ebay_request 0.2.0

data/lib/ebay_request/shopping.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+class EbayRequest::Shopping < EbayRequest::Base
+  private
+
+  def payload(callname, request)
+    request = Gyoku.xml(request)
+
+    %(<?xml version="1.0" encoding="utf-8"?>\
+<#{callname}Request xmlns="urn:ebay:apis:eBLBaseComponents">\
+#{request}</#{callname}Request>)
+  end
+
+  def endpoint
+    "http://open.api%{sandbox}.ebay.com/shopping"
+  end
+
+  def headers(callname)
+    super.merge(
+      "Content-Type" => "text/xml",
+      "X-EBAY-API-APP-ID" => config.appid,
+      "X-EBAY-API-VERSION" => config.version.to_s,
+      "X-EBAY-API-CALL-NAME" => callname,
+      "X-EBAY-API-REQUEST-ENCODING" => "XML",
+      "X-EBAY-API-SITE-ID" => siteid.to_s
+    )
+  end
+
+  def errors_for(r)
+    [r["Errors"]]
+      .flatten
+      .compact
+      .map { |e| [e["SeverityCode"], e["ErrorCode"], e["LongMessage"]] }
+  end
+
+  FATAL_ERRORS = {}.freeze
+end

data/lib/ebay_request/site.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+class EbayRequest::Site
+  KEYS = %w(
+    globalid id name currency language domain code metric country gtc_available
+    free_placement max_insertion_fee free_pictures subtitle_fee quantity_limits
+    min_fixed_price
+  ).freeze
+
+  attr_reader(*KEYS)
+
+  def initialize(hash)
+    @hash = hash
+    KEYS.each { |key| instance_variable_set(:"@#{key}", hash[key]) }
+  end
+
+  def to_hash
+    @hash
+  end
+  alias to_h to_hash
+
+  def gtc_available?
+    return @gtc_available if [true, false].include? @gtc_available
+
+    raise <<-MESSAGE.gsub(/^ +\|/, "")
+      |We haven't checked whether GTC duration is available on the site #{@id}.
+      |You should explore if GTC is supported by at least one of its categories (see https://developer.ebay.com/devzone/xml/docs/reference/ebay/GetCategoryFeatures.html)
+      |Then you're welcome to make a PR with a resulting value (true|false) added to `config/sites.yml`
+    MESSAGE
+  end
+end

data/lib/ebay_request/trading.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+class EbayRequest::Trading < EbayRequest::Base
+  class IllegalItemStateError < EbayRequest::Error; end
+  class ItemLimitReachedError < EbayRequest::Error; end
+  class DailyItemCallLimitReachedError < EbayRequest::Error; end
+  class TokenValidationFailed < EbayRequest::Error; end
+  class IAFTokenExpired < TokenValidationFailed; end
+  class AccountSuspended < EbayRequest::Error; end
+  class ApplicationInvalid < EbayRequest::Error; end
+
+  private
+
+  def payload(callname, request)
+    request = Gyoku.xml(request, key_converter: :camelcase)
+
+    %(<?xml version="1.0" encoding="utf-8"?>\
+<#{callname}Request xmlns="urn:ebay:apis:eBLBaseComponents">\
+#{creds}#{request}</#{callname}Request>)
+  end
+
+  def creds
+    return if options[:token].nil? || options[:iaf_token_manager].present?
+    %(<RequesterCredentials>\
+<eBayAuthToken>#{options[:token]}</eBayAuthToken>\
+</RequesterCredentials>)
+  end
+
+  def endpoint
+    "https://api%{sandbox}.ebay.com/ws/api.dll"
+  end
+
+  def headers(callname)
+    authorized_headers = {
+      "Content-Type" => "text/xml",
+      "X-EBAY-API-APP-NAME" => config.appid,
+      "X-EBAY-API-DEV-NAME" => config.devid,
+      "X-EBAY-API-CERT-NAME" => config.certid,
+      "X-EBAY-API-COMPATIBILITY-LEVEL" => config.version.to_s,
+      "X-EBAY-API-CALL-NAME" => callname,
+      "X-EBAY-API-SITEID" => siteid.to_s,
+    }
+    if options[:iaf_token_manager]
+      authorized_headers["X-EBAY-API-IAF-TOKEN"] =
+          options[:iaf_token_manager].access_token
+    end
+    super.merge(authorized_headers)
+  end
+
+  def errors_for(r)
+    [r["Errors"]]
+      .flatten
+      .compact
+      .map { |e| [e["SeverityCode"], e["ErrorCode"], e["LongMessage"]] }
+  end
+
+  def request(*)
+    retried ||= false
+    super.tap do |response|
+      next if retried || options[:iaf_token_manager].nil?
+      next if response.success? || response.error_class > IAFTokenExpired
+      raise response.error
+    end
+  rescue IAFTokenExpired
+    options[:iaf_token_manager].refresh!
+    retried = true
+    retry
+  end
+
+  # http://developer.ebay.com/devzone/xml/docs/reference/ebay/errors/errormessages.htm
+  FATAL_ERRORS = {
+    291        => IllegalItemStateError,
+    1047       => IllegalItemStateError,
+    21_919_188 => ItemLimitReachedError,
+    21_919_165 => DailyItemCallLimitReachedError,
+    931        => TokenValidationFailed,
+    17_470     => TokenValidationFailed,
+    16_110     => TokenValidationFailed,
+    21_916_984 => TokenValidationFailed,
+    21_917_053 => IAFTokenExpired,
+    841        => AccountSuspended,
+    127        => ApplicationInvalid
+  }.freeze
+end

data/lib/ebay_request/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module EbayRequest
+  VERSION = "0.2.0"
+end

data/lib/omniauth/strategies/ebay.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+class OmniAuth::Strategies::Ebay
+  include OmniAuth::Strategy
+
+  args [:runame, :devid, :appid, :certid]
+
+  option :runame,  nil
+  option :devid,   nil
+  option :appid,   nil
+  option :certid,  nil
+  option :site_id, "0"
+  option :sandbox, true
+  option :env,     nil
+
+  uid         { raw_info["EIASToken"] }
+  credentials { { token: @auth_token, expires_at: @expires_at } }
+  extra       { { raw_info: raw_info } }
+
+  info do
+    {
+      user_id:    raw_info["UserID"],
+      auth_token: @auth_token,
+      email:      raw_info["Email"],
+      full_name: full_name,
+      first_name: parsed_name[0],
+      last_name: parsed_name[1],
+      eias_token: raw_info["EIASToken"]
+    }
+  end
+
+  def request_phase
+    configure unless EbayRequest.configured?
+    session["omniauth.ebay.session_id"] = fetch_session_id
+    redirect ebay.ebay_login_url(session["omniauth.ebay.session_id"])
+  end
+
+  def callback_phase
+    response = fetch_token
+
+    @auth_token = response["eBayAuthToken"]
+    @expires_at = Time.parse(response["HardExpirationTime"]).to_i
+    @user_info  = ebay.user(@auth_token)
+
+    super
+  end
+
+  def configure
+    EbayRequest.configure(options.env) do |config|
+      config.runame  = options.runame
+      config.devid   = options.devid
+      config.appid   = options.appid
+      config.certid  = options.certid
+      config.sandbox = options.sandbox
+    end
+  end
+
+  def raw_info
+    @user_info["User"]
+  end
+
+  def full_name
+    @full_name ||= raw_info["RegistrationAddress"].try(:[], "Name")
+  end
+
+  def parsed_name
+    @parsed_name ||= (full_name || "").split(" ", 2)
+  end
+
+  def ebay
+    @ebay ||= EbayRequest::Auth.new(site_id: options.site_id, env: options.env)
+  end
+
+  def fetch_token
+    ebay.token(session["omniauth.ebay.session_id"])
+  end
+
+  def fetch_session_id
+    ebay.session_id["SessionID"]
+  end
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: ebay_request
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Victor Sokolov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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: simplecov
+  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: multi_xml
+  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: gyoku
+  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: omniauth
+  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: dry-initializer
+  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'
+description: 
+email:
+- gzigzigzeo@evilmartians.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- config/sites.yml
+- ebay_request.gemspec
+- lib/ebay_request.rb
+- lib/ebay_request/auth.rb
+- lib/ebay_request/base.rb
+- lib/ebay_request/business_policies.rb
+- lib/ebay_request/config.rb
+- lib/ebay_request/error.rb
+- lib/ebay_request/finding.rb
+- lib/ebay_request/response.rb
+- lib/ebay_request/shopping.rb
+- lib/ebay_request/site.rb
+- lib/ebay_request/trading.rb
+- lib/ebay_request/version.rb
+- lib/omniauth/strategies/ebay.rb
+homepage: https://github.com/gzigzigzeo/ebay_request
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.7.6
+signing_key: 
+specification_version: 4
+summary: eBay API request interface
+test_files: []