shopify-sinatra-app 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e20ce69bc42bc9bc307d4a57867d6249fadd78d8a45cc78085271af499efbc3
-  data.tar.gz: dc0743abc76b5d92f6d14eeed9a1096611b6200f506d8f942e090ebaa77f78bf
+  metadata.gz: 42c91774ed4f971d81f0a1d7f8d983e9b65b54de5abc8f27e84e2bc1fca4ac81
+  data.tar.gz: efadfb3fc31df9453e1a808e644a3045277d6316012104510954f93274d2ab06
 SHA512:
-  metadata.gz: bc5d771d614036bd2d966e33c1e98a98d1f539fd8922cccf5f948fd536128374a6b1aac3591e02109fb50f5ea987d88b2ebd92cd33dab5615843127eeb4904c5
-  data.tar.gz: 3d83a80b3d6df53d4441b25ecba9966bc16535c8dd71572dfdfd40823349eab9f1094bfaa00380fa65d05e31cfd31bf01dd77384f269441a65e5dc245ca1b8cf
+  metadata.gz: 52b38bf496bc1092461c61f846e6fb3770c9d923977d5e6d5224a953bc06b379078423b4160252d84177263806cef6d1027a9b76a997853613889469f66ac784
+  data.tar.gz: f1c509bdd3356a3c07d22f7bde37cbf777954d97c4831f3dee15d7b653cc3f8c6c3e77943c083bc302cf7fd91bce37b428dc506b3a778f955bc1a515d7e54caf

data/CHANGELOG

@@ -1,3 +1,7 @@
+0.6.0
+-----
+* remove current_shop* methods in favor of yielding shop_name to the block methods
+
 0.5.0
 -----
 * replace webhook_session and webhook_job with shopify_webhook

data/README.md

@@ -80,18 +80,18 @@ Shopify::Methods
 
 ```ruby
 get '/products.json' do
-  shopify_session do
+  shopify_session do |shop_name|
     products = ShopifyAPI::Product.all(limit: 5)
     products.to_json
   end
 end
 ```
 
-**shopify_webhook** - This method is for an endpoint that receives a webhook from Shopify. Webhooks are a great way to keep your app in sync with a shop's data without polling. You can read more about webhooks [here](http://docs.shopify.com/api/tutorials/using-webhooks). This method also takes a block and yields the `webhook_body` as a hash (note only works for json webhooks, don't use xml). Here is an example that listens to an order creation webhook:
+**shopify_webhook** - This method is for an endpoint that receives a webhook from Shopify. Webhooks are a great way to keep your app in sync with a shop's data without polling. You can read more about webhooks [here](http://docs.shopify.com/api/tutorials/using-webhooks). This method also takes a block and yields the `shop_name` and `webhook_body` as a hash (note only works for json webhooks, don't use xml). Here is an example that listens to an order creation webhook:
 
 ```ruby
 post '/order.json' do
-  shopify_webhook do |webhook_data|
+  shopify_webhook do |shop_name, webhook_data|
     # do something with the data
   end
 end
@@ -112,17 +112,11 @@ It's impossible to control the flow of webhooks to your app from Shopify especia
 
 **logout** - This method clears the current session
 
-**current_shop_name** - Returns the name of the current shop (format: example.myshopify.com)
-
-**current_shop_url** - Returns the url of the current shop (format: https://example.myshopify.com)
-
-**current_shop** - Returns the activerecord model of the current shop. Use carefully!
-
 **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 signaling 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:
+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:
 
 ```ruby
 post '/flash_message' do

data/example/src/app.rb

@@ -11,7 +11,8 @@ class SinatraApp < Sinatra::Base
   # this is a simple example that fetches some products
   # from Shopify and displays them inside your app
   get '/' do
-    shopify_session do
+    shopify_session do |shop_name|
+      @shop = ShopifyAPI::Shop.current
       @products = ShopifyAPI::Product.find(:all, params: { limit: 10 })
       erb :home
     end
@@ -21,8 +22,8 @@ class SinatraApp < Sinatra::Base
   # and cleans up data, add to this endpoint as your app
   # stores more data.
   post '/uninstall' do
-    webhook_session do |params|
-      Shop.find_by(name: current_shop_name).destroy
+    webhook_session do |shop_name, params|
+      Shop.find_by(name: shop_name).destroy
     end
   end
 

data/example/test/test_helper.rb

@@ -1,5 +1,4 @@
 ENV['RACK_ENV'] = 'test'
-ENV['SHOPIFY_REDIRECT_URI'] = 'http://localhost:4567'
 ENV['SECRET'] = 'secret'
 
 require 'minitest/autorun'

data/example/views/home.erb

@@ -4,6 +4,6 @@
 <h3>Products</h3>
 <ul>
   <% @products.each do |product| %>
-    <li><a href=<%="#{current_shop_url}/admin/products/#{product.id}"%> target="_blank"> <%= product.id %> </a></li>
+    <li><a href=<%="https://#{@shop.myshopify_domain}/admin/products/#{product.id}"%> target="_blank"> <%= product.id %> </a></li>
   <% end %>
 </ul>

data/example/views/layouts/application.erb

@@ -5,7 +5,7 @@
   <script type="text/javascript">
     ShopifyApp.init({
       apiKey: "<%= SinatraApp.settings.api_key %>",
-      shopOrigin: "<%= current_shop_url %>",
+      shopOrigin: "<%= shop_origin %>",
       debug: true
     });
   </script>

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

@@ -21,20 +21,12 @@ module Sinatra
       end
 
       def base_url
-        @base_url ||= "#{request_protocol}://#{request.env['HTTP_HOST']}"
+        "#{request_protocol}://#{request.env['HTTP_HOST']}"
       end
 
-      def current_shop
-        Shop.find_by(name: current_shop_name)
-      end
-
-      def current_shop_name
-        return session[:shopify][:shop] if session.key?(:shopify)
-        return @shop_name if @shop_name
-      end
-
-      def current_shop_url
-        "https://#{current_shop_name}" if current_shop_name
+      # for the esdk initializer
+      def shop_origin
+        "https://#{session[:shopify][:shop]}"
       end
 
       def shopify_session(&blk)
@@ -49,18 +41,18 @@ module Sinatra
           shop_name = session[:shopify][:shop]
           token = session[:shopify][:token]
           activate_shopify_api(shop_name, token)
-          yield
+          yield shop_name
         end
       rescue ActiveResource::UnauthorizedAccess
-        clear_session current_shop
+        clear_session shop_name
         redirect request.env['sinatra.route'].split(' ').last
       end
 
       def shopify_webhook(&blk)
         return unless verify_shopify_webhook
-        @shop_name = request.env['HTTP_X_SHOPIFY_SHOP_DOMAIN']
+        shop_name = request.env['HTTP_X_SHOPIFY_SHOP_DOMAIN']
         webhook_body = ActiveSupport::JSON.decode(request.body.read.to_s)
-        yield webhook_body
+        yield shop_name, webhook_body
         status 200
       end
 
@@ -84,8 +76,9 @@ module Sinatra
         ShopifyAPI::Base.activate_session(api_session)
       end
 
-      def clear_session(shop)
+      def clear_session(shop_name)
         logout
+        shop = Shop.find_by(name: shop_name)
         shop.token = nil
         shop.save
       end

data/shopify-sinatra-app.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'shopify-sinatra-app'
-  s.version = '0.5.0'
+  s.version = '0.6.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.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Kevin Hughes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-25 00:00:00.000000000 Z
+date: 2018-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra