foxycart_helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5f5fd26d3b714a0c8da11768cce2851729179ca9
+  data.tar.gz: a91e981343f2cb65ccc354c69fb92a0eb2978899
+SHA512:
+  metadata.gz: 4293fbedae46cbfe935cc72f0f27a7f53fa347b40f6e232c0635c092a39780e670a877a118cf9195d59d60f2e1dcc293f037254282be879ae9beeb2180b462ff
+  data.tar.gz: 502e6cd100890745946a4356794d3fb78d700de7699897df63e110d5ec4c6d179c81f44f0e610f8f677348c2dd6b4a0ea7cb198bfc29170aeca649df6c826bea

data/.env

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

data/.env.example

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

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

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

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,66 @@
+# Foxycart Helpers
+
+Several helpers for working with FoxyCart:
+
+* Webhook endpoint for Datafeeds - https://wiki.foxycart.com/v/2.0/transaction_xml_datafeed
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'foxycart_helpers'
+```
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install foxycart_helpers`
+
+## Usage
+
+### Transactional Datafeed Webhook
+
+This helper creates a Rack endpoint to receive a POSTed XML data feed, it:
+
+* Automatically URL decodes the POST.
+* Decrypts with your API key `ENV['FOXYCART_API_KEY']`
+* Parses the XML and presents it as a hash.
+
+__Rack/Sinatra:__
+
+```ruby
+  # config.ru
+  require 'foxycart_helpers/middleware'
+  use Foxycart::Middleware
+```
+
+__Rails:__ This middleware is registered automatically.
+
+```ruby
+FoxycartHelpers.subscribe do |payload|
+  puts payload
+  # Do something with payload
+  # You probably want to fire a background task
+end
+```
+
+In Rails this could live at `config/initalizers/foxycart.rb`
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'foxycart_helpers'
+
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/foxycart_helpers.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'foxycart_helpers/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'foxycart_helpers'
+  spec.version       = FoxycartHelpers::VERSION
+  spec.authors       = ['Robert Coleman']
+  spec.email         = ['github@robert.net.nz']
+
+  spec.summary       = %q{Helpers for using FoxyCart in Ruby}
+  spec.description   = %q{Helpers for using FoxyCart in Ruby}
+  spec.homepage      = 'https://github.com/rjocoleman/foxycart_helpers'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'ruby-rc4'
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'nori'
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec'
+  spec.add_dependency 'pry'
+end

data/lib/foxycart_helpers.rb

@@ -0,0 +1,7 @@
+require 'logger'
+
+require 'foxycart_helpers/version'
+require 'foxycart_helpers/configuration'
+require 'foxycart_helpers/listeners'
+require 'foxycart_helpers/middleware'
+require 'foxycart_helpers/railtie' if defined?(Rails::Railtie)

data/lib/foxycart_helpers/configuration.rb

@@ -0,0 +1,33 @@
+module FoxycartHelpers
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor *[
+      :logger,
+      :api_key,
+      :mount_point,
+      :raise_exceptions,
+    ]
+
+    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'
+    end
+
+  end
+end

data/lib/foxycart_helpers/datafeed.rb

@@ -0,0 +1,25 @@
+require 'foxycart_helpers/configuration'
+
+require 'rc4'
+require 'nori'
+
+module FoxycartHelpers
+  class Datafeed
+
+    def self.from_params(params)
+      decoded = URI.unescape params
+
+      trimmed = decoded.gsub(/FoxyData=/, '')
+      encrypted = URI.unescape trimmed
+
+      rc4 = RC4.new FoxycartHelpers.configuration.api_key
+      decrypted = rc4.decrypt encrypted
+
+      parser = Nori.new
+      payload = parser.parse decrypted
+
+      payload['foxydata']
+    end
+
+  end
+end

data/lib/foxycart_helpers/listeners.rb

@@ -0,0 +1,12 @@
+module FoxycartHelpers
+  LISTENERS = Array.new
+
+  def self.subscribe(&block)
+    LISTENERS << block
+  end
+
+  def self.propagate(event)
+    LISTENERS.each {|block| block.call event}
+  end
+
+end

data/lib/foxycart_helpers/middleware.rb

@@ -0,0 +1,44 @@
+require 'foxycart_helpers/configuration'
+require 'foxycart_helpers/listeners'
+require 'foxycart_helpers/datafeed'
+
+module FoxycartHelpers
+  class Middleware
+
+    def initialize(app=nil)
+      @app = app
+    end
+
+    def config
+      Foxycart.configuration
+    end
+
+    def call(env)
+      req = Rack::Request.new(env)
+      return @app.call(env) unless req.path_info == config.mount_point
+      return response 405 unless req.post?
+
+      parse_and_respond req.body.read
+    end
+
+  private
+
+    def parse_and_respond(params)
+      datafeed = Datafeed.from_params params
+      FoxycartHelpers.propagate datafeed
+      response 200, 'foxy'
+    rescue => e
+      raise e if config.raise_exceptions?
+      response 500
+    end
+
+    def response(status, body='', headers={})
+      [
+        status,
+        {'Content-Type' => 'text/plain'}.merge(headers),
+        [body],
+      ]
+    end
+
+  end
+end

data/lib/foxycart_helpers/railtie.rb

@@ -0,0 +1,11 @@
+require 'foxycart_helpers/middleware'
+
+module FoxycartHelpers
+  class Railtie < Rails::Railtie
+
+    initializer 'foxycart_helpers.use_rack_middleware' do |app|
+      app.config.middleware.use 'FoxycartHelpers::Middleware'
+    end
+
+  end
+end

data/lib/foxycart_helpers/version.rb

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

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: foxycart_helpers
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Coleman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-rc4
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nori
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Helpers for using FoxyCart in Ruby
+email:
+- github@robert.net.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env"
+- ".env.example"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- foxycart_helpers.gemspec
+- lib/foxycart_helpers.rb
+- lib/foxycart_helpers/configuration.rb
+- lib/foxycart_helpers/datafeed.rb
+- lib/foxycart_helpers/listeners.rb
+- lib/foxycart_helpers/middleware.rb
+- lib/foxycart_helpers/railtie.rb
+- lib/foxycart_helpers/version.rb
+homepage: https://github.com/rjocoleman/foxycart_helpers
+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: Helpers for using FoxyCart in Ruby
+test_files: []