lightspeed_sandbox_simulator 0.1.0

data/lib/lightspeed_sandbox_simulator/services/lightspeed/menu_service.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module LightspeedSandboxSimulator
+  module Services
+    module Lightspeed
+      class MenuService < BaseService
+        def list_categories
+          request(:get, endpoint('menu/categories'))
+        end
+
+        def create_category(name:, sort_order: nil)
+          payload = { name: name }
+          payload[:sortOrder] = sort_order if sort_order
+          request(:post, endpoint('menu/categories'), payload: payload)
+        end
+
+        def update_category(id:, name:, sort_order: nil)
+          payload = { name: name }
+          payload[:sortOrder] = sort_order if sort_order
+          request(:put, endpoint("menu/categories/#{id}"), payload: payload)
+        end
+
+        def delete_category(id:)
+          request(:delete, endpoint("menu/categories/#{id}"))
+        end
+
+        def list_items
+          request(:get, endpoint('menu/items'))
+        end
+
+        def create_item(name:, price:, category_id: nil, taxable: true, sku: nil, description: nil)
+          payload = { name: name, price: price, taxable: taxable }
+          payload[:categoryId] = category_id if category_id
+          payload[:sku] = sku if sku
+          payload[:description] = description if description
+          request(:post, endpoint('menu/items'), payload: payload)
+        end
+
+        def update_item(id:, **attributes)
+          payload = {}
+          payload[:name] = attributes[:name] if attributes.key?(:name)
+          payload[:price] = attributes[:price] if attributes.key?(:price)
+          payload[:categoryId] = attributes[:category_id] if attributes.key?(:category_id)
+          payload[:taxable] = attributes[:taxable] if attributes.key?(:taxable)
+          request(:put, endpoint("menu/items/#{id}"), payload: payload)
+        end
+
+        def delete_item(id:)
+          request(:delete, endpoint("menu/items/#{id}"))
+        end
+
+        def find_category_by_name(name)
+          categories = list_categories
+          categories = categories['categories'] if categories.is_a?(Hash) && categories.key?('categories')
+          return nil unless categories.is_a?(Array)
+
+          categories.find { |c| c['name']&.downcase == name.downcase }
+        end
+
+        def find_item_by_name(name)
+          items = list_items
+          items = items['items'] if items.is_a?(Hash) && items.key?('items')
+          return nil unless items.is_a?(Array)
+
+          items.find { |i| i['name']&.downcase == name.downcase }
+        end
+      end
+    end
+  end
+end

data/lib/lightspeed_sandbox_simulator/services/lightspeed/order_service.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module LightspeedSandboxSimulator
+  module Services
+    module Lightspeed
+      class OrderService < BaseService
+        ORDER_TYPES = { local: 'local', to_go: 'toGo' }.freeze
+
+        def create_local_order(items:, table_number: nil, covers: nil)
+          payload = build_order_payload(items)
+          payload[:tableNumber] = table_number if table_number
+          payload[:covers] = covers if covers
+          request(:post, "#{API_PREFIX}/businesses/#{config.business_id}/orders/local",
+                  payload: payload, resource_type: 'Order')
+        end
+
+        def create_to_go_order(items:, customer_name: nil)
+          payload = build_order_payload(items)
+          payload[:customerName] = customer_name if customer_name
+          request(:post, "#{API_PREFIX}/businesses/#{config.business_id}/orders/toGo",
+                  payload: payload, resource_type: 'Order')
+        end
+
+        def fetch_orders(start_date:, end_date:, cursor: nil, limit: 100)
+          params = { startDate: format_date(start_date), endDate: format_date(end_date), limit: limit }
+          params[:cursor] = cursor if cursor
+          request(:get, endpoint('orders'), params: params)
+        end
+
+        def fetch_all_orders(start_date:, end_date:)
+          all_orders = []
+          cursor = nil
+
+          loop do
+            result = fetch_orders(start_date: start_date, end_date: end_date, cursor: cursor)
+            return all_orders unless result.is_a?(Hash)
+
+            orders = result['orders'] || []
+            all_orders.concat(orders)
+
+            cursor = result['cursor']
+            break if cursor.nil? || cursor.to_s.empty? || orders.empty?
+          end
+
+          all_orders
+        end
+
+        private
+
+        def build_order_payload(items)
+          {
+            items: items.map { |item| build_item_payload(item) }
+          }
+        end
+
+        def build_item_payload(item)
+          entry = { itemId: item[:item_id], quantity: item[:quantity] || 1 }
+          entry[:unitPrice] = item[:unit_price] if item[:unit_price]
+          entry[:discountAmount] = item[:discount] if item[:discount]&.positive?
+          entry[:notes] = item[:notes] if item[:notes]
+          entry
+        end
+
+        def format_date(value)
+          case value
+          when Date then value.iso8601
+          when Time then value.to_date.iso8601
+          else value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lightspeed_sandbox_simulator/services/lightspeed/payment_method_service.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module LightspeedSandboxSimulator
+  module Services
+    module Lightspeed
+      class PaymentMethodService < BaseService
+        def list_payment_methods
+          request(:get, endpoint('payment-methods'))
+        end
+
+        def create_payment_method(name:, type: 'OTHER')
+          payload = { name: name, type: type }
+          request(:post, endpoint('payment-methods'), payload: payload)
+        end
+
+        def delete_payment_method(id:)
+          request(:delete, endpoint("payment-methods/#{id}"))
+        end
+
+        def find_payment_method_by_name(name)
+          methods = list_payment_methods
+          methods = methods['paymentMethods'] if methods.is_a?(Hash) && methods.key?('paymentMethods')
+          return nil unless methods.is_a?(Array)
+
+          methods.find { |m| m['name']&.downcase == name.downcase }
+        end
+      end
+    end
+  end
+end

data/lib/lightspeed_sandbox_simulator/services/lightspeed/payment_service.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module LightspeedSandboxSimulator
+  module Services
+    module Lightspeed
+      class PaymentService < BaseService
+        def create_payment(order_id:, amount:, payment_method_id:, tip_amount: 0, staff_id: nil)
+          payload = {
+            orderId: order_id,
+            paymentAmount: amount,
+            tipAmount: tip_amount,
+            paymentMethodId: payment_method_id
+          }
+          payload[:staffId] = staff_id if staff_id
+          request(:post, "#{API_PREFIX}/businesses/#{config.business_id}/payments",
+                  payload: payload, resource_type: 'Payment')
+        end
+
+        def fetch_payments(start_date:, end_date:, cursor: nil, limit: 100)
+          params = { startDate: format_date(start_date), endDate: format_date(end_date), limit: limit }
+          params[:cursor] = cursor if cursor
+          request(:get, endpoint('payments'), params: params)
+        end
+
+        def fetch_all_payments(start_date:, end_date:)
+          all_payments = []
+          cursor = nil
+
+          loop do
+            result = fetch_payments(start_date: start_date, end_date: end_date, cursor: cursor)
+            return all_payments unless result.is_a?(Hash)
+
+            payments = result['payments'] || []
+            all_payments.concat(payments)
+
+            cursor = result['cursor']
+            break if cursor.nil? || cursor.to_s.empty? || payments.empty?
+          end
+
+          all_payments
+        end
+
+        private
+
+        def format_date(value)
+          case value
+          when Date then value.iso8601
+          when Time then value.to_date.iso8601
+          else value.to_s
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lightspeed_sandbox_simulator/services/lightspeed/services_manager.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require 'concurrent'
+
+module LightspeedSandboxSimulator
+  module Services
+    module Lightspeed
+      class ServicesManager
+        def initialize(config: nil)
+          @config = config || LightspeedSandboxSimulator.configuration
+          @mutex = Mutex.new
+        end
+
+        def menu
+          thread_safe_memoize(:@menu) { MenuService.new(config: @config) }
+        end
+
+        def payment_methods
+          thread_safe_memoize(:@payment_methods) { PaymentMethodService.new(config: @config) }
+        end
+
+        def orders
+          thread_safe_memoize(:@orders) { OrderService.new(config: @config) }
+        end
+
+        def payments
+          thread_safe_memoize(:@payments) { PaymentService.new(config: @config) }
+        end
+
+        def business
+          thread_safe_memoize(:@business) { BusinessService.new(config: @config) }
+        end
+
+        private
+
+        def thread_safe_memoize(ivar_name)
+          value = instance_variable_get(ivar_name)
+          return value if value
+
+          @mutex.synchronize do
+            # :nocov:
+            value = instance_variable_get(ivar_name)
+            return value if value
+            # :nocov:
+
+            value = yield
+            instance_variable_set(ivar_name, value)
+            value
+          end
+        end
+      end
+    end
+  end
+end

data/lib/lightspeed_sandbox_simulator.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'zeitwerk'
+require 'logger'
+
+module LightspeedSandboxSimulator
+  class Error < StandardError; end
+  class ConfigurationError < Error; end
+  class ApiError < Error; end
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def logger
+      configuration.logger
+    end
+  end
+end
+
+loader = Zeitwerk::Loader.for_gem
+loader.setup
+# :nocov:
+loader.eager_load if ENV['RACK_ENV'] == 'production'
+# :nocov:

metadata

@@ -0,0 +1,332 @@
+--- !ruby/object:Gem::Specification
+name: lightspeed_sandbox_simulator
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- dan1d
+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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !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: 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: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.22'
+- !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 POS operations against the Lightspeed K-Series
+  API. Generates realistic orders, payments, and transaction data for testing.
+email:
+- dan1d@users.noreply.github.com
+executables:
+- simulate
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE
+- README.md
+- bin/simulate
+- lib/lightspeed_sandbox_simulator.rb
+- lib/lightspeed_sandbox_simulator/configuration.rb
+- lib/lightspeed_sandbox_simulator/data/bar_nightclub/categories.json
+- lib/lightspeed_sandbox_simulator/data/bar_nightclub/items.json
+- lib/lightspeed_sandbox_simulator/data/bar_nightclub/tenders.json
+- lib/lightspeed_sandbox_simulator/data/cafe_bakery/categories.json
+- lib/lightspeed_sandbox_simulator/data/cafe_bakery/items.json
+- lib/lightspeed_sandbox_simulator/data/cafe_bakery/tenders.json
+- lib/lightspeed_sandbox_simulator/data/restaurant/categories.json
+- lib/lightspeed_sandbox_simulator/data/restaurant/items.json
+- lib/lightspeed_sandbox_simulator/data/restaurant/tenders.json
+- lib/lightspeed_sandbox_simulator/data/retail_general/categories.json
+- lib/lightspeed_sandbox_simulator/data/retail_general/items.json
+- lib/lightspeed_sandbox_simulator/data/retail_general/tenders.json
+- lib/lightspeed_sandbox_simulator/database.rb
+- lib/lightspeed_sandbox_simulator/db/factories/api_requests.rb
+- lib/lightspeed_sandbox_simulator/db/factories/business_types.rb
+- lib/lightspeed_sandbox_simulator/db/factories/categories.rb
+- lib/lightspeed_sandbox_simulator/db/factories/items.rb
+- lib/lightspeed_sandbox_simulator/db/factories/simulated_orders.rb
+- lib/lightspeed_sandbox_simulator/db/factories/simulated_payments.rb
+- lib/lightspeed_sandbox_simulator/db/migrate/20260313000001_enable_pgcrypto.rb
+- lib/lightspeed_sandbox_simulator/db/migrate/20260313000002_create_business_types.rb
+- lib/lightspeed_sandbox_simulator/db/migrate/20260313000003_create_categories.rb
+- lib/lightspeed_sandbox_simulator/db/migrate/20260313000004_create_items.rb
+- lib/lightspeed_sandbox_simulator/db/migrate/20260313000005_create_simulated_orders.rb
+- lib/lightspeed_sandbox_simulator/db/migrate/20260313000006_create_simulated_payments.rb
+- lib/lightspeed_sandbox_simulator/db/migrate/20260313000007_create_api_requests.rb
+- lib/lightspeed_sandbox_simulator/db/migrate/20260313000008_create_daily_summaries.rb
+- lib/lightspeed_sandbox_simulator/generators/data_loader.rb
+- lib/lightspeed_sandbox_simulator/generators/entity_generator.rb
+- lib/lightspeed_sandbox_simulator/generators/order_generator.rb
+- lib/lightspeed_sandbox_simulator/models/api_request.rb
+- lib/lightspeed_sandbox_simulator/models/business_type.rb
+- lib/lightspeed_sandbox_simulator/models/category.rb
+- lib/lightspeed_sandbox_simulator/models/daily_summary.rb
+- lib/lightspeed_sandbox_simulator/models/item.rb
+- lib/lightspeed_sandbox_simulator/models/simulated_order.rb
+- lib/lightspeed_sandbox_simulator/models/simulated_payment.rb
+- lib/lightspeed_sandbox_simulator/seeder.rb
+- lib/lightspeed_sandbox_simulator/services/base_service.rb
+- lib/lightspeed_sandbox_simulator/services/lightspeed/business_service.rb
+- lib/lightspeed_sandbox_simulator/services/lightspeed/menu_service.rb
+- lib/lightspeed_sandbox_simulator/services/lightspeed/order_service.rb
+- lib/lightspeed_sandbox_simulator/services/lightspeed/payment_method_service.rb
+- lib/lightspeed_sandbox_simulator/services/lightspeed/payment_service.rb
+- lib/lightspeed_sandbox_simulator/services/lightspeed/services_manager.rb
+homepage: https://github.com/dan1d/lightspeed_sandbox_simulator
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.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: Lightspeed K-Series POS sandbox data simulator
+test_files: []