k2-connect-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cc1d6afd8cb462672623e84afe97821c5078e62ba5fa29adaa1c8af637afffb0
+  data.tar.gz: 1856d71a8889905da81c500f2259449f78e7e119235fd9429923913e4a1ca4ef
+SHA512:
+  metadata.gz: '068ee6b4ce7811008df5f432f877820c4e3b79969b09dc78d5bb2fdc80711209a982ff71b96b1d0f67e83964db4addae4a7de2f6ce0c369e5f15aee5a10aa14c'
+  data.tar.gz: a015998bc9e4414aa7f753e91eed92cde70cc9cffc762b86341b1fa6b6287edd085db757c5eddda8bc449da96dbbfe784293a7822878274285fddb75e98e2851

data/.gitignore

@@ -0,0 +1,75 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# for intellij products
+.idea
+
+# rubocop
+rubocop.html
+tmp
+
+# rubocop
+rubocop.html
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# yml files
+#lib/k2-connect-ruby/k2_utilities/config/k2_config.yml
+lib/k2-connect-ruby/k2_utilities/spec_modules/test_config.yml

data/.gitmodules

@@ -0,0 +1,6 @@
+[submodule "example_app/rails/kt_tips_rails"]
+	path = example_app/rails/kt_tips_rails
+	url = git@github.com:DavidKar1uk1/kt_tips_rails.git
+[submodule "example_app/sinatra/kt_tips"]
+	path = example_app/sinatra/kt_tips
+	url = git@github.com:DavidKar1uk1/kt_tips.git

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.0
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at David.mwangi@kopokop.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in k2-connect-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: .
+  specs:
+    k2-connect-ruby (0.0.1)
+      activemodel (~> 6.1.3.1)
+      activesupport (~> 6.1.3.1)
+      rest-client (~> 2.1.0)
+      yajl-ruby (~> 1.4.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (6.1.3.1)
+      activesupport (= 6.1.3.1)
+    activesupport (6.1.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    ffi (1.15.0)
+    formatador (0.2.5)
+    guard (2.16.2)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    hashdiff (1.0.1)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (1.8.10)
+      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-data (~> 3.2015)
+    mime-types-data (3.2021.0225)
+    minitest (5.14.4)
+    nenv (0.3.0)
+    netrc (0.11.0)
+    notiffany (0.1.3)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    pry (0.14.0)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (13.0.3)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-nc (0.3.0)
+      rspec (>= 3)
+      terminal-notifier (>= 1.4)
+    rspec-support (3.10.2)
+    shellany (0.0.1)
+    terminal-notifier (2.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    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)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  guard (~> 2.16.2)
+  guard-rspec (~> 4.7.3)
+  k2-connect-ruby!
+  rake (~> 13.0.3)
+  rspec (~> 3.10.0)
+  rspec-nc (~> 0.3.0)
+  vcr (~> 6.0.0)
+  webmock (~> 3.12.2)
+
+BUNDLED WITH
+   2.2.11

data/Guardfile

@@ -0,0 +1,80 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exist?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w(erb haml slim))
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "spec/#{m[1]}_spec.rb"
+  end
+
+  # watch /spec/ files
+  watch(%r{^spec/(.+).rb$}) do |m|
+    "spec/#{m[1]}.rb"
+  end
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Kopo Kopo Inc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,542 @@
+# K2ConnectRuby For Rails
+
+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:
+
+ - Receive Webhook notifications.
+ - Receive payments from your users/customers.
+ - Initiate payments to third parties.
+ - Initiate transfers to your settlement accounts.
+ 
+The library is optimized for **Rails Based Frameworks**.
+Please note, all requests MUST be made over HTTPS.
+Any non-secure requests are met with a redirect (HTTP 302) to the HTTPS equivalent URI.
+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
+
+Add this line to your application's Gemfile:
+
+    gem 'k2-connect-ruby'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself:
+
+    $ gem install k2-connect-ruby
+
+## Usage
+
+Add the require line to use the gem:
+
+    require 'k2-connect-ruby'
+
+### Authorization
+
+Ensure you first Register your application with the [Kopo Kopo Sandbox](To be added later when launched).
+Once an application is registered you will obtain your `client_id` and `client_secret` (aka client credentials), which will be used to identify your application when calling the Kopo Kopo API.
+
+For more Information, visit our [API docs]().
+
+In order to request for application authorization and receive an access token, we need to execute the client credentials flow, this is done so by having your application server make a HTTPS request to the Kopo Kopo authorization server, through the K2AccessToken class.
+
+```ruby
+k2_token = K2AccessToken.new('your_client_id', 'your_client_secret').request_token
+```
+
+### Webhook Subscription
+
+##### Remember to store highly sensitive information like the client credentials, in a config file, while indicating in your .gitignore file.
+
+Next, we formally create the webhook subscription by calling on the webhook_subscribe method.
+Ensure the following arguments are passed: 
+ - event type `REQUIRED`
+ - url `REQUIRED`
+ - scope `REQUIRED`: is `till` if event_type is a buygoods_transaction_received, buygoods_transaction_reversed or b2b_transaction_received, and `company` if not
+ - scope reference: is `REQUIRED` if scope is till
+ 
+Code example;
+    
+```ruby
+require 'k2-connect-ruby'
+k2_token = K2AccessToken.new('your_client_id', 'your_client_secret').request_token
+k2subscriber = K2Subscribe.new(k2_token)
+
+your_request = {
+        event_type: 'buygoods_transaction_received',
+        url: callback_url,
+        scope: 'till',
+        scope_reference: '112233'
+}
+k2subscriber.webhook_subscribe(your_request)
+```
+ 
+ 
+ ### STK-Push
+ 
+ #### Receive Payments
+ 
+ To receive payments from M-PESA users via STK Push we first create a K2Stk Object, passing the access_token that was created prior.
+ 
+    k2_stk = K2Stk.new(your_access_token)
+  
+ Afterwards we send a POST request for receiving Payments by calling the following method and passing the params value received from the POST Form Request: 
+
+    k2_stk.receive_mpesa_payments(your_input)
+    
+Ensure the following arguments are passed:
+ - payment_channel `REQUIRED`
+ - till_number `REQUIRED`: from the Online Payments Account created with Kopo Kopo Inc Web App
+ - first_name 
+ - last_name 
+ - phone_number `REQUIRED`
+ - email
+ - currency: default is `KES`
+ - value `REQUIRED`
+ - callback_url `REQUIRED`
+
+A Successful Response will be received containing the URL of the Payment Location.
+
+#### Query Request Status
+
+ To Query the STK Payment Request Status pass the Payment location URL response that is returned:
+
+    k2_stk.query_resource(k2_stk.location_url)
+
+ To Query the most recent STK Request Status is as follows:
+
+    k2_stk.query_status
+
+As a result a JSON payload will be returned, accessible with the k2_response_body variable.
+ 
+Code example;
+    
+```ruby
+k2_stk = K2Stk.new(your_access_token)
+
+your_request = {
+        payment_channel: 'M-PESA',
+        till_number: 'K112233',
+        first_name: stk_params[:first_name],
+        last_name: stk_params[:last_name],
+        phone_number: stk_params[:phone],
+        email: stk_params[:email],
+        currency: stk_params[:currency],
+        value: stk_params[:value],
+        callback_url: callback_url
+}
+k2_stk.receive_mpesa_payments(your_request)
+k2_stk.query_resource(k2_stk.location_url)
+```
+
+### PAY
+
+First Create the K2Pay Object passing the access token
+
+
+    k2_pay = K2Pay.new(access_token)
+
+#### Add PAY Recipients
+
+Add a PAY Recipient, with the following arguments:
+
+**Mobile** PAY Recipient
+- type: 'mobile_wallet' `REQUIRED`
+- first_name `REQUIRED`
+- last_name `REQUIRED`
+- phone_number `REQUIRED`
+- email `REQUIRED`
+- network `REQUIRED`
+
+**Bank** PAY Recipient
+- type: 'bank_account' `REQUIRED`
+- account_name `REQUIRED`
+- account_number `REQUIRED`
+- bank_branch_ref `REQUIRED`
+- settlement_method: 'EFT' or 'RTS' `REQUIRED`
+
+  
+    k2_pay.add_recipients(your_input)
+    
+The type value can either be `mobile_wallet` or `bank_account`
+
+A Successful Response is returned with the URL of the recipient resource.
+
+#### Create Outgoing Payment
+
+Creating an Outgoing Payment to a third party.
+
+    k2_pay.create_payment(your_input)
+    
+The following arguments should be passed within a hash:
+
+- destination_reference `REQUIRED`
+- destination_type `REQUIRED`
+- currency default is `KES`
+- value `REQUIRED`
+- callback_url `REQUIRED`
+
+A Successful Response is returned with the URL of the Payment resource in the HTTP Location Header.
+
+#### Query PAY Request Status
+
+To Query the status of the Add Recipient or Outgoing Payment request:
+
+    // add recipient
+    k2_pay.query_resource(k2_pay.recipients_location_url)
+    // create outgoing payment 
+    k2_pay.query_resource(k2_pay.payments_location_url)
+
+To Query the most recent status of either the Add Recipient or Outgoing Payment request:
+
+    // add recipient
+    k2_pay.query_status('recipients')
+    // create outgoing payment 
+    k2_pay.query_status('payments')
+
+As a result a JSON payload will be returned, accessible with the k2_response_body variable.
+ 
+Code example;
+    
+```ruby
+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)
+k2_pay.query_resource(k2_pay.payments_location_url)
+```
+
+### Settlement Accounts
+
+Add pre-approved settlement accounts, to which one can transfer funds to. Can be either a bank or mobile wallet account,
+ with the following details:
+
+**Mobile** Settlement Account
+- type: 'merchant_wallet' `REQUIRED`
+- first_name `REQUIRED`
+- last_name `REQUIRED`
+- phone_number `REQUIRED`
+- network: 'Safaricom' `REQUIRED`
+
+**Bank** Settlement Account
+- type: 'merchant_bank_account' `REQUIRED`
+- account_name `REQUIRED`
+- account_number `REQUIRED`
+- bank_branch_ref `REQUIRED`
+- settlement_method: 'EFT' or 'RTS' `REQUIRED`
+
+```ruby
+k2_settlement = K2Settlement.new(your_access_token)
+# Add a mobile merchant wallet
+k2_settlement.add_settlement_account(merchant_wallet)
+# Add a merchant bank account
+k2_settlement.add_settlement_account(merchant_bank_account)
+```
+
+### Transfers
+
+This will Enable one to transfer funds to your settlement accounts.
+
+First Create the K2Transfer Object
+
+    k2_transfers = K2Transfer.new(access_token)
+
+#### Create Transfer Request
+
+One can either have it `blind`, meaning that it has no specified destination with the default/specified settlement account being selected, 
+or one can have a `targeted` transfer with a specified settlement account in mind. Either can be done through:
+
+##### Blind Transfer
+
+     k2_transfers.transfer_funds(nil, params)
+
+With `nil` representing that there are no specified destinations.
+
+##### Target Transfer
+
+     k2_transfers.transfer_funds(params)
+      
+The Following Details should be passed for either **Blind** or **Targeted** Transfer:
+
+**Blind** Transfer to your default settlement account
+- currency default is `KES`
+- value `REQUIRED`
+- callback_url `REQUIRED`
+
+**Targeted** Transfer
+- destination_reference `REQUIRED`
+- destination_type: `merchant_wallet` or `merchant_bank_account` `REQUIRED`
+- currency default is `KES`
+- 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.
+
+Sample code example:
+
+```ruby
+k2_transfer = K2Transfer.new(your_access_token)
+# Blind or Targeted Transfer
+k2_transfer.transfer_funds(your_input)
+```
+
+#### Query Prior Transfer
+
+To Query the status of the prior initiated Transfer Request pass the location_url response as shown:
+
+     k2_transfers.query_resource(k2_transfers.location_url)  
+
+To Query the most recent initiated Transfer Request:
+
+     k2_transfers.query_status  
+
+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
+K2ProcessResult Classes will be used.
+
+###### K2Client Object
+
+First Create an Object of the K2Client class to Parse the response, passing the client_secret_key received from Kopo Kopo:
+
+     k2_parse = K2Client.new(client_secret)
+
+###### Parse the request
+
+     k2_parse.parse_request(request)
+
+###### Create an Object 
+
+Create an Object to receive the components resulting from processing the parsed request results which will be returned by the following method:
+
+     k2_components = K2ProcessResult.process(k2_parse.hash_body)
+     
+Code example:
+
+```ruby
+k2_parse = K2Client.new(client_secret)
+k2_parse.parse_request(request)
+k2_components = K2ProcessResult.process(k2_parse.hash_body)
+```
+         
+ Below is a list of key symbols accessible for each of the Results retrieved after processing it into an Object.
+ 
+1. Buy Goods Transaction Received:
+    - `id`
+    - `resource_id`
+    - `topic`
+    - `created_at`
+    - `event_type`
+    - `reference`
+    - `origination_time`
+    - `sender_phone_number`
+    - `amount`
+    - `currency`
+    - `till_number`
+    - `system`
+    - `status`
+    - `sender_first_name`
+    - `sender_last_name`
+    - `links_self`
+    - `links_resource`
+    
+2. Buy Goods Transaction Reversed:
+    - `id`
+    - `resource_id`
+    - `topic`
+    - `created_at`
+    - `event_type`
+    - `reference`
+    - `origination_time`
+    - `sender_phone_number`
+    - `amount`
+    - `currency`
+    - `till_number`
+    - `system`
+    - `status`
+    - `sender_first_name`
+    - `sender_last_name`
+    - `links_self`
+    - `links_resource` 
+    
+3. Settlement Transfer:
+    - `id`
+    - `resource_id`
+    - `topic`
+    - `created_at`
+    - `event_type`
+    - `origination_time`
+    - `amount`
+    - `currency`
+    - `resource_status`
+    - `links_self`
+    - `links_resource`
+    - `destination_reference`
+    - `destination_type`
+      **Bank Account** Destination Type
+    - `destination_account_name`
+    - `destination_account_number`
+    - `destination_bank_branch_ref`
+    - `destination_settlement_method`
+      **Merchant Wallet** Destination Type
+    - `destination_first_name`
+    - `destination_last_name`
+    - `destination_phone_number`
+    - `destination_network`
+
+4. Customer Created:
+    - `id`
+    - `resource_id`
+    - `topic`
+    - `created_at`
+    - `event_type`
+    - `resource_first_name`
+    - `resource_middle_name`
+    - `resource_last_name`
+    - `resource_phone_number`
+    - `links_self`
+    - `links_resource`
+    
+5. B2b Transaction Transaction (External Till to Till):
+    - `id`
+    - `resource_id`
+    - `topic`
+    - `created_at`
+    - `event_type`
+    - `reference`
+    - `origination_time`
+    - `amount`
+    - `currency`
+    - `till_number`
+    - `status`
+    - `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`
+    - `type`
+    - `initiation_time`
+    - `status`
+    - `event_type`
+    - `resource_id`
+    - `resource_status`
+    - `transaction_reference`
+    - `origination_time`
+    - `sender_phone_number`
+    - `amount`
+    - `currency`
+    - `till_number`
+    - `system`
+    - `sender_first_name`
+    - `sender_middle_name`
+    - `sender_last_name`
+    - `errors`
+    - `metadata`
+    - `links_self`
+    - `callback_url`
+
+8. Process PAY Result
+    - `id`
+    - `type`
+    - `created_at`
+    - `status`
+    - `transfer_batch`
+    - `currency`
+    - `value`
+    - `metadata`
+    - `links_self`
+    - `callback_url`
+
+9. Process Settlement Transfer Result
+   - `id`
+   - `type`
+   - `created_at`
+   - `status`
+   - `transfer_batch`
+   - `currency`
+   - `value`
+   - `links_self`
+   - `callback_url`
+    
+If you want to convert the Object into a Hash or Array, the following methods can be used.
+- Hash:
+   
+   
+        k2_hash_components = K2ProcessResult.return_obj_hash(k2_components)
+    
+    
+- Array:
+   
+    
+        k2_array_components = K2ProcessResult.return_obj_array(k2_components)
+
+
+Sample Web Application examples written in Rails and Sinatra frameworks that utilize this library are available in the example_app folder or in the following GitHub hyperlinks:
+
+ - [Rails example application](https://github.com/DavidKar1uk1/kt_tips_rails)
+
+ - [Sinatra example application](https://github.com/DavidKar1uk1/kt_tips)
+ 
+ ##### Take Note; the Library is optimized for Rails frameworks version 5.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Author
+
+**Name**:   [David Kariuki Mwangi](https://github.com/DavidJonKariz)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kopokopo/k2-connect-ruby. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License].
+
+## Changelog
+
+
+
+## Code of Conduct
+
+Everyone interacting in the K2ConnectRuby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/kopokopo/k2-connect-ruby/blob/master/CODE_OF_CONDUCT.md).