intercom 4.0.0 → 4.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5c53964236b264ffc6d830868e44ca4a49aa5e99
-  data.tar.gz: b2780da686165e965b18a36e9ab3016e78283178
+SHA256:
+  metadata.gz: c2825cafe4bba63c25a6a4c520d2eb001cd76442b6fcbcd6454eab4c6319dfd6
+  data.tar.gz: 912189efc621173579186ebc5aabecb8fb71e96306a722cd68a477d423c50f61
 SHA512:
-  metadata.gz: '002628c67583066ae5994bfaf1a2ff90b8111f761ab031c13a573eeeab97456572bdc821bd64e67f20fba10548edf090b4bd39ec4d8b16b77f619f754c1c3118'
-  data.tar.gz: e7d16ab3173ad4ebdfdd2f616179483b24d82f8182e250d251a9723d6ca81ce0fa117b04bc98d99eda45a07ec360e5f0daa6755f32ec76004bca8816a0f585fe
+  metadata.gz: 51c4b80bef30445a5cdee9cd6f3715e34857d1879295626cd475eb49881c19f1647a11caadaa3828e99d33009ce88b973839429b7ef54950d047ffb2eb4f1df5
+  data.tar.gz: 44529233028270a8da89edacf0f0d07cfe465faf4d04ea60559ab8a6e2cbbc71e3de2e4b273515da3449e50d9b7f098cfdc585a130fc4b5d6a70556b6ce781ef

data/README.md

@@ -61,7 +61,7 @@ Resources this API supports:
     https://api.intercom.io/counts
     https://api.intercom.io/subscriptions
     https://api.intercom.io/jobs
-   
+
 
 ### Examples
 
@@ -99,7 +99,7 @@ contacts = intercom.contacts.search(
   }
 )
 contacts.each {|c| p c.email}
-# For full detail on possible queries, please refer to the API documentation: 
+# For full detail on possible queries, please refer to the API documentation:
 # https://developers.intercom.com/intercom-api-reference/reference
 
 # Merge a lead into an existing user
@@ -191,7 +191,7 @@ intercom.data_attributes.save(attribute)
 attribute.archived = true
 intercom.data_attributes.save(attribute)
 
-# Find all customer attributes including archived 
+# 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 }
 ```
@@ -321,7 +321,7 @@ conversation.statistics.time_to_admin_reply
 conversation.statistics.last_assignment_at
 
 # Get information on the sla applied to a conversation
-conversation.sla_applied.sla_name 
+conversation.sla_applied.sla_name
 
 # REPLYING TO CONVERSATIONS
 # User (identified by email) replies with a comment
@@ -370,9 +370,9 @@ intercom.conversations.mark_read(conversation.id)
 intercom.conversations.run_assignment_rules(conversation.id)
 
 # Search for conversations
-# For full detail on possible queries, please refer to the API documentation: 
-# https://developers.intercom.com/intercom-api-reference/reference 
- 
+# For full detail on possible queries, please refer to the API documentation:
+# https://developers.intercom.com/intercom-api-reference/reference
+
 # Search for open conversations sorted by the created_at date
 conversations = intercom.conversations.search(
   query: {
@@ -386,18 +386,23 @@ conversations = intercom.conversations.search(
 conversations.each {|c| p c.id}
 
 # Tagging for conversations
-tag = intercom.tags.find(id: "2") 
+tag = intercom.tags.find(id: "2")
 conversation = intercom.conversations.find(id: "1")
 
 # An Admin ID is required to add or remove tag on a conversation
-admin = intercom.admins.find(id: "1") 
+admin = intercom.admins.find(id: "1")
 
 # Add a tag to a conversation
 conversation.add_tag(id: tag.id, admin_id: admin.id)
 
 # Remove a tag from a conversation
 conversation.remove_tag(id: tag.id, admin_id: admin.id)
- 
+
+# Add a contact to a conversation
+conversation.add_contact(admin_id: admin.id, customer: { intercom_user_id: contact.id })
+
+# Remove a contact from a conversation
+conversation.remove_contact(id: contact.id, admin_id: admin.id)
 ```
 
 #### Full loading of an embedded entity

data/changes.txt

@@ -1,3 +1,11 @@
+4.0
+New version to support API version 2.0.
+- Added support for new Contacts API.
+- Added support for Conversation Search and for Conversation model changes.
+- New DataAttribute class to support the Data Attributes. See README for details on usage.
+- New method to run assignment rules on a conversation: `intercom.conversations.run_assignment_rules(<convo_id>)`.
+- See Migration guide for breaking changes: https://github.com/intercom/intercom-ruby/wiki/Migration-guide-for-v4
+
 3.9.5
 Add Unstable version support
 

data/lib/intercom/api_operations/save.rb

@@ -27,6 +27,7 @@ module Intercom
         else
           response = @client.post("/#{collection_name}", object.to_submittable_hash.merge(identity_hash(object)))
         end
+        object.client = @client
         object.from_response(response) if response # may be nil we received back a 202
       end
 

data/lib/intercom/conversation.rb

@@ -7,5 +7,6 @@ module Intercom
     include ApiOperations::NestedResource
 
     nested_resource_methods :tag, operations: %i[add delete]
+    nested_resource_methods :contact, operations: %i[add delete], path: :customers
   end
 end

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "4.0.0"
+  VERSION = "4.0.1"
 end

data/spec/unit/intercom/contact_spec.rb

@@ -311,5 +311,60 @@ describe Intercom::Contact do
       client.expects(:delete).with("/contacts/1/companies/#{company.id}", "id": tag.id ).returns(test_company)
       contact.remove_company({ "id": tag.id })
     end
+
+    describe 'just after creating the contact' do
+      let(:contact) do
+        contact = Intercom::Contact.new('email' => 'jo@example.com', :external_id => 'i-1224242')
+        client.expects(:post).with('/contacts', 'email' => 'jo@example.com', 'external_id' => 'i-1224242', 'custom_attributes' => {})
+                             .returns('id' => 1, 'email' => 'jo@example.com', 'external_id' => 'i-1224242')
+        client.contacts.save(contact)
+      end
+
+      it 'returns a collection proxy for listing notes' do
+        proxy = contact.notes
+        _(proxy.resource_name).must_equal 'notes'
+        _(proxy.url).must_equal '/contacts/1/notes'
+        _(proxy.resource_class).must_equal Intercom::Note
+      end
+
+      it 'returns a collection proxy for listing tags' do
+        proxy = contact.tags
+        _(proxy.resource_name).must_equal 'tags'
+        _(proxy.url).must_equal '/contacts/1/tags'
+        _(proxy.resource_class).must_equal Intercom::Tag
+      end
+
+      it 'returns a collection proxy for listing companies' do
+        proxy = contact.companies
+        _(proxy.resource_name).must_equal 'companies'
+        _(proxy.url).must_equal '/contacts/1/companies'
+        _(proxy.resource_class).must_equal Intercom::Company
+      end
+
+      it 'adds a note to a contact' do
+        client.expects(:post).with('/contacts/1/notes', {body: note.body}).returns(note.to_hash)
+        contact.create_note({body: note.body})
+      end
+
+      it 'adds a tag to a contact' do
+        client.expects(:post).with('/contacts/1/tags', "id": tag.id).returns(tag.to_hash)
+        contact.add_tag({ "id": tag.id })
+      end
+
+      it 'removes a tag from a contact' do
+        client.expects(:delete).with("/contacts/1/tags/#{tag.id}", "id": tag.id ).returns(tag.to_hash)
+        contact.remove_tag({ "id": tag.id })
+      end
+
+      it 'adds a contact to a company' do
+        client.expects(:post).with('/contacts/1/companies', "id": company.id).returns(test_company)
+        contact.add_company({ "id": tag.id })
+      end
+
+      it 'removes a contact from a company' do
+        client.expects(:delete).with("/contacts/1/companies/#{company.id}", "id": tag.id ).returns(test_company)
+        contact.remove_company({ "id": tag.id })
+      end
+    end
   end
 end

data/spec/unit/intercom/conversation_spec.rb

@@ -81,5 +81,31 @@ describe "Intercom::Conversation" do
       client.expects(:delete).with("/conversations/1/tags/1", { "id": tag.id }).returns(nil)
       _(proc { conversation.remove_tag({ "id": tag.id }) }).must_raise Intercom::HttpError
     end
+
+    describe 'contacts' do
+      let(:response) do
+        {
+          customers: [
+            { type: test_contact['type'], id: test_contact['id'] }
+          ]
+        }
+      end
+
+      it 'adds a contact to a conversation' do
+        client.expects(:post)
+              .with("/conversations/1/customers",
+                    { admin_id: test_admin['id'], customer: { intercom_user_id: test_contact['id'] } })
+              .returns(response.to_hash)
+        conversation.add_contact(admin_id: test_admin['id'], customer: { intercom_user_id: test_contact['id'] })
+      end
+
+      it 'removes a contact from a conversation' do
+        client.expects(:delete)
+              .with("/conversations/1/customers/aaaaaaaaaaaaaaaaaaaaaaaa",
+                    { id: 'aaaaaaaaaaaaaaaaaaaaaaaa', admin_id: '1234' })
+              .returns(response.to_hash)
+        conversation.remove_contact(id: test_contact['id'], admin_id: test_admin['id'])
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.0.1
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-30 00:00:00.000000000 Z
+date: 2020-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -262,8 +262,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.3
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API