table_check_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38c84286de9979b1d2cb6defe416b239228bf5eb29a0a279376280f89eee5798
+  data.tar.gz: 99f0b7df14de21168415eb64d3ac543ee15a561aa742d1adb18d04613e208b74
+SHA512:
+  metadata.gz: 455c8c9f0b17450edc7cabda07a6cc47811c7a6997be484ecf12438d3d119153d819222ab507f949c8a89ad7a935fed7d337fdf1ecf1efb9a69fe27149c29c0f
+  data.tar.gz: 224a77ba6fcf739adedc680e11247a3b27d9b766bd1c2fffa4474427868a3701250496c8897f9b20e12a2ef328202b39a5ed947bd78b52597277bf0a34f975e8

data/README.md

@@ -0,0 +1,128 @@
+# TableCheck API Ruby Gem
+
+[![Test](https://github.com/Eresto-Development-Team/table_check_api/actions/workflows/test.yml/badge.svg)](https://github.com/Eresto-Development-Team/table_check_api/actions/workflows/test.yml)
+
+A Ruby wrapper for the TableCheck POS v1 API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'table_check_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Configuration
+
+Run the generator to create the initializer:
+
+    $ rails generate table_check_api:install
+
+Configure it in `config/initializers/table_check_api.rb`:
+
+```ruby
+TableCheckApi.configure do |config|
+  config.base_url = 'https://api.tablecheck.com/api'
+  config.key = 'your_api_key_here'
+end
+```
+
+## Usage
+
+### List shops
+
+```ruby
+response = TableCheckApi::Pos::V1::Shop.list
+shops = response.shops
+puts shops.first['id']
+```
+
+### List tables for a shop
+
+```ruby
+response = TableCheckApi::Pos::V1::Table.list('shop_123')
+tables = response.tables
+puts tables.first['name']
+```
+
+### Get table status
+
+```ruby
+request = TableCheckApi::Pos::V1::Table::StatusRequest.new(
+  table_id: 'ae5355ca1fd337ed5d6893e2',
+  time: '2020-01-29T19:00:00Z'
+)
+
+response = TableCheckApi::Pos::V1::Table.status('shop_123', request)
+status = response.table_status
+puts status['status']
+```
+
+### Create POS journal
+
+```ruby
+request = TableCheckApi::Pos::V1::PosJournals::CreateRequest.new(
+  batch_date: '2020-01-01',
+  country: 'JP',
+  currency: 'JPY',
+  receipt_num: 'string',
+  pos_orders: [
+    {
+      id: 'order_1',
+      menu_category_name: 'Appetizer',
+      menu_item_name: 'Chicken Soup',
+      qty: 1,
+      unit_price: '1000'
+    }
+  ]
+)
+
+response = TableCheckApi::Pos::V1::PosJournals.create('shop_123', request)
+pos_journal = response.pos_journal
+puts pos_journal['id']
+```
+
+### Update POS journal
+
+```ruby
+request = TableCheckApi::Pos::V1::PosJournals::UpdateRequest.new(
+  receipt_num: 'string',
+  pos_payments: [
+    {
+      id: 'payment_1',
+      amt: '2000'
+    }
+  ]
+)
+
+response = TableCheckApi::Pos::V1::PosJournals.update('shop_123', 1, request)
+pos_journal = response.pos_journal
+```
+
+### Delete POS journal
+
+```ruby
+response = TableCheckApi::Pos::V1::PosJournals.delete('shop_123', 1)
+puts response.body['status']
+```
+
+### Void POS journal
+
+```ruby
+request = TableCheckApi::Pos::V1::PosJournals::VoidRequest.new(
+  receipt_num: '12345',
+  void_reason: 'customer_cancellation',
+  voided_at: '2026-01-29T19:30:00Z'
+)
+
+response = TableCheckApi::Pos::V1::PosJournals.void('shop_123', request)
+pos_journal = response.pos_journal
+```
+
+## Documentation
+
+See the [AGENT.md](AGENT.md) for detailed architecture, endpoints, and usage examples.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/lib/generators/table_check_api/install_generator.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module TableCheckApi
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../templates", __FILE__)
+
+      desc "Creates TableCheck API initializer."
+
+      def copy_tablecheck_api_initializer
+        template "table_check_api.rb", "config/initializers/table_check_api.rb"
+      end
+    end
+  end
+end

data/lib/generators/templates/table_check_api.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+TableCheckApi.configure do |config|
+  # ==> TableCheck API Base URL
+  # Base URL exclude component and version segments (eg: api.tablecheck.com/api)
+  # config.base_url = 'https://api.tablecheck.com/api'
+  
+  # ==> TableCheck API Key
+  # Default API Key used when no API Key provided on API call
+  # config.key = 'validapikey'
+end

data/lib/table_check_api/configuration.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative "version"
+
+module TableCheckApi
+  # Pure Ruby module-level accessors for gem configuration.
+  # No ActiveSupport dependency required.
+  #
+  # Usage:
+  #   TableCheckApi.configure do |config|
+  #     config.base_url = 'https://api.tablecheck.com/api'
+  #     config.key = 'your_api_key'
+  #   end
+  module Configuration
+    attr_accessor :base_url, :key
+
+    def configure
+      yield self
+    end
+  end
+
+  extend Configuration
+
+  # Set defaults
+  self.base_url = 'https://api.tablecheck.com/api'
+  self.key = ''
+end

data/lib/table_check_api/pos/v1/base_request.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module TableCheckApi
+  module Pos
+    module V1
+      class BaseRequest
+        def initialize(attributes = {})
+          @attributes = attributes ? attributes.dup : {}
+          validate_unknown_keys!
+          assign_attributes
+        end
+
+        def to_h
+          self.class::ATTRIBUTES.each_with_object({}) do |attribute, payload|
+            value = send(attribute)
+            next if value.nil? || (value.respond_to?(:empty?) && value.empty?)
+
+            payload[attribute.to_s] = normalize_payload_value(value)
+          end
+        end
+
+        private
+
+        attr_reader :attributes
+
+        def fetch(key)
+          attributes.fetch(key.to_s, attributes.fetch(key.to_sym, nil))
+        end
+
+        def assign_attributes
+          self.class::ATTRIBUTES.each do |attribute|
+            send("#{attribute}=", fetch(attribute))
+          end
+        end
+
+        def arrays_as(value, klass)
+          Array(value).map { |item| klass.new(item) }
+        end
+
+        def normalize_payload_value(value)
+          return value.map(&:to_h) if value.is_a?(Array) && value.first.respond_to?(:to_h)
+
+          value
+        end
+
+        def validate_unknown_keys!
+          return unless defined?(self.class::ATTRIBUTES)
+
+          unknown_keys = attributes.keys.map(&:to_s) - self.class::ATTRIBUTES.map(&:to_s)
+          raise ArgumentError, "Unknown attributes: #{unknown_keys.join(', ')}" if unknown_keys.any?
+        end
+      end
+    end
+  end
+end

data/lib/table_check_api/pos/v1/base_response.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module TableCheckApi
+  module Pos
+    module V1
+      class BaseResponse
+        def self.from_response(response)
+          new(response)
+        end
+
+        def initialize(response)
+          raw_body = response.respond_to?(:body) ? response.body : response
+          @body = parse_body(raw_body)
+        end
+
+        def raw
+          @body
+        end
+
+        alias body raw
+
+        def errors
+          @body['errors'] || []
+        end
+
+        def success?
+          errors.empty?
+        end
+
+        private
+
+        def parse_body(raw_body)
+          JSON.parse(raw_body.to_s)
+        rescue JSON::ParserError
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/table_check_api/pos/v1/pos_journals.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+require_relative "base_request"
+require_relative "base_response"
+
+module TableCheckApi
+  module Pos
+    module V1
+      # Service class for TableCheck POS Journals endpoints.
+      #
+      # Usage:
+      #   request = TableCheckApi::Pos::V1::PosJournals::CreateRequest.new(batch_date: '2020-01-01')
+      #   TableCheckApi::Pos::V1::PosJournals.create(shop_id, request)
+      #
+      #   update_request = TableCheckApi::Pos::V1::PosJournals::UpdateRequest.new(...)
+      #   TableCheckApi::Pos::V1::PosJournals.update(shop_id, id, update_request)
+      #
+      #   void_request = TableCheckApi::Pos::V1::PosJournals::VoidRequest.new(receipt_num: '12345', void_reason: 'customer_cancellation')
+      #   TableCheckApi::Pos::V1::PosJournals.void(shop_id, void_request)
+      class PosJournals
+        RESOURCE_PATH = '/pos/v1/shops'
+
+        # POST /shops/:shop_id/pos_journals — Create a new POS journal entry.
+        def self.create(shop_id, request, headers: {})
+          response = TableCheckApi::Client.post(
+            "#{RESOURCE_PATH}/#{shop_id}/pos_journals",
+            params: build_payload(request),
+            headers: headers
+          )
+
+          CreateResponse.from_response(response)
+        end
+
+        # PUT /shops/:shop_id/pos_journals/:id — Update an existing POS journal.
+        def self.update(shop_id, id, request, headers: {})
+          response = TableCheckApi::Client.put(
+            "#{RESOURCE_PATH}/#{shop_id}/pos_journals/#{id}",
+            params: build_payload(request),
+            headers: headers
+          )
+
+          PosJournalResponse.from_response(response)
+        end
+
+        # DELETE /shops/:shop_id/pos_journals/:id — Delete a POS journal.
+        def self.delete(shop_id, id, headers: {})
+          response = TableCheckApi::Client.delete(
+            "#{RESOURCE_PATH}/#{shop_id}/pos_journals/#{id}",
+            headers: headers
+          )
+
+          DeleteResponse.from_response(response)
+        end
+
+        # POST /shops/:shop_id/pos_journals/void — Void a POS journal.
+        def self.void(shop_id, request, headers: {})
+          response = TableCheckApi::Client.post(
+            "#{RESOURCE_PATH}/#{shop_id}/pos_journals/void",
+            params: build_payload(request),
+            headers: headers
+          )
+
+          PosJournalResponse.from_response(response)
+        end
+
+        def self.build_payload(request)
+          raise ArgumentError, 'request must respond to :to_h' unless request.respond_to?(:to_h)
+
+          request.to_h
+        end
+
+        class CreateRequest < BaseRequest
+          ATTRIBUTES = %i[
+            batch_date
+            change_amt
+            country
+            coupon_amt
+            currency
+            customer_name
+            discount_amt
+            membership_code
+            order_at
+            original_receipt_num
+            pax
+            payment_at
+            receipt_num
+            revenue_center
+            room_name
+            service_fee_amt
+            service_fee_rate
+            settle_amt
+            site_name
+            staff_name
+            staff_ref
+            subtotal_amt
+            system_api_provider
+            system_maker
+            system_model
+            system_version
+            table_names
+            tax_amt
+            tax_included_amt
+            tax_rate
+            terminal_name
+            total_amt
+            reservation_ref
+            reservation_status
+            pos_orders
+            pos_payments
+            pos_discounts
+          ].freeze
+
+          attr_accessor(*ATTRIBUTES)
+
+          def pos_orders=(value)
+            @pos_orders = arrays_as(value, PosOrder)
+          end
+
+          def pos_payments=(value)
+            @pos_payments = arrays_as(value, PosPayment)
+          end
+
+          def pos_discounts=(value)
+            @pos_discounts = arrays_as(value, PosDiscount)
+          end
+        end
+
+        class UpdateRequest < CreateRequest
+        end
+
+        class VoidRequest < BaseRequest
+          ATTRIBUTES = %i[receipt_num void_reason voided_at].freeze
+          attr_accessor(*ATTRIBUTES)
+        end
+
+        class PosOrder < BaseRequest
+          ATTRIBUTES = %i[
+            id
+            menu_category_name
+            menu_category_ref
+            menu_item_name
+            menu_item_ref
+            order_at
+            qty
+            ref
+            sku
+            unit_price
+          ].freeze
+
+          attr_accessor(*ATTRIBUTES)
+        end
+
+        class PosPayment < BaseRequest
+          ATTRIBUTES = %i[id amt brand issuer payment_at ref tender].freeze
+          attr_accessor(*ATTRIBUTES)
+        end
+
+        class PosDiscount < BaseRequest
+          ATTRIBUTES = %i[id amt name order_at ref].freeze
+          attr_accessor(*ATTRIBUTES)
+        end
+
+        class CreateResponse < BaseResponse
+          def pos_journal
+            body['pos_journal']
+          end
+
+          def reservations
+            body['reservations'] || []
+          end
+        end
+
+        class PosJournalResponse < BaseResponse
+          def pos_journal
+            body['pos_journal']
+          end
+
+          def reservations
+            body['reservations'] || []
+          end
+        end
+
+        class DeleteResponse < BaseResponse
+        end
+      end
+    end
+  end
+end

data/lib/table_check_api/pos/v1/shop.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "base_response"
+
+module TableCheckApi
+  module Pos
+    module V1
+      # Service class for TableCheck Shop endpoints.
+      #
+      # Usage:
+      #   TableCheckApi::Pos::V1::Shop.list
+      #   TableCheckApi::Pos::V1::Shop.list(headers: { 'Authorization' => 'Bearer other_key' })
+      class Shop
+        RESOURCE_PATH = '/pos/v1/shops'
+
+        # GET /shops — List accessible restaurant/venue operations.
+        def self.list(headers: {})
+          response = TableCheckApi::Client.get(RESOURCE_PATH, headers: headers)
+          ListResponse.from_response(response)
+        end
+
+        class ListResponse < BaseResponse
+          def shops
+            body['shops'] || []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/table_check_api/pos/v1/table.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "base_request"
+require_relative "base_response"
+
+module TableCheckApi
+  module Pos
+    module V1
+      # Service class for TableCheck Table endpoints.
+      #
+      # Usage:
+      #   TableCheckApi::Pos::V1::Table.list(shop_id)
+      #   request = TableCheckApi::Pos::V1::Table::StatusRequest.new(table_id: 'id', time: '2020-01-29T19:00:00Z')
+      #   TableCheckApi::Pos::V1::Table.status(shop_id, request)
+      #   TableCheckApi::Pos::V1::Table.status(shop_id, request, headers: { 'Authorization' => 'Bearer other_key' })
+      class Table
+        RESOURCE_PATH = '/pos/v1/shops'
+
+        # GET /shops/:shop_id/tables — List all tables for a specific shop.
+        def self.list(shop_id, headers: {})
+          response = TableCheckApi::Client.get(
+            "#{RESOURCE_PATH}/#{shop_id}/tables",
+            headers: headers
+          )
+
+          ListResponse.from_response(response)
+        end
+
+        # POST /shops/:shop_id/table_status/show — Show the status of a table.
+        def self.status(shop_id, request, headers: {})
+          response = TableCheckApi::Client.post(
+            "#{RESOURCE_PATH}/#{shop_id}/table_status/show",
+            params: build_payload(request),
+            headers: headers
+          )
+
+          StatusResponse.from_response(response)
+        end
+
+        def self.build_payload(request)
+          raise ArgumentError, 'request must respond to :to_h' unless request.respond_to?(:to_h)
+          request.to_h
+        end
+
+        class StatusRequest < BaseRequest
+          ATTRIBUTES = %i[table_id time].freeze
+          attr_accessor(*ATTRIBUTES)
+        end
+
+        class ListResponse < BaseResponse
+          def tables
+            body['tables'] || []
+          end
+        end
+
+        class StatusResponse < BaseResponse
+          def table_status
+            body['table_status'] || {}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/table_check_api/version.rb

@@ -0,0 +1,3 @@
+module TableCheckApi
+  VERSION = '0.1.0'
+end

data/lib/table_check_api.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'httparty'
+
+require_relative "table_check_api/version"
+require_relative "table_check_api/configuration"
+require_relative "table_check_api/pos/v1/base_response"
+require_relative "table_check_api/pos/v1/shop"
+require_relative "table_check_api/pos/v1/table"
+require_relative "table_check_api/pos/v1/pos_journals"
+
+module TableCheckApi
+  # Central HTTP client for all TableCheck API communication.
+  # Service classes (Pos::V1::Shop, etc.) delegate to these methods.
+  #
+  # Headers can be overridden per-request to support per-call key overrides:
+  #   Client.get('/path', headers: { 'Authorization' => 'Bearer other_key' })
+  module Client
+    def self.default_headers
+      {
+        'User-Agent' => "TableCheckAPIClient-v#{TableCheckApi::VERSION}",
+        'Accept' => 'application/json',
+        'Content-Type' => 'application/json',
+        'Authorization' => "Bearer #{TableCheckApi.key}"
+      }.freeze
+    end
+
+    def self.get(path, params: {}, headers: {})
+      HTTParty.get(
+        "#{TableCheckApi.base_url}#{path}",
+        query: params,
+        headers: default_headers.dup.merge(headers)
+      )
+    end
+
+    def self.post(path, params: {}, headers: {})
+      HTTParty.post(
+        "#{TableCheckApi.base_url}#{path}",
+        body: params.to_json,
+        headers: default_headers.dup.merge(headers)
+      )
+    end
+
+    def self.put(path, params: {}, headers: {})
+      HTTParty.put(
+        "#{TableCheckApi.base_url}#{path}",
+        body: params.to_json,
+        headers: default_headers.dup.merge(headers)
+      )
+    end
+
+    def self.delete(path, headers: {})
+      HTTParty.delete(
+        "#{TableCheckApi.base_url}#{path}",
+        headers: default_headers.dup.merge(headers)
+      )
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: table_check_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Developer [at] Eresto
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-06-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 0.21.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: TableCheck API wrapper for Ruby
+email:
+- developer@eresto.co.id
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/generators/table_check_api/install_generator.rb
+- lib/generators/templates/table_check_api.rb
+- lib/table_check_api.rb
+- lib/table_check_api/configuration.rb
+- lib/table_check_api/pos/v1/base_request.rb
+- lib/table_check_api/pos/v1/base_response.rb
+- lib/table_check_api/pos/v1/pos_journals.rb
+- lib/table_check_api/pos/v1/shop.rb
+- lib/table_check_api/pos/v1/table.rb
+- lib/table_check_api/version.rb
+homepage: https://github.com/Eresto-Development-Team/table_check_api
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key:
+specification_version: 4
+summary: TableCheck API wrapper for Ruby
+test_files: []