bukku_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9ed6bf94470a82481cf4506e9fa920743bbbb0b54623e964a07e41de1a78a107
+  data.tar.gz: f8db6a422b83fb3ee350ad36f9f4ab469e9f6aaa577523175ab4f040200da021
+SHA512:
+  metadata.gz: 9043be0a8e7b4c69ee501a6da75ab2ed04b560a12032ff282ab13baf8ed174417c5ab71aa6d5093e46b46107619f7b39c5423383fc5f98f8f2c037d940af1edf
+  data.tar.gz: d05253cf61d9c6b4c8d5a8dc57bb65e652d14e8cbcdc29924672f893b5a8c1eb888363ace0d4ae534928713175bfd11762523cba13d3303e50dd1190e9eac58e

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-12-02
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Muzaffar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,147 @@
+# BukkuRails
+
+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. 
+
+> 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
+
+Add the gen into your Gemfile like so:
+
+`gem "bukku_rails`
+
+## Usage
+
+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. 
+
+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. 
+
+**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"
+)
+```
+
+### 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. 
+
+#### Sales
+
+| HTTP Method | Ruby Method | Endpoint |
+|------------|-------------|----------|
+| GET | `get_sales_quotes(**kwargs)` | `/sales/quotes` |
+| GET | `get_sales_quote(id)` | `/sales/quotes/:id` |
+| GET | `get_sales_orders(**kwargs)` | `/sales/orders` |
+| GET | `get_sales_order(id)` | `/sales/orders/:id` |
+| GET | `get_delivery_orders(**kwargs)` | `/sales/delivery_orders` |
+| GET | `get_delivery_order(id)` | `/sales/delivery_orders/:id` |
+| GET | `get_invoices(**kwargs)` | `/sales/invoices` |
+| GET | `get_invoice(id)` | `/sales/invoices/:id` |
+| GET | `get_sales_credit_notes(**kwargs)` | `/sales/credit_notes` |
+| GET | `get_sales_credit_note(id)` | `/sales/credit_notes/:id` |
+| GET | `get_sales_payments(**kwargs)` | `/sales/payments` |
+| GET | `get_sales_payment(id)` | `/sales/payments/:id` |
+| GET | `get_sales_refunds(**kwargs)` | `/sales/refunds` |
+| GET | `get_sales_refund(id)` | `/sales/refunds/:id` |
+
+#### Purchases
+
+| HTTP Method | Ruby Method | Endpoint |
+|------------|-------------|----------|
+| GET | `get_purchase_orders(**kwargs)` | `/purchases/orders` |
+| GET | `get_purchase_order(id)` | `/purchases/orders/:id` |
+| GET | `get_received_notes(**kwargs)` | `/purchases/goods_received_notes` |
+| GET | `get_received_note(id)` | `/purchases/goods_received_notes/:id` |
+| GET | `get_bills(**kwargs)` | `/purchases/bills` |
+| GET | `get_bill(id)` | `/purchases/bills/:id` |
+| GET | `get_purchases_credit_notes(**kwargs)` | `/purchases/credit_notes` |
+| GET | `get_purchases_credit_note(id)` | `/purchases/credit_notes/:id` |
+| GET | `get_purchases_payments(**kwargs)` | `/purchases/payments` |
+| GET | `get_purchases_payments(id)` | `/purchases/payments/:id` |
+| GET | `get_purchases_refunds(**kwargs)` | `/purchases/refunds` |
+| GET | `get_purchases_refund(id)` | `/purchases/refunds/:id` |
+
+#### Banking
+
+| HTTP Method | Ruby Method | Endpoint |
+|------------|-------------|----------|
+| GET | `get_banking_incomes(**kwargs)` | `/banking/incomes` |
+| GET | `get_banking_income(id)` | `/banking/incomes/:id` |
+| GET | `get_banking_expenses(**kwargs)` | `/banking/expenses` |
+| GET | `get_banking_expense(id)` | `/banking/expenses/:id` |
+| GET | `get_transfers(**kwargs)` | `/banking/transfers` |
+| GET | `get_transfer(id)` | `/banking/transfers/:id` |
+
+#### Contacts
+
+| HTTP Method | Ruby Method | Endpoint |
+|------------|-------------|----------|
+| GET | `get_contacts(**kwargs)` | `/contacts` |
+| GET | `get_contact(id)` | `/contacts/:id` |
+| GET | `get_contact_groups(**kwargs)` | `/contacts/groups` |
+| GET | `get_contact_group(id)` | `/contacts/groups/:id` |
+
+#### Products
+
+| HTTP Method | Ruby Method | Endpoint |
+|------------|-------------|----------|
+| GET | `get_products(**kwargs)` | `/products` |
+| GET | `get_product(id)` | `/products/:id` |
+| GET | `get_product_groups(**kwargs)` | `/products/groups` |
+| GET | `get_product_group(id)` | `/products/groups/:id` |
+
+#### Accounting
+
+| 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` |
+
+### Examples
+
+**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>.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/lib/bukku.rb

@@ -0,0 +1,212 @@
+class Bukku < Client
+  # Usage of this integration as follows:
+  # access = Bukku.new(token: "bukku_token_key", domain: "domain")
+  # respond = access.<method>(parameters)
+  # Example: respond = access.get_sales_invoices(date_from: "2025-11-25", date_to: "2025-11-30")
+
+  BASE_URI = 'https://api.bukku.my'
+
+  ## SALES
+  # Quotation
+  def get_sales_quotes(**kwargs)
+    get '/sales/quotes', query: kwargs
+  end
+
+  def get_sales_quote(id)
+    get "/sales/quotes/#{id}"
+  end
+
+  # Sales Order
+  def get_sales_orders(**kwargs)
+    get '/sales/orders', query: kwargs
+  end
+
+  def get_sales_order(id)
+    get "/sales/orders/#{id}"
+  end
+
+  # Delivery Order
+  def get_delivery_orders(**kwargs)
+    get '/sales/delivery_orders', query: kwargs
+  end
+
+  def get_delivery_order(id)
+    get "/sales/delivery_orders/#{id}"
+  end
+
+  # Invoice
+  def get_invoices(**kwargs)
+    get '/sales/invoices', query: kwargs
+  end
+
+  def get_invoice(id)
+    get "/sales/invoices/#{id}"
+  end
+
+  # Credit Note
+  def get_sales_credit_notes(**kwargs)
+    get '/sales/credit_notes', query: kwargs
+  end
+
+  def get_sales_credit_note(id)
+    get "/sales/credit_notes/#{id}"
+  end
+
+  # Payment
+  def get_sales_payments(**kwargs)
+    get '/sales/payments', query: kwargs
+  end
+
+  def get_sales_payment(id)
+    get "/sales/payments/#{id}"
+  end
+
+  # Redund
+  def get_sales_refunds(**kwargs)
+    get '/sales/refunds', query: kwargs
+  end
+
+  def get_sales_refund(id)
+    get "/sales/refunds/#{id}"
+  end
+
+  ## PURCHASE
+  # Purchase Order
+  def get_purchase_orders(**kwargs)
+    get '/purchases/orders', query: kwargs
+  end
+
+  def get_purchase_order(id)
+    get "/purchases/orders/#{id}"
+  end
+
+  ## Goods Received Note
+  def get_received_notes(**kwargs)
+    get '/purchases/goods_received_notes', query: kwargs
+  end
+
+  def get_received_note(id)
+    get "/purchases/goods_received_notes/#{id}"
+  end
+
+  # Bill
+  def get_bills(**kwargs)
+    get '/purchases/bills', query: kwargs
+  end
+
+  def get_bill(id)
+    get "/purchases/bills/#{id}"
+  end
+
+  # Credit Note
+  def get_purchases_credit_notes(**kwargs)
+    get '/purchases/credit_notes', query: kwargs
+  end
+
+  def get_purchases_credit_note(id)
+    get "/purchases/credit_notes/#{id}"
+  end
+
+  # Payment
+  def get_purchases_payments(**kwargs)
+    get '/purchases/payments', query: kwargs
+  end
+
+  def get_purchases_payment(id)
+    get "/purchases/payments/#{id}"
+  end
+
+  # Refund
+  def get_purchases_refunds(**kwargs)
+    get '/purchases/refunds', query: kwargs
+  end
+
+  def get_purchases_refund(id)
+    get "/purchases/refunds/#{id}"
+  end
+
+  ## BANK
+  # Money In
+  def get_banking_incomes(**kwargs)
+    get '/banking/incomes', query: kwargs
+  end
+
+  def get_banking_income(id)
+    get "/banking/incomes/#{id}"
+  end
+
+  # Money Out
+  def get_banking_expenses(**kwargs)
+    get '/banking/expenses', query: kwargs
+  end
+
+  def get_banking_expense(id)
+    get "/banking/expenses/#{id}"
+  end
+
+  # Transfers
+  def get_transfers(**kwargs)
+    get '/banking/transfers', query: kwargs
+  end
+
+  def get_transfer(id)
+    get "/banking/transfers/#{id}"
+  end
+
+  ## CONTACT
+  # Contacts
+  def get_contacts(**kwargs)
+    get '/contacts', query: kwargs
+  end
+
+  def get_contact(id)
+    get "/contacts/#{id}"
+  end
+
+  # Groups
+  def get_contact_groups(**kwargs)
+    get '/contacts/groups', query: kwargs
+  end
+
+  def get_contact_group(id)
+    get "/contacts/groups/#{id}"
+  end
+
+  ## PRODUCT
+  # Product
+  def get_products(**kwargs)
+    get '/products', query: kwargs
+  end
+
+  def get_product(id)
+    get "/products/#{id}"
+  end
+
+  # Groups
+  def get_product_groups(**kwargs)
+    get '/products/groups', query: kwargs
+  end
+
+  def get_product_group(id)
+    get "/products/groups/#{id}"
+  end
+
+  ## ACCOUNTING
+  # Journal Entries
+  def journal_entries(**kwargs)
+    get '/journal_entries', query: kwargs
+  end
+
+  def journal_entry(id)
+    get "/journal_entries/#{id}"
+  end
+
+  # Account
+  def accounts
+    get '/accounts'
+  end
+
+  def account(id)
+    get "/accounts/#{id}"
+  end
+end

data/lib/bukku_rails/version.rb

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

data/lib/bukku_rails.rb

@@ -0,0 +1,9 @@
+require_relative 'bukku_rails/version'
+
+require 'net/http'
+require 'uri'
+require 'json'
+
+require 'client'
+require 'bukku'
+require 'bukku_test'

data/lib/bukku_test.rb

@@ -0,0 +1,212 @@
+class BukkuTest < Client
+  # Usage of this integration as follows:
+  # access = BukkuTest.new(token: "bukku_token_key", domain: "domain")
+  # respond = access.<method>
+
+  # Testing URL
+  BASE_URI = 'https://api.bukku.fyi'
+
+  ## SALES
+  # Quotation
+  def get_sales_quotes(**kwargs)
+    get '/sales/quotes', query: kwargs
+  end
+
+  def get_sales_quote(id)
+    get "/sales/quotes/#{id}"
+  end
+
+  # Sales Order
+  def get_sales_orders(**kwargs)
+    get '/sales/orders', query: kwargs
+  end
+
+  def get_sales_order(id)
+    get "/sales/orders/#{id}"
+  end
+
+  # Delivery Order
+  def get_delivery_orders(**kwargs)
+    get '/sales/delivery_orders', query: kwargs
+  end
+
+  def get_delivery_order(id)
+    get "/sales/delivery_orders/#{id}"
+  end
+
+  # Invoice
+  def get_invoices(**kwargs)
+    get '/sales/invoices', query: kwargs
+  end
+
+  def get_invoice(id)
+    get "/sales/invoices/#{id}"
+  end
+
+  # Credit Note
+  def get_sales_credit_notes(**kwargs)
+    get '/sales/credit_notes', query: kwargs
+  end
+
+  def get_sales_credit_note(id)
+    get "/sales/credit_notes/#{id}"
+  end
+
+  # Payment
+  def get_sales_payments(**kwargs)
+    get '/sales/payments', query: kwargs
+  end
+
+  def get_sales_payment(id)
+    get "/sales/payments/#{id}"
+  end
+
+  # Redund
+  def get_sales_refunds(**kwargs)
+    get '/sales/refunds', query: kwargs
+  end
+
+  def get_sales_refund(id)
+    get "/sales/refunds/#{id}"
+  end
+
+  ## PURCHASE
+  # Purchase Order
+  def get_purchase_orders(**kwargs)
+    get '/purchases/orders', query: kwargs
+  end
+
+  def get_purchase_order(id)
+    get "/purchases/orders/#{id}"
+  end
+
+  ## Goods Received Note
+  def get_received_notes(**kwargs)
+    get '/purchases/goods_received_notes', query: kwargs
+  end
+
+  def get_received_note(id)
+    get "/purchases/goods_received_notes/#{id}"
+  end
+
+  # Bill
+  def get_bills(**kwargs)
+    get '/purchases/bills', query: kwargs
+  end
+
+  def get_bill(id)
+    get "/purchases/bills/#{id}"
+  end
+
+  # Credit Note
+  def get_purchases_credit_notes(**kwargs)
+    get '/purchases/credit_notes', query: kwargs
+  end
+
+  def get_purchases_credit_note(id)
+    get "/purchases/credit_notes/#{id}"
+  end
+
+  # Payment
+  def get_purchases_payments(**kwargs)
+    get '/purchases/payments', query: kwargs
+  end
+
+  def get_purchases_payment(id)
+    get "/purchases/payments/#{id}"
+  end
+
+  # Refund
+  def get_purchases_refunds(**kwargs)
+    get '/purchases/refunds', query: kwargs
+  end
+
+  def get_purchases_refund(id)
+    get "/purchases/refunds/#{id}"
+  end
+
+  ## BANK
+  # Money In
+  def get_banking_incomes(**kwargs)
+    get '/banking/incomes', query: kwargs
+  end
+
+  def get_banking_income(id)
+    get "/banking/incomes/#{id}"
+  end
+
+  # Money Out
+  def get_banking_expenses(**kwargs)
+    get '/banking/expenses', query: kwargs
+  end
+
+  def get_banking_expense(id)
+    get "/banking/expenses/#{id}"
+  end
+
+  # Transfers
+  def get_transfers(**kwargs)
+    get '/banking/transfers', query: kwargs
+  end
+
+  def get_transfer(id)
+    get "/banking/transfers/#{id}"
+  end
+
+  ## CONTACT
+  # Contacts
+  def get_contacts(**kwargs)
+    get '/contacts', query: kwargs
+  end
+
+  def get_contact(id)
+    get "/contacts/#{id}"
+  end
+
+  # Groups
+  def get_contact_groups(**kwargs)
+    get '/contacts/groups', query: kwargs
+  end
+
+  def get_contact_group(id)
+    get "/contacts/groups/#{id}"
+  end
+
+  ## PRODUCT
+  # Product
+  def get_products(**kwargs)
+    get '/products', query: kwargs
+  end
+
+  def get_product(id)
+    get "/products/#{id}"
+  end
+
+  # Groups
+  def get_product_groups(**kwargs)
+    get '/products/groups', query: kwargs
+  end
+
+  def get_product_group(id)
+    get "/products/groups/#{id}"
+  end
+
+  ## ACCOUNTING
+  # Journal Entries
+  def journal_entries(**kwargs)
+    get '/journal_entries', query: kwargs
+  end
+
+  def journal_entry(id)
+    get "/journal_entries/#{id}"
+  end
+
+  # Account
+  def accounts
+    get '/accounts'
+  end
+
+  def account(id)
+    get "/accounts/#{id}"
+  end
+end

data/lib/client.rb

@@ -0,0 +1,60 @@
+class Client
+  # The BASE_URI below is there to facilitate test only
+  BASE_URI = "https://rekon.org"
+
+  attr_reader :token, :domain
+
+  def initialize(token:, domain:)
+    @token = token
+    @domain = domain
+  end
+
+  private
+
+  def base_uri
+    self.class::BASE_URI
+  end
+
+  def default_headers
+    {
+      'Authorization' => "Bearer #{@token}",
+      'Company-Subdomain' => "#{@domain}",
+      'Accept' => 'application/json'
+    }
+  end
+
+  def get(path, query: {})
+    make_request Net::HTTP::Get, path, query: query
+  end
+
+  def post(path, query: {}, body: {})
+    make_request Net::HTTP::Post, path, query: query, body: body
+  end
+
+  def make_request(klass, path, query: {}, body: {})
+    uri = URI("#{base_uri}#{path}")
+    uri.query = URI.encode_www_form(query) if query
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = uri.instance_of?(URI::HTTPS)
+    # Uncomment below for debuging purpose to see the payload that was sent.
+    # http.set_debug_output($stdout)
+
+    request = klass.new(uri.request_uri, default_headers)
+    if body && !body.empty?
+      request.body = body.to_json
+    end
+
+    response = http.request(request)
+
+    case response.code.to_i
+    when 200, 201, 202, 203, 204
+      # JSON.parse(response.body) if response.body.present?
+      JSON.parse(response.body) if response.body && !response.body.empty?
+    else
+      raise Error, "#{response.code}: #{response.body}"
+    end
+  end
+
+  class Error < StandardError; end
+end

data/sig/bukku_rails.rbs

@@ -0,0 +1,4 @@
+module BukkuRails
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: bukku_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Muzaffar Ariff
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-12-03 00:00:00.000000000 Z
+dependencies: []
+description: Use Rails conventions to call Bukku API requests.
+email:
+- muz@geligalabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/bukku.rb
+- lib/bukku_rails.rb
+- lib/bukku_rails/version.rb
+- lib/bukku_test.rb
+- lib/client.rb
+- sig/bukku_rails.rbs
+homepage:
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/stopar/bukku_rails
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key:
+specification_version: 4
+summary: Bukku Cloud accounting API implementation in Rails
+test_files: []