ogone-rails 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,85 @@
-ogone-rails
-===========
+#Ogone for Rails
 
-Add Ogone payments functionality to a Rails application
+
+##What is it
+
+A Ruby gem to simplify the use of [Ogone](http://www.ogone.com) online payments service.
+
+
+##Usage
+
+### Installation
+	gem install ogone-rails
+
+### Configuration
+Define:
+
+* PSPID
+* sha_in
+* sha_out
+* currency | default: "EUR"
+* language | default: "nl_NL"
+* test | default = "live"
+
+
+
+		# config/initializers/ogone-rails.rb
+		
+		OgoneRails::config ({
+		  :pspid => "myPSPID",
+		  :sha_in => "0123456789abcdefghijklmnopqrstuv",
+		  :sha_out => "vutsrqponmlkjihgfedcba9876543210",
+		  :mode => "test""
+		})
+
+
+
+### Helpers
+Generate an **ogone_form**:
+
+	ogone_form({
+    	:order_id => 12345, 
+    	:amount => 299.99, 
+    	:customer_name => "Jan Janssen",
+    	:customer_email => "jan@email.com",
+   		:customer_address => "highstreet 101",
+   		:customer_zip => "1000",
+    	:customer_city => "Brussel",
+    	:customer_country => "Belgium",
+    	:customer_phone => "0412345678"
+ 	 })
+
+### Check Ogone feedback
+
+Create a new object to check the feedback Ogone gives you:
+
+	# app/controllers/feedback_controller.rb
+    @check = OgoneRails::CheckAuth.new( request.GET )
+
+Check valid authorization:
+	
+	@check.valid?
+	#return true or false
+
+Get parameters, returned in a hash format. The keys are renamed to be much more readable:
+	
+	@check.get_parameters
+	
+… will return …
+
+	{
+		"order_id" => "46185", 
+		"amount" => "299.38", 
+		"currency" => "EUR", 
+		"payment_method" => "CreditCard",
+		"acceptance" => "test123", 
+		"status" => "5", 
+		"card_number" => "XXXXXXXXXXXX1111",
+		"pay_id" => "14838904", 
+		"error" => nil, 
+		"brand" => "VISA",
+		"sha_sign" => "51AF71351E79DD0186816289AD53C57213978E32"
+	}
+	
+### Copyright
+Copyright © 2012 Robin Houdmeyers

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/ogone-rails/check-auth.rb

@@ -0,0 +1,56 @@
+module OgoneRails  
+  
+  class CheckAuth 
+    
+    def initialize request
+      @request = request
+      @params = {}
+      get_params
+    end
+    
+    
+    def valid?
+      # Check authentication
+      # sha_sign == sha_out_phrase
+      sha_sign, sha_out_phrase, ogone_return = @request['SHASIGN'], "", {}
+      
+      # Upcase and sort paramaters to params
+      @request.each do |key, value|
+        ogone_return[key.upcase] = value unless key == 'SHASIGN' # exclude SHASIGN
+      end
+
+      # Generate sha_out_hash
+      ogone_return.sort.each do |key, value|
+        sha_out_phrase << "#{key.upcase}=#{value}#{OgoneRails::sha_out}"
+      end      
+      
+      # Digest sha_out_phrase
+      sha_check = Digest::SHA1.hexdigest(sha_out_phrase).upcase
+    
+      # Compare sha_sign with digested phrase
+      if sha_check == sha_sign
+        return true
+      else
+       return false
+      end
+    end
+    
+
+    def get_params
+      # return values in readable format
+      @params = {
+        :order_id => (@request['orderID']).to_i,
+        :amount => (@request['amount']).to_f,
+        :currency => @request['currency'],
+        :payment_method => @request['PM'],
+        :acceptance => @request['ACCEPTANCE'],
+        :status => STATUS_CODES[@request['STATUS'].to_i],
+        :card_number => @request['CARDNO'],
+        :pay_id => @request['PAYID'],
+        :error => @request['NC ERROR'],
+        :brand => @request['BRAND'],
+        :sha_sign => @request['SHASIGN']
+      }
+    end
+  end
+end

data/lib/ogone-rails/config.rb

@@ -1,65 +1,98 @@
 module OgoneRails
+  extend self
   
-  module Config
-
-    TEST_SERVICE_URL = 'https://secure.ogone.com/ncol/test/orderstandard.asp'
-    LIVE_SERVICE_URL = 'https://secure.ogone.com/ncol/prod/orderstandard.asp'
-        
-    # sha_in
-    def self.sha_in= sha
-      @sha_in = sha
-    end
-    
-    def self.sha_in
-      @sha_in
-    end
-    
-    # sha_out
-    def self.sha_out= sha
-      @sha_out = sha
-    end
-    
-    def self.sha_out
-      @sha_out
-    end
-    
-    
-    # PSPID
-    def self.pspid= id
-      @pspid = id
-    end
-    
-    def self.pspid
-      @pspid
-    end
-    
-    
-    # currency
-    def self.currency= currency
-      @currency = currency
-    end
-    
-    def self.currency
-      @currency
-    end
-    
-    
-    # language
-    def self.language= language
-      @language = language
-    end
-    
-    def self.language
-      @language
-    end
+  TEST_SERVICE_URL = 'https://secure.ogone.com/ncol/test/orderstandard.asp'
+  LIVE_SERVICE_URL = 'https://secure.ogone.com/ncol/prod/orderstandard.asp'  
+  STATUS_CODES = {
+    0   => "Incomplete or invalid",
+    1	  => "Cancelled by client",
+    2	  => "Authorization refused",
+    4	  => "Order stored",
+    40  => "Stored waitingexternal result",
+    41  => "Waiting client payment",
+    5	  => "Authorized",
+    50  => "Authorized waiting external result",
+    51  => "Authorization waiting",
+    52  => "Authorization not known",
+    55  => "Stand-by",
+    56  => "OK with scheduled payments",
+    57  => "Error in scheduled payments",
+    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"
+  }
+  
+  @pspid    = nil
+  @sha_in   = nil
+  @sha_out  = nil
+  @currency = "EUR"
+  @language = "nl_NL"
+  @mode    = "live"
+  
+  def config c = {}
     
-    # debug
-    def self.debug= bool = false  # default to production url 
-      @test = bool
+    c.each do |key, value|
+      case key
+      when :pspid
+        @pspid = value
+      when :sha_in
+        @sha_in = value
+      when :sha_out
+        @sha_out = value
+      when :currency
+        @currency = value
+      when :language
+        @language = value
+      when :mode
+        @mode = value
+      end
     end
+  end
     
-    def self.debug
-      @test
-    end    
+
+  def self.sha_in
+    @sha_in
+  end
+
+  def self.sha_out
+    @sha_out
+  end
+
+  def self.pspid
+    @pspid
+  end
+
+  def self.currency
+    @currency
+  end
+
+  def self.language
+    @language
+  end
+
+  def self.mode
+    @mode
   end
 end

data/lib/ogone-rails/helpers.rb

@@ -5,58 +5,66 @@ module OgoneRails
     def ogone_form options={}
       form = ""
       
-      if OgoneRails::Config.debug
-        form = "<form method='post' action='#{OgoneRails::Config::TEST_SERVICE_URL}'>\n"
-      else
-        form = "<form method='post' action='#{OgoneRails::Config::LIVE_SERVICE_URL}'>\n"
-      end
+      OgoneRails::mode == "live" ? action = OgoneRails::LIVE_SERVICE_URL : action = OgoneRails::TEST_SERVICE_URL
+      
+      form << "<form method='post' action='#{action}'>\n"
       
       # REQUIRED VALUES
       StringToHash::reset
       # pspid
-      form << "\t<input type='hidden' name='PSPID' value='#{OgoneRails::Config.pspid}'>\n"
-      StringToHash::add_parameter 'PSPID', OgoneRails::Config.pspid
+      form << "\t<input type='hidden' name='PSPID' value='#{OgoneRails::pspid}'>\n"
+      StringToHash::add_parameter 'PSPID', OgoneRails::pspid
       # currency
-      form << "\t<input type='hidden' name='currency' value='#{OgoneRails::Config.currency}'>\n"
-      StringToHash::add_parameter 'currency', OgoneRails::Config.currency
+      form << "\t<input type='hidden' name='currency' value='#{OgoneRails::currency}'>\n"
+      StringToHash::add_parameter 'currency', OgoneRails::currency
       # language
-      form << "\t<input type='hidden' name='language' value='#{OgoneRails::Config.language}'>\n"
-      StringToHash::add_parameter 'language', OgoneRails::Config.language
+      form << "\t<input type='hidden' name='language' value='#{OgoneRails::language}'>\n"
+      StringToHash::add_parameter 'language', OgoneRails::language
       
       
       
       # OPTIONAL VALUES
       options.each do |option, value|
         case option
+        
         when :order_id
           form << "\t<input type='hidden' name='orderID' value='#{value}'>\n"
           StringToHash::add_parameter 'orderID', value
+          
         when :amount
           #amount 15.00 -> 1500
           value = (value.to_f * 100).to_i
           form << "\t<input type='hidden' name='amount' value='#{value}'>\n"
           StringToHash::add_parameter 'amount', value
+          
         when :customer_name
           form << "\t<input type='hidden' name='CN' value='#{value}'>\n"
           StringToHash::add_parameter 'CN', value
+          
         when :customer_email
           form << "\t<input type='hidden' name='EMAIL' value='#{value}'>\n"
           StringToHash::add_parameter 'EMAIL', value
+          
         when :customer_address
           form << "\t<input type='hidden' name='owneraddress' value='#{value}'>\n"
           StringToHash::add_parameter 'owneraddress', value
+          
         when :customer_zip
           form << "\t<input type='hidden' name='ownerZIP' value='#{value}'>\n"
           StringToHash::add_parameter 'ownerZIP', value
+          
         when :customer_city
           form << "\t<input type='hidden' name='ownertown' value='#{value}'>\n"
           StringToHash::add_parameter 'ownertown', value
+          
         when :customer_country
           form << "\t<input type='hidden' name='ownercty' value='#{value}'>\n"          
           StringToHash::add_parameter 'ownercty', value
+          
         when :customer_phone
           form << "\t<input type='hidden' name='ownertelno' value='#{value}'>\n"
           StringToHash::add_parameter 'ownertelno', value
+          
         else
           form << "\t<input type='hidden' name='#{option}' value='#{value}'>\n"
         end

data/lib/ogone-rails/{string_to_hash.rb → string-to-hash.rb}

@@ -10,7 +10,7 @@ module OgoneRails
     
     def generate_sha_in
       @params.sort.each do |key, value|
-        @sha_in_phrase << "#{key.upcase}=#{value}#{OgoneRails::Config.sha_in}"
+        @sha_in_phrase << "#{key.upcase}=#{value}#{OgoneRails::sha_in}"
       end
       
       Digest::SHA1.hexdigest(@sha_in_phrase).upcase

data/lib/ogone-rails.rb

@@ -4,50 +4,6 @@ require 'digest'
 
 require 'ogone-rails/config'
 require 'ogone-rails/rails'
-require 'ogone-rails/string_to_hash'
+require 'ogone-rails/string-to-hash'
 require 'ogone-rails/helpers'
-
-
-module OgoneRails
-  extend self
-  
-  def check_auth feedback
-    sha_sign = feedback['SHASIGN']
-        
-    params = {}
-    
-    # upcase and sort paramaters to params
-    # exclude SHASIGN
-    feedback.each do |key, value|
-      params[key.upcase] = value unless key == 'SHASIGN'
-    end
-        
-    
-    sha_out_phrase = ""
-    # generate sha_out_hash
-    params.sort.each do |key, value|
-      sha_out_phrase << "#{key.upcase}=#{value}#{OgoneRails::Config.sha_out}"
-    end
-    
-    sha_check = Digest::SHA1.hexdigest(sha_out_phrase).upcase
-    
-    if sha_check == sha_sign
-      # return values in readable format
-      {
-        'order_id' => feedback['orderID'],
-        'amount' => feedback['amount'],
-        'currency' => feedback['currency'],
-        'payment_method' => feedback['PM'],
-        'acceptance' => feedback['ACCEPTANCE'],
-        'status' => feedback['STATUS'],
-        'card_number' => feedback['CARDNO'],
-        'pay_id' => feedback['PAYID'],
-        'error' => feedback['NC ERROR'],
-        'brand' => feedback['BRAND'],
-        'sha_sign' => feedback['SHASIGN']
-      }
-    else
-      false
-    end
-  end
-end
+require 'ogone-rails/check-auth'

data/ogone-rails.gemspec

@@ -5,17 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = "ogone-rails"
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robin Houdmeyers"]
-  s.date = "2012-05-10"
+  s.date = "2012-05-14"
   s.description = "Add Ogone payments functionality to your Rails application"
   s.email = "houdmeyers@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.md",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -23,14 +22,14 @@ Gem::Specification.new do |s|
     "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
-    "README.rdoc",
     "Rakefile",
     "VERSION",
     "lib/ogone-rails.rb",
+    "lib/ogone-rails/check-auth.rb",
     "lib/ogone-rails/config.rb",
     "lib/ogone-rails/helpers.rb",
     "lib/ogone-rails/rails.rb",
-    "lib/ogone-rails/string_to_hash.rb",
+    "lib/ogone-rails/string-to-hash.rb",
     "ogone-rails.gemspec",
     "test/helper.rb",
     "test/test_ogone-rails.rb"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ogone-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-10 00:00:00.000000000 Z
+date: 2012-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70279657186260 !ruby/object:Gem::Requirement
+  requirement: &70331864054080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279657186260
+  version_requirements: *70331864054080
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70279657183380 !ruby/object:Gem::Requirement
+  requirement: &70331864052940 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70279657183380
+  version_requirements: *70331864052940
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70279657182660 !ruby/object:Gem::Requirement
+  requirement: &70331864007560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *70279657182660
+  version_requirements: *70331864007560
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70279657181700 !ruby/object:Gem::Requirement
+  requirement: &70331864006060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70279657181700
+  version_requirements: *70331864006060
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70279657180860 !ruby/object:Gem::Requirement
+  requirement: &70331864004080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +65,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70279657180860
+  version_requirements: *70331864004080
 description: Add Ogone payments functionality to your Rails application
 email: houdmeyers@gmail.com
 executables: []
@@ -73,21 +73,20 @@ extensions: []
 extra_rdoc_files:
 - LICENSE.txt
 - README.md
-- README.rdoc
 files:
 - .document
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
-- README.rdoc
 - Rakefile
 - VERSION
 - lib/ogone-rails.rb
+- lib/ogone-rails/check-auth.rb
 - lib/ogone-rails/config.rb
 - lib/ogone-rails/helpers.rb
 - lib/ogone-rails/rails.rb
-- lib/ogone-rails/string_to_hash.rb
+- lib/ogone-rails/string-to-hash.rb
 - ogone-rails.gemspec
 - test/helper.rb
 - test/test_ogone-rails.rb
@@ -106,7 +105,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2064012355136434449
+      hash: 3204021684087159827
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/README.rdoc

@@ -1,19 +0,0 @@
-= ogone-rails
-
-Description goes here.
-
-== Contributing to ogone-rails
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2012 Robin Houdmeyers. See LICENSE.txt for
-further details.
-