ebay-trader 0.9.5

data/lib/ebay_trader/sax_handler.rb

@@ -0,0 +1,151 @@
+#require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/string'
+require 'hash_with_indifferent_access'
+
+module EbayTrader
+  class SaxHandler
+
+    attr_accessor :stack
+    attr_accessor :path
+    attr_reader :skip_type_casting
+    attr_reader :known_arrays
+
+    def initialize(args = {})
+      @stack = []
+      @stack.push(HashWithIndifferentAccess.new)
+      @path = []
+      @hash = nil
+      @attributes = {}
+
+      @skip_type_casting = args[:skip_type_casting] || []
+      @skip_type_casting = [@skip_type_casting] unless @skip_type_casting.is_a?(Array)
+      @skip_type_casting.map! { |key| format(key.to_s) }
+
+      @known_arrays = args[:known_arrays] || []
+      @known_arrays = [@known_arrays] unless @known_arrays.is_a?(Array)
+      @known_arrays.map! { |key| format(key.to_s) }
+    end
+
+    def to_hash
+      stack[0]
+    end
+
+    def start_element(name)
+      @attributes.clear
+      name = name.to_s
+      path.push(name)
+
+      hash = HashWithIndifferentAccess.new
+      append(format_key(name), hash)
+      stack.push(hash)
+    end
+
+    def end_element(_)
+      @stack.pop
+      @path.pop
+    end
+
+    def text(value)
+      key = format_key(path.last)
+      auto_cast = !(skip_type_casting.include?(path.last) || skip_type_casting.include?(key.to_s))
+      parent = @stack[-2]
+
+      # If 'CurrencyID' is a defined attribute we are dealing with money type
+      if @attributes.key?('CurrencyID')
+        currency = @attributes.delete('CurrencyID')
+        value = BigDecimal.new(value)
+        if EbayTrader.configuration.price_type == :money && EbayTrader.is_money_gem_installed?
+          value = Money.new((value * 100).round.to_i, currency)
+        else
+          @attributes['Currency'] = currency
+          value = value.to_f if EbayTrader.configuration.price_type == :float
+          value = (value * 100).round.to_i if EbayTrader.configuration.price_type == :fixnum
+        end
+      end
+
+      if auto_cast && value.is_a?(String)
+        case
+          when value.downcase == 'false' then value = false
+          when value.downcase == 'true'  then value = true
+          when value.match(/^[0-9]+$/) then value = value.to_i
+          when value.match(/^[0-9]+[.][0-9]+$/) then value = value.to_f
+          when value.match(/^[0-9]{4}-[0-9]{2}-[0-9]{2}[T ][0-9]{2}:[0-9]{2}:[0-9]{2}(.[0-9a-z]+)?$/i)
+            value = Time.parse(value)
+        end
+      end
+
+      if parent[key].is_a?(Array)
+        parent[key].pop if parent[key].last.is_a?(Hash) && parent[key].last.empty?
+        parent[key] << value
+      else
+        parent[key] = value
+      end
+
+      unless @attributes.empty?
+        @attributes.each_pair do |attr_key, attr_value|
+          attr_key_element_name = format_key("#{path.last}#{attr_key}")
+          parent[attr_key_element_name] = attr_value
+        end
+      end
+    end
+
+    def cdata(value)
+      key = format_key(path.last)
+      parent = @stack[-2]
+      parent[key] = value
+    end
+
+    def attr(name, value)
+      return if name.to_s.downcase == 'xmlns'
+      last = path.last
+      return if last.nil?
+
+      name = name[0].upcase + name[1...name.length]
+      @attributes[name] = value
+    end
+
+    def error(message, line, column)
+      raise Exception.new("#{message} at #{line}:#{column}")
+    end
+
+    def append(key, value)
+      key = key.to_s
+      h = @stack.last
+      if h.key?(key)
+        v = h[key]
+        if v.is_a?(Array)
+          v << value
+        else
+          h[key] = [v, value]
+        end
+      else
+        if known_arrays.include?(key)
+          h[key] = [value]
+        else
+          h[key] = value
+        end
+      end
+    end
+
+    #-------------------------------------------------------------------------
+    private
+
+    # Ensure the key is an underscored Symbol.
+    #
+    # Examples:
+    #
+    #     'ApplyBuyerProtection' -> :apply_buyer_protection
+    #     'PayPalEmailAddress'   -> :paypal_email_address
+    #     'SoldOffeBay'          -> :sold_off_ebay
+    #
+    # @return [Symbol] the reformatted key.
+    #
+    def format_key(key)
+      key = key.to_s
+      key = key.gsub('PayPal', 'Paypal')
+      key = key.gsub('eBay',   'Ebay')
+      key = key.gsub('EBay',   'Ebay')
+      key.underscore.to_sym
+    end
+  end
+end

data/lib/ebay_trader/session_id.rb

@@ -0,0 +1,71 @@
+require 'cgi'
+require 'ebay_trader/request'
+
+module EbayTrader
+
+  # Request a session ID from the eBay API.
+  #
+  # @see http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSessionID.html
+  # @see http://developer.ebay.com/DevZone/XML/docs/HowTo/Tokens/GettingTokens.html
+  # @see http://developer.ebay.com/DevZone/guides/ebayfeatures/Basics/Tokens-MultipleUsers.html
+  #
+  class SessionID < Request
+
+    CALL_NAME = 'GetSessionID'
+
+    # The application RuName defined in {Configuration#ru_name}, unless over-ridden in {#initialize} args.
+    # @return [String] the RuName for this call.
+    # @see https://developer.ebay.com/DevZone/account/appsettings/Consent/
+    #
+    attr_reader :ru_name
+
+    # Construct a GetSessionID eBay API call.
+    # @param [Hash] args a hash of optional arguments.
+    # @option args [String] :ru_name Override the default RuName,
+    #                       which should be defined in {Configuration#ru_name}.
+    #
+    def initialize(args = {})
+      @ru_name = (args[:ru_name] || EbayTrader.configuration.ru_name).freeze
+
+      super(CALL_NAME, args) do
+        RuName ru_name
+      end
+    end
+
+    # Get the session ID returned by the API call.
+    # @return [String] the session ID.
+    #
+    def id
+      response_hash[:session_id]
+    end
+
+    # Get the URL through which a user must sign in using this session ID.
+    # @param [Hash] ruparams eBay appends this data to the AcceptURL and RejectURL.
+    #               In a typical rails app this might include the user's model primary key.
+    # @return [String] the sign-in URL.
+    #
+    def sign_in_url(ruparams = {})
+      url = EbayTrader.configuration.production? ? 'https://signin.ebay.com' : 'https://signin.sandbox.ebay.com'
+      url << '/ws/eBayISAPI.dll?SignIn'
+      url << "&runame=#{url_encode ru_name}"
+      url << "&SessID=#{url_encode id}"
+      if ruparams && ruparams.is_a?(Hash) && !ruparams.empty?
+        params = []
+        ruparams.each_pair { |key, value| params << "#{key}=#{value}" }
+        url << "&ruparams=#{url_encode(params.join('&'))}"
+      end
+      url
+    end
+
+    #---------------------------------------------------------------
+    private
+
+    def url_encode(string)
+      CGI.escape string
+    end
+
+    def url_decode(string)
+      CGI.unescape string
+    end
+  end
+end

data/lib/ebay_trader/version.rb

@@ -0,0 +1,3 @@
+module EbayTrader
+  VERSION = '0.9.5'
+end

data/lib/ebay_trader/xml_builder.rb

@@ -0,0 +1,113 @@
+module EbayTrader
+  class XMLBuilder
+
+    attr_reader :context, :xml, :depth, :tab_width
+
+    def initialize(args = {})
+      @xml = ''
+      @depth = 0
+      @tab_width = (args[:tab_width] || 0).to_i
+    end
+
+    # Catch-all method to avoid having to create individual methods for each XML tag name.
+    def method_missing(method_name, *args, &block)
+      if @context && @context.respond_to?(method_name)
+        @context.send(method_name, *args, &block)
+      else
+        node(method_name, args, &block)
+      end
+    end
+
+    # Only respond to method names with only numbers and letters.
+    # Do not respond to names with underscores.
+    def respond_to_missing?(method_name, include_private = false)
+      super || method_name.to_s =~ /^[a-z0-9]+$/i
+    end
+
+    # Begin creating an XML string by specifying the root node.
+    # This also set the context scope, allowing methods and variable
+    # outside the block to be accessed.
+    # @param [String] name the name of the root node element.
+    # @param [Array]  args the data for this element.
+    # @param [Block]  block an optional block of sub-elements to be nested
+    #                 within the root node.
+    def root(name, *args, &block)
+      set_context(&block)
+      node(name, args, &block)
+    end
+
+    #---------------------------------------------------------------------------
+    private
+
+    # @see https://github.com/sparklemotion/nokogiri/blob/master/lib/nokogiri/xml/builder.rb
+    def set_context(&block)
+      @context = block_given? ? eval('self', block.binding) : nil
+      @context = nil if @context.is_a?(XMLBuilder)
+    end
+
+    # Create an XML node
+    # @param [String|Symbol] name the name of the XML element (ul, li, strong, etc...)
+    # @param [Array] args Can contain a String of text or a Hash of attributes
+    # @param [Block] block An optional block which will further nest XML
+    def node(name, args, &block)
+      content = get_node_content(args)
+      options = format_node_attributes(get_node_attributes(args))
+
+      @xml << "#{indent_new_line}<#{name}#{options}>#{content}"
+      if block_given?
+        @depth += 1
+        instance_eval(&block)
+        @depth -= 1
+        @xml << indent_new_line
+      end
+      @xml << "</#{name}>"
+      @xml.strip
+    end
+
+    # Return the first Hash in the list of arguments to #node
+    # as this defines the attributes for the XML node.
+    # @return [Hash] the hash of attributes for this node.
+    #
+    def get_node_attributes(args)
+      args.detect { |arg| arg.is_a? Hash } || {}
+    end
+
+    # Return the node content as a String, unless a block is given.
+    # @return [String] the node data.
+    #
+    def get_node_content(args)
+      return nil if block_given?
+      content = nil
+      args.each do |arg|
+        case arg
+          when Hash
+            next
+          when Time
+            # eBay official TimeStamp format YYYY-MM-DDTHH:MM:SS.SSSZ
+            content = arg.strftime('%Y-%m-%dT%H:%M:%S.%Z')
+          when DateTime
+            content = arg.strftime('%Y-%m-%dT%H:%M:%S.%Z')
+            break
+          else
+            content = arg.to_s
+            break
+        end
+      end
+      content
+    end
+
+    # Convert the given Hash of options into a string of XML element attributes.
+    #
+    def format_node_attributes(options)
+      options.collect { |key, value|
+        value = value.to_s.gsub('"', '\"')
+        " #{key}=\"#{value}\""
+      }.join('')
+    end
+
+    # Add a new line to the XML and indent with the appropriate number of spaces.
+    def indent_new_line
+      tab_width > 0 ? ("\n" + (' ' * tab_width * depth)) : ''
+    end
+  end
+end

data/lib/hash_with_indifferent_access.rb

@@ -0,0 +1,23 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
+class HashWithIndifferentAccess
+
+  # Perform a depth first search of this hash and return the first element
+  # matching +path+, or +default+ if nothing found.
+  # @param [Array[String | Symbol] | String | Symbol] path to the element of interest.
+  # @param [Object] default the object to be returned if there is no result for +path+.
+  # @return [Object] the first object found on +path+ or +default+.
+  #
+  def deep_find(path, default = nil)
+    return default unless path
+    path = [path] if path.is_a?(String) || path.is_a?(Symbol)
+    return default unless path.is_a?(Array) && !path.empty?
+
+    location = self
+    path.each do |key|
+      return default if location.nil? || !location.key?(key)
+      location = location[key]
+    end
+    return location
+  end
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: ebay-trader
+version: !ruby/object:Gem::Version
+  version: 0.9.5
+platform: ruby
+authors:
+- Rob Graham
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-08 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.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: |2
+      EbayTrader is a lightweight easy to use Ruby gem for interacting with eBay's Trading API.
+      Using its simple DSL you can quickly and intuitively post XML requests to eBay and rapidly interpret the responses.
+email:
+- rob@altabyte.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ebay_trader.gemspec
+- examples/get_categories.rb
+- examples/more_examples.rb
+- lib/ebay_trader.rb
+- lib/ebay_trader/configuration.rb
+- lib/ebay_trader/fetch_token.rb
+- lib/ebay_trader/request.rb
+- lib/ebay_trader/sax_handler.rb
+- lib/ebay_trader/session_id.rb
+- lib/ebay_trader/version.rb
+- lib/ebay_trader/xml_builder.rb
+- lib/hash_with_indifferent_access.rb
+homepage: https://github.com/altabyte/ebay_trader
+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.6
+signing_key: 
+specification_version: 4
+summary: A DSL to interact with eBay's Trading API using Ruby
+test_files: []
+has_rdoc: