easy_meli 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d17badfe56ecab178ff6cb784e9d78bb8c0cd4ac9421e5ea356a52212622c76a
+  data.tar.gz: 4f40821e57261ade83265e971ea8a45a85db038fff68b26744daeaedf80c87fd
+SHA512:
+  metadata.gz: 8b95637656926bd1b393ed569c136cb5f486b2c76ec46ef733eabb1746ef52a062d4f669c0b068ca93c2dd0dc52641483b9866304fa10a9e8c22847254971387
+  data.tar.gz: 5c2310fbd9282c91f5777596d05f3504585cd394f3f31a59a1a514a41953593cd5422c87db971f4b3a5ce77b6989e8251676d7bd6257135fff79d24915ca3e30

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+/vender
+.DS_Store

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in easy_meli.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Eric Northam
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,97 @@
+# EasyMeli
+
+A simple gem to access low level MercadoLibre api calls. This is the draft beta version.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'easy_meli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install easy_meli
+
+## Usage
+
+Configure the gem with your application ID and secret key.
+
+```ruby
+EasyMeli.configure do |config|
+  config.application_id = 'your_app_id'
+  config.secret_key = 'your_secret_key'
+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')
+```
+
+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')
+```
+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')
+```
+
+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.get(path, query: { a: 1 })
+client.post(path, query: { a: 1 }, body: { b: 1 })
+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.
+
+```ruby
+EasyMeli::AuthorizationClient.new(logger: my_logger)
+EasyMeli::ApiClient.new(access_token, logger: my_logger)
+```
+
+### Complete example showing 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)
+
+response = api_client.get('/users/me')
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/easybroker/easy_meli.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "easy_meli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/easy_meli.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "easy_meli/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "easy_meli"
+  spec.version       = EasyMeli::VERSION
+  spec.authors       = ["Eric Northam"]
+  spec.email         = ["eric@northam.us"]
+
+  spec.summary       = %q{A simple gem to work with MercadoLibre's API}
+  spec.homepage      = "https://github.com/easybroker/easy_meli"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.18"
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "mocha"
+end

data/lib/easy_meli.rb

@@ -0,0 +1,17 @@
+require 'httparty'
+
+require 'easy_meli/version'
+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
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/easy_meli/api_client.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+class EasyMeli::ApiClient
+  include HTTParty
+
+  API_ROOT_URL = 'https://api.mercadolibre.com'
+
+  TOKEN_ERRORS = {
+    'invalid_grant' => 'Invalid Grant',
+    'forbidden' => 'Forbidden',
+    'Malformed access_token' => 'Malformed access token'
+  }
+
+  base_uri API_ROOT_URL 
+  format :json
+
+  attr_reader :logger, :access_token
+
+  def initialize(access_token, logger: nil)
+    @logger = logger
+    @access_token = access_token
+  end
+
+  def get(path, query: {})
+    send_request(:get, path, query: query)
+  end
+
+  def post(path, query: {}, body: {})
+    send_request(:post, path, query: query, body: body)
+  end
+
+  def put(path, query: {}, body: {})
+    send_request(:put, path, query: query, body: body)
+  end
+
+  def delete(path, query: {})
+    send_request(:delete, path, query: query)
+  end
+
+  private
+
+  def send_request(verb, path = '', params = {})
+    query = params[:query] || params['query'] || {}
+    query[:access_token] = access_token
+    self.class.send(verb, path, params.merge(query)).tap do |response|
+      logger&.log response
+      check_authentication(response)
+    end
+  end
+
+  def check_authentication(response)
+    response_message = error_message_from_body(response.to_h)
+    return if response_message.to_s.empty?
+    
+    TOKEN_ERRORS.keys.each do |key|
+      if response_message.include?(key)
+        raise EasyMeli::AuthenticationError.new(TOKEN_ERRORS[key], response)
+      end
+    end
+  end
+
+  def error_message_from_body(body)
+    return if body.nil?
+    body['error'].to_s.empty? ? body['message'] : body['error']
+  end
+end

data/lib/easy_meli/authorization_client.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+class EasyMeli::AuthorizationClient
+  include HTTParty
+
+  AUTH_TOKEN_URL = 'https://api.mercadolibre.com/oauth/token'
+  AUTH_PATH = '/authorization'
+  BASE_AUTH_URLS = {
+    AR: 'https://auth.mercadolibre.com.ar',
+    BR: 'https://auth.mercadolivre.com.br',
+    CO: 'https://auth.mercadolibre.com.co',
+    CR: 'https://auth.mercadolibre.com.cr',
+    EC: 'https://auth.mercadolibre.com.ec',
+    CL: 'https://auth.mercadolibre.cl',
+    MX: 'https://auth.mercadolibre.com.mx',
+    UY: 'https://auth.mercadolibre.com.uy',
+    VE: 'https://auth.mercadolibre.com.ve',
+    PA: 'https://auth.mercadolibre.com.pa',
+    PE: 'https://auth.mercadolibre.com.pe',
+    PT: 'https://auth.mercadolibre.com.pt',
+    DO: 'https://auth.mercadolibre.com.do'
+  }
+
+  format :json
+
+  attr_reader :logger
+
+  def initialize(logger: nil)
+    @logger = logger
+  end
+
+  def self.authorization_url(country_code, redirect_uri)
+    params = {
+      client_id: EasyMeli.configuration.application_id,
+      response_type: 'code',
+      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)
+    query_params = merge_auth_params(
+      grant_type: 'authorization_code',
+      code: code,
+      redirect_uri: redirect_uri
+    )
+    post_auth(query_params)
+  end
+
+  def refresh_token(refresh_token)
+    query_params = merge_auth_params(
+      grant_type: 'refresh_token',
+      refresh_token: refresh_token
+    )
+    post_auth(query_params)
+  end
+
+  private
+
+  def post_auth(params)
+    self.class.post(AUTH_TOKEN_URL, query: params).tap do |response|
+      logger&.log response
+    end
+  end
+
+  def self.country_auth_url(country_code)
+    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
+
+  def merge_auth_params(options = {})
+    options.merge(
+      client_id: EasyMeli.configuration.application_id,
+      client_secret: EasyMeli.configuration.secret_key
+    )
+  end
+end

data/lib/easy_meli/configuration.rb

@@ -0,0 +1,8 @@
+class EasyMeli::Configuration
+  attr_accessor :application_id, :secret_key
+
+  def initialize
+    @application_id = nil
+    @secret_key = nil
+  end
+end

data/lib/easy_meli/errors.rb

@@ -0,0 +1,12 @@
+module EasyMeli
+  class Error < StandardError
+    attr_reader :response
+
+    def initialize(message, response)
+      @response = response
+      super(message)
+    end
+  end
+
+  class AuthenticationError < Error; end
+end

data/lib/easy_meli/version.rb

@@ -0,0 +1,3 @@
+module EasyMeli
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: easy_meli
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Eric Northam
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- eric@northam.us
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- easy_meli.gemspec
+- lib/easy_meli.rb
+- lib/easy_meli/api_client.rb
+- lib/easy_meli/authorization_client.rb
+- lib/easy_meli/configuration.rb
+- lib/easy_meli/errors.rb
+- lib/easy_meli/version.rb
+homepage: https://github.com/easybroker/easy_meli
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/easybroker/easy_meli
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A simple gem to work with MercadoLibre's API
+test_files: []