webirr 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a58f69399972243af73a6d145553b69620e2e529404d94eebb98cbe74fa5b54c
-  data.tar.gz: e2b79637d60fb9c4b8f605ab2ef5cc2423c45f37b0c4e60d5757847bade732db
+  metadata.gz: d3c0cc887b42d61cbfe75ecb0f01cb1786a9939375ebaa2c3aaf4a2450295219
+  data.tar.gz: 4f51f4a4ccb1f7017a99b11122861571b5d5f934daf269c281bdf20e23637db4
 SHA512:
-  metadata.gz: 3c535eb9761eb175ce32136cc6dffcb65944dc6323c2fd52edde66d60328253a0ea42de26285e0e552f68223f4b6b73becf26daf8515aa4dfbeb28353bc72648
-  data.tar.gz: aa3ee6f965398424b8e034edafac3824ed0f15d4068285ea5cea5b408d1055038111e36cb00e8ef99d6acc7cb22b8d50d91f15da3a743333dc8ba3253eb892fc
+  metadata.gz: 3c44c63531e08b3e8ead77a290fd9b7c955c1344cd0e28b434afca667ec32129c3e1aca551b127e5c219b2be2ef906502c6f379b58c1a8a795506265652e6f38
+  data.tar.gz: 4a9b4eed7e56fcb3b64c97c35dccbf5c2304f7f44cfa54fe7cd4a42f538f64725fd6fd339e1009f124e2e489b722a4b45d0132c3210efb4afd0fc7dcc14eb03a

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

@@ -24,14 +24,14 @@ Or install it yourself as:
 
 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
+> 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 'bill'
-require 'webirr_client'
+require 'webirr/bill'
+require 'webirr/webirr_client'
 
 # Create & Update Bill
 def create_bill
@@ -39,9 +39,9 @@ def create_bill
     merchant_id = 'YOUR_MERCHANT_ID'
 
     # client to use test envionment
-    webirr_client = WeBirrClient.new(api_key, true)
+    webirr_client = WeBirr::Client.new(api_key, true)
 
-    bill = Bill.new
+    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"
@@ -93,8 +93,8 @@ create_bill()
 ### Getting Payment status of an existing Bill from WeBirr Servers
 
 ```rb
-require 'bill'
-require 'webirr_client'
+require 'webirr/bill'
+require 'webirr/webirr_client'
 
 # Get Payment Status of Bill
 def get_webirr_payment_status
@@ -102,7 +102,7 @@ def get_webirr_payment_status
     merchant_id = 'YOUR_MERCHANT_ID'
 
     # client to use test envionment
-    webirr_client = WeBirrClient.new(api_key, true)
+    webirr_client = WeBirr::Client.new(api_key, true)
 
     payment_code = 'PAYMENT_CODE_YOU_SAVED_AFTER_CREATING_A_NEW_BILL'  # suchas as '141 263 782'
 
@@ -161,15 +161,15 @@ get_webirr_payment_status()
 ### Getting Payment status of an existing Bill from WeBirr Servers
 
 ```rb
-require 'bill'
-require 'webirr_client'
+require 'webirr/bill'
+require 'webirr/webirr_client'
 
-// Get Payment Status of Bill
+// Get Payment Status of Webirr::Bill
 def get_webirr_payment_status
     api_key = 'YOUR_API_KEY'
     merchant_id = 'YOUR_MERCHANT_ID'
 
-    webirr_client = WeBirrClient.new(api_key, true)
+    webirr_client = WeBirr::Client.new(api_key, true)
 
     payment_code = 'PAYMENT_CODE_YOU_SAVED_AFTER_CREATING_A_NEW_BILL'  // suchas as '141 263 782'
 

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.4"
+  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.4
+  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

data/lib/bill.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-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,59 +0,0 @@
-# frozen_string_literal: true
-
-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/einvoice/api/" : "https://api.webirr.com:8080/einvoice/api/").to_s,
-        params: {
-          "api_key" => @api_key
-        },
-        headers: {
-          "Content-Type" => "application/json"
-        }
-      )
-  end
-
-  def create_bill(bill)
-    response =
-      @client.post("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("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("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("getPaymentStatus?wbc_code=#{payment_code}")
-    if response.success?
-      JSON.parse(response.body)
-    else
-      { "error" => "http error #{response.status} #{response.reason_phrase}" }
-    end
-  end
-end