k2-connect-ruby 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 813e08db1df91bfd2bc8129661251a50547dd412be8e3adf73e30601c96cfd96
-  data.tar.gz: e0152936b0c41216020713f4a9adc0b36f272f03dff49c2b5a334f7aa0bcff78
+  metadata.gz: 6f16b31dad92f44afc4fecd11658daedb06dd25dc248dc91aac55108e231c567
+  data.tar.gz: f92ca5e74163589b853eaad34856cc9477b0ea0be2794a207070f4a6e02e5906
 SHA512:
-  metadata.gz: dd9f054d341616ae35e76f056e719576f5b90f323022564cb74d3a50de13e1f416dca358fe4029bbc393149e49f29802a84260a0f7e5cba72e2b3131a202754a
-  data.tar.gz: e4de423af14eb8af838f9bbe40ecc93b7fd770fc241ea492e104585d30eda2d451a7b8342df0f3b394a413fdf59b64b1e5034b51ea2b145b9cd0f8efcdf36287
+  metadata.gz: 2c3e9fb52c6d643c0aa19bc7295db3f03a6b2831b6bff0fd804f49505895242e86ee551c37f0da6b417a86728c0ae4f330d612e82f961d6f9ec55da44c972881
+  data.tar.gz: 2098c75cdc7f5f86a65dcfe0bdc42138bba2a87eb05e0c244bf5c0e7accd3d5977b0d6ae22840ad423b2b0157980998cbcf8aa2ba791f5f3f41ea86d64701204

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    k2-connect-ruby (0.0.2)
+    k2-connect-ruby (0.0.4)
       activemodel (~> 6.1.3.1)
       activesupport (~> 6.1.3.1)
       rest-client (~> 2.1.0)

data/README.md

@@ -1,5 +1,7 @@
 # K2ConnectRuby For Rails
 
+[![Gem](https://img.shields.io/gem/v/k2-connect-ruby?style=for-the-badge)](https://rubygems.org/gems/k2-connect-ruby)
+
 Ruby SDK for connection to the Kopo Kopo API.
 This documentation gives you the specifications for connecting your systems to the Kopo Kopo Application.
 Primarily, the library provides functionality to do the following:
@@ -16,20 +18,22 @@ All calls made without authentication will also fail.
 
 ## LINKS
 
- - [Installation](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#installation)
- - [Usage](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#installation)
-    - [Authorization](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#authorization)
-    - [Webhook Subscription](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#webhook-subscription)
-    - [STK Push](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#stk-push)
-    - [PAY](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#pay)
-    - [Transfers](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#transfers)
-    - [Parsing the JSON Payload](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#parsing-the-json-payload)
- - [Development](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#development)
- - [Author](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#author)
- - [Contributing](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#contributing)
- - [License](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#license)
- - [Changelog](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#changelog)
- - [Code of Conduct](https://github.com/DavidKar1uk1/k2-connect-ruby/tree/development#code-of-conduct)
+ - [Installation](#installation)
+ - [Usage](#installation)
+    - [Authorization](#authorization)
+    - [Webhook Subscription](#webhook-subscription)
+    - [SMS Notifications](#sms-notifications)
+    - [STK Push](#stk-push)
+    - [PAY](#pay)
+    - [Transfers](#transfers)
+    - [Polling](#polling)
+    - [Parsing the JSON Payload](#parsing-the-json-payload)
+ - [Development](#development)
+ - [Author](#author)
+ - [Contributing](#contributing)
+ - [License](#license)
+ - [Changelog](#changelog)
+ - [Code of Conduct](#code-of-conduct)
 
 ## Installation
 
@@ -90,9 +94,32 @@ your_request = {
 }
 k2subscriber.webhook_subscribe(your_request)
 ```
+
+### SMS Notifications
+
+To create an SMS notification request by calling on the send_sms_transaction_notification method.
+Ensure the following arguments are passed:
+- webhook_event_reference `REQUIRED`
+- message `REQUIRED`
+- callback_url `REQUIRED`
+
+Code example;
+
+```ruby
+require 'k2-connect-ruby'
+k2_token = K2AccessToken.new('your_client_id', 'your_client_secret').request_token
+k2_notification = K2Notification.new(k2_token)
+
+request_payload = {
+        webhook_event_reference: 'c271535c-687f-4a40-a589-8b66b894792e',
+        message: 'message',
+        callback_url: 'callback_url'
+}
+k2_notification.send_sms_transaction_notification(request_payload)
+```
+
  
- 
- ### STK-Push
+### STK-Push
  
  #### Receive Payments
  
@@ -290,7 +317,7 @@ The Following Details should be passed for either **Blind** or **Targeted** Tran
 - value `REQUIRED`
 - callback_url `REQUIRED`
 
-The Params are passed as the argument containing all the form data sent. A Successful Response is returned with the URL of the Transfer in the HTTP Location Header.
+The Params are passed as the argument containing all the form data sent. A Successful Response is returned with the URL of the transfer request in the HTTP Location Header.
 
 Sample code example:
 
@@ -312,6 +339,46 @@ To Query the most recent initiated Transfer Request:
 
 A HTTP Response will be returned in a JSON Payload, accessible with the k2_response_body variable.
 
+### Polling
+
+Tallows you to poll transactions received on the Kopo Kopo system within a certain time range, and either a company or a specific till.
+
+First Create the K2Notification Object
+
+    k2_notification = K2Notification.new(access_token)
+
+#### Send SMS Notification
+
+The Following Details should be passed for creating the notification:
+
+- fromTime `REQUIRED`
+- toTime `REQUIRED`
+- scope `REQUIRED`
+- scopeReference `REQUIRED`
+- callback_url `REQUIRED`
+
+The Params are passed as the argument containing all the form data sent. A Successful Response is returned with the URL of the request in the HTTP Location Header.
+
+Sample code example:
+
+```ruby
+k2_notification = K2Notification.new(your_access_token)
+# Blind or Targeted Transfer
+k2_notification.send_sms_transaction_notification(request_payload)
+```
+
+#### Query Request
+
+To Query the status of the prior initiated Notification Request pass the location_url response as shown:
+
+     k2_notification.query_resource_url(k2_notification.location_url)  
+
+To Query the most recent initiated Transfer Request:
+
+     k2_notification.query_resource  
+
+A HTTP Response will be returned in a JSON Payload, accessible with the k2_response_body variable.
+
 ### Parsing the JSON Payload
 
 The K2Client class will be use to parse the Payload received from Kopo Kopo, and to further consume the webhooks and split the responses into components, the K2Authenticator and

data/lib/k2-connect-ruby.rb

@@ -14,8 +14,8 @@ require 'k2-connect-ruby/utilities'
 require 'k2-connect-ruby/k2_services/payload_process'
 
 # Entity
-require 'k2-connect-ruby/k2_financial_entity/k2_entity'
-require 'k2-connect-ruby/k2_financial_entity/entity'
+require 'k2-connect-ruby/k2_entity/k2_entity'
+require 'k2-connect-ruby/k2_entity/entity'
 
 # ActiveSupport
 require 'active_support/core_ext/hash/indifferent_access'

data/lib/k2-connect-ruby/k2_entity/entity.rb

@@ -0,0 +1,8 @@
+require 'k2-connect-ruby/k2_entity/k2_token'
+require 'k2-connect-ruby/k2_entity/k2_polling'
+require 'k2-connect-ruby/k2_entity/k2_subscribe'
+require 'k2-connect-ruby/k2_entity/k2_notification'
+require 'k2-connect-ruby/k2_entity/k2_financial_entities/k2_stk'
+require 'k2-connect-ruby/k2_entity/k2_financial_entities/k2_pay'
+require 'k2-connect-ruby/k2_entity/k2_financial_entities/k2_transfer'
+require 'k2-connect-ruby/k2_entity/k2_financial_entities/k2_settlement'

data/lib/k2-connect-ruby/k2_entity/k2_notification.rb

@@ -0,0 +1,41 @@
+class K2Notification
+  include K2Validation, K2Utilities
+  attr_reader :location_url, :k2_response_body
+  attr_accessor :access_token
+
+  # Initialize with access_token
+  def initialize(access_token)
+    raise ArgumentError, 'Nil or Empty Access Token Given!' if access_token.blank?
+    @threads = []
+    @access_token = access_token
+  end
+
+  # Sends transaction notifications via SMS
+  def send_sms_transaction_notification(params)
+    k2_request_links = {
+      callback_url: params[:callback_url]
+    }
+    k2_request_body = {
+      webhook_event_reference: params[:webhook_event_reference],
+      message: params[:message],
+      _links: k2_request_links,
+    }
+    subscribe_hash = make_hash(K2Config.path_url('transaction_sms_notifications'), 'post', @access_token,'Notification', k2_request_body)
+    @location_url =  K2Connect.make_request(subscribe_hash)
+  end
+
+  # Query Recent Webhook
+  def query_resource(location_url = @location_url)
+    query_hash = make_hash(location_url, 'get', @access_token, 'Notification', nil)
+    @threads << Thread.new do
+      sleep 0.25
+      @k2_response_body = K2Connect.make_request(query_hash)
+    end
+    @threads.each(&:join)
+  end
+
+  # Query Specific Webhook URL
+  def query_resource_url(url)
+    query_resource(url)
+  end
+end

data/lib/k2-connect-ruby/k2_entity/k2_polling.rb

@@ -0,0 +1,40 @@
+# Class for Polling Service
+class K2Polling
+  include K2Validation, K2Utilities
+  attr_reader :location_url, :k2_response_body
+  attr_accessor :access_token
+
+  # Initialize with access token
+  def initialize(access_token)
+    raise ArgumentError, 'Nil or Empty Access Token Given!' if access_token.blank?
+    @threads = []
+    @access_token = access_token
+  end
+
+  def poll(params)
+    k2_request_body = {
+      scope: params[:scope],
+      scope_reference: params[:scope_reference],
+      from_time: params[:from_time],
+      to_time: params[:to_time],
+      _links: { callback_url: params[:callback_url] }
+    }
+    poll_hash = make_hash(K2Config.path_url('poll'), 'post', @access_token,'Polling', k2_request_body)
+    @location_url =  K2Connect.make_request(poll_hash)
+  end
+
+  # Retrieve your newly created polling request by its resource location
+  def query_resource(location_url = @location_url)
+    query_hash = make_hash(location_url, 'get', @access_token, 'Polling', nil)
+    @threads << Thread.new do
+      sleep 0.25
+      @k2_response_body = K2Connect.make_request(query_hash)
+    end
+    @threads.each(&:join)
+  end
+
+  # Retrieve your newly created polling request by specific resource location
+  def query_resource_url(url)
+    query_resource(url)
+  end
+end

data/lib/k2-connect-ruby/{k2_financial_entity → k2_entity}/k2_subscribe.rb

@@ -4,7 +4,7 @@ class K2Subscribe
   attr_reader :location_url, :k2_response_body
   attr_accessor :access_token, :webhook_secret
 
-  # Initialize with the event_type
+  # Initialize with access token
   def initialize(access_token)
     raise ArgumentError, 'Nil or Empty Access Token Given!' if access_token.blank?
     @threads = []

data/lib/k2-connect-ruby/k2_utilities/config/k2_config.yml

@@ -1,6 +1,6 @@
 --- !ruby/hash:ActiveSupport::HashWithIndifferentAccess
 version: v1
-base_url: http://127.0.0.1:3000/
+base_url: https://sandbox.kopokopo.com/
 endpoints: !ruby/hash:ActiveSupport::HashWithIndifferentAccess
   oauth_token: oauth/token
   revoke_token: oauth/revoke
@@ -13,5 +13,7 @@ endpoints: !ruby/hash:ActiveSupport::HashWithIndifferentAccess
   settlement_mobile_wallet: merchant_wallets
   settlement_bank_account: merchant_bank_accounts
   transfers: settlement_transfers
+  poll: polling
+  transaction_sms_notifications: transaction_sms_notifications
 network_operators:
 - SAFARICOM

data/lib/k2-connect-ruby/k2_utilities/k2_connection.rb

@@ -11,10 +11,10 @@ module K2Connect
     end
 
     # Set up Headers
-    headers = { 'Content-Type': 'application/json', Accept: 'application/vnd.kopokopo.v1.hal+json', Authorization: "Bearer #{access_token}" }
+    headers = { 'Content-Type': 'application/json', Accept: 'application/json', Authorization: "Bearer #{access_token}" }
     # For access token request
     if path_url.include?('oauth/token/info')
-      headers = { 'Content-Type': 'application/json', Accept: 'application/vnd.kopokopo.v1.hal+json', Authorization: "Bearer #{access_token}" }
+      headers = { 'Content-Type': 'application/json', Accept: 'application/json', Authorization: "Bearer #{access_token}" }
     elsif path_url.include?('oauth/')
       headers = { 'Content-Type': 'application/json' }
     end
@@ -25,7 +25,7 @@ module K2Connect
     response_body = Yajl::Parser.parse(k2_response.body)
     response_headers = Yajl::Parser.parse(k2_response.headers.to_json)
     response_code = k2_response.code.to_s
-    raise K2ConnectionError.new(response_code) && k2_request.shutdown unless response_code[0].eql?(2.to_s)
+    raise K2ConnectionError.new(response_code) unless response_code[0].eql?(2.to_s)
 
     unless request_type.eql?('get')
       # Returns the access token for authorization

data/lib/k2-connect-ruby/k2_utilities/spec_modules/spec_config.rb

@@ -25,7 +25,7 @@ module SpecConfig
     def custom_stub_request(request_type, path_url, request_body, response_code)
       request_body = request_body.to_s
       request_uri = path_url
-      request_headers = { Authorization: "Bearer access_token", Accept: "application/vnd.kopokopo.v1.hal+json" }
+      request_headers = { Authorization: "Bearer access_token", Accept: "application/json" }
 
       if request_type.eql?('post')
         request_headers['Content-Type'] = 'application/json'

data/lib/k2-connect-ruby/utilities.rb

@@ -6,6 +6,9 @@ require 'k2-connect-ruby/k2_utilities/config/k2_config'
 require 'k2-connect-ruby/k2_utilities/k2_process_result'
 require 'k2-connect-ruby/k2_utilities/k2_process_webhook'
 
+# For Stub Requests
+require 'k2-connect-ruby/k2_utilities/spec_modules/spec_config'
+
 module K2Utilities
   def make_hash(path_url, request, access_token, class_type, body)
     {

data/lib/k2-connect-ruby/version.rb

@@ -1,3 +1,3 @@
 module K2ConnectRuby
-  VERSION = '0.0.3'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k2-connect-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - DavidKar1uk1
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -203,15 +203,17 @@ files:
 - bin/setup
 - k2-connect-ruby.gemspec
 - lib/k2-connect-ruby.rb
+- lib/k2-connect-ruby/k2_entity/entity.rb
+- lib/k2-connect-ruby/k2_entity/k2_entity.rb
+- lib/k2-connect-ruby/k2_entity/k2_financial_entities/k2_pay.rb
+- lib/k2-connect-ruby/k2_entity/k2_financial_entities/k2_settlement.rb
+- lib/k2-connect-ruby/k2_entity/k2_financial_entities/k2_stk.rb
+- lib/k2-connect-ruby/k2_entity/k2_financial_entities/k2_transfer.rb
+- lib/k2-connect-ruby/k2_entity/k2_notification.rb
+- lib/k2-connect-ruby/k2_entity/k2_polling.rb
+- lib/k2-connect-ruby/k2_entity/k2_subscribe.rb
+- lib/k2-connect-ruby/k2_entity/k2_token.rb
 - lib/k2-connect-ruby/k2_errors.rb
-- lib/k2-connect-ruby/k2_financial_entity/entities/k2_pay.rb
-- lib/k2-connect-ruby/k2_financial_entity/entities/k2_settlement.rb
-- lib/k2-connect-ruby/k2_financial_entity/entities/k2_stk.rb
-- lib/k2-connect-ruby/k2_financial_entity/entities/k2_transfer.rb
-- lib/k2-connect-ruby/k2_financial_entity/entity.rb
-- lib/k2-connect-ruby/k2_financial_entity/k2_entity.rb
-- lib/k2-connect-ruby/k2_financial_entity/k2_subscribe.rb
-- lib/k2-connect-ruby/k2_financial_entity/k2_token.rb
 - lib/k2-connect-ruby/k2_services/client/k2_client.rb
 - lib/k2-connect-ruby/k2_services/payload_process.rb
 - lib/k2-connect-ruby/k2_services/payloads/k2_transaction.rb

data/lib/k2-connect-ruby/k2_financial_entity/entity.rb

@@ -1,6 +0,0 @@
-require 'k2-connect-ruby/k2_financial_entity/k2_token'
-require 'k2-connect-ruby/k2_financial_entity/k2_subscribe'
-require 'k2-connect-ruby/k2_financial_entity/entities/k2_stk'
-require 'k2-connect-ruby/k2_financial_entity/entities/k2_pay'
-require 'k2-connect-ruby/k2_financial_entity/entities/k2_transfer'
-require 'k2-connect-ruby/k2_financial_entity/entities/k2_settlement'