shopify_app 6.4.2 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bf9c3e006763978a94a3a0ebf25ad30ba50c837f
-  data.tar.gz: 4a980dc3eb13651e9fd50470ce7fb8ae31efd90c
+  metadata.gz: b6ad0f2e17e02639259c5664e451a46bb524e304
+  data.tar.gz: 7cc21860a23e3d3f9bc21dfe90782dac008354c6
 SHA512:
-  metadata.gz: b2047b5db8cc3c91cc02b24bbf381ce3b76f82f07564958595936684cf0093e1212a78b9fb721a2e4847b122e69e101a1b3f03e8ebb6800aa0e482c27010c3e5
-  data.tar.gz: 2a87354cc1f99c3bee2a8836979ef7e1e660cfd6a723279cae45c191f3f94c567cdf8ba74d3af645c955513a8c54bcb823b206c35a797898536acc1d07150989
+  metadata.gz: ce081c615bd1d21b213c27cdd3b62ac3fd7f8200aa1aa20204222b0616d741e4af52c535a73c954a93fb3d0c8ed581a34588be8b90306b143b1a04d8f9c2f4cd
+  data.tar.gz: 816f9259c2e32e8a39749f26d3c031839e88a1d0f57f0393a3013820a8a23916331dc6793e2d859b9be11ea8cfdc2467e6bca06469f8803ef8e0e296832ddce5

data/CHANGELOG

@@ -1,3 +1,16 @@
+7.0.0
+----------
+
+* rename WebhooksController module to WebhookVerification
+* added a WebhooksController which automatically delegates to jobs
+* moved all engine controllers under the ShopifyApp namespace
+* rename SessionsController module to SessionsConcern
+* more robust redirects, with valid HTML in HTTP response bodies
+* `ShopifyApp::Controller` has been removed. You’ll need to replace all includes of `ShopifyApp::Controller` with `ShopifyApp::LoginProtection`
+* adds add_webhook generator to make it easier to add new webhooks to your app
+* update the install generator to use standard rails generate arguments, usage has changed from `-api_key=your_key` to `--api_key your_key`
+* remove the redirect uri - this is done automatically inside omniauth now
+
 6.4.2
 -----
 

data/ISSUE_TEMPLATE.md

@@ -0,0 +1,14 @@
+Submitting Issues
+-----------------
+
+Please open an issue here if you encounter a specific bug with this gem or the generators
+
+General questions about the Shopify API should be posted on the [Shopify forums](https://ecommerce.shopify.com/c/shopify-apis-and-technology).
+
+
+Authentication Issues
+---------------------
+
+A great deal of the issues surrounding this repo are around authenticating (installing) the generated app with Shopify.
+
+If you are experiencing issues with your app authenticating/installing the best way to get help fast is to create a repo with the minimal amount of code to demonstrate the issue and a clearly documented set of steps you took to arrive there. This will help us solve your problem quicker since we won't need to spend any time figuring out how to reproduce the bug. Please also include your operating system and browser.

data/QUICKSTART.md

@@ -21,9 +21,8 @@ The next step is to create a new heroku app. Pull up your heroku dashboard and m
 
 cli:
 ```
-heroku new
-git remote -v
-git remote set-url heroku git@heroku.com:<name>.git
+heroku create name
+heroku git:remote -a name
   ```
 
 now we need to let git know where the remote server is so we'll be able to deploy later
@@ -45,18 +44,18 @@ git remote add heroku git@heroku.com:appinfive.git
 4. Add ShopifyApp to gemfile
 ----------------------------
 ```
-vim Gemfile
-  add
-    gem 'shopify_app', '~> 6.0.6'
+$ echo "gem 'shopify_app'" >> Gemfile
 
 bundle install
 ```
 
+Note - its recommended to use the latest released version. Check the git tags to see the latest release and then add it to your Gemfile e.g `gem 'shopify_app', '~> 7.0.0'`
+
 5. Run the ShopifyApp generator
 -------------------------------
 ```
 use the keys from your app in the partners area
-rails generate shopify_app -api_key=a366cbafaccebd2f615aebdfc932fa1c -secret=8750306a895b3dbc7f4136c2ae2ea293 -redirect_uri=https://<name>.herokuapp.com/auth/shopify/callback
+rails generate shopify_app --api_key a366cbafaccebd2f615aebdfc932fa1c --secret 8750306a895b3dbc7f4136c2ae2ea293
 git add .
 git commit -m 'generated shopify app'
 ```

data/README.md

@@ -6,7 +6,9 @@ Shopify Application Rails engine and generator
 
 Description
 -----------
-This gem includes some common code and generators for writing Rails applications using the Shopify API.
+This gem includes a Rails Engine and generators for writing Rails applications using the Shopify API. The Engine provides a SessionsController and all the required code for authenticating with a shop.
+
+The [example](https://github.com/Shopify/shopify_app/tree/master/example) directory contains an app that was generated with this gem. It also contains sample code demonstrating the usage of the embedded app sdk.
 
 *Note: It's recommended to use this on a new Rails project, so that the generator won't overwrite/delete some of your files.*
 
@@ -27,7 +29,7 @@ If you don't have a Shopify Partner account yet head over to http://shopify.com/
 Once you have a Partner account create a new application to get an Api key and other Api credentials. To create a development application set the Application Callback URL to
 
 ```
-http://localhost:3000/login
+http://localhost:3000/
 ```
 
 and the `redirect_uri` to
@@ -61,6 +63,15 @@ Now we are ready to run any of the shopify_app generators. The following section
 Generators
 ----------
 
+### Default Generator
+
+The default generator will run the `install`, `shop`, and `home_controller` generators. This is the recommended way to start your app.
+
+```sh
+$ rails generate shopify_app --api_key <your_api_key> --secret <your_app_secret>
+```
+
+
 ### Install Generator
 
 ```sh
@@ -68,17 +79,16 @@ $ rails generate shopify_app:install
 
 # or optionally with arguments:
 
-$ rails generate shopify_app:install -api_key=<your_api_key> -secret=<your_app_secret>
+$ rails generate shopify_app:install --api_key <your_api_key> --secret <your_app_secret>
 ```
 
 Other options include:
 * `scope` - the Oauth access scope required for your app, eg 'read_products, write_orders'. For more information read the [docs](http://docs.shopify.com/api/tutorials/oauth)
-* `embedded` - the default is to generate an [embedded app](http://docs.shopify.com/embedded-app-sdk), if you want a legacy non-embedded app then set this to false, `-embedded false`
-* `redirect_uri` - the default is `http://localhost:3000/auth/shopify/callback` which will allow you to develop locally. You'll need to change it to match your domain for production.
+* `embedded` - the default is to generate an [embedded app](http://docs.shopify.com/embedded-app-sdk), if you want a legacy non-embedded app then set this to false, `--embedded false`
 
 You can update any of these settings later on easily, the arguments are simply for convenience.
 
-The generator creates a basic SessionsController for authenticating with your shop and a HomeController which displays basic information about your products using the ShopifyAPI. The generated controllers include concerns provided by this gem - in this way code sharing is possible and if some of these core methods are updated everyone can benefit. It is completely safe to override any of the methods provided by this gem in your application.
+The generator adds ShopifyApp and the required initializers to the host Rails application.
 
 After running the `install` generator, you can start your app with `bundle exec rails server` and install your app by visiting localhost.
 
@@ -93,15 +103,19 @@ The install generator doesn't create any database models for you and if you are
 
 *Note that you will need to run rake db:migrate after this generator*
 
-### Controllers, Routes and Views
 
-The last group of generators are for your convenience when you want to start overriding code included as part of the Rails engine. For example by default the engine provides a simple SessionController, if you run the `rails generate shopify_app:controllers` generator then this code gets copied out into your app so you can start adding to it. Routes and views follow the exact same pattern.
+### Home Controller Generator
 
+```sh
+$ rails generate shopify_app:home_controller
+```
 
-### Default Generator
+This generator creates an example home controller and view which fetches and displays products using the ShopifyAPI
 
-If you just run `rails generate shopify_app` then all the generators will be run for you. This is how we do it internally!
 
+### Controllers, Routes and Views
+
+The last group of generators are for your convenience if you want to start overriding code included as part of the Rails engine. For example by default the engine provides a simple SessionController, if you run the `rails generate shopify_app:controllers` generator then this code gets copied out into your app so you can start adding to it. Routes and views follow the exact same pattern.
 
 
 Managing Api Keys
@@ -113,7 +127,6 @@ The `install` generator places your Api credentials directly into the shopify_ap
 ShopifyApp.configure do |config|
   config.api_key = ENV['SHOPIFY_CLIENT_API_KEY']
   config.secret = ENV['SHOPIFY_CLIENT_API_SECRET']
-  config.redirect_uri = "http://localhost:3000/auth/shopify/callback"
   config.scope = 'read_customers, read_orders, write_products'
   config.embedded_app = true
 end
@@ -128,18 +141,20 @@ ShopifyApp can manage your app's webhooks for you by setting which webhooks you
 ```ruby
 ShopifyApp.configure do |config|
   config.webhooks = [
-    {topic: 'carts/update', address: 'example-app.com/webhooks'}
+    {topic: 'carts/update', address: 'example-app.com/webhooks/carts_update'}
   ]
 end
 ```
 
 When the oauth callback is completed successfully ShopifyApp will queue a background job which will ensure all the specified webhooks exist for that shop. Because this runs on every oauth callback it means your app will always have the webhooks it needs even if the user uninstalls and re-installs the app.
 
-There is also a WebhooksController module that you can include in a controller that receives Shopify webhooks. For example:
+ShopifyApp also provides a WebhooksController that receives webhooks and queues a job based on the webhook url. For example if you register the webhook from above then all you need to do is create a job called `CartsUpdateJob`. The job will be queued with 2 params `shop_domain` and `webhook` which is the webhook body.
+
+If you'd rather implement your own controller then you'll want to use the WebhookVerfication module to verify your webhooks:
 
 ```ruby
-class WebhooksController < ApplicationController
-  include ShopifyApp::WebhooksController
+class CustomWebhooksController < ApplicationController
+  include ShopifyApp::WebhookVerification
 
   def carts_update
     SomeJob.perform_later(shopify_domain: shop_domain)
@@ -152,6 +167,13 @@ The module skips the `verify_authenticity_token` before_action and adds an actio
 
 The WebhooksManager uses ActiveJob, if ActiveJob is not configured then by default Rails will run the jobs inline. However it is highly recommended to configure a proper background processing queue like sidekiq or resque in production.
 
+ShopifyApp can create webhooks for you using the `add_webhook` generator. This will add the new webhook to your config and create the required job class for you.
+
+```
+rails g shopify_app:add_webhook -t carts/update -a https://example.com/webhooks/carts_update
+```
+
+where `-t` is the topic and `-a` is the address the webhook should be sent to.
 
 ShopifyApp::SessionRepository
 -----------------------------
@@ -163,7 +185,7 @@ If you only run the install generator then by default you will have an in memory
 AuthenticatedController
 -----------------------
 
-The engine includes a controller called `AuthenticatedController` which inherits from `ApplicationController`. It adds some before_filters which ensure the user is authenticated and will redirect to the login page if not. It is best practice to have all controllers that belong to the Shopify part of your app inherit from this controller. The HomeController that is generated already inherits from AuthenticatedController.
+The engine includes a controller called `ShopifyApp::AuthenticatedController` which inherits from `ApplicationController`. It adds some before_filters which ensure the user is authenticated and will redirect to the login page if not. It is best practice to have all controllers that belong to the Shopify part of your app inherit from this controller. The HomeController that is generated already inherits from AuthenticatedController.
 
 Troubleshooting
 ---------------

data/Rakefile

@@ -1,10 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 
-Rake::TestTask.new do |t|
-  t.libs << 'test'
-  t.test_files = FileList['test/**/*_test.rb']
-  t.verbose = true
-end
+require File.expand_path('../test/dummy/config/application', __FILE__)
 
-task :default => :test
+Rails.application.load_tasks

data/app/controllers/shopify_app/authenticated_controller.rb

@@ -0,0 +1,7 @@
+module ShopifyApp
+  class AuthenticatedController < ApplicationController
+    before_action :login_again_if_different_shop
+    around_filter :shopify_session
+    layout ShopifyApp.configuration.embedded_app? ? 'embedded_app' : 'application'
+  end
+end

data/app/controllers/shopify_app/sessions_controller.rb

@@ -0,0 +1,5 @@
+module ShopifyApp
+  class SessionsController < ApplicationController
+    include ShopifyApp::SessionsConcern
+  end
+end

data/app/controllers/shopify_app/webhooks_controller.rb

@@ -0,0 +1,27 @@
+module ShopifyApp
+  class WebhooksController < ApplicationController
+    include ShopifyApp::WebhookVerification
+
+    class ShopifyApp::MissingWebhookJobError < StandardError; end
+
+    def receive
+      job_args = {shop_domain: shop_domain, webhook: webhook_params}
+      webhook_job_klass.perform_later(job_args)
+      head :no_content
+    end
+
+    private
+
+    def webhook_params
+      params.except(:controller, :action, :type)
+    end
+
+    def webhook_job_klass
+      "#{webhook_type.classify}Job".safe_constantize or raise ShopifyApp::MissingWebhookJobError
+    end
+
+    def webhook_type
+      params[:type]
+    end
+  end
+end

data/config/routes.rb

@@ -5,4 +5,8 @@ ShopifyApp::Engine.routes.draw do
     get 'auth/shopify/callback' => :callback
     get 'logout' => :destroy, :as => :logout
   end
+
+  namespace :webhooks do
+    post ':type' => :receive
+  end
 end

data/lib/generators/shopify_app/add_webhook/add_webhook_generator.rb

@@ -0,0 +1,61 @@
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class AddWebhookGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      class_option :topic, type: :string, aliases: "-t", required: true
+      class_option :address, type: :string, aliases: "-a", required: true
+
+      def init_webhook_config
+        initializer = load_initializer
+        return if initializer.include?("config.webhooks")
+
+        inject_into_file(
+          'config/initializers/shopify_app.rb',
+          "  config.webhooks = [\n  ]\n",
+          before: 'end'
+        )
+      end
+
+      def inject_webhook_to_shopify_app_initializer
+        inject_into_file(
+          'config/initializers/shopify_app.rb',
+          webhook_config,
+          after: "config.webhooks = ["
+        )
+
+        initializer = load_initializer
+
+        unless initializer.include?(webhook_config)
+          shell.say "Error adding webhook to config. Add this line manually: #{webhook_config}", :red
+        end
+      end
+
+      def add_webhook_job
+        @job_file_name = address.split('/').last + '_job'
+        @job_class_name  = @job_file_name.classify
+        template 'webhook_job.rb', "app/jobs/#{@job_file_name}.rb"
+      end
+
+      private
+
+      def load_initializer
+        File.read(File.join(destination_root, 'config/initializers/shopify_app.rb'))
+      end
+
+      def webhook_config
+        "\n    {topic: '#{topic}', address: '#{address}', format: 'json'},"
+      end
+
+      def topic
+        options['topic']
+      end
+
+      def address
+        options['address']
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/add_webhook/templates/webhook_job.rb

@@ -0,0 +1,8 @@
+class <%= @job_class_name %> < ActiveJob::Base
+  def perform(shop_domain:, webhook:)
+    shop = Shop.find_by(shopify_domain: shop_domain)
+
+    shop.with_shopify_session do
+    end
+  end
+end

data/lib/generators/shopify_app/controllers/controllers_generator.rb

@@ -14,7 +14,7 @@ module ShopifyApp
       private
 
       def controllers
-        files_within_root('.', 'app/controllers/*.*')
+        files_within_root('.', 'app/controllers/shopify_app/*.*')
       end
 
       def files_within_root(prefix, glob)

data/lib/generators/shopify_app/home_controller/home_controller_generator.rb

@@ -20,7 +20,6 @@ module ShopifyApp
       end
 
       def add_home_index_route
-        route "mount ShopifyApp::Engine, at: '/'"
         route "root :to => 'home#index'"
       end
 

data/lib/generators/shopify_app/home_controller/templates/home_controller.rb

@@ -1,4 +1,4 @@
-class HomeController < AuthenticatedController
+class HomeController < ShopifyApp::AuthenticatedController
   def index
     @products = ShopifyAPI::Product.find(:all, :params => {:limit => 10})
   end

data/lib/generators/shopify_app/install/install_generator.rb

@@ -6,26 +6,17 @@ module ShopifyApp
     class InstallGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
       source_root File.expand_path('../templates', __FILE__)
-      attr_reader :opts
 
-      def initialize(args, *options)
-        @opts = Hash[options.first.join(' ').scan(/--?([^=\s]+)(?:=(\S+))?/)]
-        @opts = @opts.with_indifferent_access
-        @opts.reverse_merge!(defaults)
-        super(args, *options)
-      end
-
-      def defaults
-        {
-          api_key: '<api_key>',
-          secret: '<secret>',
-          redirect_uri: 'http://localhost:3000/auth/shopify/callback',
-          scope: 'read_orders, read_products',
-          embedded: 'true'
-        }
-      end
+      class_option :api_key, type: :string, default: '<api_key>'
+      class_option :secret, type: :string, default: '<secret>'
+      class_option :scope, type: :string, default: 'read_orders, read_products'
+      class_option :embedded, type: :string, default: 'true'
 
       def create_shopify_app_initializer
+        @api_key = options['api_key']
+        @secret = options['secret']
+        @scope = options['scope']
+
         template 'shopify_app.rb', 'config/initializers/shopify_app.rb'
       end
 
@@ -56,7 +47,7 @@ module ShopifyApp
         inject_into_class(
           "app/controllers/application_controller.rb",
           'ApplicationController',
-          "  include ShopifyApp::Controller\n"
+          "  include ShopifyApp::LoginProtection\n"
         )
       end
 
@@ -67,11 +58,14 @@ module ShopifyApp
         end
       end
 
+      def mount_engine
+        route "mount ShopifyApp::Engine, at: '/'"
+      end
 
       private
 
       def embedded_app?
-        opts[:embedded] != 'false'
+        options['embedded'] == 'true'
       end
     end
   end

data/lib/generators/shopify_app/install/templates/embedded_app.html.erb

@@ -18,14 +18,14 @@
 
     <%= render 'layouts/flash_messages' %>
 
-    <script src="//cdn.shopify.com/s/assets/external/app.js?<%= Time.now.strftime('%Y%m%d%H') %>"></script>
+    <script src="https://cdn.shopify.com/s/assets/external/app.js?<%= Time.now.strftime('%Y%m%d%H') %>"></script>
 
     <script type="text/javascript">
       ShopifyApp.init({
         apiKey: "<%= ShopifyApp.configuration.api_key %>",
         shopOrigin: "<%= "https://#{ @shop_session.url }" if @shop_session %>",
         debug: <%= Rails.env.development? ? 'true' : 'false' %>,
-        forceRedirect: false
+        forceRedirect: true
       });
     </script>