ogone 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bec0a5e938c818872281ccd8fb3b33005b67234e
+  data.tar.gz: 7a28120c828924c4656abf5b562047720c5a76a3
+SHA512:
+  metadata.gz: 6b26d16f4c5741fb7eb0a7037b57ebcbd958d52e65a125d8d81d3fbb1ef559bdb941673e6ff98dbf3d6670a3dd4d2c4538fa97e08e8200bd9f86d1f1f10ebfd1
+  data.tar.gz: a55ebdc4b42f54fb82ee78b44cf95775a74123b8e7cc56f639188cb67ea6aa963361d1bf1cc2b1860f1ef51f5762aeca015681acec13579d9e04143c691d4f54

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2013 Applidget
+Copyright (c) 2013 Sébastien Saunier
+
+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,93 @@
+# Ogone
+
+This gem helps you to quickly get a `form` that can be submitted and redirect
+your users to the ogone ecommerce form where they can pay. This gem is flexible
+as it does not rely on a hard-coded configuration to be used. Therefore you can
+dynamically handle several PSPIDs.
+
+## Usage
+
+In your controller,
+
+```ruby
+require "ogone"
+
+class PaymentController
+  def ogone_form
+    @ogone = Ogone::Ecommerce.new :pspid => "your_pspid",
+                                  :environment => "prod",
+                                  :sha_algo => "SHA1",  # Configured in your back-office
+                                  :sha_in => "......",  # Configured in your back-office
+                                  :sha_out => "....."   # Configured in your back-office
+
+    # Add mandatory parameters. Alternatively can be passed directly in `@ogone.fields_for_payment`
+    @ogone.add_parameters(
+      :CURRENCY => "EUR",
+      :AMOUNT => 2000,  # Beware, that would be 20 EUR
+      :ORDERID => "...",
+      :LANGUAGE => "en_US"
+      # And many more parameters, refer to the Ogone documentation
+    )
+
+    # Configure where the user should be redirected once the payment is completed
+    # This sets the following urls:
+    #  - ACCEPTURL
+    #  - DECLINEURL
+    #  - EXCEPTIONURL
+    #  - CANCELURL
+    @ogone.add_single_return_url "http://your_application/route/to/ogone/return"
+  end
+end
+```
+
+Then in your view, you can quickly get the form up and running:
+
+```erb
+<%# ogone_form.html.erb %>
+
+<%= form_tag @ogone.form_action, :method => :post %>
+  <% @ogone.fields_for_payment.each do |name, value| %>
+    <%= hidden_field_tag name, value %>
+  <% end %>
+
+  <%= submit_tag "Pay" %>
+<% end %>
+```
+
+When clicking on the `Pay` button, your user will be redirected to the Ogone
+Ecommerce platform to enter his/her credit card info and pay. When the payment
+is completed, the user will be redirected to your application.
+
+This will be done via a `POST` request from Ogone to your app. This request contains
+parameters that Ogone gives to you so that you can update your own database. Before
+doing anything, you should check that the request signature is correct to make sure
+it comes from Ogone. To do so, just call:
+
+```ruby
+require "ogone"
+
+class PaymentController
+  def ogone_return
+    @ogone = Ogone::Ecommerce.new :sha_algo => "SHA1", :sha_out => "...."
+
+    begin
+      @ogone.check_shasign_out! params
+
+      status = params[:STATUS].to_i
+      if Ogone::PAID_STATUSES.include? status
+        # TODO: update database with payment info.
+      end
+    rescue Ogone::Ecommerce::OutboundSignatureMismatch
+      # The request did not come from Ogone, or there is a misconfiguration of sha_out.
+    end
+  end
+end
+```
+
+## 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/Rakefile

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

data/lib/ogone.rb

@@ -0,0 +1,3 @@
+require "ogone/version"
+require "ogone/status"
+require "ogone/ecommerce"

data/lib/ogone/ecommerce.rb

@@ -0,0 +1,120 @@
+module Ogone
+  class Ecommerce
+    VALID_ENVIRONMENTS = %w(test prod) unless const_defined? :VALID_ENVIRONMENTS
+    SIGNING_ALGORITHMS = %w(SHA1 SHA256 SHA512) unless const_defined? :SIGNING_ALGORITHMS
+
+    class ConfigurationError < StandardError; end
+
+    MANDATORY_PARAMETERS = %w(PSPID ORDERID AMOUNT CURRENCY LANGUAGE) unless const_defined? :MANDATORY_PARAMETERS
+    class MandatoryParameterMissing < StandardError; end
+
+    OUTBOUND_SIGNATURE_PARAMETERS = %w(AAVADDRESS AAVCHECK AAVZIP ACCEPTANCE ALIAS AMOUNT BIN \
+                                       BRAND CARDNO CCCTY CN COMPLUS CREATION_STATUS CURRENCY \
+                                       CVCCHECK DCC_COMMPERCENTAGE DCC_CONVAMOUNT DCC_CONVCCY \
+                                       DCC_EXCHRATE DCC_EXCHRATESOURCE DCC_EXCHRATETS DCC_INDICATOR \
+                                       DCC_MARGINPERCENTAGE DCC_VALIDHOURS DIGESTCARDNO ECI ED \
+                                       ENCCARDNO FXAMOUNT FXCURRENCY IP IPCTY NBREMAILUSAGE NBRIPUSAGE\
+                                       NBRIPUSAGE_ALLTX NBRUSAGE NCERROR ORDERID PAYID PM SCO_CATEGORY \
+                                       SCORING STATUS SUBBRAND SUBSCRIPTION_ID TRXDATE VC).collect &:to_sym unless const_defined? :OUTBOUND_SIGNATURE_PARAMETERS
+    class OutboundSignatureMismatch < StandardError; end
+
+    attr_accessor :sha_in, :sha_out
+
+    def initialize(options = {})
+      @parameters = Hash.new
+      [:sha_algo, :environment, :pspid, :sha_in, :sha_out].each do |config|
+        self.send :"#{config}=", options[config] unless options[config].nil?
+      end
+    end
+
+    def sha_algo=(sha_algo)
+      unless SIGNING_ALGORITHMS.include?(sha_algo)
+        raise ArgumentError.new("Unsupported signature algorithm: #{sha_algo}")
+      end
+      @sha_algo = sha_algo
+    end
+
+    def environment=(environment)
+      unless VALID_ENVIRONMENTS.include? environment.to_s
+        raise ArgumentError.new("Unsupported Ogone environment: #{environment}")
+      end
+      @environment = environment
+    end
+
+    def pspid=(pspid)
+      raise ArgumentError.new("PSPID cannot be empty") if pspid.nil? || pspid == ""
+      @parameters[:PSPID] = pspid
+    end
+
+    def form_action
+      unless VALID_ENVIRONMENTS.include? @environment.to_s
+        raise ConfigurationError.new("Unsupported Ogone environment: '#{@environment}'.")
+      end
+      "https://secure.ogone.com/ncol/#{@environment}/orderstandard_utf8.asp"
+    end
+
+    def add_single_return_url(return_url)
+      [:ACCEPTURL, :DECLINEURL, :EXCEPTIONURL, :CANCELURL].each do |field|
+        @parameters[field] = return_url
+      end
+    end
+
+    def add_parameters(parameters)
+      @parameters.merge! parameters
+    end
+
+    def fields_for_payment(parameters = {})
+      add_parameters(parameters || {})
+      check_mandatory_parameters!
+
+      upcase_keys(@parameters).merge :SHASIGN => sha_in_sign
+    end
+
+    def check_shasign_out!(params)
+      params = upcase_keys(params)
+      raise OutboundSignatureMismatch.new if sha_out_sign(params) != params[:SHASIGN]
+    end
+
+    def upcase_keys(hash)
+      hash.inject({}) { |h, (k, v)| h[k.upcase.to_sym] = v; h }
+    end
+
+    private
+
+    def sha_in_sign
+      to_hash = sorted_upcased_parameters.inject([]) {
+                  |a, (k, v)| a << "#{k}=#{v}#{@sha_in}" unless v.nil? || v == ""
+                  a
+                }.join
+      sign to_hash
+    end
+
+    def sha_out_sign(params)
+      to_hash = OUTBOUND_SIGNATURE_PARAMETERS.inject([]) {
+                  |a, p| a << "#{p}=#{params[p]}#{@sha_out}" unless params[p].nil? || params[p] == ""
+                  a
+                }.join
+      sign to_hash
+    end
+
+    def sign(to_hash)
+      unless SIGNING_ALGORITHMS.include?(@sha_algo)
+        raise ArgumentError.new("Unsupported signature algorithm: '#{@sha_algo}'")
+      end
+      Digest.const_get(@sha_algo).hexdigest(to_hash).upcase
+    end
+
+    def sorted_upcased_parameters
+      upcase_keys(@parameters).sort
+    end
+
+    def check_mandatory_parameters!
+      MANDATORY_PARAMETERS.each do |parameter|
+        unless @parameters.include? parameter.to_sym
+          raise MandatoryParameterMissing.new parameter
+        end
+      end
+    end
+
+  end
+end

data/lib/ogone/status.rb

@@ -0,0 +1,45 @@
+module Ogone
+
+  STATUS = {
+    0  => 'Incomplete or invalid',
+    1  => 'Cancelled by client',
+    2  => 'Authorization refused',
+    4  => 'Order stored',
+    41 => 'Waiting client payment',
+    5  => 'Authorized',
+    51 => 'Authorization waiting',
+    52 => 'Authorization not known',
+    55 => 'Stand-by',
+    59 => 'Authoriz. to get manually',
+    6  => 'Authorized and cancelled',
+    61 => 'Author. deletion waiting',
+    62 => 'Author. deletion uncertain',
+    63 => 'Author. deletion refused',
+    64 => 'Authorized and cancelled',
+    7  => 'Payment deleted',
+    71 => 'Payment deletion pending',
+    72 => 'Payment deletion uncertain',
+    73 => 'Payment deletion refused',
+    74 => 'Payment deleted',
+    75 => 'Deletion processed by merchant',
+    8  => 'Refund',
+    81 => 'Refund pending',
+    82 => 'Refund uncertain',
+    83 => 'Refund refused',
+    84 => 'Payment declined by the acquirer',
+    85 => 'Refund processed by merchant',
+    9  => 'Payment requested',
+    91 => 'Payment processing',
+    92 => 'Payment uncertain',
+    93 => 'Payment refused',
+    94 => 'Refund declined by the acquirer',
+    95 => 'Payment processed by merchant',
+    99 => 'Being processed'
+  } unless const_defined? :STATUS
+
+  PAID_STATUSES = [4, 5, 9] unless const_defined? :PAID_STATUSES
+  PENDING_STATUSES = [41, 51, 52, 91, 92, 99] unless const_defined? :PENDING_STATUSES
+  CANCELLED_STATUSES = [1] unless const_defined? :CANCELLED_STATUSES
+  REFUNDED_STATUSES = [8] unless const_defined? :REFUNDED_STATUSES
+
+end

data/lib/ogone/version.rb

@@ -0,0 +1,3 @@
+module Ogone
+  VERSION = "0.1.0"
+end

data/ogone.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ogone/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ogone"
+  spec.version       = Ogone::VERSION
+  spec.authors       = ["Sebastien Saunier"]
+  spec.email         = ["seb@saunier.me"]
+  spec.description   = %q{Flexible Ogone ecommerce wrapper
+
+Deal simply with multiple ogone ecommerce account within your application.
+No hard coded configuration read from a *.yml file.
+  }
+  spec.summary       = %q{Flexible Ogone ecommerce wrapper}
+  spec.homepage      = "https://github.com/applidget/ogone"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/spec/ogone/ecommerce_spec.rb

@@ -0,0 +1,118 @@
+require "ogone/ecommerce"
+
+module Ogone
+  describe Ecommerce do
+
+    before(:each) do
+      @ogone = Ogone::Ecommerce.new
+    end
+
+    it "should raise an error if incorrect sha algorithm given" do
+      lambda { @ogone.sha_algo = 'WRONG_SHA' }.should raise_error ArgumentError
+    end
+
+    it "should raise an error if incorrect ogone environment given" do
+      lambda { @ogone.environment = 'WRONG_ENV' }.should raise_error ArgumentError
+    end
+
+    it "should raise an error if an empty PSPID is specified" do
+      lambda { @ogone.pspid = '' }.should raise_error ArgumentError
+    end
+
+    it "should render the test Ogone url" do
+      @ogone.environment = "test"
+      @ogone.form_action.should eq "https://secure.ogone.com/ncol/test/orderstandard_utf8.asp"
+    end
+
+    it "should render the production Ogone url" do
+      @ogone.environment = "prod"
+      @ogone.form_action.should eq "https://secure.ogone.com/ncol/prod/orderstandard_utf8.asp"
+    end
+
+    it "should have the PSPID stored in the parameters" do
+      @ogone.pspid = "pspid"
+      parameters[:PSPID].should eq "pspid"
+    end
+
+    describe "#check_shasign_out!" do
+
+      before(:each) do
+        @ogone = Ogone::Ecommerce.new :sha_out => "sha_out", :sha_algo => "SHA1"
+      end
+
+      it "should check an inbound signature" do
+        params = ogone_return_parameters
+        lambda { @ogone.check_shasign_out! params }.should_not raise_error Ogone::Ecommerce::OutboundSignatureMismatch
+      end
+
+      it "should throw an error if the outbound shasign does not match" do
+        params = {
+          "amonut" => "160",
+          "SHASIGN" => "FOO"
+        }
+        lambda { @ogone.check_shasign_out! params }.should raise_error Ogone::Ecommerce::OutboundSignatureMismatch
+      end
+    end
+
+    describe "#fields_for_payment" do
+
+      before(:each) do
+        @ogone = Ogone::Ecommerce.new :pspid => "pspid", :sha_in => "sha_in", :sha_algo => "SHA1"
+      end
+
+      it "should give a hash ready to be used in `hidden_field_tag`" do
+        fields = @ogone.fields_for_payment :AMOUNT => 100,
+                                           :CURRENCY => "EUR",
+                                           :ORDERID => "123",
+                                           :LANGUAGE => "en_US"
+
+        fields[:SHASIGN].should eq "AA7CA1F98159D14D0943311092F5435F239B4B36"
+      end
+
+      it "should also work if parameters were given with #add_parameters" do
+        @ogone.add_parameters :AMOUNT => 100, :CURRENCY => "EUR", :ORDERID => "123", :LANGUAGE => "en_US"
+
+        fields = @ogone.fields_for_payment
+        fields[:SHASIGN].should eq "AA7CA1F98159D14D0943311092F5435F239B4B36"
+      end
+
+    end
+
+    describe "#add_single_return_url" do
+      it "should allow lazy folks to give just one back url" do
+        @ogone.add_single_return_url "http://iamsola.zy"
+        parameters[:ACCEPTURL].should eq "http://iamsola.zy"
+        parameters[:DECLINEURL].should eq "http://iamsola.zy"
+        parameters[:EXCEPTIONURL].should eq "http://iamsola.zy"
+        parameters[:CANCELURL].should eq "http://iamsola.zy"
+      end
+    end
+
+    private
+
+    def parameters
+      @ogone.instance_variable_get :@parameters
+    end
+
+    def ogone_return_parameters
+      {
+        "orderID" => "r_511b52f7230b430b3f000003_19",
+        "currency" => "EUR",
+        "amount" => "160",
+        "PM" => "CreditCard",
+        "ACCEPTANCE" => "",
+        "STATUS" => "1",
+        "CARDNO" => "",
+        "ED" => "",
+        "CN" => "Sebastien Saunier",
+        "TRXDATE" => "02/13/13",
+        "PAYID" => "19113975",
+        "NCERROR" => "",
+        "BRAND" => "",
+        "COMPLUS" => "registration_511b52f7230b430b3f000003",
+        "IP" => "80.12.86.33",
+        "SHASIGN" => "F3F5F963C700F56B69EA36173F5BFB3B28CA25E5",
+      }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require 'ogone'
+
+# RSpec.configure do |config|
+# end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: ogone
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sebastien Saunier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-11 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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ! "Flexible Ogone ecommerce wrapper\n\nDeal simply with multiple ogone
+  ecommerce account within your application.\nNo hard coded configuration read from
+  a *.yml file.\n  "
+email:
+- seb@saunier.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/ogone.rb
+- lib/ogone/ecommerce.rb
+- lib/ogone/status.rb
+- lib/ogone/version.rb
+- ogone.gemspec
+- spec/ogone/ecommerce_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/applidget/ogone
+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.1.0
+signing_key: 
+specification_version: 4
+summary: Flexible Ogone ecommerce wrapper
+test_files:
+- spec/ogone/ecommerce_spec.rb
+- spec/spec_helper.rb