inventables-activetiger 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Inventables
+
+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.textile

@@ -0,0 +1,46 @@
+h1. activetiger
+
+h2. Overview
+
+activetiger is a ruby library that allows interaction with Tiger Payment Processing. Using simple commands you can charge, authorize, capture, void, refund and update credit card transactions. Some simple examples are below, see the "wiki":http://wiki.github.com/inventables/activetiger for a more complete guide.
+
+h2. Simple example
+
+Authorize and capture a credit card:
+
+bc. # authorize the charge
+gateway = ActiveTiger::Gateway.new :username => "user", :password => "password"
+response = gateway.authorize :ccnumber => "4111111111111111", :ccexp => "1010", :amount => "1.00"
+
+bc. # capture
+gateway.charge(:transactionid => response.transaction_id)
+
+h2. Rails Integration
+
+activetiger works great with rails. When used in a rails project, active tiger looks for a directory called config/activetiger. Within this directory, it expects to find yaml configuration files for each environment in which you will be using activetiger. Tiger Payment Processing provides a dummy account with the username of "demo" and the password of "password". The standard configuration would normally be something like the example below:
+
+bc. # config/activetiger/development.yml
+username: demo
+password: password
+
+bc. # config/activetiger/test.yml
+username: demo
+password: password
+
+bc. # config/activetiger/production.yml
+username: realusername
+password: realpassword
+
+The above setup allows you to instantiate an ActiveTiger::Gateway without providing a username or password. It will be instantiated with the credentials specified in the yaml config files based on the environment. This allows you the test and develop against the sandbox account while run production with your account. Very handy for testing.
+
+h2. Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+h2. Copyright
+
+Copyright (c) 2009 Inventables. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'rake'
+require 'spec/rake/spectask'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "activetiger"
+    gem.summary = %Q{Easy integration with Tiger Payment Solutions}
+    gem.description = %Q{ActiveTiger allows you to simply add payment processing to your application using Tiger Payment Solutions}
+    gem.email = "development@inventables.com"
+    gem.homepage = "http://github.com/drewolson/activetiger"
+    gem.authors = ["Drew Olson"]
+    gem.add_development_dependency "rspec"
+    gem.add_dependency "adamwiggins-rest-client", ">=1.0.4"
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+task :spec => :check_dependencies
+task :default => :spec
+
+Spec::Rake::SpecTask.new do |t|
+  t.warning = true
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "activetiger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/activetiger.rb

@@ -0,0 +1,8 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+require 'restclient'
+require 'activetiger/configuration'
+require 'activetiger/gateway'
+require 'activetiger/response'
+

data/lib/activetiger/configuration.rb

@@ -0,0 +1,17 @@
+module ActiveTiger
+  class Configuration
+    def initialize
+      config_path = File.join(RAILS_ROOT, "config", "activetiger", "#{RAILS_ENV}.yml")
+      @config = YAML.load(File.read(config_path))
+    end
+
+    def username
+      @config["username"]
+    end
+
+    def password
+      @config["password"]
+    end
+  end
+end
+

data/lib/activetiger/gateway.rb

@@ -0,0 +1,41 @@
+module ActiveTiger
+  class Gateway
+    TIGER_GATEWAY_URL = "https://secure.tigergateway.net/api/transact.php"
+
+    def initialize(params = {})
+      if defined?(RAILS_ENV) && defined?(RAILS_ROOT)
+        config = ActiveTiger::Configuration.new
+        @username = config.username
+        @password = config.password
+      else
+        @username = params[:username]
+        @password = params[:password]
+      end
+    end
+
+    ["sale", "credit", "capture", "void", "refund", "update"].each do |operation|
+      define_method(operation) do |params|
+        params.merge! :type => operation
+        make_request(params)
+      end
+    end
+
+    def authorize(params)
+      params.merge! :type => "auth"
+      make_request(params)
+    end
+
+    private
+
+    def make_request(params)
+      params.merge! :username => @username, :password => @password
+      response_string = tiger_gateway.post(params)
+      ActiveTiger::Response.build_from_string(response_string)
+    end
+
+    def tiger_gateway
+      @tiger_gateway ||= RestClient::Resource.new(TIGER_GATEWAY_URL)
+    end
+  end
+end
+

data/lib/activetiger/response.rb

@@ -0,0 +1,82 @@
+module ActiveTiger
+  class Response
+    RESPONSE = {
+      :approved => "1",
+      :declined => "2",
+      :errors => "3"
+    }
+    DEFAULT_MESSAGE = "No Message Provided"
+    RESPONSE_CODE_MESSAGES = {
+      "100" => "Transaction was Approved",
+      "200" => "Transaction was Declined by Processor",
+      "200" => "Do Not Honor",
+      "201" => "Insufficient Funds",
+      "202" => "Over Limit",
+      "203" => "Transaction not allowed",
+      "220" => "Incorrect Payment Data",
+      "221" => "No Such card Issuer",
+      "222" => "No Card Number on file with Issuer",
+      "223" => "Expired Card",
+      "224" => "Invalid Expiration Date",
+      "225" => "Invalid Security Code",
+      "240" => "Call Issuer for Further Information",
+      "250" => "Pick Up Card",
+      "251" => "Lost Card",
+      "252" => "Stolen Card",
+      "253" => "Fraudulant Card",
+      "260" => "Declined with further Instructions Available (see response text)",
+      "261" => "Declined - Stop All Recurring Payments",
+      "262" => "Declined - Stop this Recurring Program",
+      "263" => "Declined - Update Cardholder Data Available",
+      "264" => "Declined - Retry in a few days",
+      "300" => "Transaction was Rejected by Gateway",
+      "400" => "Transaction Error Returned by Processor",
+      "410" => "Invalid Merchant Configuration",
+      "411" => "Merchant Account is Inactive",
+      "420" => "Communication Error",
+      "421" => "Communication Error with Issuer",
+      "430" => "Duplicate Transaction at Processor",
+      "440" => "Processor Format Error",
+      "441" => "Invalid Transaction Information",
+      "460" => "Processor Feature not Available",
+      "461" => "Unsupported Card Type"
+    }
+
+    class << self
+      def build_from_string(response_string)
+        params = response_string.split("&").inject({}) do |hash, string_pair|
+          key, val = string_pair.split("=")
+          hash.merge(key.to_sym => val)
+        end
+
+        self.new(params)
+      end
+    end
+
+    attr_reader :transaction_id, :message, :response_code
+
+    def initialize(params)
+      @response = params[:response]
+      @transaction_id = params[:transactionid]
+      @response_code = params[:response_code]
+      @message = params[:responsetext]
+    end
+
+    def approved?
+      @response == RESPONSE[:approved]
+    end
+
+    def declined?
+      @response == RESPONSE[:declined]
+    end
+
+    def has_errors?
+      @response == RESPONSE[:errors]
+    end
+
+    def response_code_message
+      RESPONSE_CODE_MESSAGES[@response_code] || DEFAULT_MESSAGE
+    end
+  end
+end
+

data/spec/activetiger/configuration_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ActiveTiger::Configuration do
+  it "loads the yaml configuration for the given environment" do
+    file_mock = mock("Config file")
+    File.should_receive(:read).with("foo/config/activetiger/test.yml").and_return(file_mock)
+    YAML.should_receive(:load).with(file_mock)
+
+    with_constants :RAILS_ENV => "test", :RAILS_ROOT => "foo" do
+      ActiveTiger::Configuration.new
+    end
+  end
+
+  describe "with a loaded configuration" do
+    before(:each) do
+      yml = <<-YML
+username: user
+password: pass
+      YML
+
+      File.should_receive(:read).with("foo/config/activetiger/test.yml").and_return(yml)
+
+      with_constants :RAILS_ENV => "test", :RAILS_ROOT => "foo" do
+        @config = ActiveTiger::Configuration.new
+      end
+    end
+
+    it "gives the correct username" do
+      @config.username.should == "user"
+    end
+
+    it "gives the correct password" do
+      @config.password.should == "pass"
+    end
+  end
+end
+

data/spec/activetiger/gateway_spec.rb

@@ -0,0 +1,152 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ActiveTiger::Gateway do
+  before(:each) do
+    @default_response = "response=1&responsetext=SUCCESS&authcode=123456&transactionid=1042256997&avsresponse=&cvvresponse=&orderid=&type=sale&response_code=100"
+    @mock_tiger_gateway = mock('Tiger ActiveTigers')
+    RestClient::Resource.stub!(:new).with("https://secure.tigergateway.net/api/transact.php").and_return(@mock_tiger_gateway)
+  end
+
+  it "creates a payment response" do
+    @mock_tiger_gateway.stub!(:post).with(
+      :username => "drew",
+      :password => "foo",
+      :type => "sale",
+      :ccnumber => "4111111111111111",
+      :ccexp => "1010",
+      :amount => "1.00"
+    ).and_return(@default_response)
+
+    ActiveTiger::Response.should_receive(:build_from_string).with(@default_response)
+
+    gateway = ActiveTiger::Gateway.new(:username => "drew", :password => "foo")
+    gateway.sale :ccnumber => "4111111111111111", :ccexp => "1010", :amount => "1.00"
+  end
+
+  context "if RAILS_ROOT and RAILS_ENV are defined" do
+    it "defaults to payment configuration values" do
+      with_constants :RAILS_ROOT => "bar", :RAILS_ENV => "test" do
+        config_mock = mock("ActiveTiger configuration")
+        config_mock.should_receive(:username).and_return("drew")
+        config_mock.should_receive(:password).and_return("pass")
+        ActiveTiger::Configuration.should_receive(:new).and_return(config_mock)
+
+        gateway = ActiveTiger::Gateway.new
+      end
+    end
+  end
+
+  context "if RAILS_ROOT or RAILS_ENV are not defined" do
+    it "should not create an instance of the configuration class" do
+      ActiveTiger::Configuration.should_not_receive(:new)
+      gateway = ActiveTiger::Gateway.new
+    end
+  end
+
+  describe "#sale" do
+    it "posts a hash of arguments the payment gateway" do
+      @mock_tiger_gateway.should_receive(:post).with(
+        :username => "drew",
+        :password => "foo",
+        :type => "sale",
+        :ccnumber => "4111111111111111",
+        :ccexp => "1010",
+        :amount => "1.00"
+      ).and_return(@default_response)
+
+      gateway = ActiveTiger::Gateway.new(:username => "drew", :password => "foo")
+      gateway.sale :ccnumber => "4111111111111111", :ccexp => "1010", :amount => "1.00"
+    end
+  end
+
+  describe "#authorize" do
+    it "posts a hash of arguments the payment gateway" do
+      @mock_tiger_gateway.should_receive(:post).with(
+        :username => "drew",
+        :password => "foo",
+        :type => "auth",
+        :ccnumber => "4111111111111111",
+        :ccexp => "1010",
+        :amount => "1.00"
+      ).and_return(@default_response)
+
+      gateway = ActiveTiger::Gateway.new(:username => "drew", :password => "foo")
+      gateway.authorize :ccnumber => "4111111111111111", :ccexp => "1010", :amount => "1.00"
+    end
+  end
+
+  describe "#credit" do
+    it "posts a hash of arguments the payment gateway" do
+      @mock_tiger_gateway.should_receive(:post).with(
+        :username => "drew",
+        :password => "foo",
+        :type => "credit",
+        :ccnumber => "4111111111111111",
+        :ccexp => "1010",
+        :amount => "1.00"
+      ).and_return(@default_response)
+
+      gateway = ActiveTiger::Gateway.new(:username => "drew", :password => "foo")
+      gateway.credit :ccnumber => "4111111111111111", :ccexp => "1010", :amount => "1.00"
+    end
+  end
+
+  describe "#capture" do
+    it "posts a hash of arguments the payment gateway" do
+      @mock_tiger_gateway.should_receive(:post).with(
+        :username => "drew",
+        :password => "foo",
+        :type => "capture",
+        :transactionid => "12345",
+        :amount => "1.00"
+      ).and_return(@default_response)
+
+      gateway = ActiveTiger::Gateway.new(:username => "drew", :password => "foo")
+      gateway.capture :transactionid => "12345", :amount => "1.00"
+    end
+  end
+
+  describe "#void" do
+    it "posts a hash of arguments the payment gateway" do
+      @mock_tiger_gateway.should_receive(:post).with(
+        :username => "drew",
+        :password => "foo",
+        :type => "void",
+        :transactionid => "12345"
+      ).and_return(@default_response)
+
+      gateway = ActiveTiger::Gateway.new(:username => "drew", :password => "foo")
+      gateway.void :transactionid => "12345"
+    end
+  end
+
+  describe "#refund" do
+    it "posts a hash of arguments the payment gateway" do
+      @mock_tiger_gateway.should_receive(:post).with(
+        :username => "drew",
+        :password => "foo",
+        :type => "refund",
+        :transactionid => "12345",
+        :amount => "1.00"
+      ).and_return(@default_response)
+
+      gateway = ActiveTiger::Gateway.new(:username => "drew", :password => "foo")
+      gateway.refund :transactionid => "12345", :amount => "1.00"
+    end
+  end
+
+  describe "#update" do
+    it "posts a hash of arguments the payment gateway" do
+      @mock_tiger_gateway.should_receive(:post).with(
+        :username => "drew",
+        :password => "foo",
+        :type => "update",
+        :transactionid => "12345"
+      ).and_return(@default_response)
+
+      gateway = ActiveTiger::Gateway.new(:username => "drew", :password => "foo")
+      gateway.update :transactionid => "12345"
+    end
+  end
+end
+

data/spec/activetiger/response_spec.rb

@@ -0,0 +1,93 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ActiveTiger::Response do
+  describe "#build_from_string" do
+    it "builds a response object from a url params string" do
+      ActiveTiger::Response.should_receive(:new).with(
+        :response => "1", 
+        :responsetext => "SUCCESS",
+        :authcode => nil,
+        :transactionid => "1042369612",
+        :avsresponse => nil,
+        :cvvresponse => nil,
+        :orderid => nil,
+        :type => "refund",
+        :response_code => "100"
+      )
+
+      ActiveTiger::Response.build_from_string(
+        "response=1&responsetext=SUCCESS&authcode=&transactionid=1042369612&avsresponse=&cvvresponse=&orderid=&type=refund&response_code=100"
+      )
+    end
+  end
+
+  describe "#approved?" do
+    it "returns true if approved" do
+      response = ActiveTiger::Response.new(:response => "1")
+      response.should be_approved
+    end
+
+    it "returns false if not approved" do
+      response = ActiveTiger::Response.new(:response => "2")
+      response.should_not be_approved
+    end
+  end
+
+  describe "#declined?" do
+    it "returns true if declined" do
+      response = ActiveTiger::Response.new(:response => "2")
+      response.should be_declined
+    end
+
+    it "returns false if not declined" do
+      response = ActiveTiger::Response.new(:response => "1")
+      response.should_not be_declined
+    end
+  end
+
+  describe "#has_errors?" do
+    it "returns true if declined" do
+      response = ActiveTiger::Response.new(:response => "3")
+      response.should have_errors
+    end
+
+    it "returns false if not declined" do
+      response = ActiveTiger::Response.new(:response => "1")
+      response.should_not have_errors
+    end
+  end
+
+  describe "#transaction_id" do
+    it "returns the transaction_id" do
+      response = ActiveTiger::Response.new(:transactionid => "12345")
+      response.transaction_id.should == "12345" 
+    end
+  end
+
+  describe "#response_code_message" do
+    it "returns the response_code_message associated with the response code" do
+      response = ActiveTiger::Response.new(:response_code => "100")
+      response.response_code_message.should == "Transaction was Approved"
+    end
+
+    it "returns the default response_code_message for an unknow response code" do
+      response = ActiveTiger::Response.new(:response_code => "42")
+      response.response_code_message.should == ActiveTiger::Response::DEFAULT_MESSAGE
+    end
+  end
+
+  describe "#response_code" do
+    it "returns the response_code" do
+      response = ActiveTiger::Response.new(:response_code => "100")
+      response.response_code.should == "100"
+    end
+  end
+
+  describe "#message" do
+    it "returns the response text" do
+      response = ActiveTiger::Response.new(:responsetext => "Sample Text")
+      response.message.should == "Sample Text"
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require File.join(File.dirname(__FILE__),'..','lib','activetiger')
+
+def with_constants(constants, &block)
+  constants.each do |constant, val|
+    Object.const_set(constant, val)
+  end
+
+  block.call
+
+  constants.each do |constant, val|
+    Object.send(:remove_const, constant)
+  end
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: inventables-activetiger
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Drew Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-27 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: adamwiggins-rest-client
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.4
+    version: 
+description: ActiveTiger allows you to simply add payment processing to your application using Tiger Payment Solutions
+email: development@inventables.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.textile
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.textile
+- Rakefile
+- VERSION
+- lib/activetiger.rb
+- lib/activetiger/configuration.rb
+- lib/activetiger/gateway.rb
+- lib/activetiger/response.rb
+- spec/activetiger/configuration_spec.rb
+- spec/activetiger/gateway_spec.rb
+- spec/activetiger/response_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/drewolson/activetiger
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Easy integration with Tiger Payment Solutions
+test_files: 
+- spec/activetiger/configuration_spec.rb
+- spec/activetiger/gateway_spec.rb
+- spec/activetiger/response_spec.rb
+- spec/spec_helper.rb