net_registry 0.0.2

data/lib/net_registry/transaction.rb

@@ -0,0 +1,48 @@
+# Copyright (c) 2015 Car Next Door
+# Author: Ray Tung
+#
+# 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.
+
+module NetRegistry
+  class Transaction
+    attr_accessor :settlement_date,
+                  :amount,
+                  :reference,
+                  :bank_reference,
+                  :command,
+                  :time,
+                  :number,
+                  :rrn,
+                  :merchant_id,
+                  :receipt
+
+    def card=(card)
+      raise TypeError, "Invalid class" if !card.is_a? NetRegistry::Card
+      @card = card
+    end
+
+    def card
+      @card ||= NetRegistry::Card.new
+    end
+
+  end
+end

data/lib/net_registry/version.rb

@@ -0,0 +1,27 @@
+# Copyright (c) 2015 Car Next Door
+# Author: Ray Tung
+#
+# 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.
+
+module NetRegistry
+  VERSION = "0.0.2"
+end

data/lib/net_registry.rb

@@ -0,0 +1,36 @@
+# Copyright (c) 2015 Car Next Door
+# Author: Ray Tung
+#
+# 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.
+
+require "net_registry/version"
+require "net_registry/client"
+require "net_registry/response"
+require "net_registry/response_builder"
+require "net_registry/helpers"
+require "net_registry/errors"
+require "net_registry/transaction"
+require "net_registry/card"
+
+module NetRegistry
+
+end

data/net_registry.gemspec

@@ -0,0 +1,53 @@
+# coding: utf-8
+
+# Copyright (c) 2015 Car Next Door
+# Author: Ray Tung
+#
+# 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.
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'net_registry/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "net_registry"
+  spec.version       = NetRegistry::VERSION
+  spec.authors       = ["Ray Tung"]
+  spec.email         = ["ray@carnextdoor.com.au"]
+  spec.summary       = %q{This gem serves as a Ruby wrapper for the NetRegistry Payment Gateway's
+API.}
+  spec.description   = %q{This gem serves as a Ruby wrapper for the NetRegistry Payment Gateway's
+API. Official documentation can be found at http://www.netregistry.com.au/ee-images/uploads/support/NR-ecom-gateway8.pdf. Source can be found on https://github.com/carnextnoor/net_registry}
+  spec.homepage      = ""
+  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.required_ruby_version = '>= 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

data/spec/card_spec.rb

@@ -0,0 +1,73 @@
+# Copyright (c) 2015 Car Next Door
+# Author: Ray Tung
+#
+# 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.
+
+require "spec_helper"
+
+RSpec.describe NetRegistry::Card do
+  let(:card) { NetRegistry::Card.new }
+  describe "#number" do
+    it "assigns number" do
+      number = "111111111111"
+      expect(card.number).to be_nil
+      card.number = number
+      expect(card.number).to eq(number)
+    end
+  end
+
+  describe "#description" do
+    it "assigns description" do
+      desc = "VISA"
+      expect(card.description).to be_nil
+      card.description= desc
+      expect(card.description).to eq(desc)
+    end
+  end
+
+  describe "#expiry" do
+    it "assigns expiry" do
+      expiry = "10/15"
+      expect(card.expiry).to be_nil
+      card.expiry = expiry
+      expect(card.expiry).to eq(expiry)
+    end
+  end
+
+  describe "#ccv" do
+    it "assigns CCV" do
+      ccv = "935"
+      expect(card.ccv).to be_nil
+      card.ccv = ccv
+      expect(card.ccv).to eq(ccv)
+    end
+  end
+
+  describe "#type" do
+    it "assigns type" do
+      type = "9"
+      expect(card.type).to be_nil
+      card.type = type
+      expect(card.type).to eq(type)
+    end
+  end
+end

data/spec/client_spec.rb

@@ -0,0 +1,265 @@
+# Copyright (c) 2015 Car Next Door
+# Author: Ray Tung
+#
+# 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.
+
+require "spec_helper"
+
+RSpec.describe NetRegistry::Client do
+  let(:username) { "username" }
+  let(:password) { "password" }
+  let(:client)   { NetRegistry::Client.new(merchant_id: username, password: password) }
+  let(:params)   do
+    {
+      AMOUNT: "100.0",
+      CCNUM: "111111111111",
+      CCEXP: "10/15",
+      TXNREF: "0007311428202312"
+    }
+  end
+  let(:body) { params.merge!(LOGIN: "#{username}/#{password}")}
+  let(:status_success_response) do
+    <<-STATUS
+    card_number=#{params[:CCNUM]}
+    settlement_date=31/07/00
+    response_text=INVALID TRANSACTION
+    amount=#{params[:AMOUNT]}
+    status=complete
+    txnref=#{params[:TXNREF]}
+    bank_ref=000731000024
+    card_desc=VISA
+    response_code=12
+    card_expiry=01/01
+    MID=24
+    card_type=6
+    time=2000­07­31 14:28:20
+    command=purchase
+    result=0
+    .
+    done=1
+    STATUS
+  end
+
+  let(:purchase_success_response) do
+    <<-PURCHASE
+    training_mode=0
+    pld=0
+    approved=0
+    settlement_date=31/07/00
+    transaction_no=332546
+    status=declined
+    version=V1.0
+    operator_no=22546
+    refund_mode=0
+    merchant_index=24
+    response_code=12
+    receipt_array=ARRAY(0x8221b9c)
+    cashout_amount=0
+    account_type=CREDIT A/C
+    rrn=000782000024
+    response_text=INVALID TRANSACTION
+    txn_ref=0007311458332546
+    card_no=4111111111111111
+    total_amount=100
+    card_desc=VISA
+    card_expiry=01/01
+    card_type=6
+    result=0
+    Reciept follows
+    Transaction No: 00332546
+    ­­­­­­­­­­­­­­­­­­­­­­­­
+    TYRELL CORPORATION    
+    MERCH ID        99999999
+    TERM  ID          Y9TB99
+    COUNTRY CODE AU
+    31/07/00           14:32
+    RRN         000782000024
+    VISA
+    411111­111
+    CREDIT A/C         01/01
+    AUTHORISATION��NO:
+    DECLINED   12
+    PURCHASE           $1.00
+    TOTAL   AUD        $1.00
+    PLEASE RETAIN AS RECORD 
+    OF PURCHASE
+    (SUBJECT TO CARDHOLDER'S
+    ACCEPTANCE)      
+    ­­­­­­­­­­­­­­­­­­­­­­­­
+    .
+    done=1
+    PURCHASE
+  end
+
+  describe "#initialize" do
+    it { expect(client.merchant_id).to eq(username) }
+    it { expect(client.password).to eq(password) }
+  end
+
+  describe "#purchase" do
+    context "parameter is a hash" do
+      it "should not raise any errors" do
+        stub_request(:post, /https:\/\/paygate\.ssllock\.net\/external2\.pl/)
+        .with(body: body.merge!(COMMAND: "purchase"))
+        .to_return(status: 200, body: purchase_success_response, headers: {})
+        expect { client.purchase(params) }.not_to raise_error
+      end
+      it "has key :AMOUNT with nil as value" do
+        response = client.purchase(params.merge!(AMOUNT: nil))
+        expect(response.class).to  eq(NetRegistry::Response)
+        expect(response.text).to   eq("AMOUNT not found")
+        expect(response.code).to   eq(-1)
+        expect(response.status).to eq("failed")
+      end
+
+      it "has key :AMOUNT with empty string as value" do
+        response = client.purchase(params.merge!(AMOUNT: ""))
+        expect(response.class).to  eq(NetRegistry::Response)
+        expect(response.text).to   eq("AMOUNT not found")
+        expect(response.code).to   eq(-1)
+        expect(response.status).to eq("failed")
+      end
+
+      it "has key :AMOUNT with a non-empty value" do
+        stub_request(:post, /https:\/\/paygate\.ssllock\.net\/external2\.pl/)
+        .with(body: body.merge!(COMMAND: "purchase"))
+        .to_return(status: 200, body: purchase_success_response, headers: {})
+
+        response = client.purchase(params)
+        expect(response.class).to  eq(NetRegistry::Response)
+        expect(response.text).to   eq("INVALID TRANSACTION")
+        expect(response.code).to   eq(12)
+        expect(response.status).to eq("declined")
+      end
+
+      it "has key :CCNUM with nil as value" do
+        response = client.purchase(params.merge!(CCNUM: nil))
+        expect(response.class).to  eq(NetRegistry::Response)
+        expect(response.text).to   eq("CCNUM not found")
+        expect(response.code).to   eq(-1)
+        expect(response.status).to eq("failed")
+      end
+
+      it "has key :CCNUM with empty string as value" do
+        response = client.purchase(params.merge!(CCNUM: ""))
+        expect(response.class).to  eq(NetRegistry::Response)
+        expect(response.text).to   eq("CCNUM not found")
+        expect(response.code).to   eq(-1)
+        expect(response.status).to eq("failed")
+      end
+
+      it "has key :CCNUM with a non-empty value" do
+        stub_request(:post, /https:\/\/paygate\.ssllock\.net\/external2\.pl/)
+        .with(body: body.merge!(COMMAND: "purchase"))
+        .to_return(status: 200, body: purchase_success_response, headers: {})
+        response = client.purchase(params)
+        expect(response.class).to  eq(NetRegistry::Response)
+        expect(response.text).to   eq("INVALID TRANSACTION")
+        expect(response.code).to   eq(12)
+        expect(response.status).to eq("declined")
+      end
+
+    end
+
+    context "parameter is anything but a hash" do
+      it { expect { client.purchase(1) }.to raise_error(TypeError) }
+    end
+  end
+
+  describe "#refund" do
+    context "parameter is a hash" do
+      it "does not raise error" do
+        stub_request(:post, /https:\/\/paygate\.ssllock\.net\/external2\.pl/)
+        .with(body: body.merge!(COMMAND: "refund"))
+        .to_return(status: 200, body: purchase_success_response, headers: {})
+        expect { client.refund(params) }.not_to raise_error
+      end
+      it "has key :AMOUNT with nil as value" do
+        response = client.refund(params.merge!(AMOUNT: nil))
+        expect(response.class).to  eq(NetRegistry::Response)
+        expect(response.text).to   eq("AMOUNT not found")
+        expect(response.code).to   eq(-1)
+        expect(response.status).to eq("failed")
+      end
+
+      it "has key :AMOUNT with empty string as value" do
+        response = client.refund(params.merge!(AMOUNT: ""))
+        expect(response.class).to  eq(NetRegistry::Response)
+        expect(response.text).to   eq("AMOUNT not found")
+        expect(response.code).to   eq(-1)
+        expect(response.status).to eq("failed")
+      end
+
+      it "has key :AMOUNT with a non-empty value" do
+        stub_request(:post, /https:\/\/paygate\.ssllock\.net\/external2\.pl/)
+        .with(body: body.merge!(COMMAND: "refund"))
+        .to_return(status: 200, body: purchase_success_response, headers: {})
+        response = client.refund(params)
+        expect(response.class).to  eq(NetRegistry::Response)
+        expect(response.text).to   eq("INVALID TRANSACTION")
+        expect(response.code).to   eq(12)
+        expect(response.status).to eq("declined")
+      end
+
+      it "has key :TXNREF with nil as value" do
+        response = client.refund(params.merge!(TXNREF: nil))
+        expect(response.class).to  eq(NetRegistry::Response)
+        expect(response.text).to   eq("TXNREF not found")
+        expect(response.code).to   eq(-1)
+        expect(response.status).to eq("failed")
+      end
+
+      it "has key :TXNREF with empty string as value" do
+        response = client.refund(params.merge!(TXNREF: ""))
+        expect(response.class).to  eq(NetRegistry::Response)
+        expect(response.text).to   eq("TXNREF not found")
+        expect(response.code).to   eq(-1)
+        expect(response.status).to eq("failed")
+      end
+
+      it "has key :TXNREF with a non-empty value" do
+        stub_request(:post, /https:\/\/paygate\.ssllock\.net\/external2\.pl/)
+        .with(body: body.merge!(COMMAND: "refund"))
+        .to_return(status: 200, body: purchase_success_response, headers: {})
+        response = client.refund(params)
+        expect(response.class).to  eq(NetRegistry::Response)
+        expect(response.text).to   eq("INVALID TRANSACTION")
+        expect(response.code).to   eq(12)
+        expect(response.status).to eq("declined")
+      end
+
+    end
+
+    context "parameter is anything but a hash" do
+      it { expect { client.refund(1) }.to raise_error(TypeError) }
+    end
+
+  end
+
+  describe "#status" do
+
+  end
+
+  describe "#preauth" do
+
+  end
+end