api2cart-ruby 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8a472dead7ba8d39e0adf36a51501e9e5236d78
+  data.tar.gz: 0e366296723d174613b001cad9575c497d3c37ff
+SHA512:
+  metadata.gz: 2204bc93466eb3ddbffb99af8132702b253addbcd648289bdc86690a782cef9a23ec47d43713be98b9054972270c1127eaab13c85f49fc7c5fbb5dcd65b97b5a
+  data.tar.gz: f67f081652e8538173c6bf85c59a367264e912ff79c28815df92af8a9cd927bc4941e2961dcca0a34d5f0534e51e5f900a55168d37cc42a358425ea794b4a2c1

data/.gitignore

@@ -0,0 +1,43 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.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
+
+/Gemfile.lock
+/spec/reports/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+/eproject.cfg

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Daniel Vartanov
+
+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,35 @@
+# Api2cart
+
+Ruby client for [API2Cart](https://www.api2cart.com/) with proxy support, fully covered with tests.
+The DSL is similar to DSL of [original gem](https://rubygems.org/gems/API2Cart) therefore migration is easy.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'api2cart-ruby', require: 'api2cart'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install api2cart-ruby
+
+## Usage
+
+```ruby
+Api2cart::Store.new(api_key, store_key).product_count
+# => { 'products_count' => 76 }
+```
+
+With proxy:
+
+```ruby
+Api2cart::Store.new(api_key, store_key, proxy: 'http://anti-throttling-proxy.local:1080').product_count
+# => { 'products_count' => 76 }
+```
+
+Sponsored by [Veeqo](https://github.com/veeqo)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/api2cart-ruby.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'api2cart/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "api2cart-ruby"
+  spec.version       = Api2cart::VERSION
+
+  spec.authors       = ["Tom Procter", "Daniel Vartanov"].sort
+  spec.email         = ["tom@procterweb.co.uk", "dan@vartanov.net"]
+
+  spec.summary       = %q{Ruby client for API2Cart}
+  spec.description   = %q{Ruby client for API2Cart with proxy support}
+  spec.homepage      = "https://github.com/DanielVartanov/api2cart-ruby"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+end

data/lib/api2cart/client.rb

@@ -0,0 +1,45 @@
+require 'net/http'
+require 'json'
+require 'active_support/core_ext/object/blank'
+
+module Api2cart
+  class Client < Struct.new(:request_url, :proxy_url)
+    def make_request!
+      self.response_body = net_http_class.get_response(request_url).body
+    end
+
+    def successful?
+      return_code == 0
+    end
+
+    def error_message
+      response_json['return_message']
+    end
+
+    def result
+      response_json['result']
+    end
+
+    protected
+
+    attr_accessor :response_body
+
+    def response_json
+      @response_json ||= JSON.parse response_body
+    end
+
+    def return_code
+      response_json['return_code']
+    end
+
+    def parsed_proxy_url
+      @parsed_proxy_url ||= URI.parse proxy_url
+    end
+
+    def net_http_class
+      proxy_url.present? ?
+        Net::HTTP::Proxy(parsed_proxy_url.host, parsed_proxy_url.port) :
+        Net::HTTP
+    end
+  end
+end

data/lib/api2cart/request_url_composer.rb

@@ -0,0 +1,27 @@
+require 'uri'
+require 'active_support/core_ext/object/to_query'
+
+module Api2cart
+  class RequestUrlComposer < Struct.new(:api_key, :store_key, :method_name, :query_params)
+    HOST = 'api.api2cart.com'
+    PATH_BASE = '/v1.0'
+
+    def compose_request_url
+      URI::HTTP.build host: HOST, path: full_path, query: query_string
+    end
+
+    protected
+
+    def full_path
+      "#{PATH_BASE}/#{dotted_method_name}.json"
+    end
+
+    def dotted_method_name
+      method_name.to_s.gsub('_', '.')
+    end
+
+    def query_string
+      { api_key: api_key, store_key: store_key }.merge(query_params || {}).to_param
+    end
+  end
+end

data/lib/api2cart/store.rb

@@ -0,0 +1,24 @@
+module Api2cart
+  class Store
+    attr_accessor :api_key, :store_key, :proxy
+
+    def initialize(api_key, store_key, proxy: nil)
+      self.api_key = api_key
+      self.store_key = store_key
+      self.proxy = proxy
+    end
+
+    def method_missing(method_name, *args)
+      request_url = RequestUrlComposer.new(api_key, store_key, method_name, args.first).compose_request_url
+
+      api2cart_client = Client.new(request_url, proxy)
+      api2cart_client.make_request!
+
+      if api2cart_client.successful?
+        api2cart_client.result
+      else
+        raise api2cart_client.error_message
+      end
+    end
+  end
+end

data/lib/api2cart/version.rb

@@ -0,0 +1,3 @@
+module Api2cart
+  VERSION = "1.0.0"
+end

data/lib/api2cart.rb

@@ -0,0 +1,6 @@
+require 'api2cart/request_url_composer'
+require 'api2cart/client'
+require 'api2cart/store'
+
+module Api2cart
+end

data/spec/api2cart/client_spec.rb

@@ -0,0 +1,56 @@
+describe Api2cart::Client do
+  let(:api2cart_client) { Api2cart::Client.new(request_url) }
+
+  before { api2cart_client.make_request! }
+
+  context 'when request is successful', vcr: { cassette_name: 'successful_request' } do
+    let(:api_key) { '43ba7043badfa2cd31cfaf5dc601a884' }
+    let(:store_key) { '6f00bbf49f5ada8156506aba161408c6' }
+
+    let(:request_url) { Api2cart::RequestUrlComposer.new(api_key, store_key, :product_count).compose_request_url }
+
+    describe '#successful?' do
+      subject { api2cart_client.successful? }
+
+      it { is_expected.to be true }
+    end
+
+    describe '#error_message' do
+      subject { api2cart_client.error_message }
+
+      it { is_expected.to eq '' }
+    end
+
+    describe '#result' do
+      subject { api2cart_client.result }
+
+      it 'returns result as parsed JSON' do
+        expect(subject).to eq({ "products_count" => 76 })
+      end
+    end
+  end
+
+  context 'when request is erroneous', vcr: { cassette_name: 'erroneous_request' } do
+    let(:request_url) { Api2cart::RequestUrlComposer.new('wrong', 'even more wrong', :product_count).compose_request_url }
+
+    describe '#successful?' do
+      subject { api2cart_client.successful? }
+
+      it { is_expected.to be false }
+    end
+
+    describe '#error_message' do
+      subject { api2cart_client.error_message }
+
+      it 'parses request and extracts error message' do
+        expect(subject).to eq 'Incorrect API Key'
+      end
+    end
+
+    describe '#result' do
+      subject { api2cart_client.result }
+
+      it { is_expected.to eq({}) }
+    end
+  end
+end

data/spec/api2cart/request_url_composer_spec.rb

@@ -0,0 +1,81 @@
+describe Api2cart::RequestUrlComposer do
+  let(:api_key) { '43ba7043badfa2cd31cfaf5dc601a884' }
+  let(:store_key) { '6f00bbf49f5ada8156506aba161408c6' }
+  let(:method_name) { :order_list }
+  let(:query_params) do
+    {
+      params: 'force_all',
+      start: 20,
+      count: 10
+    }
+  end
+  let(:request_url_composer) { Api2cart::RequestUrlComposer.new(api_key, store_key, method_name, query_params) }
+
+  let(:composed_url) { request_url_composer.compose_request_url }
+
+  describe 'protocol' do
+    subject { composed_url.scheme }
+
+    specify do
+      expect(subject).to eq('http')
+    end
+  end
+
+  describe 'domain' do
+    subject { composed_url.host }
+
+    specify do
+      expect(subject).to eq('api.api2cart.com')
+    end
+  end
+
+  describe 'path' do
+    subject { composed_url.path }
+
+    it 'contains API version in the beginning' do
+      expect(subject).to start_with('/v1.0')
+    end
+
+    it 'contains method name translating underscores to dots' do
+      expect(subject).to start_with('/v1.0/order.list')
+    end
+
+    it 'contains indicator of JSON format' do
+      expect(subject).to start_with('/v1.0/order.list.json')
+    end
+  end
+
+  describe 'query string' do
+    subject { composed_url.query }
+
+    it 'contains API key' do
+      expect(subject).to include('api_key=43ba7043badfa2cd31cfaf5dc601a884')
+    end
+
+    it 'contains store key' do
+      expect(subject).to include('store_key=6f00bbf49f5ada8156506aba161408c6')
+    end
+
+    it 'translates method arguments to query params' do
+      expect(subject).to include('count=10&params=force_all&start=20')
+    end
+  end
+
+  describe 'all together' do
+    subject { composed_url.to_s }
+
+    it do
+      is_expected.to eq 'http://api.api2cart.com/v1.0/order.list.json?api_key=43ba7043badfa2cd31cfaf5dc601a884&count=10&params=force_all&start=20&store_key=6f00bbf49f5ada8156506aba161408c6'
+    end
+  end
+
+  context 'when there is no arguments' do
+    subject { composed_url.to_s }
+
+    let(:request_url_composer) { Api2cart::RequestUrlComposer.new(api_key, store_key, :product_count, nil) }
+
+    it 'just does not add them to URL query' do
+      is_expected.to eq 'http://api.api2cart.com/v1.0/product.count.json?api_key=43ba7043badfa2cd31cfaf5dc601a884&store_key=6f00bbf49f5ada8156506aba161408c6'
+    end
+  end
+end

data/spec/api2cart/store_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Api2cart::Store do
+  context 'when request is successful', vcr: { cassette_name: 'successful_request' } do
+    let(:api_key) { '43ba7043badfa2cd31cfaf5dc601a884' }
+    let(:store_key) { '6f00bbf49f5ada8156506aba161408c6' }
+
+    it 'returns parsed JSON' do
+      expect(Api2cart::Store.new(api_key, store_key).product_count).to eq({ 'products_count' => 76 })
+    end
+  end
+
+  context 'when response contains an error', vcr: { cassette_name: 'erroneous_request' } do
+    it 'raises an exception with correspondent message' do
+      expect {
+        Api2cart::Store.new('wrong', 'even more wrong').product_count
+      }.to raise_error('Incorrect API Key')
+    end
+  end
+end

data/spec/api2cart/with_proxy_spec.rb

@@ -0,0 +1,19 @@
+require 'spec_helper'
+
+describe Api2cart do
+  context 'when proxy URL is given', vcr: { cassette_name: 'successful_request' } do
+    let(:api_key) { '43ba7043badfa2cd31cfaf5dc601a884' }
+    let(:store_key) { '6f00bbf49f5ada8156506aba161408c6' }
+
+    let(:store_with_proxy) { Api2cart::Store.new api_key, store_key, proxy: 'http://anti-throttling-proxy.local:1080' }
+
+    it 'sends request via proxy (see cassette)' do
+      expect(store_with_proxy.product_count).to eq({ 'products_count' => 76 })
+    end
+
+    it 'extracts hostname and port from proxy URL' do
+      expect(Net::HTTP).to receive(:Proxy).with('anti-throttling-proxy.local', 1080).and_call_original
+      store_with_proxy.product_count
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require_relative File.join(__dir__, '../lib/api2cart')
+
+require 'rspec/core'
+require 'webmock'
+require 'vcr'
+
+Dir[File.join(__dir__, "support/**/*.rb")].each { |f| require f }
+Dir[File.join(__dir__, "shared_examples/**/*.rb")].sort.each { |f| require f }
+
+VCR.configure do |c|
+  c.cassette_library_dir = File.join(__dir__, "vcr_cassettes")
+  c.configure_rspec_metadata!
+  c.hook_into :webmock
+end

data/spec/vcr_cassettes/erroneous_request.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.api2cart.com/v1.0/product.count.json?api_key=wrong&store_key=even%20more%20wrong
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+      Host:
+      - api.api2cart.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 19 Nov 2014 10:21:28 GMT
+      Server:
+      - Apache/2.2.27 (Unix) mod_ssl/2.2.27 OpenSSL/1.0.1e-fips mod_bwlimited/1.4
+        mod_fcgid/2.3.9
+      X-Powered-By:
+      - PHP/5.3.28
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      Set-Cookie:
+      - PHPSESSID=c217cbe8ce21f4304c661d65c982e47c; expires=Wed, 19-Nov-2014 12:21:28
+        GMT; path=/
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Allow-Headers:
+      - origin, x-requested-with, content-type
+      Access-Control-Allow-Methods:
+      - PUT, GET, POST, DELETE, OPTIONS
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: '{"return_code" : 2, "return_message": "Incorrect API Key", "result"
+        : {}}'
+    http_version: 
+  recorded_at: Wed, 19 Nov 2014 10:21:28 GMT
+recorded_with: VCR 2.9.3

data/spec/vcr_cassettes/successful_request.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://api.api2cart.com/v1.0/product.count.json?api_key=43ba7043badfa2cd31cfaf5dc601a884&store_key=6f00bbf49f5ada8156506aba161408c6
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - '*/*'
+      User-Agent:
+      - Ruby
+      Host:
+      - api.api2cart.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 19 Nov 2014 10:20:29 GMT
+      Server:
+      - Apache/2.2.27 (Unix) mod_ssl/2.2.27 OpenSSL/1.0.1e-fips mod_bwlimited/1.4
+        mod_fcgid/2.3.9
+      X-Powered-By:
+      - PHP/5.3.28
+      Expires:
+      - Thu, 19 Nov 1981 08:52:00 GMT
+      Cache-Control:
+      - no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Pragma:
+      - no-cache
+      Set-Cookie:
+      - PHPSESSID=b1ea7d1fe638a3d718f4f13215204054; expires=Wed, 19-Nov-2014 12:20:29
+        GMT; path=/
+      Access-Control-Allow-Origin:
+      - '*'
+      Access-Control-Allow-Headers:
+      - origin, x-requested-with, content-type
+      Access-Control-Allow-Methods:
+      - PUT, GET, POST, DELETE, OPTIONS
+      Transfer-Encoding:
+      - chunked
+      Content-Type:
+      - application/json; charset=utf-8
+    body:
+      encoding: UTF-8
+      string: '{"return_code" : 0, "return_message": "", "result" : {"products_count":76}}'
+    http_version: 
+  recorded_at: Wed, 19 Nov 2014 10:20:29 GMT
+recorded_with: VCR 2.9.3

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: api2cart-ruby
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Daniel Vartanov
+- Tom Procter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: vcr
+  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'
+description: Ruby client for API2Cart with proxy support
+email:
+- tom@procterweb.co.uk
+- dan@vartanov.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- api2cart-ruby.gemspec
+- lib/api2cart.rb
+- lib/api2cart/client.rb
+- lib/api2cart/request_url_composer.rb
+- lib/api2cart/store.rb
+- lib/api2cart/version.rb
+- spec/api2cart/client_spec.rb
+- spec/api2cart/request_url_composer_spec.rb
+- spec/api2cart/store_spec.rb
+- spec/api2cart/with_proxy_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_cassettes/erroneous_request.yml
+- spec/vcr_cassettes/successful_request.yml
+homepage: https://github.com/DanielVartanov/api2cart-ruby
+licenses:
+- MIT
+metadata: {}
+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.4.2
+signing_key: 
+specification_version: 4
+summary: Ruby client for API2Cart
+test_files:
+- spec/api2cart/client_spec.rb
+- spec/api2cart/request_url_composer_spec.rb
+- spec/api2cart/store_spec.rb
+- spec/api2cart/with_proxy_spec.rb
+- spec/spec_helper.rb
+- spec/vcr_cassettes/erroneous_request.yml
+- spec/vcr_cassettes/successful_request.yml