payson_api 0.0.2 → 0.0.3

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+*.gem
+.bundle
+Gemfile.lock
+pkg/*.gem
+.rvmrc
+doc

data/Gemfile

@@ -0,0 +1,14 @@
+source :rubygems
+
+gemspec
+
+gem 'require_all'
+gem 'rest-client'
+
+group :test, :development do
+  gem 'guard-test'
+  gem 'rake'
+  platforms :ruby do
+    gem 'rb-readline'
+  end
+end

data/README.rdoc

@@ -0,0 +1,84 @@
+= Payson API
+
+A simple utility to handle requests against the Payson payment gateway.
+
+
+== Supported versions
+
+* Ruby 1.9.3
+
+
+== Install
+
+Put this line in your Gemfile:
+  gem 'payson_api'
+
+Then bundle:
+  % bundle
+
+
+== Usage
+
+=== General configuration options
+
+You can configure the following default values by overriding these values using the <tt>PaysonAPI.configure</tt> method.
+
+  PaysonAPI.configure do |config|
+    config.api_user = 'XXXX'
+    config.api_key = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
+  end
+
+=== Initiating a payment
+
+  return_url = 'http://localhost/payson/success'
+  cancel_url = 'http://localhost/payson/cancel'
+  ipn_url = 'http://localhost/payson/ipn'
+  memo = 'Sample order description'
+
+  receivers = []
+  receivers << PaysonAPI::Receiver.new(
+    email = 'me@mydomain.com',
+    amount = 100
+  )
+
+  sender = PaysonAPI::Sender.new(
+    email = 'mycustomer@mydomain.com,
+    first_name = 'My',
+    last_name = 'Customer'
+  )
+
+  order_items = []
+  order_items << PaysonAPI::OrderItem.new(
+    description = 'Order item description',
+    unit_price = 100,
+    quantity = 1,
+    tax = 0,
+    sku = 'MY-ITEM-1'
+  )
+
+  pay_data = PaysonAPI::PayData.new(
+    return_url,
+    cancel_url,
+    ipn_url,
+    memo,
+    sender,
+    receivers
+  )
+  pay_data.order_items = order_items
+
+  response = PaysonAPI::Client.pay(pay_data)
+
+  if response.success?
+    # Redirect to response.forward_url
+  else
+    puts response.errors
+  end
+
+== Questions, Feedback
+
+Feel free to message me on Github (stoffus).
+
+
+== Copyright
+
+Copyright (c) 2012 Christopher Svensson.

data/lib/payson_api.rb

@@ -0,0 +1,2 @@
+require 'require_all'
+require_rel 'payson_api'

data/lib/payson_api/client.rb

@@ -0,0 +1,18 @@
+require 'rest_client'
+
+module PaysonAPI
+  class Client
+    def self.pay(pay_data)
+      action = '/%s/%s/' % [PAYSON_API_VERSION, PAYSON_API_PAY_ACTION]
+      headers = {
+        "PAYSON-SECURITY-USERID" => PaysonAPI.config.api_user,
+        "PAYSON-SECURITY-PASSWORD" => PaysonAPI.config.api_key
+      }
+      response = RestClient.post(PAYSON_API_ENDPOINT + action,
+        pay_data.to_hash,
+        headers
+      )
+      Response.new(response)
+    end
+  end
+end

data/lib/payson_api/config.rb

@@ -0,0 +1,39 @@
+module PaysonAPI
+
+  # Some hard constants
+
+  PAYSON_WWW_HOST = "https://www.payson.se"
+  PAYSON_WWW_PAY_FORWARD_URL = "/paysecure/?token=%s"
+
+  PAYSON_API_ENDPOINT = "https://api.payson.se"
+  PAYSON_API_VERSION = "1.0"
+  PAYSON_API_PAY_ACTION = "Pay"
+  PAYSON_API_PAYMENT_DETAILS_ACTION = "PaymentDetails"
+  PAYSON_API_PAYMENT_UPDATE_ACTION = "PaymentUpdate"
+  PAYSON_API_PAYMENT_VALIDATE_ACTION = "Validate"
+
+  LOCALES = %w[SV FI EN]
+  CURRENCIES = %w[SEK EUR]
+
+  # Configures global settings for Payson
+  # PaysonAPI.configure do |config|
+  #   config.api_user = 12345
+  # end
+  def self.configure(&block)
+    yield @config ||= PaysonAPI::Configuration.new
+  end
+
+  def self.config
+    @config
+  end
+
+  class Configuration
+    attr_accessor :api_user, :api_key
+  end
+
+  configure do |config|
+    config.api_user = 'XXXX'
+    config.api_key = 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX'
+  end
+
+end

data/lib/payson_api/errors/config_error.rb

@@ -0,0 +1,13 @@
+module PaysonAPI
+  module Errors
+    class ConfigError < PaysonAPIError
+      def initialize(msg)
+        @msg = msg
+      end
+
+      def to_s
+        @msg
+      end
+    end
+  end
+end

data/lib/payson_api/errors/payson_api_error.rb

@@ -0,0 +1,7 @@
+module PaysonAPI
+  module Errors
+    class PaysonAPIError < StandardError
+      # Base error.
+    end
+  end
+end

data/lib/payson_api/errors/remote_error.rb

@@ -0,0 +1,55 @@
+module PaysonAPI
+  module Errors
+    class RemoteError < PaysonAPIError
+      ERROR_CODES = {
+        '500000' => "System error.",
+        '520002' => "Internal error.",
+        '520003' => "Authentication failed; Credentials were not valid.",
+        '520004' => "The merchant account is restricted.",
+        '520005' => "The merchant account is locked.",
+        '520006' => "The requested API endpoint is unknown.",
+        '529038' => "Error while executing payment.",
+        '539041' => "An email account is not receive enabled.",
+        '539043' => "An email account is not send enabled.",
+        '559044' => "A receiver's preferences denied the payment.",
+        '560027' => "Unrecognized fees payer type.",
+        '579007' => "Payment request number of receivers exceeds the maximum.",
+        '579008' => "Number of primary receivers exceeds 1.",
+        '579017' => "Primary receiver amount for chained payment must not be less than sum of other receiver amounts.",
+        '579033' => "Sender and each receiver must all have different accounts.",
+        '579040' => "Two receivers belong to the same Payson user account.",
+        '579042' => "The tracking ID already exists and cannot be duplicated.",
+        '579045' => "This request would exceed the receiving limit for an account.",
+        '579047' => "This request would exceed the purse limit for an account.",
+        '579048' => "This request would exceed the sending limit for an account.",
+        '579049' => "The payment request you are looking for was not found in our system.",
+        '580001' => "Invalid request - the request did not pass our basic validation.",
+        '580021' => "Invalid parameter - too long.",
+        '580022' => "Your request was invalid. Check the parameter of the error to see which is invalid.",
+        '580023' => "A receiver was given more than once in the request.",
+        '580027' => "Unsupported currency code.",
+        '580028' => "A URL supplied with the request is malformed.",
+        '580029' => "A required parameter was not provided. Check the error parameter list.",
+        '589018' => "Invalid pay key.",
+        '589052' => "The transaction ID was not found in our system.",
+        '589053' => "All payment methods have been disabled for this combination of funding constraint, merchant and receiver.",
+        '590001' => "The total amount specified for receivers does not match the total amount specified by the order items.",
+        '590005' => "Not all related order item parameters where specified. All or none of unitPrice, quantity, taxPercentage and sku must be set.",
+        '590006' => "Invoice requires one reciever.",
+        '590007' => "Invoice requires fee on reciever.",
+        '590008' => "Invoice requires that order items are specified.",
+        '590009' => "Invoice payments are not available to this merchant.",
+        '590010' => "The requested action is not possible in the current state of the payment.",
+        '590011' => "The amount on the invoice is below the minimum limit.",
+        '590012' => "Invoice does not support the selected currency.",
+        '590013' => "The invoice fee out of the valid range (0-30 SEK).",
+        '590014' => "The invoice fee can only be specified for invoices.",
+        '590015' => "The receiver is not allowed to receive invoices.",
+        '590016' => "The sender and reciever is the same user.",
+        '590017' => "Invoice is frozen and cannot be updated.",
+        '590018' => "The requested action is not possible for the current type of payment.",
+        '590021' => "The funding constraint INVOICE cannot be combined with other funding constraints."
+      }
+    end
+  end
+end

data/lib/payson_api/order_item.rb

@@ -0,0 +1,46 @@
+module PaysonAPI
+class OrderItem
+  FORMAT_STRING = "orderItemList.orderItem(%d).%s"
+  attr_accessor :description, :quantity, :unit_price, :sku, :tax
+
+  def initialize(description, unit_price, quantity, tax, sku)
+    @description = description
+    @unit_price = unit_price
+    @quantity = quantity
+    @tax = tax
+    @sku = sku
+  end
+
+  def self.to_hash(order_items)
+    {}.tap do |hash|
+      order_items.each_with_index do |item, index|
+        raise "Invalid order item" unless item.instance_of?(self)
+        hash.merge!({
+          FORMAT_STRING % [index, 'description'] => item.description,
+          FORMAT_STRING % [index, 'unitPrice'] => item.unit_price,
+          FORMAT_STRING % [index, 'quantity'] => item.quantity,
+          FORMAT_STRING % [index, 'taxPercentage'] => item.tax,
+          FORMAT_STRING % [index, 'sku'] => item.sku
+        })
+      end
+    end
+  end
+
+  def self.parse_order_items(data)
+    i = 0
+    [].tap do |order_items|
+      while data[FORMAT_STRING % [i, 'description']]
+        description = data[FORMAT_STRING % [i, 'description']]
+        unit_price = data[FORMAT_STRING % [i, 'unitPrice']]
+        quantity = data[FORMAT_STRING % [i, 'quantity']]
+        tax = data[FORMAT_STRING % [i, 'taxPercentage']]
+        sku = data[FORMAT_STRING % [i, 'sku']]
+
+        order_items << OrderItem.new(description, unit_price, quantity, tax, sku)
+        i += 1
+      end
+    end
+  end
+
+end
+end

data/lib/payson_api/pay_data.rb

@@ -0,0 +1,35 @@
+module PaysonAPI
+class PayData
+  attr_accessor :return_url, :cancel_url, :ipn_url, :memo, :sender, :receivers,
+    :locale, :currency, :tracking_id, :invoice_fee, :order_items
+
+  def initialize(return_url, cancel_url, ipn_url, memo, sender, receivers)
+    @return_url = return_url
+    @cancel_url = cancel_url
+    @ipn_url = ipn_url
+    @memo = memo
+    @sender = sender
+    @receivers = receivers
+  end
+
+  def to_hash
+    {}.tap do |hash|
+      hash['returnUrl'] = @return_url
+      hash['cancelUrl'] = @cancel_url
+      hash['ipnNotificationUrl'] = @ipn_url unless @ipn_url.empty?
+      hash['memo'] = @memo
+      hash['localeCode'] = LOCALES[@locale] if @locale
+      hash['currencyCode'] = CURRENCIES[@currency] if @currency
+      hash.merge!(Receiver.to_hash(@receivers))
+      hash.merge!(@sender.to_hash)
+      hash.merge!(OrderItem.to_hash(@order_items)) if @order_items
+      hash['invoiceFee'] = @invoice_fee if @invoice_fee
+      hash['trackingId'] = @tracking_id if @tracking_id
+    end
+  end
+
+  def to_s
+    to_hash.to_s
+  end
+end
+end

data/lib/payson_api/receiver.rb

@@ -0,0 +1,35 @@
+module PaysonAPI
+class Receiver
+  FORMAT_STRING = "receiverList.receiver(%d).%s"
+  attr_accessor :email, :amount
+
+  def initialize(email, amount)
+    @email = email
+    @amount = amount
+  end
+
+  def self.to_hash(receivers)
+    {}.tap do |hash|
+      receivers.each_with_index do |receiver, index|
+        raise "Invalid receiver" unless receiver.instance_of?(self)
+        hash.merge!({
+          FORMAT_STRING % [index, 'email'] => receiver.email,
+          FORMAT_STRING % [index, 'amount'] => receiver.amount
+        })
+      end
+    end
+  end
+
+  def self.parse_receivers(data)
+    i = 0
+    [].tap do |receivers|
+      while data[FORMAT_STRING % [i, 'email']]
+        email = data[FORMAT_STRING % [i, 'email']]
+        amount = data[FORMAT_STRING % [i, 'amount']]
+        receivers << Receiver.new(email, amount)
+        i += 1
+      end
+    end
+  end
+end
+end

data/lib/payson_api/response.rb

@@ -0,0 +1,35 @@
+module PaysonAPI
+class Response
+  attr_accessor :envelope, :token, :errors
+
+  def initialize(response)
+    @errors = {}
+    @envelope = {}
+    @token = nil
+    parse_response(response)
+  end
+
+  def parse_response(response)
+    response.split(/&/).each do |item|
+      if item =~ /TOKEN/
+        @token = item.split(/=/)[1]
+      elsif item =~ /errorId/
+        code = item.split(/=/)[1]
+        @errors[code] = Errors::RemoteError::ERROR_CODES[code]
+      elsif item =~ /responseEnvelope/
+        name, value = item.split(/=/)
+        name = name.split(/\./)[1]
+        @envelope[name] = value
+      end
+    end
+  end
+
+  def success?
+    @envelope['ack'] == 'SUCCESS'
+  end
+
+  def forward_url
+    url = PAYSON_WWW_HOST + PAYSON_WWW_PAY_FORWARD_URL % @token
+  end
+end
+end

data/lib/payson_api/sender.rb

@@ -0,0 +1,19 @@
+module PaysonAPI
+class Sender
+  attr_accessor :email, :first_name, :last_name
+
+  def initialize(email, first_name, last_name)
+    @email = email
+    @first_name = first_name
+    @last_name = last_name
+  end
+
+  def to_hash
+    {}.tap do |hash|
+      hash['senderEmail'] = @email
+      hash['senderFirstName'] = @first_name
+      hash['senderLastName'] = @last_name
+    end
+  end
+end
+end

data/lib/payson_api/version.rb

@@ -0,0 +1,3 @@
+module PaysonAPI
+  VERSION = "0.0.3"
+end

data/payson_api.gemspec

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+$:.push File.expand_path("../lib", __FILE__)
+require "payson_api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "payson_api"
+  s.version     = PaysonAPI::VERSION
+  s.authors     = ["Christopher Svensson"]
+  s.email       = ["stoffus@stoffus.com"]
+  s.homepage    = "https://github.com/stoffus/payson_api"
+  s.summary     = %q{Client for Payson API}
+  s.description = %q{Client that enables access to the Payson payment gateway API.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency 'require_all'
+  s.add_dependency 'rest-client'
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: payson_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: require_all
-  requirement: &70181536161320 !ruby/object:Gem::Requirement
+  requirement: &70104901674140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70181536161320
+  version_requirements: *70104901674140
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70181536160680 !ruby/object:Gem::Requirement
+  requirement: &70104901657500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,25 +32,30 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70181536160680
-- !ruby/object:Gem::Dependency
-  name: activesupport
-  requirement: &70181536159840 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 3.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: *70181536159840
+  version_requirements: *70104901657500
 description: Client that enables access to the Payson payment gateway API.
 email:
 - stoffus@stoffus.com
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- lib/payson_api.rb
+- lib/payson_api/client.rb
+- lib/payson_api/config.rb
+- lib/payson_api/errors/config_error.rb
+- lib/payson_api/errors/payson_api_error.rb
+- lib/payson_api/errors/remote_error.rb
+- lib/payson_api/order_item.rb
+- lib/payson_api/pay_data.rb
+- lib/payson_api/receiver.rb
+- lib/payson_api/response.rb
+- lib/payson_api/sender.rb
+- lib/payson_api/version.rb
+- payson_api.gemspec
 homepage: https://github.com/stoffus/payson_api
 licenses: []
 post_install_message: