nexio 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f2411545550be2a2cf60a4ab7f8eb701a230e69a47b2351e00be776d27c6c56
-  data.tar.gz: bceb8db2b0a04f7fe44b9d215ba844762eb69c4bae73e8e33c1584971cfc1a03
+  metadata.gz: 3ab9be3e918229d1d712c9ba5899fe049bfc044d39988dc782e97dc606bd7f83
+  data.tar.gz: '099f6f223415c4b43b51078278e3078fe03d120fbcca827c2bffdfe9db815fe6'
 SHA512:
-  metadata.gz: 346f80c80b6e89bac3aefb1b480334f652f1405321b8de018fb356a881e04cb945b3745aefdb9636f78e5bc7668ddc3f25256175e09c70b6454b7ddb52cb748b
-  data.tar.gz: 4b1a95b0f7d72dba3a20cced1f0770949df3681a4e00c37f251824db2cf7232a952376df30ad718bb7769e07d021408464e292224ad54a44218f00724096504a
+  metadata.gz: 48eec7f321486b66348bfc18578db90f7501485566dca0e3d77be32a1460a80e59ad8019bb2c31a663acf5094bf4dbddf605a9d02fbefafe07cb4075ff39d415
+  data.tar.gz: c003d29fe611abb05bbfe014d644067f10224f62c8219385763074001f4f08059939544d7c9050238e2658d44b1b454859c1d419949cbd56fb64cf0a245099ed

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## [Unreleased]
 
+## [0.2.0] - 2024-06-03
+
+- Lots of updates :]
+
 ## [0.1.0] - 2024-02-27
 
 - Initial release

data/README.md

@@ -1,20 +1,14 @@
 # Nexio
 
-TODO: Delete this and the text below, and describe your gem
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/nexio`. To experiment with that code, run `bin/console` for an interactive prompt.
-
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ bundle add nexio
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install nexio
 
 ## Usage
 
@@ -47,13 +41,32 @@ Setting `config.environment` to `development` will use sandbox, otherwise it wil
 }})["token"]
 ```
 
+**Saving a credit card**
+```
+@card = Nexio::PaymentGateway.save_card(
+    {
+      "card" => {
+        "cardHolderName" => "Abdul Barek",
+        "expirationMonth" => "10",
+        "expirationYear" => "#{Date.today.year + 10}",
+        "encryptedNumber" => "JQ2DIwFqQOCypsOE+3n0Mx6W6das1LrFAQVFR1lBD9KySCbVQXvJoweQ7R3wCv34oK6d8QlYQgsAWpmcROiwe4LowQI3pLfADmGRg4arowdaW8UBcR3gm26tT7KUdG13Y+0aiTKSleSJiRUSm3yU/VrNMe1tblYG+SsmtC8c3PEZkQxkJ216RYCzBkFRku2O7TRvx/GtxGd4VQItIF567VanRmZ8tIUaZGg9ZN6PKzUifRfCCt+2XGY7I1+Z7EOEAX1gQZT86+2vzcdk8MiZtMS4KYs+4kngSxR2EhyJa+3wRQBmkApRt03qCoWJEPIbNYxgwdjapy2oWeI/DrZu6A=="
+      },
+      "data" => {
+        "currency" => "USD"
+      },
+      "shouldUpdateCard" => true,
+      "token" => <ONE_TIME_TOKEN>
+    }
+  )
+```
+
 **Update a card**
 ```
  data = {
     "shouldUpdateCard" => true,
     "card" => {
       "expirationYear" => 2036,
-      "cardHolderName" => Abdul Barek,
+      "cardHolderName" => "Abdul Barek",
       "expirationMonth" => 3
     },
     "data" => {
@@ -80,40 +93,96 @@ Nexio::PaymentGateway.delete_card([card_token1, card_token2])
 Nexio::PaymentGateway.card_token(card_token)
 ```
 
-**Saving a credit card**
+**Charging a card through it's token**
+
+It is highly recommended to pass order number and customer reference on charging a credit card. Also it is 
+mandatory to pass paymentType. For one time payment pass one of the following based on your scenario:
+1. merchant initiated using new card: `initialMoto`
+2. client initiated using new card: `initialUnscheduled`
+3. merchant initiated using saved card: `unscheduledMit`
+4. client initiated using saved card: `unscheduledCit`
+
+Please check this for more information https://docs.nexiopay.com/docs/constant-transaction-values#payment-type-paymenttype
+
 ```
-@card = Nexio::PaymentGateway.save_card(
-    {
-      "card" => {
-        "cardHolderName" => "Abdul Barek",
-        "expirationMonth" => "10",
-        "expirationYear" => "#{Date.today.year + 10}",
-        "encryptedNumber" => "JQ2DIwFqQOCypsOE+3n0Mx6W6das1LrFAQVFR1lBD9KySCbVQXvJoweQ7R3wCv34oK6d8QlYQgsAWpmcROiwe4LowQI3pLfADmGRg4arowdaW8UBcR3gm26tT7KUdG13Y+0aiTKSleSJiRUSm3yU/VrNMe1tblYG+SsmtC8c3PEZkQxkJ216RYCzBkFRku2O7TRvx/GtxGd4VQItIF567VanRmZ8tIUaZGg9ZN6PKzUifRfCCt+2XGY7I1+Z7EOEAX1gQZT86+2vzcdk8MiZtMS4KYs+4kngSxR2EhyJa+3wRQBmkApRt03qCoWJEPIbNYxgwdjapy2oWeI/DrZu6A=="
-      },
-      "data" => {
-        "currency" => "USD"
-      },
-      "shouldUpdateCard" => true,
-      "token" => <ONE_TIME_TOKEN>
-    }
-  )
+customer = {
+  "orderNumber" => 4848,
+  "customerRef" => 123
+}
+processingOptions = {
+  "paymentType" => 'initialMoto'
+}
+amount_in_usd = 20.25
+Nexio::PaymentGateway.charge(amount_in_usd,card_token, customer, processingOptions)
 ```
 
-**Charging a card through it's token**
+**How to refund**
 ```
-amount_in_usd = 20.25
-Nexio::PaymentGateway.charge(amount_in_usd,card_token)
+@refund = Nexio::PaymentGateway.refund(@nexio_payment_id,1.20)
+```
+You can use card `5105105105105100` to charge and refund for testing purpose as it settles payment immediately.
+
+**Get Payment Status**
+Before refunding, it is needed to know the payment status Settled. Please visit 
+https://docs.nexiopay.com/docs/constant-transaction-values#transaction-status-transactionstatus
+to know the different payment status
+```
+@payment_status = Nexio::PaymentGateway.payment_status(@nexio_payment_id)
+```
+
+**How to void a payment**
+```
+@payment_status = Nexio::PaymentGateway.void_payment(@nexio_payment_id)
 ```
 
 **Handling error**
 ```
 begin
-  Nexio::PaymentGateway.charge(10.60,'invalid_card_token')
+  Nexio::PaymentGateway.charge(10.60,'invalid_card_token',customer,processingOptions)
 rescue Nexio::NexioError => e
   puts e.to_hash
 end
 ```
 
+**Getting http request details including body parameters and header information**
+```
+begin
+  Nexio::PaymentGateway.charge(10.60,'invalid_card_token',customer,processingOptions)
+rescue Nexio::NexioError => e
+  puts e.request_details_in_hash
+end
+```
+
+**How to use custom css**
+
+This is very easy to style payment form by passing css file in `uiOptions` as below:
+```
+@nexio_one_time_token = Nexio::PaymentGateway.create_one_time_token(
+      {
+        "card" => {},
+        "uiOptions" => {
+          "css" => ActionController::Base.helpers.asset_path('your_custom.css', host: Rails.application.secrets.asset_host ? Rails.application.secrets.asset_host : request.base_url)
+        },
+      "data" => {
+      "currency" => "USD",
+      "customer" => {}
+    }})["token"]
+```
+Sample CSS: Nexio payment form has a wrapper with `#paymentForm` element, so you can apply more
+css considering it as parent. Just inspect the Nexio payment form to get their DOM structure in order
+to apply styles. SCSS Example:
+```
+#paymentForm{
+  width: 500px;
+  margin-left: 180px;
+  #cardHolderName{}
+  #securityCode{}
+}
+```
+
+## Testing
+`bundle exec rake test`
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/nexio/configuration.rb

@@ -16,7 +16,9 @@ module Nexio
     end
 
     def api_key!
-      api_key || raise(NexioError, "No api key specified.")
+      raise MissingApiKey if api_key.nil? || api_key.empty?
+
+      api_key
     end
 
     def api_server_url

data/lib/nexio/payment_gateway.rb

@@ -117,23 +117,29 @@ module Nexio
     end
 
     # Makes a charge of a given card using the associated card token
-    def self.charge(amount=0, card_token)
+    def self.charge(amount=0, card_token, customer, processingOptions)
+      processingOptions = {} if !defined?(processingOptions) || processingOptions.nil? || processingOptions.empty?
       url = URI("#{Nexio.configuration.api_server_url}/pay/v3/process")
       @request = Net::HTTP::Post.new(url)
       http, request = configure_https_request(url, @request)
       request.body = {
         "data" => {
-          "currency" => "USD", "amount" => amount
+          "currency" => "USD", "amount" => amount,
+          "customer" => {
+            "customerRef" => customer["customerRef"],
+            "orderNumber" => customer["orderNumber"],
+          },
         },
         "tokenex" => {"token" => card_token},
         "processingOptions" =>
           {
+            "paymentType" => processingOptions["paymentType"],
             "retryOnSoftDecline" => false,
             "checkFraud" => true,
             "shouldUseFingerprint" => true,
             "check3ds" => false,
             "verboseResponse" => false
-          },
+          }.merge(processingOptions),
         "shouldUpdateCard" => true,
         "isAuthOnly" => false,
         "paymentMethod" => "card"
@@ -142,6 +148,40 @@ module Nexio
       response_or_raise_error(response)
     end
 
+    # Amount is in USD
+    def self.refund(nexio_payment_id, amount)
+      url = URI("#{Nexio.configuration.api_server_url}/pay/v3/refund")
+      @request = Net::HTTP::Post.new(url)
+      http, request = configure_https_request(url, @request)
+      request.body = {
+        "id" => nexio_payment_id,
+        "data" => {
+          "currency" => "USD", "amount" => amount
+        },
+      }.to_json
+      response = http.request(request)
+      response_or_raise_error(response)
+    end
+
+    def self.payment_status(nexio_payment_id)
+      url = URI("#{Nexio.configuration.api_server_url}/transaction/v3/paymentId/#{nexio_payment_id}")
+      @request = Net::HTTP::Get.new(url)
+      http, request = configure_https_request(url, @request)
+      response = http.request(request)
+      response_or_raise_error(response)
+    end
+
+    def self.void_payment(nexio_payment_id)
+      url = URI("#{Nexio.configuration.api_server_url}/pay/v3/void")
+      @request = Net::HTTP::Post.new(url)
+      http, request = configure_https_request(url, @request)
+      request.body = {
+        "id" => nexio_payment_id
+      }.to_json
+      response = http.request(request)
+      response_or_raise_error(response)
+    end
+
     # https configuration using base64 basic auth code
     def self.configure_https_request(url, request)
       http = Net::HTTP.new(url.host, url.port)

data/lib/nexio/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Nexio
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/nexio.rb

@@ -23,6 +23,13 @@ module Nexio
     end
   end
 
+  class MissingApiKey < StandardError
+    def initialize(msg = "No api key configured", exception_type = "missing_api_key")
+      @exception_type = exception_type
+      super(msg)
+    end
+  end
+
   def self.configuration
     @configuration ||= Configuration.new
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nexio
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - TherapyMate
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-21 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -55,7 +55,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.3.26
 signing_key: 
 specification_version: 4
 summary: Nexio integration with Ruby on Rails