shopify-sinatra-app 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5258ae2ad69e41e73b1ac65c4486b50c18ed613
-  data.tar.gz: f1353a6f9750ccecffc2fb8b5e648ca9d8a8fa7d
+  metadata.gz: f14854ae0081a9b642032ba7eaa40ae85a5b22e0
+  data.tar.gz: c8157d64a372e0b1ad339898a920312beee32b4a
 SHA512:
-  metadata.gz: 0b04db231a6a155764b025ce9abccf65b9940bc1f770794b11f3dfe5bb28d0bd6ea65746e3419187c2b762fd79bf8a42f454d494342b5fd6c54e58c6f3c18358
-  data.tar.gz: 702b19de25f03abedb4224ef3ee9fc043dee11a86e4c2b3790fcc2d755092a205c715cc0d1da4a0dd604c819ddf6d48b0aa8a06036095d8135b7831626ec36a0
+  metadata.gz: 50a4cd567b685d6a09eba34a43f014b535ab7f6b6ffb9c26eebc34dd7989f7b74494a894253b445426452711c031dc21a9b045a26a832fddba24b34578a5b0a9
+  data.tar.gz: 789e5772cdb0dc839c5b9d53da1fe912fba53e78e9dee35bde4719490a1aaca8da44c4c7083d739d9f2d28df34e2410019739e2c8a3d60a7ea70c5f121a87cfa

data/README.md

@@ -28,11 +28,6 @@ shopify-sinatra-app-generator new <your new app name>
 
 This will create a new skeleton shopify-sinatra-app. The generator will create several default files for you rather than having them bundled in the sinatra extension - its worthwhile to read this section to understand what each of these files is for.
 
-`config/app.yml` --> Some important config information is contained in this file.
-  * scope: The scope of your app (what your app can access from the Shopify store once installed, e.g. read_products), this will be read by your app and used when your app is installed.
-
-  * uninstall_webhook: Initially an uninstall webhook is also defined in this file, although without a proper url, this file is a good place to define objects that need to be created on Shopify when your app is installed like webhooks, fulfillment and carrier services.
-
 `config/database.yml` --> The database config for active record. Initially this is setup to use sqlite3 for development and testing which you may want to change to mimic your production database.
 
 `.env` --> a hidden file not tracked by source control for storing credentials etc. to be set as environment variables
@@ -62,8 +57,6 @@ You'll need to create a Shopify Partner Account and a new application. You can m
 
 Note - The shopify-sinatra-app creates an embedded app! You need change the embedded setting to enabled in the [Shopify Partner area](https://app.shopify.com/services/partners/api_clients) for your app. If you don't want your app to be embedded then remove the related code in `layout/application.erb` and delete the `layout/_top_bar.erb` file and the references to it in the other views.
 
-Also note that when developing locally you'll need to enable unsafe javascripts in your browser for the embedded sdk to function. Read more [here](http://docs.shopify.com/embedded-app-sdk/getting-started)
-
 After creating your new application you need to edit the `.env` file and add the following lines:
 
 ```
@@ -76,28 +69,28 @@ SECRET=<generate a random string to encrypt credentials with>
 Shopify::Methods
 ----------------
 
-`shopify_session` - The main method of the framework, most of your routes will use this method to acquire a valid shopify session and then perform api calls to Shopfiy. The method simply takes a block of code and makes the shop_name available to you after activating an api session. Here is an example endpoint that displays products:
+`shopify_session` - The main method of the framework, most of your routes will use this method to acquire a valid shopify session and then perform api calls to Shopfiy. The method activates a Shopify API session for you and accepts a block inside of which you can use the ShopifyAPI. Here is an example endpoint that displays products:
 
 ```ruby
 get '/products.json' do
-  shopify_session do |shop_name|
+  shopify_session do
     products = ShopifyAPI::Product.all(limit: 5)
     products.to_json
   end
 end
 ```
 
-`webhook_session` - This method is for an endpoint that recieves 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 of code and makes the shop and webhook data as a hash available (note only works for json webhooks, don't use xml). Here is an example that listens to a order creation webhook:
+`webhook_session` - This method is for an endpoint that recieves 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 of code and makes the webhook data available as a hash (note only works for json webhooks, don't use xml). Here is an example that listens to a order creation webhook:
 
 ```ruby
 post '/order.json' do
-  webhook_session do |shop, params|
+  webhook_session do |webhook_data|
     # do something with the data
   end
 end
 ```
 
-`webhook_job` - Its impossible to control the flow of webhooks to your app from Shopify especially if a larger store installs your app or if a shop has a flash sale. To prevent your app from getting overloaded with webhook requests it is usually a good idea to process webhooks in a background queue and return a 200 to Shopify immediately. This method provides this functionality using redis and resque. This method takes the name of a job class whose perform method expects a `shop_name` and the webhook data as a hash. The session method is useful for prototpying and experimenting but production apps should use `webhook_job`. Here is an example:
+`webhook_job` - Its impossible to control the flow of webhooks to your app from Shopify especially if a larger store installs your app or if a shop has a flash sale. To prevent your app from getting overloaded with webhook requests it is usually a good idea to process webhooks in a background queue and return a 200 to Shopify immediately. This method provides this functionality using redis and resque. This method takes the name of a job class whose perform method expects a `shop_name`, `shop_token` and the webhook data as a hash. The session method is useful for prototpying and experimenting but production apps should use `webhook_job`. Here is an example:
 
 ```ruby
 post '/order.json' do
@@ -107,7 +100,7 @@ end
 class OrderWebhookJob
   @queue = :default
 
-  def self.perform(shop_name, params)
+  def self.perform(shop_name, shop_token, webhook_data)
     # do something with the data
   end
 end
@@ -115,14 +108,45 @@ end
 
 `install` - This is a private method provided with the framework that gets called when the app is authorized for the first time. You should fill this method in with anything you need to initialize on install, for example webhooks and services on shopify or any other database models you have created specific to a shop.
 
-`uninstall` - This method gets called when your app recieves an uninstall webhook from shopify. You should override this method in your class and do any appropriate clean up when the app is removed from a shop.
-
 `logout` - This method clears the current session data in the app
 
-`current_shop` - Returns the name of the current shop
+`current_shop` - Returns the name of the current shop (format: example.myshopify.com)
 
 `base_url` - This returns the url of the app
 
+shopify-sinatra-app also includes `rack-flash3` and the flash messages are forwarded to the Shopify Embedded App SDK. 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:
+
+```
+post '/flash_message' do
+  flash[:notice] = "Flash Message!"
+  redirect '/'
+end
+```
+
+note - a flash must be followed by a redirect or it won't work!
+
+Developing
+----------
+To run the app locally we use `foreman` which comes with the [Heroku Toolbelt](https://devcenter.heroku.com/articles/quickstart). Foreman handles running our application and setting our credentials as environment variables. To run the application type:
+
+```
+foreman start -p 4567
+```
+
+Debugging ...
+
+You can set the application url in the [Shopify Partner area](https://app.shopify.com/services/partners/api_clients) to be `http://localhost:4567/` which will allow you to install your app on a live shop while running it locally.
+
+While running the app locally you'll be able to test the install and other routes because your browser is aware of your local application but if you want to test a route that listens to a webhook this will not work because Shopify cannot talk to your local web application. You could expose your local application to the web but an easier solution is to use a tool called [Ngrok](https://ngrok.com/). Download Ngrok and run it on port 4567 (or whichever port you  are using):
+
+```
+./ngrok 4567
+```
+
+Ngrok will report what address your app is available at, leave Ngrok running and then create your webhook to point to the ngrok url plus your route e.g. `<ngrok url>/webhook_test.json`. Now trigger the webhook you are testing and it will get forwarded through ngrok to your local web application allowing you to use debuggers and repls to complete your code.
+
+When developing locally you'll need to enable unsafe javascripts in your browser for the Embedded App SDK to function. Read more [here](http://docs.shopify.com/embedded-app-sdk/getting-started).
+
 
 Deploying
 ---------
@@ -178,7 +202,7 @@ heroku scale web=1 resque=1
 
 Note - if you are not using any background queue for processing webhooks then you do not need the redis add-on or the resque dyno so you can set it to 0.
 
-Make sure you set your shopify apps url to your Heroku app url in the Shopify Partner area https://app.shopify.com/services/partners/api_clients.
+Make sure you set your shopify apps url to your Heroku app url (and make sure to use the `https` version or else the Embedded App SDK won't work) in the Shopify Partner area https://app.shopify.com/services/partners/api_clients.
 
 Contributing
 ------------

data/bin/shopify-sinatra-app-generator

@@ -18,20 +18,20 @@ else
   begin
     Dir.mkdir(app_dir)
 
-    FileUtils.cp_r(generator_dir + "/config",    app_dir + "/config")
-    FileUtils.cp_r(generator_dir + "/db",        app_dir + "/db")
-    FileUtils.cp_r(generator_dir + "/lib",       app_dir + "/lib")
-    FileUtils.cp_r(generator_dir + "/public",    app_dir + "/public")
-    FileUtils.cp_r(generator_dir + "/views",     app_dir + "/views")
-
-    FileUtils.cp(generator_dir   + "/.gitignore",      app_dir + "/.gitignore")
-    FileUtils.cp(generator_dir   + "/config.ru", app_dir + "/config.ru")
-    FileUtils.cp(generator_dir   + "/Procfile",  app_dir + "/Procfile")
-    FileUtils.cp(generator_dir   + "/Rakefile",  app_dir + "/Rakefile")
-    FileUtils.cp(generator_dir   + "/Gemfile",   app_dir + "/Gemfile")
-    FileUtils.cp(generator_dir   + "/README.md", app_dir + "/README.md")
-
-    FileUtils.touch ".env"
+    FileUtils.cp_r(generator_dir + "/config",     app_dir + "/config")
+    FileUtils.cp_r(generator_dir + "/db",         app_dir + "/db")
+    FileUtils.cp_r(generator_dir + "/lib",        app_dir + "/lib")
+    FileUtils.cp_r(generator_dir + "/public",     app_dir + "/public")
+    FileUtils.cp_r(generator_dir + "/views",      app_dir + "/views")
+
+    FileUtils.cp(generator_dir   + "/.gitignore", app_dir + "/.gitignore")
+    FileUtils.cp(generator_dir   + "/config.ru",  app_dir + "/config.ru")
+    FileUtils.cp(generator_dir   + "/Procfile",   app_dir + "/Procfile")
+    FileUtils.cp(generator_dir   + "/Rakefile",   app_dir + "/Rakefile")
+    FileUtils.cp(generator_dir   + "/Gemfile",    app_dir + "/Gemfile")
+    FileUtils.cp(generator_dir   + "/README.md",  app_dir + "/README.md")
+
+    FileUtils.touch(app_dir + "/.env")
 
     Dir.chdir(app_dir)
 

data/lib/generator/lib/app.rb

@@ -3,36 +3,51 @@ require 'sinatra/shopify-sinatra-app'
 class SinatraApp < Sinatra::Base
   register Sinatra::Shopify
 
+  # 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
-    # your app's Home page
-    shopify_session do |shop_name|
-      @shop_name = shop_name
-      @products = ShopifyAPI::Product.all(limit: 5)
+    shopify_session do
+      @products = ShopifyAPI::Product.all
       erb :home
     end
   end
 
+  # this endpoint recieves the uninstall webhook
+  # and cleans up data, add to this endpoint as your app
+  # stores more data.
+  post '/uninstall' do
+    webhook_session do |params|
+      shop.destroy
+    end
+  end
+
   private
 
+  # This method gets called when your app is installed.
+  # setup any webhooks or services you need on Shopify
+  # inside here.
   def install
-    # setup any webhooks or services you need when your app is installed
-    shopify_session do |shop_name|
+    shopify_session do
       params = YAML.load(File.read("config/app.yml"))
 
-      # create the uninstall webhook
-      uninstall_webhook = ShopifyAPI::Webhook.new(params["uninstall_webhook"])
-      unless ShopifyAPI::Webhook.find(:all).include?(uninstall_webhook)
-        uninstall_webhook.save
-      end
+      # 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"
+      })
+      uninstall_webhook.save
     end
-    redirect '/'
-  end
 
-  def uninstall
-    # remove data for a shop when they uninstall your app
-    webhook_session do |shop, params|
-      shop.destroy
-    end
+    redirect '/'
   end
 
 end

data/lib/generator/views/_top_bar.erb

@@ -2,7 +2,7 @@
 
   ShopifyApp.ready(function(){
     ShopifyApp.Bar.initialize({
-      icon: 'icon.png'
+      icon: '<%= "#{base_url}/icon.png" %>'
     });
 
     <% if flash[:notice] %>

data/lib/generator/views/home.erb

@@ -9,7 +9,7 @@
     <% @products.each do |product| %>
       <tr>
         <td>
-          <a href=<%="https://#{@shop_name}/admin/products/#{product.id}"%> target="_blank"> <%= product.id %> </a>
+          <a href=<%="https://#{current_shop}/admin/products/#{product.id}"%> target="_blank"> <%= product.id %> </a>
         </td>
       </tr>
     <% end %>

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

@@ -19,10 +19,6 @@ module Sinatra
         raise NotImplementedError
       end
 
-      def uninstall
-        raise NotImplementedError
-      end
-
       def logout
         session[:shopify] = nil
       end
@@ -52,7 +48,7 @@ module Sinatra
           api_session = ShopifyAPI::Session.new(shop_name, token)
           ShopifyAPI::Base.activate_session(api_session)
 
-          yield shop_name
+          yield
         end
       end
 
@@ -67,7 +63,7 @@ module Sinatra
           api_session = ShopifyAPI::Session.new(shop_name, shop.token)
           ShopifyAPI::Base.activate_session(api_session)
 
-          yield shop, params
+          yield params
 
           status 200
         end
@@ -77,9 +73,11 @@ module Sinatra
         return unless verify_shopify_webhook
 
         shop_name = request.env['HTTP_X_SHOPIFY_SHOP_DOMAIN']
+        shop = Shop.find_by(:name => shop_name)
+
         params = ActiveSupport::JSON.decode(request.body.read.to_s)
 
-        Resque.enqueue(jobKlass, shop_name, params)
+        Resque.enqueue(jobKlass, shop.name, shop.token, params)
 
         status 200
       end
@@ -154,7 +152,8 @@ module Sinatra
       app.enable :sessions
       app.enable :inline_templates
 
-      app.set :scope, YAML.load(File.read(File.expand_path("config/app.yml")))["scope"]
+      #override in app when required
+      app.set :scope, 'read_products, read_orders'
 
       app.set :api_key, ENV['SHOPIFY_API_KEY']
       app.set :shared_secret, ENV['SHOPIFY_SHARED_SECRET']
@@ -196,11 +195,6 @@ module Sinatra
         erb :install, :layout => false
       end
 
-      # endpoint for the app/uninstall webhook
-      app.post '/uninstall.json' do
-        uninstall
-      end
-
       app.post '/login' do
         authenticate
       end

data/shopify-sinatra-app.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'shopify-sinatra-app'
-  s.version = '0.0.3'
+  s.version = '0.0.4'
 
   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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify-sinatra-app
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Kevin Hughes
@@ -14,210 +14,210 @@ dependencies:
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra-redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra-activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sinatra-twitter-bootstrap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-flash3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: attr_encrypted
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: resque
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.22.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.22.0
 - !ruby/object:Gem::Dependency
   name: shopify_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: omniauth-shopify-oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 description: A Sinatra extension for building Shopify Apps. Akin to the shopify_app
@@ -228,7 +228,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -240,7 +240,6 @@ files:
 - lib/generator/README.md
 - lib/generator/Rakefile
 - lib/generator/config.ru
-- lib/generator/config/app.yml
 - lib/generator/config/database.yml
 - lib/generator/db/.keep
 - lib/generator/db/migrate/20140413221328_create_shops.rb
@@ -263,12 +262,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []

data/lib/generator/config/app.yml

@@ -1,6 +0,0 @@
-scope: 'read_products, read_orders'
-
-uninstall_webhook:
-  topic: "app/uninstalled"
-  address: "your apps url"
-  format: "json"