foxycart_helpers 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f5fd26d3b714a0c8da11768cce2851729179ca9
-  data.tar.gz: a91e981343f2cb65ccc354c69fb92a0eb2978899
+  metadata.gz: 1b6e59326aa6c2092550190903c0e195bd09ba12
+  data.tar.gz: 786de45e35135ae337095c80303a25fc8d2733f0
 SHA512:
-  metadata.gz: 4293fbedae46cbfe935cc72f0f27a7f53fa347b40f6e232c0635c092a39780e670a877a118cf9195d59d60f2e1dcc293f037254282be879ae9beeb2180b462ff
-  data.tar.gz: 502e6cd100890745946a4356794d3fb78d700de7699897df63e110d5ec4c6d179c81f44f0e610f8f677348c2dd6b4a0ea7cb198bfc29170aeca649df6c826bea
+  metadata.gz: c29b6f02bc62fe6b80c7992f62bc000fd7c349869dfd4cd9bd6c419b5b78636c9d24103ee9e029fd9cc00012d349a89480a9290ea8de28164a5f12dcbdf6643c
+  data.tar.gz: 6d21663aa68e7be07ce5ee3901a36d90fee0dfb45f5f96d8c554e5f91d76efdb39b840421e1bdc920d3d104d16627f5e629b218f12f615cb8f8db21916afc234

data/.gitignore

@@ -7,3 +7,5 @@
 /pkg/
 /spec/reports/
 /tmp/
+
+.env

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in foxycart.gemspec
+# Specify your gem's dependencies in foxycart_helpers.gemspec
 gemspec

data/README.md

@@ -1,8 +1,11 @@
 # Foxycart Helpers
 
-Several helpers for working with FoxyCart:
+Several helpers for working with FoxyCart in plain Ruby (several Rails helpers are included too but Rails isn't required):
 
 * Webhook endpoint for Datafeeds - https://wiki.foxycart.com/v/2.0/transaction_xml_datafeed
+* HMAC Product Verification - https://wiki.foxycart.com/v/2.0/hmac_validation
+* Link href builder (with support for Product Verification)
+* Generation of the store `loader.js` Javascript URL and HTML.
 
 ## Installation
 
@@ -20,6 +23,28 @@ Or install it yourself as:
 
 `$ gem install foxycart_helpers`
 
+
+## Setup
+
+The datafeed endpoint defaults to '/foxycart_processor'. If your app is at `https://example.com/` then you should set your datafeed URL in FoxyCart to `https://example.com/foxycart_processor`
+
+`ENV['FOXYCART_API_KEY']` should be set to your FoxyCart API key (available from the FoxyCart Admin area).
+
+`ENV['FOXYCART_URL']` should be set to your store URL.
+
+Or you can override/set these in configuration:
+
+```ruby
+# In an appropriate initializer e.g. /config/initializers/foxycart.rb
+FoxycartHelpers.configure do |config|
+  config.mount_point = '/some/other/path'
+  config.api_key = 'foobarbat'
+  config.url = 'https://example.foxycart.com/'
+  config.auto_encode_hrefs = true # automatically use product verification on generated hrefs
+end
+```
+
+
 ## Usage
 
 ### Transactional Datafeed Webhook
@@ -40,6 +65,8 @@ __Rack/Sinatra:__
 
 __Rails:__ This middleware is registered automatically.
 
+Then:
+
 ```ruby
 FoxycartHelpers.subscribe do |payload|
   puts payload
@@ -50,6 +77,101 @@ end
 
 In Rails this could live at `config/initalizers/foxycart.rb`
 
+
+### HMAC Product Verification
+
+This helper HMAC encodes values for use with the Product Verification feature of FoxyCart, it:
+
+* Encodes with your API key `ENV['FOXYCART_API_KEY']`
+* Can return both full string for direct replacement of existing names and values or just the hash.
+* Includes Rails view helpers.
+
+* `code` = Product code (`sku123`)
+* `name` = Value of name field in the HTML (`name`)
+* `value` = Value (or initial value) of the input etc (`Cool Example`)
+
+See the [FoxyCart docs](https://wiki.foxycart.com/v/2.0/hmac_validation) for more information on `code`, `name` and `value`.
+
+__Standalone:__
+
+```ruby
+FoxycartHelpers::ProductVerification.encode code, name, value
+# => "54a534ba0afef1b4589c2f77f9011e27089c0030a8876ec8f06fca281fedeb89"
+FoxycartHelpers::ProductVerification.encoded_name code, name, value
+# => "name||54a534ba0afef1b4589c2f77f9011e27089c0030a8876ec8f06fca281fedeb89"
+```
+
+__Rails:__
+
+In your views:
+
+```ruby
+<%= foxycart_encode 'sku123', 'name', 'Cool Example' %>
+# => "54a534ba0afef1b4589c2f77f9011e27089c0030a8876ec8f06fca281fedeb89"
+<%= foxycart_encoded_name 'sku123', 'name', 'Cool Example' %>
+# => "name||54a534ba0afef1b4589c2f77f9011e27089c0030a8876ec8f06fca281fedeb89"
+```
+
+## Link HREF builder
+
+Creates cart HREFs (encoded or plain) given for a store URL `ENV['FOXYCART_URL']`.
+
+Params are:
+
+* `name` (required always)
+* `price` (required always)
+* `code` (required if product validation is used)
+* `opts` a hash, supported values here: https://wiki.foxycart.com/v/2.0/cheat_sheet
+
+__Standalone:__
+
+```ruby
+# plain
+FoxycartHelpers::Link.href 'Cool Example', '10', nil, { color: 'red' }
+# => "https://example.foxycart.com/cart?name=Cool+Example&price=10&color=red"
+
+# encoded (switched on in config)
+FoxycartHelpers::Link.href 'Cool Example', '10', 'sku123', { color: 'red' }
+=> "https://example.foxycart.com/cart?name=Cool%20Example||54a534ba0afef1b4589c2f77f9011e27089c0030a8876ec8f06fca281fedeb89&price=10||a36dd6bcf3587676c9926d389c87cda3bf0033e6c40e0cc7124edc38409f16a9&code=sku123||dc2a524b987ee5e18af483c1a9e2d333f50eae7d8ed417b8b39442dff4c3ab82&color=red||a81b7a17e4f142ae99678fba7e479734785914953a07a42a0dbd44e145775ae9"
+```
+
+__Rails:__
+
+In your views:
+
+```
+<%= foxycart_url_for('Cool Example', '10', 'sku123') %>
+# => "https://example.foxycart.com/cart?name=Cool+Example&price=10&color=red"
+<%= link_to 'Click the Link', foxycart_url_for('Cool Example', '10', 'sku123') %>
+# => "<a href=\"https://example.foxycart.com/cart?name=Cool+Example&price=10&color=red\">Click the Link</a>"
+```
+
+## `loader.js`
+
+FoxyCart's required Javascript. Always linked as HTTPS.
+Available as just the URL and HTML element. Inferred from your configured store URL.
+
+
+__Standalone:__
+
+```ruby
+FoxycartHelpers::Javascript.url
+# => "https://cdn.foxycart.com/example/loader.js"
+
+FoxycartHelpers::Javascript.html_element
+# => "<script src=\"https://cdn.foxycart.com/example/loader.js\" async defer></script>"
+```
+
+__Rails:__
+
+Helper for use in your layout or relevant pages:
+
+```ruby
+<%= foxycart_loader_js %>
+# => "<script src=\"https://cdn.foxycart.com/example/loader.js\" async defer></script>"
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/foxycart_helpers.rb

@@ -5,3 +5,6 @@ require 'foxycart_helpers/configuration'
 require 'foxycart_helpers/listeners'
 require 'foxycart_helpers/middleware'
 require 'foxycart_helpers/railtie' if defined?(Rails::Railtie)
+require 'foxycart_helpers/product_verification'
+require 'foxycart_helpers/link'
+require 'foxycart_helpers/javascript'

data/lib/foxycart_helpers/configuration.rb

@@ -16,17 +16,22 @@ module FoxycartHelpers
     attr_accessor *[
       :logger,
       :api_key,
+      :url,
       :mount_point,
+      :auto_encode_hrefs,
       :raise_exceptions,
     ]
 
+    alias_method :auto_encode_hrefs?, :auto_encode_hrefs
     alias_method :raise_exceptions?, :raise_exceptions
 
     def initialize
-      @mount_point      = '/foxycart_processor'
-      @logger           = Logger.new STDOUT
-      @api_key          = ENV.fetch 'FOXYCART_API_KEY'
-      @raise_exceptions = true unless ENV['RACK_ENV'] == 'production'
+      @mount_point       = '/foxycart_processor'
+      @logger            = Logger.new STDOUT
+      @api_key           = ENV['FOXYCART_API_KEY']
+      @url               = ENV['FOXYCART_URL']
+      @auto_encode_hrefs = true
+      @raise_exceptions  = true unless ENV['RACK_ENV'] == 'production'
     end
 
   end

data/lib/foxycart_helpers/datafeed.rb

@@ -7,10 +7,10 @@ module FoxycartHelpers
   class Datafeed
 
     def self.from_params(params)
-      decoded = URI.unescape params
+      decoded = CGI::unescape params
 
       trimmed = decoded.gsub(/FoxyData=/, '')
-      encrypted = URI.unescape trimmed
+      encrypted = CGI::unescape trimmed
 
       rc4 = RC4.new FoxycartHelpers.configuration.api_key
       decrypted = rc4.decrypt encrypted

data/lib/foxycart_helpers/javascript.rb

@@ -0,0 +1,32 @@
+require 'foxycart_helpers/configuration'
+
+module FoxycartHelpers
+  class Javascript
+
+    def self.url(*args)
+      new(*args).url
+    end
+
+    def self.html_element(*args)
+      new(*args).html_element
+    end
+
+    def url
+      "https://cdn.foxycart.com/#{subdomain}/loader.js"
+    end
+
+    def html_element
+      "<script src=\"#{url}\" async defer></script>"
+    end
+
+    def subdomain
+      url = URI.parse config.url
+      url.host.split('.').first
+    end
+
+    def config
+      FoxycartHelpers.configuration
+    end
+
+  end
+end

data/lib/foxycart_helpers/link.rb

@@ -0,0 +1,52 @@
+require 'uri'
+
+require 'foxycart_helpers/configuration'
+
+module FoxycartHelpers
+  class Link
+
+    def self.href(*args)
+      new(*args).href
+    end
+
+    def href
+      url = URI::parse config.url
+      url.path = '/cart'
+      url.query = query_string
+
+      url.to_s
+    end
+
+    def query_string
+      params = config.auto_encode_hrefs? ? encoded_query_hash : query_hash
+      string = URI.encode_www_form(params)
+
+      return string unless config.auto_encode_hrefs?
+      CGI.unescape string
+    end
+
+    def query_hash
+      Hash.new.tap do |h|
+        h[:name] = @name
+        h[:price] = @price
+        h[:code] = @code if @code
+      end.merge(@opts)
+    end
+
+    def encoded_query_hash
+      query_hash.map {|k,v| [k, FoxycartHelpers::ProductVerification.encoded_name(@code, k.to_s, v)]}.to_h
+    end
+
+    def initialize(name, price, code=nil, opts={})
+      @name  = name
+      @price = price
+      @code  = code
+      @opts  = opts
+    end
+
+    def config
+      FoxycartHelpers.configuration
+    end
+
+  end
+end

data/lib/foxycart_helpers/middleware.rb

@@ -10,7 +10,7 @@ module FoxycartHelpers
     end
 
     def config
-      Foxycart.configuration
+      FoxycartHelpers.configuration
     end
 
     def call(env)

data/lib/foxycart_helpers/product_verification.rb

@@ -0,0 +1,40 @@
+require 'foxycart_helpers/configuration'
+
+module FoxycartHelpers
+  class ProductVerification
+
+    def self.encode(*args)
+      new(*args).encode
+    end
+
+    def self.encoded_name(*args)
+      new(*args).encoded_name
+    end
+
+    def encode
+      digest = OpenSSL::Digest.new 'sha256'
+      key = config.api_key
+      data = @code + @name + @value
+
+      OpenSSL::HMAC.hexdigest digest, key, data
+    end
+
+    def encoded_name
+      @value + '||' + encode
+    end
+
+    def config
+      FoxycartHelpers.configuration
+    end
+
+    def initialize(code, name, value)
+      @code = code
+      @name = name
+      @value = value
+    end
+
+    # encoded_value is an alias for encoded_name
+    singleton_class.send :alias_method, :encoded_value, :encoded_name
+
+  end
+end

data/lib/foxycart_helpers/rails_view_helpers.rb

@@ -0,0 +1,31 @@
+require 'foxycart_helpers/product_verification'
+require 'foxycart_helpers/link'
+require 'foxycart_helpers/javascript'
+
+module FoxycartHelpers
+  module RailsViewHelpers
+
+    def foxycart_encode(code, name, value)
+      FoxycartHelpers::ProductVerification.encode code, name, value
+    end
+
+    def foxycart_encoded_name(code, name, value)
+      FoxycartHelpers::ProductVerification.encoded_name code, name, value
+    end
+
+    def foxycart_url_for(name, price, code=nil, opts={})
+      FoxycartHelpers::Link.href name, price, code, opts
+    end
+
+    def foxycart_loader_js_url
+      FoxycartHelpers::Javascript.url
+    end
+
+    def foxycart_loader_js
+      FoxycartHelpers::Javascript.html_element
+    end
+
+    alias_method :foxycart_encoded_value, :foxycart_encoded_name
+
+  end
+end

data/lib/foxycart_helpers/railtie.rb

@@ -1,4 +1,5 @@
 require 'foxycart_helpers/middleware'
+require 'foxycart_helpers/rails_view_helpers'
 
 module FoxycartHelpers
   class Railtie < Rails::Railtie
@@ -7,5 +8,11 @@ module FoxycartHelpers
       app.config.middleware.use 'FoxycartHelpers::Middleware'
     end
 
+    initializer 'foxycart_helpers.configure_view_controller' do |app|
+      ActiveSupport.on_load :action_view do
+        include FoxycartHelpers::RailsViewHelpers
+      end
+    end
+
   end
 end

data/lib/foxycart_helpers/version.rb

@@ -1,3 +1,3 @@
 module FoxycartHelpers
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: foxycart_helpers
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Robert Coleman
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-12 00:00:00.000000000 Z
+date: 2015-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby-rc4
@@ -115,7 +115,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".env"
 - ".env.example"
 - ".gitignore"
 - ".rspec"
@@ -130,8 +129,12 @@ files:
 - lib/foxycart_helpers.rb
 - lib/foxycart_helpers/configuration.rb
 - lib/foxycart_helpers/datafeed.rb
+- lib/foxycart_helpers/javascript.rb
+- lib/foxycart_helpers/link.rb
 - lib/foxycart_helpers/listeners.rb
 - lib/foxycart_helpers/middleware.rb
+- lib/foxycart_helpers/product_verification.rb
+- lib/foxycart_helpers/rails_view_helpers.rb
 - lib/foxycart_helpers/railtie.rb
 - lib/foxycart_helpers/version.rb
 homepage: https://github.com/rjocoleman/foxycart_helpers

data/.env

@@ -1 +0,0 @@
-FOXYCART_API_KEY='keyphrase'