intercom 3.5.9 → 3.5.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d07ca20fc9a3f8b9d12df73d9b76b9e23daa41a8
-  data.tar.gz: 3fef787910743a32b6beb66038b3c6811196f352
+  metadata.gz: 0f98bf7f9725ad035949ca88859ba807a6323a83
+  data.tar.gz: 97e46a4507500d311495e11114fb80d0715cb0a0
 SHA512:
-  metadata.gz: 376bd8560327390061df14dd86b19dd4896edf07327a86d8f265e5af64ee44f7701778ca001333d4eac53a1c2447d9dc43fb762811e70987f0e0588d9a8741e7
-  data.tar.gz: 5894bc20064d92e0295afe2bf5bca9badaa13eb9fb2b4bb8719706bf198d88c383f1b5da3f273ca5fd98c82e53751610b1b39cbab1dd4194b247e55155c4b917
+  metadata.gz: 8c83c5d9c5ad9d4844b5b8f7c3602e6bf76cbbb9e9836b264acbdcfdb5e3567310c1441e23c7cd0b2dac30f0200bbea46175fe9eea5c130aa49d16e9ca5cd2d4
+  data.tar.gz: b480c171fd98135e719c37be86b0d13f7288f65130583d863afad3dd32acdc42de3e66be8941620047ba57db9fc54548b10307cbed55bd5278563825e6728de0

data/.travis.yml

@@ -3,3 +3,4 @@ sudo: false
 rvm:
   - 2.1.0
   - 2.2.0
+  - 2.3.3

data/README.md

@@ -6,7 +6,7 @@ Ruby bindings for the Intercom API (https://developers.intercom.io/reference).
 
 [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 https://github.com/intercom/intercom-rails.
 
 ## Upgrading information
 
@@ -22,18 +22,13 @@ This version of the gem is compatible with `Ruby 2.1` and above.
 
 Using bundler:
 
-    gem 'intercom', "~> 3.5.9"
+    gem 'intercom', '~> 3.5.9'
 
 ## Basic Usage
 
 ### Configure your client
 
-```ruby
-intercom = Intercom::Client.new(app_id: 'my_app_id', api_key: 'my_api_key')
-```
-> Warning: API Keys are being deprecated - you should use a [personal access token](https://app.intercom.io/a/apps/_/settings/personal-access-token) instead. [Learn more](https://developers.intercom.io/docs/personal-access-tokens) about API Keys deprecation
-
-You can get your `app_id` from the URL when you're logged into Intercom (it's the alphanumeric just after `/apps/`) and your API key from the API keys integration settings page (under your app settings - integrations in Intercom).
+> If you already have a personal access token you can find it [here](https://app.intercom.io/a/apps/_/settings/personal-access-token). If you want to create or learn more about personal access tokens then you can find more info [here](https://developers.intercom.io/docs/personal-access-tokens).
 
 ```ruby
 # With an OAuth or Personal Access token:
@@ -67,15 +62,15 @@ Resources this API supports:
 
 ```ruby
 # Find user by email
-user = intercom.users.find(:email => "bob@example.com")
+user = intercom.users.find(email: "bob@example.com")
 # Find user by user_id
-user = intercom.users.find(:user_id => "1")
+user = intercom.users.find(user_id: "1")
 # Find user by id
-user = intercom.users.find(:id => "1")
+user = intercom.users.find(id: "1")
 # Create a user
-user = intercom.users.create(:email => "bob@example.com", :name => "Bob Smith", :signed_up_at => Time.now.to_i)
+user = intercom.users.create(email: "bob@example.com", name: "Bob Smith", signed_up_at: Time.now.to_i)
 # Delete a user
-user = intercom.users.find(:id => "1")
+user = intercom.users.find(id: "1")
 deleted_user = intercom.users.delete(user)
 # Update custom_attributes for a user
 user.custom_attributes["average_monthly_spend"] = 1234.56
@@ -104,17 +99,17 @@ result = intercom.users.scroll.next
 # make a new request
 result.scroll_param
 => "0730e341-63ef-44da-ab9c-9113f886326d"
-result =  = intercom.users.scroll.next("0730e341-63ef-44da-ab9c-9113f886326d");
+result = intercom.users.scroll.next("0730e341-63ef-44da-ab9c-9113f886326d");
 
 #Bulk operations.
 # Submit bulk job to create users. If any of the items in create_items match an existing user that user will be updated
-intercom.users.submit_bulk_job(create_items: [{user_id: 25, email: "alice@example.com"}, {user_id: 25, email: "bob@example.com"}])
+intercom.users.submit_bulk_job(create_items: [{user_id: "25", email: "alice@example.com"}, {user_id: "25", email: "bob@example.com"}])
 # Submit bulk job to create users with companies. Companies must be sent as an array of objects nested within each applicable user object
-intercom.users.submit_bulk_job(create_items: [{user_id: 25, email: "alice@example.com", companies: [{:company_id => 9, :name => "Test Company"}]}])
+intercom.users.submit_bulk_job(create_items: [{user_id: "25", email: "alice@example.com", companies: [{company_id: 9, name: "Test Company"}]}])
 # Submit bulk job, to delete users
-intercom.users.submit_bulk_job(delete_items: [{user_id: 25, email: "alice@example.com"}, {user_id: 25, email: "bob@example.com"}])
+intercom.users.submit_bulk_job(delete_items: [{user_id: "25", email: "alice@example.com"}, {user_id: "25", email: "bob@example.com"}])
 # Submit bulk job, to add items to existing job
-intercom.users.submit_bulk_job(create_items: [{user_id: 25, email: "alice@example.com"}], delete_items: [{user_id: 25, email: "bob@example.com"}], job_id:'job_abcd1234')
+intercom.users.submit_bulk_job(create_items: [{user_id: "25", email: "alice@example.com"}], delete_items: [{user_id: "25", email: "bob@example.com"}], job_id:'job_abcd1234')
 ```
 
 #### Admins
@@ -122,7 +117,7 @@ intercom.users.submit_bulk_job(create_items: [{user_id: 25, email: "alice@exampl
 # Find access token owner (only with Personal Access Token and OAuth)
 intercom.admins.me
 # Find an admin by id
-intercom.admins.find(:id => admin_id)
+intercom.admins.find(id: admin_id)
 # Iterate over all admins
 intercom.admins.all.each {|admin| puts admin.email }
 ```
@@ -130,18 +125,18 @@ intercom.admins.all.each {|admin| puts admin.email }
 #### Companies
 ```ruby
 # Add a user to one or more companies
-user = intercom.users.find(:email => "bob@example.com")
-user.companies = [{:company_id => 6, :name => "Intercom"}, {:company_id => 9, :name => "Test Company"}]
+user = intercom.users.find(email: "bob@example.com")
+user.companies = [{company_id: 6, name: "Intercom"}, {company_id: 9, name: "Test Company"}]
 intercom.users.save(user)
 # You can also pass custom attributes within a company as you do this
-user.companies = [{:id => 6, :name => "Intercom", :custom_attributes => {:referral_source => "Google"} } ]
+user.companies = [{id: 6, name: "Intercom", custom_attributes: {referral_source: "Google"} } ]
 intercom.users.save(user)
 # Find a company by company_id
-company = intercom.companies.find(:company_id => "44")
+company = intercom.companies.find(company_id: "44")
 # Find a company by name
-company = intercom.companies.find(:name => "Some company")
+company = intercom.companies.find(name: "Some company")
 # Find a company by id
-company = intercom.companies.find(:id => "41e66f0313708347cb0000d0")
+company = intercom.companies.find(id: "41e66f0313708347cb0000d0")
 # Update a company
 company.name = 'Updated company name'
 intercom.companies.save(company)
@@ -168,7 +163,7 @@ tag = intercom.tags.tag(name: 'blue', companies: [{id: "42ea2f1b93891f6a99000427
 #### Segments
 ```ruby
 # Find a segment
-segment = intercom.segments.find(:id => segment_id)
+segment = intercom.segments.find(id: segment_id)
 # Iterate over all segments
 intercom.segments.all.each {|segment| puts "id: #{segment.id} name: #{segment.name}"}
 ```
@@ -176,37 +171,37 @@ intercom.segments.all.each {|segment| puts "id: #{segment.id} name: #{segment.na
 #### Notes
 ```ruby
 # Find a note by id
-note = intercom.notes.find(:id => note)
+note = intercom.notes.find(id: note)
 # Create a note for a user
-note = intercom.notes.create(:body => "<p>Text for the note</p>", :email => 'joe@example.com')
+note = intercom.notes.create(body: "<p>Text for the note</p>", email: 'joe@example.com')
 # Iterate over all notes for a user via their email address
-intercom.notes.find_all(:email => 'joe@example.com').each {|note| puts note.body}
+intercom.notes.find_all(email: 'joe@example.com').each {|note| puts note.body}
 # Iterate over all notes for a user via their user_id
-intercom.notes.find_all(:user_id => '123').each {|note| puts note.body}
+intercom.notes.find_all(user_id: '123').each {|note| puts note.body}
 ```
 
 #### Conversations
 ```ruby
 # FINDING CONVERSATIONS FOR AN ADMIN
 # Iterate over all conversations (open and closed) assigned to an admin
-intercom.conversations.find_all(:type => 'admin', :id => '7').each {|convo| ... }
+intercom.conversations.find_all(type: 'admin', id: '7').each {|convo| ... }
 # Iterate over all open conversations assigned to an admin
-intercom.conversations.find_all(:type => 'admin', :id => 7, :open => true).each {|convo| ... }
+intercom.conversations.find_all(type: 'admin', id: 7, open: true).each {|convo| ... }
 # Iterate over closed conversations assigned to an admin
-intercom.conversations.find_all(:type => 'admin', :id => 7, :open => false).each {|convo| ... }
+intercom.conversations.find_all(type: 'admin', id: 7, open: false).each {|convo| ... }
 # Iterate over closed conversations for assigned an admin, before a certain moment in time
-intercom.conversations.find_all(:type => 'admin', :id => 7, :open => false, :before => 1374844930).each {|convo| ... }
+intercom.conversations.find_all(type: 'admin', id: 7, open: false, before: 1374844930).each {|convo| ... }
 
 # FINDING CONVERSATIONS FOR A USER
 # Iterate over all conversations (read + unread, correct) with a user based on the users email
-intercom.conversations.find_all(:email => 'joe@example.com', :type => 'user').each {|convo| ... }
+intercom.conversations.find_all(email: 'joe@example.com', type: 'user').each {|convo| ... }
 # Iterate over through all conversations (read + unread) with a user based on the users email
-intercom.conversations.find_all(:email => 'joe@example.com', :type => 'user', :unread => false).each {|convo| ... }
+intercom.conversations.find_all(email: 'joe@example.com', type: 'user', unread: false).each {|convo| ... }
 # Iterate over all unread conversations with a user based on the users email
-intercom.conversations.find_all(:email => 'joe@example.com', :type => 'user', :unread => true).each {|convo| ... }
+intercom.conversations.find_all(email: 'joe@example.com', type: 'user', unread: true).each {|convo| ... }
 
 # FINDING A SINGLE CONVERSATION
-conversation = intercom.conversations.find(:id => '1')
+conversation = intercom.conversations.find(id: '1')
 
 # INTERACTING WITH THE PARTS OF A CONVERSATION
 # Getting the subject of a part (only applies to email-based conversations)
@@ -218,11 +213,11 @@ conversation.conversation_parts[1].body
 
 # REPLYING TO CONVERSATIONS
 # User (identified by email) replies with a comment
-intercom.conversations.reply(:id => conversation.id, :type => 'user', :email => 'joe@example.com', :message_type => 'comment', :body => 'foo')
+intercom.conversations.reply(id: conversation.id, type: 'user', email: 'joe@example.com', message_type: 'comment', body: 'foo')
 # Admin (identified by id) replies with a comment
-intercom.conversations.reply(:id => conversation.id, :type => 'admin', :admin_id => '123', :message_type => 'comment', :body => 'bar')
+intercom.conversations.reply(id: conversation.id, type: 'admin', admin_id: '123', message_type: 'comment', body: 'bar')
 # User (identified by email) replies with a comment and attachment
-intercom.conversations.reply(:id => conversation.id, :type => 'user', :email => 'joe@example.com', :message_type => 'comment', :body => 'foo', :attachment_urls => ['http://www.example.com/attachment.jpg'])
+intercom.conversations.reply(id: conversation.id, type: 'user', email: 'joe@example.com', message_type: 'comment', body: 'foo', attachment_urls: ['http://www.example.com/attachment.jpg'])
 
 # Open
 intercom.conversations.open(id: conversation.id, admin_id: '123')
@@ -234,13 +229,13 @@ intercom.conversations.close(id: conversation.id, admin_id: '123')
 intercom.conversations.assign(id: conversation.id, admin_id: '123', assignee_id: '124')
 
 # Reply and Open
-intercom.conversations.reply(:id => conversation.id, :type => 'admin', :admin_id => '123', :message_type => 'open', :body => 'bar')
+intercom.conversations.reply(id: conversation.id, type: 'admin', admin_id: '123', message_type: 'open', body: 'bar')
 
 # Reply and Close
-intercom.conversations.reply(:id => conversation.id, :type => 'admin', :admin_id => '123', :message_type => 'close', :body => 'bar')
+intercom.conversations.reply(id: conversation.id, type: 'admin', admin_id: '123', message_type: 'close', body: 'bar')
 
 # ASSIGNING CONVERSATIONS TO ADMINS
-intercom.conversations.reply(:id => conversation.id, :type => 'admin', :assignee_id => assignee_admin.id, :admin_id => admin.id, :message_type => 'assignment')
+intercom.conversations.reply(id: conversation.id, type: 'admin', assignee_id: assignee_admin.id, admin_id: admin.id, message_type: 'assignment')
 
 # MARKING A CONVERSATION AS READ
 intercom.conversations.mark_read(conversation.id)
@@ -258,75 +253,76 @@ intercom.users.load(conversation.user)
 
 # InApp message from admin to user
 intercom.messages.create({
-  :message_type => 'inapp',
-  :body => "What's up :)",
-  :from => {
-    :type => 'admin',
-    :id   => "1234"
+  message_type: 'inapp',
+  body: "What's up :)",
+  from: {
+    type: 'admin',
+    id: "1234"
   },
-  :to => {
-    :type => "user",
-    :user_id   => "5678"
+  to: {
+    type: "user",
+    user_id: "5678"
   }
 })
 
 # Email message from admin to user
 intercom.messages.create({
-  :message_type => 'email',
-  :subject  => 'Hey there',
-  :body     => "What's up :)",
-  :template => "plain", # or "personal",
-  :from => {
-    :type => "admin",
-    :id   => "1234"
+  message_type: 'email',
+  subject: 'Hey there',
+  body: "What's up :)",
+  template: "plain", # or "personal",
+  from: {
+    type: "admin",
+    id: "1234"
   },
-  :to => {
-    :type => "user",
-    :id => "536e564f316c83104c000020"
+  to: {
+    type: "user",
+    id: "536e564f316c83104c000020"
   }
 })
 
 # Message from a user
 intercom.messages.create({
-  :from => {
-    :type => "user",
-    :id => "536e564f316c83104c000020"
+  from: {
+    type: "user",
+    id: "536e564f316c83104c000020"
   },
-  :body => "halp"
+  body: "halp"
 })
 
 # Message from admin to contact
 
 intercom.messages.create({
-  :body     => "How can I help :)",
-  :from => {
-    :type => "admin",
-    :id   => "1234"
+  body: "How can I help :)",
+  from: {
+    type: "admin",
+    id: "1234"
   },
-  :to => {
-    :type => "contact",
-    :id => "536e5643as316c83104c400671"
+  to: {
+    type: "contact",
+    id: "536e5643as316c83104c400671"
   }
 })
 
 # Message from a contact
 intercom.messages.create({
-  :from => {
-    :type => "contact",
-    :id => "536e5643as316c83104c400671"
+  from: {
+    type: "contact",
+    id: "536e5643as316c83104c400671"
   },
-  :body => "halp"
+  body: "halp"
 })
 ```
 
 #### Events
 ```ruby
 intercom.events.create(
-  :event_name => "invited-friend", :created_at => Time.now.to_i,
-  :email => user.email,
-  :metadata => {
+  event_name: "invited-friend",
+  created_at: Time.now.to_i,
+  email: user.email,
+  metadata: {
     "invitee_email" => "pi@example.org",
-    :invite_code => "ADDAFRIEND",
+    invite_code: "ADDAFRIEND",
     "found_date" => 12909364407
   }
 )
@@ -339,25 +335,27 @@ intercom.events.create(
 Metadata Objects support a few simple types that Intercom can present on your behalf
 
 ```ruby
-intercom.events.create(:event_name => "placed-order", :email => current_user.email,
-  :created_at => 1403001013,
-  :metadata => {
-    :order_date => Time.now.to_i,
-    :stripe_invoice => 'inv_3434343434',
-    :order_number => {
-      :value => '3434-3434',
-      :url => 'https://example.org/orders/3434-3434'
+intercom.events.create(
+  event_name: "placed-order",
+  email: current_user.email,
+  created_at: 1403001013,
+  metadata: {
+    order_date: Time.now.to_i,
+    stripe_invoice: 'inv_3434343434',
+    order_number: {
+      value: '3434-3434',
+      url: 'https://example.org/orders/3434-3434'
     },
     price: {
-      :currency => 'usd',
-      :amount => 2999
+      currency: 'usd',
+      amount: 2999
     }
   }
 )
 ```
 
 The metadata key values in the example are treated as follows-
-- order_date: a Date (key ends with '_date').
+- 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)
 - price: An Amount in US Dollars (value contains 'amount' and 'currency' keys)
@@ -450,10 +448,10 @@ Subscribe to events in Intercom to receive webhooks.
 
 ```ruby
 # create a subscription
-intercom.subscriptions.create(:url => "http://example.com", :topics => ["user.created"])
+intercom.subscriptions.create(url: "http://example.com", topics: ["user.created"])
 
 # fetch a subscription
-intercom.subscriptions.find(:id => "nsub_123456789")
+intercom.subscriptions.find(id: "nsub_123456789")
 
 # list subscriptions
 intercom.subscriptions.all

data/intercom.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "fakeweb", ["~> 1.3"]
   spec.add_development_dependency "pry"
 
-  spec.add_dependency 'json', '~> 1.8'
+  spec.add_dependency 'json', '>= 1.8'
   spec.required_ruby_version = '>= 2.1.0'
   spec.add_development_dependency 'gem-release'
 end

data/lib/intercom.rb

@@ -29,7 +29,6 @@ require "intercom/message"
 require "intercom/admin"
 require "intercom/request"
 require "intercom/subscription"
-require "intercom/utils"
 require "intercom/errors"
 require "intercom/visitor"
 require "json"

data/lib/intercom/api_operations/bulk/submit.rb

@@ -1,3 +1,5 @@
+require 'intercom/utils'
+
 module Intercom
   module ApiOperations
     module Bulk

data/lib/intercom/api_operations/delete.rb

@@ -1,4 +1,4 @@
-require 'intercom/traits/api_resource'
+require 'intercom/utils'
 
 module Intercom
   module ApiOperations

data/lib/intercom/api_operations/find.rb

@@ -1,3 +1,5 @@
+require 'intercom/utils'
+
 module Intercom
   module ApiOperations
     module Find

data/lib/intercom/api_operations/find_all.rb

@@ -1,4 +1,5 @@
 require 'intercom/client_collection_proxy'
+require 'intercom/utils'
 
 module Intercom
   module ApiOperations

data/lib/intercom/api_operations/list.rb

@@ -1,4 +1,5 @@
 require 'intercom/client_collection_proxy'
+require 'intercom/utils'
 
 module Intercom
   module ApiOperations

data/lib/intercom/api_operations/load.rb

@@ -1,3 +1,5 @@
+require 'intercom/utils'
+
 module Intercom
   module ApiOperations
     module Load

data/lib/intercom/api_operations/save.rb

@@ -1,4 +1,5 @@
-require 'intercom/traits/api_resource'
+require 'intercom/utils'
+require 'ext/sliceable_hash'
 
 module Intercom
   module ApiOperations

data/lib/intercom/api_operations/scroll.rb

@@ -1,4 +1,5 @@
 require 'intercom/scroll_collection_proxy'
+require 'intercom/utils'
 
 module Intercom
   module ApiOperations
@@ -13,4 +14,4 @@ module Intercom
 
     end
   end
-end
+end

data/lib/intercom/client_collection_proxy.rb

@@ -1,5 +1,4 @@
 require "intercom/utils"
-require "ext/sliceable_hash"
 
 module Intercom
   class ClientCollectionProxy

data/lib/intercom/extended_api_operations/segments.rb

@@ -1,5 +1,5 @@
-require 'intercom/traits/api_resource'
 require 'intercom/client_collection_proxy'
+require 'intercom/utils'
 
 module Intercom
   module ExtendedApiOperations

data/lib/intercom/extended_api_operations/tags.rb

@@ -1,5 +1,5 @@
-require 'intercom/traits/api_resource'
 require 'intercom/client_collection_proxy'
+require 'intercom/utils'
 
 module Intercom
   module ExtendedApiOperations

data/lib/intercom/extended_api_operations/users.rb

@@ -1,4 +1,5 @@
-require 'intercom/traits/api_resource'
+require 'intercom/client_collection_proxy'
+require 'intercom/utils'
 
 module Intercom
   module ExtendedApiOperations

data/lib/intercom/lib/typed_json_deserializer.rb

@@ -1,6 +1,7 @@
+require 'intercom/utils'
+
 module Intercom
   module Lib
-
       # Responsibility: To decide whether we are deserializing a collection or an
       # entity of a particular type and to dispatch deserialization
       class TypedJsonDeserializer

data/lib/intercom/scroll_collection_proxy.rb

@@ -1,5 +1,4 @@
 require "intercom/utils"
-require "ext/sliceable_hash"
 
 module Intercom
   class ScrollCollectionProxy
@@ -80,4 +79,4 @@ module Intercom
       response_hash['scroll_param']
     end
   end
-end
+end

data/lib/intercom/service/conversation.rb

@@ -3,6 +3,7 @@ require 'intercom/api_operations/find_all'
 require 'intercom/api_operations/find'
 require 'intercom/api_operations/load'
 require 'intercom/api_operations/save'
+require 'intercom/utils'
 
 module Intercom
   module Service

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.5.9"
+  VERSION = "3.5.10"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.5.9
+  version: 3.5.10
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-27 00:00:00.000000000 Z
+date: 2017-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -91,14 +91,14 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
@@ -242,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: intercom
-rubygems_version: 2.6.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API