paybox 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,2 @@
+source "http://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,72 @@
+PATH
+  remote: .
+  specs:
+    paybox (0.0.1)
+      activemodel
+      activesupport
+      activevalidators
+      httparty
+      i18n
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activemodel (3.0.3)
+      activesupport (= 3.0.3)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.3)
+      activemodel (= 3.0.3)
+      activesupport (= 3.0.3)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.3)
+    activevalidators (1.2.4)
+      activemodel (>= 3.0.0)
+      activerecord (>= 3.0.0)
+      date_validator (= 0.5.9)
+      mail
+    arel (2.0.6)
+    builder (2.1.2)
+    crack (0.1.8)
+    date_validator (0.5.9)
+      activemodel (>= 3.0.0)
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    i18n (0.5.0)
+    mail (2.2.12)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    polyglot (0.3.1)
+    rspec (2.2.0)
+      rspec-core (~> 2.2)
+      rspec-expectations (~> 2.2)
+      rspec-mocks (~> 2.2)
+    rspec-core (2.2.1)
+    rspec-expectations (2.2.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.2.0)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel
+  activesupport
+  activevalidators
+  bundler
+  fakeweb
+  httparty
+  i18n
+  paybox!
+  rspec
+  rspec-core
+  rspec-expectations

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Franck Verrot
+
+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,61 @@
+Paybox
+======
+
+
+Installation (Rails 3)
+----------------------
+
+In your Gemfile :
+
+    gem 'paybox'
+
+
+Usage
+-----
+
+    response = Paybox.new(
+      :operation => '00057',
+      :amount => 1000,
+      :user_id => your_db_customer/suscriber_account_id,
+      :card_nbr => card_number_or_encrypted_alias,
+      :expire => card_expiration_date (mmyy),
+      :cvv2 => card_cvv2_code (3 digits)
+    )
+
+Then you can read response like this, for instance :
+
+    response.coderesponse = '00000' # =>  Cool, successful request
+or
+    response.commentaire = "PAYBOX : Numéro de porteur invalide" # =>  Oooops, invalid card number given
+
+Todo
+----
+
+Lots of improvements can be made:
+
+* Add I18n
+* Tests
+* Documentation
+* ...
+
+Note on Patches/Pull Requests
+-----------------------------
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+
+Contributors
+------------
+* Guillaume Barillot, author of the initial implementation
+* Franck Verrot
+
+Copyright
+---------
+
+Copyright (c) 2010 Franck Verrot. MIT LICENSE. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+begin
+  require 'rspec/core/rake_task'
+
+  desc "Run specs"
+  RSpec::Core::RakeTask.new do |t|
+    t.rspec_opts = %w(-fs --color)
+    t.ruby_opts  = %w(-w)
+  end
+
+rescue LoadError
+  task :spec do
+    abort "Run `gem install rspec` to be able to run specs"
+  end
+end
+task :default => :spec

data/lib/paybox.rb

@@ -0,0 +1,15 @@
+require 'active_support'
+require 'active_support/all'
+require 'active_model'
+require 'active_model/validations'
+require 'activevalidators'
+require 'httparty'
+
+module Paybox
+  extend ActiveSupport::Autoload
+  autoload :Paybox
+  autoload :Transaction
+  autoload :Configuration
+  autoload :Gateway
+  autoload :Operation
+end

data/lib/paybox/configuration.rb

@@ -0,0 +1,12 @@
+module Paybox
+  module Configuration
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      attr_accessor :site, :rang, :cle
+      def configure &block
+        yield self
+      end
+    end
+  end
+end

data/lib/paybox/gateway.rb

@@ -0,0 +1,11 @@
+module Paybox
+  module Gateway
+    extend ActiveSupport::Concern
+
+    included do
+      include HTTParty
+      base_uri 'https://preprod-ppps.paybox.com'
+      PROCESS_PATH = '/PPPS.php'
+    end
+  end
+end

data/lib/paybox/operation.rb

@@ -0,0 +1,26 @@
+module Paybox
+  module Operation
+    extend ActiveSupport::Concern
+
+    included do
+      include ActiveModel::Validations
+
+      # Payment's details
+      attr_accessor :operation #:operation => ":operation . The code of requested operation to be done", 
+      attr_accessor :amount    #:amount => ":amount . The amount of the transaction", 
+      attr_accessor :user_id   #:user_id => "user_id . The id of your user in your own Database", 
+      attr_accessor :card_nbr  #:card_nbr => ":card_nbr . The crypted partial card number in your Database", 
+      attr_accessor :expire    #:expire => ":expire . The expiration date of the card",
+      attr_accessor :cvv2      #:cvv2 => ":cvv2 . The CVV2 parameter you should have stored in your DB",
+      attr_accessor :numtrans  #:numtrans => ":numtrans . The previous transaction number"   
+
+
+      validates :operation, :amount, :user_id, :card_nbr, :expire, :cvv2, :presence  =>  true
+      validates :card_nbr, :credit_card => { :type => :any }
+
+      # WARNING :numtrans parameter IS REQUIRED only for operations 00002, 00005, 00013, 00017, 00052, 00055 
+      NUM_TRANS_REQUIRED_ARRAY = ['00002', '00005', '000013', '00017', '00052', '00055']
+      validates :numtrans, :presence => true, :if => Proc.new { |obj| NUM_TRANS_REQUIRED_ARRAY.include?(obj.operation) }
+    end
+  end
+end

data/lib/paybox/paybox.rb

@@ -0,0 +1,93 @@
+module Paybox
+  class Paybox
+    include Configuration    # Class-level configuration like site, rang, cle
+    include Gateway          # Gateway technical infrastructure
+    include Operation        # Internal validations
+
+    # Internal result when the object issues a call to Paybox
+    attr_accessor :transaction
+
+    def initialize(args)
+      args.each_pair { |k,v| send("#{k}=",v) }
+    end
+
+    def process
+      return false unless self.valid?
+
+      ##### List of all available operations ###########
+      # One-shot operations for customers
+      # ------------------------------------------------
+      #  00001 = Autorisation, 
+      #  00002 = Débit, 
+      #  00003 = Autorisation + Débit,
+      #  00004 = Crédit, 
+      #  00005 = Annulation, 
+      #  00011 = Vérification de l’existence d’une transaction, 
+      #  00012 = Transaction sans demande d’autorisation, 
+      #  00013 = Modification du montant d’une transaction, 
+      #  00014 = Remboursement, 
+      #  00017 = Consultation
+
+      # Recurring Operations on suscriber accounts
+      # -----------------------------------------------
+      #  00051 = Autorisation seule sur un abonné, 
+      #  00052 = Débit sur un abonné, 
+      #  00053 = Autorisation + Débit sur un abonné, 
+      #  00054 = Crédit sur un abonné, 
+      #  00055 = Annulation d’une opération sur un abonné, 
+      #  00056 = Inscription nouvel abonné, 
+      #  00057 = Modification abonné existant, 
+      #  00058 = Suppression abonné   
+      #  00061 = Transaction sans demande d’autorisation (forçage).
+
+      current_date = Time.now
+
+      data = {
+        :SITE         => self.class.site,
+        :RANG         => self.class.rang,
+        :CLE          => self.class.cle,
+
+        :DATEQ        => current_date.strftime('%d%m%Y%H%M%S'),
+        :NUMQUESTION  => current_date.to_i,
+        :TYPE         => self.operation,
+        :MONTANT      => self.amount,
+        :REFERENCE    => "test",
+        :REFABONNE    => self.user_id,
+        :VERSION      => '00104',
+        :IDENTIFIANT  => '2',
+        :DEVISE       => "978", #EURO
+        :PORTEUR      => self.card_nbr,
+        :DATEVAL      => self.expire,
+        :CVV          => self.cvv2,
+        :ACTIVITE     => "024",
+        :ARCHIVAGE    => "Simplissime.fr",
+        :DIFFERE      => "000",
+        :NUMAPPEL     => "",
+        :NUMTRANS     => self.numtrans,
+        :AUTORISATION => "",
+        :PAYS         => "FR"
+      }
+
+      response = self.class.post(PROCESS_PATH, :body => data)
+
+      # Now we've got a response, let's parse it
+      self.transaction = Transaction.new.tap do |trans|
+        response.body.split('&').each do |parameter|
+          parameter.strip!
+          key = parameter.split('=').first
+          value = Iconv.conv('utf-8', 'ISO-8859-1', parameter.split('=').last)
+
+          begin
+            #Transforms an attribute FIELD-BLAH into fieldblah
+            trans.send("#{key.downcase.tr('-','')}=", value)
+          rescue
+            warn "The gem doesnt know about the resulting field #{key}"
+            warn "Fill-in a ticket if you think this is not expected"
+            return false
+          end
+        end
+      end
+      true
+    end
+  end
+end

data/lib/paybox/transaction.rb

@@ -0,0 +1,20 @@
+module Paybox
+  class Transaction
+    attr_accessor :numtrans #'NUMTRANS'          #Numéro de la transaction créée (int (10))
+    attr_accessor :numappel #'NUMAPPEL'          # Numéro de la requête gérée sur Paybox (int (10))
+    attr_accessor :numquestion #'NUMQUESTION'          # Identifiant unique et sequentiel (un timestamp sur 10 chiffres )
+    attr_accessor :site #'SITE'          # Numéro d'adhérent fourni par la banque (int (7))
+    attr_accessor :rang #'RANG'          # Numéro de rang fourni par la banque du commerçant (int (2))
+    attr_accessor :identifiant #'IDENTIFIANT'          # Champ vide (int (10))
+    attr_accessor :autorisation #'AUTORISATION'          # Numéro d'autorisation délivré par le centre d'autorisation de la banque du commerçant si le paiement est accepté (varchar (10))
+    attr_accessor :codereponse #'CODEREPONSE'          # Code réponse concernant l'état de la réponse traité, opération acceptée ou refusée (varchar (10))
+    attr_accessor :refabonne #'REFABONNE'          # Numéro d'abonné (user) contenu dans la trame question (varchar (250))
+    attr_accessor :porteur #'PORTEUR'          # Numéro porteur partiel (n° carte crypté), Identique à la trame question (varchar (19))
+    attr_accessor :commentaire #'COMMENTAIRE'          # Messages divers pour information (varchar(100))
+    attr_accessor :pays #'PAYS'          # Code Pays du porteur de la carte (format ISO 3166)
+    attr_accessor :typecarte #'TYPECARTE'          # Type de carte utilisé (varchar(10))
+    attr_accessor :sha1 #'SHA-1'          # Empreinte SHA-1 de la carte utilisée
+    attr_accessor :status #'STATUS'          # Etat de la transaction, retourné uniquement avec une question type 17 (=consultation) (varchar (16)) 
+    attr_accessor :remise #'REMISE'          # Identifiant Paybox de la remise collectée (uniquement en consultation type 17), (int (9))
+  end
+end

data/lib/paybox/version.rb

@@ -0,0 +1,3 @@
+module Paybox
+  VERSION = "0.0.1"
+end

data/paybox.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "paybox/version"
+
+Gem::Specification.new do |s|
+  s.name        = "paybox"
+  s.version     = Paybox::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Franck Verrot","Guillaume Barillot"]
+  s.email       = ["franck@verrot.fr"]
+  s.homepage    = "http://www.verrot.fr"
+  s.summary     = %q{Payment Gateway to Paybox's services}
+  s.description = %q{Payment Gateway to Paybox's services}
+
+  s.rubyforge_project = "paybox"
+
+  s.add_dependency 'activesupport'
+  s.add_dependency 'activemodel'
+  s.add_dependency 'i18n'
+  s.add_dependency 'httparty'
+  s.add_dependency 'activevalidators'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'rspec-core'
+  s.add_development_dependency 'rspec-expectations'
+  s.add_development_dependency 'fakeweb'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/spec/fixtures/ppps.php

@@ -0,0 +1,16 @@
+NUMTRANS=
+&NUMAPPEL=
+&NUMQUESTION=
+&SITE=
+&RANG=
+&IDENTIFIANT=
+&AUTORISATION=
+&CODEREPONSE=00000
+&REFABONNE=
+&PORTEUR=
+&COMMENTAIRE=
+&PAYS=
+&TYPECARTE=
+&SHA-1=
+&STATUS=
+&REMISE=

data/spec/paybox_spec.rb

@@ -0,0 +1,38 @@
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+
+TEST_DATA = {
+  :user_id  => 1,
+  :card_nbr => '4111 1111 1111 1111',
+  :expire   => '1012',
+  :cvv2     => '123'
+}
+
+describe "Paybox" do
+  before(:each) do
+    Paybox::Paybox.configure do |configuration|
+      configuration.site = '1999888'
+      configuration.rang = '99'
+      configuration.cle  = '1999888I'
+    end
+  end
+
+  it "can be configured" do
+    Paybox::Paybox.site.should == '1999888'
+    Paybox::Paybox.rang.should == '99'
+    Paybox::Paybox.cle.should  == '1999888I'
+  end
+
+  it "initializes itself and post the data to the GW" do
+    paybox = Paybox::Paybox.new(
+      :operation => '00057',
+      :amount    => 1000,
+      :user_id   => TEST_DATA[:user_id],
+      :card_nbr  => TEST_DATA[:card_nbr],
+      :expire    => TEST_DATA[:expire],
+      :cvv2      => TEST_DATA[:cvv2]
+    )
+
+    paybox.process.should be(true)
+    paybox.transaction.codereponse.should == '00000' #=> Cool, successful request
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require 'fakeweb'
+require 'paybox'
+
+RSpec.configure do |config|
+  FakeWeb.allow_net_connect = false
+
+  config.before :all do
+    FakeWeb.register_uri(
+      :post,
+      'https://preprod-ppps.paybox.com/PPPS.php',
+      :body => File.read(File.join(File.dirname(__FILE__), 'fixtures', 'PPPS.php'))
+    )
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification 
+name: paybox
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Franck Verrot
+- Guillaume Barillot
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activemodel
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: i18n
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activevalidators
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec-core
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: rspec-expectations
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id010
+description: Payment Gateway to Paybox's services
+email: 
+- franck@verrot.fr
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/paybox.rb
+- lib/paybox/configuration.rb
+- lib/paybox/gateway.rb
+- lib/paybox/operation.rb
+- lib/paybox/paybox.rb
+- lib/paybox/transaction.rb
+- lib/paybox/version.rb
+- paybox.gemspec
+- spec/fixtures/ppps.php
+- spec/paybox_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://www.verrot.fr
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: paybox
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Payment Gateway to Paybox's services
+test_files: 
+- spec/fixtures/ppps.php
+- spec/paybox_spec.rb
+- spec/spec_helper.rb