rocketgate-ruby 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e174cdc0ab9153dd12a64e537d7f49da9e44b49d
+  data.tar.gz: 64b9018aa9f8c1266aa234e638c18772a563d147
+SHA512:
+  metadata.gz: a1cbd4b6a8ebc773c8c3847ad26619e69624fd268703ff23f741b6b2440be5fe919605db38dafd7c51eef12cfb177e80af48e008aa0e74458b4d3bd29778bb8c
+  data.tar.gz: 3c1695751188219814e250c6966ee38052205fbfaf79c82dc91ffe95f485def41eb263c8bc3c9bc2e4aaba7f61c271e7986cc5f03e6fadf2983621a93179d100

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+  - jruby-19mode
+  - jruby-head
+  - rbx-2
+  - ruby-head
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - ccashwell@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+guard 'rspec' do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Chris Cashwell
+
+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,161 @@
+# rocketgate-ruby
+
+[![Build Status](https://travis-ci.org/ccashwell/rocketgate-ruby.svg?branch=master)](https://travis-ci.org/ccashwell/rocketgate-ruby)
+[![Coverage Status](https://coveralls.io/repos/ccashwell/rocketgate-ruby/badge.png)](https://coveralls.io/r/ccashwell/rocketgate-ruby)
+[![Code Climate](https://codeclimate.com/github/ccashwell/rocketgate-ruby/badges/gpa.svg)](https://codeclimate.com/github/ccashwell/rocketgate-ruby)
+
+RocketGate's Payment Gateway, minus the painful integration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rocketgate-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rocketgate-ruby
+
+## Usage
+
+### Configuration
+
+Before you can jump in, you need to configure the gem with your RocketGate credentials:
+
+```ruby
+RocketGate.configure do |config|
+  config.merchant_id        = 'rocketgate_merchant_id'
+  config.merchant_password  = 'rocketgate_merchant_password'
+end
+```
+
+You can also supply other configuration settings:
+
+```ruby
+RocketGate.configure do |config|
+  config.merchant_id        = 'rocketgate_merchant_id'
+  config.merchant_password  = 'rocketgate_merchant_password'
+  config.currency           = 'USD'
+  config.request_host       = 'special-gateway.rocketgate.com'
+  config.request_path       = '/specialServlet'
+  config.request_port       = 8080
+  config.request_timeout    = 5
+  config.request_version    = 'R2.0'
+  config.require_avs        = false
+  config.require_cvv        = false
+  config.require_scrub      = false
+  config.require_ssl        = false
+end
+```
+
+And if you want to test something against the sandbox gateway:
+
+```ruby
+RocketGate.configuration.testing!
+```
+
+### Making an Authorization Request
+
+In order to get an authorization, you'll need to send a request to the gateway.
+
+1. Build a [`Customer`](https://github.com/ccashwell/rocketgate-ruby/blob/master/lib/rocketgate/customer.rb) and [`CreditCard`](https://github.com/ccashwell/rocketgate-ruby/blob/master/lib/rocketgate/credit_card.rb) so we know who and how to charge:
+
+  ```ruby
+  customer    = RocketGate::Customer.new('John', 'Doe', '123 Main St', 'Beverly Hills', 'CA', '90210')  
+  credit_card = RocketGate::CreditCard.new('4111-1111-1111-1111', '08', '2042', '012')
+  ```
+
+1. Build a [`Transaction`](https://github.com/ccashwell/rocketgate-ruby/blob/master/lib/rocketgate/transaction.rb)
+
+  ```ruby
+  transaction     = RocketGate::Transaction.new(9.99, customer, credit_card)
+  ```
+
+1. Set the transaction type
+
+  ```ruby
+  transaction.type = RocketGate::Transaction::TYPE[:purchase]
+  ```
+
+1. Optionally, add an identifier that ties the transaction and customer to something relevant for you, like a `User` or `Invoice`. (A UUID will be generated if not.)
+
+  ```ruby
+  credit_card.id = User.id
+  transaction.id = Invoice.id
+  ```
+
+1. Build a [`Request`](https://github.com/ccashwell/rocketgate-ruby/blob/master/lib/rocketgate/request.rb)
+
+  ```ruby
+  request = RocketGate::Request.new(transaction)
+  ```
+
+1. Send the request to the gateway
+
+  ```ruby
+  response = RocketGate.send_request!(request)
+  ```
+
+1. Check the [`Response`](https://github.com/ccashwell/rocketgate-ruby/blob/master/lib/rocketgate/response.rb)
+
+  ```ruby
+  response.authorized?            # => true (authorization OK)
+  response.success?               # => true (authorization + gateway response OK)
+  ```
+
+1. Confirm receipt of the transaction response (**Note: RocketGate will cancel your transaction if you don't confirm it!**)
+
+  ```ruby
+  response.confirm! # => returns a Response like the original request
+  ```
+
+### Authorizations
+
+In the section above you created and sent a request, then looked at the response. The response's [`Authorization`](https://github.com/ccashwell/rocketgate-ruby/blob/master/lib/rocketgate/authorization.rb) has lots of great information, too.
+
+```ruby
+authorization = response.authorization
+
+authorization.avs_ok?           # => AVS check OK or disabled
+authorization.cvv_ok?           # => CVV check OK or disabled
+authorization.success?          # => AVS check + CVV check + reason code OK
+authorization.declined?         # => opposite of success?
+authorization.auth_code         # => authorization code from gateway, may be blank
+authorization.reason_code       # => descriptive(ish) reason for the response
+authorization.approved_amount   # => dollar amount of authorization (should match transaction)
+authorization.approved_currency # => currency the authorization settled in (should match transaction)
+authorization.card_hash         # => unique hash of the card data which can be used later
+authorization.card_expiration   # => 4-digit representation of the card expiration
+authorization.card_last_four    # => the last four digits of the card charged
+authorization.reference_id      # => unique reference ID used to confirm, void or reverse the request
+```
+
+## Not Yet Implemented (Future Plans)
+
+- Rebill functionality
+
+## Compatibility
+
+This library supports Ruby >= 1.9.3 on a variety of platforms.
+
+[Travis CI](https://travis-ci.org/ccashwell/rocketgate-ruby) builds every commit under [these environments](https://github.com/ccashwell/rocketgate-ruby/blob/master/.travis.yml):
+
+ - MRI 1.9.3, 2.0.0, 2.1.1 and HEAD
+ - JRuby 1.7.11 (1.9 mode) and HEAD
+ - Rubinius 2.2.1
+
+Other interpreters and earlier versions of MRI, JRuby and RBX are not supported.
+
+## Contributing
+
+1. Fork it ( https://github.com/ccashwell/rocketgate-ruby/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,14 @@
+require 'rspec/core/rake_task'
+require 'bundler/gem_tasks'
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation', '--tag', '~integration']
+end
+
+RSpec::Core::RakeTask.new(:integration) do |task|
+  task.rspec_opts = ['--color', '--format', 'documentation', '--tag', 'integration']
+end
+
+task :default => :spec

data/lib/rocketgate.rb

@@ -0,0 +1,52 @@
+module RocketGate
+  autoload :VERSION,       'rocketgate/version'
+
+  autoload :Authorization, 'rocketgate/authorization'
+  autoload :Configuration, 'rocketgate/configuration'
+  autoload :Connection,    'rocketgate/connection'
+  autoload :CreditCard,    'rocketgate/credit_card'
+  autoload :Customer,      'rocketgate/customer'
+  autoload :Request,       'rocketgate/request'
+  autoload :Response,      'rocketgate/response'
+  autoload :ResponseCode,  'rocketgate/response_code'
+  autoload :Transaction,   'rocketgate/transaction'
+
+  autoload :Hashable,      'rocketgate/hashable'
+  autoload :Validatable,   'rocketgate/validatable'
+
+  AuthorizationError       = Class.new(StandardError)
+  ValidationError          = Class.new(StandardError)
+  GatewayRequestError      = Class.new(StandardError)
+  GatewayResponseError     = Class.new(StandardError)
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def connection
+      configuration.validate!
+      @connection ||= Connection.new(configuration.request_host,
+                                     configuration.request_port,
+                                     configuration.request_path)
+    end
+
+    def reset!
+      @configuration, @connection = nil, nil
+    end
+
+    def send_request!(request)
+      response = connection.make_request!(request.build_gateway_request)
+
+      if response.code.to_i == 200
+        return Response.from_xml(response.body)
+      else
+        raise GatewayRequestError.new("Unexpected status code in gateway response: #{response.code}")
+      end
+    end
+  end
+end

data/lib/rocketgate/authorization.rb

@@ -0,0 +1,31 @@
+module RocketGate
+  class Authorization
+    attr_accessor :auth_code, :avs_response, :cvv_response, :reason_code,
+                  :approved_amount, :approved_currency, :card_hash,
+                  :card_expiration, :card_last_four, :reference_id
+
+    def avs_ok?
+      if RocketGate.configuration.require_avs
+        RocketGate::ResponseCode::AVS_SUCCESSES.include?(avs_response)
+      else
+        true
+      end
+    end
+
+    def cvv_ok?
+      if RocketGate.configuration.require_cvv
+        RocketGate::ResponseCode::CVV_SUCCESSES.include?(cvv_response)
+      else
+        true
+      end
+    end
+
+    def declined?
+      !success?
+    end
+
+    def success?
+      avs_ok? && cvv_ok? && reason_code == :success
+    end
+  end
+end

data/lib/rocketgate/configuration.rb

@@ -0,0 +1,53 @@
+module RocketGate
+  class Configuration
+    include Validatable
+
+    attr_accessor :currency,
+                  :merchant_id,
+                  :merchant_password,
+                  :request_timeout,
+                  :request_host,
+                  :request_path,
+                  :request_port,
+                  :request_version,
+                  :require_avs,
+                  :require_cvv,
+                  :require_scrub,
+                  :require_ssl
+
+    validatable :currency, :merchant_id, :merchant_password, :request_host,
+                :request_path, :request_port, :request_timeout, :request_version,
+                :require_avs, :require_cvv, :require_scrub, :require_ssl
+
+    GATEWAY_LIVE_HOST     = 'gw-16.rocketgate.com'
+    GATEWAY_TEST_HOST     = 'dev-gw.rocketgate.com'
+    GATEWAY_PORT          = 443
+    GATEWAY_SERVLET       = '/gateway/servlet/ServiceDispatcherAccess'
+    GATEWAY_VERSION       = 'R1.2'
+    DEFAULT_TIMEOUT       = 10
+    DEFAULT_CURRENCY      = 'USD'
+    USER_AGENT_STRING     = "rocketgate-ruby/#{RocketGate::VERSION}"
+
+    def initialize
+      @currency           = DEFAULT_CURRENCY
+      @request_host       = GATEWAY_LIVE_HOST
+      @request_path       = GATEWAY_SERVLET
+      @request_port       = GATEWAY_PORT
+      @request_timeout    = DEFAULT_TIMEOUT
+      @request_version    = GATEWAY_VERSION
+      @require_avs        = true
+      @require_cvv        = true
+      @require_scrub      = true
+      @require_ssl        = true
+    end
+
+    def testing!
+      @request_host       = GATEWAY_TEST_HOST
+      @request_port       = GATEWAY_PORT
+      @merchant_id        = '1'
+      @merchant_password  = 'testpassword'
+
+      self
+    end
+  end
+end

data/lib/rocketgate/connection.rb

@@ -0,0 +1,30 @@
+require 'net/http'
+
+module RocketGate
+  class Connection
+    def initialize(server, port, path)
+      @server, @port, @path = server, port, path
+      @client               = Net::HTTP.new(server, port)
+
+      @client.open_timeout  = RocketGate.configuration.request_timeout
+      @client.read_timeout  = RocketGate.configuration.request_timeout
+
+      if RocketGate.configuration.require_ssl
+        @client.use_ssl     = true
+        @client.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+    end
+
+    def make_request!(request_body)
+      request          = Net::HTTP::Post.new(@path, {
+        'Accept'       => 'text/xml',
+        'Content-Type' => 'text/xml',
+        'User-Agent'   => "rocketgate-ruby/#{RocketGate::VERSION}"
+      })
+
+      request.body     = request_body
+
+      @client.request(request)
+    end
+  end
+end

data/lib/rocketgate/credit_card.rb

@@ -0,0 +1,42 @@
+module RocketGate
+  class CreditCard
+    include Hashable, Validatable
+
+    attr_accessor :cvv, :exp_month, :exp_year, :number, :card_hash
+
+    validatable :number, :exp_month, :exp_year
+
+    hashable({
+      cardNo:       :number,
+      expireMonth:  :exp_month,
+      expireYear:   :exp_year,
+      cvv2:         :cvv
+    })
+
+    def initialize(*args)
+      @number, @exp_month, @exp_year, @cvv = *args
+
+      clean_number! if @number
+    end
+
+    def self.from_card_hash(card_hash)
+      new.tap do |cc|
+        cc.card_hash = card_hash
+      end
+    end
+
+    def to_hash
+      card_hash ? { cardHash: card_hash } : super
+    end
+
+    def valid?
+      !card_hash.nil? || super
+    end
+
+    private
+
+    def clean_number!
+      @number.delete!("^0-9")
+    end
+  end
+end