skytab_sandbox_simulator 0.1.0

data/lib/skytab_sandbox_simulator/services/skytab/order_service.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module SkytabSandboxSimulator
+  module Services
+    module Skytab
+      # Manages SkyTab tickets (orders/checks) via POS API.
+      # GET /pos/v2/{locationId}/tickets
+      class OrderService < BaseService
+        REVENUE_CLASSES = %w[DINE_IN TAKEOUT DELIVERY BAR CATERING].freeze
+
+        # Fetch all tickets for the current location
+        #
+        # @param limit [Integer] Maximum number of tickets to return
+        # @param status [String, nil] Filter by status (open, closed)
+        # @return [Array<Hash>] Array of ticket objects
+        def get_tickets(limit: 50, status: nil)
+          logger.info "Fetching tickets..."
+          params = { limit: limit }
+          params[:status] = status if status
+
+          response = request(:get, pos_endpoint("tickets"), params: params,
+                             resource_type: "Ticket")
+          tickets = extract_elements(response)
+          logger.info "Found #{tickets.size} tickets"
+          tickets
+        end
+
+        # Get a single ticket by ID
+        #
+        # @param ticket_id [String] Ticket ID
+        # @return [Hash, nil] Ticket data
+        def get_ticket(ticket_id)
+          logger.info "Fetching ticket: #{ticket_id}"
+          request(:get, pos_endpoint("tickets/#{ticket_id}"),
+                  resource_type: "Ticket", resource_id: ticket_id)
+        end
+
+        # Create a new ticket (check/order)
+        #
+        # @param pos_ref [String, nil] POS reference number
+        # @param employee_pos_ref [String, nil] Employee POS reference
+        # @param revenue_class [String] Revenue class (DINE_IN, TAKEOUT, etc.)
+        # @return [Hash, nil] Created ticket
+        def create_ticket(pos_ref: nil, employee_pos_ref: nil, revenue_class: "DINE_IN")
+          logger.info "Creating ticket..."
+
+          payload = {
+            "status" => "open",
+            "revenueClassPosRef" => revenue_class
+          }
+          payload["posRef"] = pos_ref if pos_ref
+          payload["employeePosRef"] = employee_pos_ref if employee_pos_ref
+
+          request(:post, pos_endpoint("tickets"), payload: payload,
+                  resource_type: "Ticket")
+        end
+
+        # Add an item to a ticket
+        #
+        # @param ticket_id [String] Ticket ID
+        # @param pos_ref [String] Item POS reference
+        # @param name [String] Item name
+        # @param quantity [Integer] Quantity
+        # @param price [Integer] Unit price in cents
+        # @return [Hash, nil] Updated ticket
+        def add_item_to_ticket(ticket_id, pos_ref:, name:, quantity: 1, price:)
+          logger.debug "Adding item #{name} to ticket #{ticket_id}"
+
+          payload = {
+            "items" => [
+              {
+                "posRef" => pos_ref,
+                "name" => name,
+                "quantity" => quantity,
+                "price" => price,
+                "total" => price * quantity
+              }
+            ]
+          }
+
+          request(:put, pos_endpoint("tickets/#{ticket_id}/items"), payload: payload,
+                  resource_type: "Ticket", resource_id: ticket_id)
+        end
+
+        # Close a ticket (mark as completed)
+        #
+        # @param ticket_id [String] Ticket ID
+        # @param subtotal [Integer] Subtotal in cents
+        # @param tax [Integer] Tax amount in cents
+        # @param total [Integer] Total in cents
+        # @param tip [Integer] Tip amount in cents
+        # @return [Hash, nil] Updated ticket
+        def close_ticket(ticket_id, subtotal:, tax:, total:, tip: 0)
+          logger.info "Closing ticket: #{ticket_id}"
+
+          payload = {
+            "status" => "closed",
+            "subtotal" => subtotal,
+            "tax" => tax,
+            "total" => total,
+            "tip" => tip,
+            "closedAt" => Time.now.utc.iso8601
+          }
+
+          request(:put, pos_endpoint("tickets/#{ticket_id}"), payload: payload,
+                  resource_type: "Ticket", resource_id: ticket_id)
+        end
+
+        # Delete all tickets (use with caution)
+        #
+        # @return [Integer] Number of deleted tickets
+        def delete_all_tickets
+          tickets = get_tickets(limit: 100)
+          tickets.each do |ticket|
+            request(:delete, pos_endpoint("tickets/#{ticket['id']}"),
+                    resource_type: "Ticket", resource_id: ticket["id"])
+          rescue StandardError => e
+            logger.warn "Failed to delete ticket #{ticket['id']}: #{e.message}"
+          end
+          tickets.size
+        end
+
+        private
+
+        def extract_elements(response)
+          return [] if response.nil?
+
+          if response.is_a?(Array)
+            response
+          elsif response.is_a?(Hash)
+            response["tickets"] || response["elements"] || []
+          else
+            []
+          end
+        end
+      end
+    end
+  end
+end

data/lib/skytab_sandbox_simulator/services/skytab/payment_service.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module SkytabSandboxSimulator
+  module Services
+    module Skytab
+      # Manages SkyTab payments on tickets via POS API.
+      class PaymentService < BaseService
+        # Add a payment to a ticket
+        #
+        # @param ticket_id [String] Ticket ID
+        # @param tender_pos_ref [String] Tender POS reference (CASH, VISA, etc.)
+        # @param amount [Integer] Payment amount in cents
+        # @param tip [Integer] Tip amount in cents
+        # @return [Hash, nil] Payment result
+        def add_payment(ticket_id, tender_pos_ref:, amount:, tip: 0)
+          logger.info "Adding payment of $#{amount / 100.0} to ticket #{ticket_id}"
+
+          payload = {
+            "payments" => [
+              {
+                "tenderPosRef" => tender_pos_ref,
+                "amount" => amount,
+                "tip" => tip,
+                "status" => "completed"
+              }
+            ]
+          }
+
+          request(:put, pos_endpoint("tickets/#{ticket_id}/payments"), payload: payload,
+                  resource_type: "Payment")
+        end
+
+        # Add a split payment to a ticket (multiple tenders)
+        #
+        # @param ticket_id [String] Ticket ID
+        # @param payments [Array<Hash>] Array of payment hashes with :tender_pos_ref, :amount, :tip
+        # @return [Hash, nil] Payment result
+        def add_split_payment(ticket_id, payments:)
+          logger.info "Adding #{payments.size} split payments to ticket #{ticket_id}"
+
+          payment_data = payments.map do |p|
+            {
+              "tenderPosRef" => p[:tender_pos_ref],
+              "amount" => p[:amount],
+              "tip" => p[:tip] || 0,
+              "status" => "completed"
+            }
+          end
+
+          payload = { "payments" => payment_data }
+
+          request(:put, pos_endpoint("tickets/#{ticket_id}/payments"), payload: payload,
+                  resource_type: "Payment")
+        end
+
+        # Fetch payments for a ticket
+        #
+        # @param ticket_id [String] Ticket ID
+        # @return [Array<Hash>] Array of payment objects
+        def get_payments(ticket_id)
+          logger.info "Fetching payments for ticket: #{ticket_id}"
+          response = request(:get, pos_endpoint("tickets/#{ticket_id}/payments"),
+                             resource_type: "Payment")
+
+          return [] if response.nil?
+
+          if response.is_a?(Array)
+            response
+          elsif response.is_a?(Hash)
+            response["payments"] || response["elements"] || []
+          else
+            []
+          end
+        end
+
+        # Refund a payment
+        #
+        # @param ticket_id [String] Ticket ID
+        # @param payment_id [String] Payment ID to refund
+        # @param amount [Integer, nil] Refund amount in cents (nil for full refund)
+        # @return [Hash, nil] Refund result
+        def refund_payment(ticket_id, payment_id:, amount: nil)
+          logger.info "Refunding payment #{payment_id} on ticket #{ticket_id}"
+
+          payload = { "paymentId" => payment_id }
+          payload["amount"] = amount if amount
+
+          request(:post, pos_endpoint("tickets/#{ticket_id}/refunds"), payload: payload,
+                  resource_type: "Refund")
+        end
+      end
+    end
+  end
+end

data/lib/skytab_sandbox_simulator/services/skytab/service_manager.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module SkytabSandboxSimulator
+  module Services
+    module Skytab
+      # Central manager for all SkyTab services.
+      # Provides thread-safe, lazy-loaded access to all service classes.
+      class ServiceManager
+        attr_reader :config
+
+        def initialize(config: nil)
+          @config = config || SkytabSandboxSimulator.configuration
+          @mutex = Mutex.new
+        end
+
+        def location
+          thread_safe_memoize(:@location) { LocationService.new(config: config) }
+        end
+
+        def catalog
+          thread_safe_memoize(:@catalog) { CatalogService.new(config: config) }
+        end
+
+        def order
+          thread_safe_memoize(:@order) { OrderService.new(config: config) }
+        end
+
+        def payment
+          thread_safe_memoize(:@payment) { PaymentService.new(config: config) }
+        end
+
+        # Clear all cached service instances
+        def clear_services
+          @mutex.synchronize do
+            instance_variables.each do |var|
+              next if var == :@config || var == :@mutex
+
+              instance_variable_set(var, nil)
+            end
+          end
+        end
+
+        private
+
+        # Thread-safe memoization pattern
+        def thread_safe_memoize(ivar_name)
+          value = instance_variable_get(ivar_name)
+          return value if value
+
+          @mutex.synchronize do
+            value = instance_variable_get(ivar_name)
+            return value if value
+
+            value = yield
+            instance_variable_set(ivar_name, value)
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/skytab_sandbox_simulator/version.rb

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

data/lib/skytab_sandbox_simulator.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "logger"
+require "json"
+require "rest-client"
+require "dotenv"
+
+# Load environment variables
+Dotenv.load
+
+module SkytabSandboxSimulator
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+  class ApiError < Error; end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def logger
+      configuration.logger
+    end
+
+    def root
+      File.expand_path("..", __dir__)
+    end
+  end
+end
+
+# Set up Zeitwerk autoloader
+loader = Zeitwerk::Loader.for_gem
+# Migrations and factories follow ActiveRecord conventions, not Zeitwerk naming
+loader.ignore(File.expand_path("skytab_sandbox_simulator/db", __dir__))
+loader.setup
+
+# Eager load in production
+loader.eager_load if ENV["RACK_ENV"] == "production"

metadata

@@ -0,0 +1,305 @@
+--- !ruby/object:Gem::Specification
+name: skytab_sandbox_simulator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TheOwnerStack
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.4'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: zeitwerk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner-active_record
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.50'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.18'
+description: A Ruby gem for simulating Point of Sale operations in SkyTab (Shift4)
+  sandbox environments. Generates realistic restaurant orders, payments, and transaction
+  data for testing integrations with the Shift4 Marketplace API.
+email:
+- support@salestobooks.com
+executables:
+- simulate
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- bin/simulate
+- lib/skytab_sandbox_simulator.rb
+- lib/skytab_sandbox_simulator/configuration.rb
+- lib/skytab_sandbox_simulator/data/bar_nightclub/categories.json
+- lib/skytab_sandbox_simulator/data/bar_nightclub/items.json
+- lib/skytab_sandbox_simulator/data/bar_nightclub/tenders.json
+- lib/skytab_sandbox_simulator/data/cafe_bakery/categories.json
+- lib/skytab_sandbox_simulator/data/cafe_bakery/items.json
+- lib/skytab_sandbox_simulator/data/cafe_bakery/tenders.json
+- lib/skytab_sandbox_simulator/data/fine_dining/categories.json
+- lib/skytab_sandbox_simulator/data/fine_dining/items.json
+- lib/skytab_sandbox_simulator/data/fine_dining/tenders.json
+- lib/skytab_sandbox_simulator/data/pizzeria/categories.json
+- lib/skytab_sandbox_simulator/data/pizzeria/items.json
+- lib/skytab_sandbox_simulator/data/pizzeria/tenders.json
+- lib/skytab_sandbox_simulator/data/restaurant/categories.json
+- lib/skytab_sandbox_simulator/data/restaurant/items.json
+- lib/skytab_sandbox_simulator/data/restaurant/tenders.json
+- lib/skytab_sandbox_simulator/database.rb
+- lib/skytab_sandbox_simulator/db/factories/business_types.rb
+- lib/skytab_sandbox_simulator/db/factories/categories.rb
+- lib/skytab_sandbox_simulator/db/factories/items.rb
+- lib/skytab_sandbox_simulator/db/factories/simulated_orders.rb
+- lib/skytab_sandbox_simulator/db/factories/simulated_payments.rb
+- lib/skytab_sandbox_simulator/db/migrate/20260316000000_enable_pgcrypto.rb
+- lib/skytab_sandbox_simulator/db/migrate/20260316000001_create_business_types.rb
+- lib/skytab_sandbox_simulator/db/migrate/20260316000002_create_categories.rb
+- lib/skytab_sandbox_simulator/db/migrate/20260316000003_create_items.rb
+- lib/skytab_sandbox_simulator/db/migrate/20260316000004_create_simulated_orders.rb
+- lib/skytab_sandbox_simulator/db/migrate/20260316000005_create_simulated_payments.rb
+- lib/skytab_sandbox_simulator/db/migrate/20260316000006_create_api_requests.rb
+- lib/skytab_sandbox_simulator/db/migrate/20260316000007_create_daily_summaries.rb
+- lib/skytab_sandbox_simulator/generators/data_loader.rb
+- lib/skytab_sandbox_simulator/generators/entity_generator.rb
+- lib/skytab_sandbox_simulator/generators/order_generator.rb
+- lib/skytab_sandbox_simulator/models/api_request.rb
+- lib/skytab_sandbox_simulator/models/business_type.rb
+- lib/skytab_sandbox_simulator/models/category.rb
+- lib/skytab_sandbox_simulator/models/daily_summary.rb
+- lib/skytab_sandbox_simulator/models/item.rb
+- lib/skytab_sandbox_simulator/models/record.rb
+- lib/skytab_sandbox_simulator/models/simulated_order.rb
+- lib/skytab_sandbox_simulator/models/simulated_payment.rb
+- lib/skytab_sandbox_simulator/seeder.rb
+- lib/skytab_sandbox_simulator/services/base_service.rb
+- lib/skytab_sandbox_simulator/services/skytab/catalog_service.rb
+- lib/skytab_sandbox_simulator/services/skytab/location_service.rb
+- lib/skytab_sandbox_simulator/services/skytab/order_service.rb
+- lib/skytab_sandbox_simulator/services/skytab/payment_service.rb
+- lib/skytab_sandbox_simulator/services/skytab/service_manager.rb
+- lib/skytab_sandbox_simulator/version.rb
+homepage: https://github.com/dan1d/skytab_sandbox_simulator
+licenses:
+- MIT
+metadata: {}
+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.6.9
+specification_version: 4
+summary: SkyTab (Shift4) POS sandbox simulator for SalesToBooks integration testing
+test_files: []