ecocash 1.0.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0c8ebac975bbc7e9a427c34e38853f829ea0c89c118db4c50494905cd6b60e6
-  data.tar.gz: d54e8177603ea06064de132af2589059a00893018d763021d6bbbc457be4883e
+  metadata.gz: 721a42b256abe5bf70c784a85fa40a3e8ccb12d45296df596d3ed12026a26fb8
+  data.tar.gz: bb346238071229f8e4a796f4981874bcb3ada5f6412474e1f50a8b7f1a830252
 SHA512:
-  metadata.gz: 3da1de1ab76cf05ce6f3e9f80d733ec3ffcee1d5c79064491a48c72162500fef590c1a93ddfb1d174b38da4cb43347041bcc45f4cd3d19bb0ebf6a8fd5692389
-  data.tar.gz: ece47ab1ac200a3381b01a0ef005735b84e2179de78fc13f8ab6e0dba06c8675c3914b65b2b27015eb96f52770c78b58ba03a6056f94ea9490da8c0af7184782
+  metadata.gz: 1da95e90829fce195368efd0660c62d4c770eede057a2d569811b361e499101dfae5f1dea89ae6a9975df1fb9008f6cb09bd599253a825ec5b46462451945b12
+  data.tar.gz: 18aa68a07344c842736e42b3c81974e183861f15fe3adae3dceb61ab7b4bd84e14eb0fd6f6caa829ed7baa2684a0ac0ddc3b3e5471d2632d31d870babc2cedc5

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+CONTRIBUTING
+============
+
+Recommended steps when submitting a pull request:
+
+1. Fork the repository.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Write a failing test(using Minitest) to capture existing bug or lack of feature.
+5. Check that tests pass locally.
+6. Commit changes (see [how to write good commits][1]).
+7. Push changes to GitHub.
+8. Check if tests pass on CI.
+9. Submit a Pull Request.
+10. You will get some feedback and may need to push additional commits
+    with more fixes to the same branch; this will update your pull request
+    automatically.
+
+[1]: http://chris.beams.io/posts/git-commit/

data/Gemfile.lock

@@ -1,14 +1,18 @@
 PATH
   remote: .
   specs:
-    ecocash (1.0.0)
+    ecocash (1.2.0)
       httparty (~> 0.16.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    httparty (0.16.2)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
       multi_xml (>= 0.5.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
     minitest (5.11.3)
     multi_xml (0.6.0)
     rake (10.5.0)
@@ -23,4 +27,4 @@ DEPENDENCIES
   rake (~> 10.0)
 
 BUNDLED WITH
-   1.16.6
+   1.17.3

data/README.md

@@ -1,2 +1,107 @@
 # EcoCash Ruby Library
-This library provides developers with convenient access to the EcoCash Instant Payments(EIP) API from applications written in Ruby.
+
+This library provides developers with convenient access to the EcoCash Instant Payments(EIP) API from applications written in Ruby. The EcoCash Online API provides functionality to receive payments directly on your website or easily refund transactions to your customers.
+
+## Documentation
+
+See the [Ruby API docs](https://www.rubydoc.info/gems/ecocash/1.0.0)
+
+## Requirements
+To use the EcoCash Online API, the following things are required:
++ Get yourself a Merchant account from [EcoCash](https://www.ecocash.co.zw/)
++ Apply to be an Online Merchant(This is subject to approval)
++ Now you're ready to use EcoCash Online API
++ In order to accept payments in production mode, your integration will need to be verified by EcoCash.
+
+## Installing
+
+This package is available in RubyGems and can be installed with:
+```shell
+gem install ecocash
+```
+Or import it to your Gemfile
+```ruby
+gem 'ecocash'
+```
+
+## Usage
+```ruby
+require 'ecocash'
+```
+Values you will need from Ecocash
++ Username and password: These are credentials to authenticate the API
++ Merchant number, merchant code and pin: You change PIN on the time of activating your merchant number.
+
+### Configuration
+The library uses a configuration block for easy setup:
+
+```ruby
+Ecocash.configure do |config|
+  config.api_base_url = ENV['API_BASE_URL']
+  #Authentication
+  config.username = ENV['USERNAME'] 
+  config.password = ENV['PASSWORD'] 
+  config.merchant_number =ENV['MERCHANT_NUMBER'] 
+  config.merchant_code = ENV['MERCHANT_CODE'] 
+  config.merchant_pin = ENV['MERCHANT_PIN'] 
+  #Payment information
+  config.description = "Payment description"
+  config.on_behalf_of = "Service description"
+  config.payment_remarks = "Transaction description"
+  config.reference_code = "Transaction reference"
+  config.purchase_category_code = "Online Payment"
+  config.refund_remarks = "Refund transaction description"
+  #Merchant details
+  config.super_merchant_name = ENV['SUPER_MERCHANT_NAME'] 
+  config.merchant_name = ENV['MERCHANT_NAME'] 
+  config.terminal_id = "unique identifier"
+  config.location = "your business physical location"
+  config.notify_url = ENV['YOUR_CALLBACK_URL'] 
+  
+  config.currency_code = "USD"
+  config.country_code = "ZW"
+  #Client Correlator Prefix
+  config.client_correlator_prefix = "any letter(up to 7) to prefix your client correlator"
+end
+```
+
+Initialize the API client
+```ruby
+client = Ecocash::Client.new
+```
+
+### Charge Subscriber
+```ruby
+client.charge_subscriber('subscriber_mobile_number','amount')
+```
+
+### Refund Subscriber
+```ruby
+client.transaction_reversal('subscriber_mobile_number','transaction_id','amount')
+```
+
+### Transaction Status
+```ruby
+client.transaction_status('subscriber_mobile_number','client_correlator')
+```
+
+### List Subscriber Transactions
+```ruby
+client.list_transactions('subscriber_mobile_number')
+```
+
+## API Documentation
+The API document can be obtain from EcoCash upon approval of your application.
+
+## Contributing
+
+Please read [CONTRIBUTING.md](https://github.com/tusomx/ecocash/blob/master/CONTRIBUTING.md) for details and the process for submitting pull requests to us.
+
+## Versioning
+
+We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/tusomx/ecocash/tags). 
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/tusomx/ecocash/blob/master/LICENSE) file for details
+

data/lib/ecocash/client.rb

@@ -45,9 +45,9 @@ module Ecocash
     end
 
     def transaction_status(msisdn, client_correlator)
-      url = "#{Ecocash.configuration.api_base_url}/#{msisdn}/transactions/amount/#{client_correlator}}"
+      url = "#{Ecocash.configuration.api_base_url}/#{msisdn}/transactions/amount/#{client_correlator}"
       options = {
-        basic_auth: self.class.auth,
+        basic_auth: auth,
         headers: { 'Content-Type' => 'application/json' }
       }
       response = self.class.get(url, options)
@@ -108,7 +108,9 @@ module Ecocash
     private
 
     def generated_client_correlator
-      Time.zone.now.strftime('GD%d%m%Y%H%M%S%L%3N')
+      Time.now.strftime(
+        "#{Ecocash.configuration.client_correlator_prefix}%d%m%Y%H%M%S%L%3N"
+      )
     end
 
     def auth

data/lib/ecocash/configuration.rb

@@ -18,7 +18,8 @@ module Ecocash
                   :merchant_name,
                   :purchase_category_code,
                   :description,
-                  :reference_code
+                  :reference_code,
+                  :client_correlator_prefix
 
     def initialize
       @username = nil
@@ -40,6 +41,7 @@ module Ecocash
       @purchase_category_code = nil
       @description = nil
       @reference_code = nil
+      @client_correlator_prefix = nil
     end
   end
 end

data/lib/ecocash/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ecocash
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kudzai Tuso
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-04 00:00:00.000000000 Z
+date: 2020-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -77,6 +77,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -110,8 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Ruby wrapper for EcoCash API