foxy_sync 0.1.1 → 0.2.0

data/lib/foxy_sync/api/base.rb

@@ -1,22 +1,23 @@
 module FoxySync::Api
   #
   # Intended for subclassing, +Base+ forms the foundation
-  # for ::Api:: classes that wrap an ::Api::Response object
-  # to provide behavior around specific data in the +Response+
+  # for ::Api:: classes that wrap a +FoxySync::Xml::Document+
+  # composed of API reply XML to provide behavior around
+  # specific elements
   class Base
-    attr_accessor :api_response
+    attr_reader :api_response
 
     #
     # [_api_response_]
-    #   A +FoxySync::Api::Response+ instance
+    #   A +FoxySync::Xml::Document+ that holds API reply XML
     def initialize(api_response)
-      self.api_response = api_response
+      @api_response = api_response
     end
 
     #
     # Delegates to #api_response
     def respond_to?(method_name, include_private = false)
-      api_response.respond_to? method_name, include_private
+      super || api_response.respond_to?(method_name, include_private)
     end
 
 
@@ -27,8 +28,8 @@ module FoxySync::Api
     end
 
 
-    def fc_api
-      @_fc_api ||= FoxySync::Api::Messenger.new
+    def messenger
+      @_messenger ||= FoxySync::Api::Messenger.new
     end
   end
 end

data/lib/foxy_sync/api/customer.rb

@@ -20,21 +20,22 @@ module FoxySync::Api
     #   that work with authentication systems like +Devise+
     def initialize(user)
       self.user = user
-      super fc_api.customer_get :customer_email => user.email
+      super messenger.customer_get :customer_email => user.email
     end
 
 
     #
     # Sends the customer_save command to the FoxyCart API.
-    # Returns a FoxySync::Api::Response
+    # Returns a FoxySync::Xml::Document
     def save
       salt = user.password_salt
       hash = OpenSSL::HMAC.hexdigest 'sha256', salt, user.encrypted_password + salt
-      fc_api.customer_save(
+      messenger.customer_save(
         :customer_email => user.email,
         :customer_password_hash => hash,
         :customer_password_salt => salt
       )
     end
   end
+
 end

data/lib/foxy_sync/api/messenger.rb

@@ -7,7 +7,7 @@ module FoxySync::Api
   # the FoxyCart API (http://wiki.foxycart.com/v/1.0/api).
   # To use it create a new instance and then send it a message
   # that corresponds to the FoxyCart API. All messages
-  # return an instance of +FoxySync::Api::Response+. For Example:
+  # return an instance of +FoxySync::Xml::Document+. For Example:
   #
   # api = FoxySync::Api::Messenger.new
   # reply = api.customer_get :customer_email => 'foo@bar.com'
@@ -49,7 +49,7 @@ module FoxySync::Api
     def method_missing(method_name, *args, &block)
       return super unless respond_to? method_name
       xml = api_request method_name, args.first || {}
-      FoxySync::Api::Response.new xml
+      FoxySync::Xml::Document.new xml
     end
 
 

data/lib/foxy_sync/datafeed.rb

@@ -9,8 +9,8 @@ module FoxySync
   module Datafeed
 
     #
-    # Handles the decoding and decrypting of a datafeed request.
-    # Returns a +FoxySync::Api::Response+ whose document is the datafeed XML
+    # Handles the decoding and decrypting of a datafeed.
+    # Returns a +FoxySync::Xml::Document+ whose #xml is the datafeed XML
     #[_params_]
     #  Something that responds_to? [] and has a key 'FoxyData'. In Rails
     #  that would be the +params+ object
@@ -18,7 +18,7 @@ module FoxySync
       encrypted = params['FoxyData']
       rc4 = RC4.new FoxySync.api_key
       xml = rc4.decrypt CGI::unescape(encrypted)
-      FoxySync::Api::Response.new xml
+      FoxySync::Xml::Document.new xml
     end
 
 

data/lib/foxy_sync/xml/base.rb

@@ -0,0 +1,48 @@
+module FoxySync::Xml
+  #
+  # Allows querying of the given +Nokogiri::XML::Node+.
+  # Every message returns:
+  #
+  # * nil if no matching element is found in the XML or
+  #   if the matched element(s) do not contain text or cdata.
+  # * A +String+ if there is one matching element in the reply.
+  # * An +Array+ with all element values if there is more than one
+  #   matching element in the XML.
+  class Base
+
+    attr_reader :node
+
+
+    #
+    # [_node_]
+    #   A +Nokogiri::XML::Node+
+    def initialize(node)
+      @node = node
+    end
+
+
+    def respond_to?(method_name, include_private = false)
+      true # respond to everything; we don't know what will be in the response doc
+    end
+
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      node_set = node.xpath "//#{method_name}"
+      return nil if node_set.nil? || node_set.empty?
+
+      contents = []
+
+      node_set.children.each do |child|
+        next if child.element?
+        content = child.content.strip
+        contents << content unless content.empty?
+      end
+
+      contents.empty? ? nil : contents.size == 1 ? contents.first : contents
+    end
+
+  end
+
+end

data/lib/foxy_sync/xml/document.rb

@@ -0,0 +1,22 @@
+require 'nokogiri'
+
+module FoxySync::Xml
+  #
+  # Encapsulates a FoxyCart XML doc. To use it simply send a
+  # message that corresponds to an element in the XML. For example,
+  #
+  # api = FoxySync::Api::Messenger.new
+  # reply = api.customer_get :customer_email => 'foo@bar.com'
+  # reply.customer_id # is the customer's FoxyCart id
+  class Document < Base
+    #
+    # The raw XML used to create this +Document+
+    attr_reader :xml
+
+
+    def initialize(xml)
+      @xml = xml
+      super Nokogiri::XML(xml) {|config| config.strict.nonet }
+    end
+  end
+end

data/lib/foxy_sync/xml/transaction_detail.rb

@@ -0,0 +1,39 @@
+module FoxySync::Xml
+  #
+  # Provides methods to easily query the transaction_detail
+  # elements found in a FoxyCart transaction XML datafeed
+  class TransactionDetail < Base
+
+    #
+    # Returns an +Array+ of the +TransactionDetail+s in +xml_base+
+    # [_xml_base_]
+    #   A +FoxySync::Xml::Base+ that has a transaction_details element
+    def self.all(xml_base)
+      transactions = []
+
+      xml_base.node.xpath('//transaction_details').each do |detail|
+        transactions << new(detail)
+      end
+
+      transactions
+    end
+
+
+    #
+    # Returns custom product options in a 'name' => 'value' +Hash+
+    def custom_product_options
+      options = {}
+      options_xml = node.xpath '//transaction_detail_option'
+
+      options_xml.each do |node|
+        name = node.at_css('product_option_name').content.strip
+        value = node.at_css('product_option_value').content.strip
+        options[name] = value
+      end
+
+      options
+    end
+
+  end
+
+end

data/lib/foxy_sync.rb

@@ -4,10 +4,16 @@ module FoxySync
   autoload :CartValidation, 'foxy_sync/cart_validation'
 
   module Api
-    autoload :Messenger, 'foxy_sync/api/messenger'
-    autoload :Response,  'foxy_sync/api/response'
     autoload :Base,      'foxy_sync/api/base'
     autoload :Customer,  'foxy_sync/api/customer'
+    autoload :Messenger, 'foxy_sync/api/messenger'
+  end
+
+  module Xml
+    autoload :Base,              'foxy_sync/xml/base'
+    autoload :Document,          'foxy_sync/xml/document'
+    autoload :Transaction,       'foxy_sync/xml/transaction'
+    autoload :TransactionDetail, 'foxy_sync/xml/transaction_detail'
   end
 
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foxy_sync
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-10 00:00:00.000000000 Z
+date: 2013-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -65,14 +65,26 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ./lib/foxy_sync/api/base.rb
-- ./lib/foxy_sync/api/customer.rb
-- ./lib/foxy_sync/api/messenger.rb
-- ./lib/foxy_sync/api/response.rb
-- ./lib/foxy_sync/cart_validation.rb
-- ./lib/foxy_sync/datafeed.rb
-- ./lib/foxy_sync/sso.rb
-- ./lib/foxy_sync.rb
+- !binary |-
+  Li9saWIvZm94eV9zeW5jL2FwaS9iYXNlLnJi
+- !binary |-
+  Li9saWIvZm94eV9zeW5jL2FwaS9jdXN0b21lci5yYg==
+- !binary |-
+  Li9saWIvZm94eV9zeW5jL2FwaS9tZXNzZW5nZXIucmI=
+- !binary |-
+  Li9saWIvZm94eV9zeW5jL2NhcnRfdmFsaWRhdGlvbi5yYg==
+- !binary |-
+  Li9saWIvZm94eV9zeW5jL2RhdGFmZWVkLnJi
+- !binary |-
+  Li9saWIvZm94eV9zeW5jL3Nzby5yYg==
+- !binary |-
+  Li9saWIvZm94eV9zeW5jL3htbC9iYXNlLnJi
+- !binary |-
+  Li9saWIvZm94eV9zeW5jL3htbC9kb2N1bWVudC5yYg==
+- !binary |-
+  Li9saWIvZm94eV9zeW5jL3htbC90cmFuc2FjdGlvbl9kZXRhaWwucmI=
+- !binary |-
+  Li9saWIvZm94eV9zeW5jLnJi
 homepage: https://github.com/tablexi/foxy_sync
 licenses: []
 post_install_message: 
@@ -93,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Synchronizes your Ruby application with FoxyCart

data/lib/foxy_sync/api/response.rb

@@ -1,47 +0,0 @@
-require 'nokogiri'
-
-module FoxySync::Api
-  #
-  # A +Response+ represents an XML reply
-  # sent by the FoxyCart API. To use it simply
-  # send an instance a message that corresponds
-  # to an element in the XML. For example,
-  #
-  # api = FoxySync::Api::Messenger.new
-  # reply = api.customer_get :customer_email => 'foo@bar.com'
-  # reply.customer_id # is the customer's FoxyCart id
-  #
-  # Every message will return +nil+ if no matching
-  # element is found in the XML reply, a +String+ if
-  # there is one matching element in the reply, or an
-  # +Array+ with all element values if there is more than one
-  # element in the XML reply.
-  class Response
-    #
-    # A +Nokogiri::XML::Document+ of the API reply
-    attr_reader :document
-
-
-    def initialize(xml)
-      @document = Nokogiri::XML(xml) {|config| config.strict.nonet }
-    end
-
-
-    def respond_to?(method_name, include_private = false)
-      true # respond to everything; we don't know what will be in the response doc
-    end
-
-
-    private
-
-    def method_missing(method_name, *args, &block)
-      node_set = document.xpath "//#{method_name}"
-      return nil if node_set.nil? || node_set.empty?
-
-      contents = node_set.to_a
-      contents.map!{|node| node.content }
-      contents.delete_if{|content| content.empty? }
-      contents.size == 1 ? contents.first : contents
-    end
-  end
-end