windcave_rest 0.1.0

data/lib/windcave_rest/models/card.rb

@@ -0,0 +1,27 @@
+module WindcaveRest
+  class Card < WindcaveRest::Base
+    # Windcave generated id for the card object instance
+    api_attribute :id
+
+    # (required) card holder name as displayed on card
+    api_attribute :card_holder_name
+
+    # (required) 13 - 19 digit card number obfuscated
+    api_attribute :card_number
+
+    # (required) (MM) month of expiry as displayed on the card
+    api_attribute :date_expiry_month
+
+    # (required) (YY) year of expiry as displayed on the card
+    api_attribute :date_expiry_year
+
+    # (required) card brand, eg: visa
+    api_attribute :type
+
+    # if enabled Windcave generated luhn-able 16 digit card number alternative card id
+    api_attribute :card_number2
+
+    # cvc2 (cvv) security value printed on rear of card. required only for first use of card.
+    api_attribute :cvc2
+  end
+end

data/lib/windcave_rest/models/create_session_request.rb

@@ -0,0 +1,75 @@
+module WindcaveRest
+  class CreateSessionRequest < WindcaveRest::Base
+    # The checkout type (purchase, auth, validate) [STRING]
+    # ammount and currency are required for purchase and auth type
+    api_attribute :type
+
+    # The client type (internet, moto) [STRING]
+    api_attribute :client_type
+
+    api_attribute :amount
+
+    # (optional) amount of pre-calculated merchant specified surcharge value
+    api_attribute :amount_surcharge
+
+    # ISO 4217 3 letter code
+    api_attribute :currency
+
+    # Cart / Order reference Number
+    api_attribute :merchant_reference
+
+    # US, (string, optional) - sets the default language of the hpp. Ensure language is supported first. If not specified english is used. format is a variant of bcp47 https://tools.ietf.org/html/bcp47, specifically ISO 639-1 optionally followed by ISO 3166-1 alpha-2 separated by a '-'.
+    api_attribute :language
+
+    # this is empty or one or more array string values representing the method used
+    # card => 0, account2account => 1, alipay => 2, applepay => 3, paypal => 4,
+    # interac => 5, unionpay => 6, oxipay => 7, visacheckout => 8, wechat => 9
+    api_attribute :methods, :'Array<String>'
+    
+    # (optional) RFC-3339 Date indicates when session should expire
+    api_attribute :expires, :'Date'
+
+    # [Object] CallbackUrls
+    api_attribute :callback_urls, :'CallbackUrls'
+
+    # (optional) url for specifying alternative notification of session completion
+    api_attribute :notification_url
+
+    #######################
+    # Windcave generated id of a previously created card object
+    api_attribute :card_id
+    ####### OR ############
+    # luhn-able 16 digit card number substitute card id
+    api_attribute :card_number2
+    # store a card collected during session
+    api_attribute :store_card, :'BOOLEAN'
+    #######################
+
+    # card storage reason. 
+    # Any one of: single, recurring, installment, recurringnoexpiry, recurringinitial, installmentinitial,
+    # credentialonfileinitial, unscheduledcredentialonfileinitial, credentialonfile, unscheduledcredentialonfile,
+    # incremental, resubmission, reauthorisation, delayedcharges, noshow
+    api_attribute :stored_card_indicator
+
+    # value is used to indicate the total number of payments for an installment transaction.
+    api_attribute :installment_count, :'Integer'
+
+    # 1-based value that is used to indicate the current payment number for an installment transaction. For example, if the consumer is making payment 1 of 12, then this value should be set to 1
+    api_attribute :installment_number, :'Integer'
+
+    # set it to 1 to indicate that this is a debt repayment transaction.
+    api_attribute :debt_repayment_indicator, :'Integer'
+
+    # [Object] Customer
+    api_attribute :customer, :'Customer'
+
+    # Windcave id reference for existing customer object
+    api_attribute :customer_id
+
+    # (optional) array of string values free text relevant to your payment
+    api_attribute :meta_data, :'Array<String>'
+
+    # [Object] Browser 
+    api_attribute :browser, :'Browser'
+  end
+end

data/lib/windcave_rest/models/create_transaction_request.rb

@@ -0,0 +1,80 @@
+module WindcaveRest
+  class CreateTransactionRequest < WindcaveRest::Base
+    # transaction type, one of: (purchase, auth, refund, complete, validate, void) [STRING]
+    api_attribute :type
+
+    # base amount of the payment (not including specified surcharges) format appropriately for currency
+    api_attribute :amount
+
+    # ISO 4217 3 letter code
+    api_attribute :currency
+
+    # any one of: internet, moto, unattended
+    api_attribute :client_type
+
+    # free text field as a main reference for the transaction (max: 64) (typically invoice number or order number)
+    api_attribute :merchant_reference
+
+    # [Object] Card
+    api_attribute :card, :'Card'
+
+    #########################
+
+    # Windcave generated id of a previously created card object
+    api_attribute :card_id
+
+    ######### OR ###########
+  
+    # luhn-able 16 digit card number substitute card id
+    api_attribute :card_number2
+
+    ######### OR ###########
+
+    # TODO: Not implementing now
+    # api_attribute :applepay
+
+    ######### OR ###########
+
+    # Windcave generated id of previously processed transaction
+    api_attribute :transaction_id
+    # [Object] Customer
+    api_attribute :customer
+
+    ######### OR ###########
+
+    # Windcave generated id of the customer
+    api_attribute :customer_id
+
+    #########################
+
+    # [Object] Browser
+    api_attribute :browser, :'Browser'
+
+    # [Object] Avs
+    api_attribute :avs, :'Avs'
+
+    # [Array<Object>]
+    api_attribute :meta_data, :'Array<String>'
+
+    # amount of pre-calculated merchant specified surcharge value
+    api_attribute :amount_surcharge
+
+    # store the card object given
+    api_attribute :store_card, :'BOOLEAN'
+
+    # use case for storing or use of stored card. Any one of: single, recurring, .... https://px5.docs.apiary.io/#reference/0/transactions/create-transaction
+    api_attribute :stored_card_indicator
+
+    # value is used to indicate the total number of payments for an installment transaction.
+    api_attribute :installment_count, :'Integer'
+
+    # 1-based value that is used to indicate the current payment number for an installment transaction. For example, if the consumer is making payment 1 of 12, then this value should be set to 1
+    api_attribute :installment_number, :'Integer'
+
+    # set it to 1 to indicate that this is a debt repayment transaction.
+    api_attribute :debt_repayment_indicator, :'Integer'
+
+    # url for notification of transaction completion
+    api_attribute :notification_url
+  end
+end

data/lib/windcave_rest/models/customer.rb

@@ -0,0 +1,23 @@
+module WindcaveRest
+  class Customer < WindcaveRest::Base
+    # Windcave generated id of the customer
+    api_attribute :id
+
+    api_attribute :first_name
+
+    api_attribute :last_name
+
+    # (required)
+    api_attribute :email
+
+    api_attribute :phone_number
+
+    api_attribute :account
+
+    # [Object] Address
+    api_attribute :shipping, :'Address'
+
+    # [Object] Address
+    api_attribute :billing, :'Address'
+  end
+end

data/lib/windcave_rest/models/link.rb

@@ -0,0 +1,12 @@
+module WindcaveRest
+  class Link < WindcaveRest::Base
+    # URL relevant to the link
+    api_attribute :href
+
+    # what the link is for semantically, eg: hpp
+    api_attribute :rel
+
+    # how to use the link programmatically, eg: REDIRECT
+    api_attribute :method
+  end
+end

data/lib/windcave_rest/models/risk.rb

@@ -0,0 +1,15 @@
+module WindcaveRest
+  class Risk < WindcaveRest::Base
+    # what the risk engine has determined the required action to take was either: decline, warning, noaction
+    api_attribute :action
+
+    # actual score total from all risk assessment
+    api_attribute :score, :'Integer'
+
+    # possible score total from all risk assessment
+    api_attribute :possible, :'Integer'
+
+    # textual single field representation of risk assessment results (format subject to change)
+    api_attribute :summary_text
+  end
+end

data/lib/windcave_rest/models/session.rb

@@ -0,0 +1,22 @@
+module WindcaveRest
+  class Session < WindcaveRest::Base
+    api_attribute :id
+    api_attribute :state
+
+    # [Array Object] Link
+    api_attribute :links, :'Array<Link>'
+
+    # [Array Object] Transaction
+    api_attribute :transactions, :'Array<Transaction>'
+
+    api_attribute :customerId
+
+    def select_card_id(session_id, merchant_id, purchase_type)
+      transactions.detect do |x| 
+        x.session_id == session_id &&
+        x.merchant_reference == merchant_id &&
+        x.type == purchase_type
+      end&.card&.id
+    end
+  end
+end

data/lib/windcave_rest/models/transaction.rb

@@ -0,0 +1,110 @@
+module WindcaveRest
+  class Transaction < WindcaveRest::Base
+    # (required) Windcave generated id of the object instance / transaction_id
+    api_attribute :id
+
+    # the Windcave user which made the transaction
+    api_attribute :username
+
+    # the Windcave device id of the device which made the transaction (card present originated transaction)
+    api_attribute :device_id
+
+    # (required) true or false; true indicating the transaction was successfully authorised.
+    api_attribute :authorised, :'BOOLEAN'
+
+    # (required) true or false; true indicating that the declined result is caused by a temporal condition only and thus should be retried (change the X-ID !)
+    api_attribute :allow_retry, :'BOOLEAN'
+
+    # (required) Windcave response code. this can indicate both authorised and declined conditions. eg: 00
+    api_attribute :re_co
+
+    # (required) Windcave response text. human readable value matching the indicated reCo condition. eg: APPROVED
+    api_attribute :response_text
+
+    # (required) transaction type, eg: purchase
+    api_attribute :type
+
+    # (required) physical system method used processing. card
+    api_attribute :method
+
+    # (required) time zone abbreviation (ignoring day light savings)
+    api_attribute :local_time_zone
+
+    # (required) RFC-3339 in tz UTC
+    api_attribute :date_time_utc
+
+    # (required) RFC-3339 in tz as per localTimeZone
+    api_attribute :date_time_local
+
+    # (required) date of settlement (no time/tz associated)
+    api_attribute :settlement_date
+
+    # (required) base amount of the transaction (not including specified surcharges)
+    api_attribute :amount
+
+    # amount of residual account balance if determinable and applicable
+    api_attribute :balance_amount
+
+    # (required) ISO 4217 3 letter code of the currency of transaction
+    api_attribute :currency
+
+    # (required) ISO 3166 number of the currency of the transaction
+    api_attribute :currency_numeric, :'Integer'
+
+    # (required) Enum client type values are any, internet, moto, unattended, recurringmoto, recurringecom
+    api_attribute :client_type
+    
+    api_attribute :merchant_reference
+
+    # [Object] Card
+    api_attribute :card, :'Card'
+
+    # eg: standard, 3ds1verifiedbyvisa, 3ds1mastercardsecurecode, 3ds1amexsafekey, 3ds1other, 3ds2frictionless, 3ds2challenge
+    api_attribute :liability_indicator
+    
+    # eg: M, N, P, S, U
+    api_attribute :cvc2_result_code
+
+    # card storage reason as given in request
+    api_attribute :stored_card_indicator
+
+    # value is used to indicate the total number of payments for an installment transaction.
+    api_attribute :installment_count, :'Integer'
+
+    # 1-based value that is used to indicate the current payment number for an installment transaction. For example, if the consumer is making payment 1 of 12, then this value should be set to 1
+    api_attribute :installment_number, :'Integer'
+
+    # set it to 1 to indicate that this is a debt repayment transaction.
+    api_attribute :debt_repayment_indicator, :'Integer'
+
+    # url for notification of transaction completion
+    api_attribute :notification_url
+
+    # [Object] Customer
+    api_attribute :customer, :'Customer'
+
+    # [Object] Avs
+    api_attribute :avs, :'Avs'
+
+    # 32 character string representation of the sessionId
+    api_attribute :session_id
+
+    # [Object] Browser
+    api_attribute :browser, :'Browser'
+
+    # [Array<String>]
+    api_attribute :meta_data, :'Array<String>'
+
+    # amount of calculated surcharge value ( merchant or Windcave generated)
+    api_attribute :amount_surcharge
+
+    # (required)
+    api_attribute :is_surcharge, :'BOOLEAN'
+
+    # [Object] Risk
+    api_attribute :risk, :'Risk'
+
+    # [Array<Object>] Link
+    api_attribute :links, :'Array<Link>'
+  end
+end

data/lib/windcave_rest/version.rb

@@ -0,0 +1,3 @@
+module WindcaveRest
+  VERSION = "0.1.0"
+end

data/windcave_rest.gemspec

@@ -0,0 +1,26 @@
+require_relative 'lib/windcave_rest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "windcave_rest"
+  spec.version       = WindcaveRest::VERSION
+  spec.authors       = ["Anto Dominic"]
+  spec.email         = ["anto.dominic@reinteractive.com"]
+
+  spec.summary       = "Windcave / Payment Express new Rest API"
+  spec.description   = "Windcave REST API initial build"
+  spec.homepage      = "https://storeconnect.app/"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.add_runtime_dependency 'typhoeus'
+  spec.add_runtime_dependency 'json'
+
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: windcave_rest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anto Dominic
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Windcave REST API initial build
+email:
+- anto.dominic@reinteractive.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/windcave_rest.rb
+- lib/windcave_rest/api/base_api.rb
+- lib/windcave_rest/api/sessions_api.rb
+- lib/windcave_rest/api/transactions_api.rb
+- lib/windcave_rest/api_client.rb
+- lib/windcave_rest/api_error.rb
+- lib/windcave_rest/configuration.rb
+- lib/windcave_rest/models/address.rb
+- lib/windcave_rest/models/avs.rb
+- lib/windcave_rest/models/base.rb
+- lib/windcave_rest/models/browser.rb
+- lib/windcave_rest/models/callback_urls.rb
+- lib/windcave_rest/models/card.rb
+- lib/windcave_rest/models/create_session_request.rb
+- lib/windcave_rest/models/create_transaction_request.rb
+- lib/windcave_rest/models/customer.rb
+- lib/windcave_rest/models/link.rb
+- lib/windcave_rest/models/risk.rb
+- lib/windcave_rest/models/session.rb
+- lib/windcave_rest/models/transaction.rb
+- lib/windcave_rest/version.rb
+- windcave_rest.gemspec
+homepage: https://storeconnect.app/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Windcave / Payment Express new Rest API
+test_files: []