paypoint-blue 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 82b114473871861140e8796d61ac85a852a273d2
-  data.tar.gz: 1034d197286e603f13b8f5b409db165c89ce5edb
+  metadata.gz: 0720906c714d8425e8af2ea0bf97a877740caccf
+  data.tar.gz: 8e3711213ea3b1db72eaeeb28a76f60b860ff902
 SHA512:
-  metadata.gz: 721d6ef451f97773e72f2fef33a9895d9a0c624ac527ffad46320e14928d23814f2a29a6ea30c33233b780a67f39b08161e59d9dfeaeb6c60f1141321af5f85d
-  data.tar.gz: 041fdf89fdf82280b6459a32f1d7a0992d28d3a4b2f2057b4ed316d01854fe8a9cfb598e1a0a201484382fe79ad531af1b15e376259f64dbbafce2259eaf40e9
+  metadata.gz: 0eefb28d9180465c528f689e926944210120c67d53c2131ca3000ce5a361a4138dda564e493d82b4e031bcb7c7f12090eb1706a10a94eb2dae4063a7f1e13eeb
+  data.tar.gz: 8a694c43a0bf2dd305ce6ff9fbc29168452b1b10b4c17a751c5cb88bd33890442f0a11f700f903cae09b97bac750ee5e938f2506b3c14be3b38b31adbe59e721

data/.overcommit.yml

@@ -0,0 +1,11 @@
+PreCommit:
+  ALL:
+    quiet: false
+
+  RuboCop:
+    enabled: yes
+    on_warn: fail # Treat all warnings as failures
+
+CommitMsg:
+  TextWidth:
+    enabled: yes

data/.rubocop.yml

@@ -0,0 +1,45 @@
+AllCops:
+  Include:
+    - "**/Gemfile"
+  Exclude:
+    - "bin/*"
+    - "support/**/*"
+    - "vendor/**/*"
+
+### Style ######################################################################
+
+Style/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+Style/BlockDelimiters:
+  EnforcedStyle: line_count_based
+
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# Not enforcing %i() arrays, because they are too similar to %w() and don't have
+# proper syntax highlighting support for differentiating between them.
+Style/SymbolArray:
+  Enabled: false
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+Style/ClassAndModuleChildren:
+  Enabled: false

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in paypoint-blue.gemspec
 gemspec

data/lib/paypoint/blue/api.rb

@@ -2,24 +2,23 @@ require "paypoint/blue/base"
 
 # Client class for the API product.
 class PayPoint::Blue::API < PayPoint::Blue::Base
-
   ENDPOINTS = {
     test: "https://api.mite.paypoint.net:2443/acceptor/rest",
     live: "https://api.paypoint.net/acceptor/rest",
   }.freeze
 
-  shortcut :merchant_ref,  'transaction.merchant_ref'
-  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'
+  shortcut :merchant_ref,  "transaction.merchant_ref"
+  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"
 
-  shortcut :pre_auth_callback,        'callbacks.pre_auth_callback.url'
-  shortcut :post_auth_callback,       'callbacks.post_auth_callback.url'
-  shortcut :transaction_notification, 'callbacks.transaction_notification.url'
-  shortcut :expiry_notification,      'callbacks.expiry_notification.url'
+  shortcut :pre_auth_callback,        "callbacks.pre_auth_callback.url"
+  shortcut :post_auth_callback,       "callbacks.post_auth_callback.url"
+  shortcut :transaction_notification, "callbacks.transaction_notification.url"
+  shortcut :expiry_notification,      "callbacks.expiry_notification.url"
 
   # Test connectivity
   #
@@ -45,11 +44,9 @@ class PayPoint::Blue::API < PayPoint::Blue::Base
   #
   # @return the API response
   def make_payment(**payload)
-    payload = build_payload(payload,
-      defaults: %i[
-        currency commerce_type pre_auth_callback post_auth_callback
-        transaction_notification expiry_notification
-      ]
+    payload = build_payload payload, defaults: %i(
+      currency commerce_type pre_auth_callback post_auth_callback
+      transaction_notification expiry_notification
     )
     client.post "transactions/#{inst_id}/payment", payload
   end
@@ -85,11 +82,9 @@ 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 pre_auth_callback post_auth_callback
-        transaction_notification expiry_notification
-      ]
+    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
@@ -106,11 +101,9 @@ class PayPoint::Blue::API < PayPoint::Blue::Base
   #
   # @return the API response
   def cancel_authorisation(transaction_id, **payload)
-    payload = build_payload(payload,
-      defaults: %i[
-        commerce_type pre_auth_callback post_auth_callback
-        transaction_notification expiry_notification
-      ]
+    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
@@ -146,7 +139,7 @@ class PayPoint::Blue::API < PayPoint::Blue::Base
   # +amount+ or a +transaction+ hash as a keyword argument.
   #
   # @example Partial refund
-  #   blue.refund_payment(txn_id, amount: '3.49') # assumes currency set as default
+  #   blue.refund_payment(txn_id, amount: '3.49') # assumes a default currency
   #
   # @applies_defaults
   #   only if amount is set: +:currency+, +:commerce_type+
@@ -158,9 +151,13 @@ class PayPoint::Blue::API < PayPoint::Blue::Base
   #
   # @return the API response
   def refund_payment(transaction_id, **payload)
-    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]
+    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
@@ -180,13 +177,10 @@ class PayPoint::Blue::API < PayPoint::Blue::Base
   #
   # @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
-      ]
+    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

@@ -9,7 +9,6 @@ require "paypoint/blue/faraday_runscope"
 
 module PayPoint
   module Blue
-
     # Abstract base class for the API clients. Takes care of
     # initializing the Faraday client by setting up middlewares in the
     # right order.
@@ -25,7 +24,6 @@ module PayPoint
     #
     # @abstract
     class Base
-
       include PayloadBuilder
 
       # The Faraday client
@@ -54,23 +52,18 @@ module PayPoint
       # @option options [String] :runscope when used, all traffic will
       #   pass through the provided {https://www.runscope.com/ Runscope}
       #   bucket, including notification callbacks
-      def initialize(endpoint:,
-                     inst_id: ENV['BLUE_API_INSTALLATION'],
-                     api_id: ENV['BLUE_API_ID'],
-                     api_password: ENV['BLUE_API_PASSWORD'],
-                     **options)
-
-        @endpoint = get_endpoint_or_override_with(endpoint)
+      def initialize(endpoint:, inst_id: ENV["BLUE_API_INSTALLATION"],
+            api_id: ENV["BLUE_API_ID"], api_password: ENV["BLUE_API_PASSWORD"],
+            **options)
 
-        @inst_id      = inst_id or raise ArgumentError, 'missing inst_id'
-        @api_id       = api_id or raise ArgumentError, 'missing api_id'
-        @api_password = api_password or raise ArgumentError, 'missing api_password'
-
-        options[:url] = @endpoint
-        @options = options
+        @endpoint     = get_endpoint_or_override_with(endpoint)
+        @inst_id      = inst_id or fail ArgumentError, "missing inst_id"
+        @api_id       = api_id or fail ArgumentError, "missing api_id"
+        @api_password =
+          api_password or fail ArgumentError, "missing api_password"
 
         self.defaults = options.delete(:defaults)
-
+        @options = options.merge url: @endpoint
         @client = build_client
       end
 
@@ -79,14 +72,14 @@ module PayPoint
       attr_reader :inst_id, :options
 
       def get_endpoint_or_override_with(endpoint)
-        self.class.const_get('ENDPOINTS').fetch(endpoint, endpoint.to_s)
+        self.class.const_get("ENDPOINTS").fetch(endpoint, endpoint.to_s)
       end
 
       def client_options
         options.select { |k, _| Faraday::ConnectionOptions.members.include?(k) }
       end
 
-      def build_client
+      def build_client # rubocop:disable AbcSize, MethodLength
         Faraday.new(client_options) do |f|
           unless options[:raw]
             # This extracts the body and discards all other data from the
@@ -101,15 +94,17 @@ module PayPoint
             f.use PayPoint::Blue::HashKeyConverter
           end
           f.response :json, content_type: /\bjson$/
-          f.response :logger, options[:logger] if options[:logger] || options[:log]
+          if options[:logger] || options[:log]
+            f.response :logger, options[:logger]
+          end
 
           # This sends all API traffic through Runscope, including
           # notifications. It needs to be inserted here before the JSON
           # request middleware so that it is able to transform
           # notification URLs too.
           if options[:runscope]
-            f.use FaradayRunscope, options[:runscope],
-              transform_paths: /\A(callbacks|session)\.\w+(Callback|Notification)\.url\Z/
+            path_re = /\A(callbacks|session)\.\w+(Callback|Notification)\.url\Z/
+            f.use FaradayRunscope, options[:runscope], transform_paths: path_re
           end
 
           f.request :basic_auth, @api_id, @api_password

data/lib/paypoint/blue/body_extractor.rb

@@ -1,18 +1,14 @@
 module PayPoint
   module Blue
-
     # Faraday middleware which extracts the body from the response
     # object and returns with just that discarding all other meta
     # information.
     class BodyExtractor < Faraday::Middleware
-
       # Extract and return just the body discarding everything else
       def call(env)
         response = @app.call(env)
         response.env[:body]
       end
-
     end
-
   end
 end

data/lib/paypoint/blue/error.rb

@@ -1,10 +1,8 @@
 module PayPoint
   module Blue
-
     # Abstract error base class
     # @abstract
     class Error < StandardError
-
       # the response that caused the error
       attr_reader :response
 
@@ -53,8 +51,6 @@ module PayPoint
 
       # Specific error class for errors with an +'U'+ outcome code
       class Suspended < Error; end
-
     end
-
   end
 end

data/lib/paypoint/blue/faraday_runscope.rb

@@ -1,5 +1,6 @@
+# Faraday middleware for transforming API endpoint urls and certain urls in JSON
+# payloads to be proxied by Runscope for tracking and debugging purposes.
 class FaradayRunscope < Faraday::Middleware
-
   CUSTOM_PORT = "Runscope-Request-Port".freeze
 
   def initialize(app, bucket, transform_paths: false)
@@ -9,10 +10,7 @@ class FaradayRunscope < Faraday::Middleware
   end
 
   def call(env)
-    if env.url.port != env.url.default_port
-      env.request_headers[CUSTOM_PORT] = env.url.port.to_s
-      env.url.port = env.url.default_port
-    end
+    handle_custom_port(env)
 
     transform_url env.url
 
@@ -27,6 +25,12 @@ class FaradayRunscope < Faraday::Middleware
 
   attr_accessor :bucket, :transform_paths
 
+  def handle_custom_port(env)
+    return if env.url.port == env.url.default_port
+    env.request_headers[CUSTOM_PORT] = env.url.port.to_s
+    env.url.port = env.url.default_port
+  end
+
   def transform_url(url)
     if url.respond_to?(:host=)
       url.host = runscope_host(url.host)
@@ -39,10 +43,10 @@ class FaradayRunscope < Faraday::Middleware
   end
 
   def runscope_host(host)
-    "#{host.gsub('-', '--').tr('.', '-')}-#{bucket}.runscope.net"
+    "#{host.gsub("-", "--").tr(".", "-")}-#{bucket}.runscope.net"
   end
 
-  def transform_paths!(enum, path=nil)
+  def transform_paths!(enum, path = nil)
     each_pair(enum) do |key, value|
       key_path = path ? "#{path}.#{key}" : key.to_s
       if value.respond_to?(:each_with_index)
@@ -66,9 +70,8 @@ class FaradayRunscope < Faraday::Middleware
   end
 
   def transform_path?(path)
-    transform_paths.any? do |path_to_transform|
-      path_to_transform === path
+    transform_paths.any? do |path_pattern|
+      path_pattern.is_a?(Regexp) ? path =~ path_pattern : path == path_pattern
     end
   end
-
 end

data/lib/paypoint/blue/hash_key_converter.rb

@@ -1,11 +1,9 @@
 module PayPoint
   module Blue
-
     # Faraday middleware for converting hash keys in the request payload
     # from snake_case to camelCase and the other way around in the
     # response.
     class HashKeyConverter < Faraday::Middleware
-
       # Convert hash keys to camelCase in the request and to snake_case
       # in the response
       def call(env)
@@ -15,7 +13,8 @@ module PayPoint
 
         @app.call(env).on_complete do |response_env|
           if response_env.body.is_a?(Enumerable)
-            response_env.body = Utils.snakecase_and_symbolize_keys(response_env.body)
+            response_env.body =
+              Utils.snakecase_and_symbolize_keys(response_env.body)
           end
         end
       end

data/lib/paypoint/blue/hosted.rb

@@ -4,26 +4,26 @@ require "paypoint/blue/base"
 
 # Client class for the Hosted product.
 class PayPoint::Blue::Hosted < PayPoint::Blue::Base
-
   ENDPOINTS = {
     test: "https://hosted.mite.paypoint.net/hosted/rest",
-    live: "https://hosted.paypoint.net/hosted/rest"
+    live: "https://hosted.paypoint.net/hosted/rest",
   }.freeze
 
-  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'
-  shortcut :restore_url,   'session.restore_url.url'
-  shortcut :skin,          'session.skin'
+  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"
+  shortcut :cancel_url,    "session.cancel_url.url"
+  shortcut :restore_url,   "session.restore_url.url"
+  shortcut :skin,          "session.skin"
 
-  shortcut :pre_auth_callback,        'session.pre_auth_callback.url'
-  shortcut :post_auth_callback,       'session.post_auth_callback.url'
-  shortcut :transaction_notification, 'session.transaction_notification.url'
+  shortcut :pre_auth_callback,        "session.pre_auth_callback.url"
+  shortcut :post_auth_callback,       "session.post_auth_callback.url"
+  shortcut :transaction_notification, "session.transaction_notification.url"
 
   extend Forwardable
 
@@ -58,19 +58,18 @@ class PayPoint::Blue::Hosted < PayPoint::Blue::Base
   # @api_url https://developer.paypoint.com/payments/docs/#payments/make_a_payment
   #
   # @applies_defaults
-  #   +:currency+, +:commerce_type+, +:return_url+, +:restore_url+, +:skin+,
-  #   +:pre_auth_callback+, +:post_auth_callback+, +:transaction_notification+
+  #   +:currency+, +:commerce_type+, +:return_url+, +:cancel_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 make_payment(**payload)
-    payload = build_payload(payload,
-      defaults: %i[
-        currency commerce_type return_url restore_url skin
-        pre_auth_callback post_auth_callback transaction_notification
-      ]
+    payload = build_payload payload, defaults: %i(
+      currency commerce_type return_url cancel_url restore_url skin
+      pre_auth_callback post_auth_callback transaction_notification
     )
     client.post "sessions/#{inst_id}/payments", build_payload(payload)
   end
@@ -97,21 +96,19 @@ class PayPoint::Blue::Hosted < PayPoint::Blue::Base
   # @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+
+  #   +:currency+, +:commerce_type+, +:return_url+, +:cancel_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
-      ]
+    payload = build_payload payload, defaults: %i(
+      currency commerce_type return_url cancel_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

@@ -1,15 +1,14 @@
 module PayPoint
   module Blue
-
     # Provides helper methods for payload construction used throughout
     # the API. It allows definition of payload shortcuts and default
     # values.
     module PayloadBuilder
-
       def self.included(base)
         base.extend ClassMethods
       end
 
+      # Class level methods for PayloadBuilder.
       module ClassMethods
         def shortcuts
           @shortcuts ||= {}
@@ -23,10 +22,12 @@ module PayPoint
         # to commonly used paths.
         #
         # @example Define and use a shortcut
-        #   PayPoint::Blue::Hosted.shortcut :amount, 'transaction.money.amount.fixed'
-        #   blue.make_payment(amount: '3.49', ...)
+        #   class PayPoint::Blue::Hosted
+        #     shortcut :amount, "transaction.money.amount.fixed"
+        #   end
+        #   blue.make_payment(amount: "3.49", ...)
         #     # this will be turned into
-        #     # { transaction: { money: { amount: { fixed: '3.49' } } } }
+        #     # { transaction: { money: { amount: { fixed: "3.49" } } } }
         #
         # @param [Symbol] key the shortcut key
         # @param [String] path a path into the payload with segments
@@ -55,20 +56,7 @@ module PayPoint
       #   that should be applied to this payload
       def build_payload(payload, defaults: [])
         apply_defaults(payload, defaults)
-        payload.keys.each do |key|
-          if path = self.class.shortcut(key)
-            value = payload.delete(key)
-            segments = path.split('.').map(&:to_sym)
-            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
+        expand_shortcuts(payload)
       end
 
       private
@@ -77,14 +65,33 @@ module PayPoint
         return unless defaults
 
         defaults.each do |key, value|
-          if applicable_defaults.include?(key) && !payload.has_key?(key)
+          if applicable_defaults.include?(key) && !payload.key?(key)
             payload[key] = interpolate_values(value, payload)
           end
         end
       end
 
       def interpolate_values(value, payload)
-        value.gsub(/%(\w+)%/) {|m| payload[$1.to_sym] || m}
+        value.gsub(/%(\w+)%/) { |m| payload[Regexp.last_match(1).to_sym] || m }
+      end
+
+      def expand_shortcuts(payload)
+        payload.keys.each do |key|
+          next unless (path = self.class.shortcut(key))
+          expand_shortcut(payload, key, path)
+        end
+        payload
+      end
+
+      def expand_shortcut(payload, key, path)
+        value = payload.delete(key)
+        segments = path.split(".").map(&:to_sym)
+        leaf = segments.pop
+        leaf_parent = segments.reduce(payload) { |a, e| a[e] ||= {} }
+        leaf_parent[leaf] ||= value
+
+        callback_re = /_(?:callback|notification)\Z/
+        leaf_parent[:format] ||= "REST_JSON" if key =~ callback_re
       end
     end
   end

data/lib/paypoint/blue/raise_errors.rb

@@ -2,10 +2,8 @@ require "paypoint/blue/error"
 
 module PayPoint
   module Blue
-
     # Faraday response middleware for handling various error scenarios
     class RaiseErrors < Faraday::Response::Middleware
-
       # Raise an error if the response outcome signifies a failure or
       # the HTTP status code is 400 or greater.
       #
@@ -18,20 +16,12 @@ module PayPoint
       def on_complete(env)
         outcome = fetch_outcome(env)
         if outcome
-          case outcome[:reason_code]
-          when /^S/ then return
-          when /^V/ then raise Error::Validation, response_values(env)
-          when /^A/ then raise Error::Auth,       response_values(env)
-          when /^C/ then raise Error::Cancelled,  response_values(env)
-          when /^X/ then raise Error::External,   response_values(env)
-          when /^U/ then raise Error::Suspended,  response_values(env)
-          else
-            raise Error::Client, response_values(env)
-          end
+          return if outcome[:reason_code] =~ /^S/
+          fail error_from_outcome(outcome[:reason_code], response_values(env))
         elsif not_found?(env)
-          raise Error::NotFound, response_values(env)
+          fail Error::NotFound, response_values(env)
         elsif client_error?(env)
-          raise Error::Client, response_values(env)
+          fail Error::Client, response_values(env)
         end
       end
 
@@ -49,11 +39,23 @@ module PayPoint
         env.body.is_a?(Hash) && env.body[:outcome]
       end
 
+      def error_from_outcome(code, response_values)
+        case code
+        when /^V/ then Error::Validation.new(response_values)
+        when /^A/ then Error::Auth.new(response_values)
+        when /^C/ then Error::Cancelled.new(response_values)
+        when /^X/ then Error::External.new(response_values)
+        when /^U/ then Error::Suspended.new(response_values)
+        else
+          Error::Client.new(response_values)
+        end
+      end
+
       def response_values(env)
         {
           status:  env.status,
           headers: env.response_headers,
-          body:    env.body
+          body:    env.body,
         }
       end
     end

data/lib/paypoint/blue/utils.rb

@@ -1,17 +1,17 @@
 module PayPoint
   module Blue
+    # Miscellaneous helper methods used in multiple places.
     module Utils
-
-      extend self
+      module_function
 
       def snakecase_and_symbolize_keys(hash)
         case hash
         when Hash
-          hash.each_with_object({}) do |(key, value), snakified|
+          hash.each_with_object({},) do |(key, value), snakified|
             snakified[snakecase(key)] = snakecase_and_symbolize_keys(value)
           end
         when Enumerable
-          hash.map {|v| snakecase_and_symbolize_keys(v)}
+          hash.map { |v| snakecase_and_symbolize_keys(v) }
         else
           hash
         end
@@ -20,11 +20,11 @@ module PayPoint
       def camelcase_and_symbolize_keys(hash)
         case hash
         when Hash
-          hash.each_with_object({}) do |(key, value), camelized|
+          hash.each_with_object({},) do |(key, value), camelized|
             camelized[camelcase(key)] = camelcase_and_symbolize_keys(value)
           end
         when Enumerable
-          hash.map {|v| camelcase_and_symbolize_keys(v)}
+          hash.map { |v| camelcase_and_symbolize_keys(v) }
         else
           hash
         end
@@ -42,10 +42,9 @@ module PayPoint
 
       def camelcase(original)
         string = original.is_a?(Symbol) ? original.to_s : original.dup
-        string.gsub!(/_([a-z\d]*)/) { $1.capitalize }
+        string.gsub!(/_([a-z\d]*)/) { Regexp.last_match(1).capitalize }
         string.to_sym
       end
-
     end
   end
 end

data/lib/paypoint/blue/version.rb

@@ -1,5 +1,5 @@
 module PayPoint
-  module Blue
-    VERSION = "0.3.0"
+  module Blue # rubocop:disable Documentation
+    VERSION = "0.4.0"
   end
 end

data/lib/paypoint/blue.rb

@@ -4,8 +4,8 @@ require "paypoint/blue/hosted"
 require "paypoint/blue/utils"
 
 module PayPoint
+  # Top level module with helper methods.
   module Blue
-
     # Creates a client for the PayPoint Blue API product
     #
     # @see PayPoint::Blue::Base#initialize
@@ -27,12 +27,11 @@ module PayPoint
     def self.parse_payload(json)
       payload = json.respond_to?(:read) ? json.read : json.to_s
       if payload.encoding == Encoding::ASCII_8BIT
-        payload.force_encoding 'iso-8859-1'
+        payload.force_encoding "iso-8859-1"
       end
       payload = JSON.parse(payload)
       payload = Utils.snakecase_and_symbolize_keys(payload)
       Hashie::Mash.new(payload)
     end
-
   end
 end

data/support/yard_ext.rb

@@ -3,7 +3,7 @@ class ShortcutHandler < YARD::Handlers::Ruby::Base
   namespace_only
 
   def process
-    unless namespace.docstring.index('== Payload Shortcuts')
+    unless namespace.docstring.index("== Payload Shortcuts")
       namespace.docstring += "\n\n== Payload Shortcuts\n"
     end
     shortcut = statement.parameters.first.jump(:ident).source

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: paypoint-blue
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Laszlo Bacsi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-12 00:00:00.000000000 Z
+date: 2015-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -158,6 +158,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".overcommit.yml"
+- ".rubocop.yml"
 - ".travis.yml"
 - ".yardopts"
 - Gemfile