shieldpay 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6fe82161ac48419d43efafb27812d300e4878108abcb32d6fdf9ba086a3c1227
-  data.tar.gz: '08f25acb87847ae5fba863d74d7314af39f89c2905490048923b5007e9ce749f'
+  metadata.gz: f185dcd40cc56cdd032995190d58019c1e09d6b609a18a26dbe2840e8e3da328
+  data.tar.gz: 00e5e9aaea53dee2e7c868722720d10d3f6a482dbabaea9dc2ac74463729bbd8
 SHA512:
-  metadata.gz: 80aaa070ea5e71266e95d6a03e8dc12f27bf8a0f8f7a90ba5ba741a1232703014196c5cd72cde0e0d361ddc655261757c4806244e53fa367262d3cdd1ab5a3a2
-  data.tar.gz: 4ec5b19267b505b7ca16235368868f303b0550020734039f8bb313a0684ae2c9e7c834a96b61f01a232e8e7e940d2b12af69783b39653e35858c36976a92a5a2
+  metadata.gz: 67b9c0121cd55d315294825f9a6a69cc8d25540dd9914eeced9c570d8e6ab49448c08e611acff6dff58468e7f928184b1284a9c9c3478a03097868299b5e9aa8
+  data.tar.gz: 643e35bba559bd275b8e6b1f285ad64096de89010f08c394adf36871ace6b379ddb7faff867affb293e6473bd3e3d5516657f8efbdd1a305b7aacb266c469ca3

data/README.md

@@ -31,7 +31,7 @@ org_key|This is the organization key you need to use the ShieldPay api|No
 country_code|2 character country code that is the default for your payments|Yes
 debug|Turn debug mode on to see extra messages in your api calls|Yes
 default_currency|If you don't set a currency code in your api calls then this is used|Yes
-endpoint_url|The endpoint url used for the api. You can change this if you want to use the test version of the API. Defaults to https://api.shieldpay.com|Yes
+uat|Whether you want to access the uat version of the shieldpay api. Defaults to false|Yes
 
 #### Sample configuration
 ```Ruby
@@ -121,6 +121,7 @@ Here's a list of the events you can add webhooks for:
   receiver_decline_before_accept
   sender_cancelled_before_funded
   payment_generated
+  payment_completed
   funding_pending  
   sender_cancelled_after_funded
   refund_in_progress

data/lib/shieldpay.rb

@@ -8,6 +8,7 @@ require "shieldpay/bank_detail"
 require "shieldpay/company"
 require "shieldpay/customer"
 require "shieldpay/payment_request"
+require "shieldpay/transaction"
 require "shieldpay/webhook"
 
 module ShieldPay

data/lib/shieldpay/configuration.rb

@@ -3,15 +3,31 @@ module ShieldPay
     attr_accessor :country_code
     attr_accessor :debug
     attr_accessor :default_currency
-    attr_accessor :endpoint_url
     attr_accessor :org_key
+    attr_accessor :uat
 
     def initialize
       @org_key = nil
       @country_code = nil
       @debug = nil
       @default_currency = nil
-      @endpoint_url = "https://apiuat.shieldpay.com"
+      @uat = false
+    end
+
+    def api_endpoint_url
+      if @uat
+        "https://apiuat.shieldpay.com"
+      else
+        "https://api.shieldpay.com"
+      end
+    end
+
+    def endpoint_url
+      if @uat
+        "https://uat.shieldpay.com"
+      else
+        "https://www.shieldpay.com"
+      end
     end
   end
 end

data/lib/shieldpay/customer.rb

@@ -2,7 +2,8 @@ module ShieldPay
   class Customer
     extend Helpers
 
-    attr_accessor :customer_key, :kyc_verified
+    attr_accessor :customer_key, :kyc_verified, :display_name, :email,
+                  :mobile_no
 
     # Contact Params
     # Parameter      Optional?  Description
@@ -18,6 +19,9 @@ module ShieldPay
       new.tap do |c|
         c.customer_key = customer_key
         c.kyc_verified = kyc_verified
+        c.display_name = params["display_name"]
+        c.email = params["email"]
+        c.mobile_no = params["mobile_no"]
       end
     end
 
@@ -34,7 +38,7 @@ module ShieldPay
     # street
     # state
     # town
-    # post_code
+    # postcode
     # country
     # customer_key
     def self.kyc_verify(params={})
@@ -42,8 +46,8 @@ module ShieldPay
       if params["customer_key"].strip.empty?
         raise ShieldPay::Errors::RequiredField.new("customer_key field is required to verify this customer. You can create a customer_key field using the Customer.create method")
       end
-      params["postcode"] = params.delete("post_code")
-      params["gender"] = params.delete("gender").upcase
+      params["gender"] = params.delete("gender").to_s.upcase
+      params["date_of_birth"] = Date.parse(params["date_of_birth"].to_s).to_s
       response = Request.new.post("/Customer/KYCVerification", params)
       kyc_verified = response["Data"].dig("AddressVerified")
       new.tap do |c|

data/lib/shieldpay/errors.rb

@@ -1,6 +1,8 @@
 module ShieldPay
   module Errors
 
+    class OtherShieldPayError < StandardError; end
+
     # standard errors
     class InvalidOrganizationKey     < StandardError; end
     class OrganizationKeyDoesntExist < StandardError; end
@@ -14,20 +16,22 @@ module ShieldPay
     class AddressNotVerified  < StandardError; end
     class CustomerEmailExists < StandardError; end
     class CustomerDoesntExist < StandardError; end
+    class CustomerMobileExists < StandardError; end
 
     ERROR_MATCHING = {
       "Invalid Organization key." => InvalidOrganizationKey,
       "OrganizationKey is not valid." => InvalidOrganizationKey,
       "OrganizationKey is not exists." => OrganizationKeyDoesntExist,
 
-      "Company identifier already exist. " \
-      "Please contact your system administrator" => CompanyAlreadyExists,
+      "Company identifier already exists." => CompanyAlreadyExists,
       "Company identifier could not be validated" => InvalidCompanyIdentifier,
 
       "Email already exists." => CustomerEmailExists,
       "Customer does not exist" => CustomerDoesntExist,
       "Address not verified." => AddressNotVerified,
       "Address not varified, Exception in Request" => AddressNotVerified,
+
+      "This mobile number is already registered." => CustomerMobileExists
     }
 
     def check_for_error(response_body)
@@ -42,7 +46,7 @@ module ShieldPay
     end
 
     def raise_error(user_message)
-      error_klass = ERROR_MATCHING[user_message] || StandardError
+      error_klass = ERROR_MATCHING[user_message] || OtherShieldPayError
 
       raise error_klass.new(user_message)
     end

data/lib/shieldpay/payment_request.rb

@@ -6,9 +6,11 @@ module ShieldPay
 
     def self.create_with_email(params={})
       stringify_keys!(params)
-      params["batch_reference"] = 0
+      params["batch_reference"] = "0"
       params["currency_code"] ||= ShieldPay.configuration.default_currency
       params["target_currency_code"] ||= ShieldPay.configuration.default_currency
+      params["amount"] = params["amount"].to_s # must be a string for some reason
+      params["fee_receiver_amount"] = params["fee_receiver_amount"].to_s # must be a string for some reason
 
       response = Request.new.post("/Transaction/PaymentRequestByEmailId",
                                   params)

data/lib/shieldpay/request.rb

@@ -11,7 +11,7 @@ module ShieldPay
     UPPERCASE_KEYS = ["iban"]
 
     def post(path, params)
-      url = ShieldPay.configuration.endpoint_url + path
+      url = ShieldPay.configuration.api_endpoint_url + path
       params = add_auth_key(params)
       attrs = {
         body: processed_params(params),
@@ -67,12 +67,7 @@ module ShieldPay
     end
 
     def processed_params(params)
-      params = processed_keys(params)
-      # set the values to strings
-      params.inject({}) do |result, (key, value)|
-        result[key] = value.to_s
-        result
-      end.to_json
+      processed_keys(params).to_json
     end
 
     def underscore_to_camel_case(string)

data/lib/shieldpay/transaction.rb

@@ -0,0 +1,33 @@
+module ShieldPay
+  class Transaction
+    extend Helpers
+
+    attr_accessor :status_id
+
+
+    # Webhook Params
+    # Parameter           Optional?  Description
+    # customer_id         no 	       The customer id of either the sender or the
+    #                                receiver of this transaction
+    # transaction_id      no         The transaction id to look up
+    def self.get_status(input_params={})
+      stringify_keys!(input_params)
+      response = Request.new.post("/Transaction/GetPaymentStatus", input_params)
+      response.dig("Data", "StatusId")
+    end
+
+    # Webhook Params
+    # Parameter           Optional?  Description
+    # customer_id         no 	       The customer id of either the sender or the
+    #                                receiver of this transaction
+    # transaction_id      no         The transaction id to change status
+    # status_id           no         The status to change to
+    def self.change_status(input_params)
+      stringify_keys!(input_params)
+      input_params["transaction_status_id"] = input_params.delete("status_id")
+      response = Request.new.post("/Transaction/ChangePaymentStatus",
+                                  input_params)
+      response.dig("coreRes", "status") == 1
+    end
+  end
+end

data/lib/shieldpay/version.rb

@@ -1,3 +1,3 @@
 module ShieldPay
-  VERSION = "0.2.0"
+  VERSION = "1.0.0"
 end

data/lib/shieldpay/webhook.rb

@@ -5,24 +5,26 @@ module ShieldPay
     attr_accessor :events, :id, :url
 
     EVENT_CODES = {
-      initiated: "1", add_fund: "2", accepted: "3", sender_complete: "4",
-      receiver_complete: "5", funds_available: "6",
-      receiver_decline_before_accept: "7", sender_cancelled_before_funded: "8",
-      payment_generated: "9", funding_pending: "10",
-      sender_cancelled_after_funded: "11", refund_in_progress: "12",
-      customer_status: "13"
+      initiated: '1', add_fund: '2', accepted: '3', sender_complete: '4',
+      receiver_complete: '5', funds_available: '6',
+      receiver_decline_before_accept: '7', sender_cancelled_before_funded: '8',
+      payment_generated: '9', payment_completed: '10', funding_pending: '11',
+      sender_cancelled_after_funded: '12', refund_in_progress: '13',
+      customer_status: '14'
     }
 
     # Webhook Params
     # Parameter           Optional?  Description
     # url                  no 	     The url that shieldpay will call for webhooks
     # events               no        The events that this webhook will monitor
+    #                                (defaults to all events)
     #                                Options are:
     #                                :initated, :add_fund, :accepted, :sender_complete,
     #                                :receiver_complete, :funds_available,
     #                                :receiver_decline_before_accept,
     #                                :sender_cancelled_before_funded,
-    #                                :payment_generated, :funding_pending,
+    #                                :payment_generated, :payment_completed,
+    #                                :funding_pending,
     #                                :sender_cancelled_after_funded,
     #                                :refund_in_progress, :customer_status
     def self.add(input_params={})
@@ -31,20 +33,25 @@ module ShieldPay
       if url.nil? || url.size == 0
         raise Errors::RequiredField.new("url is a required field")
       end
-      events = input_params["events"]
-      if events.nil? || events.size == 0
-        raise Errors::RequiredField.new("events is a required field")
-      end
       params = { "Url" => url }
-      params[:webhook_event_binding] = events.collect do |event|
-        event_code = EVENT_CODES[event.to_sym]
-        if event_code.nil?
-          raise Errors::RequiredField.new("#{event} is not a valid event")
+      events = input_params["events"]
+      event_codes =  if events.nil? || events.size == 0
+        EVENT_CODES.values
+      else
+        events.collect do |event|
+          event_code = EVENT_CODES[event.to_sym]
+          if event_code.nil?
+            raise Errors::RequiredField.new("#{event} is not a valid event")
+          end
+          event_code
         end
-        {
-          "EventId" => event_code
-        }
       end
+
+
+      params[:webhook_event_binding] = event_codes.collect do |event_code|
+        { "EventId" => event_code }
+      end
+
       response = Request.new.post("/Webhook/Add", params)
       response.dig("coreRes", "userMessage") == "Request successful"
     end
@@ -68,6 +75,10 @@ module ShieldPay
       response["Data"] == "Success"
     end
 
+    def self.event_name_from_id(event_id)
+      EVENT_CODES.key(event_id.to_s)
+    end
+
     def initialize(id, url, events)
       @id = id
       @url = url

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shieldpay
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chris O'Sullivan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2018-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -119,6 +119,7 @@ files:
 - lib/shieldpay/helpers.rb
 - lib/shieldpay/payment_request.rb
 - lib/shieldpay/request.rb
+- lib/shieldpay/transaction.rb
 - lib/shieldpay/version.rb
 - lib/shieldpay/webhook.rb
 - shieldpay.gemspec