ebay_request 0.2.0

data/ebay_request.gemspec

@@ -0,0 +1,46 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ebay_request/version"
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = "ebay_request"
+  spec.version       = EbayRequest::VERSION
+  spec.authors       = ["Victor Sokolov"]
+  spec.email         = ["gzigzigzeo@evilmartians.com"]
+
+  spec.summary       = "eBay API request interface"
+  # spec.description   = "TODO: Write a longer description or delete this line."
+  spec.homepage      = "https://github.com/gzigzigzeo/ebay_request"
+
+  # 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"] = "https://rubygems.org"
+  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 do |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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "simplecov"
+
+  spec.add_dependency "multi_xml"
+  spec.add_dependency "gyoku"
+  spec.add_dependency "omniauth"
+  spec.add_dependency "dry-initializer"
+end
+# rubocop:enable Metrics/BlockLength

data/lib/ebay_request.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+require "omniauth"
+require "net/http"
+require "gyoku"
+require "multi_xml"
+require "dry-initializer"
+
+require "ebay_request/version"
+require "ebay_request/site"
+require "ebay_request/config"
+require "ebay_request/base"
+require "ebay_request/error"
+require "ebay_request/finding"
+require "ebay_request/shopping"
+require "ebay_request/trading"
+require "ebay_request/business_policies"
+require "ebay_request/auth"
+require "ebay_request/response"
+
+require "omniauth/strategies/ebay"
+
+module EbayRequest
+  class << self
+    attr_accessor :logger
+    attr_accessor :warn_logger
+    attr_accessor :config_repository
+    attr_accessor :json_logger
+
+    def config(key = nil)
+      @config_repository ||= {}
+      @config_repository[key || :default] ||= Config.new
+    end
+
+    def configure(key = nil)
+      yield(config(key)) && config(key)
+    end
+
+    def configured?
+      !@config_repository.nil?
+    end
+
+    def log(options)
+      log_info(options)
+      log_warn(options)
+      log_json(options)
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    def log_info(o)
+      return if logger.nil?
+      logger.info "[EbayRequest] | Url      | #{o[:url]}"
+      logger.info "[EbayRequest] | Headers  | #{o[:headers]}"
+      logger.info "[EbayRequest] | Body     | #{o[:request_payload]}"
+      logger.info "[EbayRequest] | Response | #{fix_utf(o[:response_payload])}"
+      logger.info "[EbayRequest] | Time     | #{o[:time]} #{o[:callname]}"
+    end
+    # rubocop:enable Metrics/AbcSize
+
+    def log_warn(o)
+      return if warn_logger.nil? || o[:warnings].empty?
+      warn_logger.warn(
+        "[EbayRequest] | #{o[:callname]} | #{o[:warnings].inspect}"
+      )
+    end
+
+    def log_json(options)
+      return if json_logger.nil?
+      json_logger.info(options)
+    end
+
+    def fix_utf(response)
+      response.encode(
+        "UTF-8", undef: :replace, invalid: :replace, replace: " "
+      )
+    end
+  end
+end

data/lib/ebay_request/auth.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+class EbayRequest::Auth < EbayRequest::Trading
+  def session_id
+    response!("GetSessionID", RuName: config.runame)
+  end
+
+  def token(session_id)
+    response!("FetchToken", SessionID: session_id)
+  end
+
+  def user(auth_token)
+    response!("GetUser", RequesterCredentials: { eBayAuthToken: auth_token },
+                         DetailLevel: "ReturnAll")
+  end
+
+  def ebay_login_url(session_id, ruparams = {})
+    params = [
+      "SignIn",
+      "RuName=#{CGI.escape(config.runame)}",
+      "SessID=#{CGI.escape(session_id)}",
+    ]
+    ruparams = CGI.escape(ruparams.map { |k, v| "#{k}=#{v}" }.join("&"))
+    params << "ruparams=#{CGI.escape(ruparams)}"
+
+    "#{signin_endpoint}?#{params.join('&')}"
+  end
+
+  private
+
+  def signin_endpoint
+    URI.parse(
+      with_sandbox("https://signin%{sandbox}.ebay.com/ws/eBayISAPI.dll")
+    )
+  end
+end

data/lib/ebay_request/base.rb

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+class EbayRequest::Base
+  def initialize(options = {})
+    @options = options
+  end
+
+  attr_reader :options
+
+  def config
+    @config ||= EbayRequest.config(options[:env])
+  end
+
+  def siteid
+    @siteid ||=
+      options[:siteid] ||
+      EbayRequest::Config.site_id_from_globalid(options[:globalid]) ||
+      0
+  end
+
+  def globalid
+    @globalid ||=
+      options[:globalid] ||
+      EbayRequest::Config.globalid_from_site_id(options[:siteid]) ||
+      "EBAY-US"
+  end
+
+  def response(callname, payload)
+    config.validate!
+    request(URI.parse(with_sandbox(endpoint)), callname, payload)
+  end
+
+  def response!(callname, payload)
+    response(callname, payload).data!
+  end
+
+  private
+
+  def endpoint
+    raise NotImplementedError, "Implement #{self.class.name}#endpoint"
+  end
+
+  def headers(_callname)
+    @options[:headers] || {}
+  end
+
+  def payload(_callname, _request)
+    raise NotImplementedError, "Implement #{self.class.name}#payload"
+  end
+
+  def parse(response)
+    MultiXml.parse(response)
+  end
+
+  def process(response, callname)
+    data = response["#{callname}Response"]
+
+    raise EbayRequest::Error, "#{callname} response is blank" if data.nil?
+    EbayRequest::Response.new(
+      callname, data, errors_for(data), self.class::FATAL_ERRORS
+    )
+  end
+
+  def with_sandbox(value)
+    # rubocop:disable Style/FormatString
+    value % { sandbox: config.sandbox? ? ".sandbox" : "" }
+  end
+
+  # rubocop:disable Metrics/MethodLength
+  def request(url, callname, request)
+    h = headers(callname)
+    b = payload(callname, request)
+
+    post = Net::HTTP::Post.new(url.path, h)
+    post.body = b
+
+    response, time = make_request(url, post)
+
+    response_object = process(parse(response), callname)
+  ensure
+    EbayRequest.log(
+      url: url.to_s,
+      callname: callname,
+      headers: h,
+      request_payload: b,
+      response_payload: response,
+      time: time,
+      warnings: response_object&.warnings,
+      errors: response_object&.errors,
+      success: response_object&.success?
+    )
+  end
+  # rubocop:enable Metrics/MethodLength
+
+  def make_request(url, post)
+    start_time = Time.now
+    http = prepare(url)
+    response = http.start { |r| r.request(post) }.body
+    [response, Time.now - start_time]
+  end
+
+  def prepare(url)
+    Net::HTTP.new(url.host, url.port).tap do |http|
+      http.read_timeout = config.timeout
+
+      if url.port == 443
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+  end
+
+  def errors_for(_r)
+    raise NotImplementedError, "Implement #{self.class.name}#errors_for"
+  end
+end

data/lib/ebay_request/business_policies.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+class EbayRequest::BusinessPolicies < EbayRequest::Base
+  private
+
+  SERVICE_NAME = "SellerProfilesManagementService"
+
+  def payload(callname, request)
+    key_converter = ->(key) { key.camelize(:lower) }
+    request = Gyoku.xml(request, key_converter: key_converter)
+
+    %(<?xml version="1.0" encoding="utf-8"?>\
+<#{callname}Request xmlns="http://www.ebay.com/marketplace/selling">\
+#{request}</#{callname}Request>)
+  end
+
+  def endpoint
+    "https://svcs%{sandbox}.ebay.com/services/selling/v1/#{SERVICE_NAME}"
+  end
+
+  def headers(callname)
+    super.merge(
+      "Content-Type" => "text/xml",
+      "X-EBAY-SOA-SECURITY-TOKEN" => options[:token].to_s,
+      "X-EBAY-SOA-SERVICE-NAME" => SERVICE_NAME,
+      "X-EBAY-SOA-OPERATION-NAME" => callname,
+      "X-EBAY-SOA-CONTENT-TYPE" => "XML",
+      "X-EBAY-SOA-GLOBAL-ID" => siteid.to_s
+    )
+  end
+
+  def errors_for(r)
+    [r.dig("errorMessage", "error")]
+      .flatten
+      .compact
+      .map { |e| [e["severity"], e["errorId"], e["message"]] }
+  end
+
+  FATAL_ERRORS = {}.freeze
+end

data/lib/ebay_request/config.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+class EbayRequest::Config
+  attr_accessor :appid
+  attr_accessor :certid
+  attr_accessor :devid
+  attr_accessor :runame
+
+  attr_accessor :sandbox
+  attr_accessor :version
+  attr_accessor :timeout
+
+  alias sandbox? sandbox
+
+  def initialize
+    @sandbox ||= true
+    @version ||= 941
+    @timeout ||= 60
+  end
+
+  def validate!
+    %w(appid certid devid runame).each do |attr|
+      value = public_send(attr)
+      raise "Set EbayRequest.config.#{attr}" if value.nil? || value.empty?
+    end
+  end
+
+  class << self
+    def globalid_from_site_id(site_id)
+      (site = sites_by_id[site_id]) && site.globalid
+    end
+
+    def site_id_from_globalid(globalid)
+      (site = sites_by_globalid[globalid.to_s.upcase]) && site.id
+    end
+
+    def site_id_from_name(name)
+      (site = sites_by_name[name]) && site.id
+    end
+
+    def sites
+      @sites ||=
+        YAML.load_file(
+          File.join(File.dirname(__FILE__), "../../config/sites.yml")
+        ).map { |h| EbayRequest::Site.new h }
+    end
+
+    def sites_by_id
+      @sites_by_id ||= Hash[sites.map { |s| [s.id, s] }]
+    end
+
+    def sites_by_globalid
+      @sites_by_globalid ||= Hash[sites.map { |s| [s.globalid, s] }]
+    end
+
+    def sites_by_name
+      @sites_by_name ||= Hash[sites.map { |s| [s.name, s] }]
+    end
+  end
+end

data/lib/ebay_request/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+class EbayRequest::Error < StandardError
+  def initialize(msg = "EbayRequest error", errors = {})
+    super(msg)
+    @errors = errors
+  end
+
+  attr_reader :errors
+end

data/lib/ebay_request/finding.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+class EbayRequest::Finding < EbayRequest::Base
+  private
+
+  def payload(callname, request)
+    request = Gyoku.xml(request)
+
+    %(<?xml version="1.0" encoding="utf-8"?><#{callname}Request\
+ xmlns="http://www.ebay.com/marketplace/search/v1/services">\
+#{request}</#{callname}Request>)
+  end
+
+  def endpoint
+    "http://svcs%{sandbox}.ebay.com/services/search/FindingService/v1"
+  end
+
+  def headers(callname)
+    super.merge(
+      "X-EBAY-SOA-SERVICE-NAME" => "FindingService",
+      "X-EBAY-SOA-SERVICE-VERSION" => "1.9.0",
+      "X-EBAY-SOA-SECURITY-APPNAME" => config.appid,
+      "X-EBAY-SOA-OPERATION-NAME" => callname,
+      "X-EBAY-SOA-REQUEST-DATA-FORMAT" => "XML",
+      "X-EBAY-SOA-GLOBAL-ID" => globalid.to_s
+    )
+  end
+
+  def errors_for(r)
+    [r.dig("errorMessage", "error")]
+      .flatten
+      .compact
+      .map { |e| [e["severity"], e["errorId"], e["message"]] }
+  end
+
+  FATAL_ERRORS = {}.freeze
+end

data/lib/ebay_request/response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+class EbayRequest::Response
+  extend Dry::Initializer
+
+  param :callname
+  param :data
+  param :errors_data
+  param :fatal_errors
+
+  def success?
+    ack = data["ack"] || data["Ack"]
+    %w(Success Warning).include?(ack)
+  end
+
+  def data!
+    raise error unless success?
+    data
+  end
+
+  def errors
+    severity("Error")
+  end
+
+  def warnings
+    severity("Warning")
+  end
+
+  def severity(severity)
+    Hash[errors_data.map { |s, c, m| [c.to_i, m] if s == severity }.compact]
+  end
+
+  def error_class
+    fatal_code = (errors.keys.map(&:to_i) & fatal_errors.keys).first
+    fatal_errors[fatal_code] || EbayRequest::Error
+  end
+
+  def error
+    error_class.new(errors.values.join(", "), errors)
+  end
+end