Merge pull request #226 from intercom/BL/oauth

Support token keyword for oauth clients

Author: bobjflong

README.md

@@ -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).

lib/intercom/client.rb

@@ -2,7 +2,7 @@ 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)
@@ -14,9 +14,14 @@ def set_base_url(base_url)
       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'
@@ -95,11 +100,11 @@ def delete(path, payload_hash)
 
     def validate_credentials!
       error = MisconfiguredClientError.new("app_id and api_key must not be nil")
-      fail error if @app_id.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

spec/unit/intercom/client_spec.rb

@@ -20,5 +20,13 @@ module Intercom
     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