cardinity 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f11054ae9a4a74c663c741d1d6e53cc679b9684b
-  data.tar.gz: ed309c4fd81fbdd4f3af840e8e0e619855933167
+  metadata.gz: 1792daaf31ee88c7c270dc6e00bd625007923fe6
+  data.tar.gz: e09efc856cd5332d1dadede05177006f5dda970e
 SHA512:
-  metadata.gz: 7821197020d3a79e12a511dfe02696a6e5f39a13f87e03f506e6198b33a8c98f08028adf90f5c9f2317ea173b0b1238876b30b9b1e39b0f244698e55768e949e
-  data.tar.gz: 14516824e4ebe5136e28151004ade1c86fcbc1850b68860f015aae50f63916b5683dd7b779f5e60c950a5adb5cb4b375d512be4f218e5f517bc3c3b6260c5c11
+  metadata.gz: b031d6b90c243e431ca5a7e3d957d43f2fd002cce7c630bf15ced922cea8959a71897ab8861613c6afb39996089d4cfe4138f04c5751601872bae0064e55e7fc
+  data.tar.gz: 165cfbd858971f0b65d7c89134224889a7cab3ee10fd4c24ce69d765437b69bcbf1f117018f376caf2c90089ecefefa1bcce39cad28fa9b7c4a7c2b5c02a80e7

data/README.md

@@ -18,7 +18,33 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Configuration
+
+    Cardinity.configure!(options)
+    
+Where options should contain:
+ - key
+ - secret
+ - api_base (optional, if you want to point the requests somewhere else than Cardinity servers)
+
+### Creating Payments
+
+    Cardinity.create_payment(payment_data)
+
+Where `payment_data` is a plain `Hash`. See rdoc or [Cardinity API doc](https://developers.cardinity.com/api/v1/) to see
+what attributes are allowed and required.
+
+    Cardinity.finalize_payment(payment_id, authorization_data)
+
+Where `payment_id` is an id of previously created payment and `authorization_data` is
+a `Hash` with single key `authorize_data`.
+
+### Other stuff
+
+    Cardinity.payments
+
+Returns the last 10 payments made.
+
 
 ## Development
 

data/cardinity.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.11"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency 'rest-client', '~> 2.0'
 end

data/lib/cardinity.rb

@@ -1,5 +1,75 @@
-require "cardinity/version"
+require 'cardinity/version'
+require 'cardinity/utils'
+require 'cardinity/auth'
+require 'rest-client'
+require 'json'
 
 module Cardinity
-  # Your code goes here...
+
+  DEFAULT_API_BASE = 'https://api.cardinity.com/v1/'
+
+  API_PAYMENTS = 'payments'
+
+  STATUS_PENDING = 'pending'
+  STATUS_APPROVED = 'approved'
+  STATUS_DECLINED = 'declined'
+
+  TYPE_AUTHORIZATION = 'authorization'
+  TYPE_PURCHASE = 'purchase'
+  TYPE_ERROR = 'https://developers.cardinity.com/api/v1/'
+
+  def self.configure!(options)
+    @config = {
+        # key and secret to be supplied from outsite
+        api_base: DEFAULT_API_BASE
+    }
+    @config.merge! options
+    @auth = Cardinity::Auth.new(@config)
+  end
+
+  # 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
+  def self.create_payment(payment_hash)
+    checked_payment_data = check_payment_data(payment_hash)
+    parse post(payments_uri, serialize(checked_payment_data))
+  end
+
+  # Finalizes a Payment
+  #
+  # 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
+  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)
+  end
+
 end

data/lib/cardinity/auth.rb

@@ -0,0 +1,69 @@
+require 'base64'
+require 'openssl/digest'
+require 'uri'
+require 'cgi'
+
+class Cardinity::Auth
+
+  OAUTH_VERSION = '1.0'
+  RESERVED_CHARACTERS = /[^a-zA-Z0-9\-._~]/
+  SIGNATURE_METHOD = 'HMAC-SHA1'
+
+  def initialize(config)
+    @config = config
+  end
+
+  def sign_request(method, uri)
+    params = {
+        oauth_consumer_key: @config[:key],
+        oauth_nonce: generate_key,
+        oauth_signature_method: SIGNATURE_METHOD,
+        oauth_timestamp: generate_timestamp,
+        oauth_version: OAUTH_VERSION
+    }
+    params[:oauth_signature] = request_signature(method, uri, params)
+    params_str = params.collect { |k, v| "#{k}=\"#{escape(v)}\"" }.join(', ')
+    "OAuth #{params_str}"
+  end
+
+  def request_signature(method, uri, params)
+    base_str = generate_base_string(method, uri, params)
+    encoded_digest(base_str)
+  end
+
+  def encoded_digest(string)
+    Base64.strict_encode64(digest(string))
+  end
+
+  def digest(string)
+    key = escape(@config[:secret]) + '&'
+    OpenSSL::HMAC.digest(
+        OpenSSL::Digest.new('sha1'),
+        key,
+        string)
+  end
+
+  def escape(string)
+    URI.escape(string, RESERVED_CHARACTERS)
+  end
+
+  def generate_base_string(method, url, params)
+    base = [method.to_s.upcase, url, normalized_params(params)]
+    base.map { |v| escape(v) }.join('&')
+  end
+
+  private
+
+    def generate_key(size=32)
+      Base64.strict_encode64(OpenSSL::Random.random_bytes(size)).gsub(/\W/, '')
+    end
+
+    def generate_timestamp
+      Time.now.to_i.to_s
+    end
+
+    def normalized_params(params)
+      params.collect { |k, v| "#{k}=#{v}" }.sort.join("&")
+    end
+
+end

data/lib/cardinity/utils.rb

@@ -0,0 +1,69 @@
+module Cardinity
+
+  CODES_WITH_RESPONSE = [200, 201, 202, 400, 402]
+
+  def self.check_payment_data(payment)
+    payment = payment.dup
+    if payment[:payment_method].nil?
+      payment[:payment_method] = 'card'
+    end
+    if payment[:amount].is_a?(Numeric)
+      payment[:amount] = '%.2f' % payment[:amount]
+    end
+    payment
+  end
+
+  def self.payments_uri
+    "#{api_base}#{API_PAYMENTS}"
+  end
+
+  def self.payment_uri(payment_id)
+    "#{api_base}#{API_PAYMENTS}/#{payment_id}"
+  end
+
+  def self.parse(response)
+    JSON.parse response.body
+  end
+
+  def self.serialize(data)
+    JSON.generate(data)
+  end
+
+  def self.handle_error_response(e)
+    if CODES_WITH_RESPONSE.index e.response.code
+      e.response
+    else
+      raise e
+    end
+  end
+
+  def self.get(uri)
+    RestClient.get uri, headers(:get, uri)
+  rescue RestClient::ExceptionWithResponse => e
+    handle_error_response e
+  end
+
+  def self.post(uri, body)
+    RestClient.post uri, body, headers(:post, uri)
+  rescue RestClient::ExceptionWithResponse => e
+    handle_error_response e
+  end
+
+  def self.patch(uri, body)
+    RestClient.patch uri, body, headers(:patch, uri)
+  rescue RestClient::ExceptionWithResponse => e
+    handle_error_response e
+  end
+
+  def self.headers(method, uri)
+    {
+        content_type: 'application/json',
+        authorization: @auth.sign_request(method, uri)
+    }
+  end
+
+  def self.api_base
+    @config[:api_base]
+  end
+
+end

data/lib/cardinity/version.rb

@@ -1,3 +1,3 @@
 module Cardinity
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cardinity
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Jan Sterba
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-10 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: 
 email:
 - info@jansterba.com
@@ -70,6 +84,8 @@ files:
 - bin/setup
 - cardinity.gemspec
 - lib/cardinity.rb
+- lib/cardinity/auth.rb
+- lib/cardinity/utils.rb
 - lib/cardinity/version.rb
 homepage: https://github.com/honzasterba/cardinity
 licenses: