api_connector 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 979197de3db76b40d6333064617dfbb1eb6abcb1
+  data.tar.gz: 1f57a6ec15fcc5310a4543a8f4c3d121917b7f59
+SHA512:
+  metadata.gz: e6e5cfb6595ff164aa12d2792ba153cccf93c6ee6a924df663b489ada74b34ef833cec6e2dd1809c985672a3f4c883f9ca6315d3515dfcb664c33e3897ec6b2c
+  data.tar.gz: 5640599b700c5a1eae1059a90139e337ce8b6c893a524a4573515aa319155726532a8793776ecf4f387e00bbfe629761133afcc43c7177b9498a856098e482d7

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.swp
+.swo

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.0.0
+before_install: gem install bundler -v 1.10.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in api_connector.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    api_connector (0.1.0)
+      activesupport (~> 4.2.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.4)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    diff-lcs (1.2.5)
+    i18n (0.7.0)
+    json (1.8.3)
+    minitest (5.8.2)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  api_connector!
+  bundler (~> 1.10)
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.10.5

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Juan Manuel Rodulfo Salcedo
+
+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/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Juan Manuel Rodulfo
+
+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,57 @@
+# ApiConnector
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/api_connector`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'api_connector'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api_connector
+
+## Usage
+
+###Available commands:
+
+```ruby
+  new(opts) - Creates a new Connector. (opts to be defined)
+  get(hash)
+  post(hash, payload)
+  delete(hash)
+```
+###Hash structure:
+==== Attributes
+** hash[:endpoint] - Url endpoint ex. /product/get (no need to specify the version)
+** hash[:headers]     - Request arguments, (add headers key for extra headers options) ex. hash[:headers] = { 'content-type' => 'xml' }
+** hash[params]    - Request parameters. ex. hash[:params] = { 'param1' => 'XXXXXX' }
+
+###Payload
+JSON-formatted hash.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` 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/[USERNAME]/api_connector. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/api_connector.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api_connector/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api_connector"
+  spec.version       = ApiConnector::VERSION
+  spec.authors       = ["Juan Manuel Rodulfo"]
+  spec.email         = ["jm.rodulfo.salcedo@gmail.com"]
+
+  spec.summary       = "API connectors"
+  spec.description   = "API Connector main class for wrapping RestClient functionality"
+  spec.homepage      = "https://github.com/Juanchote/api_connectors"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+     spec.metadata['allowed_push_host'] = "http://mygemserver.com"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+
+  spec.add_dependency 'activesupport', '~> 4.2.4'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "api_connector"
+
+# 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

data/bin/setup

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

data/lib/api_connector.rb

@@ -0,0 +1,10 @@
+require "api_connector/version"
+require 'api_connector/api_connector'
+require 'active_support/core_ext/hash/keys'
+require 'logger'
+
+module ApiConnector
+  def self.new(options={})
+    @conn = Connectors::ApiConnector.new(options)
+  end
+end

data/lib/api_connector/api_connector.rb

@@ -0,0 +1,144 @@
+# * Parent Connector for APIs
+# * author: juanma <jm.rodulfo.salcedo@gmail.com>
+module Connectors #:nodoc:
+  # === Heading
+  # This class has all the common logic from <b>api connectors</b>.
+  class ApiConnector
+    attr_reader :logger, :api_client_id, :api_domain, :api_mall_id,
+      :api_domain_format, :api_headers_token, :connection_protocol,
+      :headers, :code, :cookies, :cookie_jar, :request, :body
+
+    def initialize(options = {}) #:notnew:
+      options.symbolize_keys!
+
+      #@logger = Logger.new "#{Rails.root}/log/#{self.class.to_s.demodulize.underscore}.log"
+      #@logger.level = Rails.logger.level
+
+      opts_to_vars(options)
+    end
+
+    # makes a GET request
+    #
+    # ==== Attributes
+    #  * +hash+ - Hash of Parameters
+    #  ** +endpoint+ - Url endpoint ex. /product/get (no need to specify the version)
+    #  ** +args+ - Request arguments, (add headers key for extra headers options) ex. hash[:headers] = { 'content-type' => 'xml' }
+    #  ** +params+ - Request parameters. ex. hash[:params] = { 'merchantId' => 'XXXXXX' }
+    def get(hash={})
+      hash.symbolize_keys!
+      call(:get, hash[:endpoint], (hash[:args]||{}), hash[:params]||{})
+    end
+
+    def delete(hash={})
+      hash.symbolize_keys!
+      call(:delete, hash[:endpoint], (hash[:args]||{}), hash[:params]||{})
+    end
+
+    # makes a POST request
+    #
+    # ==== Attributes
+    # * +hash+ - Hash of parameters
+    # ** +endpoint+ - Url endpoint ex. /product/createOrUpdate
+    # ** +args+ - Request arguments, (add headers key for extra headers options) ex. hash[:headers] = { 'content-type' => 'xml' }
+    # * +payload+ - Data for the request ex. { merchantId: 'asdasdsadas', products: [{ ... },{ ...}...]}
+    def post hash={}, payload
+      raise 'Payload cannot be blank' if payload.nil? || payload.empty?
+
+      hash.symbolize_keys!
+      call(:post, hash[:endpoint], (hash[:args]||{}).merge({:method => :post}), payload)
+    end
+
+    # low level api for request (needed por PUT, PATCH & DELETE methods)
+    #
+    # ==== Attributes
+    # * +endpoint+ - Url endpoint ex. /merchant/get
+    # * +args+ - Request arguments, (add headers key for extra headers options) ex. { method: :get, headers: { 'content-type' => 'xml' } } (method key is needed, otherwise :get will be setted)
+    # * +params+ - Request parameters / payload data
+    def call method, endpoint, args={}, params
+      raise "Endpoint can't be blank" unless endpoint
+      raise "Method is missing" unless method
+
+      url = (method == :get || method == :delete) ? url(endpoint,params) : url(endpoint)
+
+      begin
+        RestClient::Request.execute(method: method,
+                                url: url,
+                                headers: header(args[:headers]),
+                                payload: params || {}
+                               ) do |response, request, result|
+                                 status = response.code == 200 ? :debug : :error
+                                 #print(status, request, response.body)
+                                 parse(response, endpoint)
+                               end
+      rescue RestClient::RequestTimeout
+        { status: '400', message: "RestClient timeout" }
+      end
+    end
+
+    def parse(response, endpoint = nil)
+      @headers, @code, @cookies, @cookie_jar, @request, @body = response.headers, response.code, response.cookies, response.cookie_jar, response.request, response.body
+      begin
+        JSON.parse(response)
+      rescue JSON::ParserError
+        { status: '400', message: "RestClient failed to parse JSON: #{response}" }
+      end
+    end
+
+    protected
+
+    def opts_to_vars(opts)
+      instance_eval do
+        opts.each do |k, v|
+          instance_variable_set("@#{k}".to_sym, v)
+        end
+      end
+    end
+
+    def header headers={}
+      common_headers.merge({
+        'X-Client-Id' => @x_person_id,
+        'Content-Type' => @content_type || 'application/json',
+        'Charset' => @charset || 'utf-8'
+      }).merge(headers || {})
+    end
+
+    def url endpoint, args={}
+      url_constructor endpoint, args
+    end
+
+
+    def print(status, request, response)
+      status = :debug
+      @logger.send(status,
+                   "#{DateTime.now} "\
+                   "- Request: #{request.inspect} "\
+                   "- Response: #{response.force_encoding('utf-8')}"
+                  )
+    end
+
+    def common_headers
+      { 'X-Client-Id' => api_client_id }.merge(
+        {"Authorization" => "Basic #{@api_headers_token}"}
+      ) if @api_headers_token
+    end
+
+    def url_constructor endpoint, hash
+      url = "#{@connection_protocol}://#{format(api_domain)}/#{format(@prefix)}" << (@version ? "/#{@version}" : "") << "/#{format(endpoint)}"
+      url << ("?#{parametrize(hash)}") unless hash.empty?
+      url
+    end
+
+    def parametrize hash
+      hash.map do |key,values|
+        [values].flatten.map do |value|
+          "#{key}=#{value}"
+        end
+      end.join('&')
+    end
+
+    def format string
+      match_data = string.match(/\w+.+\w+/)
+      match_data ? match_data[0] : ''
+    end
+  end
+end

data/lib/api_connector/version.rb

@@ -0,0 +1,3 @@
+module ApiConnector
+  VERSION = "0.1.1"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: api_connector
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Juan Manuel Rodulfo
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.4
+description: API Connector main class for wrapping RestClient functionality
+email:
+- jm.rodulfo.salcedo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- api_connector.gemspec
+- bin/console
+- bin/setup
+- lib/api_connector.rb
+- lib/api_connector/api_connector.rb
+- lib/api_connector/version.rb
+homepage: https://github.com/Juanchote/api_connectors
+licenses:
+- MIT
+metadata:
+  allowed_push_host: http://mygemserver.com
+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: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: API connectors
+test_files: []
+has_rdoc: