Sinatra::Shopified

This is a work-in-progress extension for Sinatra which provides some basic helpers and routes to create a Sinatra-powered Shopify application.

Sinatra 1 and Sinatra 2 are both supported.

Add this line to your application's Gemfile:

gem 'sinatra-shopified'

Then, execute bundle to install then Gem.

This assumes you have ActiveRecord up and running and you are using a modular-style Sinatra application.

In your Sinatra application, load the Gem:

require 'sinatra/shopified'

Now, register it. As an example:

require 'sinatra/base'
require 'sinatra/shopified'

class MyCoolApp < Sinatra::Base
  # ...
  register Sinatra::Shopified
  # ...
end

This Gem provides a model of Shop which contains a couple of basic columns (shop domain and token).

Here is the migration for ActiveRecord if you wish to use it:

class Shop < ActiveRecord::Migration
  def up
    create_table :shops do |t|
      t.string :shop
      t.string :token, null: true
    end
  end

  def down
    drop_table :shops
  end
end

Alternatively, you can just load in the SQL:

CREATE TABLE `shops` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `shop` text NOT NULL,
  `token` text NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;

You can extends the built-in Shop model if need-be by doing the following in your own app:

module YourApp
  module Models
    class Shop < Sinatra::Shopified::Models::Shop
      # Your extra code here
    end
  end
end

This Gem uses environment variables (ENV) for the Shopify config. dotenv Gem is a great way to manage environment variables.

Here is a guide for all required environment variables you can set:

SHOPIFY_API_KEY='YOUR APP API KEY'
SHOPIFY_API_SECRET='YOUR APP API PASSWORD'
SHOPIFY_API_SCOPE='YOUR APP SCOPES' # Comma-separated example: "read_themes,write_themes"
SHOPIFY_APP_REDIRECT_AFTER_AUTH='/' # Where to redirect after authentication is completed (example: /admin)

YARD is used for documentation. Simply run bundle exec yardoc to generate the documentation of the code and open doc/index.html in your browser.

For initial runs, simply setup the database, migrate the db, and load the seeds in.

bundle exec rake db:create
bundle exec rake db:migrate
bundle exec rake db:seed
bundle exec rake test

For Appraisal testing:

appraisal install
appraisal rake test

There are a couple noteable helper methods.

This will return the current authenticated shop from your database

You are <%= current_shop.shop %>

This is a helper method you can run which will ensure the shop can access the page. If it can, it will activate the shop's session with Shopify. If it can not, it will redirect the shop to the auth page.

You can place this anywhere you need to use the Shopify API, such as at the top of a route.

class PendingController < Sinatra::Base
  # ...
  register Sinatra::Shopified
  # ...
  get "/admin" do
    authorize_shop

    product = ShopifyAPI::Product.find 1787887
    # ...
  end
  # ...
end

or, use it in a before filter:

# ...
before do
  authorize_shop if request.path.include? "/admin"
end
# ...

If you are using ESDK and need to escape the iFrame to do a redirect (maybe go to /admin/products, an off-site link) this method can help.

  return esdk_redirect "https://#{current_shop.shop}/admin/products"

Useful for if you wish to temporarily use the Shopify API with another shop.

shop = Shopified::Models::Shop.find_by(shop: "coolshop.myshopify.com")
shopify_session_with shop do
  ShopifyAPI::Product.find 42
end

This module adds one route.

With the use of authorize_shop or simply visting /auth. When creating your app in the Partner section, set this as the redirect_uri.

The Gem is available as open source under the terms of the MIT License.