easy_meli 0.3.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89f477f8757f02eec3581b7336db18264543b27dd335b5eda3c532fcf1566cec
-  data.tar.gz: dc55656ac52fcbe17a58659ce619fd4f20e90a8334f7ab3a3956f13a3a61caf4
+  metadata.gz: bc240e7ae7a827cff6460162be1a9460f5e860676f3800a50d18ae3558f2976e
+  data.tar.gz: 714503d3e3886b1d491d1ea579d72f1d74e2408d476b9ada5ee6446f0efbb467
 SHA512:
-  metadata.gz: 276d56f9e9dbd6fe0f6d544220b7942442fdf372ed8d22c5d6e87c1901dec997d8c6e432041cda289d1e855df08f76b449483ceb0bfc932afe8436d97a23b3e0
-  data.tar.gz: '0588f3f0451f110057e54ade0e1a68bbaaf8180c4aaf8cdf92e26c9e7616c475c73961d6c5552327bc350620676ce899dc6b21d058a650e719a6442976c1b25e'
+  metadata.gz: 7004c03b3ec4be44170bb4ea92c5ac2595ddd5d244a7e680a88e67d5bdc9eec0197ae7a7bd0970ac78d0912e42f04b9b44a65ee907e5333db479f569753853b2
+  data.tar.gz: 139f426a07c7782b73ea52959283b70e068f8565d9c5e646790cd7f3373b51eed3f3e179d418a72ddf746012c13f4ea735a133c023b59da4c6d8d24aed38ab91

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,15 @@
+# Changelog
+
+## 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

@@ -32,26 +32,26 @@ end
 To get the authorization url that the end-user uses to give your app authorization to access MercadoLibre on your part call the `authorization_url` with the desired country and the url to redirect to in order to complete the authorization.
 
 ```ruby
-EasyMeli::AuthorizationClient.authorization_url('MX', 'your_redirect_url')
+EasyMeli.authorization_url('MX', 'your_redirect_url')
 ```
 
 Once MercadoLibre calls your redirect url you can get a refresh token by calling
 
 ```ruby
-response = EasyMeli::AuthorizationClient.new.create_token('the_code_in_the_redirect', 'the_same_redirect_url_as_above')
+response = EasyMeli.create_token('the_code_in_the_redirect', 'the_same_redirect_url_as_above')
 ```
 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
-response = EasyMeli::AuthorizationClient.new.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::ApiClient.new(access_token)
+client = EasyMeli.api_client(access_token: access_token)
 
 client.get(path, query: { a: 1 })
 client.post(path, query: { a: 1 }, body: { b: 1 })
@@ -59,25 +59,21 @@ client.put(path, query: { a: 1 }, body: { b: 1 })
 client.delete(path, query: { a: 1 })
 ```
 
-You can also pass a logger when instantiating the `EasyMeli::ApiClient` or `EasyMeli::AuthorizationClient`. The logger class must implement a `log` method which will be called with the [HTTParty response](https://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/Response) for every remote request sent.
+You can also pass a logger to any methods that make remote calls. The logger class must implement a `log` method which will be called with the [HTTParty response](https://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/Response) for every remote request sent.
 
 ```ruby
-EasyMeli::AuthorizationClient.new(logger: my_logger)
-EasyMeli::ApiClient.new(access_token, logger: my_logger)
+EasyMeli.create_token('the_code_in_the_redirect', 'the_same_redirect_url_as_above', logger: my_logger)
+EasyMeli.api_client(refresh_token: refresh_token, logger: my_logger)
 ```
 
-### Complete example showing how to retrieve a user profile
+### Example of how to retrieve a user profile
 ```ruby
 EasyMeli.configure do |config|
   config.application_id = "your_app_id"
   config.secret_key = "your_secret_key"
 end
 
-authorization_client = EasyMeli::AuthorizationClient.new
-token = authorization_client.refresh_token(previously_stored_refresh_token).to_h['access_token']
-
-api_client = EasyMeli::ApiClient.new(token)
-
+api_client = EasyMeli.api_client(refresh_token: refresh_token)
 response = api_client.get('/users/me')
 
 ```

data/lib/easy_meli.rb

@@ -16,4 +16,21 @@ module EasyMeli
   def self.configure
     yield(configuration)
   end
+
+  def self.authorization_url(country_code, redirect_uri)
+    EasyMeli::AuthorizationClient.authorization_url(country_code, redirect_uri)
+  end
+
+  def self.create_token(code, redirect_uri, logger: nil)
+    EasyMeli::AuthorizationClient.create_token(code, redirect_uri, logger: logger)
+  end
+
+  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.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,19 +5,21 @@ 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,
+    'forbidden' => 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
 
   attr_reader :logger, :access_token
 
-  def initialize(access_token, logger: nil)
+  def initialize(access_token = nil, logger: nil)
     @logger = logger
     @access_token = access_token
   end
@@ -42,27 +44,31 @@ class EasyMeli::ApiClient
 
   def send_request(verb, path = '', params = {})
     query = params[:query] || params['query'] || {}
-    query[:access_token] = access_token
+    query[:access_token] = access_token if access_token
 
     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
 
-    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)
+    return if response.body.nil?
+
+    response['message'].to_s.empty? ? response['error'] : response['message']
   end
 end

data/lib/easy_meli/authorization_client.rb

@@ -20,6 +20,7 @@ class EasyMeli::AuthorizationClient
     PT: 'https://auth.mercadolibre.com.pt',
     DO: 'https://auth.mercadolibre.com.do'
   }
+  ACCESS_TOKEN_KEY = 'access_token'
 
   headers EasyMeli::DEFAULT_HEADERS
   format :json
@@ -34,12 +35,30 @@ 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
 
-  def create_token(code, redirect_uri)
+  def self.create_token(code, redirect_uri, logger: nil)
+    response = self.new(logger: logger).create_token_with_response(code, redirect_uri)
+    if response.success?
+      response.to_h
+    else
+      raise EasyMeli::CreateTokenError.new(response)
+    end
+  end
+
+  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::InvalidTokenError.new(response)
+    end
+  end
+
+  def create_token_with_response(code, redirect_uri)
     query_params = merge_auth_params(
       grant_type: 'authorization_code',
       code: code,
@@ -48,7 +67,7 @@ class EasyMeli::AuthorizationClient
     post_auth(query_params)
   end
 
-  def refresh_token(refresh_token)
+  def access_token_with_response(refresh_token)
     query_params = merge_auth_params(
       grant_type: 'refresh_token',
       refresh_token: refresh_token
@@ -65,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
@@ -76,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.3.1"
+  VERSION = "0.6.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_meli
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.6.2
 platform: ruby
 authors:
 - Eric Northam
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-18 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: []