intercom 3.3.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ecabc64ed0e6223bb4b5af895a49b6dee13fdb5
-  data.tar.gz: 98f56f0bd24d589be44195af2d8470b469adfdd2
+  metadata.gz: d99183b501bb44dbe266b53e79f3f87c19598ec3
+  data.tar.gz: 60219b646fe7651c872bb0defc9e519538d76278
 SHA512:
-  metadata.gz: ab1db67838ece4aeb6456060bd27b68b7a3762b1840dd5bed9cbeddab2c542eb1dbed37c78a2a0ffd2245601d896a19aac1974b5e79739b0809e3e729bbfc015
-  data.tar.gz: 74252ee9ad4f610e86d5c37fda98e36911211ba353a14c212347a5d5bf0e54c08999239c21638e59c5f44726242ad9f8b9555875f828459ce2bd7b6f6c563156
+  metadata.gz: 75cf2e79bd16fbecd583c1870b88cb6434c2626049b005616b22c9702b8b55dca4eccf32dfcf080fa466b32081b6f14ae4f88156d43af865728ecbd33062ff8f
+  data.tar.gz: 6e70470e54a9b0c82e91ff6a598e49ace938ea7504aec800ebb0bf81cf8b710aa495d915b176d862290cf703371f2724c8a1ac967a8bf0a48755470181bde009

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.3.0"
+    gem 'intercom', "~> 3.4.0"
 
 ## Basic Usage
 
@@ -30,6 +30,9 @@ Using bundler:
 
 ```ruby
 intercom = Intercom::Client.new(app_id: 'my_app_id', api_key: 'my_api_key')
+
+# With an OAuth token:
+intercom = Intercom::Client.new(token: 'my_token')
 ```
 
 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).
@@ -79,7 +82,7 @@ intercom.users.all.each {|user| puts %Q(#{user.email} - #{user.custom_attributes
 intercom.users.all.map {|user| user.email }
 
 #Bulk operations.
-# Submit bulk job, to create users
+# 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"}])
 # 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"}])
@@ -328,7 +331,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.
 
-Bulk operations. 
+Bulk operations.
 ```ruby
 # Submit bulk job, to create events
 intercom.events.submit_bulk_job(create_items: [

data/changes.txt

@@ -1,3 +1,6 @@
+3.4.0
+ - Add a "token" keyword for OAuth clients
+
 3.3.0
  - Add Bulk API support
 

data/lib/intercom/client.rb

@@ -1,7 +1,8 @@
 module Intercom
+  class MisconfiguredClientError < StandardError; end
   class Client
     include Options
-    attr_reader :base_url, :rate_limit_details
+    attr_reader :base_url, :rate_limit_details, :username_part, :password_part
 
     class << self
       def set_base_url(base_url)
@@ -13,9 +14,16 @@ module Intercom
       end
     end
 
-    def initialize(app_id: 'my_app_id', api_key: 'my_api_key')
-      @app_id = app_id
-      @api_key = api_key
+    def initialize(app_id: 'my_app_id', api_key: 'my_api_key', token: nil)
+      if token
+        @username_part = token
+        @password_part = ""
+      else
+        @username_part = app_id
+        @password_part = api_key
+      end
+      validate_credentials!
+
       @base_url = 'https://api.intercom.io'
       @rate_limit_details = {}
     end
@@ -90,8 +98,13 @@ module Intercom
 
     private
 
+    def validate_credentials!
+      error = MisconfiguredClientError.new("app_id and api_key must not be nil")
+      fail error if @username_part.nil?
+    end
+
     def execute_request(request)
-      result = request.execute(@base_url, username: @app_id, secret: @api_key)
+      result = request.execute(@base_url, username: @username_part, secret: @password_part)
       @rate_limit_details = request.rate_limit_details
       result
     end

data/lib/intercom/service/tag.rb

@@ -11,6 +11,7 @@ module Intercom
       include ApiOperations::List
       include ApiOperations::Find
       include ApiOperations::FindAll
+      include ApiOperations::Delete
 
       def collection_class
         Intercom::Tag

data/lib/intercom/version.rb

@@ -1,3 +1,3 @@
 module Intercom #:nodoc:
-  VERSION = "3.3.0"
+  VERSION = "3.4.0"
 end

data/spec/unit/intercom/client_spec.rb

@@ -17,5 +17,16 @@ module Intercom
       client.base_url.must_equal('https://api.intercom.io')
     end
 
+    it 'should raise on nil credentials' do
+      proc { Client.new(app_id: nil, api_key: nil) }.must_raise MisconfiguredClientError
+    end
+
+    describe 'OAuth clients' do
+      it 'supports "token"' do
+        client = Client.new(token: 'foo')
+        client.username_part.must_equal('foo')
+        client.password_part.must_equal('')
+      end
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: intercom
 version: !ruby/object:Gem::Version
-  version: 3.3.0
+  version: 3.4.0
 platform: ruby
 authors:
 - Ben McRedmond
@@ -15,7 +15,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-10 00:00:00.000000000 Z
+date: 2016-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -221,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: intercom
-rubygems_version: 2.2.3
+rubygems_version: 2.2.5
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for the Intercom API
@@ -246,3 +246,4 @@ test_files:
 - spec/unit/intercom/traits/api_resource_spec.rb
 - spec/unit/intercom/user_spec.rb
 - spec/unit/intercom_spec.rb
+has_rdoc: