ogone-rails 0.0.4 → 0.1.0

data/README.md

@@ -10,65 +10,127 @@ A Ruby gem to simplify the use of [Ogone](http://www.ogone.com) online payments
 
 ### Installation
 	gem install ogone-rails
+	# or include in a gemfile
+	gem 'ogone-rails'
 
 ### Configuration
-Define:
+Define ogone parameters in a yaml config file:
+		
+		# config/ogone.yml
+		development:
+  			pspid: "hoetmaaiers"
+  			sha_in: "0123456789abcdefghijklmnopqrstuv"
+  			sha_out: "vutsrqponmlkjihgfedcba9876543210"
+  			currency: "EUR"
+  			language: "nl_NL"
+  			mode: 'test'
+  		production:
+  			pspid: "hoetmaaiers"
+  			sha_in: "0123456789abcdefghijklmnopqrstuv"
+  			sha_out: "vutsrqponmlkjihgfedcba9876543210"
+  			currency: "EUR"
+  			language: "nl_NL"
+  			mode: 'live'
+
+Configure ogone-rails in an initializer:
+		
+		# initializers/ogone.rb
+		ogone_config = YAML.load_file('config/ogone.yml')[Rails.env].symbolize_keys
+		OgoneRails::config (ogone_config)
+		
+
+#### Parameters	
+__required__
 
 * PSPID
 * sha_in
 * sha_out
-* currency | default: "EUR"
-* language | default: "nl_NL"
-* test | default = "live"
-
 
+__optional__
 
-		# config/initializers/ogone-rails.rb
-		
-		OgoneRails::config ({
-		  :pspid => "myPSPID",
-		  :sha_in => "0123456789abcdefghijklmnopqrstuv",
-		  :sha_out => "vutsrqponmlkjihgfedcba9876543210",
-		  :mode => "test""
-		})
+* currency,  _default: "EUR"_
+* language, _default: "nl_NL"_
+* mode, _default = "live"_
 
 
 
 ### Helpers
-Generate an **ogone_form**:
+
+#### New syntax
+
+Generate an **ogone_form** whith the new syntax.
+
+
+**Full example**
+	
+	ogone_form_tag({:id => "form"}) do 
+		form_content = ogone_fields({  
+	        :parameter => value
+	        ...
+	      })
+	
+		# add custom submit
+		form_content << '<input type="submit" value="pay now" />'
+	end
+
+**ogone_form_tag** example
+	
+	ogone_form_tag({ :html_attribute => "value" }) do 
+		...
+		# everything in here must be in one variable
+		form_content = "…"
+		form_content << "…"		
+		...
+	end
+
+**ogone_fields** example
+
+Generate hidden input fields with ogone parameters.
+
+
+	ogone_fields({
+		:parameter => "value",
+		...
+	}
+
+#### Parameters
+
+      ogone_fields_options = {
+        # General parameters
+        :order_id           => 'orderID',
+        :amount             => 'amount',
+        :customer_name      => 'CN',
+        :customer_email     => 'EMAIL',
+        :customer_address   => 'owneraddress',
+        :customer_zip       => 'ownerZIP',
+        :customer_city      => 'ownertown',
+        :customer_country   => 'ownercty',
+        :customer_phone     => 'ownertelno',
+        # Feedback url's    
+        :accept_url         => 'accepturl',
+        :decline_url        => 'declineurl',
+        :exception_url      => 'exceptionurl',
+        :cancel_url         => 'cancelurl',
+        # Look and feel     
+        :title              => 'TITLE',
+        :bg_color           => 'BGCOLOR',
+        :text_color         => 'TXTCOLOR',
+        :table_bg_color     => 'TBLBGCOLOR',
+        :table_text_color   => 'TBLTXTCOLOR',
+        :button_bg_color    => 'BUTTONBGCOLOR',
+        :button_text_color  => 'BUTTONTXTCOLOR',
+        :font_family        => 'FONTTYPE',
+        :logo               => 'LOGO'       
+      }
+
+
+
+####No worry, old syntax is still enabled...
+
 
 	ogone_form({
-		#transaction information
-    	: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",
-    	
-    	# feedback url's
-    	:accept_url => "www.example.com/ogone/accept",
-    	:decline_url => "www.example.com/ogone/decline",
-    	:exception_url => "www.example.com/ogone/exception",
-    	:cancel_url => "www.example.com/ogone/cancel",
-    	
-    	# look and feel
-    	:title => "lorem ipsum",
-    	:bg_color => "FFFFFF",
-    	:text_color => "000000",
-    	:table_bg_color => "000000",
-    	:table_text_color => "000000",    	
-    	:button_bg_color => "CCCCCC",
-    	:button_text_color => "000000",
-    	:font_family => "Helvetica",
-    	:logo => "www.example.com/images/logo.png",
-    	
-    	# default ogone parameter
-    	'PARAM' => "example"
-   	})
+		:paramater => "value"
+   	}, { :html_attribute => "" })
 
 ### Check Ogone feedback
 

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.0

data/lib/generators/ogone/config_generator.rb

@@ -0,0 +1,46 @@
+require "rails/generators/base"
+
+module Ogone  
+  class ConfigGenerator < Rails::Generators::Base
+    source_root File.expand_path("../templates", __FILE__)
+    
+    desc "generate yaml and initializer config for ogone-rails.gem usage"
+
+    def copy_files
+      say_status "", "time to put configuration files in place... \n", :blue
+      copy_file "ogone.yml", "config/ogone.yml"
+      copy_file "ogone.rb", "config/initializers/ogone.rb"
+    end
+      
+    def print_manual
+      say_status "OK", "...configuration files are in place.", :green
+      say "\nNow it's time to change the example documentation in 'config/ogone.yml' to your ogone details.", :bold
+      say "More information can be found on https://github.com/robinhoudmeyers/ogone-rails or http://www.ogone.com.\n"
+    end
+  end
+end
+
+    
+# def yaml_config
+#   # create settings directory
+#   settings_path = File.join(::Rails.root.to_s, "config/settings")
+#   unless File.directory?(settings_path)
+#     p "CREATING 'config/settings/ directory ..." 
+#     Dir.mkdir(settings_path)
+#   end
+# 
+#   # # write yaml file
+#   p "WRITING yaml.config..."
+# 
+#   # create a configuration file
+#   snap_up_yaml_original = File.join(File.dirname(__FILE__), '../../..', 'install', 'snap_up.yml')
+#   snap_up_yaml_filepath = File.join(::Rails.root.to_s, 'config/settings', 'snap_up.yml')
+# 
+# 
+# 
+#   if FileUtils.cp_r snap_up_yaml_original, snap_up_yaml_filepath
+#       puts "A configuration file has been CREATED at #{ snap_up_yaml_filepath }"
+#   else
+#       puts "Can't create #{ snap_up_yaml_filepath }"
+#   end
+# end

data/lib/generators/ogone/templates/ogone.rb

@@ -0,0 +1,4 @@
+# -*- encoding : utf-8 -*
+# load yaml configuration for current environment && symbolize_keys
+ogone_config = YAML.load_file('config/ogone.yml')[Rails.env].symbolize_keys
+OgoneRails::config (ogone_config)

data/lib/generators/ogone/templates/ogone.yml

@@ -0,0 +1,23 @@
+development:
+  pspid: "example"
+  sha_in: "0123456789abcdefghijklmnopqrstuv"
+  sha_out: "vutsrqponmlkjihgfedcba9876543210"
+  currency: "EUR"
+  language: "nl_NL"
+  mode: 'test'
+  
+test:
+  pspid: "example"
+  sha_in: "0123456789abcdefghijklmnopqrstuv"
+  sha_out: "vutsrqponmlkjihgfedcba9876543210"
+  currency: "EUR"
+  language: "nl_NL"
+  mode: 'test'
+  
+production:
+  pspid: "example"
+  sha_in: "0123456789abcdefghijklmnopqrstuv"
+  sha_out: "vutsrqponmlkjihgfedcba9876543210"
+  currency: "EUR"
+  language: "nl_NL"
+  mode: 'live'

data/lib/ogone-rails.rb

@@ -4,6 +4,7 @@ require 'digest'
 
 require 'ogone-rails/config'
 require 'ogone-rails/rails'
+require 'ogone-rails/form'
 require 'ogone-rails/string-to-hash'
 require 'ogone-rails/helpers'
 require 'ogone-rails/check-auth'

data/lib/ogone-rails/config.rb

@@ -51,7 +51,7 @@ module OgoneRails
   @language = "nl_NL"
   @mode    = "live"
   
-  def config c = {}
+  def config c
     
     c.each do |key, value|
       case key
@@ -62,11 +62,11 @@ module OgoneRails
       when :sha_out
         @sha_out = value
       when :currency
-        @currency = value
+        @currency = value unless value.nil?
       when :language
-        @language = value
+        @language = value unless value.nil?
       when :mode
-        @mode = value
+        @mode = value unless value.nil?
       end
     end
   end

data/lib/ogone-rails/form.rb

@@ -0,0 +1,23 @@
+module OgoneRails
+  class Form
+    attr_reader :form_tag, :form_fields
+    
+    def initialize
+      @form_fields = ""
+    end
+    
+    def get_form_tag action = "", options = {}      
+      # parse form atributes
+      form_attributes = ""
+      options.each do |key, value|
+        form_attributes << "#{key}=\"#{value}\" "
+      end
+      
+      @form_tag = "<form method='post' action='#{action}' #{ form_attributes }>\n"
+    end
+    
+    def add_input name, value
+      @form_fields << "\t<input type='hidden' name='#{name}' value='#{value}' />\n"
+    end
+  end
+end

data/lib/ogone-rails/helpers.rb

@@ -3,173 +3,94 @@ module OgoneRails
   module Helpers
     extend self
 
-    def ogone_form options={}
-      
+    @hash
+    @form
+     
+    def ogone_form_tag options={}
       OgoneRails::mode == "live" ? action = OgoneRails::LIVE_SERVICE_URL : action = OgoneRails::TEST_SERVICE_URL
       
-      form = Form.new(action)
-      hash = StringToHash.new
+      @form = Form.new
       
-      # REQUIRED VALUES
-      # hash.reset
-      # pspid
-      form.add_input('PSPID', OgoneRails::pspid)
-      hash.add_parameter 'PSPID', OgoneRails::pspid
-      # currency
-      form.add_input('currency', OgoneRails::currency)
-      hash.add_parameter 'currency', OgoneRails::currency
-      # language
-      form.add_input('language', OgoneRails::language)
-      hash.add_parameter 'language', OgoneRails::language
+      form_content = yield(form_content)
       
+      output = @form.get_form_tag(action, options)
+      output << form_content
+      output << "\n</form>"#.html_safe
       
+      # block.methods
+      output.html_safe
+    end
+    
+    
+    def ogone_fields options = {}
+      @form = Form.new
+      @hash = StringToHash.new
       
-      # OPTIONAL VALUES
-      options.each do |option, value|
-        case option
-        
-        
-        # ------------------
-        # General parameters
-        
-        when :order_id
-          form.add_input('orderID', value)
-          hash.add_parameter 'orderID', value
-          
-        when :amount
-          #amount 15.00 -> 1500
-          value = (value.to_f * 100).to_i
-          form.add_input('amount', value)
-          hash.add_parameter 'amount', value
-          
-        when :customer_name
-          form.add_input('CN', value)
-          hash.add_parameter 'CN', value
-          
-        when :customer_email
-          form.add_input('EMAIL', value)
-          hash.add_parameter 'EMAIL', value
-          
-        when :customer_address
-          form.add_input('owneraddress', value)
-          hash.add_parameter 'owneraddress', value
-          
-        when :customer_zip
-          form.add_input('ownerZIP', value)
-          hash.add_parameter 'ownerZIP', value
-          
-        when :customer_city
-          form.add_input('ownertown', value)
-          hash.add_parameter 'ownertown', value
-          
-        when :customer_country
-          form.add_input('ownercty', value)
-          hash.add_parameter 'ownercty', value
-          
-        when :customer_phone
-          form.add_input('ownertelno', value)
-          hash.add_parameter 'ownertelno', value
-        
-        
-        # --------------
-        # Feedback url's
-        
-        when :accept_url
-          form.add_input('accepturl', value)
-          hash.add_parameter 'accepturl', value
-          
-        when :decline_url
-          form.add_input('declineurl', value)
-          hash.add_parameter 'declineurl', value
-        
-        when :exception_url
-          form.add_input('exceptionurl', value)
-          hash.add_parameter 'exceptionurl', value
-          
-        when :cancel_url
-          form.add_input('cancelurl', value)
-          hash.add_parameter 'cancelurl', value
-        
-        
-        # --------------
-        # Look and feel
-        
-        when :title
-          form.add_input('TITLE', value)
-          hash.add_parameter 'TITLE', value
-
-        when :bg_color
-          form.add_input('BGCOLOR', value)
-          hash.add_parameter 'BGCOLOR', value
-
-
-        when :text_color
-          form.add_input('TXTCOLOR', value)
-          hash.add_parameter 'TXTCOLOR', value
-
-
-        when :table_bg_color
-          form.add_input('TBLBGCOLOR', value)
-          hash.add_parameter 'TBLBGCOLOR', value
-
-        when :table_text_color
-          form.add_input('TBLTXTCOLOR', value)
-          hash.add_parameter 'TBLTXTCOLOR', value
-        
-        
-        when :button_bg_color
-          form.add_input('BUTTONBGCOLOR', value)
-          hash.add_parameter 'BUTTONBGCOLOR', value
-        
-        
-        when :button_text_color
-          form.add_input('BUTTONTXTCOLOR', value)
-          hash.add_parameter 'BUTTONTXTCOLOR', value
-        
-        
-        when :font_family
-          form.add_input('FONTTYPE', value)
-          hash.add_parameter 'FONTTYPE', value
-        
-        when :logo
-          form.add_input('LOGO', value)
-          hash.add_parameter 'LOGO', value
-        
-        
+      # Required values
+      add_ogone_parameter('PSPID', OgoneRails::pspid)
+      add_ogone_parameter('currency', OgoneRails::currency)
+      add_ogone_parameter('language', OgoneRails::language)
+      
+      options_index = {
+        # General params
+        :order_id           => 'orderID',
+        :amount             => 'amount',
+        :customer_name      => 'CN',
+        :customer_email     => 'EMAIL',
+        :customer_address   => 'owneraddress',
+        :customer_zip       => 'ownerZIP',
+        :customer_city      => 'ownertown',
+        :customer_country   => 'ownercty',
+        :customer_phone     => 'ownertelno',
+        # Feedback url's    
+        :accept_url         => 'accepturl',
+        :decline_url        => 'declineurl',
+        :exception_url      => 'exceptionurl',
+        :cancel_url         => 'cancelurl',
+        # Look and feel     
+        :title              => 'TITLE',
+        :bg_color           => 'BGCOLOR',
+        :text_color         => 'TXTCOLOR',
+        :table_bg_color     => 'TBLBGCOLOR',
+        :table_text_color   => 'TBLTXTCOLOR',
+        :button_bg_color    => 'BUTTONBGCOLOR',
+        :button_text_color  => 'BUTTONTXTCOLOR',
+        :font_family        => 'FONTTYPE',
+        :logo               => 'LOGO'       
+      }
+      
+      options.each do |option, value|        
+        if options_index.key?(option)
+          # ogone param
+          value = (value.to_f * 100).to_i if option == :amount # amount in cents
+          add_ogone_parameter(options_index[option], value)
         else
-          form.add_input(option, value)
-          hash.add_parameter(option, value)
+          # custom param
+          add_ogone_parameter(option.to_s, value)
         end
       end
       
       # shasign
-      sha_in = hash.generate_sha_in
-      form.add_input('sha_phrase', hash.sha_in_phrase)
+      @form.add_input('SHASign', @hash.generate_sha_in)
       
-      form.add_input('SHASign', sha_in)
-
-      form.get_form
+      # get form_fields
+      @form.form_fields
     end
-  end
-  
-  
-  private
-  
-    class Form
-      def initialize action
-        @form = ""
-        @form << "<form method='post' action='#{action}'>\n"
-      end
     
-      def add_input name, value
-        @form << "\t<input type='hidden' name='#{name}' value='#{value}'>\n"
+    # to support old method
+    def ogone_form options={}, html={}
+      ogone_form_tag(html) do
+        output = ogone_fields(options)
+        output << "\t<input type='submit' value='ga verder naar ogones' id='submit2' name='submit2'>\n"
       end
-
+    end
     
-      def get_form
-        @form << "\t<input type='submit' value='ga verder naar ogones' id='submit2' name='submit2'>\n"
-        @form << "</form>"
-        @form.html_safe
+    private 
+      
+      # helper method to add params to Form and Hash
+      def add_ogone_parameter name, value
+        @form.add_input(name, value)
+        @hash.add_parameter(name.to_s, value)
       end
-    end
+  end
 end

data/ogone-rails.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "ogone-rails"
-  s.version = "0.0.4"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Robin Houdmeyers"]
-  s.date = "2012-05-15"
+  s.date = "2012-10-10"
   s.description = "Add Ogone payments functionality to your Rails application"
   s.email = "houdmeyers@gmail.com"
   s.extra_rdoc_files = [
@@ -17,6 +17,7 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.files = [
+    ".DS_Store",
     ".document",
     "Gemfile",
     "Gemfile.lock",
@@ -24,12 +25,20 @@ Gem::Specification.new do |s|
     "README.md",
     "Rakefile",
     "VERSION",
+    "lib/.DS_Store",
+    "lib/generators/.DS_Store",
+    "lib/generators/ogone/.DS_Store",
+    "lib/generators/ogone/config_generator.rb",
+    "lib/generators/ogone/templates/ogone.rb",
+    "lib/generators/ogone/templates/ogone.yml",
     "lib/ogone-rails.rb",
     "lib/ogone-rails/check-auth.rb",
     "lib/ogone-rails/config.rb",
+    "lib/ogone-rails/form.rb",
     "lib/ogone-rails/helpers.rb",
     "lib/ogone-rails/rails.rb",
     "lib/ogone-rails/string-to-hash.rb",
+    "lib/rails/.DS_Store",
     "ogone-rails.gemspec",
     "test/helper.rb",
     "test/test_ogone-rails.rb"
@@ -37,7 +46,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/robinhoudmeyers/ogone-rails"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.17"
+  s.rubygems_version = "1.8.24"
   s.summary = "Ogone usable in Rails"
 
   if s.respond_to? :specification_version then

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ogone-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-15 00:00:00.000000000 Z
+date: 2012-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70334405707980 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70334405707980
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70334405706500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *70334405706500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70334405704900 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: 1.1.3
   type: :development
   prerelease: false
-  version_requirements: *70334405704900
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.3
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70334405703820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,15 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *70334405703820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70334405700340 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +85,12 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70334405700340
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Add Ogone payments functionality to your Rails application
 email: houdmeyers@gmail.com
 executables: []
@@ -74,6 +99,7 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
+- .DS_Store
 - .document
 - Gemfile
 - Gemfile.lock
@@ -81,12 +107,20 @@ files:
 - README.md
 - Rakefile
 - VERSION
+- lib/.DS_Store
+- lib/generators/.DS_Store
+- lib/generators/ogone/.DS_Store
+- lib/generators/ogone/config_generator.rb
+- lib/generators/ogone/templates/ogone.rb
+- lib/generators/ogone/templates/ogone.yml
 - lib/ogone-rails.rb
 - lib/ogone-rails/check-auth.rb
 - lib/ogone-rails/config.rb
+- lib/ogone-rails/form.rb
 - lib/ogone-rails/helpers.rb
 - lib/ogone-rails/rails.rb
 - lib/ogone-rails/string-to-hash.rb
+- lib/rails/.DS_Store
 - ogone-rails.gemspec
 - test/helper.rb
 - test/test_ogone-rails.rb
@@ -105,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3381941522637900023
+      hash: 3997629917588372855
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -114,7 +148,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ogone usable in Rails