playbook.md

Playbook

Running Locally

Prereqs:

• A shopify application and credentials

• A development domain with https (I have a personal domain but ngork also works). This domain needs to be configured in Shopify and in the AfterInstallJob.

• A .env file that includes:

  SHOPIFY_API_KEY=
  SHOPIFY_SHARED_SECRET=
  SECRET=
  SIDEKIQ_USERNAME=
  SIDEKIQ_PASSWORD=
  DEVELOPMENT=1
  

Then run OVERMIND_PROCESSES=web,worker PORT=5000 overmind start

Testing

To run a single test file:

bundle exec rake test TEST=test/app_test.rb

Staging

git add remote staging https://git.heroku.com/taxreceipts-staging.git
git push staging <branch_name>:master -f

Debug Production

Sinatra console on production:

heroku run bundle exec irb --app taxreceipts

require_relative 'src/app.rb'

Debug a shop

heroku run bundle exec rake debug_shop\[kevintest3.myshopify.com\] --app taxreceipts

$> starts irb with the shop activated for API use

Check webhooks for shop:

name = 'kevintest3.myshopify.com'
shop = Shop.find_by(name: name)

api_session = ShopifyAPI::Session.new(domain: shop.name, token: shop.token, api_version: API_VERSION)
ShopifyAPI::Base.activate_session(api_session)

ShopifyAPI::Webhook.all

Re-create the webhook (after checking using the above):

order_webhook = ShopifyAPI::Webhook.new({topic: 'orders/paid', address: 'https://taxreceipts.herokuapp.com/order.json', format: 'json'})
order_webhook.save

List products setup for a shop:

products = Product.where(shop: 'kevintest3.myshopify.com').pluck(:id)

Parsing product_ids from order json:

require 'json'
file = File.read('order.json')
json = JSON.parse(file)
ids = json['order']['line_items'].map{ |l| l['product_id'] }

Migrations

To create a migration run:

bundle exec rake db:create_migration NAME=_______

If you are backfilling and need encrypted shop tokens use:

foreman run bundle exec rake db:migrate