paybox_direct 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6998f735f27720f3c35bc55f6723eb342664d86
-  data.tar.gz: bd26cf6c73b72f96b1748664d2fa60e13aaa1157
+  metadata.gz: d901596ca4dfc8d6cc31a037c6226d752d5deade
+  data.tar.gz: bfa78c3eeceb6bbd5a002d12f0074057f50eb8dc
 SHA512:
-  metadata.gz: 4e0ef292152cb66d1da4b74d6c4227dd13c8635a1e287e84ccf9c36ea06d3e4ab72c8943ef17109b4208b828283e8876e224ba9f916c8ce8a3931c75b73303cc
-  data.tar.gz: c9ad2b64d51e8c5aeb08a8674fe97a6dbc1bd9a65369ec91525b95bb13eff29e30fa12d24d4f384ea2b4ef012f597cb7f7701320332688f7bedecded9e11f65e
+  metadata.gz: ba3dd9e300e848cf51767c906f5b2b0be01a6497f361155320c286cebab22154d9e5bd4f0743987c6927c6d3989b0a4df30574c781a2a86d403056c49c6dc904
+  data.tar.gz: a476ab097a23f45cd154f513b7bb3846c85674e53601b9e257fed5b86cbdde74ff9bb373c1381b3e18bf5742cd8a4550379cc4cf0b48d70f294fa18a6cd2e510

data/lib/paybox_direct.rb

@@ -65,43 +65,44 @@ module PayboxDirect
   # == Raises:
   # * PayboxDirect::AuthorizationError, if authorization fails
   # * PayboxDirect::ServerUnavailableError, if Paybox server is unavailable
-  def self.authorize(opts)
-    raise ArgumentError, "Expecting hash" unless opts.is_a? Hash
-    raise ArgumentError, "Expecting `amount` option" unless opts.has_key? :amount
-    raise ArgumentError, "Expecting `currency` option" unless opts.has_key? :currency
-    raise ArgumentError, "Expecting `ref` option" unless opts.has_key? :ref
-    raise ArgumentError, "Expecting `cc_expire` option" unless opts.has_key? :cc_expire
-    raise ArgumentError, "Expecting `cc_cvv` option" unless opts.has_key? :cc_cvv
-    raise ArgumentError, "amount: Expecting Numeric" unless opts[:amount].is_a? Numeric
-    raise ArgumentError, "currency: Not supported" unless CURRENCIES.has_key? opts[:currency]
-    raise ArgumentError, "cc_expire: Expecting Date" unless opts[:cc_expire].is_a? Date
-    opts[:debit] = false if !opts.has_key? :debit
+  def self.authorize(amount:,
+                     currency:,
+                     ref:,
+                     cc_number: nil,
+                     wallet: nil,
+                     cc_expire:,
+                     cc_cvv:,
+                     subscriber: nil,
+                     debit: false)
+    raise ArgumentError, "amount: Expecting Numeric" unless amount.is_a? Numeric
+    raise ArgumentError, "currency: Not supported" unless CURRENCIES.has_key? currency
+    raise ArgumentError, "cc_expire: Expecting Date" unless cc_expire.is_a? Date
 
-    if opts.has_key? :subscriber
-      if opts.has_key? :wallet
-        raise ArgumentError, "cc_number: Unexpected when `wallet` provided" if opts.has_key? :cc_number
-        op_code = opts[:debit] ? 53 : 51
+    if !subscriber.nil?
+      if !wallet.nil?
+        raise ArgumentError, "cc_number: Unexpected when `wallet` provided" unless cc_number.nil?
+        op_code = debit ? 53 : 51
       else
-        raise ArgumentError, "Expecting `cc_number` option" unless opts.has_key? :cc_number
+        raise ArgumentError, "Expecting `cc_number` option" if cc_number.nil?
         op_code = 56 # Paybox can't create a new subscriber with immediate debit
       end
     else
-      raise ArgumentError, "Expecting `cc_number` option" unless opts.has_key? :cc_number
-      raise ArgumentError, "Unexpected `wallet` option" if opts.has_key? :wallet
-      op_code = opts[:debit] ? 3 : 1
+      raise ArgumentError, "Expecting `cc_number` option" if cc_number.nil?
+      raise ArgumentError, "Unexpected `wallet` option" unless wallet.nil?
+      op_code = debit ? 3 : 1
     end
 
     vars = {
       "TYPE"      => op_code.to_s.rjust(5, "0"),
-      "REFERENCE" => @@config.ref_prefix + opts[:ref],
-      "MONTANT"   => (opts[:amount].round(2) * 100).round.to_s.rjust(10, "0"),
-      "DEVISE"    => CURRENCIES[opts[:currency]].to_s.rjust(3, "0"),
-      "PORTEUR"   => opts.has_key?(:wallet) ? opts[:wallet] : opts[:cc_number].gsub(/[ -.]/, ""),
-      "DATEVAL"   => opts[:cc_expire].strftime("%m%y"),
-      "CVV"       => opts[:cc_cvv]
+      "REFERENCE" => @@config.ref_prefix + ref,
+      "MONTANT"   => (amount.round(2) * 100).round.to_s.rjust(10, "0"),
+      "DEVISE"    => CURRENCIES[currency].to_s.rjust(3, "0"),
+      "PORTEUR"   => !wallet.nil? ? wallet : cc_number.gsub(/[ -.]/, ""),
+      "DATEVAL"   => cc_expire.strftime("%m%y"),
+      "CVV"       => cc_cvv
     }
-    if opts.has_key? :subscriber
-      vars["REFABONNE"] = @@config.ref_prefix + opts[:subscriber]
+    if !subscriber.nil?
+      vars["REFABONNE"] = @@config.ref_prefix + subscriber
     end
     req = Request.new(vars)
     req.execute!
@@ -117,11 +118,11 @@ module PayboxDirect
       req.response[:wallet] = req.fields["PORTEUR"]
 
       # We now execute debit after authorization-only operation #56
-      if opts[:debit]
+      if debit
         sleep 1 # Paybox recommends to wait a few seconds between the authorization and the debit
         debit_authorization(
-          amount:         opts[:amount],
-          currency:       opts[:currency],
+          amount:         amount,
+          currency:       currency,
           request_id:     req.request_id,
           transaction_id: req.response[:transaction_id]
         )
@@ -154,23 +155,21 @@ module PayboxDirect
   # == Raises:
   # * PayboxDirect::DebitError, if debit fails
   # * PayboxDirect::ServerUnavailableError, if Paybox server is unavailable
-  def self.debit_authorization(opts)
-    raise ArgumentError, "Expecting hash" unless opts.is_a? Hash
-    raise ArgumentError, "Expecting `amount` option" unless opts.has_key? :amount
-    raise ArgumentError, "Expecting `currency` option" unless opts.has_key? :currency
-    raise ArgumentError, "Expecting `request_id` option" unless opts.has_key? :request_id
-    raise ArgumentError, "Expecting `transaction_id` option" unless opts.has_key? :transaction_id
-    raise ArgumentError, "amount: Expecting Numeric" unless opts[:amount].is_a? Numeric
-    raise ArgumentError, "currency: Not supported" unless CURRENCIES.has_key? opts[:currency]
-    raise ArgumentError, "request_id: Expecting Fixnum" unless opts[:request_id].is_a? Fixnum
-    raise ArgumentError, "transaction_id: Expecting Fixnum" unless opts[:transaction_id].is_a? Fixnum
+  def self.debit_authorization(amount:,
+                               currency:,
+                               request_id:,
+                               transaction_id:)
+    raise ArgumentError, "amount: Expecting Numeric" unless amount.is_a? Numeric
+    raise ArgumentError, "currency: Not supported" unless CURRENCIES.has_key? currency
+    raise ArgumentError, "request_id: Expecting Fixnum" unless request_id.is_a? Fixnum
+    raise ArgumentError, "transaction_id: Expecting Fixnum" unless transaction_id.is_a? Fixnum
 
     req = Request.new({
       "TYPE"     => "00002",
-      "MONTANT"  => (opts[:amount].round(2) * 100).round.to_s.rjust(10, "0"),
-      "DEVISE"   => CURRENCIES[opts[:currency]].to_s.rjust(3, "0"),
-      "NUMAPPEL" => opts[:request_id].to_s.rjust(10, "0"),
-      "NUMTRANS" => opts[:transaction_id].to_s.rjust(10, "0")
+      "MONTANT"  => (amount.round(2) * 100).round.to_s.rjust(10, "0"),
+      "DEVISE"   => CURRENCIES[currency].to_s.rjust(3, "0"),
+      "NUMAPPEL" => request_id.to_s.rjust(10, "0"),
+      "NUMTRANS" => transaction_id.to_s.rjust(10, "0")
     })
     req.execute!
 
@@ -202,42 +201,43 @@ module PayboxDirect
   # == Raises:
   # * PayboxDirect::CancelError, if cancellation fails
   # * PayboxDirect::ServerUnavailableError, if Paybox server is unavailable
-  def self.cancel(opts)
-    raise ArgumentError, "Expecting hash" unless opts.is_a? Hash
-    raise ArgumentError, "Expecting `amount` option" unless opts.has_key? :amount
-    raise ArgumentError, "Expecting `currency` option" unless opts.has_key? :currency
-    raise ArgumentError, "Expecting `ref` option" unless opts.has_key? :ref
-    raise ArgumentError, "Expecting `cc_cvv` option" unless opts.has_key? :cc_cvv
-    raise ArgumentError, "Expecting `request_id` option" unless opts.has_key? :request_id
-    raise ArgumentError, "Expecting `transaction_id` option" unless opts.has_key? :transaction_id
-    raise ArgumentError, "amount: Expecting Numeric" unless opts[:amount].is_a? Numeric
-    raise ArgumentError, "currency: Not supported" unless CURRENCIES.has_key? opts[:currency]
-    raise ArgumentError, "cc_expire: Expecting Date" unless opts[:cc_expire].is_a? Date
-    raise ArgumentError, "request_id: Expecting Numeric" unless opts[:request_id].is_a? Numeric
-    raise ArgumentError, "transaction_id: Expecting Numeric" unless opts[:transaction_id].is_a? Numeric
+  def self.cancel(amount:,
+                  currency:,
+                  ref:,
+                  wallet: nil,
+                  cc_expire: nil,
+                  cc_cvv:,
+                  subscriber: nil,
+                  request_id:,
+                  transaction_id:)
+    raise ArgumentError, "amount: Expecting Numeric" unless amount.is_a? Numeric
+    raise ArgumentError, "currency: Not supported" unless CURRENCIES.has_key? currency
+    raise ArgumentError, "cc_expire: Expecting Date" unless cc_expire.is_a? Date
+    raise ArgumentError, "request_id: Expecting Numeric" unless request_id.is_a? Numeric
+    raise ArgumentError, "transaction_id: Expecting Numeric" unless transaction_id.is_a? Numeric
 
-    if opts.has_key? :subscriber
-      raise ArgumentError, "Expecting `wallet` option" unless opts.has_key? :wallet
-      raise ArgumentError, "Expecting `cc_expire` option" unless opts.has_key? :cc_expire
+    if !subscriber.nil?
+      raise ArgumentError, "Expecting `wallet` option" if wallet.nil?
+      raise ArgumentError, "Expecting `cc_expire` option" if cc_expire.nil?
       op_code = 55
     else
-      raise ArgumentError, "Unexpected `wallet` option" if opts.has_key? :wallet
+      raise ArgumentError, "Unexpected `wallet` option" unless wallet.nil?
       op_code = 5
     end
 
     vars = {
       "TYPE"      => op_code.to_s.rjust(5, "0"),
-      "REFERENCE" => @@config.ref_prefix + opts[:ref],
-      "MONTANT"   => (opts[:amount].round(2) * 100).round.to_s.rjust(10, "0"),
-      "DEVISE"    => CURRENCIES[opts[:currency]].to_s.rjust(3, "0"),
-      "DATEVAL"   => opts[:cc_expire].strftime("%m%y"),
-      "CVV"       => opts[:cc_cvv],
-      "NUMAPPEL"  => opts[:request_id].to_s.rjust(10, "0"),
-      "NUMTRANS"  => opts[:transaction_id].to_s.rjust(10, "0")
+      "REFERENCE" => @@config.ref_prefix + ref,
+      "MONTANT"   => (amount.round(2) * 100).round.to_s.rjust(10, "0"),
+      "DEVISE"    => CURRENCIES[currency].to_s.rjust(3, "0"),
+      "DATEVAL"   => cc_expire.strftime("%m%y"),
+      "CVV"       => cc_cvv,
+      "NUMAPPEL"  => request_id.to_s.rjust(10, "0"),
+      "NUMTRANS"  => transaction_id.to_s.rjust(10, "0")
     }
-    if opts.has_key? :subscriber
-      vars["PORTEUR"]   = opts[:wallet]
-      vars["REFABONNE"] = @@config.ref_prefix + opts[:subscriber]
+    if !subscriber.nil?
+      vars["PORTEUR"]   = wallet
+      vars["REFABONNE"] = @@config.ref_prefix + subscriber
     end
     req = Request.new(vars)
     req.execute!
@@ -264,23 +264,21 @@ module PayboxDirect
   # == Raises:
   # * PayboxDirect::RefundError, if cancellation fails
   # * PayboxDirect::ServerUnavailableError, if Paybox server is unavailable
-  def self.refund(opts)
-    raise ArgumentError, "Expecting hash" unless opts.is_a? Hash
-    raise ArgumentError, "Expecting `amount` option" unless opts.has_key? :amount
-    raise ArgumentError, "Expecting `currency` option" unless opts.has_key? :currency
-    raise ArgumentError, "Expecting `request_id` option" unless opts.has_key? :request_id
-    raise ArgumentError, "Expecting `transaction_id` option" unless opts.has_key? :transaction_id
-    raise ArgumentError, "amount: Expecting Numeric" unless opts[:amount].is_a? Numeric
-    raise ArgumentError, "currency: Not supported" unless CURRENCIES.has_key? opts[:currency]
-    raise ArgumentError, "request_id: Expecting Numeric" unless opts[:request_id].is_a? Numeric
-    raise ArgumentError, "transaction_id: Expecting Numeric" unless opts[:transaction_id].is_a? Numeric
+  def self.refund(amount:,
+                  currency:,
+                  request_id:,
+                  transaction_id:)
+    raise ArgumentError, "amount: Expecting Numeric" unless amount.is_a? Numeric
+    raise ArgumentError, "currency: Not supported" unless CURRENCIES.has_key? currency
+    raise ArgumentError, "request_id: Expecting Numeric" unless request_id.is_a? Numeric
+    raise ArgumentError, "transaction_id: Expecting Numeric" unless transaction_id.is_a? Numeric
 
     req = Request.new({
       "TYPE"     => "00014",
-      "MONTANT"  => (opts[:amount].round(2) * 100).round.to_s.rjust(10, "0"),
-      "DEVISE"   => CURRENCIES[opts[:currency]].to_s.rjust(3, "0"),
-      "NUMAPPEL" => opts[:request_id].to_s.rjust(10, "0"),
-      "NUMTRANS" => opts[:transaction_id].to_s.rjust(10, "0")
+      "MONTANT"  => (amount.round(2) * 100).round.to_s.rjust(10, "0"),
+      "DEVISE"   => CURRENCIES[currency].to_s.rjust(3, "0"),
+      "NUMAPPEL" => request_id.to_s.rjust(10, "0"),
+      "NUMTRANS" => transaction_id.to_s.rjust(10, "0")
     })
     req.execute!
 
@@ -311,38 +309,39 @@ module PayboxDirect
   # == Raises:
   # * PayboxDirect::CreditError, if credit fails
   # * PayboxDirect::ServerUnavailableError, if Paybox server is unavailable
-  def self.credit(opts)
-    raise ArgumentError, "Expecting hash" unless opts.is_a? Hash
-    raise ArgumentError, "Expecting `amount` option" unless opts.has_key? :amount
-    raise ArgumentError, "Expecting `currency` option" unless opts.has_key? :currency
-    raise ArgumentError, "Expecting `ref` option" unless opts.has_key? :ref
-    raise ArgumentError, "Expecting `cc_expire` option" unless opts.has_key? :cc_expire
-    raise ArgumentError, "Expecting `cc_cvv` option" unless opts.has_key? :cc_cvv
-    raise ArgumentError, "amount: Expecting Numeric" unless opts[:amount].is_a? Numeric
-    raise ArgumentError, "currency: Not supported" unless CURRENCIES.has_key? opts[:currency]
-    raise ArgumentError, "cc_expire: Expecting Date" unless opts[:cc_expire].is_a? Date
+  def self.credit(amount:,
+                  currency:,
+                  ref:,
+                  cc_number: nil,
+                  wallet: nil,
+                  cc_expire:,
+                  cc_cvv:,
+                  subscriber: nil)
+    raise ArgumentError, "amount: Expecting Numeric" unless amount.is_a? Numeric
+    raise ArgumentError, "currency: Not supported" unless CURRENCIES.has_key? currency
+    raise ArgumentError, "cc_expire: Expecting Date" unless cc_expire.is_a? Date
 
-    if opts.has_key? :subscriber
-      raise ArgumentError, "Expecting `wallet` option" unless opts.has_key? :wallet
-      raise ArgumentError, "cc_number: Unexpected when `wallet` provided" if opts.has_key? :cc_number
+    if !subscriber.nil?
+      raise ArgumentError, "Expecting `wallet` option" if wallet.nil?
+      raise ArgumentError, "cc_number: Unexpected when `wallet` provided" unless cc_number.nil?
       op_code = 54
     else
-      raise ArgumentError, "Expecting `cc_number` option" unless opts.has_key? :cc_number
-      raise ArgumentError, "Unexpected `wallet` option" if opts.has_key? :wallet
+      raise ArgumentError, "Expecting `cc_number` option" if cc_number.nil?
+      raise ArgumentError, "Unexpected `wallet` option" unless wallet.nil?
       op_code = 4
     end
 
     vars = {
       "TYPE"      => op_code.to_s.rjust(5, "0"),
-      "REFERENCE" => @@config.ref_prefix + opts[:ref],
-      "MONTANT"   => (opts[:amount].round(2) * 100).round.to_s.rjust(10, "0"),
-      "DEVISE"    => CURRENCIES[opts[:currency]].to_s.rjust(3, "0"),
-      "PORTEUR"   => opts.has_key?(:wallet) ? opts[:wallet] : opts[:cc_number].gsub(/[ -.]/, ""),
-      "DATEVAL"   => opts[:cc_expire].strftime("%m%y"),
-      "CVV"       => opts[:cc_cvv]
+      "REFERENCE" => @@config.ref_prefix + ref,
+      "MONTANT"   => (amount.round(2) * 100).round.to_s.rjust(10, "0"),
+      "DEVISE"    => CURRENCIES[currency].to_s.rjust(3, "0"),
+      "PORTEUR"   => !wallet.nil? ? wallet : cc_number.gsub(/[ -.]/, ""),
+      "DATEVAL"   => cc_expire.strftime("%m%y"),
+      "CVV"       => cc_cvv
     }
-    if opts.has_key? :subscriber
-      vars["REFABONNE"] = @@config.ref_prefix + opts[:subscriber]
+    if !subscriber.nil?
+      vars["REFABONNE"] = @@config.ref_prefix + subscriber
     end
     req = Request.new(vars)
     req.execute!

data/lib/paybox_direct/request.rb

@@ -6,9 +6,20 @@
 require 'rack'
 
 class PayboxDirect::Request
-  attr_reader   :vars, :post_request, :fields
+  attr_reader   :vars, :post_request, :fields, :http_resp
   attr_accessor :response
 
+  @@request_callbacks = []
+  @@undo_callbacks = []
+
+  def self.on_request(&block)
+    @@request_callbacks << block
+  end
+
+  def self.on_undo(&block)
+    @@undo_callbacks << block
+  end
+
   def initialize(vars)
     defaults = {
       "VERSION"     => PayboxDirect.config.version.to_s.rjust(5, "0"),
@@ -29,6 +40,7 @@ class PayboxDirect::Request
     @post_request = nil
     @fields = nil
     @response = {}
+    @is_executed = false
   end
 
   # Executes the POST request on the Paybox server.
@@ -58,6 +70,16 @@ class PayboxDirect::Request
     end
   end
 
+  def undo!
+    return unless executed? and !failed?
+
+    @@undo_callbacks.each{ |proc| proc.call(self) }
+  end
+
+  def executed?
+    @is_executed
+  end
+
   def failed?
     raise "Not executed yet" if @fields.nil?
     return @fields["CODEREPONSE"] != "00000"
@@ -91,7 +113,9 @@ private
     http = self.class.http_connection(uri)
     @post_request = Net::HTTP::Post.new(uri.request_uri)
     @post_request.set_form_data(@vars)
-    resp = http.request(@post_request)
-    return resp
+    @http_resp = http.request(@post_request)
+    @is_executed = true
+    @@request_callbacks.each{ |proc| proc.call(self) }
+    return @http_resp
   end
 end

data/spec/request_spec.rb

@@ -47,6 +47,20 @@ RSpec.describe PayboxDirect::Request do
     expect(req.error_comment).to eq "My error description"
   end
 
+  it "calls request callbacks" do
+    expect_any_instance_of(Net::HTTP).to receive(:request){
+      OpenStruct.new({
+        code: "200",
+        body: "CODEREPONSE=00000&COMMENTAIRE=OK"
+      })
+    }
+    cb = proc {}
+    req = PayboxDirect::Request.new("VAR1" => "VAL1", "VAR2" => "VAL2")
+    PayboxDirect::Request.on_request &cb
+    expect(cb).to receive(:call).with(req)
+    req.execute!
+  end
+
   it "should raise ServerUnavailable in dev" do
     was_prod = PayboxDirect.config.is_prod
     PayboxDirect.config.is_prod = false

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paybox_direct
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Kévin Lesénéchal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-14 00:00:00.000000000 Z
+date: 2015-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake