easy_meli 0.6.2 → 0.6.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc240e7ae7a827cff6460162be1a9460f5e860676f3800a50d18ae3558f2976e
-  data.tar.gz: 714503d3e3886b1d491d1ea579d72f1d74e2408d476b9ada5ee6446f0efbb467
+  metadata.gz: b1338e416eb7581a2e568c8621f77789507d271bd0212936fa6c8d8ee7292025
+  data.tar.gz: fb5936ef060651fe095269d173dcda3a25ae97ae84d6bfc1386bec73d1d055d0
 SHA512:
-  metadata.gz: 7004c03b3ec4be44170bb4ea92c5ac2595ddd5d244a7e680a88e67d5bdc9eec0197ae7a7bd0970ac78d0912e42f04b9b44a65ee907e5333db479f569753853b2
-  data.tar.gz: 139f426a07c7782b73ea52959283b70e068f8565d9c5e646790cd7f3373b51eed3f3e179d418a72ddf746012c13f4ea735a133c023b59da4c6d8d24aed38ab91
+  metadata.gz: 7bf7cddd43e511f2b55bed1f68c5905e0362821a7c825bb1a8f5ce7d6dd3dc4892e5dc9fb1d8499a42d17cc30a3a117194ace8cc734899a8cbeef7d58ac974ed
+  data.tar.gz: a56c55e73b131f1f36bef43a3db22f5c68c92cd611cc2f448a7e9486a2d302c5489669e8aa87f19755f7ceb3858c502ea11fca97922444321390606b2d31b55f

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## V 0.6.7
+- Send `access_token` in the Authorization Header instead of the query params [See Official Documentation](https://developers.mercadolibre.com.ar/es_ar/desarrollo-seguro#header)
+
+## V 0.6.6
+- Classify status code 401 as EasyMeli::InvalidTokenError.
+
+## 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
 

data/README.md

@@ -63,7 +63,7 @@ You can also pass a logger to any methods that make remote calls. The logger cla
 
 ```ruby
 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)
+EasyMeli.api_client(access_token: access_token, logger: my_logger)
 ```
 
 ### Example of how to retrieve a user profile
@@ -73,8 +73,8 @@ EasyMeli.configure do |config|
   config.secret_key = "your_secret_key"
 end
 
-api_client = EasyMeli.api_client(refresh_token: refresh_token)
-response = api_client.get('/users/me')
+client = EasyMeli.api_client(access_token: access_token)
+response = client.get('/users/me')
 
 ```
 

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,16 +5,7 @@ class EasyMeli::ApiClient
 
   API_ROOT_URL = 'https://api.mercadolibre.com'
 
-  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
-  headers EasyMeli::DEFAULT_HEADERS
   format :json
 
   attr_reader :logger, :access_token
@@ -44,31 +35,36 @@ class EasyMeli::ApiClient
 
   def send_request(verb, path = '', params = {})
     query = params[:query] || params['query'] || {}
-    query[:access_token] = access_token if access_token
+    params[:headers] = EasyMeli::DEFAULT_HEADERS.merge(authorization_header)
 
     self.class.send(verb, path, params.merge(query)).tap do |response|
       logger&.log response
+      check_status(response)
       check_for_errors(response)
     end
   end
 
-  def check_for_errors(response)
-    return unless response.parsed_response.is_a? Hash
-
-    exception = error_class(response)
+  def check_status(response)
+    exception = EasyMeli::ErrorParser.status_error_class(response)
 
     if exception
       raise exception.new(response)
     end
   end
 
-  def error_class(body)
-    ERROR_LIST.find { |key, _| error_message_from_body(body).include?(key) }&.last
+  def check_for_errors(response)
+    return unless response.parsed_response.is_a?(Hash) && !response.body.nil?
+
+    exception = EasyMeli::ErrorParser.error_class(response)
+
+    if exception
+      raise exception.new(response)
+    end
   end
 
-  def error_message_from_body(response)
-    return if response.body.nil?
+  def authorization_header
+    return {} unless access_token
 
-    response['message'].to_s.empty? ? response['error'] : response['message']
+    { Authorization: "Bearer #{access_token}" }
   end
 end

data/lib/easy_meli/authorization_client.rb

@@ -54,7 +54,9 @@ class EasyMeli::AuthorizationClient
     if response.success?
       response.to_h[EasyMeli::AuthorizationClient::ACCESS_TOKEN_KEY]
     else
-      raise EasyMeli::InvalidTokenError.new(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,43 @@
+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 = {
+    401 => EasyMeli::InvalidTokenError,
+    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.status_code_listed?(response) || 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
+
+  def self.status_code_listed?(response)
+    STATUS_ERRORS.keys.include?(response.code)
+  end
+end

data/lib/easy_meli/errors.rb

@@ -65,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.2"
+  VERSION = "0.6.7"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_meli
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.7
 platform: ruby
 authors:
 - Eric Northam
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-01-28 00:00:00.000000000 Z
+date: 2021-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -130,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