rdstation-ruby-client 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 5ca94a755162557e5fcca58d15583986492ee1ef64c569c54d7c8a6feab6edec
-  data.tar.gz: 7b258da27dd4f13148e2f9de60a4a95eb32131fb0e5e0d8f5cc133eb3e4720fd
+SHA1:
+  metadata.gz: adcf1abef180f5dd333152cc6956191fd637f09e
+  data.tar.gz: 22ad74012fcef08e888ef1d72fb73989f84ee651
 SHA512:
-  metadata.gz: 28bf2fc07e73df574917d1b441867146d3120d44a7e72599399648b118922c04c7e4fc75364180bdc175c14ee77c2452cf7ff02885d83d7daf6924c642876759
-  data.tar.gz: c70a26f5d2b8a42d6b4deb8ee3de27ad817262e58b033a88200bcda04f9c36e468f2ce919b25d29181d810eb286a018a8eaed52eb04e4f545682e7a36b7a3876
+  metadata.gz: ad4409d04b424d90f74bab2a3d5264b7a0fe1b74b233840befff8e21a8597c40cb1cd99767292322b65a3ee309d809ad9a00ec8a851855476471fc89bb1a240c
+  data.tar.gz: 54f42eac6c63524bdacfb2c00548f3e9fdc5b0b63554c9c3ceca15f0afc24c800339506582127ebcc21b59e2b39f15ba5b3e20fe3eca9a658d0a258c9b380b5c

data/CHANGELOG.md

@@ -1,8 +1,14 @@
+## 2.1.0
+
+### Additions
+
+`RDStation::Authentication.revoke`  added. This method revokes an access_token at RD Station.
+
 ## 2.0.0
 
 ### Removals
 
-All API methods that were called directly on `RDStation::Client` (ex: `RDStation::Client.new('rdstation_token', 'auth_token').create_lead(lead_info)`) have been removed. See the [upgrading guide](#Upgrading-to-version-2.0.0) for a comprehensive guide on how to upgrade from version 1.2.x.
+All API methods that were called directly on `RDStation::Client` (ex: `RDStation::Client.new('rdstation_token', 'auth_token').create_lead(lead_info)`) have been removed. See the [migration guide](README.md#Upgrading-from-1.2.x-to-2.0.0) for a comprehensive guide on how to upgrade from version 1.2.x.
 
 ### Notable changes
 
@@ -52,8 +58,8 @@ In cause of Unahtorized (401), the following specific errors may be raised (thos
 
 `rdstation-ruby-client` now requires `ruby >= 2.0.0`.
 
-## 1.2.1 
+## 1.2.1
 
 ### Deprecations
 
-All API methods that were called directly on `RDStation::Client` (ex: `RDStation::Client.new('rdstation_token', 'auth_token').create_lead(lead_info)`) are now deprecated. Those methods call RDSM's 1.3 API and will be removed in the next release.
+All API methods that were called directly on `RDStation::Client` (ex: `RDStation::Client.new('rdstation_token', 'auth_token').create_lead(lead_info)`) are now deprecated. Those methods call RDSM's 1.3 API and will be removed in the next release.

data/README.md

@@ -68,6 +68,14 @@ rdstation_authentication = RDStation::Authentication.new('client_id', 'client_se
 rdstation_authentication.update_access_token('refresh_token')
 ```
 
+#### Revoking an access_token
+
+```ruby
+RDStation::Authentication.revoke(access_token: "your token")
+```
+
+Note: this will completely remove your credentials from RD Station (`update_access_token` won't work anymore).
+
 ### Contacts
 
 #### Getting a Contact by UUID

data/lib/rdstation/authentication.rb

@@ -5,6 +5,7 @@ module RDStation
 
     AUTH_TOKEN_URL = 'https://api.rd.services/auth/token'.freeze
     DEFAULT_HEADERS = { 'Content-Type' => 'application/json' }.freeze
+    REVOKE_URL = 'https://api.rd.services/auth/revoke'.freeze
 
     def initialize(client_id, client_secret)
       @client_id = client_id
@@ -47,8 +48,31 @@ module RDStation
       ApiResponse.build(response)
     end
 
+    def self.revoke(access_token:)
+      response = self.post(
+        REVOKE_URL,
+        body: revoke_body(access_token),
+        headers: revoke_headers(access_token)
+      )
+      ApiResponse.build(response)
+    end
+
     private
 
+    def self.revoke_body(access_token)
+      URI.encode_www_form({
+        token: access_token,
+        token_type_hint: 'access_token'
+      })
+    end
+
+    def self.revoke_headers(access_token)
+      {
+        "Authorization" => "Bearer #{access_token}",
+        "Content-Type" => "application/x-www-form-urlencoded"
+      }
+    end
+
     def post_to_auth_endpoint(params)
       default_body = { client_id: @client_id, client_secret: @client_secret }
       body = default_body.merge(params)

data/lib/rdstation/version.rb

@@ -1,3 +1,3 @@
 module RDStation
-  VERSION = '2.0.0'.freeze
+  VERSION = '2.1.0'.freeze
 end

data/spec/lib/rdstation/authentication_spec.rb

@@ -174,4 +174,78 @@ RSpec.describe RDStation::Authentication do
       end
     end
   end
+
+  describe ".revoke" do
+    let(:revoke_endpoint) { 'https://api.rd.services/auth/revoke' }
+    let(:request_headers) do
+      {
+        "Authorization" => "Bearer #{access_token}",
+        "Content-Type" => "application/x-www-form-urlencoded"
+      }
+    end
+
+    context "valid access_token" do
+      let(:access_token) { "valid_access_token" }
+
+      let(:ok_response) do
+        {
+          status: 200,
+          headers: { 'Content-Type' => 'application/json' },
+          body: {}.to_json
+        }
+      end
+
+      before do
+        stub_request(:post, revoke_endpoint)
+          .with(
+            headers: request_headers,
+            body: URI.encode_www_form({
+              token: access_token,
+              token_type_hint: 'access_token'
+            })
+          )
+          .to_return(ok_response)
+      end
+
+      it "returns 200 code with an empty hash in the body" do
+        request_response = RDStation::Authentication.revoke(access_token: access_token)
+        expect(request_response).to eq({})
+      end
+    end
+
+    context "invalid access token" do
+      let(:access_token) { "invalid_access_token" }
+
+      let(:unauthorized_response) do
+        {
+          status: 401,
+          headers: { 'Content-Type' => 'application/json' },
+          body: {
+            errors: {
+              error_type: 'UNAUTHORIZED',
+              error_message: 'Invalid token.'
+            }
+          }.to_json
+        }
+      end
+
+      before do
+        stub_request(:post, revoke_endpoint)
+          .with(
+            headers: request_headers,
+            body: URI.encode_www_form({
+              token: access_token,
+              token_type_hint: 'access_token'
+            })
+          )
+          .to_return(unauthorized_response)
+      end
+
+      it "raises unauthorized" do
+        expect do
+          RDStation::Authentication.revoke(access_token: access_token)
+        end.to raise_error(RDStation::Error::Unauthorized)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Paulo L F Casaretto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,7 +184,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Ruby API wrapper for RD Station