safecharge 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ff76ed515bb382871847edfff75a3338adb50cbe
+  data.tar.gz: 1abce3e38d9783c534ae44b8a511768f4a44ba0b
+SHA512:
+  metadata.gz: 207c9507b761fd53c213796c29bef229582d769c283bb162952c8798dde2707a0308fd8386f2f31637bfd1bb49ae33d34dc46355b0fda5f2d1f3770b1a296b68
+  data.tar.gz: d1204ea21290be3e93365297a2bc23f251884e52e3274f2024c3c9899d10341be942b8cadf0495d7b7b45a327df6e30a5a95536a58c8b4e5592c16f8b6f65e65

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Interactive Gaming Entertainment Pty Ltd
+
+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,137 @@
+# Safecharge
+
+A simple Ruby wrapper for the SafeCharge PPP Payment API v 3.0.0 (Revised July 2011), as well as
+the SafeCharge Web Cashier API v1.0 (Revised July 2013).
+
+## Status
+
+This project is under active development right now, and not suitable for use.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'safecharge'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install safecharge
+
+## Usage
+
+### Public Payment Page
+
+The SafeCharge PPP system provides a simple means for merchants to integrate credit card
+payments into their site, without worrying about having to capture their customers'
+credit card details.
+
+It works like this:
+
+Step 1)  Your website provides a way for customers to choose the items they wish to buy,
+say via a shopping basket, or similar.
+
+Collate an array of items with the following information
+        
+    items = [
+      {
+      'name' => 'bat',
+      'number' => 'sku54321',
+      'amount' => 25,
+      'quantity' => 1
+      },
+      {
+      'name' => 'ball',
+      'number' => 'sku12345',
+      'amount' => 15,
+      'quantity' => 2
+      }
+    ]
+
+and insert that items array into an array of params like so
+
+    params = {
+      'total_amount' => 55,
+      'currency' => 'USD',
+      'items' => items
+    }
+
+Note you must supply the following environment variables for this API to work.
+
+    SAFECHARGE_SECRET_KEY, SAFECHARGE_MERCHANT_ID, SAFECHARGE_MERCHANT_SITE_ID
+
+These will have been provided to you by Safecharge.
+
+Step 2) You offer a `checkout` button that links to the following url.
+
+    `url = Safecharge.request_url(params)`
+
+Step 3) The SafeCharge system will redirect the user to the Public Payment Page
+and there they will enter in their credit card and other payment details as needed.
+When the user confirms their payment, the Safecharge system authenticates it and
+redirects the user to either a 'success', 'failure' or 'back' page. The back page
+is used if the user suspends the payment processing by clicking on their browser's
+back button.
+
+### Web Cashier
+
+The Safecharge Web Cashier extends the standard Public Payment Page with paramaters that
+allow you to register and identify customers in SafeCharge's system, and enable you to
+change the deposit amounts within limits you define.
+
+It works like this:
+
+Step 1)  Your website provides a way for customers to choose the items they wish to buy,
+say via a shopping basket, or similar.
+
+Collate an array of items with the following information
+        
+    items = [
+      {
+      'name' => 'deposit',
+      'number' => 'something',
+      'amount' => 0,
+      'quantity' => 1,
+      'open_amount' => 'true',
+      'min_amount' => 10.0,
+      'max_amount' => 1000.0,
+      },
+    ]
+
+and insert that items array into an array of params like so
+
+    params = {
+      'total_amount' => 55,
+      'currency' => 'USD',
+      'items' => items,
+      'user_token' => 'auto', # or 'register'
+      'user_token_id' => 'player_id'
+    }
+
+Note you must supply the following environment variables for this API to work.
+
+    SAFECHARGE_SECRET_KEY, SAFECHARGE_MERCHANT_ID, SAFECHARGE_MERCHANT_SITE_ID
+
+These will have been provided to you by Safecharge.
+
+Step 2) You offer a `checkout` button that links to the following url.
+
+    `url = Safecharge.wc_request_url(params)`
+
+Step 3) The SafeCharge system will redirect the user to the WebCashier Page
+and there they will enter in their credit card and other payment details as needed.
+When the user confirms their payment, the Safecharge system authenticates it and
+redirects the user to either a 'success', 'failure' or 'back' page. The back page
+is used if the user suspends the payment processing by clicking on their browser's
+back button.
+
+## Contributing
+
+1. Fork it
+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/lib/safecharge.rb

@@ -0,0 +1,147 @@
+#!/user/bin/env ruby
+#coding: utf-8
+
+require "safecharge/version"
+require "safecharge/constants"
+require "safecharge/request"
+require "safecharge/wc_request"
+require "safecharge/response"
+
+# The Safecharge PPP system provides a simple means for merchants to integrate credit card
+# payments into their site, without worrying about having to capture their customers'
+# credit card details.
+# 
+# It works like this:
+# 
+# Step 1) Your website provides a way for customers to choose the items they wish to buy,
+#         say via a shopping basket, or similar.
+#         
+#         Collate an array of items with the following information
+#         
+#         items = [
+#           {
+#           'name' => 'bat',
+#           'number' => 'sku54321',
+#           'amount' => 25,
+#           'quantity' => 1
+#           },
+#           {
+#           'name' => 'ball',
+#           'number' => 'sku12345',
+#           'amount' => 15,
+#           'quantity' => 2
+#           }
+#         ]
+#
+#         and insert that items array into an array of params like so
+#
+#         params = {
+#           'total_amount' => 55,
+#           'currency' => 'USD',
+#           'items' => items
+#         }
+#
+#         Note you must supply the following environment variables for this API to work.
+# 
+#         SAFECHARGE_SECRET_KEY, SAFECHARGE_MERCHANT_ID, SAFECHARGE_MERCHANT_SITE_ID
+#
+#         These will have been provided to you by Safecharge.
+#
+# Step 2) You offer a 'checkout' button that links to the following url.
+#
+#         url = Safecharge.request_url(params)
+#
+# Step 3) The Safecharge system will redirect the user to the Public Payment Page
+#         and there they will enter in their credit card and other payment details as needed.
+#         When the user confirms their payment, the Safecharge system authenticates it and
+#         redirects the user to either a 'success', 'failure' or 'back' page. The back page
+#         is used if the user suspends the payment processing by clicking on their browser's
+#         back button.
+#         Whichever page is returned, it will incude parameters from the server
+#         which can be decoded into a valid Response object by your server.
+#
+#         response = Safecharge.parse_response
+#
+# TODO: finish these docs
+#
+module Safecharge
+
+  # define errors and exceptions.
+  class SafechargeError < RuntimeError
+  end
+  class InternalException < SafechargeError
+  end
+  class ValidationException < SafechargeError
+  end
+
+  # module level method to get the redirection URL given some params.
+  # you must explicitly set the mode to 'live' to generate the production URL.
+  def self.request_url(params = {}, mode = 'test')
+    result = nil
+    url = ''
+    case mode
+      when 'test'
+        url = Safecharge::Constants::SERVER_TEST
+      when 'live'
+        url = Safecharge::Constants::SERVER_LIVE
+      else
+        raise ArgumentError, "Invalid request mode #{mode}"
+    end
+
+    begin
+      request = Safecharge::Request.new(url, params)
+      return request.full_url
+
+    rescue InternalException => e
+      puts "Caught Internal Exception: #{e.message}"
+      puts e.backtrace
+      raise RuntimeError, "Internal server error. Please try again later."
+
+    rescue ValidationException => e
+      puts "Caught Validation Exception: #{e.message}"
+      puts e.backtrace
+      raise RuntimeError, "Validation error: #{e.message} Fix your data and retry."
+
+    rescue SafechargeError => e
+      puts "Caught General Safecharge Error: #{e.message}"
+      puts e.backtrace
+      raise RuntimeError, "Undocumented Internal error: #{e.message}"
+    end
+  end
+
+  # module level method to get the redirection URL given some params.
+  # you must explicitly set the mode to 'live' to generate the production URL.
+  def self.wc_request_url(params = {}, mode = 'test')
+    result = nil
+    url = ''
+    case mode
+      when 'test'
+        url = Safecharge::Constants::SERVER_TEST
+      when 'live'
+        url = Safecharge::Constants::SERVER_LIVE
+      else
+        raise ArgumentError, "Invalid request mode #{mode}"
+    end
+
+    begin
+      request = Safecharge::WcRequest.new(url, params)
+      return request.full_url
+
+    rescue InternalException => e
+      puts "Caught Internal Exception: #{e.message}"
+      puts e.backtrace
+      raise RuntimeError, "Internal server error. Please try again later."
+
+    rescue ValidationException => e
+      puts "Caught Validation Exception: #{e.message}"
+      puts e.backtrace
+      raise RuntimeError, "Validation error: #{e.message} Fix your data and retry."
+
+    rescue SafechargeError => e
+      puts "Caught General Safecharge Error: #{e.message}"
+      puts e.backtrace
+      raise RuntimeError, "Undocumented Internal error: #{e.message}"
+    end
+  end
+
+end

data/lib/safecharge/constants.rb

@@ -0,0 +1,44 @@
+#!/user/bin/env ruby
+#coding: utf-8
+
+module Safecharge
+  class Constants
+    API_VERSION = '3.0.0'
+
+    SERVER_TEST = ENV['SAFECHARGE_SERVER_TEST']                     # provided by SafeCharge
+    SERVER_LIVE = ENV['SAFECHARGE_SERVER_LIVE']                     # provided by SafeCharge
+    
+    SECRET_KEY = ENV['SAFECHARGE_SECRET_KEY']                       # provided by SafeCharge
+    MERCHANT_ID =  ENV['SAFECHARGE_MERCHANT_ID']                    # provided by SafeCharge
+    MERCHANT_SITE_ID = ENV['SAFECHARGE_MERCHANT_SITE_ID']           # provided by SafeCharge
+    MERCHANT_3D_SITE_ID = ENV['SAFECHARGE_MERCHANT_3D_SITE_ID']     # provided by SafeCharge
+    
+    SG_CLIENT_PASSWORD = ENV['SAFECHARGE_SG_CLIENT_PASSWORD']       # provided by SafeCharge
+    SG_3D_CLIENT_PASSWORD = ENV['SAFECHARGE_SG_3D_CLIENT_PASSWORD'] # provided by SafeCharge
+    
+    CPANEL_PASSWORD = ENV['SAFECHARGE_CPANEL_PASSWORD']             # provided by SafeCharge
+
+    APPROVED = 'APPROVED'
+    DECLINED = 'DECLINED'
+    ERROR = 'ERROR'
+    BANK_ERROR = 'BANK_ERROR'
+    INVALID_LOGIN = 'INVALID_LOGIN'
+    INVALID_IP = 'INVALID_IP'
+    TIMEOUT = 'TIMEOUT'
+    UNKNOWN_ERROR = 'UNKNOWN_ERROR'
+
+    CURRENCIES = [
+      'GBP', 'EUR', 'USD', 'HKD', 'YEN', 'AUD', 'CAD',
+      'NOK', 'ZAR', 'SEK', 'CHF', 'NIS', 'MXN', 'RUB'
+    ]
+#     REQUEST_TYPE_AUTH   = 'Auth'
+#     REQUEST_TYPE_SETTLE = 'Settle'
+#     REQUEST_TYPE_SALE   = 'Sale'
+#     REQUEST_TYPE_CREDIT = 'Credit'
+#     REQUEST_TYPE_VOID   = 'Void'
+#     REQUEST_TYPE_AVS    = 'AVSOnly'
+
+    DEFAULT_ENCODING = 'utf-8'
+    DEFAULT_CURRENCY_CODE = 'EUR'
+  end
+end

data/lib/safecharge/request.rb

@@ -0,0 +1,187 @@
+#!/user/bin/env ruby
+#coding: utf-8
+
+require "safecharge"
+require "safecharge/constants"
+
+module Safecharge
+  class Request
+    attr_accessor :mode, :params, :items, :url, :full_url
+
+    ALLOWED_FIELDS = {
+      'currency' => {:required => true, :type => 'currency_code'},
+      'customData' => {:required => false, :type => 'string', length: 255},
+      'customSiteName' => {:required => false, :type => 'string', length: 50},
+      'discount' => {:required => false, :type => 'currency'},
+      'encoding' => {:required => false, :type => 'string', length: 20},
+      'error_url' => {:required => false, :type => 'string', length: 300},
+      'handling' => {:required => false, :type => 'currency'},
+      'invoice_id' =>  {:required => false, :type => 'string', length: 400},
+      'merchant_id' => {:required => true, :type => 'int'},
+      'merchant_site_id' => {:required => true, :type => 'int'},
+      'merchant_unique_id' => {:required => false, :type => 'string', length: 64},
+      'merchantLocale' => {:required => false, :type => 'string', length: 5},
+      'payment_method' => {:required => false, :type => 'string', length: 256},
+      'pending_url' => {:required => false, :type => 'string', length: 300},
+      'productId' => {:required => false, :type => 'string', length: 50},
+      'shipping' => {:required => false, :type => 'currency'},
+      'skip_billing_tab' => {:required => false, :type => 'boolstring'},
+      'skip_review_tab' => {:required => false, :type => 'boolstring'},
+      'success_url' => {:required => false, :type => 'string', length: 300},
+      'total_amount' => {:required => true, :type => 'currency'},
+      'total_tax' => {:required => false, :type => 'percent'},
+      'userid' => {:required => false, :type => 'string', length: 50},
+      'version' => {:required => true, :type => 'string', length: 10},
+      'webMasterId' => {:required => false, :type => 'string', length: 255}
+
+    } # 'time_stamp', 'numberofitems' and 'checksum' are inserted after validation.
+
+    ALLOWED_ITEM_FIELDS = {
+      'name' => {:required => true, :type => 'string', length: 400},
+      'number' => {:required => true, :type => 'string', length: 400},
+      'amount' => {:required => true, :type => 'currency'},
+      'quantity' => {:required => true, :type => 'int'},
+      'discount' => {:required => false, :type => 'percent'},
+      'shipping' => {:required => false, :type => 'currency'},
+      'handling' => {:required => false, :type => 'currency'}
+
+    }
+
+    DEFAULT_PARAMS = {
+      'merchant_id' => Safecharge::Constants::MERCHANT_ID,
+      'merchant_site_id' => Safecharge::Constants::MERCHANT_SITE_ID,
+      'currency' => Safecharge::Constants::DEFAULT_CURRENCY_CODE,
+      'version' => Safecharge::Constants::API_VERSION,
+      'encoding' => Safecharge::Constants::DEFAULT_ENCODING
+    }
+
+    def initialize(url, params = {})
+      raise ArgumentError, "missing url" if url == nil || url.empty?
+      if url === Safecharge::Constants::SERVER_TEST
+        self.mode = 'test'
+      elsif url === Safecharge::Constants::SERVER_LIVE
+        self.mode = 'live'
+      else
+        raise ArgumentError, "invalid url #{url}"
+      end
+      self.url = url
+      self.full_url = url
+      core_params, items, extracted_items = self.extract_items(params)
+      raise ValidationException, "Missing array of Items." if items == nil || items.empty?
+      self.items = items
+      self.params = DEFAULT_PARAMS.merge(core_params)
+      self.validate_parameters(self.params)
+      items.each {|i| self.validate_parameters(i, self.class::ALLOWED_ITEM_FIELDS)}
+      self.params.merge!(extracted_items)
+      self.params.merge!({'numberofitems' => items.size,
+                          'time_stamp' => Time.now.utc.strftime("%Y-%m-%d.%H:%M:%S")})
+      self.params.merge!({'checksum' => calculate_checksum})
+      self.construct_url
+    end
+
+    protected
+
+    def extract_items(params)
+      items = params.delete('items')
+      return params, nil, nil if items == nil
+      keyed_items = {}
+      items.each_with_index do |item, i|
+        item.keys.each do |key|
+          new_key = "item_#{key}_#{i+1}"
+          keyed_items[new_key] = item[key]
+        end
+      end
+      return params, items, keyed_items
+    end
+
+    def validate_parameters(params, against = self.class::ALLOWED_FIELDS)
+      self.validate_fields(params, against)
+      self.validate_no_extra_fields(params, against)
+    end
+
+    def validate_fields(params, against = self.class::ALLOWED_FIELDS)
+      against.each do |name, meta|
+        required = (meta[:required] === true)
+        # Check that all required parameters are present
+        if required && !params.keys.include?(name)
+          raise ValidationException, "Parameter #{name} is required, but missing from #{params.keys}"
+        end
+        if params.keys.include? name
+          p = params[name]
+          if p != nil
+            # Check the type of the value
+            correct_type = false
+            case meta[:type]
+              when 'boolstring'
+                correct_type = p.is_a?(String) && ['True', 'False'].include?(p)
+              when 'string'
+                correct_type = p.is_a? String
+                raise ValidationException, sprintf("Value '%s' in field '%s' is too long.", p, name) if p.size > meta[:length]
+              when 'currency_code'
+                correct_type = p.is_a? String
+              when 'currency'
+                correct_type = p.is_a?(Float) || p.is_a?(Integer)
+              when 'percent'
+                correct_type = p.is_a?(Float) || p.is_a?(Integer)
+              when 'int'
+                correct_type = p.is_a? Integer
+            end
+
+            if !correct_type
+              raise ValidationException, sprintf("Value '%s' in field '%s' is not of expected type '%s'", p, name, meta[:type])
+            end
+          end
+        end
+      end
+    end
+
+    def validate_no_extra_fields(params, against = self.class::ALLOWED_FIELDS)
+      allowed_fields = against.keys
+      params.each do |key, value|
+        raise InternalException, "Field #{key} is not supported" if !allowed_fields.include?(key)
+      end
+    end
+
+    def calculate_checksum
+      codes = [Safecharge::Constants::SECRET_KEY,
+              self.params['merchant_id'],
+              self.params['currency'],
+              self.params['total_amount']]
+      self.items.each do |item|
+        codes << item['name']
+        codes << item['amount']
+        codes << item['quantity']
+      end
+      codes << self.params['time_stamp']
+      s = codes.join('')
+      return Digest::MD5.hexdigest(s)
+    end
+
+    def construct_url
+      uri = URI(self.url)
+      uri.query = URI.encode_www_form(self.params)
+      self.full_url = uri.to_s
+      return uri
+    end
+
+#     def calculate_item_total
+#      # item_amount_N - item_discount_N + item_shipping_N + item_handling_N) * item_quantity_N
+#      return 0.0 if self.items == nil || self.items.empty?
+#      result = 0
+#      self.items.each {|i| result += (i['amount'] +
+#                                       i['shipping'] +
+#                                       i['handling'] -
+#                                       i['discount']) * i['quantity']}
+#       return result
+#     end
+#     
+#     def calculate_total_with_tax
+#       # calculatedTotalAmount+=shipping+handling-discount
+#       tot = calculate_item_total +
+#             self.fields['shipping'] +
+#             self.fields['handling'] - self.fields['discount']
+#       return tot, tot * ( self.fields['total_tax'] / 100)
+#     end
+
+  end
+end

data/lib/safecharge/response.rb

@@ -0,0 +1,58 @@
+#!/user/bin/env ruby
+#coding: utf-8
+
+require "safecharge"
+require "safecharge/constants"
+
+module Safecharge
+  class Response
+    attr_accessor :params
+
+    ALLOWED_FIELDS = [
+      'Status', 'totalAmount', 'TransactionID', 'ClientUniqueID', 'ErrCode',
+      'ExErrCode', 'AuthCode', 'Reason', 'Token', 'ReasonCode',
+      'advanceResponseChecksum', 'ECI',
+      'nameOnCard', 'currency', 
+      'total_discount', 'total_handling', 'total_shipping', 'total_tax',
+      'customData', 'merchant_unique_id', 'merchant_site_id',
+      'requestVersion', 'message', 'Error', 'PPP_TransactionID', 'UserID',
+      'ProductID', 'ppp_status', 'merchantLocale', 'unknownParameters', 'webMasterId'
+    ]
+
+    def initialize(incoming_encoded_params = nil)
+      self.params = self.decode(incoming_encoded_params)
+    end
+
+    def decode(param_string)
+      #todo write this.
+      return {}
+    end
+
+    def self.code(err, exerr)
+      return Safecharge::Constants::APPROVED if err == 0 && exerr == 0
+      return Safecharge::Constants::DECLINED if err == -1 && exerr == 0
+      # pending? see p 22 of the spec
+      return Safecharge::Constants::ERROR if err == -1100 && exerr > 0
+      # could be more specific. see p 22 of the spec for exerr codes
+      return Safecharge::Constants::BANK_ERROR if err < 0 && exerr != 0
+      return Safecharge::Constants::INVALID_LOGIN if err == -1001
+      return Safecharge::Constants::INVALID_IP if err == -1005
+      return Safecharge::Constants::TIMEOUT if err == -1203
+      return Safecharge::Constants::UNKNOWN_ERROR
+    end
+
+    protected
+
+    def calculate_checksum
+      codes = [Safecharge::Constants::SECRET_KEY,
+              self.params['totalAmount'],
+              self.params['currency'],
+              self.params['responseTimeStamp'],
+              self.params['PPP_TransactionID'],
+              self.params['Status'],
+              self.params['productId']]
+      s = codes.join('')
+      return Digest::MD5.hexdigest(s)
+    end
+  end
+end

data/lib/safecharge/version.rb

@@ -0,0 +1,6 @@
+#!/user/bin/env ruby
+#coding: utf-8
+
+module Safecharge
+  VERSION = "0.0.3"
+end

data/lib/safecharge/wc_request.rb

@@ -0,0 +1,79 @@
+#!/user/bin/env ruby
+#coding: utf-8
+
+require "safecharge"
+require "safecharge/constants"
+
+module Safecharge
+  class WcRequest < Request
+
+    ALLOWED_FIELDS = {
+      'currency' => {:required => true, :type => 'currency_code'},
+      'customData' => {:required => false, :type => 'string', length: 255},
+      'customSiteName' => {:required => false, :type => 'string', length: 50},
+      'discount' => {:required => false, :type => 'currency'},
+      'encoding' => {:required => false, :type => 'string', length: 20},
+      'error_url' => {:required => false, :type => 'string', length: 300},
+      'handling' => {:required => false, :type => 'currency'},
+      'invoice_id' =>  {:required => false, :type => 'string', length: 400},
+      'merchant_id' => {:required => true, :type => 'int'},
+      'merchant_site_id' => {:required => true, :type => 'int'},
+      'merchant_unique_id' => {:required => false, :type => 'string', length: 64},
+      'merchantLocale' => {:required => false, :type => 'string', length: 5},
+      'payment_method' => {:required => false, :type => 'string', length: 256},
+      'pending_url' => {:required => false, :type => 'string', length: 300},
+      'productId' => {:required => false, :type => 'string', length: 50},
+      'shipping' => {:required => false, :type => 'currency'},
+      'skip_billing_tab' => {:required => false, :type => 'boolstring'},
+      'skip_review_tab' => {:required => false, :type => 'boolstring'},
+      'success_url' => {:required => false, :type => 'string', length: 300},
+      'total_amount' => {:required => true, :type => 'currency'},
+      'total_tax' => {:required => false, :type => 'percent'},
+      'userid' => {:required => false, :type => 'string', length: 50},
+      'version' => {:required => true, :type => 'string', length: 10},
+      'webMasterId' => {:required => false, :type => 'string', length: 255},
+      'user_token' => {:required => false, :type => 'string', length: 8}, # register or auto
+      'user_token_id' => {:required => true, :type => 'string', length: 45}
+
+    } # 'time_stamp', 'numberofitems' and 'checksum' are inserted after validation.
+
+    ALLOWED_ITEM_FIELDS = {
+      'name' => {:required => true, :type => 'string', length: 400},
+      'number' => {:required => true, :type => 'string', length: 400},
+      'amount' => {:required => true, :type => 'currency'},
+      'quantity' => {:required => true, :type => 'int'},
+      'discount' => {:required => false, :type => 'percent'},
+      'shipping' => {:required => false, :type => 'currency'},
+      'handling' => {:required => false, :type => 'currency'},
+      'open_amount' => {:required => false, :type => 'boolstring'},
+      'min_amount' => {:required => false, :type => 'currency'},
+      'max_amount' => {:required => false, :type => 'currency'}
+    }
+
+    def initialize(url, params = {})
+      super(url, params)
+    end
+
+    protected
+
+    def calculate_checksum
+      codes = [Safecharge::Constants::SECRET_KEY,
+              self.params['merchant_id'],
+              self.params['currency'],
+              self.params['total_amount']]
+      self.items.each do |item|
+        codes << item['name']
+        codes << item['amount']
+        codes << item['quantity']
+        codes << item['open_amount']
+        codes << item['min_amount']
+        codes << item['max_amount']
+      end
+      codes << self.params['user_token_id']
+      codes << self.params['time_stamp']
+      s = codes.join('')
+      return Digest::MD5.hexdigest(s)
+    end
+
+  end
+end

data/safecharge.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'safecharge/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "safecharge"
+  spec.version       = Safecharge::VERSION
+  spec.authors       = ["Dave Sag"]
+  spec.email         = ["davesag@gmail.com"]
+  spec.description   = "Implements all of the features of the SafeCharge API."
+  spec.summary       = "A Ruby Wrapper for the SafeCharge API"
+  spec.homepage      = "http://cv.davesag.com/"
+  spec.license       = "MIT"
+  spec.date          = Time.now.utc.strftime("%Y-%m-%d")
+
+  spec.files         = `git ls-files`.split($/) - %w(.rspec .gitignore Rakefile) - `git ls-files test_data`.split($/) - `git ls-files spec`.split($/)
+  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_dependency "ox", "~> 2.0.5"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "dotenv"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: safecharge
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Dave Sag
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: Implements all of the features of the SafeCharge API.
+email:
+- davesag@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- lib/safecharge.rb
+- lib/safecharge/constants.rb
+- lib/safecharge/request.rb
+- lib/safecharge/response.rb
+- lib/safecharge/version.rb
+- lib/safecharge/wc_request.rb
+- safecharge.gemspec
+homepage: http://cv.davesag.com/
+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.7
+signing_key: 
+specification_version: 4
+summary: A Ruby Wrapper for the SafeCharge API
+test_files: []