easy_meli 0.6.0 → 0.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e8de8ae979d9da175327ba9238ceabac72a6276f0e51a9d6a99fb35040f50f8
-  data.tar.gz: 613fa5048c19460f7b209552ea9d314e222f43092b9780a6f09eff6a10b07314
+  metadata.gz: 269c22ea4f450792d02935692db9eec8adc207fc8f44c946f1d3f439cce435b1
+  data.tar.gz: 00565d53e5a9e3b40235bce3723ab962d7e3f0a8fb912713330255de90b7980c
 SHA512:
-  metadata.gz: b19390ec2c0d7f62de4d2a7b57647d565c82047a3ac094c27b1ae136128d8efaceb442bd23fa22d281003969c7ace0753c844c2d78b0cc042024d36669c1abda
-  data.tar.gz: 57325bba54d582992def8dd90ddaff390588b8cd400bdbaa3299803be7639f4e1520c08e5a1d226f0266decb54812650b096b39ebfa4a43908263521ac68ec92
+  metadata.gz: 7f3e5971e80a8a9b73b435186fad527d93e71f0d454208ecf78a412c5716726f28ab0fbc25cca60dc6701422adf089d05ae504a86d3b34efb918ef4ba1685223
+  data.tar.gz: 6f1e0cb4af4919bb9c15fbd15526787c1f13727b870d5b2345a36d67f5e790bd9602eb39fde70dcb137d62856eda5e789c2c3629962fb0c081d5ddc09d4fb738

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+on:
+  pull_request:
+    branches: [ master ]
+  push:
+    branches: [ master ]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: [ '2.6' ]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Setup ruby ${{ matrix.ruby_version }}
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+      - name: Setup cache key and directory for gems cache
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-use-ruby-${{ matrix.ruby_version }}-${{ hashFiles('**/Gemfile.lock') }}
+      - name: Bundle install
+        run: |
+          gem install bundler:1.17.0
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+      - name: Run tests
+        run: |
+          bundle exec rake test

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## V 0.6.5
+- Move Error class search to its own class and reuse it for ApiClient and AuthorizationClient
+- Raise EasyMeli exceptions for server side errors.
+
+## V 0.6.4
+- Add Unknown error support
+
+## V 0.6.3
+- Fix error when the api response doesn't include error or message keys.
+- Add right error message for forbidden error.
+
+## V 0.6.2
+- Update Error classification mechanism to use error message as first option
+
+## V 0.6.1
+- Fix a bug in the error raising in the authorization client introduced in V 0.6.0
+
 ## V 0.6.0
 - Classify an `invalid_token` response as an `InvalidTokenError`.
 - `Malformed access_token` error changed from `AuthenticationError` to `InvalidTokenError`.

data/lib/easy_meli.rb

@@ -3,6 +3,7 @@ require 'httparty'
 require 'easy_meli/version'
 require 'easy_meli/constants'
 require 'easy_meli/errors'
+require 'easy_meli/error_parser'
 require 'easy_meli/configuration'
 require 'easy_meli/authorization_client'
 require 'easy_meli/api_client'

data/lib/easy_meli/api_client.rb

@@ -5,17 +5,6 @@ class EasyMeli::ApiClient
 
   API_ROOT_URL = 'https://api.mercadolibre.com'
 
-  ERROR_LIST = {
-    'invalid_grant' => EasyMeli::InvalidGrantError,
-    'forbidden' => EasyMeli::ForbiddenError,
-    'invalid_token' => EasyMeli::InvalidTokenError,
-    'Malformed access_token' => EasyMeli::MalformedTokenError
-  }
-
-  STATUS_ERRORS = {
-    429 => EasyMeli::TooManyRequestsError
-  }
-
   base_uri API_ROOT_URL
   headers EasyMeli::DEFAULT_HEADERS
   format :json
@@ -51,30 +40,26 @@ class EasyMeli::ApiClient
 
     self.class.send(verb, path, params.merge(query)).tap do |response|
       logger&.log response
-      check_authentication(response)
       check_status(response)
+      check_for_errors(response)
     end
   end
 
-  def check_authentication(response)
-    response_message = error_message_from_body(response.to_h) if response.parsed_response.is_a? Hash
-    return if response_message.to_s.empty?
+  def check_status(response)
+    exception = EasyMeli::ErrorParser.status_error_class(response)
 
-    ERROR_LIST.keys.each do |key|
-      if response_message.include?(key)
-        exception = ERROR_LIST[key]
-        raise exception.new(response)
-      end
+    if exception
+      raise exception.new(response)
     end
   end
 
-  def error_message_from_body(body)
-    return if body.nil?
-    body['error'].to_s.empty? ? body['message'] : body['error']
-  end
+  def check_for_errors(response)
+    return unless response.parsed_response.is_a?(Hash) && !response.body.nil?
 
-  def check_status(response)
-    status_error = STATUS_ERRORS[response.code]
-    raise status_error.new(response) if status_error
+    exception = EasyMeli::ErrorParser.error_class(response)
+
+    if exception
+      raise exception.new(response)
+    end
   end
 end

data/lib/easy_meli/authorization_client.rb

@@ -45,7 +45,7 @@ class EasyMeli::AuthorizationClient
     if response.success?
       response.to_h
     else
-      raise EasyMeli::AuthenticationError.new('Error Creating Token', response)
+      raise EasyMeli::CreateTokenError.new(response)
     end
   end
 
@@ -54,7 +54,9 @@ class EasyMeli::AuthorizationClient
     if response.success?
       response.to_h[EasyMeli::AuthorizationClient::ACCESS_TOKEN_KEY]
     else
-      raise EasyMeli::AuthenticationError.new('Error Refreshing Token', response)
+      exception = EasyMeli::ErrorParser.error_class(response) || EasyMeli::InvalidTokenError
+
+      raise exception.new(response)
     end
   end
 

data/lib/easy_meli/error_parser.rb

@@ -0,0 +1,38 @@
+class EasyMeli::ErrorParser
+  ERROR_LIST = {
+    'Error validating grant' => EasyMeli::InvalidGrantError,
+    'The User ID must match the consultant\'s' => EasyMeli::ForbiddenError,
+    'invalid_token' => EasyMeli::InvalidTokenError,
+    'Malformed access_token' => EasyMeli::MalformedTokenError,
+    'too_many_requests' => EasyMeli::TooManyRequestsError,
+    'unknown_error' => EasyMeli::UnknownError
+  }
+
+  STATUS_ERRORS = {
+    500 => EasyMeli::InternalServerError,
+    501 => EasyMeli::NotImplementedError,
+    502 => EasyMeli::BadGatewayError,
+    503 => EasyMeli::ServiceUnavailableError,
+    504 => EasyMeli::GatewayTimeoutError
+  }
+
+  def self.error_class(response)
+    ERROR_LIST.find { |key, _| self.error_message_from_body(response)&.include?(key) }&.last
+  end
+
+  def self.status_error_class(response)
+    return unless self.server_side_error?(response)
+
+    STATUS_ERRORS[response.code] || EasyMeli::ServerError
+  end
+
+  private
+
+  def self.error_message_from_body(response)
+    response['message'].to_s.empty? ? response['error'] : response['message']
+  end
+
+  def self.server_side_error?(response)
+    response.code >= 500
+  end
+end

data/lib/easy_meli/errors.rb

@@ -16,6 +16,14 @@ module EasyMeli
 
   class AuthenticationError < Error; end
 
+  class CreateTokenError < AuthenticationError
+    private
+
+    def local_message
+      'Error Creating Token'
+    end
+  end
+
   class InvalidGrantError < AuthenticationError
     private
 
@@ -57,4 +65,60 @@ module EasyMeli
       'Too many requests'
     end
   end
+
+  class UnknownError < Error
+    private
+
+    def local_message
+      'Unknown Error'
+    end
+  end
+
+  class ServerError < Error
+    private
+
+    def local_message
+      'Server Error'
+    end
+  end
+
+  class InternalServerError < ServerError
+    private
+
+    def local_message
+      'Internal Server Error'
+    end
+  end
+
+  class NotImplementedError < ServerError
+    private
+
+    def local_message
+      'Not Implemented'
+    end
+  end
+
+  class BadGatewayError < ServerError
+    private
+
+    def local_message
+      'Bad Gateway'
+    end
+  end
+
+  class ServiceUnavailableError < ServerError
+    private
+
+    def local_message
+      'Service Unavailable'
+    end
+  end
+
+  class GatewayTimeoutError < ServerError
+    private
+
+    def local_message
+      'Gateway Timeout'
+    end
+  end
 end

data/lib/easy_meli/version.rb

@@ -1,3 +1,3 @@
 module EasyMeli
-  VERSION = "0.6.0"
+  VERSION = "0.6.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_meli
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.5
 platform: ruby
 authors:
 - Eric Northam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-27 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -115,6 +115,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
@@ -129,6 +130,7 @@ files:
 - lib/easy_meli/authorization_client.rb
 - lib/easy_meli/configuration.rb
 - lib/easy_meli/constants.rb
+- lib/easy_meli/error_parser.rb
 - lib/easy_meli/errors.rb
 - lib/easy_meli/version.rb
 homepage: https://github.com/easybroker/easy_meli