foxy_sync 0.1.1

data/lib/foxy_sync.rb

@@ -0,0 +1,40 @@
+module FoxySync
+  autoload :Sso,            'foxy_sync/sso'
+  autoload :Datafeed,       'foxy_sync/datafeed'
+  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'
+  end
+
+
+  def self.setup
+    yield self
+  end
+
+
+  @@api_key = nil
+
+  def self.api_key=(key)
+    @@api_key = key
+  end
+
+  def self.api_key
+    @@api_key
+  end
+
+
+  @@store_url = nil
+
+  def self.store_url=(url)
+    @@store_url = url
+  end
+
+  def self.store_url
+    @@store_url
+  end
+
+end

data/lib/foxy_sync/api/base.rb

@@ -0,0 +1,34 @@
+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+
+  class Base
+    attr_accessor :api_response
+
+    #
+    # [_api_response_]
+    #   A +FoxySync::Api::Response+ instance
+    def initialize(api_response)
+      self.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
+    end
+
+
+    private
+
+    def method_missing(method_name, *args, &block)
+      api_response.send method_name, *args
+    end
+
+
+    def fc_api
+      @_fc_api ||= FoxySync::Api::Messenger.new
+    end
+  end
+end

data/lib/foxy_sync/api/customer.rb

@@ -0,0 +1,40 @@
+require 'openssl'
+
+module FoxySync::Api
+  #
+  # Each method here corresponds to a call in the "Customer" section
+  # of the FoxyCart API (customer_get, customer_save, etc.).
+  class Customer < Base
+    attr_accessor :user
+
+    #
+    # Upon initialization requests and retains the
+    # response to FoxyCart's customer_get API command.
+    # The full response is available via #api_response.
+    # [_user_]
+    #   An object that responds_to? the following:
+    #     * #email
+    #     * #password_salt
+    #     * #encrypted_password
+    #   These are commonly found on +User+ class instances
+    #   that work with authentication systems like +Devise+
+    def initialize(user)
+      self.user = user
+      super fc_api.customer_get :customer_email => user.email
+    end
+
+
+    #
+    # Sends the customer_save command to the FoxyCart API.
+    # Returns a FoxySync::Api::Response
+    def save
+      salt = user.password_salt
+      hash = OpenSSL::HMAC.hexdigest 'sha256', salt, user.encrypted_password + salt
+      fc_api.customer_save(
+        :customer_email => user.email,
+        :customer_password_hash => hash,
+        :customer_password_salt => salt
+      )
+    end
+  end
+end

data/lib/foxy_sync/api/messenger.rb

@@ -0,0 +1,85 @@
+require 'net/http'
+require 'uri'
+
+module FoxySync::Api
+  #
+  # Use this class to send and receive messages to/from
+  # 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:
+  #
+  # api = FoxySync::Api::Messenger.new
+  # reply = api.customer_get :customer_email => 'foo@bar.com'
+  #
+  # +Messenger+ instances respond to every API call in FoxyCart v1.0.
+  class Messenger
+    URL = URI.parse "#{FoxySync.store_url}/api"
+
+
+    def respond_to?(method_name, include_private = false)
+      %w(
+        store_template_cache
+        store_includes_get
+        attribute_save
+        attribute_list
+        attribute_delete
+        category_list
+        downloadable_list
+        customer_get
+        customer_save
+        customer_list
+        customer_address_get
+        customer_address_save
+        transaction_get
+        transaction_list
+        transaction_modify
+        transaction_datafeed
+        subscription_get
+        subscription_cancel
+        subscription_modify
+        subscription_list
+        subscription_datafeed
+      ).include? method_name.to_s
+    end
+
+
+    private
+
+    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
+    end
+
+
+    def api_request(action, params = {})
+      params.merge!({
+        :api_action => action,
+        :api_token => FoxySync.api_key
+      })
+
+      attempts = 0
+
+      begin
+        http = Net::HTTP.new URL.host, URL.port
+        http.use_ssl = true
+        #http.set_debug_output $stdout
+
+        request = Net::HTTP::Post.new URL.request_uri
+        request.set_form_data params
+
+        response = http.request request
+        response.body
+      rescue => e
+        if attempts < 3
+          attempts += 1
+          sleep 1
+          retry
+        end
+
+        raise e
+      end
+    end
+  end
+end

data/lib/foxy_sync/api/response.rb

@@ -0,0 +1,47 @@
+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

data/lib/foxy_sync/cart_validation.rb

@@ -0,0 +1,23 @@
+require 'openssl'
+
+module FoxySync
+  #
+  # Holds methods to help with FoxyCart's HMAC link and form (cart)
+  # validation (http://wiki.foxycart.com/v/1.0/hmac_validation).
+  # Typically mixed into a view helper.
+  module CartValidation
+
+    #
+    # Creates the value expected on name elements of form inputs
+    # [_name_]
+    #  The plain text value of the name element
+    # [_value_]
+    #  The value of the input with name +name+
+    # [_code_]
+    #  The code of the product that the input relates to
+    def cart_input_name(name, value, code)
+      "#{name.to_s}||#{OpenSSL::HMAC.hexdigest 'sha256', FoxySync.api_key, code.to_s + name.to_s + value.to_s}"
+    end
+
+  end
+end

data/lib/foxy_sync/datafeed.rb

@@ -0,0 +1,32 @@
+require 'rc4'
+require 'cgi'
+
+module FoxySync
+  #
+  # Holds methods that help with FoxyCart's datafeed
+  # requests (http://wiki.foxycart.com/v/1.0/webhooks).
+  # This module is typically mixed into a controller.
+  module Datafeed
+
+    #
+    # Handles the decoding and decrypting of a datafeed request.
+    # Returns a +FoxySync::Api::Response+ whose document is the datafeed XML
+    #[_params_]
+    #  Something that responds_to? [] and has a key 'FoxyData'. In Rails
+    #  that would be the +params+ object
+    def datafeed_unwrap(params)
+      encrypted = params['FoxyData']
+      rc4 = RC4.new FoxySync.api_key
+      xml = rc4.decrypt CGI::unescape(encrypted)
+      FoxySync::Api::Response.new xml
+    end
+
+
+    #
+    # Wrapper for the text reply that a datafeed request expects
+    def datafeed_response
+      'foxy'
+    end
+
+  end
+end

data/lib/foxy_sync/sso.rb

@@ -0,0 +1,46 @@
+require 'digest/sha1'
+
+module FoxySync
+  #
+  # Holds methods that help with FoxyCart's SSO service
+  # (http://wiki.foxycart.com/v/1.0/sso). This module is
+  # intended to be mixed into a controller for easy completion
+  # of the SSO handshake.
+  module Sso
+    #
+    # Returns the redirect URL that FoxyCart
+    # expects to be requested after it hits your
+    # application's SSO URL.
+    # [_params_]
+    #   Something that responds to [] and holds the
+    #   'fcsid' and 'timestamp' parameters given by
+    #   the FoxyCart SSO request. Usually your controller's
+    #   +params+ object.
+    # [_user_]
+    #   The currently logged in user, if any
+    def sso_url(params, user = nil)
+      fc_session_id = params['fcsid']
+      cid = 0
+
+      if user
+        customer = FoxySync::Api::Customer.new user
+        cid = customer.customer_id
+        cid = customer.save.customer_id if cid.nil?
+      end
+
+      timestamp = params['timestamp'].to_i
+      later_timestamp = timestamp + 60 * 60
+      token = auth_token cid, later_timestamp
+
+      "#{FoxySync.store_url}/checkout?fc_auth_token=#{token}&fcsid=#{fc_session_id}&fc_customer_id=#{cid}&timestamp=#{later_timestamp}"
+    end
+
+
+    private
+
+    def auth_token(customer_id, timestamp)
+      Digest::SHA1.hexdigest("#{customer_id}|#{timestamp}|#{FoxySync.api_key}")
+    end
+
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: foxy_sync
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Chris Stump
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.5
+- !ruby/object:Gem::Dependency
+  name: ruby-rc4
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.5
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+description: Encapsulates FoxyCart SSO, datafeed, and cart validation protocols
+email: chris@tablexi.com
+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
+homepage: https://github.com/tablexi/foxy_sync
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Synchronizes your Ruby application with FoxyCart
+test_files: []