atos 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+--- 
+SHA1: 
+  data.tar.gz: 2ee92e798051fc53e257525398340bd3e94ca3aa
+  metadata.gz: d9b6bdce2ccf1af1427b329826b1c8727ce0a7c3
+SHA512: 
+  data.tar.gz: 429143a6fba31195c52804bfc99e74e3bc64c299c1073c69c13bc32ad3849e806316468bbcc08b8b4a4da1ecb7712a6de9301933ea63d3017d9aeddb4a8fab01
+  metadata.gz: 1a3319abe4849de8647e34172fdf78485702a25847984ef6d838c080c57e72eaf05989f04cf2eb13746a8939afe6072c7f6587cf98b00bc83e5dbdd41a26840b

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 [name of plugin creator]
+
+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,122 @@
+Atos, a Ruby on Rails gateway for SIPS/ATOS french online payments API
+===
+
+Usage
+---
+1. Drop the files given by your bank in your /lib dir, so it should look like this :
+
+```
+    /lib
+      /atos
+       /bin
+         request
+         request_2.4.18_2.96
+         ....
+
+     /param
+       certif.fr.014295303911111
+       parmcom.014295303911111
+       parmcom.*
+       pathfile
+```
+
+2. From your controller, call the API like this :
+
+```
+    @request = Atos.new.request(
+      :merchant_id            => '014295303911111',
+      :amount                 => '1500',
+      :customer_id            => 'YOUR_CUSTOMER_ID',
+      :automatic_response_url => 'http://YOUR_SITE.com/ANY/LISTENING/URL/YOU/WANT',
+      :normal_return_url      => 'http://YOUR_SITE.com/NORMAL/RETURN/URL',
+      :cancel_return_url      => 'http://YOUR_SITE.com/CANCEL/URL'
+    )
+```
+
+3. And then show the @request in your view (it's an HTML form)
+
+----- Let the customer pay on the bank platform, then listen to its response ----
+
+4. Now, you can catch the DATA parameter in response by listening to the 'automatic\_response\_url' you gave above
+```
+  response = Atos.new.response(params[:DATA])
+```
+
+5. Finally, you get a hash in 'response', that follows the API specs :
+```
+    {
+      :code
+      :error
+      :merchant_id
+      :merchant_country
+      :amount
+      :transaction_id
+      :payment_means
+      :transmission_date
+      :payment_time
+      :payment_date
+      :response_code
+      :payment_certificate
+      :authorisation_id
+      :currency_code
+      :card_number
+      :cvv_flag
+      :cvv_response_code
+      :bank_response_code
+      :complementary_code
+      :complementary_info
+      :return_context
+      :caddie
+      :receipt_complement
+      :merchant_language
+      :language
+      :customer_id
+      :order_id
+      :customer_email
+      :customer_ip_address
+      :capture_day
+      :capture_mode
+      :data
+    }
+```
+
+Notes
+---
+- merchant_id, amount, customer_id, automatic_response_url, normal_return_url and cancel_return_url
+  are required to push a request, but you can freely add others (shopping cart, customer email...),
+  according to the API docs.
+
+- Default language is set to 'fr' and currency to 'Euro', simply pass your own 'locale/currency' in
+  the request to override.
+
+- I prefer conventions over configuration, but you can also override with your own path dirs while
+  instanciating the Atos class. You just add one step to the shortand way :
+
+```
+    @request = Atos.new(
+      :root_path     => '/where',
+      :request_path  => '/where/ever',
+      :response_path => '/where/ever/you',
+      :pathfile_path => '/where/ever/you/want'
+    )
+```
+
+...And then...
+
+```
+    @request.request(
+      :merchant_id       => '014295303911111',
+      :amount            => '1500',
+      :customer_id       => YOUR_CUSTOMER_ID,:automatic_response_url=>'http://YOUR_SITE.com/ANY/LISTENING/URL/YOU/WANT',
+      :normal_return_url => 'http://YOUR_SITE.com/NORMAL/FALLBACK/URL',
+      :cancel_return_url => 'http://YOUR_SITE.com/CANCEL/URL'
+    )
+```
+
+* Don't forget to check at the 'pathfile' Atos file, and fill requested paths according to your app absolute location on the server
+
+* Drop the credit card logos in a public dir, then fill this directory's absolute location on the server
+  in the '/lib/atos/param/pathfile' file
+
+* The '014295303911111' merchant\_id I use all the way here is the test merchant\_id, obviously, use you own.
+

data/lib/atos.rb

@@ -0,0 +1,84 @@
+require 'exception_handler'
+
+class Atos
+
+  attr_accessor :root_path, :request_path, :response_path, :pathfile_path
+  
+  def initialize(*args)
+  
+    args.empty? ? paths = {} : paths = args.first
+    
+    # You may override those default paths on Class instanciation 
+    paths[:root_path]     ? @root_path     = paths[:root_path]     : @root_path     = "#{Rails.root}/lib/atos"
+    paths[:request_path]  ? @request_path  = paths[:request_path]  : @request_path  = "#{self.root_path}/bin/request"
+    paths[:response_path] ? @response_path = paths[:response_path] : @response_path = "#{self.root_path}/bin/response"
+    paths[:pathfile_path] ? @pathfile_path = paths[:pathfile_path] : @pathfile_path = "#{self.root_path}/param/pathfile"  
+
+  end
+      
+  # Call the request binary 
+  def request(datas)
+  
+    ExceptionHandler.before(datas)
+        
+    # Default parameters if nothing given
+    datas[:merchant_country] ||= "fr"                # => French shop
+    datas[:language]         ||= "fr"                # => French locale
+    datas[:currency_code]    ||= "978"               # => Euro
+    datas[:pathfile]         ||= "#{@pathfile_path}" # => Path to the Atos "pathfile"
+         
+    args = ''
+    datas.each do |key, value|
+      args << "#{key.to_s}=#{value} "
+    end        
+    
+    response_array = ExceptionHandler.on_launch(`#{self.request_path} #{args}`)
+
+    # If everything goes fine, should now respond an HTML form 
+    response_array[3]
+    
+  end
+
+  # Decrypt bank response, then return a hash
+  def response(datas)
+
+    response_array = ExceptionHandler.on_launch(`#{self.response_path} pathfile=#{self.pathfile_path} message=#{datas}`)
+
+    { 
+      :code                   => response_array[1],
+      :error                  => response_array[2],
+      :merchant_id            => response_array[3],
+      :merchant_country       => response_array[4],
+      :amount                 => response_array[5],
+      :transaction_id         => response_array[6],
+      :payment_means          => response_array[7],
+      :transmission_date      => response_array[8],
+      :payment_time           => response_array[9],
+      :payment_date           => response_array[10],
+      :response_code          => response_array[11],
+      :payment_certificate    => response_array[12],
+      :authorisation_id       => response_array[13],
+      :currency_code          => response_array[14],
+      :card_number            => response_array[15],
+      :cvv_flag               => response_array[16],
+      :cvv_response_code      => response_array[17],
+      :bank_response_code     => response_array[18],
+      :complementary_code     => response_array[19],
+      :complementary_info     => response_array[20],
+      :return_context         => response_array[21],
+      :caddie                 => response_array[22],
+      :receipt_complement     => response_array[23],
+      :merchant_language      => response_array[24],
+      :language               => response_array[25],
+      :customer_id            => response_array[26],
+      :order_id               => response_array[27],
+      :customer_email         => response_array[28],
+      :customer_ip_address    => response_array[29],
+      :capture_day            => response_array[30],
+      :capture_mode           => response_array[31],
+      :data                   => response_array[32]
+    }      
+    
+  end    
+
+end

data/lib/exception_handler.rb

@@ -0,0 +1,40 @@
+class ExceptionHandler < StandardError
+  
+  # Minimum required parameters
+  def self.before(datas)
+  
+    required_params = [
+      'merchant_id',
+      'amount',
+      'customer_id',
+      'cancel_return_url',
+      'normal_return_url',
+      'automatic_response_url'
+    ]
+    
+    required_params.each do |r| 
+      raise "Atos plugin error : missing parameter '#{r}' in request" if !datas[r.to_sym]
+    end
+   
+  end
+  
+  # Check if the request is ok
+  def self.on_launch(datas)
+    
+    response_array = datas.split("!")
+    
+    case response_array[1]
+    when nil
+      # No response at all from API
+      raise "Atos plugin error : binary file does not respond ! Check your 'request' binary path, default is 'Rails.root/lib/atos/bin'"
+    when "0"      
+      # API respond 'ok', return the content
+      response_array
+    else
+      # API binary respond an error, formated in an HTML table. Let's strip tags before showing the error message
+      raise "Atos API binary file outputs : #{response_array[2].gsub(/<\/?[^>]*>/, '')}" 
+    end
+    
+  end   
+  
+end

data/test/atos_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+class AtosTest < ActiveSupport::TestCase
+  def setup
+    @atos = Atos.new
+  end
+
+  test "request: wrong arguments" do
+    assert_raise RuntimeError do
+      @atos.request({})
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'active_support'
+require 'active_support/test_case'
+require 'test/unit'
+
+require 'rails'
+require 'atos'

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification 
+name: atos
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Guillaume Barillot
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-06-07 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - &id002 
+      - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - *id002
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 3.2.13
+  type: :development
+  version_requirements: *id004
+description: Ruby on Rails gateway for SIPS/ATOS french online payments API
+email: gbarillot@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- MIT-LICENSE
+- README.md
+- Gemfile
+- lib/atos.rb
+- lib/exception_handler.rb
+- test/atos_test.rb
+- test/test_helper.rb
+homepage: http://github.com/gbarillot/atos
+licenses: 
+- MIT
+metadata: {}
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - *id002
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Ruby on Rails gateway for SIPS/ATOS
+test_files: 
+- test/atos_test.rb