sagepay_protocol3 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f30c0dcebb7611d5a7409640ac070c1df0b75a68
+  data.tar.gz: c2dee42a6c0d0de1200bf9d3a22cc07048f32065
+SHA512:
+  metadata.gz: eaf224c217d849fff84e62750c34cad9d6d3d4e64cb47704263d56c6cf4495c05d47f0c4ba1fc965dccd624cc39a3ff15d2b3439e94fef8580cd9c4afb9cd33b
+  data.tar.gz: 07123d3bfd3ebeda25c496f16323ef18d0f7375be2f4b9823cff825b6e5ec7fae80726b1d349edb55ee9df41c0c7ce72fe801b46629d754fc28d57db9f348e93

data/.gitignore

@@ -0,0 +1,33 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# Vim
+*.swp
+*.swo
+
+# Backup
+*~
+
+# Mac
+.DS_Store
+
+# RVM
+.rvmrc
+
+# CTAGS
+tags

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+script: "bundle exec rspec"
+before_install:
+  - gem install bundler -v '>= 1.3'
+rvm:
+  - 1.9.3
+  - 1.9.3-p448
+  - 2.0.0
+  - 2.1.3
+gemfile:
+  - Gemfile
+notifications:
+  email: false
+

data/.yardopts

@@ -0,0 +1,2 @@
+--markup-provider=redcarpet
+--markup=markdown

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => "--color --format documentation --fail-fast", :all_on_start => false, :all_after_pass => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/MIT-LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michael de Silva
+
+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,39 @@
+# SagepayProtocol3
+
+[![Build Status](https://travis-ci.org/bsodmike/sagepay_protocol3.png?branch=master)](https://travis-ci.org/bsodmike/sagepay_protocol3)
+
+Encryption in Ruby to interface with SagePay's payment gateway protocol v3.
+
+## Compatibility
+
+* Supports multiple Ruby versions: Ruby 1.9.3, 2.0.0, 2.1.3 (see
+Travis build status).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sagepay_protocol3'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sagepay_protocol3
+
+## API Summary
+
+
+## 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
+
+## License
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

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

data/lib/sagepay_protocol3/encryption.rb

@@ -0,0 +1,40 @@
+require 'openssl'
+
+module SagepayProtocol3
+
+  module Encryption
+    extend self
+
+    def cipher(operation, cipher, cipher_key)
+      lambda do |data, padding|
+        c = OpenSSL::Cipher.new(cipher)
+        c.send(operation)
+        c.padding = padding
+        c.key = cipher_key
+        c.iv = cipher_key
+        c.update(data) + c.final
+      end
+    end
+
+    def decrypt(cipher_key, data, cipher = "AES-128-CBC")
+      hex = data.gsub(/\A(@)/, '')
+      input = [hex].pack('H*')
+      output = cipher(:decrypt, cipher, cipher_key)[input, 0]
+      sanitize_payload output
+    end
+
+    def encrypt(cipher_key, data, cipher = "AES-128-CBC")
+      _encrypted = cipher(:encrypt, cipher, cipher_key)[data, 1]
+      "@#{_encrypted.unpack('H*').first.upcase}"
+    end
+
+    def sanitize_payload(string)
+      string.gsub(/\005/, '').gsub("\r", '').gsub("\n", '')
+    end
+
+    def to_h(crypt_string)
+      Hash[*crypt_string.split(/[=&]/)]
+    end
+  end
+
+end

data/lib/sagepay_protocol3/version.rb

@@ -0,0 +1,3 @@
+module SagepayProtocol3
+  VERSION = "0.1.0"
+end

data/lib/sagepay_protocol3.rb

@@ -0,0 +1,5 @@
+require "sagepay_protocol3/version"
+
+module SagepayProtocol3
+  # Your code goes here...
+end

data/sagepay_protocol3.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sagepay_protocol3/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sagepay_protocol3"
+  spec.version       = SagepayProtocol3::VERSION
+  spec.authors       = ["Michael de Silva"]
+  spec.email         = ["michael@mwdesilva.com"]
+  spec.homepage      = "http://mwdesilva.com"
+  spec.summary       = "Encryption in Ruby to interface with SagePay's payment gateway protocol v3."
+  spec.description   = spec.summary
+  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.required_ruby_version = '>= 1.8.7'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "mocha"
+  #spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "yard"
+  spec.add_development_dependency "redcarpet"
+end

data/spec/plugin/encryption_spec.rb

@@ -0,0 +1,88 @@
+# encoding: utf-8
+require 'spec_helper'
+require 'sagepay_protocol3/encryption'
+
+module SagepayProtocol3
+
+  describe Encryption do
+    module TestRunner
+      extend self
+
+      def cipher_text
+        "@2DCD27338114D4C39A14A855702FBAB2EF40BCAC2D76A3ABC0F660A07E9C1C921C2C755BA9B59C39F882FBF6DFED114F23141D94E50A01A665B1E31A86C07CA1CD1BB8EF5B6CF2C23D495CD79F9C0F678D61773E7A1AA30AA5B23D56503FC0B52AC0694A8C341263D2C5FE1BAD93BDB94726761E155E900448F644AF1F67BE1AC77E852B9D90809A44F258EE9478B6D8C1C4ED58759263E7DBF8871C6592287C0358F36F4EEC326CEDDD440DA2FED8AB35F1B630A5C6FA671E4D78CC8CACECF9DFDC31D6C5EC8270FB21E297E2C2E14F99A04223EFFD4F00062D440E78A3D2C7140EC8F123D247B75E7482AE98858DA34D37EDE6D7C69AA74391F559305CF675ADB3615244A107ABBB6AF26E29A2FFA059B12688D90FE09E0DE069325BFF3587A695F5DA36E4B809B69CC9A37034F166B63B5A62B986F4DA34E9AC9516AFDE70642EC7DAD1AEBA93A1F347D6AC7046E967DCBFE7ACFCEE5DAFC0B29F1765032B3060EBE565CBD57D092075D15CF12725199C6881605B2E0F105698CE3ADD04361CA9D620C187B90E3F9849445B5C3C0FDF1768BFFD61F97E51316826F4F10E0E3E668F0A9F5ED9CCDA6F2C7CC957F12DB48F9041482E3D035E7A91852C404BFA325FED947E71F57B871DFAC6AF4FF29F4513A4A80B2D7ECC9D19D47ED04FA99CDFC881DFA771E1EA4F3F9B2C5AC673EF3DA2699A309CC8522993A63CB8D45D3CDF09B1DFDC573CD19679B250AD6721450B5042F201670B464505DCAEF59E2C67ABACC9AE2EEE793CE191FEBF66B8FAF4204EFFB359246B9C99FB52805C46375FF35140F74707FBC73C7731A28A2C883A"
+      end
+
+      def crypt_string
+        "VendorTxCode=TxCode-1310917599-223087284&Amount=36.95&Currency=GBP&Description=description&CustomerName=Fname Surname&CustomerEMail=customer@example.com&BillingSurname=Surname&BillingFirstnames=Fname&BillingAddress1=BillAddress Line 1&BillingCity=BillCity&BillingPostCode=W1A 1BL&BillingCountry=GB&BillingPhone=447933000000&DeliveryFirstnames=Fname&DeliverySurname=Surname&DeliveryAddress1=BillAddress Line 1&DeliveryCity=BillCity&DeliveryPostCode=W1A 1BL&DeliveryCountry=GB&DeliveryPhone=447933000000&SuccessURL=https://example.com/success&FailureURL=https://example.com/failure"
+
+      end
+    end
+
+    it "should be a Module" do
+      expect(described_class).to be_a(Module)
+    end
+
+    context "when provided a known cipher text and encryption key" do
+      describe "#decrypt" do
+        it "should decrypt the cipher text yielding the crypt string" do
+          cipher_text = TestRunner.cipher_text
+          encryption_key = "55a51621a6648525"
+
+          result = SagepayProtocol3::Encryption.decrypt(encryption_key, cipher_text)
+
+          expect(result).to eq(TestRunner.crypt_string)
+        end
+      end
+
+      describe "#encrypt" do
+        it "should encrypt the crypt string yielding the cipher text" do
+          crypt_string = TestRunner.crypt_string
+          encryption_key = "55a51621a6648525"
+
+          result = SagepayProtocol3::Encryption.encrypt(encryption_key, crypt_string)
+
+          expect(result).to eq(TestRunner.cipher_text)
+        end
+      end
+
+      describe "#to_h" do
+        it "should return the crypt_string data as a Hash" do
+          cipher_text = TestRunner.cipher_text
+          encryption_key = "55a51621a6648525"
+
+          result = SagepayProtocol3::Encryption.decrypt(encryption_key, cipher_text)
+
+          expect(result).to eq(TestRunner.crypt_string)
+          expect(SagepayProtocol3::Encryption.to_h(result)).to eq(
+            {
+              "Amount" => "36.95",
+              "BillingAddress1" => "BillAddress Line 1",
+              "BillingCity" => "BillCity",
+              "BillingCountry" => "GB",
+              "BillingFirstnames" => "Fname",
+              "BillingPhone" => "447933000000",
+              "BillingPostCode" => "W1A 1BL",
+              "BillingSurname" => "Surname",
+              "Currency" => "GBP",
+              "CustomerEMail" => "customer@example.com",
+              "CustomerName" => "Fname Surname",
+              "DeliveryAddress1" => "BillAddress Line 1",
+              "DeliveryCity" => "BillCity",
+              "DeliveryCountry" => "GB",
+              "DeliveryFirstnames" => "Fname",
+              "DeliveryPhone" => "447933000000",
+              "DeliveryPostCode" => "W1A 1BL",
+              "DeliverySurname" => "Surname",
+              "Description" => "description",
+              "FailureURL" => "https://example.com/failure",
+              "SuccessURL" => "https://example.com/success",
+              "VendorTxCode" => "TxCode-1310917599-223087284"
+            }
+          )
+        end
+      end
+    end
+
+  end
+
+end

data/spec/plugin/sagepay_protocol3_spec.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe SagepayProtocol3 do
+
+  it "should be a Module" do
+    expect(described_class).to be_a(Module)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+require 'sagepay_protocol3'
+require 'mocha/api'
+require 'pry'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.mock_with :mocha
+
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # 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'
+
+  # Disable should syntax
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end
+

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: sagepay_protocol3
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Michael de Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-24 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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: mocha
+  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: yard
+  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: redcarpet
+  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: Encryption in Ruby to interface with SagePay's payment gateway protocol
+  v3.
+email:
+- michael@mwdesilva.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- .yardopts
+- Gemfile
+- Guardfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/sagepay_protocol3.rb
+- lib/sagepay_protocol3/encryption.rb
+- lib/sagepay_protocol3/version.rb
+- sagepay_protocol3.gemspec
+- spec/plugin/encryption_spec.rb
+- spec/plugin/sagepay_protocol3_spec.rb
+- spec/spec_helper.rb
+homepage: http://mwdesilva.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: Encryption in Ruby to interface with SagePay's payment gateway protocol v3.
+test_files:
+- spec/plugin/encryption_spec.rb
+- spec/plugin/sagepay_protocol3_spec.rb
+- spec/spec_helper.rb
+has_rdoc: