Contents

require 'intercom/user_resource'
require 'intercom/flat_store'
require 'intercom/social_profile'

module Intercom
  # A collection of your Users from Intercom
  # Uses the paginated users api under the covers (http://docs.intercom.io/api#getting_all_users)
  #
  # == Examples:
  #
  # Fetching a count of all Users tracked on Intercom
  #    Intercom::User.all.count
  #
  # Iterating over each user
  #    Intercom::User.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)
      page = 1
      fetch_another_page = true
      while fetch_another_page
        current_page = Intercom.get("/v1/users", {:page => page})
        current_page["users"].each do |user|
          block.call User.from_api(user)
        end
        page = page + 1
        fetch_another_page = !current_page["next_page"].nil?
      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

    alias :collect :map
  end
end

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
intercom-0.1.2	lib/intercom/user_collection_proxy.rb
intercom-0.1.1	lib/intercom/user_collection_proxy.rb