payu_za 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f79cdfe7ab276c4aa7cdc7845567507ba5abe271
+  data.tar.gz: 8e19b1e54cca1952fe60dd8bbfc3dcd51a89fc49
+SHA512:
+  metadata.gz: 9d770bc328474caf38da34f830de867ed05310b9822fc78d67d4a7b83e4dfeab8cf1702f5ecc5152438146f333fb2e171e90ae37ae739c0d8664aa256053cee8
+  data.tar.gz: ce12d5a2c97fd7f68f25f939b19d4939e2466a1ef71ff51b43d587c844dc3cb89525c9f7a01e5525d676844a009380112d91fa354a4b025c4f96f77523127c36

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in payu_za.gemspec
+gemspec
+
+group :test do
+  gem 'guard-rspec', '~> 4.5.2'
+  gem 'pry-byebug'
+end

data/Guardfile

@@ -0,0 +1,16 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Stan Bondi
+
+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,91 @@
+# PayuZa
+
+PayU ZA Enterprise SOAP API integration
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'payu_za'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install payu_za
+
+## Usage
+
+### Initializer
+
+```ruby
+PayUZa.configure do |c|
+  c.soap_username = ENV['PAYU_SOAP_USERNAME']
+  c.soap_password = ENV['PAYU_SOAP_PASSWORD']
+  c.safe_key = ENV['PAYU_SAFE_KEY']
+  # Be sure to set your environment to :production in prod - defaults to :staging
+  c.environment = :production # or :staging or Rails.env.to_sym
+
+  # Other configuration
+  # Set the default api version (can be overriden per request)
+  # c.api_version = "ONE_ZERO"
+  #
+  # Set password_digest to true to prevent your password being sent in clear text
+  # Defaults to false because not sure if PayU supports wsse password digest
+  # c.password_digest = true
+  #
+  # Set your own wsdls - not sure why anyone would ever need this
+  # c.wsdl_endpoints = {
+  #    development: 'https://localhost:12345/?wsdl',
+  #    production: 'https://my-proxy.com/wsdl'
+  # }
+end
+```
+
+### DoTransaction Example
+
+```ruby
+client = PayUZa::Client.new
+
+additional_info = client.new_struct(:additional_information, {
+  merchantReference: '12345',
+  payUReference: 'abcdefg1234'
+})
+
+transaction = client.new_struct(:do_transaction, {
+  TransactionType: PayUZa::Structs::TRANSACTION_TYPE::PAYMENT,
+  AuthenticationType: PayUZa::Structs::AUTHENTICATION_TYPE::NA,
+  AdditionalInformation: additional_info
+  # etc ...
+})
+
+# Object style
+creditcard = client.new_struct(:credit_card)
+creditcard.cardNumber = '4242424242424242'
+creditcard.cardExpiry = '122013'
+
+transaction.Creditcard = creditcard
+
+response = client.execute(transaction)
+# or you can pass in a hash
+response = client.execute(:do_transaction, {
+  Api: 'ONE_ZERO',
+  SafeKey: '12345'
+  # ...
+})
+
+```
+
+Supports `do_transaction`, `set_transaction` and `get_transaction`
+
+## Contributing
+
+1. Fork it ( https://github.com/fixate/payu_za/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/payu_za/client.rb

@@ -0,0 +1,45 @@
+module PayuZa
+  class Client
+    def operations
+      client.operations
+    end
+
+    # execute(:method, {my: 'message'}|Struct)
+    # or
+    # execute(Struct)
+    def execute(*args)
+      if args.length > 1
+        operation_name, struct = args
+      else
+        struct = args.first
+        operation_name = struct.operation_name
+      end
+
+      message = struct.respond_to?(:to_hash) ? struct.to_hash : struct
+
+      client.call(operation_name, message: message)
+    end
+
+    def new_struct(name, attributes = {})
+      klass = name.to_s.camelize
+      "PayuZa::Structs::#{klass}".constantize.create(attributes)
+    end
+
+    def request(name, struct)
+      client.operation(name).request(message: struct.to_hash)
+    end
+
+    def client
+      @client ||= Savon.client(
+        wsdl: PayuZa.wsdl_endpoint,
+        wsse_auth: wsse_auth
+      )
+    end
+
+    private
+
+    def wsse_auth
+      [PayuZa.soap_username, PayuZa.soap_password, PayuZa.password_digest]
+    end
+  end
+end

data/lib/payu_za/errors.rb

@@ -0,0 +1,10 @@
+module PayuZa
+  class StructNotValidError < StandardError
+    attr_reader :var_name
+
+    def initialize(var_name, message)
+      @message = "#{var_name} #{message}"
+      @var_name = var_name
+    end
+  end
+end

data/lib/payu_za/structs/additional_information.rb

@@ -0,0 +1,12 @@
+module PayuZa
+  module Structs
+    class AdditionalInformation
+      include StructModel
+
+      field :merchantReference, required: true
+      field :payUReference
+      field :demoMode
+      field :notificationUrl
+    end
+  end
+end

data/lib/payu_za/structs/basket.rb

@@ -0,0 +1,11 @@
+module PayuZa
+  module Structs
+    class Basket
+      include StructModel
+
+      field :description, required: true
+      field :amountInCents, required: true
+      field :currencyCode, required: true
+    end
+  end
+end

data/lib/payu_za/structs/credit_card.rb

@@ -0,0 +1,15 @@
+module PayuZa
+  module Structs
+    class CreditCard
+      include StructModel
+
+      field :pmId
+      field :cardNumber
+      field :cardExpiry
+      field :cvv
+      field :nameOnCard
+      field :budgetPeriod
+      field :amountInCents, required: true
+    end
+  end
+end

data/lib/payu_za/structs/custom_field.rb

@@ -0,0 +1,10 @@
+module PayuZa
+  module Structs
+    class CustomField
+      include StructModel
+
+      field :key, required: true
+      field :value, default: ''
+    end
+  end
+end

data/lib/payu_za/structs/customer.rb

@@ -0,0 +1,15 @@
+module PayuZa
+  module Structs
+    class Customer
+      include StructModel
+
+      field :firstName
+      field :lastName
+      field :regionalId
+      field :mobile
+      field :email
+      field :merchantUserId
+      field :DOB
+    end
+  end
+end

data/lib/payu_za/structs/do_transaction.rb

@@ -0,0 +1,5 @@
+module PayuZa
+  module Structs
+    class DoTransaction < Transaction; end
+  end
+end

data/lib/payu_za/structs/get_transaction.rb

@@ -0,0 +1,12 @@
+module PayuZa
+  module Structs
+    class GetTransaction
+      include StructModel
+
+      field :Api, default: 'ONE_ZERO'
+      field :SafeKey, default: -> { PayuZa.safe_key }
+      field :payUReference
+      field :merchantReference
+    end
+  end
+end

data/lib/payu_za/structs/set_transaction.rb

@@ -0,0 +1,5 @@
+module PayuZa
+  module Structs
+    class SetTransaction < Transaction; end
+  end
+end

data/lib/payu_za/structs/struct_model.rb

@@ -0,0 +1,89 @@
+module PayuZa
+  module Structs
+    module StructModel
+
+      def self.included(base)
+        base.send(:extend, ClassMethods)
+      end
+
+      def valid?
+        validate! rescue false
+      end
+
+      def validate!
+        self.class.fields.each do |name, options|
+          if options[:required] && send(name).nil?
+            raise StructNotValidError.new(name, 'is required')
+          end
+        end
+      end
+
+      def to_hash
+        vars_to_hash
+      end
+
+      def operation_name
+        @operation_name ||= self.class.name.split('::').last.underscore.to_sym
+      end
+
+      private
+
+      def vars_to_hash
+        hash = {}
+        self.class.fields.each do |name, _options|
+          value = send(name)
+          next if value.nil?
+          hash[name.to_s] = hash_value(value)
+        end
+        hash
+      end
+
+      def hash_value(value)
+        if value.respond_to?(:to_hash)
+          value.to_hash
+        elsif value.is_a?(Array)
+          value.map do |v|
+            hash_value(v)
+          end
+        else
+          value
+        end
+      end
+
+      def default_for(field)
+        default = self.class.fields[field][:default]
+        if default.respond_to?(:call)
+          default.arity > 0 ?  default.call(self) : default.call
+        else
+          default
+        end
+      end
+
+      module ClassMethods
+        def field(name, options = {})
+          fields[name] = options
+
+          define_method name do
+            instance_variable_get(:"@#{name}") || default_for(name)
+          end
+
+          define_method "#{name}=" do |value|
+            instance_variable_set(:"@#{name}", value)
+          end
+        end
+
+        def create(attributes)
+          new.tap do |struct|
+            attributes.each do |name, value|
+              struct.send("#{name}=", value)
+            end
+          end
+        end
+
+        def fields
+          @fields ||= {}
+        end
+      end
+    end
+  end
+end

data/lib/payu_za/structs/transaction.rb

@@ -0,0 +1,18 @@
+module PayuZa
+  module Structs
+    class Transaction
+      include StructModel
+
+      field :Api, default: 'ONE_ZERO'
+      field :SafeKey, default: -> { PayuZa.safe_key }
+      field :TransactionType, required: true
+      field :AuthenticationType, required: true
+      field :storePaymentMethod
+      field :AdditionalInformation, required: true
+      field :Basket, required: true
+      field :Customer
+      field :Creditcard
+      field :Loyalty
+    end
+  end
+end

data/lib/payu_za/structs.rb

@@ -0,0 +1,30 @@
+require "payu_za/structs/struct_model"
+require "payu_za/structs/additional_information"
+require "payu_za/structs/customer"
+require "payu_za/structs/credit_card"
+require "payu_za/structs/basket"
+require "payu_za/structs/custom_field"
+
+require "payu_za/structs/transaction"
+require "payu_za/structs/get_transaction"
+require "payu_za/structs/set_transaction"
+require "payu_za/structs/do_transaction"
+
+
+module PayuZa
+  module Structs
+    module TRANSACTION_TYPE
+      RESERVE        = 'RESERVE'
+      RESERVE_CANCEL = 'RESERVE_CANCEL'
+      PAYMENT        = 'PAYMENT'
+      FINALIZE       = 'FINALIZE'
+      CREDIT         = 'CREDIT'
+    end
+
+    module AUTHENTICATION_TYPE
+      NA        = 'NA'
+      HANDSHAKE = 'HANDSHAKE'
+      TOKEN     = 'TOKEN'
+    end
+  end
+end

data/lib/payu_za/version.rb

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

data/lib/payu_za.rb

@@ -0,0 +1,38 @@
+require "active_support/core_ext/string"
+require 'savon'
+
+require "payu_za/version"
+require "payu_za/errors"
+require "payu_za/client"
+require "payu_za/structs"
+
+module PayuZa
+  extend self
+
+  attr_accessor :wsdl_endpoints, :environment, :soap_username, :soap_password,
+    :safe_key, :api_version, :password_digest
+
+  def configure
+    yield self
+  end
+
+  def default!
+    PayuZa.configure do |config|
+      config.api_version = 'ONE_ZERO'
+      config.wsdl_endpoints = {
+        development: 'https://staging.payu.co.za/service/PayUAPI?wsdl',
+        staging: 'https://staging.payu.co.za/service/PayUAPI?wsdl',
+        production: 'https://secure.payu.co.za/service/PayUAPI?wsdl'
+      }
+
+      config.environment = :staging
+    end
+  end
+
+  # Set defaults
+  default!
+
+  def wsdl_endpoint
+    wsdl_endpoints[environment]
+  end
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification
+name: payu_za
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stan Bondi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+description: |2
+    PayU ZA Enterprise SOAP Api integration
+
+    Provides an easy-to-use ruby to the tricky SOAP api.
+email:
+- stan@fixate.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/payu_za.rb
+- lib/payu_za/client.rb
+- lib/payu_za/errors.rb
+- lib/payu_za/structs.rb
+- lib/payu_za/structs/additional_information.rb
+- lib/payu_za/structs/basket.rb
+- lib/payu_za/structs/credit_card.rb
+- lib/payu_za/structs/custom_field.rb
+- lib/payu_za/structs/customer.rb
+- lib/payu_za/structs/do_transaction.rb
+- lib/payu_za/structs/get_transaction.rb
+- lib/payu_za/structs/set_transaction.rb
+- lib/payu_za/structs/struct_model.rb
+- lib/payu_za/structs/transaction.rb
+- lib/payu_za/version.rb
+homepage: https://github.com/fixate/payu_za
+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.4.5
+signing_key: 
+specification_version: 4
+summary: PayU ZA Enterprise SOAP API integration
+test_files: []