automation-api 0.3.0

data/Rakefile

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'automation/api/version'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'pact/tasks'
+require 'pact_broker/client/tasks'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+
+# Run with `bundle exec rake pact:publish`
+PactBroker::Client::PublicationTask.new do |task|
+  version    = Automation::API::VERSION
+  git_commit = ENV.fetch('GIT_COMMIT')
+  git_branch = ENV.fetch('GIT_BRANCH')
+
+  task.consumer_version = "#{version}-#{git_commit}"
+
+  # optional, default value is 'spec/pacts/*.json'
+  # task.pattern = 'spec/pacts/*.json'
+
+  task.pact_broker_base_url = 'https://pact-broker.internal.staging.posrip.com/'
+
+  # Optional but STRONGLY RECOMMENDED as it will greatly assist with your
+  # pact workflow. Result will be merged with other specified task.tags
+  # However this is retrieving the branch name, it doesn't work
+  # task.tag_with_git_branch = true
+
+  # Optional
+  task.tags = [git_branch]
+
+  # # Optional
+  # task.pact_broker_basic_auth = { username: '', password: '' }
+
+  # # Optional
+  # task.pact_broker_token = '1234abcd' # Bearer token
+
+  # # This will merge the published pact into an existing pact rather than
+  # # overwriting it if one exists. Not recommended, as it makes a mulch of
+  # # the workflow on the broker.
+  # task.write_method = :merge
+end

data/automation-api.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'automation/api/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name          = 'automation-api'
+  spec.version       = Automation::API::VERSION
+  spec.authors       = ['Marc Sangster']
+  spec.email         = ['msangster@shopkeep.com']
+  spec.summary       = 'Client for HTTP requests to BackOffice'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'graphql-client', '~> 0.16.0'
+  spec.add_dependency 'json', '>= 1.8', '< 3'
+  spec.add_dependency 'rest-client', '~> 2.1'
+  spec.add_dependency 'thor', '~> 0.20'
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 1.0'
+  spec.add_development_dependency 'faker', '~> 2.4'
+  spec.add_development_dependency 'pact', '~> 1.42'
+  spec.add_development_dependency 'pact_broker-client', '~> 1.20'
+  spec.add_development_dependency 'pry', '~> 0.12.2'
+  spec.add_development_dependency 'rake', '~> 12.3', '>= 12.3.3'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'rspec_junit_formatter', '~> 0.2'
+  spec.add_development_dependency 'simplecov', '~> 0.13'
+  spec.add_development_dependency 'simplecov-rcov', '~> 0.2'
+end
+# rubocop:enable Metrics/BlockLength

data/bin/console

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'automation/api'
+require 'pry'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+@uuid   = '<insert store uuid>'
+@client = Automation::API::Client.new(uuid: @uuid,
+                                      store: @store,
+                                      login: @login,
+                                      password: @password)
+
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/basic.yml

@@ -0,0 +1,16 @@
+:account_owner:
+  :first_name: Test
+  :last_name: Basic
+  :phone: '9736928048'
+  :entitlements:
+    :activate:
+      - standard_care
+      - customer_recognition
+      - price_packaging
+      - point_of_sale
+      # Default: Here for reference
+      # - pocket
+      # - freemium_care
+      # - billing_management
+    :deactivate:
+      - freemium

data/config/essential.yml

@@ -0,0 +1,21 @@
+:account_owner:
+  :first_name: Test
+  :last_name: Essential
+  :phone: '9736928048'
+:entitlements:
+  :activate:
+    - standard_care
+    - sales_restrictions
+    - pocket_date_picker
+    - customer_recognition
+    - custom_permissions
+    - price_packaging
+    - online_ordering
+    - quickbooks
+    - gift_card
+    - mailchimp
+    - webstore
+    - advanced_reporting
+    - point_of_sale
+  :deactivate:
+    - freemium

data/config/loyalty.yml

@@ -0,0 +1,7 @@
+:account_owner:
+  :first_name: Test
+  :last_name: Loyalty
+  :phone: '9736928048'
+:loyalty_provisioned: true
+:location_preferences:
+  :loyalty_enabled: true

data/config/online.yml

@@ -0,0 +1,17 @@
+:account_owner:
+  :first_name: Test
+  :last_name: Online
+  :phone: '9736928048'
+:settings:
+  :location_name: Online Ordering Test
+  :location_addr1: 1 Yemen Street
+  :location_addr2: Yemen
+  :location_city: Yemen
+  :location_postal_code: YM111
+  :location_phone: '1111111111'
+  :location_state: AK
+  :location_country: United States
+:entitlements:
+  :activate:
+    - online_ordering
+:online_ordering: true

data/config/profile.yml.example

@@ -0,0 +1,231 @@
+# Below is an example configuration just to give an idea of what can be done,
+# and the shape of the data. No validation is done this side, so if something
+# isn't right the request to request will simply fail.
+
+# Account owner information is required if you plan on using loyalty.
+# I believe '9736928048' is the magic phone number that must be used in this case.
+:account_owner:
+  # :login: ~
+  # :email: ~
+  :first_name: Test
+  :last_name: Example
+  :phone: '9736928048'
+
+# Not required, but can help to dry up some of the configuration.
+:customer: &customer
+  :last_name: Simpson
+  :address_line1: 742 Evergreen Terrace
+  # Additonal customer fields
+  # :first_name: ~
+  # :email: ~
+  # :address_line2: ~
+  # :city: ~
+  # :state: ~
+  # :zip: ~
+  # :phone: ~
+  # :account_code: ~
+  # :account_type: ~
+  # :tax_exempt: ~
+  # :sales_tax_number: ~
+  # :notes:
+
+# An Array of customers to add
+:customers:
+  - <<: *customer
+    :first_name: Homer
+  - <<: *customer
+    :first_name: Marge
+  - <<: *customer
+    :first_name: Bart
+  - <<: *customer
+    :first_name: Lisa
+  - <<: *customer
+    :first_name: Maggie
+
+# :employee: &employee
+  # :first_name: ~
+  # :last_name: ~
+  # :phone: ~
+  # :email: ~
+  # :login: ~
+  # :register_name: ~
+  # :register_code: ~
+  # :manager: ~
+  # :password: ~
+  # :ipad_login_code:
+  # :register_manager_signin: ~
+  # :register_cashier_signin: ~
+  # :hourly_wage: ~
+
+:employees:
+  - :first_name: Working
+    :last_name: Hard
+    :manager: false
+    :ipad_login_code: 9090
+  - :first_name: Hardly
+    :last_name: Working
+    :manager: true
+    :ipad_login_code: 3948
+
+# Entitlements take an array of entitlements to 'activate' and another array to deactivate,
+# though neither is required.
+:entitlements:
+  :activate:
+    - standard_care
+    - price_packaging
+    - online_ordering
+  :deactivate:
+    - freemium
+
+# Works just like entitlements. Feature flag names are always snake_cased versions of
+# the backoffice admin list
+:features:
+  :activate:
+    - validated_clockpunch_ios
+    - item_sales_restrictions
+  :deactivate:
+    - check_sync_and_backup
+    - register_push_notification
+
+# Loyalty is not provisioned be default, so if you didn't want this
+# you would just leave it out entirely
+# :loyalty_provisioned: true
+
+# Loyalty must be provisioned before being enabled. Order matters
+:location_preferences:
+  :loyalty_enabled: false
+  :table_layout_enabled: true
+  :pinless_login_enabled: true
+  :guest_count_tracking: false
+  :guest_count_cashier_prompt: false
+
+# On iOS the first register assigned to an account will have coach marks displayed,
+# this can be a pain for automation. This option will discard the first register.
+:burn_first_register: false
+
+# Most of the settings are self explanatory. We've set the location information here
+# as it's a requirement for setting up online ordering.
+:settings:
+  # :publisher_name: ~
+  # :publisher_password: ~
+  # :merchant_location_code: ~
+  # :processor_name: ~
+  # :config_display_gratuity_line: ~
+  # :config_display_sig_line: ~
+  # :gift_card_processor_name: ~
+  # :gift_card_processor_url: ~
+  # :gift_card_processor_username: ~
+  # :gift_card_processor_password: ~
+  # :gift_card_enabled: ~
+  # :emv_enabled: ~
+  :location_name: Online Ordering Test
+  :location_addr1: 1 Yemen Street
+  :location_addr2: Yemen
+  :location_city: Yemen
+  :location_postal_code: YM111
+  :location_phone: '1111111111'
+  :location_state: AK
+  :location_country: United States
+  # :location_email: ~
+  # :location_website: ~
+  # :signature_on_paper_receipt: ~
+  # :tip_suggestions_on_paper: ~
+  # :combine_tip_and_signature_screens: ~
+  # :suggested_tip_1_value: ~
+  # :suggested_tip_1_type: ~
+  # :suggested_tip_2_value: ~
+  # :suggested_tip_2_type: ~
+  # :suggested_tip_3_value: ~
+  # :suggested_tip_3_type: ~
+  # :receipt_custom_text: ~
+  # :print_customer_delivery_on_tickets: ~
+  # :print_customer_delivery_on_checks: ~
+  # :print_customer_delivery_on_receipts: ~
+  # :show_receipt_logo: ~
+  # :config_display_powered_by: ~
+  # :apply_discounts_to_entire_subtotal: ~
+  # :require_manager_to_void: ~
+  # :tax_id: ~
+  # :default_home_screen: ~
+  # :auto_signout: ~
+  # :register_sync: ~
+  # :customer_facing_display_enabled: ~
+  
+  # Departments are simple and only have a 'name' field
+  :departments:
+    - :name: Restricted
+  
+  # If you reference a department, this will fetch the department by name and use the 'id'
+  :category: &category 
+    :department: Restricted
+  
+  :categories:
+    - :name: Age Restricted
+      <<: *category
+    - :name: Qty Restricted
+      <<: *category
+  
+  # Again, reference the department/categories by name and the relevant 'id' will be fetched
+  # before making the request
+  :sales_restrictions:
+    - :name: Age Restriction
+      :age_minimum: 21
+      :department: Restricted
+      :category: Age Restricted
+    - :name: Qty Restriction
+      :item_maximum: 3
+      :department: Restricted
+      :category: Qty Restricted
+  
+  :stock_item: &stock_item
+    :price_type: system
+    :price: 10.0
+    :department: Restricted
+    # :description:
+    # :department_id:
+    # :category_id:
+    # :register_data_status:
+    # :upc_code:
+    # :discountable:
+    # :taxable:
+    # :unit:
+    # :cost:
+    # :tax_id:
+    # :quantity_on_hand:
+    # :recommended_order:
+    # :order_trigger:
+    # :supplier_id:
+    # :select_modifiers_when_sold:
+    # :inventory_method:
+    # :assigned_cost:
+    # :printer_setting_id:
+  
+  :stock_items:
+    - <<: *stock_item
+      :description: Age Restricted Item
+      :category: Age Restricted
+    - <<: *stock_item
+      :description: Qty Restricted Item
+      :category: Qty Restricted
+  
+  :button_pages:
+    - :name: Restricted Items
+      :page_number: 0
+  
+  :button: &button
+    :page: Restricted Items
+    :x_offset: 0
+    :y_offset: 0
+    :item_type: StockItem
+  
+  :buttons:
+    - <<: *button
+      :item: Age Restricted Item
+    - <<: *button
+      :x_offset: 1
+      :item: Qty Restricted Item
+
+# This step blocks the request until the user activates a register.
+# For online orders to be received a register must be activated first, though
+# this step can be skipped.
+:online_ordering: true

data/config/restrictions.yml

@@ -0,0 +1,55 @@
+:features:
+  :activate:
+    - item_sales_restrictions
+
+:departments:
+  - :name: Restricted
+
+:category: &category 
+  :department: Restricted
+
+:categories:
+  - :name: Age Restricted
+    <<: *category
+  - :name: Qty Restricted
+    <<: *category
+
+:sales_restrictions:
+  - :name: Age Restriction
+    :age_minimum: 21
+    :department: Restricted
+    :category: Age Restricted
+  - :name: Qty Restriction
+    :item_maximum: 3
+    :department: Restricted
+    :category: Qty Restricted
+
+:stock_item: &stock_item
+  :price_type: system
+  :price: 10.0
+  :department: Restricted
+
+:stock_items:
+  - <<: *stock_item
+    :description: Age Restricted Item
+    :category: Age Restricted
+  - <<: *stock_item
+    :description: Qty Restricted Item
+    :category: Qty Restricted
+
+:button_pages:
+  - :name: Restricted Items
+    :page_number: 0
+
+:button: &button
+  :page: Restricted Items
+  :x_offset: 0
+  :y_offset: 0
+  :item_type: StockItem
+
+:buttons:
+  - <<: *button
+    :item: Age Restricted Item
+  - <<: *button
+    :x_offset: 1
+    :item: Qty Restricted Item