shopify-sinatra-app 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42c91774ed4f971d81f0a1d7f8d983e9b65b54de5abc8f27e84e2bc1fca4ac81
-  data.tar.gz: efadfb3fc31df9453e1a808e644a3045277d6316012104510954f93274d2ab06
+  metadata.gz: 824f5c84a183bf093bf35cb931166ed811fafb4dcdb32664a9c3027a56acf38f
+  data.tar.gz: 4369c1e33e0032792d4016f772bd041f3eb85aea722e015a9d7e1aed48e29f78
 SHA512:
-  metadata.gz: 52b38bf496bc1092461c61f846e6fb3770c9d923977d5e6d5224a953bc06b379078423b4160252d84177263806cef6d1027a9b76a997853613889469f66ac784
-  data.tar.gz: f1c509bdd3356a3c07d22f7bde37cbf777954d97c4831f3dee15d7b653cc3f8c6c3e77943c083bc302cf7fd91bce37b428dc506b3a778f955bc1a515d7e54caf
+  metadata.gz: e64a1b720743bde0a66a79c39d5574d62f9867da1c7bb479a96253051197efb6e21f0a9366c59d1d98d503478b50a69c3707ba4300fefda601e26a78f7b5f042
+  data.tar.gz: 7ff7babe886332b170e4ae052669acba61a922ee2b814a77b0d52d0c72ce5920ad7171e80956dcdac81358e4489acf17002448f6f784f2dacf9d57744b2c85a4

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 
 rvm:
-  - 2.5.0
+  - 2.5.3
 
 gemfile: example/Gemfile
 

data/CHANGELOG

@@ -1,3 +1,9 @@
+0.7.0
+-----
+* make base_url private (users can add back in their app easily if needed)
+* store request params in the session so they can be retrieved after the omniauth flow. This fixes app actions from the admin if the user's session has expired
+* refactored some smaller methods to make the shopify_session method easier on the eyes.
+
 0.6.0
 -----
 * remove current_shop* methods in favor of yielding shop_name to the block methods

data/README.md

@@ -112,8 +112,6 @@ It's impossible to control the flow of webhooks to your app from Shopify especia
 
 **logout** - This method clears the current session
 
-**base_url** - This returns the url of the app
-
 shopify-sinatra-app includes sinatra/activerecord for creating models that can be persisted in the database. You might want to read more about sinatra/activerecord and the methods it makes available to you: [https://github.com/janko-m/sinatra-activerecord](https://github.com/janko-m/sinatra-activerecord)
 
 shopify-sinatra-app also includes `rack-flash3` and the flash messages are forwarded to the Shopify Embedded App SDK (see the code in `views/layouts/application.erb`). Flash messages are useful for signalling to your users that a request was successful without changing the page. The following is an example of how to use a flash message in a route:

data/example/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
-ruby '2.5.0'
+ruby '2.5.3'
 
 gem 'shopify-sinatra-app', path: '../'
 gem 'sinatra-activerecord'

data/example/db/schema.rb

@@ -10,7 +10,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140414042317) do
+ActiveRecord::Schema.define(version: 2014_04_14_042317) do
 
   create_table "shops", force: :cascade do |t|
     t.string "name"

data/example/src/app.rb

@@ -22,7 +22,7 @@ class SinatraApp < Sinatra::Base
   # and cleans up data, add to this endpoint as your app
   # stores more data.
   post '/uninstall' do
-    webhook_session do |shop_name, params|
+    shopify_webhook do |shop_name, params|
       Shop.find_by(name: shop_name).destroy
     end
   end

data/example/test/app_test.rb

@@ -1,6 +1,16 @@
 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
@@ -8,10 +18,12 @@ class AppTest < Minitest::Test
 
   def setup
     @shop_name = 'testshop.myshopify.com'
+    @shopify_shop = MockShop.new(@shop_name)
   end
 
   def test_root_with_session
     set_session
+    fake 'https://testshop.myshopify.com/admin/shop.json', body: {myshopify_domain: @shop_name}.to_json
     fake 'https://testshop.myshopify.com/admin/products.json?limit=10', body: '{}'
     get '/'
     assert last_response.ok?
@@ -20,6 +32,7 @@ class AppTest < Minitest::Test
   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?
@@ -46,7 +59,7 @@ class AppTest < Minitest::Test
     set_session
     SinatraApp.any_instance.expects(:activate_shopify_api).with(@shop_name, 'token')
     SinatraApp.any_instance.expects(:clear_session)
-    ShopifyAPI::Product.expects(:find).raises(ActiveResource::UnauthorizedAccess.new('UnauthorizedAccess'))
+    ShopifyAPI::Shop.expects(:current).raises(ActiveResource::UnauthorizedAccess.new('UnauthorizedAccess'))
     get '/'
     assert_equal 302, last_response.status
     assert_equal 'http://example.org/', last_response.location

data/example/test/test_helper.rb

@@ -1,3 +1,5 @@
+$VERBOSE = nil
+
 ENV['RACK_ENV'] = 'test'
 ENV['SECRET'] = 'secret'
 

data/lib/sinatra/shopify-sinatra-app.rb

@@ -18,10 +18,7 @@ module Sinatra
 
       def logout
         session.delete(:shopify)
-      end
-
-      def base_url
-        "#{request_protocol}://#{request.env['HTTP_HOST']}"
+        session.clear
       end
 
       # for the esdk initializer
@@ -30,13 +27,14 @@ module Sinatra
       end
 
       def shopify_session(&blk)
-        return_to = request.env['sinatra.route'].split(' ').last
+        return_to = request.path
+        return_params = request.params
 
-        if !session.key?(:shopify)
-          authenticate(return_to)
-        elsif params[:shop].present? && session[:shopify][:shop] != sanitize_shop_param(params)
+        if no_session?
+          authenticate(return_to, return_params)
+        elsif different_shop?
           logout
-          authenticate(return_to)
+          authenticate(return_to, return_params)
         else
           shop_name = session[:shopify][:shop]
           token = session[:shopify][:token]
@@ -45,7 +43,7 @@ module Sinatra
         end
       rescue ActiveResource::UnauthorizedAccess
         clear_session shop_name
-        redirect request.env['sinatra.route'].split(' ').last
+        redirect request.path
       end
 
       def shopify_webhook(&blk)
@@ -62,8 +60,21 @@ module Sinatra
         request.secure? ? 'https' : 'http'
       end
 
-      def authenticate(return_to = '/')
+      def base_url
+        "#{request_protocol}://#{request.env['HTTP_HOST']}"
+      end
+
+      def no_session?
+        !session.key?(:shopify)
+      end
+
+      def different_shop?
+        params[:shop].present? && session[:shopify][:shop] != sanitize_shop_param(params)
+      end
+
+      def authenticate(return_to = '/', return_params = nil)
         if shop_name = sanitized_shop_name
+          session[:return_params] = return_params if return_params
           redirect_url = "/auth/shopify?shop=#{shop_name}&return_to=#{base_url}#{return_to}"
           redirect_javascript redirect_url
         else
@@ -221,6 +232,11 @@ module Sinatra
         after_shopify_auth()
 
         return_to = env['omniauth.params']['return_to']
+        return_params = session[:return_params]
+        session.delete(:return_params)
+
+        return_to += "?#{return_params.to_query}" if return_params.present?
+
         redirect return_to
       end
 

data/shopify-sinatra-app.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'shopify-sinatra-app'
-  s.version = '0.6.0'
+  s.version = '0.7.0'
 
   s.summary     = 'A classy shopify app'
   s.description = 'A Sinatra extension for building Shopify Apps. Akin to the shopify_app gem but for Sinatra'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-sinatra-app
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Kevin Hughes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-26 00:00:00.000000000 Z
+date: 2019-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra