okra-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01f30c247f81018a9bab302ef54352cfd2ff5b5a9f9c5d915ba55e4a08fefd99
+  data.tar.gz: e147cbae5cdeecb5c213856a64b1a5ff4b026af63f14da1f08cb6d8024e3c5fc
+SHA512:
+  metadata.gz: 0354a10a89230b95f638e5c99e5c5071b033cc0b4b6a158f9d4792f48d6e07aeb03d7f8eef000341b4d6bbe893e3108f463a1806e41c50ffbac7b5ce16c4fabe
+  data.tar.gz: 1364840edd388ce9e254799f0d482e9519e0781b17c911260b6a8ac48c134d6e2d8ed5d1c850100c864c29a0d02e180f4d531bcb7a78cf448cbcc25017dc7f1f

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+auth_test.rb
+identity_test.rb
+bank_test.rb
+balance_test.rb
+account_test.rb
+payment_test.rb
+.DS_Store

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.6.3
+before_install: gem install bundler -v 1.17.2

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 ifavour902@gmail.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 okra-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    okra-ruby (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (10.5.0)
+    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-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  okra-ruby!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Iphytech
+
+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 NONINFRINGEMENT. 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,187 @@
+# Okra Ruby SDK
+
+This is a Ruby gem for easy integration of [Okra](okra.ng) products. 
+
+# Documentation
+
+See [Here](https://docs.okra.ng/docs/get-started-with-okra) for the API Docs.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'okra-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install okra-ruby
+
+## Usage
+
+## Instantiate Okra Object
+
+To use the SDK in your project, you need to instantiate the Okra::ruby with your API keys( public and secret). We recommed that you store API keys in your environment variable named OKRA_PUBLIC_KEY, OKRA_SECRET_KEY.  Instantiating your Okra object after adding your API keys in your environment is illustrated as follows below:
+
+```ruby
+
+OkraTest = OkraSDK.new
+
+```
+
+This throws a `OKRABadKeyError` if no key is found in the environment variable.
+
+### Instantiate Okra object in Sandbox without environment variable:
+
+You can instantiate your Okra object by passing your public , secret key as an argument of the `OkraSDk` class just as displayed below:
+
+```ruby
+
+OkraTest = OkraSDK.new("public_key", "secret_key)
+
+```
+
+#### `NOTE:` It is best practice to always set your API keys to your environment variable for security purpose. Please be warned not use this package without setting your API keys in your environment variables in production.
+
+#### To instantiate Okra object in production with environment variable:
+
+Simply use it as displayed below:
+
+```ruby
+
+OkraTest = OkraSDK.new("YOUR_OKRA_LIVE_PUBLIC_KEY", "YOUR_OKRA_LIVE_SECRET_KEY", true)
+
+```
+
+
+### List of all the Okra class available in the gem
+
+NB - See the documentation for the request for each method of the products
+
+- Auth.new(OkraTest) 
+- Account.new(OkraTest)
+- AssetsAndLiabilities.new(OkraTest)
+- Balance.new(OkraTest)
+- Bank.new(OkraTest)
+- Customer.new(OkraTest)
+- Identity.new(OkraTest)
+- Income.new(OkraTest)
+- OtherProducts.new(OkraTest)
+- Payment.new(OkraTest)
+- Revenue.new(OkraTest)
+- Transactions.new(OkraTest)
+- Widget.new(OkraTest)
+
+
+## How to use
+
+Once you initailzie a project with any of the classes listed above, you will be able to use their methods. To see all the available methods, kindly run the following command
+
+Eg. ClassName.methods
+
+```cmd
+Auth.instance_methods - Object.instance_methods
+
+```
+
+The above command will output all the methods associated with the `Auth` class.
+
+
+### Full Auth Sample payload 
+
+```ruby
+
+require './okra_sdk'
+
+
+OkraTest = OkraSDK.new("public_key", "secret_key")
+auth = Auth.new(OkraTest)
+
+# ========================= Get by ID
+
+payload = {
+    "id" => "607d4xxxxx951e8ff79bxx79"
+}
+response = auth.get_by_id(payload)
+puts response
+
+
+# ===================================== Retrieve all auths
+
+payload = {
+    "page" => 20,
+    "limit" => 2
+}
+
+response = auth.fetch_auths(payload)
+puts response
+
+
+# ===================================== get by customer
+
+payload = {
+    "customer" => "xxxxx486"
+}
+
+response = auth.get_by_customer(payload)
+puts response
+
+
+# ===================================== get by date
+
+payload = {
+    "from" => "2020-04-25",
+    "to" => "2020-06-29"
+}
+
+response = auth.get_by_date(payload)
+puts response
+
+
+# ======================================== get by bank
+
+payload = {
+    "bank" => "5d6fe57a4099cc4b210bbeb3"
+}
+
+response = auth.get_by_bank(payload)
+puts response
+
+
+# ====================================== get by customerDate
+
+payload = {
+    "customer" => "",
+    "to" => "2020-06-29",
+    "from" => "2020-04-25"
+}
+
+response = auth.get_by_customerDate(payload)
+puts response
+
+```
+
+
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/okraHQ/okra-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](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Okra::Ruby project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/OkraHQ/okra-ruby/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "okra/ruby"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/okra/error.rb

@@ -0,0 +1,13 @@
+class OkraServerError < StandardError
+  attr_reader :response
+
+  def initialize(response=nil)
+    @response = response
+  end
+
+  class OkraBadKeyError < StandardError
+  end
+
+  class ArgumentError < StandardError
+  end
+end

data/lib/okra/okra_modules/base_endpoints.rb

@@ -0,0 +1,11 @@
+module BASE_ENDPOINTS
+    OKRA_LIVE_URL = "https://api.okra.ng/v2"
+    OKRA_SANDBOX_URL = "https://api.okra.ng/v2/sandbox"
+    AUTH_ENDPOINT = "/auth"
+    IDENTITY_ENDPOINT = "/identity"
+    BALANCE_ENDPOINT = "/balance"
+    ACCOUNT_ENDPOINT = "/accounts"
+    TRANSACTION_ENDPOINT = "/transactions"
+    INCOME_ENDPOINT = "/income"
+    REVENUE_ENDPOINT = "/revenue"
+end

data/lib/okra/okra_products/account.rb

@@ -0,0 +1,64 @@
+require_relative "base/base.rb"
+require 'json'
+
+class Account < Base
+    def realtime_bank_account_info(data)
+        base_url = okra_object.base_url
+        #certain that the required parameters are passed
+        required_params = ["page", "limit"] 
+        check_passed_parameters(required_params, data)
+        payload = data.to_json
+        response = post_request("#{base_url}/products/accounts", payload) 
+        return response
+    end
+
+    def get_by_id(data)
+        base_url = okra_object.base_url
+        #certain that the required parameters are passed
+        required_params = ["id"] 
+        check_passed_parameters(required_params, data)
+        payload = data.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::ACCOUNT_ENDPOINT}/getById", payload) 
+        return response
+    end
+
+    def get_by_customer(data)
+        base_url = okra_object.base_url
+        #certain that the required parameters are passed
+        required_params = ["customer"] 
+        check_passed_parameters(required_params, data)
+        payload = data.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::ACCOUNT_ENDPOINT}/getByCustomer", payload) 
+        return response
+    end
+
+    def get_by_bank(data)
+        base_url = okra_object.base_url
+        #certain that the required parameters are passed
+        required_params = ["bank"] 
+        check_passed_parameters(required_params, data)
+        payload = data.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::ACCOUNT_ENDPOINT}/getByBank", payload) 
+        return response
+    end
+
+    def get_by_date(data)
+        base_url = okra_object.base_url
+        #certain that the required parameters are passed
+        required_params = ["from", "to"] 
+        check_passed_parameters(required_params, data)
+        payload = data.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::ACCOUNT_ENDPOINT}/getByDate", payload) 
+        return response
+    end
+
+    def get_by_customerDate(data)
+        base_url = okra_object.base_url
+        #certain that the required parameters are passed
+        required_params = ["to", "from", "customer"] 
+        check_passed_parameters(required_params, data)
+        payload = data.to_json
+        response = post_request("#{base_url}#{BASE_ENDPOINTS::ACCOUNT_ENDPOINT}/getByCustomerDate", payload) 
+        return response
+    end
+end