payxml 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb58ae8d982e195dc9254b6e62ca101245acba03
+  data.tar.gz: 46164462e34eebf809e4dcb7878ec6b992b960a6
+SHA512:
+  metadata.gz: c8b215d4282214c51359b931724efc40fabd5fd9d9c62ef2c573e038971b1fd7b41b4a602937128382286d89880dd722218923fa49f33c4d7c9bd6b626003ea5
+  data.tar.gz: d13ffcf41a21f034be757ef76117221b45f5652ca96dcf15edb4e18ad7ce42717174c80a88683ab5f74920b2f53edb76ceaa9ccbd8335e61328421cc02834027

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at duplessis.nico@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in payxml.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nico du Plessis
+
+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,58 @@
+[![Build Status](https://travis-ci.org/nduplessis/payxml.svg?branch=master)](https://travis-ci.org/nduplessis/payxml)
+
+# PayXML
+
+PayXML is an easy use wrapper for the the PayGate PayXML payment gateway API.
+
+https://www.paygate.co.za
+
+Compatible with:
+- `PayXML 4.0`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'payxml'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install payxml
+
+## Usage
+
+### Test vs Production
+
+### Example
+
+```ruby
+require 'payxml'
+
+payxml = PayXML::PayXML.new( '10011013800', 'test' )
+response = payxml.authorise({customer_name: 'John Doe', customer_reference: 'customer ref 1', credit_card_number: '4000000000000002', expiry_date: '122018', cvv: '123', amount: '30020', currency: 'ZAR', notify_callback_url: 'http://mysite.dev/notify', response_url: 'http://mysite.dev/order-complete'})
+
+if response.requires_secure_redirect?
+  # redirect to response.secure_redirect_url
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nduplessis/payxml. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "payxml"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/payxml.rb

@@ -0,0 +1,73 @@
+require "payxml/version"
+require "payxml/result_codes"
+require "payxml/credit_card_types"
+require "payxml/message"
+require "payxml/error"
+require "payxml/auth"
+require "nokogiri"
+require 'digest'
+require 'net/http'
+
+module PayXML
+  class PayXML
+    # PayXML API version number
+    PAYXML_VERSION_NUMBER = '4.0'
+
+    PAYXML_URL = 'https://www.paygate.co.za/payxml/process.trans'
+
+    def initialize(paygate_id, paygate_password)
+      @paygate_id = paygate_id
+      @paygate_password = paygate_password
+    end
+
+    def authorise(options = {})
+      authtx = Auth::Request.new(@paygate_id, @paygate_password)
+      authtx.customer_reference = options[:customer_reference]
+      authtx.customer_name = options[:customer_name]
+      authtx.credit_card_number = options[:credit_card_number]
+      authtx.expiry_date = options[:expiry_date]
+      authtx.currency = options[:currency]
+      authtx.amount = options[:amount]
+      authtx.cvv = options[:cvv]
+
+      authtx.customer_ip_address = options[:customer_ip_address]
+      authtx.notify_callback_url = options[:notify_callback_url]
+      authtx.response_url = options[:response_url]
+
+      response = post_request_body(authtx.xml_string)
+
+      if !(response.body =~ /errorrx/i).nil?
+        response_object = Error.allocate
+        response_object.parse(response.body)
+      else
+        response_object = Auth::Response.allocate
+        response_object.parse(response.body)
+      end
+
+      response_object
+    end
+
+    def self.checksum(values=[])
+      md5 = Digest::MD5.new
+      md5 << values.map { |i| i.to_s }.join("|")
+      md5.hexdigest
+    end
+
+    protected
+    def post_request_body(xml_body)
+      uri = URI.parse PAYXML_URL
+      request = Net::HTTP::Post.new uri.path
+      request.body = xml_body
+      request.content_type = 'text/xml'
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      response = http.request(request)
+
+      response
+    end
+
+    def validate_response
+    end
+
+  end
+end

data/lib/payxml/auth.rb

@@ -0,0 +1,111 @@
+module PayXML
+  module Auth
+    class Request < Message
+      attr_accessor :customer_name
+      attr_accessor :customer_reference
+      attr_accessor :budget_period
+      attr_accessor :amount
+      attr_accessor :currency
+      attr_accessor :bno
+      attr_accessor :credit_card_number
+      attr_accessor :cvv
+      attr_accessor :expiry_date
+      attr_accessor :customer_ip_address
+      attr_accessor :notify_callback_url
+      attr_accessor :response_url
+
+      def initialize(paygate_id, paygate_password)
+        super(paygate_id, paygate_password)
+
+        @budget_period = 0
+        @bno = ''
+      end
+
+      def parse(xml_string)
+        super(xml_string)
+
+        doc = Nokogiri::XML(xml_string)
+        authtx = doc.xpath("//authtx").first
+        self.customer_reference = authtx['cref'] unless authtx['cref'].nil?
+        # self.customer_name = authtx['cname']
+        # self.credit_card_number = authtx['cc']
+        # self.expiry_date = authtx['exp']
+        # self.cvv = authtx['cvv']
+        # self.budget_period = authtx['budp']
+        # self.currency = authtx['cur']
+      end
+
+      protected
+      def xml_doc
+        doc = super
+        protocol = doc.xpath("//protocol").first
+        authtx = Nokogiri::XML::Node.new "authtx", doc
+
+        # Required values
+        authtx['cref'] = self.customer_reference
+        authtx['cname'] = self.customer_name
+        authtx['cc'] = self.credit_card_number
+        authtx['exp'] = self.expiry_date
+        authtx['cur'] = self.currency
+        authtx['amt'] = self.amount.to_s
+        authtx['budp'] = self.budget_period.to_s
+        authtx['bno'] = self.bno
+        authtx['cvv'] = self.cvv
+
+        # Optional values for 3D sercure auth
+        authtx['ip'] = self.customer_ip_address unless self.customer_ip_address.nil?
+        authtx['nurl'] = self.notify_callback_url unless self.notify_callback_url.nil?
+        authtx['rurl'] = self.response_url unless self.response_url.nil?
+
+        protocol.add_child(authtx)
+
+        doc
+      end
+    end
+
+    class Response < Message
+      attr_reader :customer_reference
+      attr_reader :transaction_id
+      attr_reader :card_type
+      attr_reader :bno
+      attr_reader :result_description
+      attr_reader :result_code
+      attr_reader :transaction_status_description
+      attr_reader :transaction_status
+      attr_reader :authorisation_code
+      attr_reader :risk
+      attr_reader :secure_redirect_url
+      attr_reader :secure_checksum
+
+      def requires_secure_redirect?
+        !self.secure_redirect_url.nil?
+      end
+
+      def parse(xml_string)
+        super(xml_string)
+
+        doc = Nokogiri::XML(xml_string)
+        authrx = doc.xpath("//authrx").first
+        securerx = doc.xpath("//securerx").first
+        if !authrx.nil?
+          @customer_reference = authrx['cref'] unless authrx['cref'].nil?
+          @transaction_id = authrx['tid'] unless authrx['tid'].nil?
+          @card_type = authrx['ctype'] unless authrx['ctype'].nil?
+          @transaction_status = authrx['stat'] unless authrx['stat'].nil?
+          @transaction_status_description = authrx['sdesc'] unless authrx['sdesc'].nil?
+          @bno = authrx['bno'] unless authrx['bno'].nil?
+          @result_code = authrx['res'] unless authrx['res'].nil?
+          @result_description = authrx['rdesc'] unless authrx['rdesc'].nil?
+          @authorisation_code = authrx['auth'] unless authrx['auth'].nil?
+          @risk = authrx['risk'] unless authrx['risk'].nil?
+        elsif !securerx.nil?
+          @customer_reference = securerx['cref'] unless securerx['cref'].nil?
+          @transaction_id = securerx['tid'] unless securerx['tid'].nil?
+          @secure_redirect_url = securerx['url'] unless securerx['url'].nil?
+          @secure_checksum = securerx['chk'] unless securerx['chk'].nil?
+        end
+      end
+    end
+
+  end
+end

data/lib/payxml/credit_card_types.rb

@@ -0,0 +1,9 @@
+module PayXML
+  CREDIT_CARD_TYPES = {
+    :unknown => 0,
+    :visa => 1,
+    :master_card => 2,
+    :american_express => 3,
+    :diners_club => 4,
+  }
+end

data/lib/payxml/error.rb

@@ -0,0 +1,30 @@
+module PayXML
+
+  ##
+  # Wraps an error message from the API.
+  class Error < Message
+    attr_reader :code
+    attr_reader :description
+
+    def parse(xml_string)
+      super(xml_string)
+
+      doc = Nokogiri::XML(xml_string)
+      errorrx = doc.xpath("//errorrx").first
+
+      @code = errorrx['ecode']
+      @description = errorrx['edesc']
+    end
+
+    protected
+    def xml_doc
+      doc = super
+
+      protocol = doc.xpath("//protocol").first
+      errorrx = Nokogiri::XML::Node.new "errorrx", doc
+      protocol.add_child(errorrx)
+
+      doc
+    end
+  end
+end

data/lib/payxml/message.rb

@@ -0,0 +1,45 @@
+module PayXML
+
+  ##
+  # This class represents the base class for all XML message payloads used
+  # for the PayXML API.
+
+  class Message
+    attr_accessor :paygate_id
+    attr_accessor :paygate_password
+
+    PAYXML_VERSION_NUMBER = '4.0'
+
+    def initialize( paygate_id, paygate_password )
+      self.paygate_id = paygate_id
+      self.paygate_password = paygate_password
+    end
+
+    def parse(xml_string)
+      doc = Nokogiri::XML(xml_string)
+      protocol = doc.xpath("//protocol").first
+      self.paygate_id = protocol['pgid']
+      self.paygate_password = protocol['pwd']
+    end
+
+    def xml_string
+      xml_doc.to_s
+    end
+
+    protected
+
+    def xml_doc
+      doc = Nokogiri::XML::Document.new
+
+      protocol = Nokogiri::XML::Node.new "protocol", doc
+      protocol['ver'] = PAYXML_VERSION_NUMBER
+      protocol['pgid'] = self.paygate_id
+      protocol['pwd'] = self.paygate_password
+
+      doc << protocol
+
+      doc
+    end
+  end
+
+end

data/lib/payxml/protocol.rb

@@ -0,0 +1,9 @@
+module PayXML
+  class Protocol
+    attr_accessor :paygate_id
+    attr_accessor :password
+
+    def to_s
+    end
+  end
+end

data/lib/payxml/result_codes.rb

@@ -0,0 +1,13 @@
+module PayXML
+  RESULT_CODES = {
+    :call_for_approval => 900001,
+    :card_expired => 900002,
+    :insufficient_funds => 900003,
+    :invalid_card_number => 900004,
+    :bank_interface_timeout => 900005,
+    :invalid_card => 900006,
+    :declined => 900007,
+    :lost_card => 900009,
+    :invalid_card_length => 900010,
+  }
+end

data/lib/payxml/version.rb

@@ -0,0 +1,3 @@
+module PayXML
+  VERSION = "0.1.0"
+end

data/payxml.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'payxml/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "payxml"
+  spec.version       = PayXML::VERSION
+  spec.authors       = ["Nico du Plessis"]
+  spec.email         = ["duplessis.nico@gmail.com"]
+
+  spec.summary       = %q{A wrapper for the PayGate PayXML API.}
+  spec.description   = %q{PayXML is an easy use wrapper for the the PayGate PayXML payment gateway API.}
+  spec.homepage      = "https://github.com/nduplessis/payxml"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-mocks"
+  spec.add_development_dependency "nokogiri"
+end

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: payxml
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nico du Plessis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-02-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: PayXML is an easy use wrapper for the the PayGate PayXML payment gateway
+  API.
+email:
+- duplessis.nico@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/payxml.rb
+- lib/payxml/auth.rb
+- lib/payxml/credit_card_types.rb
+- lib/payxml/error.rb
+- lib/payxml/message.rb
+- lib/payxml/protocol.rb
+- lib/payxml/result_codes.rb
+- lib/payxml/version.rb
+- payxml.gemspec
+homepage: https://github.com/nduplessis/payxml
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: A wrapper for the PayGate PayXML API.
+test_files: []