automation-api 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b5c379106726417528c8660c525662b6657259cc4b9e6b7065e29b5ed729cb7d
+  data.tar.gz: c6f63c3fc5e93cafd8e53eb38b980740b9d8270a8708e88cc74351ead25f2d85
+SHA512:
+  metadata.gz: 1d6f9001ca6e399270b8ae2adf832606657bea8c5fd7b65985f4d4364367882fa71742a68d3099d7e2ec2f02c5db9ef8894b35a26c5a0ae90cee0a69c2c5c837
+  data.tar.gz: dc6537d24579e74bcb602b0acb8b848987c11f6cd32722ee9a1ed14070d63cfc4375a2671a772db1cb17926b87bc67e6d0dd3d07221c7f12da2271b2587b2a87

data/.dependabot/config.yml

@@ -0,0 +1,8 @@
+version: 1
+update_configs:
+  - package_manager: "ruby:bundler"
+    directory: "/"
+    update_schedule: "live"
+    allowed_updates:
+    - match:
+        update_type: "security"

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/log/
+/pkg/
+/spec/pacts/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,3 @@
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.5.5

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.5
+before_install: gem install bundler -v 1.16.6

data/CHANGELONG.md

@@ -0,0 +1,13 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.3.0] - 11/01/2021
+
+### Added
+
+- CHANGELOG.md added.
+- Appsync 

data/Dockerfile

@@ -0,0 +1,16 @@
+FROM ruby:2.5.5
+
+LABEL DevOps <devops@shopkeep.com>
+
+RUN mkdir -p /usr/src/app
+WORKDIR /usr/src/app
+
+RUN gem install bundler
+
+RUN mkdir -p /lib/automation
+COPY Gemfile* ./
+COPY *.gemspec ./
+COPY lib/automation/api/version.rb ./lib/automation/api/
+RUN bundle install --binstubs --jobs 4 --retry 3
+
+COPY . ./

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in automation-api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,149 @@
+PATH
+  remote: .
+  specs:
+    automation-api (0.3.0)
+      graphql-client (~> 0.16.0)
+      json (>= 1.8, < 3)
+      rest-client (~> 2.1)
+      thor (~> 0.20)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    awesome_print (1.8.0)
+    codeclimate-test-reporter (1.0.7)
+      simplecov
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    faker (2.10.1)
+      i18n (>= 1.6, < 2)
+    filelock (1.1.1)
+    find_a_port (1.0.1)
+    graphql (1.11.6)
+    graphql-client (0.16.0)
+      activesupport (>= 3.0)
+      graphql (~> 1.8)
+    http-accept (1.7.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    httparty (0.17.3)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    json (2.3.0)
+    method_source (0.9.2)
+    mime-types (3.3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2019.1009)
+    minitest (5.14.3)
+    multi_xml (0.6.0)
+    netrc (0.11.0)
+    pact (1.47.0)
+      pact-mock_service (~> 3.0, >= 3.3.1)
+      pact-support (~> 1.9)
+      rack-test (>= 0.6.3, < 2.0.0)
+      rspec (~> 3.0)
+      term-ansicolor (~> 1.0)
+      thor (~> 0.20)
+      webrick (~> 1.3)
+    pact-mock_service (3.5.0)
+      filelock (~> 1.1)
+      find_a_port (~> 1.0.1)
+      json
+      pact-support (~> 1.12, >= 1.12.0)
+      rack (~> 2.0)
+      rspec (>= 2.14)
+      term-ansicolor (~> 1.0)
+      thor (~> 0.19)
+      webrick (~> 1.3)
+    pact-support (1.13.0)
+      awesome_print (~> 1.1)
+      randexp (~> 0.1.7)
+      rspec (>= 2.14)
+      term-ansicolor (~> 1.0)
+    pact_broker-client (1.23.0)
+      httparty
+      json
+      rake
+      table_print (~> 1.5)
+      term-ansicolor
+      thor (~> 0.20)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rake (12.3.3)
+    randexp (0.1.7)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    simplecov (0.18.1)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11.0)
+    simplecov-html (0.11.0)
+    simplecov-rcov (0.2.3)
+      simplecov (>= 0.4.1)
+    sync (0.5.0)
+    table_print (1.5.6)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (0.20.3)
+    tins (1.24.1)
+      sync
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.7)
+    webrick (1.6.0)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  automation-api!
+  bundler (~> 1.16)
+  codeclimate-test-reporter (~> 1.0)
+  faker (~> 2.4)
+  pact (~> 1.42)
+  pact_broker-client (~> 1.20)
+  pry (~> 0.12.2)
+  rake (~> 12.3, >= 12.3.3)
+  rspec (~> 3.8)
+  rspec_junit_formatter (~> 0.2)
+  simplecov (~> 0.13)
+  simplecov-rcov (~> 0.2)
+
+BUNDLED WITH
+   1.17.3

data/Jenkinsfile

@@ -0,0 +1,31 @@
+@Library('shared-pipelines@master') _
+
+pipeline {
+    agent { label 'docker-slave-staging' }
+
+    stages {
+        stage('Test') {
+            environment { COVERAGE = true }
+
+            steps {
+                runTests results: '/usr/artifacts/rspec.xml'
+            }
+        }
+        stage('Build Package') {
+            steps {
+                buildPackage language: 'ruby'
+            }
+        }
+        stage('Publish Package') {
+            when { branch 'master' }
+            steps {
+                publishPackage language: 'ruby'
+            }
+        }
+    }
+    post {
+        always {
+            cleanWs()
+        }   
+    }
+}

data/README.md

@@ -0,0 +1,176 @@
+# Automation::API
+
+Gem for making HTTP requests to BackOffice Staging
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+source 'https://5a8e458f6acf55f1543dc82e924301613c8f8cfba0fd5949:@packagecloud.io/shopkeep/ruby' do
+  gem 'automation-api'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install --source 'https://5a8e458f6acf55f1543dc82e924301613c8f8cfba0fd5949:@packagecloud.io/shopkeep/ruby' automation-api
+
+## Usage
+
+
+### Help
+
+    $ store-gen help
+    
+    Commands:
+    store-gen create [PROFILE]    # Create store of using specified profile
+    store-gen help [COMMAND]      # Describe available commands or one specific command
+    store-gen list                # List of predifined store profiles
+    store-gen new_profile [NAME]  # Start creating a new custom profile
+    store-gen view [PROFILE]      # View config file for requested profile
+
+So for detailed 'help' for 'create'.
+
+    $ store-gen help create
+
+
+### Listing
+
+    $ store-gen list
+
+    basic
+    essential
+    loyalty
+    online
+    profile
+    restrictions
+    starter
+
+List of predifined store porfiles.
+
+
+#### Additional Options
+
+    --path, [--profile-path=PROFILE_PATH]  # Specify a path to the directory containing the profile configuration
+
+If you choose to create your own custom profile(s), use this flag to point to the correct directory.
+
+
+### View configuration
+
+    $ store-gen view [PROFILE]
+
+    :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
+
+View config file for requested profile(basic in the example above). Used for reference, or if creating a custom profile that extends an existing.
+
+
+#### Additional Options
+
+    --path, [--profile-path=PROFILE_PATH]  # Specify a path to the directory containing the profile configuration
+
+If you choose to create your own custom profile(s), use this flag to point to the correct directory.
+
+
+### Generating a store
+
+    $ store-gen create [PROFILE]
+
+    {"email"=>"gen+841r25@shopkeep.com",
+    "subdomain"=>"test-auto-thor-7a6a0b03",
+    "password"=>"password",
+    "ok"=>true,
+    "uuid"=>"6DC1E24C-99EF-4F86-9ECD-139E0B29403E",
+    "login"=>"gen+841r25@shopkeep.com",
+    "register_id"=>1,
+    "register_number"=>1,
+    "manager_signin"=>"8997"}
+    Updating account owner information...done
+
+Create store of using specified profile(basic in the example above). By default this will create an 'empty' and then use the porfile configuration provided to make further changes.
+
+
+#### Additional Options
+
+    -a, [--archetype=ARCHETYPE]
+    
+Store archetype - the base upon which the profile is built. By default it creates an 'empty' store. Typically we use 'complex' stores during automation as they have a number of items, customers, tax groups whatnot, pre-baked. The final option is 'coffee_shop'. These 'archetypes' correspond with those visible when creating a test account through the brower.
+
+
+    -l, [--license-count=N]
+
+Number of register license available. When running automation it's usually the case that the app state is reset between tests. Every test uses a new licens. When you run use them up you'll need to deactivate registers or create a new store. The default here is 100
+
+
+    -s, [--subdomain=SUBDOMAIN]
+
+Store subdomain - randomly generated if not given. If you are supplying your own specific subdomain it should start with 'test'. eg 'test-97422cfe', 'test-romantic-adventerous-cows'
+
+
+    -e, [--email=EMAIL]
+    
+Email address associated with account - randomly generated if not given
+
+
+    -p, [--password=PASSWORD]
+    
+Password for account owner. Default is 'password
+
+
+    -t, [--time-zone=TIME_ZONE]
+    
+Store time zone. Default is 'Eastern Time (US & Canada)'. Any validation is happening elsewhere, so if you are changing this, best to check it's validity first.
+
+
+    -x, [--sk-expert=SK_EXPERT]
+    -e, [--sk-employee=SK_EMPLOYEE]
+
+TODO: find out what these are for.
+
+
+    -c, [--processor=PROCESSOR]
+    
+Credit card processor. One of the few abstractions, this option makes a number of changes to the store settings to allow card payments to be processed. # Possible values: tgate_dev(default), tgate_prod, tgate_mock, clover, freedompay_uat, tgate_emulator_uat, broken, none.
+
+    --path, [--profile-path=PROFILE_PATH]  # Specify a path to the directory containing the profile configuration
+
+If you choose to create your own custom profile(s), use this flag to point to the correct directory.
+
+
+### Creating a custom profile
+
+    $ store-gen new_profile [NAME]
+
+This will create a copy of the example profile config using the provided NAME. From there you can write your own confifguration.
+
+
+#### Additional Options
+
+    --path, [--profile-path=PROFILE_PATH]  # Specify a path to the directory containing the profile configuration
+
+If you choose to create your own custom profile(s), use this flag to point to the correct directory. By default it will create the new profile in your current directory. If you then want to create a store using this configuration, you'll have to supply the `--path` to the `create` command. 
+
+
+### Disclaimer
+
+There's plenty here subject to change so I appologise for any mistakes or omissions in the documentaion. Any querries? Post on Slack - #testengineering or #reflektor