fake_pin 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b26c0fbfa19cf74b4521c19774b1e844ec5623b7
+  data.tar.gz: 65ffac6cf6f96872dd30930e5f8f0681a69ff7cc
+SHA512:
+  metadata.gz: ea5167e1da065cc289fc2160b78427ca65c7ed9779cf0f3242c1efdcd1d0c4fe9ea07d472393c1c4805e8fe14090e8ff3160d072602ed4ed2e30fdefc12343c3
+  data.tar.gz: ee02b374c8fb12317fc002a2c28a0d478d92e727811faad003bcb012fe0f1e741301d373b234477e0ebc3887053e09488a8d88a65152db202d272c43b0d9ab18

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--profile
+-Ilib

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Keith Pitt
+
+MIT License
+
+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,59 @@
+# FakePin
+
+A basic implmentation of the Pin Payments REST API. This is great for when you want to test your API client or want an offline version of the API for automated testing.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fake_pin'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install fake_pin
+```
+
+## Usage
+
+In your Rails Routes folder:
+
+```ruby
+YourApp::Application.routes.draw do
+  # ...
+
+  if Rails.env.development? || Rails.env.test?
+    constraints :host => /pin.your-app.dev/ do
+      mount FakePin::Rack.new => '/'
+    end
+  end
+end
+```
+
+Or you can run it as a standlone server. Currently it only support WEBrick and runs on port 9000.
+
+```bash
+$ fake_pin
+```
+
+You should then be able to cURL charges like so:
+
+```bash
+curl localhost:9000/1/charges -u your-secret-api-key: -d "amount=400" -d "currency=AUD" -d "description=test charge" -d "email=roland@pin.net.au" -d "ip_address=203.192.1.172" -d "card[number]=5520000000000000" -d "card[expiry_month]=05" -d "card[expiry_year]=2014" -d "card[cvc]=123" -d "card[name]=Roland Robot" -d "card[address_line1]=42 Sevenoaks St" -d "card[address_line2]=" -d "card[address_city]=Lathlain" -d "card[address_postcode]=6454" -d "card[address_state]=WA" -d "card[address_country]=Australia"
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/fake_pin

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+# Set the process name before we go to far in
+$PROGRAM_NAME = 'fake_pin'
+
+# Add the fake_pin lib directory to the load path
+root_dir = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+lib_dir  = File.join(root_dir, 'lib')
+$LOAD_PATH.unshift(lib_dir) unless $LOAD_PATH.include?(lib_dir)
+
+require 'fake_pin'
+require 'rack'
+
+Rack::Handler::WEBrick.run(
+  FakePin::Rack.new, :Port => 9000
+)

data/fake_pin.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fake_pin/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "fake_pin"
+  spec.version       = FakePin::VERSION
+  spec.authors       = ["Keith Pitt"]
+  spec.email         = ["me@keithpitt.com"]
+  spec.description   = %q{A rack-mountable version of the Pin Payments API}
+  spec.summary       = %q{A rack-mountable version of the Pin Payments API}
+  spec.homepage      = "https://github.com/keithpitt/fake_pin"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rack'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/fake_pin/card.rb

@@ -0,0 +1,64 @@
+module FakePin
+  class Card
+    class UnrecognisedCardSchemeError < RuntimeError; end
+
+    REQUIRED_PARAMS = :number, :expiry_month, :expiry_year, :name, :address_line1,
+                      :address_city, :address_postcode, :address_state, :address_country
+
+    SCHEMES = {
+      'visa'               => /^4\d{12}(\d{3})?$/,
+      'master'             => /^(5[1-5]\d{4}|677189)\d{10}$/,
+      'discover'           => /^(6011|65\d{2}|64[4-9]\d)\d{12}|(62\d{14})$/,
+      'american_express'   => /^3[47]\d{13}$/,
+      'diners_club'        => /^3(0[0-5]|[68]\d)\d{11}$/,
+      'jcb'                => /^35(28|29|[3-8]\d)\d{12}$/,
+      'switch'             => /^6759\d{12}(\d{2,3})?$/,
+      'solo'               => /^6767\d{12}(\d{2,3})?$/,
+      'dankort'            => /^5019\d{12}$/,
+      'maestro'            => /^(5[06-8]|6\d)\d{10,17}$/,
+      'forbrugsforeningen' => /^600722\d{10}$/,
+      'laser'              => /^(6304|6706|6709|6771(?!89))\d{8}(\d{4}|\d{6,7})?$/
+    }
+
+    def self.create(params)
+      new(params).create
+    end
+
+    def initialize(params)
+      @params = params
+    end
+
+    def create
+      @params.require(*REQUIRED_PARAMS)
+
+      number = @params['number'].to_s.gsub(/[^0-9]+/, '')
+
+      {
+        "token"            => Token.generate('card'),
+        "display_number"   => obfuscate_card_number(number),
+        "expiry_month"     => @params['expiry_month'],
+        "expiry_year"      => @params['expiry_year'],
+        "name"             => @params['name'],
+        "address_line1"    => @params['address_line1'],
+        "address_line2"    => @params['address_line2'],
+        "address_city"     => @params['address_city'],
+        "address_postcode" => @params['address_postcode'],
+        "address_state"    => @params['address_state'],
+        "address_country"  => @params['address_country'],
+        "scheme"           => card_scheme(number)
+      }
+    end
+
+    private
+
+    def card_scheme(number)
+      SCHEMES.each_pair { |scheme, regex| return scheme if number =~ regex }
+
+      raise UnrecognisedCardSchemeError
+    end
+
+    def obfuscate_card_number(card_number)
+      "XXXX-XXXX-XXXX-#{card_number[-4..-1]}"
+    end
+  end
+end

data/lib/fake_pin/charge.rb

@@ -0,0 +1,30 @@
+module FakePin
+  class Charge
+    def self.create(params)
+      new(params).create
+    end
+
+    def initialize(params)
+      @params = params
+    end
+
+    def create
+      @params.require(:amount, :description)
+      currency = @params["currency"] || "AUD"
+
+      { "token"                 => Token.generate('ch'),
+        "success"               => true,
+        "amount"                => @params['amount'],
+        "description"           => @params['description'],
+        "currency"              => currency,
+        "ip_address"            => "203.192.1.172",
+        "email"                 => @params['email'],
+        "status_message"        => "Success!",
+        "error_message"         => nil,
+        "captured"              => true,
+        "authorisation_expired" => false,
+        "transfer"              => nil,
+        "created_at"            => Time.now.to_s }
+    end
+  end
+end

data/lib/fake_pin/customer.rb

@@ -0,0 +1,24 @@
+module FakePin
+  class Customer
+    def self.create(params)
+      new(params).create
+    end
+
+    def initialize(params)
+      @params = params
+    end
+
+    def create
+      card = @params['card']
+      @params.require(:email, :card => Card::REQUIRED_PARAMS) if card.present?
+
+      response =  { "token"      => Token.generate('cus'),
+                    "email"      => @params['email'],
+                    "created_at" => Time.now.to_s }
+
+      response['card'] = Card.create(card) if card.present?
+
+      response
+    end
+  end
+end

data/lib/fake_pin/params.rb

@@ -0,0 +1,47 @@
+module FakePin
+  class Params
+    class MissingParametersError < RuntimeError
+      attr_reader :parameters
+
+      def initialize(parameters, message = nil)
+        @parameters = parameters
+        super(message)
+      end
+    end
+
+    def initialize(params)
+      @params = params
+    end
+
+    def [](key)
+      value = @params[key]
+      if value.kind_of?(Hash)
+        self.class.new(value)
+      else
+        value
+      end
+    end
+
+    def require(*params)
+      missing_params = []
+      params.each do |param|
+        if param.kind_of?(Hash)
+          parent_key = param.keys.first
+          param[parent_key].each do |child_key|
+            if @params[parent_key.to_s][child_key.to_s].nil?
+              missing_params << child_key
+            end
+          end
+        else
+          if @params[param.to_s].nil?
+            missing_params << param
+          end
+        end
+      end
+
+      if missing_params.length > 0
+        raise MissingParametersError.new(missing_params)
+      end
+    end
+  end
+end

data/lib/fake_pin/rack.rb

@@ -0,0 +1,85 @@
+require 'json'
+require 'rack'
+
+module FakePin
+  class Rack
+    def call(env)
+      request = ::Rack::Request.new(env)
+      method  = env['REQUEST_METHOD']
+      path    = env['PATH_INFO']
+
+      # Strip the first slash if there is one. When mounted in Rails, there is no slash.
+      # When running as a standlone rack app, there is one.
+      path = path.gsub(/\A\//, '')
+
+      params  = if env['CONTENT_TYPE'] == "application/json"
+                  Params.new(JSON.parse(request.body.read))
+                else
+                  Params.new(request.params)
+                end
+
+      if path == "1/customers"
+        if method == "POST"
+          return render_response(201, Customer.create(params))
+        end
+      elsif path == "1/charges"
+        if method == "POST"
+          return render_response(201, Charge.create(params))
+        end
+      elsif path =~ /1\/cards(\.json)?/
+        is_jsonp = (method == "GET" && params['_method'] == "POST")
+
+        if method == "POST" || is_jsonp
+          return render_response(201, Card.create(params), :callback => is_jsonp ? params['callback'] : nil)
+        end
+      end
+
+      render_404
+    rescue Params::MissingParametersError => e
+      messages = e.parameters.map do |param|
+        { :code => "#{param}_invalid", :message => "#{param} is required", :param => param }
+      end
+
+      render_error 422, 'invalid_resource', 'One or more parameters were missing or invalid.', messages
+    rescue => e
+      render_error 500, 'fake_pin_exception', "FakePin broke with: #{e.class.name}:#{e.message}"
+    end
+
+    private
+
+    def render_404
+      render_error(404, "invalid_resource", "The resource you requested could not be found")
+    end
+
+    def render_response(status, response, options = {})
+      if options[:callback]
+        render_jsonp(status, { :response => response }, options[:callback])
+      else
+        render_json(status, :response => response)
+      end
+    end
+
+    def render_error(status, error, description, messages = nil)
+      response = { :error => error, :error_description => description }
+      response[:messages] = messages unless messages.nil?
+
+      render_json(status, response)
+    end
+
+    def render_jsonp(status, json, callback)
+      [
+        status,
+        {"Content-Type" => 'text/javascript'},
+        ["#{callback}(#{JSON.dump(json)})"]
+      ]
+    end
+
+    def render_json(status, json)
+      [
+        status,
+        {"Content-Type" => 'text/json'},
+        [JSON.dump(json)]
+      ]
+    end
+  end
+end

data/lib/fake_pin/token.rb

@@ -0,0 +1,15 @@
+module FakePin
+  class Token
+    def self.generate(prefix)
+      new(prefix).generate
+    end
+
+    def initialize(prefix)
+      @prefix = prefix
+    end
+
+    def generate
+      "#{@prefix}_#{Time.now.to_f.to_s.gsub(/\./, '')}"
+    end
+  end
+end

data/lib/fake_pin/version.rb

@@ -0,0 +1,3 @@
+module FakePin
+  VERSION = "0.0.1"
+end

data/lib/fake_pin.rb

@@ -0,0 +1,9 @@
+module FakePin
+  autoload :Card,     "fake_pin/card"
+  autoload :Charge,   "fake_pin/charge"
+  autoload :Customer, "fake_pin/customer"
+  autoload :Params,   "fake_pin/params"
+  autoload :Rack,     "fake_pin/rack"
+  autoload :Token,    "fake_pin/token"
+  autoload :VERSION,  "fake_pin/version"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'bundler/setup'
+require 'fake_pin'
+
+Dir[SPEC_PATH.join("support/**/*.rb")].each { |f| require f }
+
+RSpec.configure do |config|
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = "random"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: fake_pin
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Keith Pitt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: 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'
+description: A rack-mountable version of the Pin Payments API
+email:
+- me@keithpitt.com
+executables:
+- fake_pin
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/fake_pin
+- fake_pin.gemspec
+- lib/fake_pin.rb
+- lib/fake_pin/card.rb
+- lib/fake_pin/charge.rb
+- lib/fake_pin/customer.rb
+- lib/fake_pin/params.rb
+- lib/fake_pin/rack.rb
+- lib/fake_pin/token.rb
+- lib/fake_pin/version.rb
+- spec/spec_helper.rb
+homepage: https://github.com/keithpitt/fake_pin
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A rack-mountable version of the Pin Payments API
+test_files:
+- spec/spec_helper.rb