shopify-sinatra-app 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fccd4ff6faec2fcff66aed5c5fdf7f3893935cba839e21d2192065190891bb2c
-  data.tar.gz: e29f14e3e7cdb0d7f21bbce7189c61178566c2931d52e00e0980000fe2dd8f8c
+  metadata.gz: 6e20ce69bc42bc9bc307d4a57867d6249fadd78d8a45cc78085271af499efbc3
+  data.tar.gz: dc0743abc76b5d92f6d14eeed9a1096611b6200f506d8f942e090ebaa77f78bf
 SHA512:
-  metadata.gz: c08033567d98178683fd4a1153eeef3761eed574f7e3f303bc17cd38fec6d252ecd6126a1404d57ccbcbf8af3e5d74a8a8b8fdce7af0092e4b9d560a16de033b
-  data.tar.gz: f09d42913d91dd1f502e3243536b960797acacb1dc95afaac0fd30ed3a530194536437310c0eccca99ed7acc887c725c5f9f7438f98eabb378da0da5bc783684
+  metadata.gz: bc5d771d614036bd2d966e33c1e98a98d1f539fd8922cccf5f948fd536128374a6b1aac3591e02109fb50f5ea987d88b2ebd92cd33dab5615843127eeb4904c5
+  data.tar.gz: 3d83a80b3d6df53d4441b25ecba9966bc16535c8dd71572dfdfd40823349eab9f1094bfaa00380fa65d05e31cfd31bf01dd77384f269441a65e5dc245ca1b8cf

data/.gitignore

@@ -1,2 +1,4 @@
 *.gem
 *.sqlite3
+Gemfile.lock
+example/Gemfile.lock

data/CHANGELOG

@@ -1,3 +1,8 @@
+0.5.0
+-----
+* replace webhook_session and webhook_job with shopify_webhook
+* remove redis and resque as dependencies
+
 0.4.0
 -----
 * update to sinatra 2.0.1

data/README.md

@@ -87,31 +87,26 @@ get '/products.json' do
 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 yields the `webhook_data` 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 `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
-  webhook_session do |webhook_data|
+  shopify_webhook 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`, `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:
+Note this method does not active a Shopify session by default but the current_shop* methods still work. It is not advised but if you want to handle the webhook in a web request you will need to activate the ShopifyAPI session manually:
 
 ```ruby
-post '/order.json' do
-  webhook_job(OrderWebhookJob)
-end
+shop = Shop.find_by(name: current_shop_name)
+api_session = ShopifyAPI::Session.new(shop.name, shop.token)
+ShopifyAPI::Base.activate_session(api_session)
+```
 
-class OrderWebhookJob
-  @queue = :default
+It's 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 best practise to process webhooks in a background queue and return a `200` to Shopify immediately. Ruby has several good background job frameworks that work with Sinatra including [Sidekiq](https://github.com/mperham/sidekiq) and [Resque](https://github.com/resque/resque).
 
-  def self.perform(shop_name, shop_token, webhook_data)
-    # do something with the data
-  end
-end
-```
 
 **after_shopify_auth** - This is a private method provided with the framework that gets called whenever the app is authorized. You should fill this method in with anything you need to initialize, for example webhooks and services on Shopify or any other database models you have created specific to a shop. Note that this method will be called anytime the auth flow is completed so this method should be idempotent (running it twice has the same effect as running it once).
 
@@ -129,7 +124,7 @@ shopify-sinatra-app includes sinatra/activerecord for creating models that can b
 
 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:
 
-```
+```ruby
 post '/flash_message' do
   flash[:notice] = "Flash Message!"
   redirect '/'
@@ -146,7 +141,7 @@ The embedded app sdk won't load non https content so you'll need to use a forwar
 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 run bundle exec rackup config.ru
+PORT=4567 foreman run web
 ```
 
 Note - we use `foreman run ...` not `foreman start ...` because we only want to start the single process that is our app. This means if you add a debugger in your app it will trigger properly in the command line when the debugger is hit. If you don't have any debuggers feel free to use `foreman start -p 4567`.
@@ -194,7 +189,6 @@ You will also need to add the following (free) add-ons to your new Heroku app:
 
 ```
 heroku addons:add heroku-postgresql
-heroku addons:add rediscloud
 ```
 
 Now we can deploy the new application to Heroku. Deploying to Heroku is as simple as pushing the code using git:
@@ -217,14 +211,12 @@ We also need to set our environment variables on Heroku. The environment variabl
 rake creds2heroku
 ```
 
-and make sure you have at least 1 dyno for web and resque:
+and make sure you have at least 1 dyno for web:
 
 ```
-heroku scale web=1 resque=1
+heroku scale web=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 (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.
 
 

data/example/.gitignore

@@ -1,2 +1,3 @@
 .env
 *.sqlite3
+.byebug_history

data/example/Procfile

@@ -1,2 +1 @@
 web: bundle exec rackup config.ru -p $PORT
-resque: env TERM_CHILD=1 RESQUE_TERM_TIMEOUT=7 QUEUE=default bundle exec rake resque:work

data/example/src/app.rb

@@ -22,7 +22,7 @@ class SinatraApp < Sinatra::Base
   # stores more data.
   post '/uninstall' do
     webhook_session do |params|
-      current_shop.destroy
+      Shop.find_by(name: current_shop_name).destroy
     end
   end
 

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

@@ -1,8 +1,6 @@
 require 'sinatra/base'
-require 'sinatra/redis'
 require 'sinatra/activerecord'
 
-require 'resque'
 require 'rack-flash'
 require 'attr_encrypted'
 require 'active_support/all'
@@ -58,25 +56,11 @@ module Sinatra
         redirect request.env['sinatra.route'].split(' ').last
       end
 
-      def webhook_session(&blk)
+      def shopify_webhook(&blk)
         return unless verify_shopify_webhook
         @shop_name = request.env['HTTP_X_SHOPIFY_SHOP_DOMAIN']
-        shop = Shop.find_by(name: @shop_name)
-
-        if shop.present?
-          params = ActiveSupport::JSON.decode(request.body.read.to_s)
-          activate_shopify_api(shop.name, shop.token)
-          yield params
-          status 200
-        end
-      end
-
-      def webhook_job(jobKlass)
-        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, shop.token, params)
+        webhook_body = ActiveSupport::JSON.decode(request.body.read.to_s)
+        yield webhook_body
         status 200
       end
 
@@ -192,14 +176,6 @@ module Sinatra
                                      secret: app.settings.secret,
                                      expire_after: 60 * 30 # half an hour in seconds
 
-      app.set :redis_url, ENV['REDISCLOUD_URL'] || 'redis://localhost:6379/'
-      redis_uri = URI.parse(app.settings.redis_url)
-      Resque.redis = ::Redis.new(host: redis_uri.host,
-                                 port: redis_uri.port,
-                                 password: redis_uri.password)
-      Resque.redis.namespace = 'resque'
-      app.set :redis, app.settings.redis_url
-
       app.use OmniAuth::Builder do
         provider :shopify,
                  app.settings.api_key,
@@ -214,8 +190,10 @@ module Sinatra
                  }
       end
 
-      ShopifyAPI::Session.setup(api_key: app.settings.api_key,
-                                secret: app.settings.shared_secret)
+      ShopifyAPI::Session.setup(
+        api_key: app.settings.api_key,
+        secret: app.settings.shared_secret
+      )
 
       app.get '/install' do
         if params[:shop].present?

data/shopify-sinatra-app.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'shopify-sinatra-app'
-  s.version = '0.4.1'
+  s.version = '0.5.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'
@@ -14,14 +14,11 @@ Gem::Specification.new do |s|
   s.executables << 'shopify-sinatra-app-generator'
 
   s.add_runtime_dependency 'sinatra', '~> 2.0.2'
-  s.add_runtime_dependency 'sinatra-redis', '~> 0.3.0'
   s.add_runtime_dependency 'sinatra-activerecord', '~> 2.0.9'
   s.add_runtime_dependency 'rack-flash3', '~> 1.0.5'
   s.add_runtime_dependency 'activesupport'
   s.add_runtime_dependency 'attr_encrypted', '~> 3.1.0'
 
-  s.add_runtime_dependency 'resque'
-
   s.add_runtime_dependency 'shopify_api'
   s.add_runtime_dependency 'omniauth-shopify-oauth2'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-sinatra-app
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Kevin Hughes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-24 00:00:00.000000000 Z
+date: 2018-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.2
-- !ruby/object:Gem::Dependency
-  name: sinatra-redis
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: sinatra-activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -94,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.0
-- !ruby/object:Gem::Dependency
-  name: resque
-  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: shopify_api
   requirement: !ruby/object:Gem::Requirement
@@ -232,13 +204,11 @@ files:
 - ".travis.yml"
 - CHANGELOG
 - Gemfile
-- Gemfile.lock
 - LICENSE
 - README.md
 - bin/shopify-sinatra-app-generator
 - example/.gitignore
 - example/Gemfile
-- example/Gemfile.lock
 - example/Procfile
 - example/README.md
 - example/Rakefile
@@ -281,7 +251,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: A classy shopify app

data/Gemfile.lock

@@ -1,130 +0,0 @@
-PATH
-  remote: .
-  specs:
-    shopify-sinatra-app (0.4.0)
-      activesupport
-      attr_encrypted (~> 3.1.0)
-      omniauth-shopify-oauth2
-      rack-flash3 (~> 1.0.5)
-      resque
-      shopify_api
-      sinatra (~> 2.0.2)
-      sinatra-activerecord (~> 2.0.9)
-      sinatra-redis (~> 0.3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (5.2.0)
-      activesupport (= 5.2.0)
-    activemodel-serializers-xml (1.0.2)
-      activemodel (> 5.x)
-      activesupport (> 5.x)
-      builder (~> 3.1)
-    activerecord (5.2.0)
-      activemodel (= 5.2.0)
-      activesupport (= 5.2.0)
-      arel (>= 9.0)
-    activeresource (5.0.0)
-      activemodel (>= 5.0, < 6)
-      activemodel-serializers-xml (~> 1.0)
-      activesupport (>= 5.0, < 6)
-    activesupport (5.2.0)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (>= 0.7, < 2)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (9.0.0)
-    attr_encrypted (3.1.0)
-      encryptor (~> 3.0.0)
-    builder (3.2.3)
-    concurrent-ruby (1.0.5)
-    encryptor (3.0.0)
-    fakeweb (1.3.0)
-    faraday (0.12.2)
-      multipart-post (>= 1.2, < 3)
-    graphql (1.8.5)
-    graphql-client (0.13.0)
-      activesupport (>= 3.0, < 6.0)
-      graphql (~> 1.6)
-    hashie (3.5.7)
-    i18n (1.0.1)
-      concurrent-ruby (~> 1.0)
-    jwt (1.5.6)
-    metaclass (0.0.4)
-    minitest (5.11.3)
-    mocha (1.3.0)
-      metaclass (~> 0.0.1)
-    mono_logger (1.1.0)
-    multi_json (1.13.1)
-    multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    mustermann (1.0.2)
-    oauth2 (1.4.0)
-      faraday (>= 0.8, < 0.13)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    omniauth (1.8.1)
-      hashie (>= 3.4.6, < 3.6.0)
-      rack (>= 1.6.2, < 3)
-    omniauth-oauth2 (1.5.0)
-      oauth2 (~> 1.1)
-      omniauth (~> 1.2)
-    omniauth-shopify-oauth2 (1.2.1)
-      omniauth-oauth2 (~> 1.5.0)
-    rack (2.0.4)
-    rack-flash3 (1.0.5)
-      rack
-    rack-protection (2.0.3)
-      rack
-    rack-test (0.8.3)
-      rack (>= 1.0, < 3)
-    rake (12.3.0)
-    redis (4.0.1)
-    redis-namespace (1.6.0)
-      redis (>= 3.0.4)
-    resque (1.27.4)
-      mono_logger (~> 1.0)
-      multi_json (~> 1.0)
-      redis-namespace (~> 1.3)
-      sinatra (>= 0.9.2)
-      vegas (~> 0.1.2)
-    shopify_api (4.12.0)
-      activeresource (>= 3.0.0)
-      graphql-client
-      rack
-    sinatra (2.0.3)
-      mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.3)
-      tilt (~> 2.0)
-    sinatra-activerecord (2.0.13)
-      activerecord (>= 3.2)
-      sinatra (>= 1.0)
-    sinatra-redis (0.3.0)
-      redis
-      sinatra (>= 0.9.4)
-    sqlite3 (1.3.13)
-    thread_safe (0.3.6)
-    tilt (2.0.8)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    vegas (0.1.11)
-      rack (>= 1.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  fakeweb
-  minitest
-  mocha
-  rack-test
-  rake
-  shopify-sinatra-app!
-  sqlite3
-
-BUNDLED WITH
-   1.16.3

data/example/Gemfile.lock

@@ -1,145 +0,0 @@
-PATH
-  remote: ..
-  specs:
-    shopify-sinatra-app (0.4.0)
-      activesupport
-      attr_encrypted (~> 3.1.0)
-      omniauth-shopify-oauth2
-      rack-flash3 (~> 1.0.5)
-      resque
-      shopify_api
-      sinatra (~> 2.0.2)
-      sinatra-activerecord (~> 2.0.9)
-      sinatra-redis (~> 0.3.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    activemodel (5.1.5)
-      activesupport (= 5.1.5)
-    activemodel-serializers-xml (1.0.2)
-      activemodel (> 5.x)
-      activesupport (> 5.x)
-      builder (~> 3.1)
-    activerecord (5.1.5)
-      activemodel (= 5.1.5)
-      activesupport (= 5.1.5)
-      arel (~> 8.0)
-    activeresource (5.0.0)
-      activemodel (>= 5.0, < 6)
-      activemodel-serializers-xml (~> 1.0)
-      activesupport (>= 5.0, < 6)
-    activesupport (5.1.5)
-      concurrent-ruby (~> 1.0, >= 1.0.2)
-      i18n (~> 0.7)
-      minitest (~> 5.1)
-      tzinfo (~> 1.1)
-    arel (8.0.0)
-    attr_encrypted (3.1.0)
-      encryptor (~> 3.0.0)
-    builder (3.2.3)
-    byebug (10.0.0)
-    concurrent-ruby (1.0.5)
-    dotenv (2.2.1)
-    encryptor (3.0.0)
-    fakeweb (1.3.0)
-    faraday (0.12.2)
-      multipart-post (>= 1.2, < 3)
-    foreman (0.84.0)
-      thor (~> 0.19.1)
-    graphql (1.8.5)
-    graphql-client (0.13.0)
-      activesupport (>= 3.0, < 6.0)
-      graphql (~> 1.6)
-    hashie (3.5.7)
-    i18n (0.9.5)
-      concurrent-ruby (~> 1.0)
-    jwt (1.5.6)
-    metaclass (0.0.4)
-    minitest (5.11.3)
-    mocha (1.3.0)
-      metaclass (~> 0.0.1)
-    mono_logger (1.1.0)
-    multi_json (1.13.1)
-    multi_xml (0.6.0)
-    multipart-post (2.0.0)
-    mustermann (1.0.2)
-    oauth2 (1.4.0)
-      faraday (>= 0.8, < 0.13)
-      jwt (~> 1.0)
-      multi_json (~> 1.3)
-      multi_xml (~> 0.5)
-      rack (>= 1.2, < 3)
-    omniauth (1.8.1)
-      hashie (>= 3.4.6, < 3.6.0)
-      rack (>= 1.6.2, < 3)
-    omniauth-oauth2 (1.5.0)
-      oauth2 (~> 1.1)
-      omniauth (~> 1.2)
-    omniauth-shopify-oauth2 (1.2.1)
-      omniauth-oauth2 (~> 1.5.0)
-    pg (1.0.0)
-    rack (2.0.5)
-    rack-flash3 (1.0.5)
-      rack
-    rack-protection (2.0.3)
-      rack
-    rack-test (0.8.3)
-      rack (>= 1.0, < 3)
-    rake (12.3.0)
-    redis (4.0.1)
-    redis-namespace (1.6.0)
-      redis (>= 3.0.4)
-    resque (1.27.4)
-      mono_logger (~> 1.0)
-      multi_json (~> 1.0)
-      redis-namespace (~> 1.3)
-      sinatra (>= 0.9.2)
-      vegas (~> 0.1.2)
-    shopify_api (4.12.0)
-      activeresource (>= 3.0.0)
-      graphql-client
-      rack
-    sinatra (2.0.3)
-      mustermann (~> 1.0)
-      rack (~> 2.0)
-      rack-protection (= 2.0.3)
-      tilt (~> 2.0)
-    sinatra-activerecord (2.0.13)
-      activerecord (>= 3.2)
-      sinatra (>= 1.0)
-    sinatra-redis (0.3.0)
-      redis
-      sinatra (>= 0.9.4)
-    sqlite3 (1.3.13)
-    thor (0.19.4)
-    thread_safe (0.3.6)
-    tilt (2.0.8)
-    tzinfo (1.2.5)
-      thread_safe (~> 0.1)
-    vegas (0.1.11)
-      rack (>= 1.0.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  byebug
-  dotenv
-  fakeweb
-  foreman
-  minitest
-  mocha
-  pg
-  rack-flash3
-  rack-test
-  rake
-  shopify-sinatra-app!
-  sinatra-activerecord
-  sqlite3
-
-RUBY VERSION
-   ruby 2.5.0p0
-
-BUNDLED WITH
-   1.16.1