paypoint-blue 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9097aafc20b17695e989cce94618d414cb72d404
-  data.tar.gz: 7dfc8e09ba1b8268dfc7e357eb62b87ca8964d86
+  metadata.gz: 617bb51fe80f9911886c294298720bb7c150286d
+  data.tar.gz: 9fb48b6b0bba74eaa3e17d136c1f6e3d0f9f54df
 SHA512:
-  metadata.gz: fa0c78e2028e56f6b876ba359a0090360975fee9432d6e87af6420d022069af5f01ce607d5d7f3bc4b46afad7a72bba970d5047b1224f7acd0cb5ac5de4c30f6
-  data.tar.gz: 9ae0701c9674f7b3b048f42d23ab68de6417bf14c11c8ebef486d220a46991115bebc961a90d449be04ece80f4ddd5ea1213b6fee58c469c1873072e53f538c0
+  metadata.gz: b5d26c4e5cc872308c605aa8352fc112a5d20ac5fc105f49fe3f87a0c5ab75ac372f7116a4fee7df941ea4e800e87de6922822f1ef4e86615aaa9480a6f6e2ff
+  data.tar.gz: f4ee41a5cb74df53e8d83e64fb69aee524ae700ccaa2c6a986891574358f9b1c5da86d5e80a8b4fab9624c68d464be261244eee60018a0596104aabe5e7cad1c

data/Guardfile

@@ -0,0 +1,8 @@
+guard :minitest, all_after_pass: true do
+  watch(%r{^test/test_(.*)\.rb$})
+  watch(%r{^lib/((?:.*/)?[^/]+)\.rb$}) do |m|
+    test_file = "test/test_#{m[1].tr('/', '_')}.rb"
+    File.exists?(test_file) ? test_file : 'test'
+  end
+  watch(%r{^test/minitest_helper\.rb$}) { 'test' }
+end

data/bin/console

@@ -36,7 +36,7 @@ client helpers:
 This is most useful when using the Runscope integration. The available ids are:
 
   :preauth_proceed, :preauth_cancel, :preauth_suspend, :preauth_suspend_replay,
-  :postauth_proceed, :postauth_cancel, :empty
+  :postauth_proceed, :postauth_cancel, :transaction, :expiry, :empty
 
 These will return mocky.io urls which return the proper response. Using the
 Runscope integration you will see the requests PayPoint makes to these endpoints
@@ -60,19 +60,18 @@ end
 alias :h :help
 
 def blue_default_options
-  return_base = ENV['RUNSCOPE_BUCKET'] ? "https://#{RUNSCOPE_BUCKET}.runscope.net" : "http://bluedemo.dev"
+  return_base = ENV['RUNSCOPE_BUCKET'] ? "https://#{ENV['RUNSCOPE_BUCKET']}.runscope.net" : "http://bluedemo.dev"
   {
     runscope: ENV['RUNSCOPE_BUCKET'],
     defaults: {
       currency: 'GBP',
       commerce_type: 'ECOM',
       skin: ENV['BLUE_SKIN'],
-      return_url: "#{return_base}/callback/return",
-      restore_url: "#{return_base}/callback/restore",
+      return_url: "#{return_base}/callback/return/%merchant_ref%",
       pre_auth_callback: cb(:preauth_proceed),
       post_auth_callback: cb(:postauth_proceed),
-      transaction_notification: cb(:empty),
-      expiry_notification: cb(:empty)
+      transaction_notification: cb(:transaction),
+      expiry_notification: cb(:expiry)
     }
   }
 end
@@ -95,8 +94,10 @@ def cb(id)
     preauth_suspend_replay: "http://www.mocky.io/v2/550f110a364506690a2a4211",
     postauth_proceed:       "http://www.mocky.io/v2/550f1159364506650a2a4212",
     postauth_cancel:        "http://www.mocky.io/v2/550f11633645066c0a2a4213",
+    transaction:            "http://www.mocky.io/v2/550f11723645066c0a2a4214",
+    expiry:                 "http://www.mocky.io/v2/550f11723645066c0a2a4214",
     empty:                  "http://www.mocky.io/v2/550f11723645066c0a2a4214"
-  }[id]
+  }[id] + "/#{id.to_s.split('_').first}"
 end
 
 def callbacks
@@ -104,8 +105,8 @@ def callbacks
     callbacks: {
       preAuthCallback: { url: cb(:preauth_proceed), format: "REST_JSON" },
       postAuthCallback: { url: cb(:postauth_proceed), format: "REST_JSON" },
-      transactionNotification: { url: cb(:empty), format: "REST_JSON" },
-      expiryNotification: { url: cb(:empty), format: "REST_JSON" }
+      transactionNotification: { url: cb(:transaction), format: "REST_JSON" },
+      expiryNotification: { url: cb(:expiry), format: "REST_JSON" }
     }
   }
 end

data/lib/paypoint/blue/api.rb

@@ -12,6 +12,7 @@ class PayPoint::Blue::API < PayPoint::Blue::Base
   shortcut :amount,        'transaction.amount'
   shortcut :currency,      'transaction.currency'
   shortcut :commerce_type, 'transaction.commerce_type'
+  shortcut :description,   'transaction.description'
   shortcut :customer_ref,  'customer.merchant_ref'
   shortcut :customer_name, 'customer.display_name'
 
@@ -74,7 +75,9 @@ class PayPoint::Blue::API < PayPoint::Blue::Base
   #
   # @api_url https://developer.paypoint.com/payments/docs/#payments/capture_an_authorisation
   #
-  # @applies_defaults +:commerce_type+
+  # @applies_defaults
+  #   +:commerce_type+, +:pre_auth_callback+, +:post_auth_callback+,
+  #   +:transaction_notification+, +:expiry_notification+
   #
   # @param [String] transaction_id the id of the previous transaction
   # @param [Hash] payload the payload is made up of the keyword
@@ -82,7 +85,12 @@ class PayPoint::Blue::API < PayPoint::Blue::Base
   #
   # @return the API response
   def capture_authorisation(transaction_id, **payload)
-    payload = build_payload(payload, defaults: %i[commerce_type])
+    payload = build_payload(payload,
+      defaults: %i[
+        commerce_type pre_auth_callback post_auth_callback
+        transaction_notification expiry_notification
+      ]
+    )
     client.post "transactions/#{inst_id}/#{transaction_id}/capture", payload
   end
 
@@ -90,13 +98,20 @@ class PayPoint::Blue::API < PayPoint::Blue::Base
   #
   # @api_url https://developer.paypoint.com/payments/docs/#payments/cancel_an_authorisation
   #
-  # @applies_defaults +:commerce_type+
+  # @applies_defaults
+  #   +:commerce_type+, +:pre_auth_callback+, +:post_auth_callback+,
+  #   +:transaction_notification+, +:expiry_notification+
   #
   # @param (see #capture_authorisation)
   #
   # @return the API response
   def cancel_authorisation(transaction_id, **payload)
-    payload = build_payload(payload, defaults: %i[commerce_type])
+    payload = build_payload(payload,
+      defaults: %i[
+        commerce_type pre_auth_callback post_auth_callback
+        transaction_notification expiry_notification
+      ]
+    )
     client.post "transactions/#{inst_id}/#{transaction_id}/cancel", payload
   end
 
@@ -111,6 +126,17 @@ class PayPoint::Blue::API < PayPoint::Blue::Base
     client.get "transactions/#{inst_id}/#{transaction_id}"
   end
 
+  # Get transaction details by merchant reference
+  #
+  # @api_url https://developer.paypoint.com/payments/docs/#payments/request_a_previous_transaction
+  #
+  # @param [String] merchant_ref the merchant reference for the transactions
+  #
+  # @return the API response
+  def transactions_by_ref(merchant_ref)
+    client.get "transactions/#{inst_id}/byRef?merchantRef=#{merchant_ref}"
+  end
+
   # Refund a payment
   #
   # @api_url https://developer.paypoint.com/payments/docs/#payments/refund_a_payment
@@ -122,13 +148,45 @@ class PayPoint::Blue::API < PayPoint::Blue::Base
   # @example Partial refund
   #   blue.refund_payment(txn_id, amount: '3.49') # assumes currency set as default
   #
+  # @applies_defaults
+  #   only if amount is set: +:currency+, +:commerce_type+
+  # @applies_defaults
+  #   +:pre_auth_callback+, +:post_auth_callback+,
+  #   +:transaction_notification+, +:expiry_notification+
+  #
   # @param (see #capture_authorisation)
   #
   # @return the API response
   def refund_payment(transaction_id, **payload)
-    defaults = payload[:amount] || payload[:transaction] && payload[:transaction][:amount] ? %i[currency commerce_type] : []
+    defaults = %i[ pre_auth_callback post_auth_callback transaction_notification expiry_notification ]
+    if payload[:amount] || payload[:transaction] && payload[:transaction][:amount]
+      defaults += %i[currency commerce_type]
+    end
     payload = build_payload(payload, defaults: defaults)
     client.post "transactions/#{inst_id}/#{transaction_id}/refund", payload
   end
 
+  # Submit a payout
+  #
+  # @api_url https://developer.paypoint.com/payments/docs/#payments/submit_a_payout
+  #
+  # @applies_defaults
+  #   +:currency+, +:commerce_type+, +:pre_auth_callback+,
+  #   +:post_auth_callback+, +:transaction_notification+,
+  #   +:expiry_notification+
+  #
+  # @param [Hash] payload the payload is made up of the keyword
+  #   arguments passed to the method
+  #
+  # @return the API response
+  def submit_payout(**payload)
+    payload = build_payload(payload,
+      defaults: %i[
+        currency commerce_type pre_auth_callback post_auth_callback
+        transaction_notification expiry_notification
+      ]
+    )
+    client.post "transactions/#{inst_id}/payout", payload
+  end
+
 end

data/lib/paypoint/blue/base.rb

@@ -96,7 +96,6 @@ module PayPoint
             f.response :mashify
             f.use PayPoint::Blue::HashKeyConverter
           end
-          f.response :dates
           f.response :json, content_type: /\bjson$/
           f.response :logger, options[:logger] if options[:logger] || options[:log]
 

data/lib/paypoint/blue/hosted.rb

@@ -13,6 +13,8 @@ class PayPoint::Blue::Hosted < PayPoint::Blue::Base
   shortcut :merchant_ref,  'transaction.merchant_reference'
   shortcut :amount,        'transaction.money.amount.fixed'
   shortcut :currency,      'transaction.money.currency'
+  shortcut :commerce_type, 'transaction.commerce_type'
+  shortcut :description,   'transaction.description'
   shortcut :customer_ref,  'customer.identity.merchant_customer_id'
   shortcut :customer_name, 'customer.details.name'
   shortcut :return_url,    'session.return_url.url'
@@ -29,6 +31,7 @@ class PayPoint::Blue::Hosted < PayPoint::Blue::Base
     :capture_authorisation,
     :cancel_authorisation,
     :transaction,
+    :transactions_by_ref,
     :refund_payment
 
   # The Hosted product has only a few endpoints. However, users most
@@ -55,7 +58,7 @@ class PayPoint::Blue::Hosted < PayPoint::Blue::Base
   # @api_url https://developer.paypoint.com/payments/docs/#payments/make_a_payment
   #
   # @applies_defaults
-  #   +:currency+, +:return_url+, +:restore_url+, +:skin+,
+  #   +:currency+, +:commerce_type+, +:return_url+, +:restore_url+, +:skin+,
   #   +:pre_auth_callback+, +:post_auth_callback+, +:transaction_notification+
   #
   # @param [Hash] payload the payload is made up of the keyword
@@ -65,7 +68,7 @@ class PayPoint::Blue::Hosted < PayPoint::Blue::Base
   def make_payment(**payload)
     payload = build_payload(payload,
       defaults: %i[
-        currency return_url restore_url skin
+        currency commerce_type return_url restore_url skin
         pre_auth_callback post_auth_callback transaction_notification
       ]
     )
@@ -89,4 +92,26 @@ class PayPoint::Blue::Hosted < PayPoint::Blue::Base
     make_payment(**payload)
   end
 
+  # Submit a payout
+  #
+  # @api_url https://developer.paypoint.com/payments/docs/#payments/submit_a_payout
+  #
+  # @applies_defaults
+  #   +:currency+, +:commerce_type+, +:return_url+, +:restore_url+, +:skin+,
+  #   +:pre_auth_callback+, +:post_auth_callback+, +:transaction_notification+
+  #
+  # @param [Hash] payload the payload is made up of the keyword
+  #   arguments passed to the method
+  #
+  # @return the API response
+  def submit_payout(**payload)
+    payload = build_payload(payload,
+      defaults: %i[
+        currency commerce_type return_url restore_url skin
+        pre_auth_callback post_auth_callback transaction_notification
+      ]
+    )
+    client.post "sessions/#{inst_id}/payouts", build_payload(payload)
+  end
+
 end

data/lib/paypoint/blue/payload_builder.rb

@@ -42,6 +42,11 @@ module PayPoint
       # Builds the payload by applying default values and replacing
       # shortcuts
       #
+      # @note When using the callback and notification shortcuts, the
+      # builder will also default their +format+ to +'REST_JSON'+,
+      # because the PayPoint API requires it in _some_ cases. If your
+      # endpoints expect XML, you won't be able to use these shortcuts.
+      #
       # @param [Hash] payload the original payload using shortcuts
       # @param [Array<Symbol>] defaults an array of symbols for defaults
       #   that should be applied to this payload
@@ -54,6 +59,10 @@ module PayPoint
             leaf = segments.pop
             leaf_parent = segments.reduce(payload) {|h,k| h[k] ||= {}}
             leaf_parent[leaf] ||= value
+
+            if key =~ /_(?:callback|notification)\Z/
+              leaf_parent[:format] ||= "REST_JSON"
+            end
           end
         end
         payload
@@ -66,11 +75,15 @@ module PayPoint
 
         defaults.each do |key, value|
           if applicable_defaults.include?(key) && !payload.has_key?(key)
-            payload[key] = value
+            payload[key] = interpolate_values(value, payload)
           end
         end
       end
 
+      def interpolate_values(value, payload)
+        value.gsub(/%(\w+)%/) {|m| payload[$1.to_sym] || m}
+      end
+
     end
 
   end

data/lib/paypoint/blue/version.rb

@@ -1,5 +1,5 @@
 module PayPoint
   module Blue
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/paypoint/blue.rb

@@ -20,5 +20,15 @@ module PayPoint
       PayPoint::Blue::Hosted.new(**options)
     end
 
+    # Parse a raw JSON PayPoint callback payload similarly to the
+    # Faraday response middlewares set up in {PayPoint::Blue::Base}.
+    #
+    # @return [Hashie::Mash] the parsed, snake_cased response
+    def self.parse_payload(json)
+      payload = JSON.parse(json.is_a?(IO) ? json.read : json.to_s)
+      payload = Utils.snakecase_and_symbolize_keys(payload)
+      Hashie::Mash.new(payload)
+    end
+
   end
 end

data/paypoint-blue.gemspec

@@ -26,4 +26,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.8"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "webmock"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-minitest"
+  spec.add_development_dependency "terminal-notifier-guard"
+  spec.add_development_dependency "terminal-notifier"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paypoint-blue
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Laszlo Bacsi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-03-24 00:00:00.000000000 Z
+date: 2015-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,6 +94,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: API client for PayPoint's 3rd generation PSP product a.k.a PayPoint Blue
 email:
 - lackac@lackac.hu
@@ -105,6 +161,7 @@ files:
 - ".travis.yml"
 - ".yardopts"
 - Gemfile
+- Guardfile
 - LICENSE
 - README.md
 - Rakefile