sinatra-embedded-shopify-app 0.5.16

data/example/Gemfile.lock

@@ -0,0 +1,126 @@
+PATH
+  remote: ..
+  specs:
+    sinatra-embedded-shopify-app (0.5.16)
+      activesupport
+      omniauth (~> 2.0, >= 2.0.4)
+      omniauth-shopify-oauth2 (~> 2.3, >= 2.3.2)
+      shopify_api (= 9.5.1)
+      sinatra (>= 2.2, < 3.1)
+      sinatra-activerecord (~> 2.0.9)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activemodel-serializers-xml (1.0.2)
+      activemodel (> 5.x)
+      activesupport (> 5.x)
+      builder (~> 3.1)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activeresource (6.0.0)
+      activemodel (>= 6.0)
+      activemodel-serializers-xml (~> 1.0)
+      activesupport (>= 6.0)
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.2.2)
+    fakeweb (1.3.0)
+    faraday (2.7.4)
+      faraday-net_http (>= 2.0, < 3.1)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (3.0.2)
+    graphql (2.0.21)
+    graphql-client (0.18.0)
+      activesupport (>= 3.0)
+      graphql
+    hashie (5.0.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    jwt (2.7.0)
+    mini_portile2 (2.8.2)
+    minitest (5.18.0)
+    mocha (1.15.0)
+    multi_xml (0.6.0)
+    mustermann (2.0.2)
+      ruby2_keywords (~> 0.0.1)
+    oauth2 (2.0.9)
+      faraday (>= 0.17.3, < 3.0)
+      jwt (>= 1.0, < 3.0)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 4)
+      snaky_hash (~> 2.0)
+      version_gem (~> 1.1)
+    omniauth (2.1.1)
+      hashie (>= 3.4.6)
+      rack (>= 2.2.3)
+      rack-protection
+    omniauth-oauth2 (1.8.0)
+      oauth2 (>= 1.4, < 3)
+      omniauth (~> 2.0)
+    omniauth-shopify-oauth2 (2.3.2)
+      activesupport
+      omniauth-oauth2 (~> 1.5)
+    pg (1.4.3)
+    rack (2.2.6.4)
+    rack-protection (2.2.4)
+      rack
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rake (13.0.6)
+    ruby2_keywords (0.0.5)
+    shopify_api (9.5.1)
+      activeresource (>= 4.1.0)
+      graphql-client
+      rack
+    sinatra (2.2.4)
+      mustermann (~> 2.0)
+      rack (~> 2.2)
+      rack-protection (= 2.2.4)
+      tilt (~> 2.0)
+    sinatra-activerecord (2.0.26)
+      activerecord (>= 4.1)
+      sinatra (>= 1.0)
+    sinatra-flash (0.3.0)
+      sinatra (>= 1.0.0)
+    snaky_hash (2.0.1)
+      hashie
+      version_gem (~> 1.1, >= 1.1.1)
+    sqlite3 (1.5.1)
+      mini_portile2 (~> 2.8.0)
+    sqlite3 (1.5.1-x86_64-linux)
+    tilt (2.0.11)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    version_gem (1.1.2)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  byebug
+  fakeweb
+  minitest
+  mocha
+  pg
+  rack-test
+  rake (>= 12.3.3)
+  sinatra-activerecord
+  sinatra-embedded-shopify-app!
+  sinatra-flash
+  sqlite3
+
+RUBY VERSION
+   ruby 2.7.7p221
+
+BUNDLED WITH
+   2.4.12

data/example/Procfile

@@ -0,0 +1 @@
+web: bundle exec rackup config.ru -p $PORT

data/example/README.md

@@ -0,0 +1,4 @@
+New Sinatra Embedded Shopify App
+=======================
+
+Fill me in!

data/example/Rakefile

@@ -0,0 +1,19 @@
+require 'sinatra/activerecord/rake'
+require 'rake/testtask'
+require './src/app'
+
+namespace :test do
+  task :prepare do
+    `RACK_ENV=test rake db:create`
+    `RACK_ENV=test rake db:migrate`
+    `RACK_ENV=test SECRET=secret rake db:seed`
+  end
+end
+
+task :test do
+  Rake::TestTask.new do |t|
+    t.pattern = 'test/*_test.rb'
+    t.libs << 'test'
+    t.verbose = true
+  end
+end

data/example/config/database.yml

@@ -0,0 +1,12 @@
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+
+production:
+  url: <%= ENV['DATABASE_URL'] %>
+
+test:
+  adapter: sqlite3
+  database: "db/test.sqlite3"
+  pool: 8

data/example/config.ru

@@ -0,0 +1,3 @@
+require './src/app'
+SinatraApp.set :bind, '0.0.0.0'
+SinatraApp.run!

data/example/db/migrate/20140413221328_create_shops.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class CreateShops < ActiveRecord::Migration[5.1]
+  def self.up
+    create_table :shops do |t|
+      t.string :shopify_domain
+      t.string :shopify_token
+    end
+  end
+
+  def self.down
+    drop_table :shops
+  end
+end

data/example/db/migrate/20140414042317_add_index_to_shops.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class AddIndexToShops < ActiveRecord::Migration[5.1]
+  def self.up
+    add_index :shops, :shopify_domain
+  end
+
+  def self.down
+    remove_index :shops, :shopify_domain
+  end
+end

data/example/db/schema.rb

@@ -0,0 +1,20 @@
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# This file is the source Rails uses to define your schema when running `bin/rails
+# db:schema:load`. When creating a new database, `bin/rails db:schema:load` tends to
+# be faster and is potentially less error prone than running all of your
+# migrations from scratch. Old migrations may fail to apply correctly if those
+# migrations use external dependencies or application code.
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema[7.0].define(version: 2014_04_14_042317) do
+  create_table "shops", force: :cascade do |t|
+    t.string "shopify_domain"
+    t.string "shopify_token"
+    t.index ["shopify_domain"], name: "index_shops_on_shopify_domain"
+  end
+
+end

data/example/db/seeds.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+shop = Shop.create(shopify_domain: 'testshop.myshopify.com', shopify_token: 'token')

data/example/src/app.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'sinatra/sinatra-embedded-shopify-app'
+require 'sinatra/flash'
+
+# SinatraApp
+class SinatraApp < Sinatra::Base
+  register Sinatra::Shopify
+  register Sinatra::Flash
+
+  # set the scope that your app needs, read more here:
+  # http://docs.shopify.com/api/tutorials/oauth
+  set :scope, 'read_products, read_orders'
+
+  # Your App's Home page
+  # this is a simple example that fetches some products
+  # from Shopify and displays them inside your app
+  get '/' do
+    shopify_session do |shop_name|
+      @shop = ShopifyAPI::Shop.current
+      @products = ShopifyAPI::Product.find(:all, params: { limit: 10 })
+      erb :home
+    end
+  end
+
+  # this endpoint recieves the uninstall webhook
+  # and cleans up data, add to this endpoint as your app
+  # stores more data.
+  shopify_webhook '/uninstall' do |shop_name, params|
+    Shop.find_by(shopify_domain: shop_name).destroy
+  end
+
+  private
+
+  # This method gets called when your app is installed.
+  # setup any webhooks or services you need on Shopify
+  # inside here.
+  def after_shopify_auth
+    # shopify_session do
+      # create an uninstall webhook, this webhook gets sent
+      # when your app is uninstalled from a shop. It is good
+      # practice to clean up any data from a shop when they
+      # uninstall your app:
+
+      # uninstall_webhook = ShopifyAPI::Webhook.new(
+      #   topic: 'app/uninstalled',
+      #   address: "#{base_url}/uninstall",
+      #   format: 'json'
+      # )
+      # begin
+      #   uninstall_webhook.save!
+      # rescue => e
+      #   raise unless uninstall_webhook.persisted?
+      # end
+    # end
+  end
+end

data/example/test/app_test.rb

@@ -0,0 +1,81 @@
+require 'test_helper'
+require './src/app'
+
+class MockShop
+  def initialize(shop_name)
+    @shop_name = shop_name
+  end
+
+  def myshopify_domain
+    @shop_name
+  end
+end
+
+class AppTest < Minitest::Test
+  def app
+    SinatraApp
+  end
+
+  def setup
+    @shop_name = 'testshop.myshopify.com'
+    @shopify_shop = MockShop.new(@shop_name)
+  end
+
+  def test_root_with_session
+    set_session
+    api_url = "https://testshop.myshopify.com/admin/api/#{app.settings.api_version}"
+    fake "#{api_url}/shop.json", body: {myshopify_domain: @shop_name}.to_json
+    fake "#{api_url}/products.json?limit=10", body: '{}'
+    get '/'
+    assert last_response.ok?
+  end
+
+  def test_root_with_session_activates_api
+    set_session
+    SinatraApp.any_instance.expects(:activate_shopify_api).with(@shop_name, 'token')
+    ShopifyAPI::Shop.expects(:current).returns(@shopify_shop)
+    ShopifyAPI::Product.expects(:find).returns([])
+    get '/'
+    assert last_response.ok?
+  end
+
+  def test_root_without_session_redirects_to_install
+    get '/'
+    assert_equal 302, last_response.status
+    assert_equal 'http://example.org/login', last_response.location
+  end
+
+  def test_root_with_shop_redirects_to_auth
+    get '/?shop=othertestshop.myshopify.com'
+    assert_equal 'http://example.org/login?shop=othertestshop.myshopify.com', last_response.location
+  end
+
+  def test_root_with_session_and_new_shop_redirects_to_auth
+    set_session
+    get '/?shop=othertestshop.myshopify.com'
+    assert_equal 'http://example.org/login?shop=othertestshop.myshopify.com', last_response.location
+  end
+
+  def test_root_rescues_UnauthorizedAccess_clears_session_and_redirects
+    set_session
+    SinatraApp.any_instance.expects(:activate_shopify_api).with(@shop_name, 'token')
+    SinatraApp.any_instance.expects(:clear_session)
+    ShopifyAPI::Shop.expects(:current).raises(ActiveResource::UnauthorizedAccess.new('UnauthorizedAccess'))
+    get '/'
+    assert_equal 302, last_response.status
+    assert_equal 'http://example.org/', last_response.location
+  end
+
+  def test_uninstall_webhook_endpoint
+    SinatraApp.any_instance.expects(:verify_shopify_webhook).returns(true)
+    Shop.any_instance.expects(:destroy)
+    post '/uninstall', '{}', 'HTTP_X_SHOPIFY_SHOP_DOMAIN' => @shop_name
+    assert last_response.ok?
+  end
+
+  private
+
+  def set_session(shop = 'testshop.myshopify.com', token = 'token')
+    SinatraApp.any_instance.stubs(:session).returns(shopify: { shop: shop, token: token })
+  end
+end

data/example/test/test_helper.rb

@@ -0,0 +1,31 @@
+$VERBOSE = nil
+
+ENV['RACK_ENV'] = 'test'
+ENV['SECRET'] = 'secret'
+
+require 'minitest/autorun'
+require 'rack/test'
+require 'mocha/minitest'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+module Helpers
+  include Rack::Test::Methods
+
+  def load_fixture(name)
+    File.read("./test/fixtures/#{name}")
+  end
+
+  def fake(url, options = {})
+    method = options.delete(:method) || :get
+    body = options.delete(:body) || '{}'
+    format = options.delete(:format) || :json
+
+    FakeWeb.register_uri(method, url, { body: body, status: 200, content_type: "application/#{format}" }.merge(options))
+  end
+end
+
+class Minitest::Test
+  include Helpers
+end

data/example/views/_flash_messages.erb

@@ -0,0 +1,25 @@
+<script type="text/javascript">
+  var AppBridge = window['app-bridge'];
+
+  var actions = AppBridge.actions;
+  var Toast = actions.Toast;
+
+  <% if flash[:notice] %>
+    var notice = Toast.create(app, {
+      message: "<%= flash[:notice] %>",
+      duration: 5000
+    });
+
+    notice.dispatch(Toast.Action.SHOW);
+  <% end %>
+
+  <% if flash[:error] %>
+    var notice = Toast.create(app, {
+      message: "<%= flash[:error] %>",
+      duration: 5000,
+      isError: true,
+    });
+
+    notice.dispatch(Toast.Action.SHOW);
+  <% end %>
+</script>

data/example/views/_top_bar.erb

@@ -0,0 +1,10 @@
+<script type="text/javascript">
+  var AppBridge = window['app-bridge'];
+
+  var actions = AppBridge.actions;
+  var TitleBar = actions.TitleBar;
+
+  var titleBar = TitleBar.create(app, {
+    icon: '<%= "#{base_url}/icon.png" %>'
+  });
+</script>

data/example/views/home.erb

@@ -0,0 +1,11 @@
+<h3>Shopify Sinatra App</h3>
+<p>Welcome!</p>
+
+<h3>Products</h3>
+<ul>
+  <% @products.each do |product| %>
+    <li><a href=<%="https://#{@shop.myshopify_domain}/admin/products/#{product.id}"%> target="_blank"> <%= product.id %> </a></li>
+  <% end %>
+</ul>
+
+<a href="/logout">Logout</a>

data/example/views/layouts/application.erb

@@ -0,0 +1,26 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <script src="https://unpkg.com/@shopify/app-bridge@3"></script>
+  <script type="text/javascript">
+    var AppBridge = window['app-bridge'];
+
+    var host = '<%= shop_host %>';
+    var apiKey = '<%= SinatraApp.settings.api_key %>';
+
+    var app = AppBridge.createApp({
+      apiKey: apiKey,
+      host: host
+    });
+  </script>
+  <link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" rel="stylesheet" integrity="sha256-7s5uDGW3AHqw6xtJmNNtr+OBRJUlgkNJEo78P4b0yRw= sha512-nNo+yCHEyn0smMxSswnf/OnX6/KwJuZTlNZBjauKhTK0c+zT+q5JOCx0UFhXQ6rJR9jg6Es8gPuD2uZcYDLqSw==" crossorigin="anonymous">
+</head>
+
+<body>
+  <div class="container">
+    <%= erb :'_top_bar', layout: false, locals: locals %>
+    <%= erb :'_flash_messages', layout: false, locals: locals %>
+    <%= yield %>
+  </div>
+</body>
+</html>

data/example/views/login.erb

@@ -0,0 +1,42 @@
+<link href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css" rel="stylesheet" integrity="sha256-7s5uDGW3AHqw6xtJmNNtr+OBRJUlgkNJEo78P4b0yRw= sha512-nNo+yCHEyn0smMxSswnf/OnX6/KwJuZTlNZBjauKhTK0c+zT+q5JOCx0UFhXQ6rJR9jg6Es8gPuD2uZcYDLqSw==" crossorigin="anonymous">
+
+<style>
+  body {
+    background: #fff url(<%="#{base_url}/legend.gif"%>) no-repeat fixed right 130px;
+  }
+
+  .form-large input {
+    font-size: 18px;
+    padding: 8px;
+    height: auto;
+    line-height: normal;
+  }
+
+  .form-wide {
+    width: 480px;
+  }
+</style>
+
+<body>
+  <div style="margin-top: 100px"></div>
+
+  <div class="container">
+    <h1>Shopify Sinatra App</h1>
+    <h2><small>This app requires you to login to start using it.</small></h2>
+  </div>
+
+  <div style="margin-top: 30px"></div>
+
+  <div class="container">
+    <form id="login" role="form" class="form-large" action="/auth/shopify" method="post">
+      <input type="hidden" name="authenticity_token" value="<%= env['rack.session'][:csrf] %>" />
+      <div class="input-group form-wide">
+        <input class="form-control" name="shop" value="<%= params['shop'] %>" placeholder="your-shop-url.myshopify.com">
+        <span class="input-group-btn">
+          <input class="btn" type="submit" value="Login" />
+        </span>
+      </div>
+    </form>
+  </div>
+ </body>
+