webirr 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8767fa7d918d0ff92dd7ef661d765a83f1c178c7ac3f71b3863d5ec12e4d3ef0
-  data.tar.gz: a4cdfb5614bffebcee32be661a1b8e444aa0cbd84205323a6e1562b1b80703c5
+  metadata.gz: a58f69399972243af73a6d145553b69620e2e529404d94eebb98cbe74fa5b54c
+  data.tar.gz: e2b79637d60fb9c4b8f605ab2ef5cc2423c45f37b0c4e60d5757847bade732db
 SHA512:
-  metadata.gz: c29b008f7d10eb12c27b7c3631cd50e901c49f7c01e0342f829da71029541e2d21ee80487af62976f3b7801337df83611bc680c2f575c4d21382c87bbfd2b15a
-  data.tar.gz: 533d4af1f858f4cbe466a7ce2ea3924f53c5d026327def0632a90e4fc2abece0e426ce3693fce71d0ad1f6c17c5a4b2171de5c41e3f6386b18ee384ec7c2fa73
+  metadata.gz: 3c535eb9761eb175ce32136cc6dffcb65944dc6323c2fd52edde66d60328253a0ea42de26285e0e552f68223f4b6b73becf26daf8515aa4dfbeb28353bc72648
+  data.tar.gz: aa3ee6f965398424b8e034edafac3824ed0f15d4068285ea5cea5b408d1055038111e36cb00e8ef99d6acc7cb22b8d50d91f15da3a743333dc8ba3253eb892fc

data/CHANGELOG.md

@@ -1,5 +1,3 @@
-## [Unreleased]
-
-## [0.1.0] - 2022-09-06
+## [0.1.3] - 2022-09-06
 
 - Initial release

data/README.md

@@ -1,8 +1,8 @@
 # Webirr
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/webirr`. To experiment with that code, run `bin/console` for an interactive prompt.
+Official Ruby gem for WeBirr Payment Gateway APIs
 
-TODO: Delete this and the text above, and describe your gem
+This gem provides convenient access to WeBirr Payment Gateway APIs from Ruby Applications.
 
 ## Installation
 
@@ -22,7 +22,207 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+The library needs to be configured with a *merchant Id* & *API key*. You can get it by contacting [webirr.com](https://webirr.com)
+
+> You can use this library for production or test environments. you will need to set is_test_env=true for test, and false for production apps when creating objects of class WeBirrClient
+
+## Examples
+### Creating a new Bill / Updating an existing Bill on WeBirr Servers
+
+```rb
+require 'bill'
+require 'webirr_client'
+
+# Create & Update Bill
+def create_bill
+    api_key = 'YOUR_API_KEY'
+    merchant_id = 'YOUR_MERCHANT_ID'
+
+    # client to use test envionment
+    webirr_client = WeBirrClient.new(api_key, true)
+
+    bill = Bill.new
+    bill.amount = "120.45"
+    bill.customer_code = "C001" # it can be email address or phone number if you dont have customer code
+    bill.customer_name = "Yohannes Aregay Hailu"
+    bill.time = "2022-09-06 14:20:26" # your bill time, always in this format
+    bill.description = "Food delivery"
+    bill.bill_reference = "ruby/2022/001" # your unique reference number
+    bill.merchant_id = merchant_id
+
+    puts "\nCreating Bill..."
+
+    res = webirr_client.create_bill(bill)
+
+    if (res["error"].blank?)
+        # success
+        payment_code = res["res"]  # returns paymentcode such as 429 723 975
+        puts "\nPayment Code = #{payment_code}" # we may want to save payment code in local db.
+    else
+        # fail
+        puts "\nerror: #{res["error"]}"
+        puts "\nerrorCode: #{res["errorCode"]}" # can be used to handle specific busines error such as ERROR_INVLAID_INPUT_DUP_REF
+    end
+
+    #pp res
+
+    # Update existing bill if it is not paid
+    bill.amount = "278.00"
+    bill.customer_name = 'John ruby'
+    #bill.bill_reference = "WE CAN NOT CHANGE THIS"
+
+    puts "\nUpdating Bill..."
+
+    res = webirr_client.update_bill(bill)
+
+    if (res["error"].blank?)
+        # success
+        puts "\nbill is updated succesfully" #res.res will be 'OK'  no need to check here!
+    else
+        # fail
+        puts "\nerror: #{res["error"]}"
+        puts "\nerrorCode: #{res["errorCode"]}" # can be used to handle specific busines error such as ERROR_INVLAID_INPUT
+    end
+end
+
+create_bill()
+
+```
+
+
+### Getting Payment status of an existing Bill from WeBirr Servers
+
+```rb
+require 'bill'
+require 'webirr_client'
+
+# Get Payment Status of Bill
+def get_webirr_payment_status
+    api_key = 'YOUR_API_KEY'
+    merchant_id = 'YOUR_MERCHANT_ID'
+
+    # client to use test envionment
+    webirr_client = WeBirrClient.new(api_key, true)
+
+    payment_code = 'PAYMENT_CODE_YOU_SAVED_AFTER_CREATING_A_NEW_BILL'  # suchas as '141 263 782'
+
+    puts "\nGetting Payment Status..."
+
+    res = webirr_client.get_payment_status(payment_code)
+
+    if (res["error"].blank?) 
+        # success
+        if (res["res"]["status"] == 2)
+          data =  res["res"]["data"]
+          puts "\nbill is paid"
+          puts "\nbill payment detail"
+          puts "\nBank: #{data["bankID"]}"
+          puts "\nBank Reference Number: #{data["paymentReference"]}"
+          puts "\nAmount Paid: #{data["amount"]}"
+        else
+          puts "\nbill is pending payment"
+        end
+    else
+        # fail
+        puts "\nerror: #{res["error"]}"
+        puts "\nerrorCode: #{res["errorCode"]}" # can be used to handle specific busines error such as ERROR_INVLAID_INPUT
+    end
+
+    #pp res
+end
+
+get_webirr_payment_status()
+
+```
+
+*Sample object returned from get_payment_status()*
+
+```javascript
+{
+  error: null,
+  res: {
+    status: 2,
+    data: {
+      id: 111112347,
+      paymentReference: '8G3303GHJN',      
+      confirmed: true,
+      confirmedTime: '2021-07-03 10:25:35',
+      bankID: 'cbe_birr',
+      time: '2021-07-03 10:25:33',
+      amount: '4.60',
+      wbcCode: '624 549 955'
+    }
+  },
+  errorCode: null
+}
+
+```
+
+### Getting Payment status of an existing Bill from WeBirr Servers
+
+```rb
+require 'bill'
+require 'webirr_client'
+
+// Get Payment Status of Bill
+def get_webirr_payment_status
+    api_key = 'YOUR_API_KEY'
+    merchant_id = 'YOUR_MERCHANT_ID'
+
+    webirr_client = WeBirrClient.new(api_key, true)
+
+    payment_code = 'PAYMENT_CODE_YOU_SAVED_AFTER_CREATING_A_NEW_BILL'  // suchas as '141 263 782'
+
+    puts "\nGetting Payment Status..."
+
+    res = webirr_client.get_payment_status(payment_code)
+
+    if (res["error"].blank?) 
+        # success
+        if (res["res"]["status"] == 2)
+          data =  res["res"]["data"]
+          puts "\nbill is paid"
+          puts "\nbill payment detail"
+          puts "\nBank: #{data["bankID"]}"
+          puts "\nBank Reference Number: #{data["paymentReference"]}"
+          puts "\nAmount Paid: #{data["amount"]}"
+        else
+          puts "\nbill is pending payment"
+        end
+    else
+        # fail
+        puts "\nerror: #{res["error"]}"
+        puts "\nerrorCode: #{res["errorCode"]}" # can be used to handle specific busines error such as ERROR_INVLAID_INPUT
+    end
+
+    //pp res
+end
+get_webirr_payment_status()
+
+```
+
+*Sample object returned from getPaymentStatus()*
+
+```javascript
+{
+  error: null,
+  res: {
+    status: 2,
+    data: {
+      id: 111112347,
+      paymentReference: '8G3303GHJN',      
+      confirmed: true,
+      confirmedTime: '2021-07-03 10:25:35',
+      bankID: 'cbe_birr',
+      time: '2021-07-03 10:25:33',
+      amount: '4.60',
+      wbcCode: '624 549 955'
+    }
+  },
+  errorCode: null
+}
+
+```
 
 ## Development
 

data/lib/bill.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "json"
 
 class Bill
@@ -9,7 +11,7 @@ class Bill
                 :merchant_id,
                 :time
 
-  def as_json(options = {})
+  def as_json(_options = {})
     {
       customerCode: @customer_code,
       customerName: @customer_name,

data/lib/webirr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Webirr
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/lib/webirr_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "faraday"
 
 class WebirrClient
@@ -6,7 +8,7 @@ class WebirrClient
     @client =
       Faraday.new(
         url:
-          "#{is_test_env ? "https://api.webirr.com/" : "https://api.webirr.com:8080/"}",
+          (is_test_env ? "https://api.webirr.com/einvoice/api/" : "https://api.webirr.com:8080/einvoice/api/").to_s,
         params: {
           "api_key" => @api_key
         },
@@ -18,7 +20,7 @@ class WebirrClient
 
   def create_bill(bill)
     response =
-      @client.post("einvoice/api/postbill") { |req| req.body = bill.to_json }
+      @client.post("postbill") { |req| req.body = bill.to_json }
     if response.success?
       JSON.parse(response.body)
     else
@@ -28,7 +30,7 @@ class WebirrClient
 
   def update_bill(bill)
     response =
-      @client.put("einvoice/api/postbill") { |req| req.body = bill.to_json }
+      @client.put("postbill") { |req| req.body = bill.to_json }
     if response.success?
       JSON.parse(response.body)
     else
@@ -37,7 +39,7 @@ class WebirrClient
   end
 
   def delete_bill(payment_code)
-    response = @client.put("einvoice/api/deletebill?wbc_code=#{payment_code}")
+    response = @client.put("deletebill?wbc_code=#{payment_code}")
     if response.success?
       JSON.parse(response.body)
     else
@@ -47,7 +49,7 @@ class WebirrClient
 
   def get_payment_status(payment_code)
     response =
-      @client.get("einvoice/api/getPaymentStatus?wbc_code=#{payment_code}")
+      @client.get("getPaymentStatus?wbc_code=#{payment_code}")
     if response.success?
       JSON.parse(response.body)
     else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webirr
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Yohannes Aregay
@@ -52,7 +52,7 @@ metadata:
   allowed_push_host: https://rubygems.org/
   homepage_uri: https://github.com/johnhailu/webirr
   source_code_uri: https://github.com/johnhailu/webirr
-  changelog_uri: https://github.com/johnhailu/CHANGELOG.md
+  changelog_uri: https://github.com/johnhailu/webirr/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: