flutterwave 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 273fe5aaf4f8f929e7f3579a2e3862d016704027
+  data.tar.gz: 7658f624f764bd070c708b85e1cabf983298a6bd
+SHA512:
+  metadata.gz: 41d08641f6303ed74ec7a8c1908df3b972a01e0105cc5a6afd3fe7c980d83978fbc4dd642627b1afb1216350af8a2494e568b477717faab0e262da3f07f86f6e
+  data.tar.gz: 9c544fd6958d10121fcbb90ebea9e1babd2a56099dfba44198cb96890f89a5957a5fda44061f6f4e6e1882c0cdc7a346c3a17bd6a8b9a8b2c527f741b6ea2869

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.12.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Tobi Oduah
+
+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,102 @@
+# Flutterwave
+
+Ruby SDK for convenient access to the Flutterwave API from Ruby applications. Full API documentation avaialable at https://www.flutterwave.com/documentation
+
+## Installation
+
+    gem install flutterwave
+
+## Usage
+
+The library needs to be configured with your merchant key and API key. These are accessible from the Settings panel at https://www.flutterwavedev.com/
+
+To initialize the Ruby client:
+
+```ruby
+require 'flutterwave'
+
+merchant_key = 'tk_aT0BPO14Rs'
+api_key = 'tk_ybh0luGWQbM04Is15lXh'
+client = Flutterwave::Client.new(merchant_key, api_key)
+```
+
+## API operations
+All API operations are performed through the client instance. API responses are used to initialize a response class that allows direct access to JSON keys as methods. Arguments to operation methods adapt the same signature as sample requests to the API endpoint. For instance, an API call that returns:
+
+```json
+{
+  "data": {
+    "responsecode": "02",
+    "responsemessage": "Successful, pending OTP validation",
+    "transactionreference": "ABC1234444"
+  },
+  "status": "success"
+}
+```
+Gets initialized as a `Flutterwave::Response` object with method keys - `responsecode`, `responsemessage`, `transactionreference`, `successful?`, `failed?`
+
+## Examples
+An example using the wrapper for accessing https://www.flutterwave.com/documentation/alternative-payments/
+The resend-otp operation could be accessed through this sample:
+
+```ruby
+client = Flutterwave::Client.new('sample_merchant_key', 'sample_api_key')
+response = client.account.resend({
+  validateoption: 'SMS',
+  transactionreference: 'FLW02391188'
+})
+
+print response.responsemessage if response.successful?
+```
+
+The method arguments to the resend method match the same hash-signature as the request sample at https://www.flutterwave.com/documentation/alternative-payments/#resend-otp. Response from the API is used to construct an instance of `Flutterwave::Response` which makes keys in the `data` hash accessible as methods.
+
+## Banks Listing
+The only operation that does not follow the description above is when obtaining listing of banks, alongside their codes and names. To ease operation with the listing, a `Flutterwave::Bank` object is created for each bank object returned by the API. The `Flutterwave::BankAPI` also comes with some helper methods that help find a bank by code, or by a regex matching the bank's name. An example usage is described below:
+
+```ruby
+client = Flutterwave::Client.new('sample_merchant_key', 'sample_api_key')
+all_banks = client.bank.list
+names_of_all_banks = all_banks.inject([]) { |list, bank| list << bank.name }
+
+p names_of_all_banks # => ["Fidelity Bank", "Heritage"..."Unity Bank"]
+
+# sample for finding a bank by name
+access_bank_code = client.bank.find_by_name('access').code # => '044'
+
+# sample for finding a bank by code
+bank_name = client.bank.find_by_code('058').name # => GTBank Plc
+```
+
+## Mappings (API to Method)
+Each method has the corresponding API link as a comment above the method signature. To access details about the arguments to the method, please see the tests for that class, or visit the API link.
+
+## Development
+
+Run all tests:
+
+    bundle exec rake
+
+Run a single test suite:
+
+    bundle exec rake TEST=test/pay_test.rb
+
+## Contributing
+
+1. Fork it by visiting - https://github.com/0duaht/flutterwave-ruby/fork
+
+2. Create your feature branch
+
+        $ git checkout -b new_feature
+    
+3. Contribute to code
+
+4. Commit changes made
+
+        $ git commit -a -m 'descriptive_message_about_change'
+    
+5. Push to branch created
+
+        $ git push origin new_feature
+    
+6. Then, create a new Pull Request

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "flutterwave"
+
+# 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

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/flutterwave.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flutterwave/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'flutterwave'
+  spec.version       = Flutterwave::VERSION
+  spec.authors       = ['Tobi Oduah']
+  spec.email         = ['tobi.oduah@andela.com']
+
+  spec.summary       = 'Ruby client for interacting with Flutterwave APIs'
+  spec.homepage      = 'https://github.com/0duaht/flutterwave-ruby'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'faker'
+  spec.add_development_dependency 'webmock'
+end

data/lib/flutterwave.rb

@@ -0,0 +1,2 @@
+require 'flutterwave/version'
+require 'flutterwave/client'

data/lib/flutterwave/account.rb

@@ -0,0 +1,161 @@
+require 'flutterwave/response'
+
+module Flutterwave
+  class Account
+    include Flutterwave::Helpers
+    attr_accessor :client, :options
+
+    def initialize(client)
+      @client = client
+    end
+
+    # https://www.flutterwave.com/documentation/alternative-payments-recurrent/#initiate
+    def initiate_recurrent(options = {})
+      @options = options
+
+      request_params = {
+        accountNumber: encrypt(:accountNumber),
+        merchantid: client.merchant_key
+      }
+
+      response = post(
+        Flutterwave::Utils::Constants::ACCOUNT[:initiate_recurrent_url],
+        request_params
+      )
+
+      Flutterwave::Response.new(response)
+    end
+
+    # https://www.flutterwave.com/documentation/alternative-payments-recurrent/#validate
+    def validate_recurrent(options = {})
+      @options = options
+
+      request_params = {
+        accountNumber: encrypt(:accountNumber),
+        otp: encrypt(:otp),
+        reference: encrypt(:reference),
+        billingamount: encrypt(:billingamount),
+        debitnarration: encrypt(:debitnarration),
+        merchantid: client.merchant_key
+      }
+
+      response = post(
+        Flutterwave::Utils::Constants::ACCOUNT[:validate_recurrent_url],
+        request_params
+      )
+
+      Flutterwave::Response.new(response)
+    end
+
+    # https://www.flutterwave.com/documentation/alternative-payments-recurrent/#initiate
+    def charge_recurrent(options = {})
+      @options = options
+
+      request_params = {
+        accountToken: encrypt(:accountToken),
+        billingamount: encrypt(:billingamount),
+        debitnarration: encrypt(:debitnarration),
+        merchantid: client.merchant_key
+      }
+
+      response = post(
+        Flutterwave::Utils::Constants::ACCOUNT[:charge_recurrent_url],
+        request_params
+      )
+
+      Flutterwave::Response.new(response)
+    end
+
+    # https://www.flutterwave.com/documentation/alternative-payments/#charge-ii
+    def charge(options = {})
+      @options = options
+      options[:country] ||= 'NG'
+
+      request_params = {
+        validateoption: encrypt(:validateoption),
+        accountnumber: encrypt(:accountnumber),
+        bankcode: encrypt(:bankcode),
+        amount: encrypt(:amount),
+        currency: encrypt(:currency),
+        firstname: encrypt(:firstname),
+        lastname: encrypt(:lastname),
+        email: encrypt(:email),
+        narration: encrypt(:narration),
+        transactionreference: encrypt(:transactionreference),
+        merchantid: client.merchant_key
+      }
+
+      request_params[:passcode] = encrypt(:passcode) if options[:passcode]
+
+      response = post(
+        Flutterwave::Utils::Constants::ACCOUNT[:charge_url],
+        request_params
+      )
+
+      Flutterwave::Response.new(response)
+    end
+
+    # https://www.flutterwave.com/documentation/alternative-payments/#resend-otp
+    def resend(options = {})
+      @options = options
+
+      request_params = {
+        validateoption: encrypt(:validateoption),
+        transactionreference: encrypt(:transactionreference),
+        merchantid: client.merchant_key
+      }
+
+      response = post(
+        Flutterwave::Utils::Constants::ACCOUNT[:resend_url],
+        request_params
+      )
+
+      Flutterwave::Response.new(response)
+    end
+
+    # https://www.flutterwave.com/documentation/alternative-payments/#validate-ii
+    def validate(options = {})
+      @options = options
+
+      request_params = {
+        otp: encrypt(:otp),
+        transactionreference: encrypt(:transactionreference),
+        merchantid: client.merchant_key
+      }
+
+      response = post(
+        Flutterwave::Utils::Constants::ACCOUNT[:validate_url],
+        request_params
+      )
+
+      Flutterwave::Response.new(response)
+    end
+
+    # https://www.flutterwave.com/documentation/alternative-payments/#validate-ii-alt
+    def alt_validate(options = {})
+      @options = options
+
+      request_params = {
+        otp: encrypt(:otp),
+        phonenumber: encrypt(:phonenumber),
+        merchantid: client.merchant_key
+      }
+
+      response = post(
+        Flutterwave::Utils::Constants::ACCOUNT[:alt_validate_url],
+        request_params
+      )
+
+      Flutterwave::Response.new(response)
+    end
+
+    def encrypt(key)
+      plain_text = options[key].to_s
+      raise Flutterwave::Utils::MissingKeyError.new(
+        "#{key.capitalize} key required!"
+      ) if plain_text.empty?
+
+      encrypt_data(plain_text, client.api_key)
+    end
+  end
+end

data/lib/flutterwave/ach.rb

@@ -0,0 +1,83 @@
+module Flutterwave
+  class ACH
+    include Flutterwave::Helpers
+    attr_accessor :client, :options
+
+    def initialize(client)
+      @client = client
+    end
+
+    # https://www.flutterwave.com/documentation/ach-payments/#get-institutions
+    def list
+      response = post(
+        Flutterwave::Utils::Constants::ACH[:list_url],
+        merchantid: client.merchant_key
+      )
+
+      Flutterwave::Response.new(response)
+    end
+
+    # https://www.flutterwave.com/documentation/ach-payments/#get-institution-by-id
+    def find_by_id(options = {})
+      @options = options
+
+      response = post(
+        Flutterwave::Utils::Constants::ACH[:id_url],
+        institutionid: encrypt(:id),
+        merchantid: client.merchant_key
+      )
+
+      Flutterwave::Response.new(response)
+    end
+
+    # https://www.flutterwave.com/documentation/ach-payments/#add-user
+    def add_user(options = {})
+      @options = options
+
+      request_params = {
+        username: encrypt(:username),
+        password: encrypt(:password),
+        email: encrypt(:email),
+        institution: encrypt(:institution),
+        merchantid: client.merchant_key
+      }
+
+      request_params[:pin] = encrypt(:pin) if options[:pin]
+
+      response = post(
+        Flutterwave::Utils::Constants::ACH[:add_user_url],
+        request_params
+      )
+
+      Flutterwave::Response.new(response)
+    end
+
+    # https://www.flutterwave.com/documentation/ach-payments/#charge
+    def charge(options = {})
+      @options = options
+
+      response = post(
+        Flutterwave::Utils::Constants::ACH[:charge_url],
+        publictoken: encrypt(:publictoken),
+        accountid: encrypt(:accountid),
+        custid: encrypt(:custid),
+        narration: encrypt(:narration),
+        trxreference: encrypt(:trxreference),
+        amount: encrypt(:amount),
+        currency: encrypt(:currency),
+        merchantid: client.merchant_key
+      )
+
+      Flutterwave::Response.new(response)
+    end
+
+    def encrypt(key)
+      plain_text = options[key].to_s
+      raise Flutterwave::Utils::MissingKeyError.new(
+        "#{key.capitalize} key required!"
+      ) if plain_text.empty?
+
+      encrypt_data(plain_text, client.api_key)
+    end
+  end
+end