Merge pull request intercom#7 from timcraft/user-collection-proxy-fixes

darragh · darragh · commit de90c3f43b47 · 2013-03-04T08:34:45.000-08:00
User collection proxy fixes
diff --git a/lib/intercom/user.rb b/lib/intercom/user.rb
@@ -8,13 +8,13 @@ module Intercom
   #
   # == Example usage
   # * Fetching a user
-  #    Intercom::User.find_by_email("bob@example.")
+  #    Intercom::User.find_by_email("bob@example.com")
   #
   # * Getting the count of all users
   #    Intercom::User.all.count
   #
   # * Fetching all users
-  #    Intercom::User.all.each {|user| puts user.email }
+  #    Intercom::User.all.each { |user| puts user.email }
   #
   # * Updating custom data on a user
   #    user = Intercom::User.find_by_email("bob@example.com")
@@ -68,20 +68,29 @@ def self.create(params)
 
     # Retrieve all the users
     # Examples:
-    #   Intercom::User.all.count
-    #     > 5346
-    #   Intercom::User.each do |user|
+    #   Intercom::User.all.each do |user|
     #     puts user.inspect
     #   end
     #     > ["user1@example.com" ,"user2@example.com" ,....]
-    #   Intercom::User.map(&:email)
+    #   Intercom::User.all.map(&:email)
     #     > ["user1@example.com" ,"user2@example.com" ,....]
     #
     # @return [UserCollectionProxy]
     def self.all
       UserCollectionProxy.new
     end
 
+    # Fetches a count of all Users tracked on Intercom.
+    # Example:
+    #   Intercom::User.all.count
+    #     > 5346
+    #
+    # @return [Integer]
+    def self.count
+      response = Intercom.get("/v1/users", {:per_page => 1})
+      response["total_count"]
+    end
+
     # Deletes a user record on your application.
     #
     # Calls DELETE https://api.intercom.io/v1/users
diff --git a/lib/intercom/user_collection_proxy.rb b/lib/intercom/user_collection_proxy.rb
@@ -8,21 +8,12 @@ module Intercom
   #
   # == Examples:
   #
-  # Fetching a count of all Users tracked on Intercom
-  #    Intercom::User.all.count
-  #
   # Iterating over each user
-  #    Intercom::User.each do |user|
+  #    Intercom::User.all.each do |user|
   #      puts user.inspect
   #    end
   #
   class UserCollectionProxy
-    # @return [Integer] number of users tracked on Intercom for this application
-    def count
-      response = Intercom.get("/v1/users", {:per_page => 1})
-      response["total_count"]
-    end
-
     # yields each {User} to the block provided
     # @return [void]
     def each(&block)
@@ -38,14 +29,15 @@ def each(&block)
       end
     end
 
-    # yields each {User} to the block provided and collects the output in the same way as Enumerable#map
-    # @return [Array<Object>]
-    def map
-      out = []
-      each { |e| out << yield(e) }
-      out
-    end
+    include Enumerable
+
+    # This method exists as an optimisation of Enumerable#count,
+    # which would potentially fetch multiple pages of users.
+    def count(item=nil) #:nodoc:
+      return super unless item.nil?
+      return super if block_given?
 
-    alias :collect :map
+      Intercom::User.count
+    end
   end
 end
diff --git a/spec/unit/intercom/user_collection_proxy_spec.rb b/spec/unit/intercom/user_collection_proxy_spec.rb
@@ -18,15 +18,15 @@
     Intercom::User.all.collect { |user| user.email }.must_equal %W(user1@example.com user2@example.com user3@example.com)
   end
 
-  it "yields each user to the block" do
-    Intercom.expects(:get).with("/v1/users", {:per_page => 1}).returns(page_of_users(1,1))
-    Intercom::User.all.count.must_equal 3
-  end
-
   it "loads multiple pages" do
     Intercom.expects(:get).with("/v1/users", {:page => 1}).returns(page_of_users(1, 1))
     Intercom.expects(:get).with("/v1/users", {:page => 2}).returns(page_of_users(2, 1))
     Intercom.expects(:get).with("/v1/users", {:page => 3}).returns(page_of_users(3, 1))
     Intercom::User.all.map { |user| user.email }.must_equal %W(user1@example.com user2@example.com user3@example.com)
   end
+
+  it "only loads the first page when counting" do
+    Intercom.expects(:get).with("/v1/users", {:per_page => 1}).returns(page_of_users(1, 1))
+    Intercom::User.all.count.must_equal(3)
+  end
 end
diff --git a/spec/unit/intercom/user_spec.rb b/spec/unit/intercom/user_spec.rb
@@ -184,6 +184,11 @@
     all.must_be_instance_of(Intercom::UserCollectionProxy)
   end
 
+  it "returns the total number of users" do
+    Intercom.expects(:get).with("/v1/users", {:per_page => 1}).returns(page_of_users)
+    Intercom::User.count.must_be_kind_of(Integer)
+  end
+
   it "can find_by_email" do
     Intercom::User.expects(:find).with(:email => "bob@example.com")
     Intercom::User.find_by_email("bob@example.com")
