ebay_client 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OTQzYjA2ZmUwYzllYmJiNmNlOWQxMWRlZTVmYzk3M2MzODVlMmRkNg==
+  data.tar.gz: !binary |-
+    MWFjZWIyZWQwMmM1ZTE0MGZjYjY2N2UxYTI1OTM1YjRmODNkM2Q1Mg==
+SHA512:
+  metadata.gz: !binary |-
+    NmY3NGI2MjllOWNmY2U0MDk5NzZmNTQzMDgxNTI3NjI5ZDc4N2NjYTAwYTg3
+    ODMyMjk4MWVjYzA2MDA4MjA3NGQ3NTI3ZmY1NTVkNzFlNjkwMjZjZTA0ZjAy
+    Y2Y2ODFiM2M0MzY4MTExNTJmOGExZDdlNTg0MGU0Yzc2MjFiZDA=
+  data.tar.gz: !binary |-
+    MTg2NjZmMGY2YjVmZmUzMWI4OTM4ZWJhNWUxYzQ3ZTFhYzY4MjJlMTBjYTQx
+    NTQ1NDQ3NmNiNWM3NDJkMGQ5ZDMwZTU3YjJiYTZjMTA5YTliZmM4NDQ0OTUz
+    N2I0YjQ3ZGY4ZWZjNjZkZTZhMDM0YWVkZmY5Zjg2YmNhNDM3N2E=

data/.gitignore

@@ -0,0 +1,2 @@
+.bundle/
+.project

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    ebay_client (0.0.1)
+      activesupport (>= 3.1.0)
+      savon (~> 0.9.9)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (3.2.3)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    akami (1.0.0)
+      gyoku (>= 0.4.0)
+    builder (3.0.0)
+    columnize (0.3.6)
+    debugger (1.1.1)
+      columnize (>= 0.3.1)
+      debugger-linecache (~> 1.1)
+      debugger-ruby_core_source (~> 1.1)
+    debugger-linecache (1.1.1)
+      debugger-ruby_core_source (>= 1.1.1)
+    debugger-ruby_core_source (1.1.2)
+    gyoku (0.4.4)
+      builder (>= 2.1.2)
+    httpi (0.9.6)
+      rack
+    i18n (0.6.0)
+    multi_json (1.3.2)
+    nokogiri (1.5.2)
+    nori (1.1.0)
+    rack (1.4.1)
+    savon (0.9.9)
+      akami (~> 1.0)
+      builder (>= 2.1.2)
+      gyoku (>= 0.4.0)
+      httpi (~> 0.9)
+      nokogiri (>= 1.4.0)
+      nori (~> 1.1)
+      wasabi (~> 2.1)
+    wasabi (2.1.0)
+      nokogiri (>= 1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  debugger
+  ebay_client!

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2012 ['Kayoom GmbH Düren, Germany', 'Marian Theisen'],
+except 'vendor/ebay/*.wsdl', Copyright (c) eBay
+
+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,63 @@
+EbayClient
+==========
+
+Simple, lightweight eBay Trading API Client.
+
+Installation
+------------
+
+### Rails
+
+`Gemfile`:
+
+    gem 'ebay_client', '~> 0.1.0'
+
+`config/ebay_client.yml`:
+
+    development: &sandbox
+      api_keys:
+        - token: '<YOUR SANDBOX AUTHENTICATION TOKEN>'
+          devid: '<YOUR SANDBOX DEV ID>'
+          appid: '<YOUR SANDBOX APP ID>'
+          certid: '<YOUR SANDBOX CERT ID>'
+
+    test:
+      <<: *sandbox
+
+    production:
+      api_keys:
+        - token: '<YOUR LIVE AUTHENTICATION TOKEN>'
+          devid: '<YOUR LIVE DEV ID>'
+          appid: '<YOUR LIVE APP ID>'
+          certid: '<YOUR LIVE CERT ID>'
+
+Fire up your console!
+
+Usage
+-----
+
+### Rails
+
+e.g. `rails console`:
+
+    EbayClient.api.get_ebay_official_time!
+    # => {:timestamp=>Fri, 22 Nov 2013 12:31:02 +0000}
+
+Notes
+-----
+* An overview of possible API calls can be found at the
+  [eBay Trading API docs](http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/)
+* Names (Methods, Types, Members) are mapped from `CamelCase` \<=\> `snake_case`
+* `eBay` is mapped to `ebay`, i.e. `GeteBayOfficialTime` \<=\>
+  `get_ebay_official_time`
+* For each call, there are 2 methods, with and without a bang (`!`), i.e.  
+    * `get_ebay_official_time` returns an `EbayClient::Response`
+      instance, which contains the `ack` value, the `payload` and possibly
+      `errors`
+    * `get_ebay_official_time!` returns the payload as a `Hash` and raises
+      an `EbayClient::Response::Exception` if the API returned an error.
+* You can specify an arbitrary amount of API key/tokens in your
+  `ebay_client.yml`. On initialization, the EbayClient will randomly
+  choose one of them. If you run out of API calls, it will automatically
+  switch to another key.
+* Pull requests and bug reports are welcome!

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake'
+require 'rake/rdoctask'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+

data/config/defaults.yml

@@ -0,0 +1,25 @@
+defaults: &defaults
+  version: 809
+  # use local file as default
+  #wsdl_file: 'http://developer.ebay.com/webservices/809/eBaySvc.wsdl'
+  routing: default
+  siteid: 0
+  preload: false
+  warning_level: Low
+  error_language: en_US
+  api_keys: []
+  savon_log_level: debug
+
+development: &development
+  <<: *defaults
+  url: 'https://api.sandbox.ebay.com/wsapi'
+  warning_level: High
+  savon_log_level: info
+
+test:
+  <<: *development
+
+production:
+  <<: *defaults
+  url: 'https://api.ebay.com/wsapi'
+  preload: true

data/ebay_client.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "ebay_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ebay_client"
+  s.version     = EbayClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.date        = Time.now.strftime("%Y-%m-%d")
+  s.authors     = ["Marian Theisen"]
+  s.email       = 'marian.theisen@kayoom.com'
+  s.summary     = "Ebay Trading API Client"
+  s.homepage    = "http://github.com/kayoom/ebay_client"
+  s.description = "Simple, lightweight eBay Trading API Client"
+  s.license     = "MIT"
+  s.metadata    = {
+    'issue_tracker' => 'https://github.com/kayoom/ebay_client/issues'
+  }
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "activesupport", ">= 3.1.0"
+  s.add_dependency "savon", "< 2.0.0"
+
+  s.add_development_dependency "bundler"
+end

data/lib/ebay_client.rb

@@ -0,0 +1,11 @@
+require 'ebay_client/version'
+require 'ebay_client/engine' if defined?(::Rails)
+
+module EbayClient
+  autoload :Configuration, 'ebay_client/configuration'
+  autoload :Api, 'ebay_client/api'
+  autoload :Endpoint, 'ebay_client/endpoint'
+  autoload :Header, 'ebay_client/header'
+  autoload :Request, 'ebay_client/request'
+  autoload :Response, 'ebay_client/response'
+end

data/lib/ebay_client/api.rb

@@ -0,0 +1,68 @@
+require 'savon'
+require 'gyoku'
+require 'ebay_client/response'
+
+class EbayClient::Api < ActiveSupport::BasicObject
+  attr_reader :configuration, :endpoint, :namespace, :header, :client, :calls
+
+  def initialize configuration
+    @configuration = configuration
+    @endpoint = ::EbayClient::Endpoint.new configuration
+    @namespace = :urn
+    @header = ::EbayClient::Header.new configuration, namespace
+    @client = ::Savon::Client.new configuration.wsdl_file
+    @client.http.read_timeout = 600
+    @calls = 0
+
+    ::Gyoku.convert_symbols_to :camelcase
+    create_methods if configuration.preload?
+  end
+
+  def dispatch name, body
+    request = ::EbayClient::Request.new self, name, body
+
+    @calls += 1
+    begin
+      request.execute
+    rescue ::EbayClient::Response::Error.for_code('218050') => e
+      @configuration.next_key!
+      request.execute
+    end
+  end
+
+  def dispatch! name, body
+    dispatch(name, body).payload!
+  end
+
+  def inspect
+    "<EbayClient::Api>"
+  end
+  alias_method :to_s, :inspect
+
+  protected
+  def create_methods
+    api_methods = ::Module.new
+
+    client.wsdl.soap_actions.each do |action|
+      name = action.to_s.gsub(/e_bay_/, '_ebay_')
+
+      api_methods.send :define_method, name do |*args|
+        dispatch name, args.first
+      end
+
+      api_methods.send :define_method, name + '!' do |*args|
+        dispatch! name, args.first
+      end
+    end
+
+    api_methods.send :extend_object, self
+  end
+
+  def method_missing name, *args, &block
+    if name.to_s[-1,1] == '!'
+      dispatch! name, args.first
+    else
+      dispatch name, args.first
+    end
+  end
+end

data/lib/ebay_client/configuration.rb

@@ -0,0 +1,79 @@
+class EbayClient::Configuration
+  class ApiKey
+    attr_accessor :appid, :devid, :certid, :token
+
+    def initialize key_values
+      key_values.each do |key, val|
+        instance_variable_set "@#{key}", val
+      end
+    end
+  end
+
+  attr_accessor :version, :siteid, :routing, :url, :api_keys, :warning_level, :error_language, :current_key, :savon_log_level
+
+  def initialize presets
+    presets.each do |key, val|
+      instance_variable_set "@#{key}", val
+    end
+
+    @api_keys = @api_keys.map do |key_values|
+      ApiKey.new key_values
+    end.shuffle
+    @current_key = @api_keys.first
+  end
+
+  def next_key!
+    i = @api_keys.index(@current_key) + 1
+    i = 0 if i >= @api_keys.count
+    @current_key = @api_keys[i]
+  end
+
+  def appid
+    @current_key.appid
+  end
+
+  def devid
+    @current_key.devid
+  end
+
+  def certid
+    @current_key.certid
+  end
+
+  def token
+    @current_key.token
+  end
+
+  def wsdl_file
+    @wsdl_file ||= File.expand_path "../../../vendor/ebay/#{version}.wsdl", __FILE__
+  end
+
+  def preload?
+    !!@preload
+  end
+
+  class << self
+    def load file
+      defaults = load_defaults
+      configs = YAML.load_file file
+
+      configs.each_pair do |env, presets|
+        env_defaults = defaults[env] || {}
+        presets = presets || {}
+
+        configs[env] = new env_defaults.merge(presets)
+      end
+
+      configs
+    end
+
+    protected
+    def load_defaults
+      YAML.load_file defaults_file
+    end
+
+    def defaults_file
+      File.expand_path '../../../config/defaults.yml', __FILE__
+    end
+  end
+end

data/lib/ebay_client/endpoint.rb

@@ -0,0 +1,22 @@
+class EbayClient::Endpoint
+  attr_reader :configuration
+
+  def initialize configuration
+    @configuration = configuration
+  end
+
+  def url_for action
+    url_base + action.to_s
+  end
+
+  def url_base
+    @url_base ||= [
+      configuration.url,
+      params_base
+    ].join
+  end
+
+  def params_base
+    @params_base ||= "?appid=#{configuration.appid}&siteid=#{configuration.siteid}&version=#{configuration.version}&routing=#{configuration.routing}&callname="
+  end
+end

data/lib/ebay_client/engine.rb

@@ -0,0 +1,20 @@
+module EbayClient
+  mattr_accessor :api
+
+  class Engine < ::Rails::Engine
+    CONFIG_FILE_PATH = %w(config ebay_client.yml)
+
+    initializer 'ebay_client.load_configuration' do
+      configurations = EbayClient::Configuration.load Rails.root.join(*CONFIG_FILE_PATH)
+      configuration = configurations[Rails.env]
+
+      EbayClient.api = EbayClient::Api.new configuration
+
+      ::Savon.configure do |config|
+        config.log = true
+        config.logger = Rails.logger
+        config.log_level = configuration.savon_log_level
+      end
+    end
+  end
+end

data/lib/ebay_client/header.rb

@@ -0,0 +1,26 @@
+class EbayClient::Header
+  attr_reader :configuration, :namespace
+
+  def initialize configuration, namespace
+    @configuration = configuration
+    @namespace = namespace
+  end
+
+  def to_hash
+    {
+      ns_key(:RequesterCredentials) => {
+        ns_key(:eBayAuthToken) => configuration.token,
+        ns_key(:Credentials) => {
+          ns_key(:AppId) => configuration.appid,
+          ns_key(:DevId) => configuration.devid,
+          ns_key(:AuthCert) => configuration.certid
+        }
+      }
+    }
+  end
+
+  protected
+  def ns_key key
+    "#{namespace}:#{key}"
+  end
+end