easy_meli 0.4.0 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee793dc5802586adac55653bb44e8183f2903583fe2463e57d3f6ba6f8f87810
-  data.tar.gz: bddc2f0e96a9d2080088af552aba50cdf02530d869d92837ddb8d1339a5450b0
+  metadata.gz: 55e9bca011c82596149caa2a4bbddbe3350aa239936c1687406172531d7ec62c
+  data.tar.gz: 25b16a878e1c1fb9a8f8d6e5cbe1df2171b69d7b41912e72bb45133a9cdfe8f0
 SHA512:
-  metadata.gz: 301620aaaabac2777da9d129f043aca962af57c2e6c93138a4f75ed741a4ff05a977971e94352f611c80107a485f0bf0e6935f7ce2732a2f4470bfa950ad6606
-  data.tar.gz: 4ef357f6574ca2883befdcfac864397cdc2c402adcc6bc81e5e3fde337e36254b48553b5e882f99011238027061611ba2be9a0d8c0af8aef400c2a6ede17eff0
+  metadata.gz: 82a0a0178335a821c1113f775fffef25fb4f81eb8ae992f44308dd0f0d7d51fac92db23d56445e99c634dd17f86a959baeacd6237f91892358c4bf8511b9ae9d
+  data.tar.gz: 18da80bf6afefcb08394578f2a7e8c95220640c52b13bd2ff605648a90650d1376ba50f044b83f2a60089afbbaae3828ead52cadb0d42a6f013cc7ee3bddb036

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

@@ -0,0 +1,19 @@
+# Changelog
+
+## 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`.
+
+## V 0.5.0
+- `self.api_client` Prevent access_token override when initialize together with a refresh_token.
+- Raises a EasyMeli::TooManyRequestsError if a 429 response status is returned.

data/README.md

@@ -42,16 +42,16 @@ response = EasyMeli.create_token('the_code_in_the_redirect', 'the_same_redirect_
 ```
 This will return a response object with a json body that you can easily access via `response.to_h`.
 
-If you want to refresh the token call 
+If you want to refresh the token call
 
 ```ruby
-access_token = EasyMeli.refresh_token('a_refresh_token')
+access_token = EasyMeli.access_token('a_refresh_token')
 ```
 
 Once you can have an access token you can create a client and call the supported http verb methods.
 
 ```ruby
-client = EasyMeli.api_client(refresh_token: refresh_token)
+client = EasyMeli.api_client(access_token: access_token)
 
 client.get(path, query: { a: 1 })
 client.post(path, query: { a: 1 }, body: { b: 1 })

data/lib/easy_meli.rb

@@ -25,12 +25,12 @@ module EasyMeli
     EasyMeli::AuthorizationClient.create_token(code, redirect_uri, logger: logger)
   end
 
-  def self.refresh_token(refresh_token, logger: nil)
-    EasyMeli::AuthorizationClient.refresh_token(refresh_token, logger: logger)
+  def self.access_token(refresh_token, logger: nil)
+    EasyMeli::AuthorizationClient.access_token(refresh_token, logger: logger)
   end
 
   def self.api_client(access_token: nil, refresh_token: nil, logger: nil)
-    access_token = self.refresh_token(refresh_token, logger: logger) if refresh_token
+    access_token ||= self.access_token(refresh_token, logger: logger) if refresh_token
     EasyMeli::ApiClient.new(access_token, logger: logger)
   end
 end

data/lib/easy_meli/api_client.rb

@@ -5,13 +5,15 @@ class EasyMeli::ApiClient
 
   API_ROOT_URL = 'https://api.mercadolibre.com'
 
-  TOKEN_ERRORS = {
-    'invalid_grant' => 'Invalid Grant',
-    'forbidden' => 'Forbidden',
-    'Malformed access_token' => 'Malformed access token'
+  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
   }
 
-  base_uri API_ROOT_URL 
+  base_uri API_ROOT_URL
   headers EasyMeli::DEFAULT_HEADERS
   format :json
 
@@ -46,23 +48,25 @@ class EasyMeli::ApiClient
 
     self.class.send(verb, path, params.merge(query)).tap do |response|
       logger&.log response
-      check_authentication(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_for_errors(response)
+    return unless response.parsed_response.is_a?(Hash) && !response.body.nil?
 
-    TOKEN_ERRORS.keys.each do |key|
-      if response_message.include?(key)
-        raise EasyMeli::AuthenticationError.new(TOKEN_ERRORS[key], response)
-      end
+    exception = error_class(response)
+
+    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']
+  def error_class(body)
+    ERROR_LIST.find { |key, _| error_message_from_body(body)&.include?(key) }&.last
+  end
+
+  def error_message_from_body(response)
+    response['message'].to_s.empty? ? response['error'] : response['message']
   end
 end

data/lib/easy_meli/authorization_client.rb

@@ -35,7 +35,7 @@ class EasyMeli::AuthorizationClient
     params = {
       client_id: EasyMeli.configuration.application_id,
       response_type: 'code',
-      redirect_uri: redirect_uri 
+      redirect_uri: redirect_uri
     }
     HTTParty::Request.new(:get, country_auth_url(country_code), query: params).uri.to_s
   end
@@ -45,16 +45,16 @@ 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
 
-  def self.refresh_token(refresh_token, logger: nil)
-    response = self.new(logger: logger).refresh_token_with_response(refresh_token)
+  def self.access_token(refresh_token, logger: nil)
+    response = self.new(logger: logger).access_token_with_response(refresh_token)
     if response.success?
       response.to_h[EasyMeli::AuthorizationClient::ACCESS_TOKEN_KEY]
     else
-      raise EasyMeli::AuthenticationError.new('Error Refreshing Token', response)
+      raise EasyMeli::InvalidTokenError.new(response)
     end
   end
 
@@ -67,7 +67,7 @@ class EasyMeli::AuthorizationClient
     post_auth(query_params)
   end
 
-  def refresh_token_with_response(refresh_token)
+  def access_token_with_response(refresh_token)
     query_params = merge_auth_params(
       grant_type: 'refresh_token',
       refresh_token: refresh_token
@@ -84,7 +84,7 @@ class EasyMeli::AuthorizationClient
   end
 
   def self.country_auth_url(country_code)
-    url = BASE_AUTH_URLS[country_code.to_s.upcase.to_sym] || 
+    url = BASE_AUTH_URLS[country_code.to_s.upcase.to_sym] ||
       (raise ArgumentError.new('%s is an invalid country code' % country_code))
     [url, AUTH_PATH].join
   end
@@ -95,4 +95,4 @@ class EasyMeli::AuthorizationClient
       client_secret: EasyMeli.configuration.secret_key
     )
   end
-end
+end

data/lib/easy_meli/errors.rb

@@ -2,11 +2,67 @@ module EasyMeli
   class Error < StandardError
     attr_reader :response
 
-    def initialize(message, response)
+    def initialize(response)
       @response = response
-      super(message)
+      super(local_message)
+    end
+
+    private
+
+    def local_message
+      raise NotImplementedError
     end
   end
 
   class AuthenticationError < Error; end
-end
+
+  class CreateTokenError < AuthenticationError
+    private
+
+    def local_message
+      'Error Creating Token'
+    end
+  end
+
+  class InvalidGrantError < AuthenticationError
+    private
+
+    def local_message
+      'Invalid Grant'
+    end
+  end
+
+  class ForbiddenError < AuthenticationError
+    private
+
+    def local_message
+      'Forbidden'
+    end
+  end
+
+  class AccessTokenError < Error; end
+
+  class InvalidTokenError < AccessTokenError
+    private
+
+    def local_message
+      'Invalid Token'
+    end
+  end
+
+  class MalformedTokenError < AccessTokenError
+    private
+
+    def local_message
+      'Malformed access token'
+    end
+  end
+
+  class TooManyRequestsError < Error
+    private
+
+    def local_message
+      'Too many requests'
+    end
+  end
+end

data/lib/easy_meli/version.rb

@@ -1,3 +1,3 @@
 module EasyMeli
-  VERSION = "0.4.0"
+  VERSION = "0.6.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_meli
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.3
 platform: ruby
 authors:
 - Eric Northam
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-19 00:00:00.000000000 Z
+date: 2021-01-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -108,14 +108,16 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - eric@northam.us
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -135,7 +137,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/easybroker/easy_meli
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -150,8 +152,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A simple gem to work with MercadoLibre's API
 test_files: []