rdstation-ruby-client 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d8b49b1c3af26dff4944b5a246306050577424f
-  data.tar.gz: 3e4238d351ee0b2820370d4c7b9ea8285f565fd6
+  metadata.gz: 49d611a1dd83c95db29c6fd6abaf5e174d0cfaab
+  data.tar.gz: 47644e5e101c69feeacd833935dae34764a915e5
 SHA512:
-  metadata.gz: 14804ae659e189e1ac5f1d3880e8fe7071a1dcbdb035a237e12b06b5f7ee9113d067eb86b28fb63fe47c2dc76cd499e64b7b74bf36d1e0393ff960b892fdee91
-  data.tar.gz: 2fbd0fbe9a184a30b592747d5dcc79b4714c187b993428a69526d1f3a16f0918726ef4abd3fea21fcba23484aef92e23360ed6ab39e19817858751000a76fa1f
+  metadata.gz: f9d6ddc90bab5f0ba6a9403a10f4cd6efad29f31c2998f2ea1cbac80996caf1e97bcccc6c59a27a3723c311ba505b7f4fef3f45685fe7fd1d99115b64736731f
+  data.tar.gz: 628b0e48df49f7082784d6a84e4d6a31590237f9140198bed8206d7e1a12c545f87dfcb0512f418af785735b10719fee8f4736391ad4ffebdf6a5c2d5827b975

data/README.md

@@ -47,6 +47,33 @@ rdstation_client = RDStation::Client.new('rdstation_token', 'auth_token')
 rdstation_client.change_lead_status(email: 'joe@foo.bar', status: 'won', value: 999)
 ```
 
+### Authentication
+
+#### Getting authentication URL 
+
+```ruby
+rdstation_authentication = RDStation::Authentication.new('client_id', 'client_secret')
+
+redirect_url = 'https://yourapp.org/auth/callback'
+rdstation_authentication.auth_url(redirect_url)
+```
+
+#### Getting access_token 
+
+You will need the code param that is returned from RD Station to your application after the user confirms the access at the authorization dialog.
+
+```ruby
+rdstation_authentication = RDStation::Authentication.new('client_id', 'client_secret')
+rdstation_authentication.authenticate(code_returned_from_rdstation)
+```
+
+#### Updating access_token 
+
+```ruby
+rdstation_authentication = RDStation::Authentication.new('client_id', 'client_secret')
+rdstation_authentication.update_access_token('refresh_token')
+```
+
 ### Contacts
 
 #### Getting a Contact by UUID

data/lib/rdstation-ruby-client.rb

@@ -1,3 +1,4 @@
 require "httparty"
 require "rdstation/client"
 require "rdstation/contacts"
+require "rdstation/authentication"

data/lib/rdstation/authentication.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+module RDStation
+  class Authentication
+    include HTTParty
+
+    def initialize(client_id, client_secret)
+      @client_id = client_id
+      @client_secret = client_secret
+    end
+
+    #
+    # param redirect_url
+    #  URL that the user will be redirected
+    #  after confirming application authorization 
+    #
+    def auth_url(redirect_url)
+      "https://api.rd.services/auth/dialog?client_id=#{@client_id}&redirect_url=#{redirect_url}"
+    end
+
+    #
+    # param code
+    #   parameter sent by RDStation after user confirms authorization  
+    #
+    def authenticate(code)
+      post_to_auth_endpoint({ :code => code })
+    end
+
+    #
+    # param refresh_token
+    #   parameter sent by RDStation after authenticate  
+    #
+    def update_access_token(refresh_token)
+      post_to_auth_endpoint({ :refresh_token => refresh_token })
+    end
+
+    private
+
+      def auth_token_url
+        "https://api.rd.services/auth/token"
+      end
+
+      def post_to_auth_endpoint(params)
+        default_body = { :client_id => @client_id, :client_secret => @client_secret }
+
+        self.class.post(
+          auth_token_url,
+          :headers => {
+            "Accept-Encoding": "identity"
+          },
+          :body => default_body.merge(params)
+        )
+      end
+  end
+end

data/lib/rdstation/version.rb

@@ -1,3 +1,3 @@
 module RDStation
-  VERSION = '0.1'.freeze
+  VERSION = '0.1.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Paulo L F Casaretto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-03 00:00:00.000000000 Z
+date: 2018-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,6 +122,7 @@ files:
 - README.md
 - Rakefile
 - lib/rdstation-ruby-client.rb
+- lib/rdstation/authentication.rb
 - lib/rdstation/client.rb
 - lib/rdstation/contacts.rb
 - lib/rdstation/version.rb