bukku_rails 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ed6bf94470a82481cf4506e9fa920743bbbb0b54623e964a07e41de1a78a107
-  data.tar.gz: f8db6a422b83fb3ee350ad36f9f4ab469e9f6aaa577523175ab4f040200da021
+  metadata.gz: a006616b833583b37331723b5905afbb2db5d1486a43e7d737e7163aa9146db2
+  data.tar.gz: '08b80379615978eb56a083e2bc6bdd6d886d5e7fc3f18734e07b47af78a09f31'
 SHA512:
-  metadata.gz: 9043be0a8e7b4c69ee501a6da75ab2ed04b560a12032ff282ab13baf8ed174417c5ab71aa6d5093e46b46107619f7b39c5423383fc5f98f8f2c037d940af1edf
-  data.tar.gz: d05253cf61d9c6b4c8d5a8dc57bb65e652d14e8cbcdc29924672f893b5a8c1eb888363ace0d4ae534928713175bfd11762523cba13d3303e50dd1190e9eac58e
+  metadata.gz: 71aae60f0f3f73cac249a5596be4fac6b2e983a0bc96fc03230af12a5f2c18de534021d6908bdc13016b8ef95735acf7035ed105b94f2d2daaf9eb4a265e6b7f
+  data.tar.gz: 1b4bea76f7e23fd4f2b87188faa5c5285f86c31e189b9af60c7e39ebce38001f9dd9137ff72bf4fa064a7e69526efa823e30af527acf9ab231d5a13e19706ff6

data/README.md

@@ -1,10 +1,10 @@
 # BukkuRails
 
-Use Rails methods to interact with your data in [Bukku](https://bukku.my/) accounting software. 
+Use Rails methods to interact with your data in [Bukku](https://bukku.my/) accounting software.
 
-Take a look at [Bukku's API](https://developers.bukku.my) to know what data you can extract from Bukku. 
+Take a look at [Bukku's API](https://developers.bukku.my) to know what data you can extract from Bukku.
 
-> As of December 2, 2025, the gem only handles **GET** request. If you require other request, fork the gem and write it and then send us a Pull Request. 
+> As of December 2, 2025, the gem only handles **GET** request. If you require other request, fork the gem and write it and then send us a Pull Request.
 
 ## Installation
 
@@ -14,36 +14,17 @@ Add the gen into your Gemfile like so:
 
 ## Usage
 
-You will need 2 things - your **subdomain** and **API Token**. 
+You will need 2 things - your **subdomain** and **API Token**.
 
-You can get these after you login into your Bukku account, Control Panel -> Integrations -> Turn ON API Access. 
+You can get these after you login into your Bukku account, Control Panel -> Integrations -> Turn ON API Access.
 
-Note: Bukku offers 2 type of access - Staging and Production. You can [email Bukku](mailto:dev@bukku.my) for a Staging account which will be great to test your Rails app if it is extracting the correct data from Bukku. Once you are satisfied you can then use access the Production server where your actual data lives. 
+Note: Bukku offers 2 type of access - Staging and Production. You can [email Bukku](mailto:dev@bukku.my) for a Staging account which will be a great way to test your Rails app to see if it is extracting the correct data from Bukku's staging server (exactly the same app but at their staging server). Once you are satisfied you can then use access the Production server where your actual data lives.
 
-**Bukku Rails** provides usage for both access. For Staging use the `BukkuTest` class and actual production simply use `Bukku` class. Then you can use any of the methods listed in the table below: 
-
-### Setup
-For Staging
-```ruby
-# Initialize the client
-client = BukkuTest.new(
-  token: "your_bukku_api_token",
-  domain: "your_company_subdomain"
-)
-```
-
-For Production
-```ruby
-# Initialize the client
-client = Bukku.new(
-  token: "your_bukku_api_token",
-  domain: "your_company_subdomain"
-)
-```
+**Bukku Rails** provides usage for both access. For Staging use the `BukkuTest` class and actual Production simply use `Bukku` class. Then you can use any of the methods listed in the table below:
 
 ### Available Methods
 
-Just like in Rails the methods follow the singular and plural expression. Methods with arguments are normally plural, while methods without arguments are singular methods calls. 
+Just like in Rails the methods follow the singular and plural expression. Methods with arguments are normally plural, while methods without arguments are singular methods calls.
 
 #### Sales
 
@@ -114,30 +95,52 @@ Just like in Rails the methods follow the singular and plural expression. Method
 
 | HTTP Method | Ruby Method | Endpoint |
 |------------|-------------|----------|
-| GET | `journal_entries(**kwargs)` | `/journal_entries` |
-| GET | `journal_entry(id)` | `/journal_entries/:id` |
-| GET | `accounts` | `/accounts` |
-| GET | `account(id)` | `/accounts/:id` |
+| GET | `get_journal_entries(**kwargs)` | `/journal_entries` |
+| GET | `get_journal_entry(id)` | `/journal_entries/:id` |
+| GET | `get_accounts` | `/accounts` |
+| GET | `get_account(id)` | `/accounts/:id` |
 
 ### Examples
 
+To use the gem you will need to initialize a client first. Either choose a Bukku's Staging or Production server to test your app.
+
+For Staging at <https://api.bukku.fyi>
+
+```ruby
+client = BukkuTest.new(
+  token: "your_bukku_api_token",
+  domain: "your_company_subdomain"
+)
+```
+
+For Production at <https://api.bukku.my>
+
+```ruby
+client = Bukku.new(
+  token: "your_bukku_api_token",
+  domain: "your_company_subdomain"
+)
+```
+
 **Fetch all invoices:**
+
 ```ruby
 invoices = client.get_invoices
 ```
 
 **Fetch invoices with date filters or parameters:**
 To know more on what Query Parameters is acceptable head to [Bukku API page](https://developers.bukku.my)
+
 ```ruby
 invoices = client.get_invoices(date_from: "2025-11-01", date_to: "2025-11-30")
 ```
 
 **Fetch a specific invoice:**
+
 ```ruby
 invoice = client.get_invoice(123)
 ```
 
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/stopar/bukku_rails>.

data/lib/bukku.rb

@@ -193,20 +193,20 @@ class Bukku < Client
 
   ## ACCOUNTING
   # Journal Entries
-  def journal_entries(**kwargs)
+  def get_journal_entries(**kwargs)
     get '/journal_entries', query: kwargs
   end
 
-  def journal_entry(id)
+  def get_journal_entry(id)
     get "/journal_entries/#{id}"
   end
 
   # Account
-  def accounts
+  def get_accounts
     get '/accounts'
   end
 
-  def account(id)
+  def get_account(id)
     get "/accounts/#{id}"
   end
 end

data/lib/bukku_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BukkuRails
-  VERSION = "0.1.0"
+  VERSION = '0.1.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bukku_rails
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors:
 - Muzaffar Ariff
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-12-03 00:00:00.000000000 Z
+date: 2025-12-11 00:00:00.000000000 Z
 dependencies: []
 description: Use Rails conventions to call Bukku API requests.
 email: