bukku_rails 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c67f4ffcd9e8bb2bba1d68c241003ba09ade70e0e7b5006a01373d047b4cf5e9
-  data.tar.gz: aa4ae29f71918a76fcdab8ac286752dd5b8f4ad9ae79fb4089b2da95c5f5e4bf
+  metadata.gz: 565be27afe248599db5d33a723aaa9a5ad9c57bc25ffab1b7f8e0f9a91fb5bf5
+  data.tar.gz: cccbcfb3e2dbdef04b6d851f9504b31f93e5c897e2a198a680a9a2f863e671c6
 SHA512:
-  metadata.gz: cacbd80c9079264a39ac0426777de2d9110e974599768585685066f6cc04e2acec4fb371562b49759d6ff91385d91f3f05132b96c2b3580139aa69782dc1a868
-  data.tar.gz: 034b19b90d92d54f5f6361b8ba977b39a4c00d5a727fcb970e2cab6191fda237f87d9d29513bea1f51a5d976d053c676a21721643429a820b7e646af0064c922
+  metadata.gz: 01d76b79443c4113cfe1bc605cffea51bf241b9d69f6a98c1b10185939164d8aa75ca39d68ab5ea53d84f63d007883109993fa4188b99a7dff7d9e08424f709f
+  data.tar.gz: 0b017d34db3dbe0cfef610aadcf14e2e1dc7987b73aecb1ac179463000569b69fa1a3495f6663a6c68c945ade9242a6972741ee75eaaa37d04cc470d0eed5fe5

data/README.md

@@ -4,7 +4,7 @@ Use Rails methods to interact with your data in [Bukku](https://bukku.my/) accou
 
 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 February 2026, the gem handles **GET**, **POST**, and **file upload** requests.
 
 ## Installation
 
@@ -36,13 +36,15 @@ Note: Bukku offers 2 type of access:
 
 **Bukku Rails** provides usage for both access, under 2 different classes:
 
-1. *Staging* use the `BukkuTest` class, like so `client = BukkuTest.new(domain: "sub-domain", token: "token-from-bukku-fyi")`
+1. *Staging* use the `BukkuTest` class, like so
+`client = BukkuTest.new(domain: "sub-domain", token: "api-token-from-bukku-fyi")`
 
-2. *Production* use `Bukku` class, like so `client = Bukku.new(domain: "sub-domain", token: "token-from-bukku-my")`
+2. *Production* use `Bukku` class, like so
+`client = Bukku.new(domain: "sub-domain", token: "api-token-from-bukku-my")`
 
 ### 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 that might return multiple records are plural expression methods. While methods that returns or create a single records are singular methods. So be careful where you put your ***s***'s 😁
 
 #### Sales
 
@@ -50,18 +52,25 @@ Just like in Rails the methods follow the singular and plural expression. Method
 |------------|-------------|----------|
 | GET | `get_sales_quotes(query-parameters)` | `/sales/quotes` |
 | GET | `get_sales_quote(id)` | `/sales/quotes/:id` |
+| POST | `create_quote(body:)` | `/sales/quotes` |
 | GET | `get_sales_orders(query-parameters)` | `/sales/orders` |
 | GET | `get_sales_order(id)` | `/sales/orders/:id` |
+| POST | `create_sales_order(body:)` | `/sales/orders` |
 | GET | `get_delivery_orders(query-parameters)` | `/sales/delivery_orders` |
 | GET | `get_delivery_order(id)` | `/sales/delivery_orders/:id` |
+| POST | `create_delivery_order(body:)` | `/sales/delivery_orders` |
 | GET | `get_invoices(query-parameters)` | `/sales/invoices` |
 | GET | `get_invoice(id)` | `/sales/invoices/:id` |
+| POST | `create_invoice(body:)` | `/sales/invoices` |
 | GET | `get_sales_credit_notes(query-parameters)` | `/sales/credit_notes` |
 | GET | `get_sales_credit_note(id)` | `/sales/credit_notes/:id` |
+| POST | `create_credit_note(body:)` | `/sales/credit_notes` |
 | GET | `get_sales_payments(query-parameters)` | `/sales/payments` |
 | GET | `get_sales_payment(id)` | `/sales/payments/:id` |
+| POST | `create_payment(body:)` | `/sales/payments` |
 | GET | `get_sales_refunds(query-parameters)` | `/sales/refunds` |
 | GET | `get_sales_refund(id)` | `/sales/refunds/:id` |
+| POST | `create_refund(body:)` | `/sales/refunds` |
 
 #### Purchases
 
@@ -69,16 +78,22 @@ Just like in Rails the methods follow the singular and plural expression. Method
 |------------|-------------|----------|
 | GET | `get_purchase_orders(query-parameters)` | `/purchases/orders` |
 | GET | `get_purchase_order(id)` | `/purchases/orders/:id` |
+| POST | `create_purchase_order(body:)` | `/purchases/orders` |
 | GET | `get_received_notes(query-parameters)` | `/purchases/goods_received_notes` |
 | GET | `get_received_note(id)` | `/purchases/goods_received_notes/:id` |
+| POST | `create_received_note(body:)` | `/purchases/goods_received_notes` |
 | GET | `get_bills(query-parameters)` | `/purchases/bills` |
 | GET | `get_bill(id)` | `/purchases/bills/:id` |
+| POST | `create_bill(body:)` | `/purchases/bills` |
 | GET | `get_purchases_credit_notes(query-parameters)` | `/purchases/credit_notes` |
 | GET | `get_purchases_credit_note(id)` | `/purchases/credit_notes/:id` |
+| POST | `create_purchase_credit_note(body:)` | `/purchases/credit_note` |
 | GET | `get_purchases_payments(query-parameters)` | `/purchases/payments` |
-| GET | `get_purchases_payments(id)` | `/purchases/payments/:id` |
+| GET | `get_purchases_payment(id)` | `/purchases/payments/:id` |
+| POST | `create_purchases_payment(body:)` | `/purchases/payments` |
 | GET | `get_purchases_refunds(query-parameters)` | `/purchases/refunds` |
 | GET | `get_purchases_refund(id)` | `/purchases/refunds/:id` |
+| POST | `create_purchases_refund(body:)` | `/purchases/refunds` |
 
 #### Banking
 
@@ -86,10 +101,13 @@ Just like in Rails the methods follow the singular and plural expression. Method
 |------------|-------------|----------|
 | GET | `get_banking_incomes(query-parameters)` | `/banking/incomes` |
 | GET | `get_banking_income(id)` | `/banking/incomes/:id` |
+| POST | `create_banking_income(body:)` | `/banking/incomes` |
 | GET | `get_banking_expenses(query-parameters)` | `/banking/expenses` |
 | GET | `get_banking_expense(id)` | `/banking/expenses/:id` |
+| POST | `create_expense(body:)` | `/banking/expenses` |
 | GET | `get_transfers(query-parameters)` | `/banking/transfers` |
 | GET | `get_transfer(id)` | `/banking/transfers/:id` |
+| POST | `create_transfer(body:)` | `/banking/transfer` |
 
 #### Contacts
 
@@ -97,8 +115,10 @@ Just like in Rails the methods follow the singular and plural expression. Method
 |------------|-------------|----------|
 | GET | `get_contacts(query-parameters)` | `/contacts` |
 | GET | `get_contact(id)` | `/contacts/:id` |
+| POST | `create_contact(body:)` | `/contacts` |
 | GET | `get_contact_groups(query-parameters)` | `/contacts/groups` |
 | GET | `get_contact_group(id)` | `/contacts/groups/:id` |
+| POST | `create_group(body:)` | `/contacts/groups` |
 
 #### Products
 
@@ -106,8 +126,12 @@ Just like in Rails the methods follow the singular and plural expression. Method
 |------------|-------------|----------|
 | GET | `get_products(query-parameters)` | `/products` |
 | GET | `get_product(id)` | `/products/:id` |
+| POST | `create_product(body:)` | `/products` |
+| GET | `get_bundle(id)` | `/products/bundles/:id` |
+| POST | `create_bundle(body:)` | `/products/bundles` |
 | GET | `get_product_groups(query-parameters)` | `/products/groups` |
 | GET | `get_product_group(id)` | `/products/groups/:id` |
+| POST | `create_product_group(body:)` | `/products/groups` |
 
 #### Accounting
 
@@ -115,8 +139,16 @@ Just like in Rails the methods follow the singular and plural expression. Method
 |------------|-------------|----------|
 | GET | `get_journal_entries(query-parameters)` | `/journal_entries` |
 | GET | `get_journal_entry(id)` | `/journal_entries/:id` |
+| POST | `create_journal_entry(body:)` | `/journal_entries` |
 | GET | `get_accounts(query-parameters)` | `/accounts` |
 | GET | `get_account(id)` | `/accounts/:id` |
+| POST | `create_account(body:)` | `/accounts` |
+
+#### Files
+
+| HTTP Method | Ruby Method | Endpoint |
+|------------|-------------|----------|
+| POST | `upload_file(file_data:, filename:, mime_type:)` | `/files` |
 
 ### Examples
 
@@ -159,10 +191,34 @@ invoices = client.get_invoices(date_from: "2025-11-01", date_to: "2025-11-30")
 invoice = client.get_invoice(123)
 ```
 
+**Creating a new contact (or supplier)**:
+
+```ruby
+body = {
+  entity_type: "MALAYSIAN_COMPANY",
+  legal_name: invoice.supplier_name,
+  types: ["supplier"]
+}
+
+contact = client.create_contact(body: body)
+```
+
+**File upload:**
+
+```ruby
+
+file_data = File.read("invoice.pdf")
+filename  = "invoice.pdf"
+mime_type = "application/pdf"
+
+client.upload_file(file_data: file_data, filename: filename, mime_type: mime_type)
+
+```
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at <https://github.com/stopar/bukku_rails>.
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT)

data/lib/bukku_rails/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BukkuRails
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/bukku_test.rb

@@ -4,7 +4,7 @@ class BukkuTest < Client
   # respond = access.<method>
 
   # Testing URL
-  BASE_URI = 'https://api.bukku.fyi'
+  BASE_URI = 'https://api.staging.bukku.dev'
 
   ## SALES
   # Quotation

data/lib/client.rb

@@ -49,7 +49,7 @@ class Client
     http.use_ssl = uri.instance_of?(URI::HTTPS)
 
     # Add the 2 lines below because development keeps on failing SSL CRL checks
-    # Check this article for explanation: 
+    # Check this article for explanation:
     # https://dev.to/madhuhari188/how-we-solved-unable-to-get-certificate-crl-in-rails-a-debugging-story-2pna
     http.verify_mode = OpenSSL::SSL::VERIFY_PEER
     http.verify_callback = ->(_preverify_ok, _store_ctx) { true }
@@ -58,7 +58,7 @@ class Client
   end
 
   def make_request(klass, path, query: {}, body: {})
-    # Uncomment below for debuging purpose to see the payload that was sent.
+    # Uncomment below for debuging purpose to see payload that was sent.
     # build_http(uri).set_debug_output($stdout)
 
     uri = URI("#{base_uri}#{path}")
@@ -90,5 +90,6 @@ class Client
       raise Error, "#{response.code}: #{response.body}"
     end
   end
+
   class Error < StandardError; end
 end

metadata

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