net_registry 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5ff510ba930514e5dd870986c3f6ae24fa305115
+  data.tar.gz: f7ed940f85609d8038cd729070e53401403dc558
+SHA512:
+  metadata.gz: e6dbd45eea7926c888585cb941071cfd02168dca65c210656afd20df0bae116dfe0d66230054d9ec19717167bd9fb259990a0c25a01fc03e62a3d9ecbce95d02
+  data.tar.gz: e2a3be6fd1389c05cb9c16db8288543fb5dbc9550c6e5a4df9976d872760d1f755d955b24d8f6180b48583e6b0ea694ca0f8ebe3fda085f988d82830341db1b5

data/.gitignore

@@ -0,0 +1,22 @@
+*.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/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,28 @@
+# 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.
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in net_registry.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,23 @@
+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.

data/README.md

@@ -0,0 +1,108 @@
+# NetRegistry
+
+This gem serves as a Ruby wrapper for the NetRegistry Payment Gateway's
+API. Official documentation can be found [http://www.netregistry.com.au/ee-images/uploads/support/NR-ecom-gateway8.pdf](here)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem 'net_registry'
+```
+
+And then execute:
+
+``` BASH
+$ bundle
+```
+
+Or install it yourself as:
+
+``` BASH
+$ gem install net_registry
+```
+
+## Quick start
+
+``` ruby
+client   = NetRegistry::Client.new(merchant_id: 1234, password: 1234)
+response = client.purchase(AMOUNT: 100, CCNUM: "111111111111", CCEXP: "10/15")
+```
+
+## Usage
+
+This gem currently support "purchase", "refund", "status", "preauth",
+and each of these methods take a `hash` parameter. The required keys
+are specified in the following:
+
+#### Purchase
+
+Input:
+
+``` ruby
+{
+  AMOUNT: (Integer, Float, or String). The amount you would like to
+  charge. Don't add "$", just the numerical amount.,
+
+  CCNUM: (Integer, String). The credit card number. NO SPACES OR
+  DASH,
+
+  CCEXP: (String). Credit card expiry date. Must be in the format of
+  "mm/yy".
+}
+```
+
+Returns: NetRegistry::Response object.
+
+#### Refund
+
+Input:
+``` ruby
+{
+  AMOUNT: (Integer, Float, or String). The amount you would like to
+  charge. Don't add "$", just the numerical amount.,
+
+  TXNREF: (String). Transaction reference number
+}
+```
+
+Returns: NetRegistry::Response object.
+
+#### Preauth
+
+Input:
+
+``` ruby
+{
+  AMOUNT: (Integer, Float, or String). The amount you would like to
+  charge. Don't add "$", just the numerical amount.,
+
+  CCNUM: (Integer, String). The credit card number. NO SPACES OR
+  DASH,
+
+  CCEXP: (String). Credit card expiry date. Must be in the format of
+  "mm/yy".
+}
+```
+
+Returns: NetRegistry::Response object.
+
+#### Status
+
+Input:
+``` ruby
+{
+  TXNREF: (String). Transaction reference number
+}
+```
+
+Returns: NetRegistry::Response object.
+
+## Contributing
+
+1. Fork it ( https://github.com/carnextdoor/net_registry/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/lib/net_registry/card.rb

@@ -0,0 +1,42 @@
+# 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 Card
+    attr_accessor :number,
+                  :description,
+                  :expiry,
+                  :ccv,
+                  :type
+
+    def initialize(number: nil, description: nil, expiry: nil, ccv: nil, type: nil)
+      @number      = number
+      @description = description
+      @expiry      = expiry
+      @ccv         = ccv
+      @type        = type
+    end
+
+  end
+end

data/lib/net_registry/client.rb

@@ -0,0 +1,83 @@
+# 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/http"
+
+module NetRegistry
+  class Client
+
+    attr_accessor :merchant_id, :password, :base_url, :factory, :url, :login
+
+    def initialize(merchant_id: ENV["NET_REGISTRY_MERCHANT"], password: ENV["NET_REGISTRY_PASSWORD"])
+      @merchant_id, @password = merchant_id, password
+
+      @login    = "#{@merchant_id}/#{@password}"
+      @base_url = "https://paygate.ssllock.net/external2.pl"
+      @uri      = URI(@base_url)
+      @factory  = NetRegistry::ResponseBuilder.new
+    end
+
+    # Alias for
+    # request(COMMAND: "purchase", AMOUNT: 100 ... etc)
+    def purchase(params = {})
+      raise TypeError, "params is not a hash" if !params.is_a?(Hash)
+      request(params.merge!(COMMAND: "purchase"))
+    end
+
+    # Alias for
+    # request(COMMAND: "refund", AMOUNT: 100 ... etc)
+    def refund(params = {})
+      raise TypeError, "params is not a hash" if !params.is_a?(Hash)
+      request(params.merge!(COMMAND: "refund"))
+    end
+
+    # Alias for
+    # request(COMMAND: "status", AMOUNT: 100 ... etc)
+    def status(params = {})
+      raise TypeError, "params is not a hash" if !params.is_a?(Hash)
+      request(params.merge!(COMMAND: "status"))
+    end
+
+    # Alias for
+    # request(COMMAND: "preauth", AMOUNT: 100 ... etc)
+    def preauth(params = {})
+      raise TypeError, "params is not a hash" if !params.is_a?(Hash)
+      request(params.merge!(COMMAND: "preauth"))
+    end
+
+    def request(params = {})
+      raise TypeError, "params is not a hash" if !params.is_a?(Hash)
+      params.merge!(LOGIN: @login)
+      @factory.verify_params(params) ? send_request(params) : @factory.create
+    end
+
+    private
+
+    def send_request(params)
+      res = Net::HTTP.post_form(@uri, params)
+      @factory.parse(res.body).create
+    end
+
+  end
+end

data/lib/net_registry/errors.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
+  class CommandNotFoundError < ArgumentError; end
+end

data/lib/net_registry/helpers.rb

@@ -0,0 +1,29 @@
+# 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
+  module Helpers
+    EXPIRY_REGEX = /\d{2}\/\d{2}/
+  end
+end

data/lib/net_registry/response.rb

@@ -0,0 +1,61 @@
+# 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 Response
+    attr_accessor :text, :status, :full_response
+    attr_reader   :code, :result
+
+    def initialize(text: "Unknown Error", code: -1, status: "failed", result: -1)
+      @text, @code, @status, @result = text, code, status, result
+    end
+
+    def failed?
+      @code == -1 ||
+        (!@full_response.nil? && @full_response.first == "failed")
+    end
+
+    def success?
+      !failed?
+    end
+
+    def code=(code)
+      @code = code.to_i
+    end
+
+    def result=(result)
+      @result = result.to_i
+    end
+
+    def transaction=(transaction)
+      raise TypeError, "Not NetRegistry::Transaction" if !transaction.is_a?(NetRegistry::Transaction)
+      @transaction = transaction
+    end
+
+    def transaction
+      @transaction ||= NetRegistry::Transaction.new
+    end
+
+  end
+end

data/lib/net_registry/response_builder.rb

@@ -0,0 +1,203 @@
+# 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 'date'
+
+module NetRegistry
+  class ResponseBuilder
+
+    attr_reader :response
+
+    def initialize
+      @response = NetRegistry::Response.new
+    end
+
+    # command (String): Denotes which action we're taking.
+    #                   Only accepts the following actions:
+    #                   purchase, refund, preauth, status.
+    # params (Hash):    Variables to pass to NetRegistry
+    def verify_params(params = {})
+      success  = false
+      params = process_params(params)
+      case params[:COMMAND]
+      when "purchase"
+        @response.text, success = validate_purchase_params(params)
+      when "refund"
+        @response.text, success = validate_refund_params(params)
+      when "preauth"
+        @response.text, success = validate_preauth_params(params)
+      when "status"
+        @response.text, success = validate_status_params(params)
+      else
+        @response.text = "Invalid command. Only [purchase status preauth refund] are valid."
+        success        = false
+      end
+      @response.code   = 0  if success
+      @response.result = 0  if success
+      @response.status = "" if success
+
+      @response.success?
+    end
+
+    def create
+      @response
+    end
+
+    # parse HTTP request response body into a response object
+    # return factory itself.
+    # To get the response object, use #create method
+    def parse(response)
+      raise TypeError, "Response is not a string" if !response.is_a?(String)
+      @full_response = response.split("\n").map(&:strip)
+      if @full_response.first == "failed"
+        # remove all spaces until the dot
+        lines = @full_response.drop_while { |x| x != "." }
+        if lines.empty?
+          @response.text = @full_response[1]
+        else
+          lines.shift
+          lines[0].slice!("response_text=")
+          @response.text = lines[0]
+        end
+        @response.status = "failed"
+        @response.code   = -1
+      else
+        @full_response.each do |line|
+          data = line.split("=")
+          case data.first
+          when "card_number", "card_no"
+            @response.transaction.card.number = data[1]
+          when "response_text"
+            @response.text = data[1].to_s
+          when "amount", "total_amount"
+            @response.transaction.amount = data[1]
+          when "status"
+            @response.status = data[1]
+          when "txnref", "txn_ref"
+            @response.transaction.reference = data[1]
+          when "transaction_no"
+            @response.transaction.number = data[1]
+          when "bank_ref"
+            @response.transaction.bank_reference = data[1]
+          when "card_desc"
+            @response.transaction.card.description = data[1]
+          when "response_code"
+            @response.code = data[1]
+          when "card_type"
+            @response.transaction.card.type = data[1]
+          when "time"
+            @response.transaction.time = data[1]
+          when "command"
+            @response.transaction.command = data[1]
+          when "card_expiry"
+            @response.transaction.card.expiry = data[1]
+          when "result"
+            @response.result = data[1]
+          when "settlement_date"
+            @response.transaction.settlement_date = data[1]
+          when "rrn"
+            @response.transaction.rrn = data[1]
+          when "MID"
+            @response.transaction.merchant_id = data[1]
+          else
+          end
+        end
+        @receipt = @full_response.drop_while { |line| !line.include?("Reciept follows") }
+        if @receipt.include?("Reciept follows")
+          @receipt = @receipt[1...-2]
+          @response.transaction.receipt = @receipt.join("\n")
+        end
+      end
+
+      self
+    end
+
+    protected
+    # Preliminary validation for the purchase method
+    # Returns a Response Object
+    def validate_purchase_params(params)
+      if params[:AMOUNT].nil?   || params[:AMOUNT].empty?
+        return "AMOUNT not found", false
+      elsif params[:CCNUM].nil? || params[:CCNUM].empty?
+        return "CCNUM not found", false
+      elsif params[:CCEXP].nil? || params[:CCEXP].empty?
+        return "CCEXP not found", false
+      elsif !valid_expiry_format?(params[:CCEXP])
+        return "CCEXP invalid format", false
+      else
+        return "", true
+      end
+    end
+
+    def validate_refund_params(params)
+      if params[:AMOUNT].nil? || params[:AMOUNT].empty?
+        return "AMOUNT not found", false
+      elsif params[:TXNREF].nil? || params[:TXNREF].empty?
+        return "TXNREF not found", false
+      else
+        return "", true
+      end
+    end
+
+    def validate_preauth_params(params)
+      if params[:CCNUM].nil? || params[:CCNUM].empty?
+        return "CCNUM not found", false
+      elsif params[:CCEXP].nil? || params[:CCEXP].empty?
+        return "CCEXP not found", false
+      elsif !valid_expiry_format?(params[:CCEXP])
+        return "CCEXP invalid format", false
+      elsif params[:AMOUNT].nil? || params[:AMOUNT].empty?
+        return "AMOUNT not found", false
+      else
+        return "", true
+      end
+    end
+
+    def validate_status_params(params)
+      if params[:TXNREF].nil? || params[:TXNREF].empty?
+        return "TXNREF not found", false
+      else
+        return "", true
+      end
+    end
+
+
+    def valid_expiry_format?(card_expiry)
+      raise TypeError if !card_expiry.is_a?(String)
+      begin
+        Date.parse(card_expiry)
+        !NetRegistry::Helpers::EXPIRY_REGEX.match(card_expiry).nil?
+      rescue ArgumentError
+        false
+      end
+    end
+
+    # Pre-process parameters. In this instance, pre-process
+    # all parameters into strings, for easy params validation
+    def process_params(params)
+      params.each { |key, value| params[key] = value.to_s }
+    end
+  end
+
+end