middleman-foxycart 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 092361e5e4d5be93e2d186fd9b3c0aa6b71bc424
+  data.tar.gz: 32848fd8874a566f35771caa2ca368dafd5cb925
+SHA512:
+  metadata.gz: 89003066c6cd0d63c526e59d6e288a766843d9944fdad819d7d744cf1129968eb086bbc5d5421a996f97bcb35e90f6c26f2f4c9b6db1a8dbb456b3ad7a1e13b6
+  data.tar.gz: 17ee7518c968b5528ab4064b7059623a066b8234f1f2acf279f48987be0d37bfcd3ccc7cb86f678798d3a989b8d9469e4c261121a3d7e81908ffecf76af9e8f8

data/.gitignore

@@ -0,0 +1,7 @@
+# Ignore bundler lock file
+/Gemfile.lock
+
+# Ignore pkg folder
+/pkg
+
+.env

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in middleman-foxycart.gemspec
+gemspec
+
+group :development do
+  gem 'rake'
+  gem 'rdoc'
+  gem 'yard'
+end
+
+group :test do
+  gem 'cucumber'
+  gem 'aruba'
+  gem 'rspec'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Robert Coleman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# middleman-foxycart
+
+A [Middleman](https://middlemanapp.com) extension for use with [FoxyCart](http://www.foxycart.com/).
+
+__Features__
+
+* 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.
+
+
+## Setup and Configuration
+
+In `config.rb`
+
+```ruby
+activate :foxycart do |foxycart|
+  foxycart.api_key = 'your foxycart api key' # also as `ENV['FOXYCART_API_KEY']`
+  foxycart.url = 'https://mystoreurl.foxycart.com' # also as `ENV['FOXYCART_URL']`
+  foxycart.auto_encode_hrefs = true # (default) Use HMAC Product Verification when generating links
+end
+```
+
+## Helper and Usage
+
+Examples for ERB templates:
+
+```ruby
+# JS helper, e.g. use in layout.erb
+<%= foxycart_loader_js %>
+# => "<script src=\"https://cdn.foxycart.com/example/loader.js\" async defer></script>"
+
+# URL Helper
+<%= 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>"
+
+# Product Verification link payloads
+<%= foxycart_encode 'sku123', 'name', 'Cool Example' %>
+# => "54a534ba0afef1b4589c2f77f9011e27089c0030a8876ec8f06fca281fedeb89"
+<%= foxycart_encoded_name 'sku123', 'name', 'Cool Example' %>
+# => "name||54a534ba0afef1b4589c2f77f9011e27089c0030a8876ec8f06fca281fedeb89"
+```
+
+`foxycart_url_for` and the Product Verification helpers arguments are:
+
+* `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`.
+
+
+## Contributing
+
+Under the hood uses the gem [`foxycart_helpers`](https://github.com/rjocoleman/foxycart_helpers) (Foxycart helpers for plain Ruby and Rails)- this is just a thin wrapper for Middleman.
+
+Bug reports and pull requests are welcome on GitHub on this repo if approparte or at https://github.com/rjocoleman/foxycart_helpers.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = '--color --tags ~@wip --strict'
+end
+
+require 'rake/clean'
+
+task test: ['cucumber']
+
+task default: :test

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require 'middleman-core'
+require 'middleman-core/step_definitions'
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-foxycart')

data/lib/middleman-foxycart.rb

@@ -0,0 +1,43 @@
+require 'middleman-core'
+
+class Foxycart < ::Middleman::Extension
+  option :api_key,  ENV['FOXYCART_API_KEY'], 'FoxyCart API key'
+  option :url, ENV['FOXYCART_URL'], 'FoxyCart domain'
+  option :auto_encode_hrefs, true, 'Automatically encode HREFs with product validation hashes?'
+
+  def initialize(app, options_hash={}, &block)
+    super
+
+    require 'foxycart_helpers'
+
+    FoxycartHelpers.configure do |config|
+      config.api_key =  options.api_key
+      config.url = options.url
+      config.auto_encode_hrefs = options.auto_encode_hrefs
+    end
+  end
+
+  helpers do
+    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
+  end
+end
+
+Foxycart.register(:foxycart)

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-foxycart'

data/middleman-foxycart.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'middleman-foxycart'
+  s.version     = '0.1.0'
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Robert Coleman']
+  s.email       = ['github@robert.net.nz']
+  s.homepage    = 'https://github.com/rjocoleman/middleman-foxycart'
+  s.summary     = %q{FoxyCart helpers for Middleman static sites}
+  s.description = %q{FoxyCart helpers for Middleman static sites}
+  s.license     = 'MIT'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency 'middleman-core', '>= 3.4.0'
+
+  s.add_runtime_dependency 'foxycart_helpers', '~> 1.0'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: middleman-foxycart
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Coleman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+- !ruby/object:Gem::Dependency
+  name: foxycart_helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: FoxyCart helpers for Middleman static sites
+email:
+- github@robert.net.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- features/support/env.rb
+- lib/middleman-foxycart.rb
+- lib/middleman_extension.rb
+- middleman-foxycart.gemspec
+homepage: https://github.com/rjocoleman/middleman-foxycart
+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.5.1
+signing_key: 
+specification_version: 4
+summary: FoxyCart helpers for Middleman static sites
+test_files:
+- features/support/env.rb
+has_rdoc: