intercom 3.5.3 → 3.5.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cb77431bc9d029fc727badd60a0ff01a015646d
-  data.tar.gz: 4e29db4fae3a6d8451bd35fc4ab63fc3bf97d39c
+  metadata.gz: 65f8ee35be573105827b5e3b6241d07154e0a075
+  data.tar.gz: 5a61122d948cd69ea4d2b6ddade7ab6a614de8a5
 SHA512:
-  metadata.gz: b2c07f366f514edbc42ca1fdfe75f568eda7b7b8cd1ba7737d29503474e875c98c01d2288df14d2ab6ad8f6557f77ade20bea102793a8487cfc64348fb607244
-  data.tar.gz: 1d13a52bc103466aa225e0bda5426ff54b6294c6d5a303f302f84430732857f61ec6df572ba46d7b49a393fd804dace30b1bf9d0a8bb14eb6ca2948a56787b05
+  metadata.gz: 74f22fb60b9c7ac2b65eaa1921be6cb44a18c1862254ba961f3f6bb57187cfbf56f56c555e241ac7681a6cd79ef28f11329b5c9dc5c0a49368710bcfaad85df9
+  data.tar.gz: 4561b5bdf72b92be0a91eebd9ad049239d5682b5b37b4f3f93e41a3cd8a5faa3a861a2d9f51a3ecdb1924e24cedadcc2cf756ab69553eb3570deafa244257141

data/README.md

@@ -22,7 +22,7 @@ This version of the gem is compatible with `Ruby 2.1` and above.
 
 Using bundler:
 
-    gem 'intercom', "~> 3.5.2"
+    gem 'intercom', "~> 3.5.3"
 
 ## Basic Usage
 

data/changes.txt

@@ -1,3 +1,6 @@
+3.5.4
+- Add support for scoll API feature
+
 3.5.3
 - Add support for global conversation counts
 

data/lib/intercom/api_operations/scroll.rb

@@ -0,0 +1,16 @@
+require 'intercom/scroll_collection_proxy'
+
+module Intercom
+  module ApiOperations
+    module Scroll
+
+      def scroll()
+        collection_name = Utils.resource_class_to_collection_name(collection_class)
+        finder_details = {}
+        finder_details[:url] = "/#{collection_name}"
+        ScrollCollectionProxy.new(collection_name, finder_details: finder_details,  client: @client)
+      end
+
+    end
+  end
+end

data/lib/intercom/scroll_collection_proxy.rb

@@ -0,0 +1,83 @@
+require "intercom/utils"
+require "ext/sliceable_hash"
+
+module Intercom
+  class ScrollCollectionProxy
+
+    attr_reader :resource_name, :scroll_url, :resource_class, :scroll_param, :records
+
+    def initialize(resource_name, finder_details: {}, client:)
+      @resource_name = resource_name
+      @resource_class = Utils.constantize_resource_name(resource_name)
+      @scroll_url = (finder_details[:url] || "/#{@resource_name}") + '/scroll'
+      @client = client
+
+    end
+
+    def next(scroll_parameter=nil)
+      @records = []
+      if not scroll_parameter
+        #First time so do initial get without scroll_param
+        response_hash = @client.get(@scroll_url, '')
+      else
+        #Not first call so use get next page
+        response_hash = @client.get(@scroll_url, scroll_param: scroll_parameter)
+      end
+      raise Intercom::HttpError.new('Http Error - No response entity returned') unless response_hash
+      @scroll_param = extract_scroll_param(response_hash)
+      top_level_entity_key = deserialize_response_hash(response_hash)
+      response_hash[top_level_entity_key] = response_hash[top_level_entity_key].map do |object_json|
+        Lib::TypedJsonDeserializer.new(object_json).deserialize
+      end
+      @records = response_hash[@resource_name]
+      self
+    end
+
+    def each(&block)
+      scroll_param = nil
+      loop do
+        if not scroll_param
+          response_hash = @client.get(@scroll_url, '')
+        else
+          response_hash = @client.get(@scroll_url, scroll_param: scroll_param)
+        end
+        raise Intercom::HttpError.new('Http Error - No response entity returned') unless response_hash
+        response_hash[deserialize_response_hash(response_hash)].each do |object_json|
+          block.call Lib::TypedJsonDeserializer.new(object_json).deserialize
+        end
+        scroll_param = extract_scroll_param(response_hash)
+        break if not records_present?(response_hash)
+      end
+      self
+    end
+
+    def [](target_index)
+      self.each_with_index do |item, index|
+        return item if index == target_index
+      end
+      nil
+    end
+
+    include Enumerable
+
+    private
+
+    def deserialize_response_hash(response_hash)
+      top_level_type = response_hash.delete('type')
+      if resource_name == 'subscriptions'
+        top_level_entity_key = 'items'
+      else
+        top_level_entity_key = Utils.entity_key_from_type(top_level_type)
+      end
+    end
+
+    def records_present?(response_hash)
+      (response_hash[@resource_name].length > 0)
+    end
+
+    def extract_scroll_param(response_hash)
+      return nil unless records_present?(response_hash)
+      response_hash['scroll_param']
+    end
+  end
+end

data/lib/intercom/service/user.rb

@@ -1,6 +1,7 @@
 require 'intercom/service/base_service'
 require 'intercom/api_operations/load'
 require 'intercom/api_operations/list'
+require 'intercom/api_operations/scroll'
 require 'intercom/api_operations/find'
 require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/save'
@@ -14,6 +15,7 @@ module Intercom
     class User < BaseService
       include ApiOperations::Load
       include ApiOperations::List
+      include ApiOperations::Scroll
       include ApiOperations::Find
       include ApiOperations::FindAll
       include ApiOperations::Save

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.5.3"
+  VERSION = "3.5.4"
 end

data/spec/spec_helper.rb

@@ -216,6 +216,14 @@ def page_of_users(include_next_link= false)
   }
 end
 
+def users_scroll(include_users= false)
+  {
+      "type"=>"user.list",
+      "scroll_param"=> ("da6bbbac-25f6-4f07-866b-b911082d7"),
+      "users"=> (include_users ? [test_user("user1@example.com"), test_user("user2@example.com"), test_user("user3@example.com")] : []),
+  }
+end
+
 def users_pagination(include_next_link=false, per_page=0, page=0, total_pages=0, total_count=0, user_list=[])
   {
       "type"=>"user.list",

data/spec/unit/intercom/scroll_collection_proxy_spec.rb

@@ -0,0 +1,56 @@
+require "spec_helper"
+
+describe Intercom::ScrollCollectionProxy do
+  let (:client) { Intercom::Client.new(app_id: 'app_id',  api_key: 'api_key') }
+
+  it "stops iterating if no users returned" do
+    client.expects(:get).with("/users/scroll", '').returns(users_scroll(false))
+    emails = []
+    client.users.scroll.each { |user| emails << user.email }
+    emails.must_equal %W()
+  end
+
+  it "keeps iterating if users returned" do
+    client.expects(:get).with("/users/scroll", '').returns(users_scroll(true))
+    client.expects(:get).with('/users/scroll', {:scroll_param => 'da6bbbac-25f6-4f07-866b-b911082d7'}).returns(users_scroll(false))
+    emails = []
+    client.users.scroll.each { |user| emails << user.email }
+  end
+
+  it "supports indexed array access" do
+    client.expects(:get).with("/users/scroll", '').returns(users_scroll(true))
+    client.users.scroll[0].email.must_equal 'user1@example.com'
+  end
+
+  it "supports map" do
+    client.expects(:get).with("/users/scroll", '').returns(users_scroll(true))
+    client.expects(:get).with('/users/scroll', {:scroll_param => 'da6bbbac-25f6-4f07-866b-b911082d7'}).returns(users_scroll(false))
+    emails = client.users.scroll.map { |user| user.email }
+    emails.must_equal %W(user1@example.com user2@example.com user3@example.com)
+  end
+
+  it "returns one page scroll" do
+    client.expects(:get).with("/users/scroll", '').returns(users_scroll(true))
+    scroll = client.users.scroll.next
+    emails = []
+    scroll.records.each {|usr| emails << usr.email}
+    emails.must_equal %W(user1@example.com user2@example.com user3@example.com)
+  end
+
+  it "keeps iterating if called with scroll_param" do
+    client.expects(:get).with("/users/scroll", '').returns(users_scroll(true))
+    client.expects(:get).with('/users/scroll', {:scroll_param => 'da6bbbac-25f6-4f07-866b-b911082d7'}).returns(users_scroll(true))
+    scroll = client.users.scroll.next
+    scroll = client.users.scroll.next('da6bbbac-25f6-4f07-866b-b911082d7')
+    emails =[]
+    scroll.records.each {|usr| puts usr.email}
+  end
+
+  it "works with an empty list" do
+    client.expects(:get).with("/users/scroll", '').returns(users_scroll(false))
+    scroll = client.users.scroll.next
+    emails = []
+    scroll.records.each {|usr| emails << usr.email}
+    emails.must_equal %W()
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.5.3
+  version: 3.5.4
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-08-25 00:00:00.000000000 Z
+date: 2016-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -139,6 +139,7 @@ files:
 - lib/intercom/api_operations/list.rb
 - lib/intercom/api_operations/load.rb
 - lib/intercom/api_operations/save.rb
+- lib/intercom/api_operations/scroll.rb
 - lib/intercom/client.rb
 - lib/intercom/client_collection_proxy.rb
 - lib/intercom/company.rb
@@ -159,6 +160,7 @@ files:
 - lib/intercom/note.rb
 - lib/intercom/options.rb
 - lib/intercom/request.rb
+- lib/intercom/scroll_collection_proxy.rb
 - lib/intercom/segment.rb
 - lib/intercom/service/admin.rb
 - lib/intercom/service/base_service.rb
@@ -198,6 +200,7 @@ files:
 - spec/unit/intercom/message_spec.rb
 - spec/unit/intercom/note_spec.rb
 - spec/unit/intercom/request_spec.rb
+- spec/unit/intercom/scroll_collection_proxy_spec.rb
 - spec/unit/intercom/segment_spec.rb
 - spec/unit/intercom/subscription_spec.rb
 - spec/unit/intercom/tag_spec.rb
@@ -244,6 +247,7 @@ test_files:
 - spec/unit/intercom/message_spec.rb
 - spec/unit/intercom/note_spec.rb
 - spec/unit/intercom/request_spec.rb
+- spec/unit/intercom/scroll_collection_proxy_spec.rb
 - spec/unit/intercom/segment_spec.rb
 - spec/unit/intercom/subscription_spec.rb
 - spec/unit/intercom/tag_spec.rb