rdstation-ruby-client 2.4.0 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d51df272057d17abe280b0fe23f7a97f9ef2ceb543f823db1ce8b047788d1887
-  data.tar.gz: d59bd8063663bb95df477c672066e4c6655172a193d9b2244bba6b8608a92869
+  metadata.gz: 5df3763feda5bcb841946b403695b54933c0fcc9b0b9da1c907146454e5311ff
+  data.tar.gz: 63cd80564336415bc361c3dfce276611d1b1a6b61c68554e4f1a212c73fd9c7e
 SHA512:
-  metadata.gz: 1451abf2db818f4551575ea88befdb63b6f8f8b1afa3270b96ee50b059f0f69676d6c6104a6e217d58e9c84384527d77e81d257d5a222a1ab2df74e1ed525446
-  data.tar.gz: 06c2620cdf413e945207f7b0bad15bcdb762038b360ef3c9ed5371e2ff06edc4949f97602fc0c3ffc352ff14bf66774234c398b291a5606d34931ab0eded84e9
+  metadata.gz: 60eded16372c0d970d67b5f456a28d8adb9e7f013f8551e56b72598752ea9a0c24f99fdf4f3c943f040872d71a837279d769b43ac7b2e36d2c0c5eaa8ae9f405
+  data.tar.gz: 1107d1405d1984cd36de905403f3a53a6275505e55ff4c4d5661f7914d268f11031d81c5602464ca2f573b61831d5516a437abe9501a1fd8a34549ec3a36753f

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 2.5.0
+
+- InvalidRefreshToken error added. This error will be raised when the refresh token is invalid or it was revoked. When you get this error, you can safely disconnect the user from RD Station.
+
+Usage example:
+
+```ruby
+begin
+  rdstation.update_access_token(refresh_token)
+rescue RDStation::Error::InvalidRefreshToken
+  # Disconnect user
+end
+```
+
 ## 2.4.0
 
 - Add the TooManyRequests errors in case of rate limit exceeded. See [API request limit](https://developers.rdstation.com/en/request-limit) for more details

data/Rakefile

@@ -5,3 +5,7 @@ RSpec::Core::RakeTask.new
 
 task :default => :spec
 task :test => :spec
+
+task :console do
+  exec 'pry -r rdstation-ruby-client -I ./lib'
+end

data/lib/rdstation/error.rb

@@ -35,5 +35,6 @@ module RDStation
     class ExpiredAccessToken < Unauthorized; end
     class ExpiredCodeGrant < Unauthorized; end
     class InvalidCredentials < Unauthorized; end
+    class InvalidRefreshToken < Unauthorized; end
   end
 end

data/lib/rdstation/error_handler/invalid_refresh_token.rb

@@ -0,0 +1,24 @@
+module RDStation
+  class ErrorHandler
+    class InvalidRefreshToken
+      attr_reader :errors
+
+      ERROR_CODE = 'INVALID_REFRESH_TOKEN'.freeze
+
+      def initialize(errors)
+        @errors = errors
+      end
+
+      def raise_error
+        return if invalid_refresh_token_error.empty?
+        raise RDStation::Error::InvalidRefreshToken, invalid_refresh_token_error
+      end
+
+      private
+
+      def invalid_refresh_token_error
+        errors.find { |error| error['error_type'] == ERROR_CODE }
+      end
+    end
+  end
+end

data/lib/rdstation/error_handler/unauthorized.rb

@@ -1,6 +1,7 @@
 require_relative 'expired_access_token'
 require_relative 'expired_code_grant'
 require_relative 'invalid_credentials'
+require_relative 'invalid_refresh_token'
 
 module RDStation
   class ErrorHandler
@@ -9,6 +10,7 @@ module RDStation
         ErrorHandler::ExpiredAccessToken,
         ErrorHandler::ExpiredCodeGrant,
         ErrorHandler::InvalidCredentials,
+        ErrorHandler::InvalidRefreshToken,
       ].freeze
 
       def initialize(array_of_errors)

data/lib/rdstation/version.rb

@@ -1,3 +1,3 @@
 module RDStation
-  VERSION = '2.4.0'.freeze
+  VERSION = '2.5.0'.freeze
 end

data/spec/lib/rdstation/authentication_spec.rb

@@ -217,19 +217,32 @@ RSpec.describe RDStation::Authentication do
     end
 
     context 'when the refresh token is invalid' do
+      let(:invalid_refresh_token_response) do
+        {
+          status: 401,
+          headers: { 'Content-Type' => 'application/json' },
+          body: {
+            errors: {
+              error_type: 'INVALID_REFRESH_TOKEN',
+              error_message: 'The provided refresh token is invalid or was revoked.'
+            }
+          }.to_json
+        }
+      end
+
       before do
         stub_request(:post, token_endpoint)
           .with(
             headers: request_headers,
             body: token_request_with_invalid_refresh_token.to_json
           )
-          .to_return(invalid_code_response)
+          .to_return(invalid_refresh_token_response)
       end
 
       it 'returns an auth error' do
         expect do
           authentication.update_access_token('invalid_refresh_token')
-        end.to raise_error(RDStation::Error::InvalidCredentials)
+        end.to raise_error(RDStation::Error::InvalidRefreshToken)
       end
     end
 

data/spec/lib/rdstation/error_handler/invalid_refresh_token_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+RSpec.describe RDStation::ErrorHandler::InvalidRefreshToken do
+  describe '#raise_error' do
+    subject(:invalid_refresh_token) { described_class.new(errors) }
+
+    context 'when the refresh token is invalid or was revoked' do
+      let(:errors) do
+        [
+          {
+            'error_type' => 'INVALID_REFRESH_TOKEN',
+            'error_message' => 'Error Message',
+          }
+        ]
+      end
+
+      it 'raises an InvalidRefreshToken error' do
+        expect do
+          invalid_refresh_token.raise_error
+        end.to raise_error(RDStation::Error::InvalidRefreshToken, 'Error Message')
+      end
+    end
+
+    context 'when none of the errors are invalid refresh token errors' do
+      let(:errors) do
+        [
+          {
+            'error_message' => 'Error Message',
+            'error_type' => 'RANDOM_ERROR_TYPE'
+          },
+          {
+            'error_message' => 'Another Error Message',
+            'error_type' => 'ANOTHER_RANDOM_ERROR_TYPE'
+          }
+        ]
+      end
+
+      it 'does not raise an InvalidRefreshToken error' do
+        result = invalid_refresh_token.raise_error
+        expect(result).to be_nil
+      end
+    end
+
+    context 'when there are no errors' do
+      let(:errors) { [] }
+
+      it 'does not raise an InvalidRefreshToken error' do
+        result = invalid_refresh_token.raise_error
+        expect(result).to be_nil
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 2.5.0
 platform: ruby
 authors:
 - Paulo L F Casaretto
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-16 00:00:00.000000000 Z
+date: 2020-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -156,6 +156,7 @@ files:
 - lib/rdstation/error_handler/expired_code_grant.rb
 - lib/rdstation/error_handler/invalid_credentials.rb
 - lib/rdstation/error_handler/invalid_event_type.rb
+- lib/rdstation/error_handler/invalid_refresh_token.rb
 - lib/rdstation/error_handler/unauthorized.rb
 - lib/rdstation/events.rb
 - lib/rdstation/fields.rb
@@ -177,6 +178,7 @@ files:
 - spec/lib/rdstation/error_handler/expired_code_grant_spec.rb
 - spec/lib/rdstation/error_handler/invalid_credentials_spec.rb
 - spec/lib/rdstation/error_handler/invalid_event_type_spec.rb
+- spec/lib/rdstation/error_handler/invalid_refresh_token_spec.rb
 - spec/lib/rdstation/error_handler/unauthorized_spec.rb
 - spec/lib/rdstation/error_handler_spec.rb
 - spec/lib/rdstation/error_spec.rb
@@ -190,7 +192,7 @@ homepage: http://resultadosdigitais.com.br
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -205,8 +207,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
-signing_key:
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
 specification_version: 4
 summary: Ruby API wrapper for RD Station
 test_files:
@@ -224,6 +227,7 @@ test_files:
 - spec/lib/rdstation/error_handler/expired_code_grant_spec.rb
 - spec/lib/rdstation/error_handler/invalid_credentials_spec.rb
 - spec/lib/rdstation/error_handler/invalid_event_type_spec.rb
+- spec/lib/rdstation/error_handler/invalid_refresh_token_spec.rb
 - spec/lib/rdstation/error_handler/unauthorized_spec.rb
 - spec/lib/rdstation/error_handler_spec.rb
 - spec/lib/rdstation/error_spec.rb