clover_sandbox_simulator 1.0.0

data/lib/clover_sandbox_simulator/services/clover/tax_service.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module CloverSandboxSimulator
+  module Services
+    module Clover
+      # Manages Clover tax rates
+      class TaxService < BaseService
+        # Fetch all tax rates
+        def get_tax_rates
+          logger.info "Fetching tax rates..."
+          response = request(:get, endpoint("tax_rates"))
+          elements = response&.dig("elements") || []
+          logger.info "Found #{elements.size} tax rates"
+          elements
+        end
+
+        # Get default tax rate
+        def default_tax_rate
+          rates = get_tax_rates
+          # Find default rate or return first active one
+          rates.find { |r| r["isDefault"] == true } || rates.first
+        end
+
+        # Create a tax rate
+        def create_tax_rate(name:, rate:, is_default: false)
+          logger.info "Creating tax rate: #{name} (#{rate}%)"
+
+          # Rate is stored as basis points (8.25% = 825000)
+          rate_basis_points = (rate * 100_000).to_i
+
+          request(:post, endpoint("tax_rates"), payload: {
+            "name" => name,
+            "rate" => rate_basis_points,
+            "isDefault" => is_default,
+            "taxType" => "VAT_EXEMPT" # For US sales tax
+          })
+        end
+
+        # Delete a tax rate
+        def delete_tax_rate(tax_rate_id)
+          logger.info "Deleting tax rate: #{tax_rate_id}"
+          request(:delete, endpoint("tax_rates/#{tax_rate_id}"))
+        end
+
+        # Calculate tax for an amount
+        def calculate_tax(subtotal, tax_rate = nil)
+          rate = tax_rate || config.tax_rate
+          (subtotal * rate / 100.0).round
+        end
+      end
+    end
+  end
+end

data/lib/clover_sandbox_simulator/services/clover/tender_service.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module CloverSandboxSimulator
+  module Services
+    module Clover
+      # Manages Clover payment tenders (Cash, Gift Card, etc.)
+      class TenderService < BaseService
+        # Tenders that work reliably in Clover sandbox
+        # NOTE: Credit Card and Debit Card are BROKEN in sandbox - do not use!
+        SANDBOX_SAFE_TENDERS = %w[
+          com.clover.tender.cash
+          com.clover.tender.check
+          com.clover.tender.external_gift_card
+          com.clover.tender.external_payment
+        ].freeze
+
+        # Fetch all tenders
+        def get_tenders
+          logger.info "Fetching tenders..."
+          response = request(:get, endpoint("tenders"))
+          elements = response&.dig("elements") || []
+
+          # Filter to enabled tenders only
+          enabled = elements.select { |t| t["enabled"] == true }
+          logger.info "Found #{enabled.size} enabled tenders"
+          enabled
+        end
+
+        # Get sandbox-safe tenders (excludes credit/debit cards)
+        def get_safe_tenders
+          tenders = get_tenders
+
+          safe = tenders.reject do |tender|
+            label = tender["label"]&.downcase || ""
+            label_key = tender["labelKey"]&.downcase || ""
+
+            # Exclude credit and debit cards - they're broken in sandbox
+            label.include?("credit") ||
+              label.include?("debit") ||
+              label_key.include?("credit") ||
+              label_key.include?("debit")
+          end
+
+          logger.info "Found #{safe.size} sandbox-safe tenders"
+          safe
+        end
+
+        # Get a specific tender by label
+        def find_tender_by_label(label)
+          tenders = get_tenders
+          tenders.find { |t| t["label"]&.downcase == label.downcase }
+        end
+
+        # Get cash tender
+        def cash_tender
+          find_tender_by_label("Cash") || get_safe_tenders.first
+        end
+
+        # Create a custom tender
+        def create_tender(label:, label_key: nil, enabled: true, opens_cash_drawer: false)
+          logger.info "Creating tender: #{label}"
+
+          payload = {
+            "label" => label,
+            "labelKey" => label_key || "com.clover.tender.#{label.downcase.gsub(/\s+/, '_')}",
+            "enabled" => enabled,
+            "opensCashDrawer" => opens_cash_drawer
+          }
+
+          request(:post, endpoint("tenders"), payload: payload)
+        end
+
+        # Select random safe tenders for split payment
+        # Returns array of tender IDs with split percentages
+        def select_split_tenders(num_splits: nil)
+          tenders = get_safe_tenders
+          return [] if tenders.empty?
+
+          # Determine number of splits (1-3)
+          num_splits ||= rand(1..3)
+          num_splits = [num_splits, tenders.size].min
+
+          # Select random tenders
+          selected = tenders.sample(num_splits)
+
+          # Generate random split percentages that sum to 100
+          percentages = generate_split_percentages(num_splits)
+
+          selected.zip(percentages).map do |tender, percentage|
+            { tender: tender, percentage: percentage }
+          end
+        end
+
+        private
+
+        def generate_split_percentages(count)
+          return [100] if count == 1
+
+          # Generate random split points
+          points = Array.new(count - 1) { rand(10..90) }.sort
+
+          # Calculate percentages from split points
+          percentages = []
+          prev = 0
+          points.each do |point|
+            percentages << (point - prev)
+            prev = point
+          end
+          percentages << (100 - prev)
+
+          # Ensure no percentage is less than 5%
+          percentages.map { |p| [p, 5].max }
+        end
+      end
+    end
+  end
+end

data/lib/clover_sandbox_simulator.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "zeitwerk"
+require "logger"
+require "json"
+require "rest-client"
+require "dotenv"
+
+# Load environment variables
+Dotenv.load
+
+module CloverSandboxSimulator
+  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
+loader.setup
+
+# Eager load in production
+loader.eager_load if ENV["RACK_ENV"] == "production"

metadata

@@ -0,0 +1,195 @@
+--- !ruby/object:Gem::Specification
+name: clover_sandbox_simulator
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- dan1d
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-01-31 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: 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: 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: 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: 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'
+- !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'
+description: A Ruby gem for simulating Point of Sale operations in Clover sandbox
+  environments. Generates realistic restaurant orders, payments, and transaction data
+  for testing integrations with Clover's API.
+email:
+- dan1d@users.noreply.github.com
+executables:
+- simulate
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- bin/simulate
+- lib/clover_sandbox_simulator.rb
+- lib/clover_sandbox_simulator/configuration.rb
+- lib/clover_sandbox_simulator/data/restaurant/categories.json
+- lib/clover_sandbox_simulator/data/restaurant/discounts.json
+- lib/clover_sandbox_simulator/data/restaurant/items.json
+- lib/clover_sandbox_simulator/data/restaurant/modifiers.json
+- lib/clover_sandbox_simulator/data/restaurant/tenders.json
+- lib/clover_sandbox_simulator/generators/data_loader.rb
+- lib/clover_sandbox_simulator/generators/entity_generator.rb
+- lib/clover_sandbox_simulator/generators/order_generator.rb
+- lib/clover_sandbox_simulator/services/base_service.rb
+- lib/clover_sandbox_simulator/services/clover/customer_service.rb
+- lib/clover_sandbox_simulator/services/clover/discount_service.rb
+- lib/clover_sandbox_simulator/services/clover/employee_service.rb
+- lib/clover_sandbox_simulator/services/clover/inventory_service.rb
+- lib/clover_sandbox_simulator/services/clover/order_service.rb
+- lib/clover_sandbox_simulator/services/clover/payment_service.rb
+- lib/clover_sandbox_simulator/services/clover/services_manager.rb
+- lib/clover_sandbox_simulator/services/clover/tax_service.rb
+- lib/clover_sandbox_simulator/services/clover/tender_service.rb
+homepage: https://github.com/dan1d/clover_sandbox_simulator
+licenses:
+- MIT
+metadata: {}
+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.4.10
+signing_key:
+specification_version: 4
+summary: Clover Sandbox Simulator for generating realistic restaurant data
+test_files: []