easy_meli 0.3.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d17badfe56ecab178ff6cb784e9d78bb8c0cd4ac9421e5ea356a52212622c76a
-  data.tar.gz: 4f40821e57261ade83265e971ea8a45a85db038fff68b26744daeaedf80c87fd
+  metadata.gz: 8c8dc1140d9368b076baf0a49a9742aea8de95565a90512152c9c58ec2b98723
+  data.tar.gz: 543cbed2c4789b0259b62f11d332a02c3b5b281feb2c5b60c5f87fd8640c0754
 SHA512:
-  metadata.gz: 8b95637656926bd1b393ed569c136cb5f486b2c76ec46ef733eabb1746ef52a062d4f669c0b068ca93c2dd0dc52641483b9866304fa10a9e8c22847254971387
-  data.tar.gz: 5c2310fbd9282c91f5777596d05f3504585cd394f3f31a59a1a514a41953593cd5422c87db971f4b3a5ce77b6989e8251676d7bd6257135fff79d24915ca3e30
+  metadata.gz: c2a7ecfa32beed3a9329b01312b1cfd4ed70fceb26469dc90e8d0d2c3b42186a9c1ec06f115f1dc5fa15236aa48d99b7e074a089fad7f710bddaf2bcb324680a
+  data.tar.gz: dfc01a8544c0f2d23711888fdfa3fb6a6f6f68196782d41cb501c1f50d53900882fb5c1b8d7a9f88e610eb1fafc8112447943ff87b8793af7fccd29e800a6d17

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

@@ -1,12 +1,14 @@
 require 'httparty'
 
 require 'easy_meli/version'
+require 'easy_meli/constants'
 require 'easy_meli/errors'
 require 'easy_meli/configuration'
 require 'easy_meli/authorization_client'
 require 'easy_meli/api_client'
 
 module EasyMeli
+
   def self.configuration
     @configuration ||= Configuration.new
   end
@@ -14,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,18 +5,24 @@ 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 = {
+    'invalid_grant' => EasyMeli::InvalidGrantError,
+    'forbidden' => EasyMeli::ForbiddenError,
+    'invalid_token' => EasyMeli::InvalidTokenError,
+    'Malformed access_token' => EasyMeli::MalformedTokenError
   }
 
-  base_uri API_ROOT_URL 
+  STATUS_ERRORS = {
+    429 => EasyMeli::TooManyRequestsError
+  }
+
+  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
@@ -41,20 +47,23 @@ 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_status(response)
     end
   end
 
   def check_authentication(response)
-    response_message = error_message_from_body(response.to_h)
+    response_message = error_message_from_body(response.to_h) if response.parsed_response.is_a? Hash
     return if response_message.to_s.empty?
-    
-    TOKEN_ERRORS.keys.each do |key|
+
+    ERROR_LIST.keys.each do |key|
       if response_message.include?(key)
-        raise EasyMeli::AuthenticationError.new(TOKEN_ERRORS[key], response)
+        exception = ERROR_LIST[key]
+        raise exception.new(response)
       end
     end
   end
@@ -63,4 +72,9 @@ class EasyMeli::ApiClient
     return if body.nil?
     body['error'].to_s.empty? ? body['message'] : body['error']
   end
-end
+
+  def check_status(response)
+    status_error = STATUS_ERRORS[response.code]
+    raise status_error.new(response) if status_error
+  end
+end

data/lib/easy_meli/authorization_client.rb

@@ -20,7 +20,9 @@ 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
 
   attr_reader :logger
@@ -33,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,
@@ -47,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
@@ -64,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
@@ -75,4 +95,4 @@ class EasyMeli::AuthorizationClient
       client_secret: EasyMeli.configuration.secret_key
     )
   end
-end
+end

data/lib/easy_meli/constants.rb

@@ -0,0 +1,8 @@
+module EasyMeli
+  USER_AGENT = "EasyMeli-%s" % VERSION
+  DEFAULT_HEADERS = {
+    'Content-Type' => 'application/json',
+    'Accept' => 'application/json',
+    'User-Agent' => USER_AGENT
+  }
+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.0"
+  VERSION = "0.6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_meli
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Eric Northam
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2021-01-27 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
@@ -127,6 +129,7 @@ files:
 - lib/easy_meli/api_client.rb
 - lib/easy_meli/authorization_client.rb
 - lib/easy_meli/configuration.rb
+- lib/easy_meli/constants.rb
 - lib/easy_meli/errors.rb
 - lib/easy_meli/version.rb
 homepage: https://github.com/easybroker/easy_meli
@@ -134,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
@@ -149,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: []