easy_meli 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89f477f8757f02eec3581b7336db18264543b27dd335b5eda3c532fcf1566cec
-  data.tar.gz: dc55656ac52fcbe17a58659ce619fd4f20e90a8334f7ab3a3956f13a3a61caf4
+  metadata.gz: ee793dc5802586adac55653bb44e8183f2903583fe2463e57d3f6ba6f8f87810
+  data.tar.gz: bddc2f0e96a9d2080088af552aba50cdf02530d869d92837ddb8d1339a5450b0
 SHA512:
-  metadata.gz: 276d56f9e9dbd6fe0f6d544220b7942442fdf372ed8d22c5d6e87c1901dec997d8c6e432041cda289d1e855df08f76b449483ceb0bfc932afe8436d97a23b3e0
-  data.tar.gz: '0588f3f0451f110057e54ade0e1a68bbaaf8180c4aaf8cdf92e26c9e7616c475c73961d6c5552327bc350620676ce899dc6b21d058a650e719a6442976c1b25e'
+  metadata.gz: 301620aaaabac2777da9d129f043aca962af57c2e6c93138a4f75ed741a4ff05a977971e94352f611c80107a485f0bf0e6935f7ce2732a2f4470bfa950ad6606
+  data.tar.gz: 4ef357f6574ca2883befdcfac864397cdc2c402adcc6bc81e5e3fde337e36254b48553b5e882f99011238027061611ba2be9a0d8c0af8aef400c2a6ede17eff0

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 
 
 ```ruby
-response = EasyMeli::AuthorizationClient.new.refresh_token('a_refresh_token')
+access_token = EasyMeli.refresh_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(refresh_token: refresh_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.refresh_token(refresh_token, logger: nil)
+    EasyMeli::AuthorizationClient.refresh_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
+    EasyMeli::ApiClient.new(access_token, logger: logger)
+  end
 end

data/lib/easy_meli/api_client.rb

@@ -17,7 +17,7 @@ class EasyMeli::ApiClient
 
   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,7 +42,7 @@ 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

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
@@ -39,7 +40,25 @@ class EasyMeli::AuthorizationClient
     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::AuthenticationError.new('Error Creating Token', response)
+    end
+  end
+
+  def self.refresh_token(refresh_token, logger: nil)
+    response = self.new(logger: logger).refresh_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)
+    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 refresh_token_with_response(refresh_token)
     query_params = merge_auth_params(
       grant_type: 'refresh_token',
       refresh_token: refresh_token

data/lib/easy_meli/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: easy_meli
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Eric Northam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-18 00:00:00.000000000 Z
+date: 2020-05-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty