rdstation-ruby-client 2.3.1 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6526c586f6fb45ddb0851311da56f9525ca352eb2383dd46e746fe98c9642f7
-  data.tar.gz: c539bb37a63551c67b2e5d376bf08855f2a1a7371232b4490f7b3c06b1976c02
+  metadata.gz: d51df272057d17abe280b0fe23f7a97f9ef2ceb543f823db1ce8b047788d1887
+  data.tar.gz: d59bd8063663bb95df477c672066e4c6655172a193d9b2244bba6b8608a92869
 SHA512:
-  metadata.gz: c6c7f1555c420ac06ee04bfe1d2ff5596c4a7d92dd39990b1221ff386247dcf3142b78c065190030856183f2b0878f0bcaae55e0b01889e738a04dc735704767
-  data.tar.gz: e6fd2530aa309a93dac05b913ca7ab527d740ebd20fe640ea3c5fd87fe4449943a6c501d3902d2f9ecd40b79caa4431df143baccda99d642b3fe37ae13e25a20
+  metadata.gz: 1451abf2db818f4551575ea88befdb63b6f8f8b1afa3270b96ee50b059f0f69676d6c6104a6e217d58e9c84384527d77e81d257d5a222a1ab2df74e1ed525446
+  data.tar.gz: 06c2620cdf413e945207f7b0bad15bcdb762038b360ef3c9ed5371e2ff06edc4949f97602fc0c3ffc352ff14bf66774234c398b291a5606d34931ab0eded84e9

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 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
+
 ## 2.3.1
 
 - Fixed a bug when no error is found in the known errors list (issue [#52](https://github.com/ResultadosDigitais/rdstation-ruby-client/issues/52))

data/README.md

@@ -93,7 +93,7 @@ RDStation.configure do |config|
     # authorization.access_token_expires_in is the time (in seconds for with the token is valid)
     # authorization.access_token is the new token
     # authorization.refresh_token is the existing refresh_token
-    # 
+    #
     # If you are using ActiveRecord, you may want to update the stored access_token, like in the following code:
     MyStoredAuth.where(refresh_token: authorization.refresh_token).update_all(access_token: authorization.access_token)
   end
@@ -232,7 +232,7 @@ client.fields.create builder.build
 ```ruby
 payload = {} # hash representing the payload
 client = RDStation::Client.new(access_token: 'access_token', refresh_token: 'refresh_token')
-client.fields.update('FIELD_UUID', payload) 
+client.fields.update('FIELD_UUID', payload)
 ```
 Or you can use the new `RDStation::Builder::Field`
 
@@ -315,6 +315,7 @@ Each endpoint may raise errors accoording to the HTTP response code from RDStati
 - `RDStation::Error::Conflict` (409)
 - `RDStation::Error::UnsupportedMediaType` (415)
 - `RDStation::Error::UnprocessableEntity` (422)
+- `RDStation::Error::TooManyRequests` (429)
 - `RDStation::Error::InternalServerError` (500)
 - `RDStation::Error::NotImplemented` (501)
 - `RDStation::Error::BadGateway` (502)

data/lib/rdstation/error.rb

@@ -19,6 +19,7 @@ module RDStation
     class Conflict < Error; end
     class UnsupportedMediaType < Error; end
     class UnprocessableEntity < Error; end
+    class TooManyRequests < Error; end
     class InternalServerError < Error; end
     class NotImplemented < Error; end
     class BadGateway < Error; end

data/lib/rdstation/error/format.rb

@@ -8,6 +8,7 @@ module RDStation
       ARRAY_OF_HASHES = 'ARRAY_OF_HASHES'
       HASH_OF_MULTIPLE_TYPES = 'HASH_OF_MULTIPLE_TYPES'
       HASH_OF_HASHES = 'HASH_OF_HASHES'
+      SINGLE_HASH = 'SINGLE_HASH'
 
       def initialize(errors)
         @errors = errors
@@ -15,6 +16,7 @@ module RDStation
 
       def format
         return FLAT_HASH if flat_hash?
+        return SINGLE_HASH if single_hash?
         return HASH_OF_ARRAYS if hash_of_arrays?
         return HASH_OF_HASHES if hash_of_hashes?
         return HASH_OF_MULTIPLE_TYPES if hash_of_multiple_types?
@@ -24,6 +26,12 @@ module RDStation
 
       private
 
+      def single_hash?
+        return unless @errors.is_a?(Hash)
+
+        @errors.key?('error')
+      end
+
       def flat_hash?
         return unless @errors.is_a?(Hash)
 

data/lib/rdstation/error/formatter.rb

@@ -13,6 +13,8 @@ module RDStation
         return @error_response unless @error_response.is_a?(Hash)
 
         case error_format.format
+        when RDStation::Error::Format::SINGLE_HASH
+          return from_single_hash
         when RDStation::Error::Format::FLAT_HASH
           return from_flat_hash
         when RDStation::Error::Format::HASH_OF_ARRAYS
@@ -26,6 +28,19 @@ module RDStation
         errors
       end
 
+      def from_single_hash
+        error_hash = @error_response.dup
+        error_message = error_hash.delete('error')
+
+        [
+          {
+            'error_type' => 'TOO_MANY_REQUESTS',
+            'error_message' => error_message,
+            'details' => error_hash
+          }
+        ]
+      end
+
       def from_flat_hash
         [errors]
       end
@@ -60,7 +75,7 @@ module RDStation
       end
 
       def errors
-        @errors ||= @error_response['errors']
+        @errors ||= @error_response.fetch('errors', @error_response)
       end
 
       private

data/lib/rdstation/error_handler.rb

@@ -32,6 +32,7 @@ module RDStation
       when 409      then RDStation::Error::Conflict
       when 415      then RDStation::Error::UnsupportedMediaType
       when 422      then RDStation::Error::UnprocessableEntity
+      when 429      then RDStation::Error::TooManyRequests
       when 500      then RDStation::Error::InternalServerError
       when 501      then RDStation::Error::NotImplemented
       when 502      then RDStation::Error::BadGateway
@@ -57,7 +58,7 @@ module RDStation
     end
 
     def additional_error_attributes
-      {
+      attrs = {
         'headers' => response.headers,
         'body' => JSON.parse(response.body),
         'http_status' => response.code,

data/lib/rdstation/version.rb

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

data/spec/lib/rdstation/error/format_spec.rb

@@ -98,5 +98,22 @@ RSpec.describe RDStation::Error::Format do
         expect(result).to eq(RDStation::Error::Format::HASH_OF_HASHES)
       end
     end
+
+    context 'when receives a single hash with error' do
+      let(:errors) do
+        {
+          'error' => "'lead_limiter' rate limit exceeded for 86400 second(s) period for key ...",
+          'max' => 24,
+          'usage' => 55,
+          'remaining_time' => 20745,
+        }
+      end
+
+      it 'returns the SINGLE_HASH format' do
+        result = error_format.format
+        expect(result).to eq(RDStation::Error::Format::SINGLE_HASH)
+      end
+
+    end
   end
 end

data/spec/lib/rdstation/error/formatter_spec.rb

@@ -215,5 +215,35 @@ RSpec.describe RDStation::Error::Formatter do
         expect(result).to eq(expected_result)
       end
     end
+
+    context 'when receives a single hash of errors' do
+      let(:error_format) { instance_double(RDStation::Error::Format, format: RDStation::Error::Format::SINGLE_HASH) }
+
+      let(:error_response) do
+        {
+          'error' => "'lead_limiter' rate limit exceeded for 86400 second(s) period for key",
+          'max' => 24,
+          'usage' => 55,
+          'remaining_time' => 20745
+        }
+      end
+
+      let(:error_formatter) { described_class.new(error_response) }
+
+      let(:expected_result) do
+        [
+          {
+            'error_type' => 'TOO_MANY_REQUESTS',
+            'error_message' => "'lead_limiter' rate limit exceeded for 86400 second(s) period for key",
+            'details' => { 'max' => 24, 'usage' => 55, 'remaining_time' => 20745 }
+          }
+        ]
+      end
+
+      it 'returns an array of errors' do
+        result = error_formatter.to_array
+        expect(result).to eq(expected_result)
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdstation-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.3.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Paulo L F Casaretto
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-11 00:00:00.000000000 Z
+date: 2020-09-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -190,7 +190,7 @@ homepage: http://resultadosdigitais.com.br
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -205,9 +205,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Ruby API wrapper for RD Station
 test_files: