cybersourcery_testing 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d691ed4729b44202aae717e8b195a5f240601ec
+  data.tar.gz: 2a9653b278588a6c6a0bccfcf8cb973f2e4246bd
+SHA512:
+  metadata.gz: af13df4dad192f1e90633c7f3e78cc74a54b48a2b9d43030562a2f31fc5b0b3acae9bec7c26c0918b45981082e3ba7275cdef0bf74a69fea7a7346475e8c0410
+  data.tar.gz: 4126546a2cfdfbdd9c3d0aa24f93b1032c045fdafa8912e7f4cbb2ce97d0e10c43f17278d7a6f4b4ac8a87dc3a66dea0d461a51eb3a2092e832a9af4bfc5f644

data/.gitignore

@@ -0,0 +1,24 @@
+.idea
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 PromptWorks
+
+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,94 @@
+# Cybersourcery Testing
+
+The Cybersourcery Testing gem is designed for use with Rails projects, and supports feature/integration testing of the Cybersource Silent Order POST (SOP) service. It can be used with [the Cybersourcery gem](https://github.com/promptworks/cybersourcery) or as a stand-alone testing service. It uses a Sinatra proxy server and [VCR](https://github.com/vcr/vcr), to avoid the need for repeated requests to the Cybersource SOP test server.
+
+## Features
+
+Automated testing with Cybersource SOP is more difficult than typical 3rd party services. When a transaction is submitted, Cybersource dynamically generates a hidden form in the user's browser, which it then automatically submits to the Cybersource Profile's "Customer Response Page URL." This URL may not correspond to your local testing environment. The Cybersourcery Testing gem uses middleware to rewrite these responses, so they can be handled in your local testing environment. It also hooks into VCR for recording transactions, and handles known but undocumented Cybersource errors.
+
+It includes:
+
+* A proxy server to stand-in for the Cybersource SOP test server. It runs on Sinatra, and includes a middleware translating proxy which directs both requests to, and responses from, the Cybersource SOP test server to the Sinatra server.
+* Detection and alerts for undocumented Cybersource SOP error conditions, where Cybersource returns only a general server error message. The proxy server will detect these conditions and raise exceptions that include clear explanations.
+* A VCR implementation to record your test transactions, for re-use in future test runs. 
+* Support for defining your own VCR custom matchers, to detect variations in the data in test submissions. The gem comes with a check for changes in the credit card number. You can add checks for other fields as needed for your business requirements.
+
+When a test is run that shows a change against any of the defined matchers, the proxy server will forward the transaction to the actual Cybersource SOP test server, and VCR will record the transaction. Subsequent runs of the same test will rely on the VCR recording. This means you can do repeated feature/integration testing without requiring ongoing contact with the Cybersource SOP test server.
+
+## Installation
+
+1. Add it to your Gemfile and run bundle:
+
+  ```ruby
+  gem 'cybersourcery_testing'
+  ```
+  
+  ```console
+  bundle
+  ```
+
+2. Run the generator for creating a sample .env file, and update your .env file:
+
+  ```console
+  rails generate cybersourcery_testing:dotenv
+  ```
+  
+  This generates a file in your Rails root directory named `.env.cybersourcery_testing_sample`. If you do not have a `.env` file already, rename it to `.env`. If you do have a `.env` file, copy the contents of the sample file and paste them to the end of your .env file. You can then delete the sample file.
+  
+3. Update your .env settings as needed:
+
+  * CYBERSOURCERY_SOP_TEST_URL: the URL of the Cybersource Silent Order Post (SOP) test server. You should not need to change this.
+  * CYBERSOURCERY_SOP_PROXY_URL: the base URL the Sinatra proxy will use.
+  * CYBERSOURCERY_SOP_PROXY_RUNNER: `ruby` by default, which means it will start Sinatra. You can change this to `shotgun`, etc if you setup a different runner you prefer.
+  * CYBERSOURCERY_RESPONSE_PAGE_URL: this must match the "Customer Response Page" URL you have set in the Cybersource Business Center for the profile you will use when testing.
+  * CYBERSOURCERY_LOCAL_RESPONSE_PAGE_PATH: the path to the local equivalent of the "Customer Response Page" (should be in URI path format, e.g. `/confirm`)
+  * CYBERSOURCERY_USE_VCR_IN_TESTS: `true` or `false`. This should be `true` unless you have a special reason to change it. If you do not set this to `true` the Sinatra proxy will always forward all requests to the actual Cybersource SOP test server.
+  * CYBERSOURCERY_VCR_CASSETTE_DIR: the relative path to where your VCR cassette file should be stored.
+
+## Usage
+
+### Optional: Define matchers for VCR
+
+When you submit a transaction through the proxy server, it will forward the request to the Cybersource SOP test sever only if there is a change in a field that VCR has a matcher for. VCR checks its existing cassettes to see if the request has changes to any of the fields it has matchers for. So it's up to you to decide which fields are important for detecting and testing changes in.
+
+A matcher for detecting changes in the credit card number is included. If that's all you need, then you can skip the rest of this step.
+
+To set up your own matchers:
+
+1. Create a file to put your matchers in. Here is an example for detecting changes to the card type:
+ 
+  ```ruby
+  require 'sinatra'
+  require 'cybersourcery_testing/cybersource_proxy'
+ 
+  VCR.configure do |c|
+    c.register_request_matcher :card_type_equality do |request_1, request_2|
+      pattern = /\&card_type=(\d+)\&/i
+      CybersourceryTesting::Vcr.did_it_change?(pattern, request_1.body, request_2.body)
+    end
+  end
+  ```
+
+  The two `require` statements are important! Also, you can make as many `register_request_matcher` calls as you need.
+  
+2. Add the relative path to this file to your .env file, with the variable name `CYBERSOURCERY_SOP_PROXY_RB_PATH`. For example:
+
+  ```console
+  CYBERSOURCERY_SOP_PROXY_RB_PATH = 'spec/cybersource_proxy_custom.rb'
+  ```
+
+### Start the proxy server
+
+The gem comes with a rake task for starting the proxy server, which is exported for use in your Rails project:
+
+```console
+rake cybersourcery:proxy
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cybersourcery_testing/fork )
+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 a new Pull Request

data/Rakefile

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

data/cybersourcery_testing.gemspec

@@ -0,0 +1,30 @@
+$:.push File.expand_path('../lib', __FILE__)
+
+# Maintain your gem's version:
+require 'cybersourcery_testing/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cybersourcery_testing'
+  spec.version       = CybersourceryTesting::VERSION
+  spec.authors       = ['Michael Toppa']
+  spec.email         = ['public@toppa.com']
+  spec.summary       = %q{For developing feature tests with Cybersourcery}
+  spec.description   = %q{The Cybersourcery Testing gem is designed for use with Rails projects, and supports feature/integration testing of the Cybersource Silent Order POST (SOP) service. It can be used with the Cybersourcery gem or as a stand-alone testing service. It uses a Sinatra proxy server and VCR, to avoid the need for repeated requests to the Cybersource SOP test server.}
+  spec.homepage      = 'https://github.com/promptworks/cybersourcery_testing'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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-translating_proxy', '~> 0.1.1'
+  spec.add_dependency 'sinatra', '~> 1.4'
+  spec.add_dependency 'nokogiri', '~> 1.6'
+  spec.add_dependency 'webmock', '~> 1.19'
+  spec.add_dependency 'vcr', '~> 2.9'
+  spec.add_dependency 'rakeup', '~> 1.2'
+  spec.add_dependency 'dotenv', '~> 0.11'
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.3'
+end

data/lib/cybersourcery_testing.rb

@@ -0,0 +1,5 @@
+require "cybersourcery_testing/version"
+
+module CybersourceryTesting
+  require 'cybersourcery_testing/railtie' if defined?(Rails)
+end

data/lib/cybersourcery_testing/cybersource_proxy.rb

@@ -0,0 +1,17 @@
+require 'sinatra'
+require 'base64'
+require 'json'
+require 'vcr'
+require 'nokogiri'
+require 'webmock'
+require 'cybersourcery'
+require 'cybersourcery_testing/vcr'
+require 'cybersourcery_testing/translating_proxy'
+
+use CybersourceryTesting::TranslatingProxy
+
+CybersourceryTesting::Vcr.configure
+
+get('/') do
+  [200, {'Content-Type' => 'text/html'}, ["It's not a trick it's an illusion"]]
+end

data/lib/cybersourcery_testing/railtie.rb

@@ -0,0 +1,7 @@
+module CybersourceryTesting
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__),'/tasks/*.rake')].each { |f| load f }
+    end
+  end
+end

data/lib/cybersourcery_testing/tasks/cybersourcery_testing.rake

@@ -0,0 +1,21 @@
+namespace :cybersourcery do
+  require 'rubygems'
+  require 'bundler/setup'
+  require 'rakeup'
+
+  desc 'Start the Cybersource SOP proxy server'
+  task :proxy do
+    if ENV['CYBERSOURCERY_SOP_PROXY_RB_PATH'].present?
+      proxy_path = ENV['CYBERSOURCERY_SOP_PROXY_RB_PATH']
+    else
+      proxy_path = "#{File.expand_path File.dirname(__FILE__)}/../cybersource_proxy.rb"
+    end
+
+    RakeUp::ServerTask.new('cybersource_proxy') do |t|
+      proxy_uri = URI ENV['CYBERSOURCERY_SOP_PROXY_URL']
+      t.run_command = "#{ENV['CYBERSOURCERY_SOP_PROXY_RUNNER']} #{proxy_path} -p #{proxy_uri.port}"
+    end
+
+    Rake::Task['cybersource_proxy'].invoke
+  end
+end

data/lib/cybersourcery_testing/translating_proxy.rb

@@ -0,0 +1,97 @@
+require 'rack/translating_proxy'
+
+module CybersourceryTesting
+  class TranslatingProxy < Rack::TranslatingProxy
+    alias :super_call :call
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      if proxy?(env)
+        request = Rack::Request.new(env)
+        set_referrer(request)
+        check_for_cryptic_cybersource_errors(request)
+        maybe_use_vcr(env)
+      else
+        @app.call(env)
+      end
+    end
+
+    def proxy?(env)
+      # The browser keeps requesting favicon.ico, which throws errors when the request is forwarded
+      # to the Cybersource server. So ony forward POST requests.
+      env['REQUEST_METHOD'] == 'POST'
+    end
+
+    def set_referrer(request)
+      # We are making @referrer an instance variable for convenience. We need it since the port of
+      # the test server can change with every test run. Conceptually, http_referrer should be part
+      # of env, but env is not an instance variable. We would have to rewrite multiple method
+      # signatures and a bunch of calls in the parent translating_proxy.rb if we put the referrer in
+      # env (we need it in request_mapping(), which is at the end of a chain of calls).
+      @referrer = request.referrer ? URI(request.referrer) : nil
+    end
+
+    def check_for_cryptic_cybersource_errors(request)
+      request.params.each do |k,v|
+        if v.class != String
+          raise "You are attempting to pass a value that is not a String to Cybersource. This will cause Cybersource to throw a generic server error. You passed: #{k}: #{v.to_s}"
+        end
+
+        if k == 'signed_field_names' && v.length >= 700
+          raise "You are attempting to pass a signed_fields value to Cybersource that is 700 characters or greater. This will cause Cybersource to throw a generic server error. You passed: #{k}: #{v}"
+        end
+      end
+    end
+
+    def maybe_use_vcr(env)
+      if ENV['CYBERSOURCERY_USE_VCR_IN_TESTS']
+        VCR.use_cassette(
+          'cybersourcery',
+          record: :new_episodes,
+          match_requests_on: CybersourceryTesting::Vcr.match_requests_on
+        ) do
+          super_call(env)
+        end
+      else
+        super_call(env)
+      end
+    end
+
+    def target_host
+      ENV['CYBERSOURCERY_SOP_TEST_URL']
+    end
+
+    def request_mapping
+      mappings = {
+        # our proxy                           the actual Cybersource test server
+        #ENV['CYBERSOURCERY_SOP_PROXY_URL'] => ENV['CYBERSOURCERY_SOP_TEST_URL'],
+      }
+
+      if @referrer
+        local_response_url = "#{@referrer.scheme}://#{@referrer.host}:#{@referrer.port}#{ENV['CYBERSOURCERY_LOCAL_RESPONSE_PAGE_PATH']}"
+
+        #        local resp page       page where Cybersource redirects
+        mappings[local_response_url] = ENV['CYBERSOURCERY_RESPONSE_PAGE_URL']
+      end
+
+      mappings
+    end
+
+    # override parent
+    def rewrite_response_body(body)
+      # to_s on an array gives a version that has brackets, escape characters, etc. I don't know why
+      # it worked outside the middleware context (as I didn't have this problem with it before).
+      #str = rewrite_string(body.to_s, _response_mapping)
+      str = rewrite_string(body.first, _response_mapping)
+      rewrite_string(str, _response_mapping, URI.method(:encode_www_form_component))
+    end
+
+    # override parent - we need this refreshed with each request, since the test server port changes
+    def _response_mapping
+      request_mapping.invert
+    end
+  end
+end

data/lib/cybersourcery_testing/vcr.rb

@@ -0,0 +1,32 @@
+module CybersourceryTesting
+  class Vcr
+    def self.configure
+      VCR.configure do |c|
+        c.cassette_library_dir = ENV['CYBERSOURCERY_VCR_CASSETTE_DIR']
+        c.hook_into :webmock
+        c.allow_http_connections_when_no_cassette = true
+        c.register_request_matcher :card_number_equality do |request_1, request_2|
+          pattern = /\&card_number=(\d+)\&/i
+          self.did_it_change?(pattern, request_1.body, request_2.body)
+        end
+      end
+    end
+
+    def self.did_it_change?(pattern, body1, body2)
+      if body1 =~ pattern && body2 =~ pattern
+        one = pattern.match(body1).captures[0]
+        two = pattern.match(body2).captures[0]
+        one == two
+      else
+        body1 !~ pattern && body2 !~ pattern
+      end
+    end
+
+    def self.match_requests_on
+      exclude = %i(body headers host path query body_as_json)
+      # @registry is private, but we really need it: all your encapsulation are belong to us
+      all = VCR.request_matchers.instance_variable_get(:@registry).keys
+      all - exclude # :method, :uri, and any custom matchers
+    end
+  end
+end

data/lib/cybersourcery_testing/version.rb

@@ -0,0 +1,3 @@
+module CybersourceryTesting
+  VERSION = '0.0.2'
+end

data/lib/rails/generators/cybersourcery_testing/dotenv_generator.rb

@@ -0,0 +1,15 @@
+module CybersourceryTesting
+  module Generators
+    class DotenvGenerator < Rails::Generators::Base
+      desc 'Creates a sample .env file for the Cybersourcery Testing gem'
+
+      def self.source_root
+        @source_root ||= File.expand_path('../templates', __FILE__)
+      end
+
+      def create_dotenv_file
+        template 'dotenv', File.join('.env.cybersourcery_testing_sample')
+      end
+    end
+  end
+end

data/lib/rails/generators/cybersourcery_testing/templates/dotenv

@@ -0,0 +1,7 @@
+CYBERSOURCERY_SOP_TEST_URL = 'https://testsecureacceptance.cybersource.com'
+CYBERSOURCERY_SOP_PROXY_URL = 'http://localhost:5556'
+CYBERSOURCERY_SOP_PROXY_RUNNER = ruby
+CYBERSOURCERY_RESPONSE_PAGE_URL = 'http://your_cybersource_response_page.com/confirm'
+CYBERSOURCERY_LOCAL_RESPONSE_PAGE_PATH = '/confirm'
+CYBERSOURCERY_USE_VCR_IN_TESTS = true
+CYBERSOURCERY_VCR_CASSETTE_DIR = 'spec/cassettes'

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: cybersourcery_testing
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Michael Toppa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack-translating_proxy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.19'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: rakeup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.3'
+description: The Cybersourcery Testing gem is designed for use with Rails projects,
+  and supports feature/integration testing of the Cybersource Silent Order POST (SOP)
+  service. It can be used with the Cybersourcery gem or as a stand-alone testing service.
+  It uses a Sinatra proxy server and VCR, to avoid the need for repeated requests
+  to the Cybersource SOP test server.
+email:
+- public@toppa.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- cybersourcery_testing.gemspec
+- lib/cybersourcery_testing.rb
+- lib/cybersourcery_testing/cybersource_proxy.rb
+- lib/cybersourcery_testing/railtie.rb
+- lib/cybersourcery_testing/tasks/cybersourcery_testing.rake
+- lib/cybersourcery_testing/translating_proxy.rb
+- lib/cybersourcery_testing/vcr.rb
+- lib/cybersourcery_testing/version.rb
+- lib/rails/generators/cybersourcery_testing/dotenv_generator.rb
+- lib/rails/generators/cybersourcery_testing/templates/dotenv
+homepage: https://github.com/promptworks/cybersourcery_testing
+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.1
+signing_key: 
+specification_version: 4
+summary: For developing feature tests with Cybersourcery
+test_files: []