webirr 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8767fa7d918d0ff92dd7ef661d765a83f1c178c7ac3f71b3863d5ec12e4d3ef0
-  data.tar.gz: a4cdfb5614bffebcee32be661a1b8e444aa0cbd84205323a6e1562b1b80703c5
+  metadata.gz: d3c0cc887b42d61cbfe75ecb0f01cb1786a9939375ebaa2c3aaf4a2450295219
+  data.tar.gz: 4f51f4a4ccb1f7017a99b11122861571b5d5f934daf269c281bdf20e23637db4
 SHA512:
-  metadata.gz: c29b008f7d10eb12c27b7c3631cd50e901c49f7c01e0342f829da71029541e2d21ee80487af62976f3b7801337df83611bc680c2f575c4d21382c87bbfd2b15a
-  data.tar.gz: 533d4af1f858f4cbe466a7ce2ea3924f53c5d026327def0632a90e4fc2abece0e426ce3693fce71d0ad1f6c17c5a4b2171de5c41e3f6386b18ee384ec7c2fa73
+  metadata.gz: 3c44c63531e08b3e8ead77a290fd9b7c955c1344cd0e28b434afca667ec32129c3e1aca551b127e5c219b2be2ef906502c6f379b58c1a8a795506265652e6f38
+  data.tar.gz: 4a9b4eed7e56fcb3b64c97c35dccbf5c2304f7f44cfa54fe7cd4a42f538f64725fd6fd339e1009f124e2e489b722a4b45d0132c3210efb4afd0fc7dcc14eb03a

data/CHANGELOG.md

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

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    webirr (0.1.0)
+    webirr (0.1.5)
+      faraday (~> 2.5)
 
 GEM
   remote: https://rubygems.org/
@@ -53,7 +54,6 @@ PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
-  faraday (~> 2.5)
   rake (~> 13.0)
   rspec (~> 3.0)
   rubocop (~> 1.21)

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 WeBirr::Client
+
+## Examples
+### Creating a new Bill / Updating an existing Bill on WeBirr Servers
+
+```rb
+require 'webirr/bill'
+require 'webirr/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 = WeBirr::Client.new(api_key, true)
+
+    bill = Webirr::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 'webirr/bill'
+require 'webirr/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 = WeBirr::Client.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 'webirr/bill'
+require 'webirr/webirr_client'
+
+// Get Payment Status of Webirr::Bill
+def get_webirr_payment_status
+    api_key = 'YOUR_API_KEY'
+    merchant_id = 'YOUR_MERCHANT_ID'
+
+    webirr_client = WeBirr::Client.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/webirr/bill.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Webirr
+  class Bill
+    attr_accessor :customer_code,
+                  :customer_name,
+                  :amount,
+                  :description,
+                  :bill_reference,
+                  :merchant_id,
+                  :time
+
+    def as_json(_options = {})
+      {
+        customerCode: @customer_code,
+        customerName: @customer_name,
+        amount: @amount,
+        description: @description,
+        billReference: @bill_reference,
+        merchantID: @merchant_id,
+        time: @time
+      }
+    end
+
+    def to_json(*options)
+      as_json(*options).to_json(*options)
+    end
+  end
+end

data/lib/webirr/client.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module Webirr
+  class Client
+    def initialize(api_key, is_test_env)
+      @api_key = api_key
+      @client =
+        Faraday.new(
+          url:
+            (is_test_env ? "https://api.webirr.com/" : "https://api.webirr.com:8080/").to_s,
+          params: {
+            "api_key" => @api_key
+          },
+          headers: {
+            "Content-Type" => "application/json"
+          }
+        )
+    end
+
+    def create_bill(bill)
+      response =
+        @client.post("einvoice/api/postbill") { |req| req.body = bill.to_json }
+      if response.success?
+        JSON.parse(response.body)
+      else
+        { "error" => "http error #{response.status} #{response.reason_phrase}" }
+      end
+    end
+
+    def update_bill(bill)
+      response =
+        @client.put("einvoice/api/postbill") { |req| req.body = bill.to_json }
+      if response.success?
+        JSON.parse(response.body)
+      else
+        { "error" => "http error #{response.status} #{response.reason_phrase}" }
+      end
+    end
+
+    def delete_bill(payment_code)
+      response = @client.put("einvoice/api/deletebill?wbc_code=#{payment_code}")
+      if response.success?
+        JSON.parse(response.body)
+      else
+        { "error" => "http error #{response.status} #{response.reason_phrase}" }
+      end
+    end
+
+    def get_payment_status(payment_code)
+      response =
+        @client.get("einvoice/api/getPaymentStatus?wbc_code=#{payment_code}")
+      if response.success?
+        JSON.parse(response.body)
+      else
+        { "error" => "http error #{response.status} #{response.reason_phrase}" }
+      end
+    end
+
+    def get_stat
+      response = @client.get("merchant/stat")
+      if response.success?
+        JSON.parse(response.body)
+      else
+        { "error" => "http error #{response.status} #{response.reason_phrase}" }
+      end
+    end
+  end
+end

data/lib/webirr/version.rb

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

data/webirr.gemspec

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative "lib/webirr/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "webirr"
+  spec.version = Webirr::VERSION
+  spec.authors = ["Yohannes Aregay"]
+  spec.email = ["emailtoyohannes@gmail.com"]
+
+  spec.summary = "Official Ruby Client Library for WeBirr Payment Gateway APIs"
+  spec.description = "Official Ruby Client Library for WeBirr Payment Gateway APIs"
+  spec.homepage = "https://github.com/johnhailu/webirr"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/johnhailu/webirr"
+  spec.metadata["changelog_uri"] = "https://github.com/johnhailu/webirr/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "faraday", "~> 2.5"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webirr
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.5
 platform: ruby
 authors:
 - Yohannes Aregay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-06 00:00:00.000000000 Z
+date: 2022-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -40,11 +40,12 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/bill.rb
 - lib/webirr.rb
+- lib/webirr/bill.rb
+- lib/webirr/client.rb
 - lib/webirr/version.rb
-- lib/webirr_client.rb
 - sig/webirr.rbs
+- webirr.gemspec
 homepage: https://github.com/johnhailu/webirr
 licenses:
 - MIT
@@ -52,7 +53,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:

data/lib/bill.rb

@@ -1,27 +0,0 @@
-require "json"
-
-class Bill
-  attr_accessor :customer_code,
-                :customer_name,
-                :amount,
-                :description,
-                :bill_reference,
-                :merchant_id,
-                :time
-
-  def as_json(options = {})
-    {
-      customerCode: @customer_code,
-      customerName: @customer_name,
-      amount: @amount,
-      description: @description,
-      billReference: @bill_reference,
-      merchantID: @merchant_id,
-      time: @time
-    }
-  end
-
-  def to_json(*options)
-    as_json(*options).to_json(*options)
-  end
-end

data/lib/webirr_client.rb

@@ -1,57 +0,0 @@
-require "faraday"
-
-class WebirrClient
-  def initialize(api_key, is_test_env)
-    @api_key = api_key
-    @client =
-      Faraday.new(
-        url:
-          "#{is_test_env ? "https://api.webirr.com/" : "https://api.webirr.com:8080/"}",
-        params: {
-          "api_key" => @api_key
-        },
-        headers: {
-          "Content-Type" => "application/json"
-        }
-      )
-  end
-
-  def create_bill(bill)
-    response =
-      @client.post("einvoice/api/postbill") { |req| req.body = bill.to_json }
-    if response.success?
-      JSON.parse(response.body)
-    else
-      { "error" => "http error #{response.status} #{response.reason_phrase}" }
-    end
-  end
-
-  def update_bill(bill)
-    response =
-      @client.put("einvoice/api/postbill") { |req| req.body = bill.to_json }
-    if response.success?
-      JSON.parse(response.body)
-    else
-      { "error" => "http error #{response.status} #{response.reason_phrase}" }
-    end
-  end
-
-  def delete_bill(payment_code)
-    response = @client.put("einvoice/api/deletebill?wbc_code=#{payment_code}")
-    if response.success?
-      JSON.parse(response.body)
-    else
-      { "error" => "http error #{response.status} #{response.reason_phrase}" }
-    end
-  end
-
-  def get_payment_status(payment_code)
-    response =
-      @client.get("einvoice/api/getPaymentStatus?wbc_code=#{payment_code}")
-    if response.success?
-      JSON.parse(response.body)
-    else
-      { "error" => "http error #{response.status} #{response.reason_phrase}" }
-    end
-  end
-end