px 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 50752bce2cd1db2c72c0b839fef08f4e510b1d52
+  data.tar.gz: 035c5445a531812d74b358ac36f845c8ead5146c
+SHA512:
+  metadata.gz: 44a4531f2f41b38911aade34f14993159f65ffbd90c3b1811df0a70375a06430d0207721b6c19ef3e13529c6df54cd8a0a24850c9a1bac00018eb7aa3b74470a
+  data.tar.gz: a641d4c79afb30cf14aa77625340f0696c02ddae092b8e23ccae51977dcf17cd3cb639f96d5cc05268edcc96cf6e3eea94b7cab6d502c91c69656372ddcbde66

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Cyril David
+
+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/Makefile

@@ -0,0 +1,9 @@
+test/px_test.rb: .PHONY
+	cutest test/px_test.rb
+
+test: test/px_test.rb
+
+test_integration:
+	TEST_INTEGRATION=1 cutest test/px_test.rb
+
+.PHONY:

data/README.md

@@ -0,0 +1,21 @@
+## PX: paymentexpress library
+
+```ruby
+
+    url = PX.request(...)
+    # redirect to the url / iframe target it
+
+    # get redirected to a URL with `result` parameter then
+    data = PX.response(response: result)
+
+    # you can now use this as your customer token
+    # if you want to charge the same card in the future
+    # for recurring and/or pay per use type scenarios.
+    data[:token]
+
+    # Sometime in the future:
+    PX.post(amount: 1, token: token)
+
+```
+
+### LICENSE: MIT

data/lib/px.rb

@@ -0,0 +1,207 @@
+require "hache"
+require "logger"
+require "mote"
+require "requests"
+require "xmlsimple"
+
+module PX
+  UID = ENV.fetch("PX_UID")
+  KEY = ENV.fetch("PX_KEY")
+
+  SUCCESS_URL = ENV.fetch("PX_SUCCESS_URL")
+  FAIL_URL = ENV.fetch("PX_FAIL_URL")
+
+  TYPES = [
+    TYPE_AUTH     = "Auth",
+    TYPE_PURCHASE = "Purchase",
+    TYPE_COMPLETE = "Complete",
+    TYPE_VALIDATE = "Validate",
+    TYPE_REFUND   = "Refund",
+  ]
+
+  def self.request(data)
+    Util.post(Request, data)
+  end
+
+  def self.response(data)
+    Util.post(Response, data)
+  end
+
+  def self.post(data)
+    Util.post(PxPost, data)
+  end
+
+  module Util
+    def self.post(strategy, data)
+      xml = strategy.build(data)
+
+      begin
+        response = Requests.request("POST", strategy::URL, data: xml)
+
+        strategy.parse(response.body)
+      rescue Requests::Error => err
+        log(:error, strategy.name, err.inspect)
+
+        return nil
+      end
+    end
+
+    def self.logger=(logger)
+      @logger = logger
+    end
+    @logger = Logger.new(STDERR)
+
+    def self.log(type, namespace, text)
+      @logger.send(type, "%s -- %s" % [namespace, text])
+    end
+  end
+
+  module Request
+    extend Mote::Helpers
+
+    XML = File.expand_path("../xml/request.xml", __FILE__)
+
+    # Endpoint for Request / Response related posts
+    URL = "https://sec.paymentexpress.com/pxpay/pxaccess.aspx"
+
+    # <Request valid="1">
+    #   <URI>https://sec.paymentexpress.com/pxmi3/XXXX</URI>
+    # </Request>
+    def self.parse(xml)
+      dict = XmlSimple.xml_in(xml, forcearray: false)
+
+      PX::Util.log(:info, self.name, dict.inspect)
+
+      if dict["valid"] == "1" && dict["URI"]
+        dict["URI"]
+      end
+    end
+
+    def self.build(data)
+      params = {
+        uid: UID,
+        key: KEY,
+
+        # = Required parameters with smart defaults:
+        currency: data.fetch(:currency, "USD"),
+
+        # == Optimized for Token Billing defaults
+        #    (AUTH and Amount = 1 only)
+        type: data.fetch(:type, TYPE_AUTH),
+        amount: data.fetch(:amount, "1"),
+
+        # = Optional parameters, but we make it mandatory
+        # in this library
+        email: data.fetch(:email),
+
+        # == Really optional (both in API and in lib)
+        ref: data.fetch(:ref, ""),
+        data1: data.fetch(:data1, ""),
+        data2: data.fetch(:data2, ""),
+        data3: data.fetch(:data3, ""),
+        txn_id: data.fetch(:txn_id, ""),
+
+        # == Given that we optimize for Token billing, we
+        #    default to `true`.
+        add_bill_card: data.fetch(:add_bill_card, true),
+
+        success_url: data.fetch(:success_url, SUCCESS_URL),
+        fail_url: data.fetch(:fail_url, FAIL_URL),
+
+        this: Hache,
+      }
+
+      mote(XML, params)
+    end
+  end
+
+  module Response
+    extend Mote::Helpers
+
+    XML = File.expand_path("../xml/response.xml", __FILE__)
+
+    # Endpoint for Request / Response related posts
+    URL = "https://sec.paymentexpress.com/pxpay/pxaccess.aspx"
+
+    def self.parse(xml)
+      dict = XmlSimple.xml_in(xml, forcearray: false)
+
+      PX::Util.log(:info, self.name, dict.inspect)
+
+      if dict["valid"] == "1" && dict["Success"] == "1"
+        # Provide a more agnostic term so outside code
+        # fetching it won't look too tied to PX.
+        dict[:token] = dict["DpsBillingId"]
+
+        return dict
+      end
+    end
+
+    def self.build(data)
+      params = {
+        uid: UID,
+        key: KEY,
+
+        # The only key we require for PX::Response
+        # is `response` which is obtained after
+        # a successful redirect with the `result`
+        # query string parameter.
+        #
+        response: data.fetch(:response),
+
+        this: Hache,
+      }
+
+      mote(XML, params)
+    end
+  end
+
+  module PxPost
+    extend Mote::Helpers
+
+    USERNAME = ENV.fetch("PX_USERNAME")
+    PASSWORD = ENV.fetch("PX_PASSWORD")
+
+    # PX Post endpoint; used in conjunction with DpsBillingId
+    # and the Token billing strategy.
+    URL = "https://sec.paymentexpress.com/pxpost.aspx"
+
+    XML = File.expand_path("../xml/post.xml", __FILE__)
+
+    def self.parse(xml)
+      dict = XmlSimple.xml_in(xml, forcearray: false)
+
+      PX::Util.log(:info, self.name, dict.inspect)
+
+      return unless data = dict["Transaction"]
+
+      if data["success"] == "1" && data["responseText"] == "APPROVED"
+        return data
+      end
+    end
+
+    def self.build(data)
+      params = {
+        uid: USERNAME,
+        key: PASSWORD,
+
+        # required parameters
+        amount: data.fetch(:amount),
+
+        # required, but with sane defaults.
+        currency: data.fetch(:currency, "USD"),
+        type: data.fetch(:type, TYPE_PURCHASE),
+
+        # mandatory recommendations even though
+        # they're optional in the API.
+        txn_id: data.fetch(:txn_id, ""),
+        ref: data.fetch(:ref, ""),
+        token: data.fetch(:token),
+
+        this: Hache,
+      }
+
+      mote(XML, params)
+    end
+  end
+end

data/lib/xml/post.xml

@@ -0,0 +1,10 @@
+<Txn>
+  <PostUsername>{{ uid }}</PostUsername>
+  <PostPassword>{{ key }}</PostPassword>
+  <Amount>{{ "%0.2f" % amount }}</Amount>
+  <InputCurrency>{{ currency }}</InputCurrency>
+  <TxnType>{{ type }}</TxnType>
+  <TxnId>{{ this.h(txn_id) }}</TxnId>
+  <MerchantReference>{{ this.h(ref) }}</MerchantReference>
+  <DpsBillingId>{{ this.h(token) }}</DpsBillingId>
+</Txn>

data/lib/xml/request.xml

@@ -0,0 +1,16 @@
+<GenerateRequest>
+  <PxPayUserId>{{ uid }}</PxPayUserId>
+  <PxPayKey>{{ key }}</PxPayKey>
+  <MerchantReference>{{ ref }}</MerchantReference>
+  <TxnType>{{ type }}</TxnType>
+  <AmountInput>{{ "%0.2f" % amount }}</AmountInput>
+  <CurrencyInput>{{ currency }}</CurrencyInput>
+  <TxnData1>{{ this.h(data1) }}</TxnData1>
+  <TxnData2>{{ this.h(data2) }}</TxnData2>
+  <TxnData3>{{ this.h(data3) }}</TxnData3>
+  <EmailAddress>{{ this.h(email) }}</EmailAddress>
+  <TxnId>{{ this.h(txn_id) }}</TxnId>
+  <EnableAddBillCard>{{ add_bill_card ? 1 : 0 }}</EnableAddBillCard>
+  <UrlSuccess>{{ success_url }}</UrlSuccess>
+  <UrlFail>{{ fail_url }}</UrlFail>
+</GenerateRequest>

data/lib/xml/response.xml

@@ -0,0 +1,5 @@
+<ProcessResponse>
+  <PxPayUserId>{{ uid }}</PxPayUserId>
+  <PxPayKey>{{ key }}</PxPayKey>
+  <Response>{{ response }}</Response>
+</ProcessResponse>

data/px.gemspec

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name = "px"
+  s.version = "0.0.1"
+  s.summary = "PX library"
+  s.description = "PaymentExpress 1.0 integration library"
+  s.authors = ["Cyril David"]
+  s.email = ["cyx@cyx.is"]
+  s.homepage = "http://cyx.is"
+  s.files = Dir[
+    "LICENSE",
+    "README*",
+    "Makefile",
+    "lib/*.rb",
+    "lib/xml/*.xml",
+    "*.gemspec",
+    "test/*.*",
+  ]
+
+  s.license = "MIT"
+
+  s.add_dependency "requests", "~> 1.0"
+  s.add_dependency "xml-simple", "~> 1.1"
+  s.add_dependency "mote", "~> 1.1"
+  s.add_dependency "hache", "~> 1.1"
+  s.add_development_dependency "cutest", "~> 1.2"
+end

data/test/px_test.rb

@@ -0,0 +1,140 @@
+require "cutest"
+require "securerandom"
+require "open-uri"
+
+ENV["PX_SUCCESS_URL"] = "http://openredis.com/"
+ENV["PX_FAIL_URL"] = "http://openredis.com/"
+
+require_relative "../lib/px"
+
+# This will hit the live URL, so you'll have to have
+# the proper UID / KEY to be able to test this properly.
+test "PX.request" do
+  data = {
+    email: "cyx@cyx.is",
+    txn_id: SecureRandom.hex(8),
+    ref: SecureRandom.hex(16),
+    type: PX::TYPE_AUTH,
+    amount: 1,
+    currency: "USD",
+    add_bill_card: true
+  }
+
+  # Since we're passing trash data, we expect it
+  # to not give us a URI response.
+  uri = URI(PX.request(data))
+
+  assert_equal "https", uri.scheme
+  assert_equal "sec.paymentexpress.com", uri.host
+
+  assert open(uri.to_s).read.include?("Credit Card Payment")
+
+end if ENV["TEST_INTEGRATION"]
+
+test "parse request (valid)" do
+  request = <<-EOT
+  <Request valid="1">
+    <URI>https://sec.paymentexpress.com/pxmi3/XXXX</URI>
+  </Request>
+  EOT
+
+  expected = "https://sec.paymentexpress.com/pxmi3/XXXX"
+
+  assert_equal expected, PX::Request.parse(request)
+end
+
+test "parse response (valid)" do
+  response = <<-EOT
+    <Response valid="1">
+      <Success>1</Success>
+      <TxnType>Purchase</TxnType>
+      <CurrencyInput>NZD</CurrencyInput>
+      <MerchantReference>Purchase Example</MerchantReference>
+      <TxnData1></TxnData1>
+      <TxnData2></TxnData2>
+      <TxnData3></TxnData3>
+      <AuthCode>113837</AuthCode>
+      <CardName>Visa</CardName>
+      <CardHolderName>CARDHOLDER NAME</CardHolderName>
+      <CardNumber>411111........11</CardNumber>
+      <DateExpiry>1111</DateExpiry>
+      <ClientInfo>192.168.1.111</ClientInfo>
+      <TxnId>P03E57DA8A9DD700</TxnId>
+      <EmailAddress></EmailAddress>
+      <DpsTxnRef>000000060495729b</DpsTxnRef>
+      <BillingId></BillingId>
+      <DpsBillingId></DpsBillingId>
+      <AmountSettlement>1.00</AmountSettlement>
+      <CurrencySettlement>NZD</CurrencySettlement>
+      <DateSettlement>20100924</DateSettlement>
+      <TxnMac>BD43E619</TxnMac>
+      <ResponseText>APPROVED</ResponseText>
+      <CardNumber2></CardNumber2>
+      <Cvc2ResultCode>M</Cvc2ResultCode>
+    </Response>
+  EOT
+
+  dict = PX::Response.parse(response)
+
+  assert dict.kind_of?(Hash)
+end
+
+test "response build" do
+  xml = PX::Response.build(response: "foo")
+
+  dict = XmlSimple.xml_in(xml, forcearray: false)
+
+  assert_equal PX::UID, dict["PxPayUserId"]
+  assert_equal PX::KEY, dict["PxPayKey"]
+  assert_equal "foo", dict["Response"]
+end
+
+test "response live" do
+  data = {
+    response: "00000100491234332513213fb881cc01"
+  }
+
+  # puts PX.response(data).inspect
+
+  assert_equal "0000010059278491", PX.response(data)[:token]
+end if ENV["TEST_INTEGRATION"]
+
+test "pxpost build" do
+  data = {
+    amount: 8,
+    currency: "SGD",
+    type: PX::TYPE_AUTH,
+    txn_id: "txn1234",
+    ref: "ref1234",
+    token: "tok1234",
+  }
+
+  dict = XmlSimple.xml_in(PX::PxPost.build(data), forcearray: false)
+
+  assert_equal PX::PxPost::USERNAME, dict["PostUsername"]
+  assert_equal PX::PxPost::PASSWORD, dict["PostPassword"]
+  assert_equal "8.00", dict["Amount"]
+  assert_equal "SGD", dict["InputCurrency"]
+  assert_equal PX::TYPE_AUTH, dict["TxnType"]
+  assert_equal "txn1234", dict["TxnId"]
+  assert_equal "ref1234", dict["MerchantReference"]
+  assert_equal "tok1234", dict["DpsBillingId"]
+end
+
+test "pxpost POST" do
+  data = {
+    amount: 8,
+    currency: "USD",
+    type: PX::TYPE_PURCHASE,
+    token: "0000010059278491"
+  }
+
+  dict = PX.post(data)
+
+  assert_equal "1", dict["success"]
+  assert_equal "APPROVED", dict["responseText"]
+  assert_equal "1", dict["Authorized"]
+  assert_equal "8.00", dict["Amount"]
+  assert_equal "USD", dict["CurrencyName"]
+
+end if ENV["TEST_INTEGRATION"]

metadata

@@ -0,0 +1,123 @@
+--- !ruby/object:Gem::Specification
+name: px
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Cyril David
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: requests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: mote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: hache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+description: PaymentExpress 1.0 integration library
+email:
+- cyx@cyx.is
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- Makefile
+- README.md
+- lib/px.rb
+- lib/xml/post.xml
+- lib/xml/request.xml
+- lib/xml/response.xml
+- px.gemspec
+- test/px_test.rb
+homepage: http://cyx.is
+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.2.2
+signing_key: 
+specification_version: 4
+summary: PX library
+test_files: []