ecocash 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0c8ebac975bbc7e9a427c34e38853f829ea0c89c118db4c50494905cd6b60e6
+  data.tar.gz: d54e8177603ea06064de132af2589059a00893018d763021d6bbbc457be4883e
+SHA512:
+  metadata.gz: 3da1de1ab76cf05ce6f3e9f80d733ec3ffcee1d5c79064491a48c72162500fef590c1a93ddfb1d174b38da4cb43347041bcc45f4cd3d19bb0ebf6a8fd5692389
+  data.tar.gz: ece47ab1ac200a3381b01a0ef005735b84e2179de78fc13f8ab6e0dba06c8675c3914b65b2b27015eb96f52770c78b58ba03a6056f94ea9490da8c0af7184782

data/.gitignore

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

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  Style/Documentation:
+  Enabled: false
+
+  Metrics/ClassLength:
+    Enabled: false
+
+  Metrics/MethodLength:
+    Enabled: false
+
+  Metrics/ModuleLength:
+    Enabled: false
+
+  Layout/IndentArray:
+    EnforcedStyle: consistent
+
+  Layout/EmptyLinesAroundBlockBody:
+    EnforcedStyle: no_empty_lines
+    Enabled: true
+
+  Layout/EmptyLinesAroundClassBody:
+    EnforcedStyle: no_empty_lines
+    Enabled: true
+
+  Layout/EmptyLinesAroundModuleBody:
+    EnforcedStyle: no_empty_lines

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in ecocash.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,26 @@
+PATH
+  remote: .
+  specs:
+    ecocash (1.0.0)
+      httparty (~> 0.16.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.16.2)
+      multi_xml (>= 0.5.2)
+    minitest (5.11.3)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ecocash!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.6

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Maxwell Tuso
+
+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,2 @@
+# EcoCash Ruby Library
+This library provides developers with convenient access to the EcoCash Instant Payments(EIP) API from applications written in Ruby.

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 'ecocash'
+
+# 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/ecocash.gemspec

@@ -0,0 +1,37 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ecocash/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ecocash"
+  spec.version       = Ecocash::VERSION
+  spec.authors       = ["Kudzai Tuso"]
+  spec.email         = ["tusomx@gmail.com"]
+
+  spec.summary       = %q{Ruby wrapper for EcoCash API}
+  spec.description   = %q{EcoCash is the easiest way to accept mobile payments online. See https://ecocash.co.zw for more details.}
+  spec.homepage      = "https://github.com/tusomx/ecocash"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "httparty", "~> 0.16.2"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/ecocash.rb

@@ -0,0 +1,22 @@
+require 'httparty'
+require 'ecocash/configuration'
+require 'ecocash/client'
+require 'ecocash/version'
+
+module Ecocash
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
+end

data/lib/ecocash/client.rb

@@ -0,0 +1,121 @@
+module Ecocash
+  class Client
+    include HTTParty
+
+    def charge_subscriber(msisdn, amount)
+      url = "#{Ecocash.configuration.api_base_url}/transactions/amount"
+      args = {
+        clientCorrelator: generated_client_correlator,
+        notifyUrl: Ecocash.configuration.notify_url,
+        referenceCode: Ecocash.configuration.reference_code,
+        tranType: 'MER',
+        endUserId: msisdn,
+        remarks: Ecocash.configuration.payment_remarks,
+        transactionOperationStatus: 'CHARGED',
+        paymentAmount: {
+          charginginformation: {
+            amount: amount,
+            currency: Ecocash.configuration.currency_code,
+            description: Ecocash.configuration.description
+          },
+          chargeMetaData: {
+            channel: 'WEB',
+            purchaseCategoryCode: Ecocash.configuration.purchase_category_code,
+            onBeHalfOf: Ecocash.configuration.on_behalf_of
+          }
+        },
+        merchantCode: Ecocash.configuration.merchant_code,
+        merchantPin: Ecocash.configuration.merchant_pin,
+        merchantNumber: Ecocash.configuration.merchant_number,
+        currencyCode: Ecocash.configuration.currency_code,
+        countryCode: Ecocash.configuration.country_code,
+        terminalID: Ecocash.configuration.terminal_id,
+        location: Ecocash.configuration.location,
+        superMerchantName: Ecocash.configuration.super_merchant_name,
+        merchantName: Ecocash.configuration.merchant_name
+      }.to_json
+
+      options = {
+        body: args,
+        basic_auth: auth,
+        headers: { 'Content-Type' => 'application/json' }
+      }
+      response = self.class.post(url, options)
+      JSON.parse(response.body)
+    end
+
+    def transaction_status(msisdn, client_correlator)
+      url = "#{Ecocash.configuration.api_base_url}/#{msisdn}/transactions/amount/#{client_correlator}}"
+      options = {
+        basic_auth: self.class.auth,
+        headers: { 'Content-Type' => 'application/json' }
+      }
+      response = self.class.get(url, options)
+      JSON.parse(response.body)
+    end
+
+    def list_transactions(msisdn)
+      url = "#{Ecocash.configuration.api_base_url}/#{msisdn}/transactions"
+      options = {
+        basic_auth: auth,
+        headers: { 'Content-Type' => 'application/json' }
+      }
+      response = self.class.get(url, options)
+      JSON.parse(response.body)
+    end
+
+    def transaction_reversal(msisdn, transaction_id, amount)
+      url = "#{Ecocash.configuration.api_base_url}/transactions/refund"
+      args = {
+        clientCorrelator: generated_client_correlator,
+        referenceCode: Ecocash.configuration.reference_code,
+        tranType: 'REF',
+        endUserId: msisdn,
+        originalEcocashReference: transaction_id,
+        remark: Ecocash.configuration.refund_remarks,
+        paymentAmount: {
+          charginginformation: {
+            amount: amount,
+            currency: Ecocash.configuration.currency_code,
+            description: Ecocash.configuration.description
+          },
+          chargeMetaData: {
+            channel: 'SMS',
+            purchaseCategoryCode: Ecocash.configuration.purchase_category_code,
+            onBeHalfOf: Ecocash.configuration.on_behalf_of
+          }
+        },
+        merchantCode: Ecocash.configuration.merchant_code,
+        merchantPin: Ecocash.configuration.merchant_pin,
+        merchantNumber: Ecocash.configuration.merchant_number,
+        currencyCode: Ecocash.configuration.currency_code,
+        countryCode: Ecocash.configuration.country_code,
+        terminalID: Ecocash.configuration.terminal_id,
+        location: cocash.configuration.location,
+        superMerchantName: Ecocash.configuration.super_merchant_name,
+        merchantName: Ecocash.configuration.merchant_name
+      }.to_json
+
+      options = {
+        body: args,
+        basic_auth: auth,
+        headers: { 'Content-Type' => 'application/json' }
+      }
+      response = self.class.post(url, options)
+      JSON.parse(response.body)
+    end
+
+    private
+
+    def generated_client_correlator
+      Time.zone.now.strftime('GD%d%m%Y%H%M%S%L%3N')
+    end
+
+    def auth
+      {
+        username: Ecocash.configuration.username,
+        password: Ecocash.configuration.password
+      }
+    end
+  end
+end

data/lib/ecocash/configuration.rb

@@ -0,0 +1,45 @@
+module Ecocash
+  class Configuration
+    attr_accessor :username,
+                  :password,
+                  :notify_url,
+                  :payment_remarks,
+                  :refund_remarks,
+                  :on_behalf_of,
+                  :merchant_code,
+                  :merchant_pin,
+                  :merchant_number,
+                  :country_code,
+                  :api_base_url,
+                  :currency_code,
+                  :terminal_id,
+                  :location,
+                  :super_merchant_name,
+                  :merchant_name,
+                  :purchase_category_code,
+                  :description,
+                  :reference_code
+
+    def initialize
+      @username = nil
+      @password = nil
+      @notify_url = nil
+      @refund_remarks = nil
+      @payment_remarks = nil
+      @on_behalf_of = nil
+      @merchant_code = nil
+      @merchant_pin = nil
+      @merchant_number = nil
+      @country_code = nil
+      @api_base_url = nil
+      @currency_code = nil
+      @terminal_id = nil
+      @location = nil
+      @super_merchant_name = nil
+      @merchant_name = nil
+      @purchase_category_code = nil
+      @description = nil
+      @reference_code = nil
+    end
+  end
+end

data/lib/ecocash/version.rb

@@ -0,0 +1,3 @@
+module Ecocash
+  VERSION = '1.0.0'.freeze
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: ecocash
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kudzai Tuso
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-11-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: EcoCash is the easiest way to accept mobile payments online. See https://ecocash.co.zw
+  for more details.
+email:
+- tusomx@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ecocash.gemspec
+- lib/ecocash.rb
+- lib/ecocash/client.rb
+- lib/ecocash/configuration.rb
+- lib/ecocash/version.rb
+homepage: https://github.com/tusomx/ecocash
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tusomx/ecocash
+  source_code_uri: https://github.com/tusomx/ecocash
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for EcoCash API
+test_files: []