k2-connect-ruby 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f16b31dad92f44afc4fecd11658daedb06dd25dc248dc91aac55108e231c567
-  data.tar.gz: f92ca5e74163589b853eaad34856cc9477b0ea0be2794a207070f4a6e02e5906
+  metadata.gz: 31eba87b4eac68ac9e84013a18c31fbd9947329ed46b2baa0635634612fad44d
+  data.tar.gz: d00eecefb30ff3c58bb6487913b0fdde209f1b2452dfcf742722be7e5a7a189e
 SHA512:
-  metadata.gz: 2c3e9fb52c6d643c0aa19bc7295db3f03a6b2831b6bff0fd804f49505895242e86ee551c37f0da6b417a86728c0ae4f330d612e82f961d6f9ec55da44c972881
-  data.tar.gz: 2098c75cdc7f5f86a65dcfe0bdc42138bba2a87eb05e0c244bf5c0e7accd3d5977b0d6ae22840ad423b2b0157980998cbcf8aa2ba791f5f3f41ea86d64701204
+  metadata.gz: da32a40989d406aaac05646153edf4dfe18ec2c21eaf97a61c3ef1dc94a9571a57a7fa658fa822716d0c4c413ff04305a2c51deafab4fb8771aaab501453872b
+  data.tar.gz: fff96cacf6ec1888f3ab2dd2aca2683a1d042f9fbae335f19a71919f4250fac534594f5c6960b6f6a6e6c9d30b83009f3f0aa9c764796591f8cda9009e441133

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    k2-connect-ruby (0.0.4)
+    k2-connect-ruby (1.0.0)
       activemodel (~> 6.1.3.1)
       activesupport (~> 6.1.3.1)
       rest-client (~> 2.1.0)
@@ -10,18 +10,18 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.3.1)
-      activesupport (= 6.1.3.1)
-    activesupport (6.1.3.1)
+    activemodel (6.1.3.2)
+      activesupport (= 6.1.3.2)
+    activesupport (6.1.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
       zeitwerk (~> 2.3)
-    addressable (2.7.0)
+    addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     coderay (1.1.3)
-    concurrent-ruby (1.1.8)
+    concurrent-ruby (1.1.9)
     crack (0.4.5)
       rexml
     diff-lcs (1.4.4)
@@ -45,19 +45,19 @@ GEM
       rspec (>= 2.99.0, < 4.0)
     hashdiff (1.0.1)
     http-accept (1.7.0)
-    http-cookie (1.0.3)
+    http-cookie (1.0.4)
       domain_name (~> 0.5)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     listen (3.5.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     lumberjack (1.2.8)
     method_source (1.0.0)
-    mime-types (3.3.1)
+    mime-types (3.4.1)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2021.0225)
-    minitest (5.14.4)
+    mime-types-data (3.2022.0105)
+    minitest (5.15.0)
     nenv (0.3.0)
     netrc (0.11.0)
     notiffany (0.1.3)
@@ -100,14 +100,14 @@ GEM
       concurrent-ruby (~> 1.0)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.7)
+    unf_ext (0.0.8)
     vcr (6.0.0)
     webmock (3.12.2)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
     yajl-ruby (1.4.1)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   ruby
@@ -124,4 +124,4 @@ DEPENDENCIES
   webmock (~> 3.12.2)
 
 BUNDLED WITH
-   2.2.11
+   2.2.21

data/README.md

@@ -202,6 +202,17 @@ Add a PAY Recipient, with the following arguments:
 - bank_branch_ref `REQUIRED`
 - settlement_method: 'EFT' or 'RTS' `REQUIRED`
 
+**Paybill** PAY Recipient
+- type: 'paybill' `REQUIRED`
+- paybill_name `REQUIRED`
+- paybill_number `REQUIRED`
+- paybill_account_number `REQUIRED`
+
+**Till** PAY Recipient
+- type: 'till' `REQUIRED`
+- till_name `REQUIRED`
+- till_number `REQUIRED`
+
   
     k2_pay.add_recipients(your_input)
     
@@ -221,6 +232,9 @@ The following arguments should be passed within a hash:
 - destination_type `REQUIRED`
 - currency default is `KES`
 - value `REQUIRED`
+- description `REQUIRED`
+- category
+- tags
 - callback_url `REQUIRED`
 
 A Successful Response is returned with the URL of the Payment resource in the HTTP Location Header.
@@ -249,7 +263,25 @@ Code example;
 k2_pay = K2Pay.new(your_access_token)
 k2_pay.add_recipient(your_recipient_input)
 k2_pay.query_resource(k2_pay.recipients_location_url)
-k2_pay.create_payment(your_payment_input)
+
+your_request = {
+        destination_type: "mobile_wallet",
+        destination_reference: "example_reference",
+        amount: {
+                "currency": "KES",
+                "value": "500"
+        },
+        description: "k2-connect",
+        category: "general",
+        tags: ["tag_1", "tag_2"],
+        metadata: {
+                "something": "",
+                "something_else": "Something else"
+        },
+        _links: { "callback_url": "https://example.site/example" }
+}
+
+k2_pay.create_payment(your_request)
 k2_pay.query_resource(k2_pay.payments_location_url)
 ```
 
@@ -341,7 +373,7 @@ A HTTP Response will be returned in a JSON Payload, accessible with the k2_respo
 
 ### 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.
+Allows 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
 
@@ -501,21 +533,6 @@ k2_components = K2ProcessResult.process(k2_parse.hash_body)
     - `links_self`
     - `links_resource`
     - `sending_till`
-
-6. Merchant to Merchant Transaction:
-    - `id`
-    - `resource_id`
-    - `topic`
-    - `created_at`
-    - `event_type`
-    - `reference`
-    - `origination_time`
-    - `amount`
-    - `currency`
-    - `status`
-    - `links_self`
-    - `links_resource`
-    - `resource_sending_merchant`
     
 7. Process STK Push Payment Request Result
     - `id`

data/lib/k2-connect-ruby/k2_entity/k2_financial_entities/k2_pay.rb

@@ -34,11 +34,12 @@ class K2Pay < K2Entity
         till_number: params[:till_number]
       }
       # In the case of bank pay recipient
-    elsif params[:type].eql?('kopo_kopo_merchant')
-      params = validate_input(params, @exception_array += %w[alias_name till_number])
+    elsif params[:type].eql?('paybill')
+      params = validate_input(params, @exception_array += %w[paybill_name paybill_number paybill_account_number])
       k2_request_pay_recipient = {
-        alias_name: params[:alias_name],
-        till_number: params[:till_number]
+        paybill_name: params[:paybill_name],
+        paybill_number: params[:paybill_number],
+        paybill_account_number: params[:paybill_account_number]
       }
     else
       raise ArgumentError, 'Undefined Payment Method.'
@@ -59,7 +60,7 @@ class K2Pay < K2Entity
   # Create an outgoing Payment to a third party.
   def create_payment(params)
     # Validation
-    params = validate_input(params, @exception_array += %w[destination_reference destination_type currency value callback_url metadata])
+    params = validate_input(params, @exception_array += %w[destination_reference destination_type description category tags currency value callback_url metadata])
     # The Request Body Parameters
     k2_request_pay_amount = {
       currency: params[:currency],
@@ -72,6 +73,9 @@ class K2Pay < K2Entity
     create_payment_body = {
       destination_reference: params[:destination_reference],
       destination_type: params[:destination_type],
+      description: params[:description],
+      category: params[:category],
+      tags: params[:tags],
       amount: k2_request_pay_amount,
       meta_data: k2_request_pay_metadata,
       _links: k2_request_links

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: k2-connect-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - DavidKar1uk1
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-07-12 00:00:00.000000000 Z
+date: 2022-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -261,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby SDK for the Kopo Kopo K2 Connect API.