cardinity 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89277a2f03c1fd84b02c4ccf81686059c0566d734e9f8b82ad0695a33c096f91
-  data.tar.gz: 2602f3ad85e8937a94b125e704bf10f9586c8dee9c6b2db0ecdbe8beb1617af8
+  metadata.gz: 869663da5da3a101dacfec24b52bcfe60ded6df1beece8c0475969fb0db2e597
+  data.tar.gz: 543f216baba16da8ac063faec41a6c9f398827be50eb5a244bf0688fad4d9112
 SHA512:
-  metadata.gz: 60e1b3633a5df1ea4e226544e659cd87e45aac2f41a0275d066a36b8ccf48a9a9713166273307cdb731689adb4780a2626d32b7160bf87822d9e5c5d7f0af581
-  data.tar.gz: 93e4477d0dbd84e596b71921ebe6ad0ba3ed412d2af14d53cbef93de447c6982f2dacfc84bfbf94f15bf2890ae191d0fa014c17390eb07b86a208d1baaa4297d
+  metadata.gz: 748e5e48e97038dd4570afdacd4e659af54169ce3775b5e93a64d52fd4a2981b7900ddd54919ee8735aedfac5a11ddb517cffdc9d779dfec323edba1ab074fec
+  data.tar.gz: b395bf1643b76c7817bc74e18c317747ff09a39dd0af2158d09043236ee194fdfeccc8e82eaf334df33ae3707a66f0053936d213791d4e75f344913e148a13a0

data/lib/cardinity.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cardinity/version'
 require 'cardinity/utils'
 require 'cardinity/auth'
@@ -18,9 +20,15 @@ module Cardinity
   TYPE_PURCHASE = 'purchase'
   TYPE_ERROR = 'https://developers.cardinity.com/api/v1/'
 
+  # Configure Cardinity. Must be called before other methods.
+  #
+  # @param [Hash] options
+  # @option options [String] :key API key.
+  # @option options [String] :secret API secret.
+  # @option options [String] :api_base (DEFAULT_API_BASE) API base URL.
   def self.configure!(options)
     @config = {
-        # key and secret to be supplied from outsite
+        # key and secret to be supplied from outside
         api_base: DEFAULT_API_BASE
     }
     @config.merge! options
@@ -29,24 +37,25 @@ module Cardinity
 
   # Creates a Payment object
   #
-  # Accepted attributes:
-  # - amount (#0.00, two decimals required)
-  # - currency (EUR,USD)
-  # - settle (boolean, default true, false means just pre-authorize and finish later)
-  # - order_id (not required)
-  # - description (not required)
-  # - country (country of customer, required)
-  # - payment_method (required, only supported value is card)
-  # - payment_instrument (card details)
-  #   - pan (card number)
-  #   - exp_year
-  #   - exp_month
-  #   - cvc
-  #   - holder
-  #
-  # Returns:
-  # - updated payment object on success
-  # - error object on error
+  # @param [Hash] payment_hash Payment data. Keys can be symbols or strings.
+  # @option payment_hash [Numeric, String] :amount #0.00.
+  #   If a string, two decimals are required.
+  # @option payment_hash [String] :currency Three-letter ISO currency code,
+  #   e.g. "EUR".
+  # @option payment_hash [Boolean] :settle (true) If false, creates a
+  #   pre-authorization instead of settling immediately.
+  # @option payment_hash [String] :country Customer's billing country as
+  #   ISO 3166-1 alpha-2 country code, required.
+  # @option payment_hash [String] :payment_method ('card')
+  # @option payment_hash [Hash] :payment_instrument Card details:
+  #   * :pan [String] Card number.
+  #   * :exp_year [Integer] 4-digit year.
+  #   * :exp_month [Integer] 2-digit month
+  #   * :cvc [Integer] Card security code.
+  #   * :holder [String] Cardholder's name, max length 32 characters.
+  # @option payment_hash [String, nil] :order_id (nil)
+  # @option payment_hash [String, nil] :description (nil)
+  # @return [Hash] Updated payment object or an error object.
   def self.create_payment(payment_hash)
     checked_payment_data = check_payment_data(payment_hash)
     parse post(payments_uri, serialize(checked_payment_data))
@@ -57,19 +66,53 @@ module Cardinity
   # This is necessary for 3D secure payments, when the customer has completed
   # the 3D secure redirects and authorization.
   #
-  # Accepted attributes:
-  #  - authorize_data (PaRes string received from 3D secure)
-  #
-  # Returns:
-  # - updated payment object on success
-  # - error object on error
+  # @param [String] payment_id
+  # @param [String] authorize_data PaRes string received from 3D secure.
+  # @return [Hash] Payment or error object.
   def self.finalize_payment(payment_id, authorize_hash)
     parse patch(payment_uri(payment_id), serialize(authorize_hash))
   end
 
-  # Get list of all payments
-  def self.payments
-    parse get(payments_uri)
+  # Get list of the last payments.
+  # By default, cardinity returns 10 payments. Pass `limit` to override.
+  # @param [Integer, nil] limit
+  # @return [Array<Hash>, Hash] Payment objects or an error object.
+  def self.payments(limit: nil)
+    query = {}
+    query[:limit] = limit if limit
+    parse get(payments_uri, query)
+  end
+
+  # Get the payment information for the given payment ID.
+  # @param [String] payment_id
+  # @return [Hash] Payment or error object.
+  def self.payment(payment_id)
+    parse get(payment_uri(payment_id))
   end
 
+  # Fully or partially refund a payment
+  # @param [String] payment_id
+  # @param [Numeric, String] amount If a string, two decimals are required.
+  # @param [String] description
+  # @return [Hash] Refund or error object.
+  def self.create_refund(payment_id, amount:, description: '')
+    amount = format('%.2f', amount) if amount.is_a?(Numeric)
+    parse post(refunds_uri(payment_id),
+               serialize(amount: amount, description: description))
+  end
+
+  # Get all the refunds for the given payment ID.
+  # @param [String] payment_id
+  # @return [Array<Hash>, Hash] Refund objects or an error object.
+  def self.refunds(payment_id)
+    parse get(refunds_uri(payment_id))
+  end
+
+  # Get the refund for the given payment ID and refund ID.
+  # @param [String] payment_id
+  # @param [String] refund_id
+  # @return [Hash] Refund or error object.
+  def self.refund(payment_id, refund_id)
+    parse get(refund_uri(payment_id, refund_id))
+  end
 end

data/lib/cardinity/auth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 require 'openssl'
 require 'uri'
@@ -12,16 +14,16 @@ class Cardinity::Auth
     @config = config
   end
 
-  def sign_request(method, uri)
+  def sign_request(method, uri, params = {})
     params = {
         oauth_consumer_key: @config[:key],
         oauth_nonce: generate_key,
         oauth_signature_method: SIGNATURE_METHOD,
         oauth_timestamp: generate_timestamp,
         oauth_version: OAUTH_VERSION
-    }
+    }.update(params)
     params[:oauth_signature] = request_signature(method, uri, params)
-    params_str = params.collect { |k, v| "#{k}=\"#{escape(v)}\"" }.join(', ')
+    params_str = params.map { |k, v| "#{k}=\"#{escape(v.to_s)}\"" }.join(', ')
     "OAuth #{params_str}"
   end
 

data/lib/cardinity/utils.rb

@@ -1,14 +1,21 @@
+# frozen_string_literal: true
+
+require 'uri'
+
 module Cardinity
 
-  CODES_WITH_RESPONSE = [200, 201, 202, 400, 402]
+  CODES_WITH_RESPONSE = [200, 201, 202, 400, 401, 402, 405, 500, 503]
 
   def self.check_payment_data(payment)
     payment = payment.dup
-    if payment[:payment_method].nil?
-      payment[:payment_method] = 'card'
+    payment_method = payment['payment_method'] || payment[:payment_method]
+    if payment_method.nil?
+      payment['payment_method'] = 'card'
     end
-    if payment[:amount].is_a?(Numeric)
-      payment[:amount] = '%.2f' % payment[:amount]
+    amount = payment['amount'] || payment[:amount]
+    if amount.is_a?(Numeric)
+      payment.delete(:amount)
+      payment['amount'] = format('%.2f', amount)
     end
     payment
   end
@@ -21,6 +28,14 @@ module Cardinity
     "#{api_base}#{API_PAYMENTS}/#{payment_id}"
   end
 
+  def self.refunds_uri(payment_id)
+    "#{api_base}#{API_PAYMENTS}/#{payment_id}/refunds"
+  end
+
+  def self.refund_uri(payment_id, refund_id)
+    "#{api_base}#{API_PAYMENTS}/#{payment_id}/refunds/#{refund_id}"
+  end
+
   def self.parse(response)
     JSON.parse response.body
   end
@@ -37,8 +52,10 @@ module Cardinity
     end
   end
 
-  def self.get(uri)
-    RestClient.get uri, headers(:get, uri)
+  def self.get(base_url, params = {})
+    uri = URI.parse(base_url)
+    uri.query = URI.encode_www_form(params)
+    RestClient.get uri.to_s, headers(:get, base_url, params)
   rescue RestClient::ExceptionWithResponse => e
     handle_error_response e
   end
@@ -55,10 +72,10 @@ module Cardinity
     handle_error_response e
   end
 
-  def self.headers(method, uri)
+  def self.headers(method, uri, params = {})
     {
         content_type: 'application/json',
-        authorization: @auth.sign_request(method, uri)
+        authorization: @auth.sign_request(method, uri, params)
     }
   end
 
@@ -66,4 +83,4 @@ module Cardinity
     @config[:api_base]
   end
 
-end
+end

data/lib/cardinity/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cardinity
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cardinity
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jan Sterba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2018-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler