intercom 4.1.2 → 4.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebb883bd25fc8d132306baac3a22c43650701dbe42d42b95ada3819bc52cc2d6
-  data.tar.gz: 8d1158c4d79cf19916c6cc1d413c329588d1ff36b5741517e029415e0f992360
+  metadata.gz: 02dd1486f502ecd7d6cd6c5ac0eda0dd7aa0efa2f127caee9eb4d5c2f87d131d
+  data.tar.gz: 618094ddfd695421006362dc450cf42d9e09f8fd70238dd9a783c1e98821112e
 SHA512:
-  metadata.gz: 0a0ea848ac117043da9707f2f9689504abda06f34e218a077c0591216aa654c3e9ca73f9874f2255e7300cd3329c95ba6440232c30d58364877e7d358bf950d0
-  data.tar.gz: 95b5ffdd05e7332fcbd53061c08c380d8632bd9f11d09e3673da65ca25b4624377b409116292b41f626a0fc6b4ad3d1c5183e5315533d3b4f94fe285c74041a6
+  metadata.gz: d551de01dc64b86f6e414234e0b0bdb8f207f2387cab6f15254ff5aa9f8561232fa1b6412ad067eaef768d9a6fffcbf0677330f8aee8667a0fd597bae5d7c7a7
+  data.tar.gz: 843174258835ec50702e28c10b16592d954e67a95318314f1c3eb544ee48705b2115ff82924c67eee32a280670c91c0885bbd04bb816d8ce59bb4db10258d1ca

data/README.md

@@ -1,12 +1,26 @@
 # intercom-ruby
 
-Ruby bindings for the Intercom API (https://developers.intercom.io/reference).
+[![Circle CI](https://circleci.com/gh/intercom/intercom-ruby.png?style=shield)](https://circleci.com/gh/intercom/intercom-ruby)
+[![gem](https://img.shields.io/gem/v/intercom)](https://rubygems.org/gems/intercom)
+![Intercom API Version](https://img.shields.io/badge/Intercom%20API%20Version-2.2-blue)
+
+> Ruby bindings for the [Intercom API](https://developers.intercom.io/reference).
+
+## Project Updates
+
+### Maintenance
+
+We're currently building a new team to provide in-depth and dedicated SDK support.
+
+In the meantime, we'll be operating on limited capacity, meaning all pull requests will be evaluated on a best effort basis and will be limited to critical issues.
+
+We'll communicate all relevant updates as we build this new team and support strategy in the coming months.
 
 [API Documentation](https://developers.intercom.io/docs)
 
 [Gem Documentation](http://rubydoc.info/github/intercom/intercom-ruby/master/frames)
 
-For generating Intercom JavaScript script tags for Rails, please see https://github.com/intercom/intercom-rails.
+For generating Intercom JavaScript script tags for Rails, please see [intercom/intercom-rails](https://github.com/intercom/intercom-rails)
 
 ## Upgrading information
 
@@ -16,12 +30,15 @@ This version of the gem is compatible with `Ruby 2.1` and above.
 
 ## Installation
 
-
-    gem install intercom
+```bash
+gem install intercom
+```
 
 Using bundler:
 
-    gem 'intercom', '~> 4.1'
+```bundler
+gem 'intercom', '~> 4.1'
+```
 
 ## Basic Usage
 
@@ -36,7 +53,7 @@ intercom = Intercom::Client.new(token: 'my_token')
 
 ```ruby
 # With a versioned app:
-intercom = Intercom::Client.new(token: 'my_token', api_version: '2.1')
+intercom = Intercom::Client.new(token: 'my_token', api_version: '2.2')
 ```
 
 If you are building a third party application you can get your access_tokens by [setting-up-oauth](https://developers.intercom.io/page/setting-up-oauth) for Intercom.
@@ -46,29 +63,31 @@ You can also use the [omniauth-intercom lib](https://github.com/intercom/omniaut
 
 Resources this API supports:
 
-    https://api.intercom.io/contacts
-    https://api.intercom.io/visitors
-    https://api.intercom.io/companies
-    https://api.intercom.io/data_attributes
-    https://api.intercom.io/events
-    https://api.intercom.io/tags
-    https://api.intercom.io/notes
-    https://api.intercom.io/segments
-    https://api.intercom.io/conversations
-    https://api.intercom.io/messages
-    https://api.intercom.io/admins
-    https://api.intercom.io/teams
-    https://api.intercom.io/counts
-    https://api.intercom.io/subscriptions
-    https://api.intercom.io/jobs
-    https://api.intercom.io/articles
-    https://api.intercom.io/help_center/collections
-    https://api.intercom.io/help_center/sections
-
+```text
+https://api.intercom.io/contacts
+https://api.intercom.io/visitors
+https://api.intercom.io/companies
+https://api.intercom.io/data_attributes
+https://api.intercom.io/events
+https://api.intercom.io/tags
+https://api.intercom.io/notes
+https://api.intercom.io/segments
+https://api.intercom.io/conversations
+https://api.intercom.io/messages
+https://api.intercom.io/admins
+https://api.intercom.io/teams
+https://api.intercom.io/counts
+https://api.intercom.io/subscriptions
+https://api.intercom.io/jobs
+https://api.intercom.io/articles
+https://api.intercom.io/help_center/collections
+https://api.intercom.io/help_center/sections
+```
 
 ### Examples
 
 #### Contacts
+
 Note that this is a new resource compatible only with the new [Contacts API](https://developers.intercom.com/intercom-api-reference/reference#contacts-model) released in API v2.0.
 
 ```ruby
@@ -146,6 +165,7 @@ contact.companies.each {|c| p c.name}
 ```
 
 #### Visitors
+
 ```ruby
 # Get and update a visitor
 visitor = intercom.visitors.find(id: "5dd570e7b1b922452676af23")
@@ -161,6 +181,7 @@ intercom.visitors.convert(visitor, user)
 ```
 
 #### Companies
+
 ```ruby
 # Find a company by company_id
 company = intercom.companies.find(company_id: "44")
@@ -188,7 +209,9 @@ intercom.companies.scroll.each { |comp| puts comp.name}
 ```
 
 #### Data Attributes
+
 Data Attributes are a type of metadata used to describe your customer and company models. These include standard and custom attributes.
+
 ```ruby
 # Create a new custom data attribute
 intercom.data_attributes.create({ name: "test_attribute", model: "contact", data_type: "string" })
@@ -208,10 +231,11 @@ intercom.data_attributes.save(attribute)
 
 # Find all customer attributes including archived
 customer_attributes_incl_archived = intercom.data_attributes.find_all({"model": "contact", "include_archived": true})
-customer_attributes_incl_archived.each { |attr| p attribute.name }
+customer_attributes_incl_archived.each { |attr| p attr.name }
 ```
 
 #### Events
+
 ```ruby
 intercom.events.create(
   event_name: "invited-friend",
@@ -257,7 +281,8 @@ intercom.events.create(
 )
 ```
 
-The metadata key values in the example are treated as follows-
+The metadata key values in the example are treated as follows:
+
 - order_date: a Date (key ends with '_date')
 - stripe_invoice: The identifier of the Stripe invoice (has a 'stripe_invoice' key)
 - order_number: a Rich Link (value contains 'url' and 'value' keys)
@@ -266,6 +291,7 @@ The metadata key values in the example are treated as follows-
 *NB:* This version of the gem reserves the field name `type` in Event data.
 
 #### Tags
+
 ```ruby
 # Iterate over all tags
 intercom.tags.all.each {|tag| "#{tag.id} - #{tag.name}" }
@@ -279,12 +305,14 @@ tag = intercom.tags.untag(name: 'blue', companies: [{ company_id: "42ea2f1b93891
 ```
 
 #### Notes
+
 ```ruby
 # Find a note by id
 note = intercom.notes.find(id: "123")
 ```
 
 #### Segments
+
 ```ruby
 # Find a segment
 segment = intercom.segments.find(id: segment_id)
@@ -294,6 +322,7 @@ intercom.segments.all.each {|segment| puts "id: #{segment.id} name: #{segment.na
 ```
 
 #### Conversations
+
 ```ruby
 # Iterate over all conversations for your app
 intercom.conversations.all.each { |convo| ... }
@@ -424,6 +453,7 @@ conversation.remove_contact(id: contact.id, admin_id: admin.id)
 ```
 
 #### Full loading of an embedded entity
+
 ```ruby
 # Given a conversation with a partial contact, load the full contact. This can be
 # done for any entity
@@ -431,6 +461,7 @@ intercom.contacts.load(conversation.contacts.first)
 ```
 
 #### Sending messages
+
 ```ruby
 
 # InApp message from admin to user
@@ -497,6 +528,7 @@ intercom.messages.create({
 ```
 
 #### Admins
+
 ```ruby
 # Find access token owner (only with Personal Access Token and OAuth)
 intercom.admins.me
@@ -507,6 +539,7 @@ intercom.admins.all.each {|admin| puts admin.email }
 ```
 
 #### Teams
+
 ```ruby
 # Find a team by id
 intercom.teams.find(id: team_id)
@@ -544,6 +577,7 @@ intercom.subscriptions.all
 ```
 
 #### Articles
+
 ```ruby
 # Create an article
 article = intercom.articles.create(title: "New Article", author_id: "123456")
@@ -577,6 +611,7 @@ intercom.articles.delete(article)
 ```
 
 #### Collections
+
 ```ruby
 # Create a collection
 collection = intercom.collections.create(name: "New Collection")
@@ -609,6 +644,7 @@ intercom.collections.delete(collection)
 ```
 
 #### Sections
+
 ```ruby
 # Create a section
 section = intercom.sections.create(name: "New Section", parent_id: "123456")
@@ -660,6 +696,7 @@ Intercom::RateLimitExceeded
 Intercom::AttributeNotSetError # Raised when you try to call a getter that does not exist on an object
 Intercom::MultipleMatchingUsersError
 Intercom::HttpError # Raised when response object is unexpectedly nil
+Intercom::GatewayTimeoutError
 ```
 
 ### Rate Limiting
@@ -674,7 +711,7 @@ intercom.rate_limit_details
 You can handle the rate limits yourself but a simple option is to use the handle_rate_limit flag.
 This will automatically catch the 429 rate limit exceeded error and wait until the reset time to retry. After three retries a rate limit exception will be raised. Encountering this error frequently may require a revisiting of your usage of the API.
 
-```
+```ruby
 intercom = Intercom::Client.new(token: ENV['AT'], handle_rate_limit: true)
 ```
 
@@ -700,13 +737,13 @@ intercom = Intercom::Client.new(token: ENV['AT'], handle_rate_limit: true)
 
 ```bash
 # all tests
-bundle exec spec
+bundle exec rake spec
 
 # unit tests
-bundle exec spec:unit
+bundle exec rake spec:unit
 
 # integration tests
-bundle exec spec:integration
+bundle exec rake spec:integration
 
 # single test file
 bundle exec m spec/unit/intercom/job_spec.rb

data/changes.txt

@@ -1,3 +1,10 @@
+4.1.2
+- Adding support for company delete.
+- Adding support for archiving/unarchiving contacts.
+- Adding support for listing contact segments.
+- Fixed issue with scroll collection proxy.
+- Fixed issue with running assignment rules on a conversation.
+
 4.1.1
 - Fixed bug with deprecated lead resource.
 

data/lib/intercom/base_collection_proxy.rb

@@ -58,6 +58,7 @@ module Intercom
         @params[:starting_after] = paging_next['starting_after']
         return true
       else
+        @params[:starting_after] = nil
         return false
       end
     end

data/lib/intercom/lib/dynamic_accessors.rb

@@ -5,20 +5,19 @@ module Intercom
       class << self
 
         def define_accessors(attribute, value, object)
-          klass = object.class
           if attribute.to_s.end_with?('_at') && attribute.to_s != 'update_last_request_at'
-            define_date_based_accessors(attribute, value, klass)
+            define_date_based_accessors(attribute, value, object)
           elsif object.flat_store_attribute?(attribute)
-            define_flat_store_based_accessors(attribute, value, klass)
+            define_flat_store_based_accessors(attribute, value, object)
           else
-            define_standard_accessors(attribute, value, klass)
+            define_standard_accessors(attribute, value, object)
           end
         end
 
         private
 
-        def define_flat_store_based_accessors(attribute, value, klass)
-          klass.class_eval %Q"
+        def define_flat_store_based_accessors(attribute, value, object)
+          object.instance_eval %Q"
             def #{attribute}=(value)
               mark_field_as_changed!(:#{attribute})
               @#{attribute} = Intercom::Lib::FlatStore.new(value)
@@ -29,8 +28,8 @@ module Intercom
           "
         end
 
-        def define_date_based_accessors(attribute, value, klass)
-          klass.class_eval %Q"
+        def define_date_based_accessors(attribute, value, object)
+          object.instance_eval %Q"
             def #{attribute}=(value)
               mark_field_as_changed!(:#{attribute})
               @#{attribute} = value.nil? ? nil : value.to_i
@@ -41,8 +40,8 @@ module Intercom
           "
         end
 
-        def define_standard_accessors(attribute, value, klass)
-            klass.class_eval %Q"
+        def define_standard_accessors(attribute, value, object)
+            object.instance_eval %Q"
               def #{attribute}=(value)
                 mark_field_as_changed!(:#{attribute})
                 @#{attribute} = value

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "4.1.2"
+  VERSION = "4.1.3"
 end

data/spec/unit/intercom/base_collection_proxy_spec.rb

@@ -4,7 +4,7 @@ describe Intercom::BaseCollectionProxy do
   let(:client) { Intercom::Client.new(token: 'token') }
 
   it "stops iterating if no starting after value" do
-    client.expects(:get).with("/contacts", {}). returns(page_of_contacts(false))
+    client.expects(:get).with("/contacts", {}).returns(page_of_contacts(false))
     emails = []
     client.contacts.all.each { |contact| emails << contact.email }
     _(emails).must_equal %w[test1@example.com test2@example.com test3@example.com]
@@ -15,6 +15,7 @@ describe Intercom::BaseCollectionProxy do
     client.expects(:get).with('/contacts', { starting_after: "EnCrYpTeDsTrInG" }).returns(page_of_contacts(false))
     emails = []
     client.contacts.all.each { |contact| emails << contact.email }
+    _(emails).must_equal %w[test1@example.com test2@example.com test3@example.com test1@example.com test2@example.com test3@example.com]
   end
 
   it "supports indexed array access" do
@@ -27,4 +28,20 @@ describe Intercom::BaseCollectionProxy do
     emails = client.contacts.all.map { |contact| contact.email }
     _(emails).must_equal %w[test1@example.com test2@example.com test3@example.com]
   end
+
+  it "keeps entire collection iterable after first iteration" do
+    contacts = client.contacts.all
+    emails_iter1 = []
+    emails_iter2 = []
+    expects_pagination = proc do
+      client.expects(:get).with("/contacts", {}).returns(page_of_contacts(true))
+      client.expects(:get).with("/contacts", { starting_after: "EnCrYpTeDsTrInG" }).returns(page_of_contacts(false))
+    end
+
+    expects_pagination.call
+    contacts.each { |contact| emails_iter1 << contact.email }
+    expects_pagination.call
+    contacts.each { |contact| emails_iter2 << contact.email }
+    _(emails_iter1).must_equal emails_iter2
+  end
 end

data/spec/unit/intercom/contact_spec.rb

@@ -274,6 +274,7 @@ describe Intercom::Contact do
 
   describe 'nested resources' do
     let(:contact) { Intercom::Contact.new(id: '1', client: client) }
+    let(:contact_no_tags) { Intercom::Contact.new(id: '2', client: client, tags: []) }
     let(:company) { Intercom::Company.new(id: '1') }
     let(:tag) { Intercom::Tag.new(id: '1') }
     let(:note) { Intercom::Note.new(body: "<p>Text for the note</p>") }
@@ -299,6 +300,27 @@ describe Intercom::Contact do
       _(proxy.resource_class).must_equal Intercom::Tag
     end
 
+    it 'returns correct tags from differring contacts' do
+      client.expects(:get).with('/contacts/1/tags', {}).returns({
+        'type' => 'tag.list',
+        'tags' => [
+          {
+            'type' => 'tag',
+            'id' => '1',
+            'name' => 'VIP Customer'
+          },
+          {
+            'type' => 'tag',
+            'id' => '2',
+            'name' => 'Test tag'
+          }
+        ]
+      })
+
+      _(contact_no_tags.tags.map{ |t| t.id }).must_equal []
+      _(contact.tags.map{ |t| t.id }).must_equal ['1', '2']
+    end
+
     it 'returns a collection proxy for listing companies' do
       proxy = contact.companies
       _(proxy.resource_name).must_equal 'companies'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 4.1.2
+  version: 4.1.3
 platform: ruby
 authors:
 - Ben McRedmond
@@ -12,10 +12,10 @@ authors:
 - Declan McGrath
 - Jamie Osler
 - Bob Long
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-30 00:00:00.000000000 Z
+date: 2022-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -256,7 +256,7 @@ homepage: https://www.intercom.io
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -271,8 +271,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.2.16
+signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API
 test_files: