netaxept 0.1.0 → 0.2.0

data/.gitignore

@@ -1,4 +1,5 @@
 *.gem
 .bundle
 Gemfile.lock
-pkg/*
+pkg/*
+.DS_Store

data/README.md

@@ -1,14 +1,63 @@
-[![Build Status](https://secure.travis-ci.org/Hakon/netaxept.png)](http://travis-ci.org/Hakon/netaxept)
-
 Installation
 -----------
+run
 
     gem install netaxept
 
+or include in your _Gemfile_:
+
+    gem 'netaxept'
+
+Usage
+-----
+
+First step is to tell Netaxept your credentials and the desired mode:
+
+    Netaxept::Service.authenticate <merchant id>, <token>
+    Netaxept::Service.environment =  :test|:production
+
+To interact with Netaxept you need to create an instance of `Netaxept::Service`:
+
+    service = Netaxept::Service.new
+
+### General
+
+Every request returns a `Netaxept::Response` object, which has a `success?` method.
+In case of an error you can call `errors`, which gives you a list of `Netaxept::ErrorMessage`s
+(each with a `message`, `code`, `source` and `text`).
+
+### Off-site payment workflow
+
+The following applies for the _Nets hosted_ service type where the user is redirect to the
+Netaxept site to enter her payment details (see the
+[Netaxept docs](http://www.betalingsterminal.no/Netthandel-forside/Teknisk-veiledning/Overview/)
+for details).
+
+#### Registering a payment
+
+    service.register <amount in cents>, <order number>, <options>
+
+Required options are `CurrencyCode` (3 letter ISO code) and `redirectUrl`.
+
+On success the response object gives you a `transaction_id`.
+You pass that to `Netaxept::Service.terminal_url(<transaction id>)` to get the URL for redirecting the user.
+
+For details on the options see http://www.betalingsterminal.no/Netthandel-forside/Teknisk-veiledning/API/Register/
+
+#### Completing a payment
+
+After the user has authorized the payment on the Netaxept site he is redirected to the `redirectUrl` you provided. Netaxept adds a `resonseCode` and `transactionId` parameter to the URL. To finalize the payment you call `sale` on the service.
+
+    service.sale <transaction id>, <amount in cents>
+
+The response is a `Responses::SaleResponse` which only has the `success?` and `errors` methods mentioned under _General_.
+
+Congratulations, you have processed a payment.
+
 Testing
 -------
 
 To run the tests:
 
     $ bundle
-    $ rake
+    $ rake MERCHANT_ID=<your merchant id> NETAXEPT_TOKEN=<your token>

data/lib/netaxept.rb

@@ -19,5 +19,6 @@ module Netaxept
     autoload :CaptureResponse, "netaxept/responses/capture_response"
     
     autoload :CreditResponse, "netaxept/responses/credit_response"
+    autoload :AnnulResponse, "netaxept/responses/annul_response"
   end
 end

data/lib/netaxept/responses/annul_response.rb

@@ -0,0 +1,7 @@
+module Netaxept
+  module Responses
+    class AnnulResponse < Response
+
+    end
+  end
+end

data/lib/netaxept/service.rb

@@ -113,6 +113,17 @@ module Netaxept
       Responses::CreditResponse.new(self.class.get("/Netaxept/Process.aspx", params).parsed_response)
     end
 
+    def annul(transaction_id)
+      params = {
+        :query => {
+          :transactionId => transaction_id,
+          :operation => "ANNUL"
+        }
+      }
+
+      Responses::AnnulResponse.new(self.class.get("/Netaxept/Process.aspx", params).parsed_response)
+    end
+
     ##
     # The terminal url for a given transaction id
     

data/lib/netaxept/version.rb

@@ -1,3 +1,3 @@
 module Netaxept
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/netaxept.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Netaxept::VERSION
   s.authors     = ["Håkon Lerring", "Theodor Tonum"]
   s.email       = ["hakon@powow.no", "theodor@tonum.no"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/Hakon/netaxept"
   s.summary     = %q{A gem for speaking to Nets Netaxept credit card payment service}
   s.description = %q{This gem simplifies the comunication with the netaxept service significantly. Right now it only supports register and sale, more is to come.}
   s.has_rdoc    = true
@@ -19,8 +19,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
   s.add_development_dependency "rdoc"
-  s.add_development_dependency "vcr"
-  s.add_development_dependency "fakeweb"
+  s.add_development_dependency "mechanize"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/spec/netaxept/service_spec.rb

@@ -7,26 +7,26 @@ describe Netaxept::Service do
   describe ".authenticate" do
     it "sets merchant id and token as default params" do
       Netaxept::Service.should_receive(:default_params).with({
-        :MerchantId => "12341234",
-        :token => "abc123"
+        :MerchantId => NETAXEPT_TEST_MERCHANT_ID,
+        :token => NETAXEPT_TEST_TOKEN
       })
       
-      Netaxept::Service.authenticate("12341234", "abc123")
+      Netaxept::Service.authenticate(NETAXEPT_TEST_MERCHANT_ID, NETAXEPT_TEST_TOKEN)
     end
   end
   
   describe ".environment" do
-    it "sets the base_uri to https://epayment-test.bbs.no/ when set to test" do
-      Netaxept::Service.should_receive(:base_uri).with "https://epayment-test.bbs.no/"
-      
-      Netaxept::Service.environment = :test
-    end
-    
     it "sets the base_uri to https://epayment.bbs.no/ when set to production" do
       Netaxept::Service.should_receive(:base_uri).with "https://epayment.bbs.no/"
       
       Netaxept::Service.environment = :production
     end
+    
+    it "sets the base_uri to https://epayment-test.bbs.no/ when set to test" do
+      Netaxept::Service.should_receive(:base_uri).with "https://epayment-test.bbs.no/"
+      
+      Netaxept::Service.environment = :test
+    end
   end
   
   describe ".terminal_url" do
@@ -46,14 +46,13 @@ describe Netaxept::Service do
   end
   
   describe ".register" do
-    use_vcr_cassette
     
     describe "a valid request" do
       
       let(:response) { service.register(20100, 12, :redirectUrl => "http://localhost:3000/order/1/return") }
       
       it "is successful" do
-        response.success?.should == true
+        response.should be_successful
       end
       
       it "has a transaction_id" do
@@ -67,87 +66,88 @@ describe Netaxept::Service do
       let(:response) { service.register(0, 12, :redirectUrl => "http://localhost:3000/order/1/return") }
 
       it "is not a success" do
-        response.success?.should == false
+        response.should fail.with_message("Transaction amount must be greater than zero.")
       end
       
       it "does not have a transaction id" do
         response.transaction_id.should be_nil
       end
       
-      it "has an error message" do
-        response.errors.first.message.should == "Transaction amount must be greater than zero."
-      end
-      
     end
     
   end
   
-  describe ".sale" do
-    use_vcr_cassette
+  context "with a transaction id" do
     
     let(:transaction_id) { service.register(20100, 12, :redirectUrl => "http://localhost:3000/order/1/return").transaction_id }
+
+    before do 
+
+      # Register some card data with the transaction.
+      url = Netaxept::Service.terminal_url(transaction_id)
+      mechanic = Mechanize.new
+      mechanic.agent.http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      mechanic.get(url) do |page|
+        form = page.form_with(:name => "form1")
+        cc_form = form.click_button(form.button_with(:value => /^Neste/)).form_with(:name => "form1") do |form|
+          
+          form["ctl10$cardNo"] = "4925000000000004"
+          form.field_with(:id => "month").options.last.tick
+          form.field_with(:id => "year").options.last.tick
+          form["ctl10$securityCode"] = "111"
+
+        end
+        mechanic.redirect_ok = false
+        cc_form.click_button(cc_form.button_with(:id => "okButton"))
+      end
+
+    end
     
-    describe "a valid request" do
-      
-      let(:response) { service.sale(transaction_id, 20100) }
-      
+    describe "a valid sale request" do
+
       it "is a success" do
-        response.success?.should == true
+        response = service.sale(transaction_id, 20100)
+        response.should be_successful
       end
       
     end
-    
-  end
-  
-  describe ".auth" do
-    use_vcr_cassette
-    
-    let(:transaction_id) { service.register(20100, 12, :redirectUrl => "http://localhost:3000/order/1/return").transaction_id }
-    
-    describe "a valid request" do
-      
-      let(:response) { service.auth(transaction_id, 20100) }
+
+    describe "a valid auth request" do
       
       it "is a success" do
-        response.success?.should == true
+        response = service.auth(transaction_id, 20100)
+        response.should be_successful
       end
       
     end
-  end
   
-  describe ".capture" do
-    use_vcr_cassette
-    
-    let(:transaction_id) { service.register(20100, 12, :redirectUrl => "http://localhost:3000/order/1/return").transaction_id }
-    
-    describe "a valid request" do
-      
-      let(:response) { service.capture(transaction_id, 20100) }
+    describe "a valid capture request" do
       
       it "is a success" do
-        response.success?.should == true
+        service.auth(transaction_id, 20100)
+        response = service.capture(transaction_id, 20100)
+        response.should be_successful
       end
       
     end
-  end
   
-  describe ".credit" do
-    use_vcr_cassette
-
-    let(:transaction_id) { service.register(20100, 12, :redirectUrl => "http://localhost:3000/order/1/return").transaction_id }
+    describe "a valid credit request" do
 
-    describe "a valid request" do
+      it "is a success" do
+        service.sale(transaction_id, 20100)
 
-      before(:each) do
-        service.auth(transaction_id, 20100)
-        service.capture(transaction_id, 20100)
+        service.credit(transaction_id, 20100).should be_successful
       end
+    end
+
+    describe "a valid annul request" do
 
       it "is a success" do
-        service.credit(transaction_id, 20100).success?.should == true
+        service.auth(transaction_id, 20100)
+        service.annul(transaction_id).should be_successful
       end
     end
 
+    
   end
-
 end

data/spec/netaxept_credentials.rb

@@ -1,2 +1,2 @@
-NETAXEPT_TEST_MERCHANT_ID = "123123"
-NETAXEPT_TEST_TOKEN       = "123test"
+NETAXEPT_TEST_MERCHANT_ID = ENV["MERCHANT_ID"]
+NETAXEPT_TEST_TOKEN       = ENV["NETAXEPT_TOKEN"]

data/spec/spec_helper.rb

@@ -1,22 +1,13 @@
 require 'rubygems'
 require 'bundler/setup'
 
-require 'vcr'
-require "fakeweb"
-
 require 'netaxept' # and any other gems you need
 require "netaxept_credentials"
 
-VCR.config do |c|
-  c.cassette_library_dir     = 'spec/cassettes'
-  c.stub_with                :fakeweb
-  c.default_cassette_options = { :record => :new_episodes }
-end
+require "mechanize"
 
-RSpec.configure do |config|
-  
-  config.extend VCR::RSpec::Macros
-  
+Dir.glob(File.join(File.dirname(__FILE__),"support/matchers/*_matcher.rb")) do |file|
+  require file
 end
 
 Netaxept::Service.authenticate(NETAXEPT_TEST_MERCHANT_ID, NETAXEPT_TEST_TOKEN)

data/spec/support/matchers/response_success_matcher.rb

@@ -0,0 +1,47 @@
+RSpec::Matchers.define :be_successful do
+
+  match do |response|
+    response.success?
+  end
+  
+  failure_message_for_should do |response|
+    errors = response.errors.map(&:message).join(", ")
+    "#{response} should be successful, got error(s): #{errors}"
+  end
+  
+  failure_message_for_should_not do |response|
+    "#{response} should not be successful"
+  end
+  
+end
+
+RSpec::Matchers.define :fail do
+  chain :with_message do |message|
+    @message = message
+  end
+
+  match do |response|
+    @failure = !response.success?
+    
+    if(@message)
+      @failure && response.errors.map(&:message).include?(@message)
+    else
+      @failure
+    end
+    
+  end
+  
+  failure_message_for_should do |response|
+    errors = response.errors.map(&:message).join(", ")
+    if(@message)
+      "#{response} should have error message: #{@message}"
+    else
+      "#{response} should not be successful"
+    end
+  end
+  
+  failure_message_for_should_not do |response|
+    "#{response} should be successful"
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: netaxept
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-16 00:00:00.000000000 Z
+date: 2012-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70230869242240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,15 @@ dependencies:
         version: '0.7'
   type: :runtime
   prerelease: false
-  version_requirements: *70230869242240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70230869240580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70230869240580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70230869238440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +54,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70230869238440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70230869236020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,21 +70,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70230869236020
-- !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: &70230869080020 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70230869080020
 - !ruby/object:Gem::Dependency
-  name: fakeweb
-  requirement: &70230869078320 !ruby/object:Gem::Requirement
+  name: mechanize
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,7 +86,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70230869078320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: This gem simplifies the comunication with the netaxept service significantly.
   Right now it only supports register and sale, more is to come.
 email:
@@ -95,6 +109,7 @@ files:
 - Rakefile
 - lib/netaxept.rb
 - lib/netaxept/error_message.rb
+- lib/netaxept/responses/annul_response.rb
 - lib/netaxept/responses/auth_response.rb
 - lib/netaxept/responses/capture_response.rb
 - lib/netaxept/responses/credit_response.rb
@@ -104,17 +119,11 @@ files:
 - lib/netaxept/service.rb
 - lib/netaxept/version.rb
 - netaxept.gemspec
-- spec/cassettes/Netaxept_Service/_auth.yml
-- spec/cassettes/Netaxept_Service/_capture.yml
-- spec/cassettes/Netaxept_Service/_credit.yml
-- spec/cassettes/Netaxept_Service/_register.yml
-- spec/cassettes/Netaxept_Service/_sale.yml
 - spec/netaxept/service_spec.rb
 - spec/netaxept_credentials.rb
 - spec/spec_helper.rb
-- spec/support/responses/register_response.xml
-- spec/support/responses/register_without_order_id_response.xml
-homepage: ''
+- spec/support/matchers/response_success_matcher.rb
+homepage: https://github.com/Hakon/netaxept
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -134,18 +143,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: netaxept
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A gem for speaking to Nets Netaxept credit card payment service
 test_files:
-- spec/cassettes/Netaxept_Service/_auth.yml
-- spec/cassettes/Netaxept_Service/_capture.yml
-- spec/cassettes/Netaxept_Service/_credit.yml
-- spec/cassettes/Netaxept_Service/_register.yml
-- spec/cassettes/Netaxept_Service/_sale.yml
 - spec/netaxept/service_spec.rb
 - spec/netaxept_credentials.rb
 - spec/spec_helper.rb
-- spec/support/responses/register_response.xml
-- spec/support/responses/register_without_order_id_response.xml
+- spec/support/matchers/response_success_matcher.rb
+has_rdoc: true