payline 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4c3ea74c226badf6cd8c31dbd2faccf27f5bafcf
+  data.tar.gz: ab1f60398460581a2cb58910eff54725e96ab120
+SHA512:
+  metadata.gz: aaac69b5549f2fca3a60878d00f36b6ebba837a97f89decdd5fe14c70a79ba5f2d7556be18a20489ae8c84afbe0f0ef7baad945bfa679148d5e5e749be0114f2
+  data.tar.gz: ced66d4ecce5c4436166de4b98920c0288dd66c5ae27dc804ee49c2c31145bed3b00fc75f8f33143b995f5a885e5878481163a06ac6223d6e7dfe7935586582d

data/.editorconfig

@@ -0,0 +1,21 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# Change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# We recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test.rb

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 FireWorks Innovation
+
+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,80 @@
+Payline Api for Ruby
+=========================
+
+Wrapper around the Payline Api.
+
+[Payline](http://www.payline.co.za/) allows you to proccess credit cards.
+
+
+Contents
+--------
+
+- [How to Install](#how-to-install)
+- [Configuration](#configuration)
+- [Usage](#usage)
+
+How to Install
+--------------
+
+Add this line to your application's Gemfile:
+
+    gem 'payline'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install payline
+
+
+## Configuration
+
+The best would be to place this in `config/initializers/payline.rb`
+
+```ruby
+Payline.configure do |c|
+  c.company_name = 'Company Name'
+  c.contact_email = 'test@test.com'
+
+  c.sender = "sender_id"
+  c.secret = "secret"
+  c.user_login = "login"
+  c.user_password = "password"
+  c.transaction_mode = "INTEGRATOR_TEST"
+  c.channel  = "channel_id"
+end
+```
+
+## Basic usage
+
+```ruby
+client = Payline.client
+guid = SecureRandom.uuid
+amount = "1.00"
+
+card = {
+  account_type: 'MASTER', # VISA
+  card_number: '1234 1234 1234 1234',
+  expiry_year: '2015',
+  expiry_month: '01',
+  card_holder: 'Mr Y Name',
+  cvv: '123'
+}
+
+# Reponse can be used in subsequent calls
+response = client.reserve(guid, amount, card)
+
+client.reverse(response, amount)
+
+client.capture(response, amount)
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/fireworksinnovation/payline-ruby/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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/payline.rb

@@ -0,0 +1,35 @@
+require 'net/http'
+require 'net/https'
+require 'json'
+
+require 'payline/version'
+require 'payline/urls'
+require 'payline/exceptions'
+require 'payline/response_handler'
+require 'payline/configuration'
+require 'payline/reserve_response'
+require 'payline/client'
+
+
+
+module Payline
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.client
+    Client.new(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/payline/client.rb

@@ -0,0 +1,87 @@
+module Payline
+  class Client
+
+    def initialize(config)
+      @config = config
+      @response_handler = Payline::ResponseHandler.new
+    end
+
+    def reserve(guid, amount, credit_card)
+      params = {
+          'PAYMENT.CODE' => "CC.PA",
+          'PRESENTATION.AMOUNT' => amount,
+          'PRESENTATION.CURRENCY' => @config.currency,
+
+          'ACCOUNT.BRAND' => credit_card[:account_type],
+          'ACCOUNT.NUMBER' => credit_card[:card_number],
+          'ACCOUNT.EXPIRY_MONTH' => credit_card[:expiry_month],
+          'ACCOUNT.EXPIRY_YEAR' => credit_card[:expiry_year],
+          'ACCOUNT.HOLDER' => credit_card[:card_holder],
+          'ACCOUNT.VERIFICATION' => credit_card[:cvv],
+
+          'NAME.COMPANY' => @config.company_name,
+          'CONTACT.EMAIL' => @config.contact_email,
+
+          # need to be here but currently not being passed in
+          'ADDRESS.STREET' => 'na',
+          'ADDRESS.ZIP' => 'na',
+          'ADDRESS.CITY' => 'na',
+          'ADDRESS.STATE' => 'na',
+          'ADDRESS.COUNTRY' => 'ZA',
+
+      }
+      hash = do_request(params)
+      merchant_id = hash['IDENTIFICATION.TRANSACTIONID']
+      ref_id = hash['IDENTIFICATION.UNIQUEID']
+      Payline::ReserveResponse.new(merchant_id, ref_id)
+    end
+
+    def capture(reserve_response, amount)
+      params = {
+          'PRESENTATION.CURRENCY' => @config.currency,
+          'PAYMENT.CODE' => "CC.CP",
+          'PRESENTATION.AMOUNT' => amount,
+          'IDENTIFICATION.TRANSACTIONID'=>reserve_response.merchant_reference,
+          'IDENTIFICATION.REFERENCEID'=> reserve_response.transaction_id
+      }
+      do_request(params)
+    end
+
+    def reverse(reserve_response, amount)
+      params = {
+          'PRESENTATION.CURRENCY' => @config.currency,
+          'PAYMENT.CODE' => "CC.RV",
+          'PRESENTATION.AMOUNT' => amount,
+          'IDENTIFICATION.TRANSACTIONID'=> reserve_response.merchant_reference,
+          'IDENTIFICATION.REFERENCEID'=> reserve_response.transaction_id
+      }
+      do_request(params)
+    end
+
+    private
+
+    def do_request(params)
+      uri = URI(Payline::Urls::PAYMENT)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      req = Net::HTTP::Post.new(uri.path)
+      request_data = params.merge(basic_auth)
+      req.set_form_data(request_data)
+      res = http.request(req)
+      hash = @response_handler.parse_and_handle_errors(res.body)
+      hash
+    end
+
+    def basic_auth
+      {
+        'SECURITY.SENDER' => @config.sender,
+        'TRANSACTION.CHANNEL' => @config.channel,
+        'TRANSACTION.MODE' => @config.transaction_mode,
+        'USER.LOGIN' => @config.user_login,
+        'USER.PWD' => @config.user_password,
+        'TRANSACTION.RESPONSE'=>'SYNC'
+      }
+    end
+
+  end
+ end

data/lib/payline/configuration.rb

@@ -0,0 +1,17 @@
+module Payline
+  class Configuration
+    attr_accessor :sender
+    attr_accessor :user_login
+    attr_accessor :user_password
+    attr_accessor :secret
+    attr_accessor :transaction_mode
+    attr_accessor :channel
+    attr_accessor :currency
+    attr_accessor :company_name
+    attr_accessor :contact_email
+
+    def initialize
+      @currency = "ZAR"
+    end
+  end
+end

data/lib/payline/exceptions.rb

@@ -0,0 +1,3 @@
+module Payline
+  class Error < StandardError; end
+end

data/lib/payline/reserve_response.rb

@@ -0,0 +1,11 @@
+module Payline
+  class ReserveResponse
+    attr_reader :merchant_reference
+    attr_reader :transaction_id
+
+    def initialize(merchant_reference, transaction_id)
+      @merchant_reference = merchant_reference
+      @transaction_id = transaction_id
+    end
+  end
+end

data/lib/payline/response_handler.rb

@@ -0,0 +1,26 @@
+module Payline
+  class ResponseHandler
+
+    def parse(text)
+      # CGI by default returns an hash of arrays even if there is one element (is is the norm)
+      hash = CGI::parse(text)
+      hash.each {|k, v|
+        hash[k] = v.length == 1 ? v.first : v
+      }
+      hash
+    end
+
+    def parse_and_handle_errors(text)
+      hash = parse(text)
+      handle_errors(hash)
+      hash
+    end
+
+    def handle_errors(hash)
+      if hash['PROCESSING.REASON.CODE'].to_s != '00'
+        # Error message should be friendly
+        raise Payline::Error.new(hash['PROCESSING.RETURN'])
+      end
+    end
+  end
+end

data/lib/payline/urls.rb

@@ -0,0 +1,5 @@
+module Payline
+  module Urls
+    PAYMENT = "https://ctpe.net/frontend/ExecutePayment"
+  end
+end

data/lib/payline/version.rb

@@ -0,0 +1,3 @@
+module Payline
+  VERSION = "0.0.1"
+end

data/payline.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'payline/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "payline"
+  spec.version       = Payline::VERSION
+  spec.authors       = ["David Rubin"]
+  spec.email         = ["david@fireid.com"]
+  spec.summary       = %q{Wrapper around Payline http post api}
+  spec.description   = %q{Wrapper around Payline http post api}
+  spec.homepage      = "https://github.com/fireworksinnovation/payline"
+  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.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 2.9.0'
+end

data/spec/response_parser_spec.rb

@@ -0,0 +1,39 @@
+require 'spec_helper'
+
+describe Payline::ResponseHandler do
+  before do
+    @response = Payline::ResponseHandler.new
+  end
+
+  it 'Can parse out text' do
+    data = "PROCESSING.RISK_SCORE=0&P3.VALIDATION=ACK&CLEARING.DESCRIPTOR=7092.5040.4626&TRANSACTION.CHANNEL=8a8394c3461960d701461ac26f1c071f&PROCESSING.REASON.CODE=00&ADDRESS.CITY=na&PROCESSING.CODE=CC.PA.90.00&FRONTEND.REQUEST.CANCELLED=false&PROCESSING.REASON=Successful+Processing&FRONTEND.MODE=DEFAULT&CLEARING.FXSOURCE=INTERN&CLEARING.AMOUNT=1.00&PROCESSING.RESULT=ACK&NAME.SALUTATION=NONE&POST.VALIDATION=ACK&CONTACT.EMAIL=test%40test.com&CLEARING.CURRENCY=ZAR&FRONTEND.SESSION_ID=&PROCESSING.STATUS.CODE=90&PRESENTATION.CURRENCY=ZAR&PAYMENT.CODE=CC.PA&PROCESSING.RETURN.CODE=000.100.110&CONTACT.IP=10.3.20.38&PROCESSING.STATUS=NEW&FRONTEND.CC_LOGO=images%2Fvisa_mc.gif&PRESENTATION.AMOUNT=1.00&IDENTIFICATION.UNIQUEID=8a839482461e719d01461eb59f784012&IDENTIFICATION.SHORTID=7092.5040.4626&CLEARING.FXRATE=1.0&PROCESSING.TIMESTAMP=2014-05-21+12%3A15%3A57&ADDRESS.COUNTRY=ZA&ADDRESS.STATE=na&RESPONSE.VERSION=1.0&TRANSACTION.MODE=INTEGRATOR_TEST&TRANSACTION.RESPONSE=SYNC&PROCESSING.RETURN=Request+successfully+processed+in+%27Merchant+in+Integrator+Test+Mode%27&ADDRESS.STREET=na&CLEARING.FXDATE=2014-05-21+12%3A15%3A57&ADDRESS.ZIP=na\r\n"
+    hash = @response.parse(data)
+    hash['PROCESSING.REASON.CODE'].should eq('00')
+    hash['PROCESSING.RISK_SCORE'].should eq('0')
+    hash['P3.VALIDATION'].should eq('ACK')
+    hash['FRONTEND.REQUEST.CANCELLED'].should eq('false')
+  end
+
+  it 'Can handle errors' do
+    hash = {
+      'PROCESSING.REASON.CODE'=> '1234',
+      'PROCESSING.RETURN'=> 'This is the error'
+    }
+    expect{@response.handle_errors(hash)}.to raise_error(Payline::Error)
+    expect{@response.handle_errors(hash)}.to raise_error('This is the error')
+  end
+
+   it 'Can deal with success' do
+    hash = {
+      'PROCESSING.REASON.CODE'=> '00',
+      'PROCESSING.RETURN'=> 'Successful'
+    }
+    @response.handle_errors(hash)
+  end
+
+  it 'Parses and checks' do
+    data = 'PROCESSING.REASON.CODE=00&PROCESSING.RETURN=Successful&NOMATTER=nomatter'
+    hash = @response.parse_and_handle_errors(data)
+    hash['NOMATTER'].should eq('nomatter')
+  end
+end

data/spec/results.txt

@@ -0,0 +1,8 @@
+failed
+
+
+TRANSACTION.CHANNEL=8a8394c3461960d701461ac26f1c071f&PRESENTATION.CURRENCY=ZAR&IDENTIFICATION.UNIQUEID=8a839486461e719e01461eaedb2f27cd&PAYMENT.CODE=CC.PA&FRONTEND.CC_LOGO=images%2Fvisa_mc.gif&PROCESSING.STATUS=REJECTED_VALIDATION&ADDRESS.STREET=na&CONTACT.IP=10.3.20.36&FRONTEND.MODE=DEFAULT&FRONTEND.REQUEST.CANCELLED=false&PROCESSING.RETURN=invalid+credit+card+brand&PROCESSING.REASON=Account+Validation&ADDRESS.STATE=na&PROCESSING.STATUS.CODE=70&TRANSACTION.MODE=INTEGRATOR_TEST&POST.VALIDATION=ACK&CONTACT.EMAIL=fireworks-services%40fireid.com&PROCESSING.TIMESTAMP=2014-05-21+12%3A08%3A34&ADDRESS.CITY=na&PROCESSING.RETURN.CODE=100.100.501&RESPONSE.VERSION=1.0&TRANSACTION.RESPONSE=SYNC&P3.VALIDATION=ACK&PROCESSING.CODE=CC.PA.70.40&FRONTEND.SESSION_ID=&PROCESSING.REASON.CODE=40&IDENTIFICATION.SHORTID=8838.6766.8754&NAME.SALUTATION=NONE&PROCESSING.RESULT=NOK&PRESENTATION.AMOUNT=1.00&ADDRESS.COUNTRY=ZA&ADDRESS.ZIP=na\r\n
+
+
+SUCCESS
+PROCESSING.RISK_SCORE=0&P3.VALIDATION=ACK&CLEARING.DESCRIPTOR=7092.5040.4626&TRANSACTION.CHANNEL=8a8394c3461960d701461ac26f1c071f&PROCESSING.REASON.CODE=00&ADDRESS.CITY=na&PROCESSING.CODE=CC.PA.90.00&FRONTEND.REQUEST.CANCELLED=false&PROCESSING.REASON=Successful+Processing&FRONTEND.MODE=DEFAULT&CLEARING.FXSOURCE=INTERN&CLEARING.AMOUNT=1.00&PROCESSING.RESULT=ACK&NAME.SALUTATION=NONE&POST.VALIDATION=ACK&CONTACT.EMAIL=fireworks-services%40fireid.com&CLEARING.CURRENCY=ZAR&FRONTEND.SESSION_ID=&PROCESSING.STATUS.CODE=90&PRESENTATION.CURRENCY=ZAR&PAYMENT.CODE=CC.PA&PROCESSING.RETURN.CODE=000.100.110&CONTACT.IP=10.3.20.38&PROCESSING.STATUS=NEW&FRONTEND.CC_LOGO=images%2Fvisa_mc.gif&PRESENTATION.AMOUNT=1.00&IDENTIFICATION.UNIQUEID=8a839482461e719d01461eb59f784012&IDENTIFICATION.SHORTID=7092.5040.4626&CLEARING.FXRATE=1.0&PROCESSING.TIMESTAMP=2014-05-21+12%3A15%3A57&ADDRESS.COUNTRY=ZA&ADDRESS.STATE=na&RESPONSE.VERSION=1.0&TRANSACTION.MODE=INTEGRATOR_TEST&TRANSACTION.RESPONSE=SYNC&PROCESSING.RETURN=Request+successfully+processed+in+%27Merchant+in+Integrator+Test+Mode%27&ADDRESS.STREET=na&CLEARING.FXDATE=2014-05-21+12%3A15%3A57&ADDRESS.ZIP=na\r\n

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'bundler/setup'
+# our gem
+require 'payline'
+
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: payline
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- David Rubin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.9.0
+description: Wrapper around Payline http post api
+email:
+- david@fireid.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .editorconfig
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/payline.rb
+- lib/payline/client.rb
+- lib/payline/configuration.rb
+- lib/payline/exceptions.rb
+- lib/payline/reserve_response.rb
+- lib/payline/response_handler.rb
+- lib/payline/urls.rb
+- lib/payline/version.rb
+- payline.gemspec
+- spec/response_parser_spec.rb
+- spec/results.txt
+- spec/spec_helper.rb
+homepage: https://github.com/fireworksinnovation/payline
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Wrapper around Payline http post api
+test_files:
+- spec/response_parser_spec.rb
+- spec/results.txt
+- spec/spec_helper.rb