shopify_app 7.0.11 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01fd54b8c417c343000ff7831af46518aae171ea
-  data.tar.gz: e090401fe863bdef0f70cb41fd2c184332565439
+  metadata.gz: 95666ea2f773fc1abdccd1dd9fbe7b9a2d52763e
+  data.tar.gz: 997acff43235b5ab32e218f78754f0600c1ab88e
 SHA512:
-  metadata.gz: a857bf574d74edcf5820f253404ce863c3ca4b50d92026780e32060aedfe7b658865c86a92df0062f63f0894e21dd82f7d10a8f99987ad66ba06b1f5d62b4106
-  data.tar.gz: bdf917823af652bc3b6f340fd0c3a26c01320e12ae097f2b11e81031f606c54fc91b34a6918211e2c9027adaca11c027ac99e1d0ce306fdb2b5f6a552e30c0f0
+  metadata.gz: 41a95e72af79a9128c34f740294eb49901342ff179a1651332712ac151ece83b2b20ea84fd87861eb681ee8b0b627212abc3c57c8795b8f7618ade804f6a72a1
+  data.tar.gz: d5d05dc80096af9ed3d3219ea7ddd8547aef315885eff4b81f51b01b6c2fbcb18356131223a98100dc511ae6245a8a6d9736dbf0a86c0506cf7b7fda8879912a

data/.travis.yml

@@ -3,9 +3,15 @@ cache: bundler
 sudo: false
 
 rvm:
-  - 2.2.4
   - 2.3.1
 
 gemfile:
   - Gemfile
   - Gemfile.rails50
+
+matrix:
+  include:
+  - rvm: 2.2.4
+    gemfile: Gemfile.ruby22
+  - rvm: 2.2.4
+    gemfile: Gemfile.ruby22.rails50

data/{CHANGELOG → CHANGELOG.md}

@@ -1,9 +1,19 @@
+7.1.0
+-----
+* Update login page copy
+* Add application_name configuration option
+* Add new optional App Proxy Controller Generator to the Engine. Refer README for details.
+* Include ShopifyApp::LoginProtection in Authenticated and Session Controller directly instead of Application Controller.
+* Loosen ShopifyAPI dependency requirements to `>= 4.2.2` and allow ShopifyAPI 4.3.0 and above.
+* Move application.js to inside HEAD in Embedded App Template.
+* Add ability to override the ActiveJob queue names in initializer file.
+
 7.0.11
 ------
 * Pass configured resources (like webhooks or scripttags) into the job rather than reading the config again. This allows for dynamically setting ShopifyApp config in a web request and having the job handle it correctly. This change does not affect the usage of webhooks or scripttags
 
 7.0.10
------
+------
 * Loosen Rails dependency requirements to `>= 4.2.6` and allow Rails 5.0
 * Add support for App Proxies
 
@@ -25,7 +35,7 @@
 7.0.3
 -----
 
-* Bump required Rails version to >= 4.2.6 since we are now using ActiveSupport::SecurityUtils:Module
+* Bump required Rails version to `>= 4.2.6` since we are now using `ActiveSupport::SecurityUtils:Module`
 
 7.0.2
 -----

data/Gemfile.ruby22

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shopify_app.gemspec
+gemspec
+
+gem 'shopify_api', '< 4.3'

data/Gemfile.ruby22.rails50

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in shopify_app.gemspec
+gemspec
+
+gem 'rails', '~> 5.0'
+gem 'activeresource', github: 'rails/activeresource'
+
+gem 'shopify_api', '< 4.3'

data/README.md

@@ -1,9 +1,42 @@
-Shopify App      [![Build Status](https://travis-ci.org/Shopify/shopify_app.png)](https://travis-ci.org/Shopify/shopify_app)
+Shopify App
 ===========
+[![Version][gem]][gem_url] [![Build Status](https://travis-ci.org/Shopify/shopify_app.png)](https://travis-ci.org/Shopify/shopify_app)
+
+[gem]: https://img.shields.io/gem/v/shopify_app.svg
+[gem_url]: https://rubygems.org/gems/shopify_app
+
 
 Shopify Application Rails engine and generator
 
 
+Table of Contents
+-----------------
+* [**Description**](#description)
+* [**Quickstart**](#quickstart)
+* [**Becoming a Shopify App Developer**](#becoming-a-shopify-app-developer)
+* [**Installation**](#installation)
+  * [Rails 5](#rails-5)
+* [**Generators**](#generators)
+ * [Default Generator](#default-generator)
+ * [Install Generator](#install-generator)
+ * [Shop Model Generator](#shop-model-generator)
+ * [Home Controller Generator](#home-controller-generator)
+ * [App Proxy Controller Generator](#app-proxy-controller-generator)
+ * [Controllers, Routes and Views](#controllers-routes-and-views)
+* [**Managing Api Keys**](#managing-api-keys)
+* [**WebhooksManager**](#webhooksmanager)
+* [**ScripttagsManager**](#scripttagsmanager)
+* [**ShopifyApp::SessionRepository**](#shopifyappsessionrepository)
+* [**AuthenticatedController**](#authenticatedcontroller)
+* [**AppProxyVerification**](#appproxyverification)
+ * [Recommended Usage](#recommended-usage)
+* [**Troubleshooting**](#troubleshooting)
+ * [Generator shopify_app:install hangs](#generator-shopify_appinstall-hangs)
+* [**Testing an embedded app outside the Shopify admin**](#testing-an-embedded-app-outside-the-shopify-admin)
+* [**App Tunneling**](#app-tunneling)
+* [**Questions or problems?**](#questions-or-problems)
+
+
 Description
 -----------
 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 via Oauth (other authentication methods are not supported).
@@ -60,6 +93,16 @@ $ bundle install
 Now we are ready to run any of the shopify_app generators. The following section explains the generators and what they can do.
 
 
+#### Rails 5
+
+shopify_app is compatible with Rails 5 but since the latest ActiveResource release (4.1) is locked on Rails 4.x, you'll need to use the unreleased master version:
+
+```ruby
+gem 'shopify_app'
+gem 'activeresource', github: 'rails/activeresource'
+```
+
+
 Generators
 ----------
 
@@ -83,6 +126,7 @@ $ rails generate shopify_app:install --api_key <your_api_key> --secret <your_app
 ```
 
 Other options include:
+* `application_name` - the name of your app
 * `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`
 
@@ -113,6 +157,15 @@ $ rails generate shopify_app:home_controller
 This generator creates an example home controller and view which fetches and displays products using the ShopifyAPI
 
 
+### App Proxy Controller Generator
+
+```sh
+$ rails generate shopify_app:app_proxy_controller
+```
+
+This optional generator, not included with the default generator, creates the app proxy controller to handle proxy requests to the app from your shop storefront, modifies 'config/routes.rb' with a namespace route, and an example view which displays current shop information using the LiquidAPI
+
+
 ### 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.
@@ -125,6 +178,7 @@ The `install` generator places your Api credentials directly into the shopify_ap
 
 ```ruby
 ShopifyApp.configure do |config|
+  config.application_name = 'Your app name' # Optional
   config.api_key = ENV['SHOPIFY_CLIENT_API_KEY']
   config.secret = ENV['SHOPIFY_CLIENT_API_SECRET']
   config.scope = 'read_customers, read_orders, write_products'
@@ -209,43 +263,18 @@ The engine provides a mixin for verifying incoming HTTP requests sent via an App
 
 ### Recommended Usage
 
-1. Use the `namespace` method to create app proxy routes
-    ```ruby
-    # config/routes.rb
-    namespace :app_proxy do
-      # simple routes without a specified controller will go to AppProxyController
-      # GET '/app_proxy/basic' will be routed to AppProxyController#basic
-      get :basic
-
-      # this will route GET /app_proxy to AppProxyController#main
-      root action: :main
-
-      # more complex routes will go to controllers in the AppProxy namespace
-      resources :reviews
-      # GET /app_proxy/reviews will now be routed to
-      # AppProxy::ReviewsController#index, for example
-    end
-    ```
-
-2. `include` the mixin in your app proxy controllers
-    ```ruby
-    # app/controllers/app_proxy_controller.rb
-    class AppProxyController < ApplicationController
-      include ShopifyApp::AppProxyVerification
-
-      def basic
-        render text: 'Signature verification passed!'
-      end
-    end
-
-    # app/controllers/app_proxy/reviews_controller.rb
-    class ReviewsController < ApplicationController
-      include ShopifyApp::AppProxyVerification
-      # ...
-    end
-    ```
-
-3. Create your app proxy url in the [Shopify Partners' Dashboard](https://app.shopify.com/services/partners/api_clients), making sure to point it to `https://your_app_website.com/app_proxy`.
+The App Proxy Controller Generator automatically adds the mixin to the generated app_proxy_controller.rb
+Additional controllers for resources within the App_Proxy namespace, will need to include the mixin like so:
+
+```ruby
+# app/controllers/app_proxy/reviews_controller.rb
+class ReviewsController < ApplicationController
+  include ShopifyApp::AppProxyVerification
+  # ...
+end
+```
+
+Create your app proxy url in the [Shopify Partners' Dashboard](https://app.shopify.com/services/partners/api_clients), making sure to point it to `https://your_app_website.com/app_proxy`.
 ![Creating an App Proxy](/images/app-proxy-screenshot.png)
 
 Troubleshooting
@@ -270,6 +299,13 @@ By default, loading your embedded app will redirect to the Shopify admin, with t
 forceRedirect: <%= Rails.env.development? || Rails.env.test? ? 'false' : 'true' %>
 ```
 
+App Tunneling
+-------------
+
+For certain features like Application Proxy or Webhooks to receive requests from Shopify, your app needs to be on a publicly visible URL. This can be a hurdle during development or testing on a local machine. Fortunately, this can be overcome by employing a tunneling service like [Forward](https://forwardhq.com/), [RequestBin](requestb.in/), [ngrok](https://ngrok.com/) etc. These tools allow you to create a secure tunnel from the public Internet to your local machine.
+
+Tunneling is also useful for working the the embedded app sdk to solve mixed content issues since most tunnles provide ssl.
+
 Questions or problems?
 ----------------------
 http://api.shopify.com <= Read up on the possible API calls!

data/app/controllers/shopify_app/authenticated_controller.rb

@@ -1,5 +1,6 @@
 module ShopifyApp
   class AuthenticatedController < ApplicationController
+    include ShopifyApp::LoginProtection
     before_action :login_again_if_different_shop
     around_action :shopify_session
     layout ShopifyApp.configuration.embedded_app? ? 'embedded_app' : 'application'

data/app/views/shopify_app/sessions/new.html.erb

@@ -76,15 +76,16 @@
 
   <main class="container" role="main">
     <header>
-      <h1>Shopify App — Installation</h1>
+      <% application_name = ShopifyApp.configuration.application_name %>
+      <h1><%= application_name.presence || 'Shopify App – Installation' %></h1>
       <p class="subhead">
-        <label for="shop">Please enter the “myshopify” domain of your store</label>
+        <label for="shop">Enter your shop domain to log in or install this app.</label>
       </p>
     </header>
 
     <div class="container__form">
       <form method="GET" action="login">
-        <input type="text" name="shop" id="shop" placeholder="blabla.myshopify.com"/>
+        <input type="text" name="shop" id="shop" placeholder="example.myshopify.com"/>
         <button type="submit">Install</button>
       </form>
     </div>

data/lib/generators/shopify_app/app_proxy_controller/app_proxy_controller_generator.rb

@@ -0,0 +1,25 @@
+require 'rails/generators/base'
+
+module ShopifyApp
+  module Generators
+    class AppProxyControllerGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def create_app_proxy_controller
+        template 'app_proxy_controller.rb', 'app/controllers/app_proxy_controller.rb'
+      end
+
+      def create_app_proxy_index_view
+        copy_file 'index.html.erb', 'app/views/app_proxy/index.html.erb'
+      end
+
+      def add_app_proxy_route
+        inject_into_file(
+          'config/routes.rb',
+          File.read(File.expand_path(find_in_source_paths('app_proxy_route.rb'))),
+          after: "mount ShopifyApp::Engine, at: '/'\n"
+        )  			 
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+class AppProxyController < ApplicationController
+   include ShopifyApp::AppProxyVerification
+
+  def index
+    render layout: false, content_type: 'application/liquid'
+  end
+
+end

data/lib/generators/shopify_app/app_proxy_controller/templates/app_proxy_route.rb

@@ -0,0 +1,10 @@
+
+  namespace :app_proxy do
+    root action: 'index'
+    # simple routes without a specified controller will go to AppProxyController
+    
+    # more complex routes will go to controllers in the AppProxy namespace
+    # 	resources :reviews
+    # GET /app_proxy/reviews will now be routed to
+    # AppProxy::ReviewsController#index, for example
+  end

data/lib/generators/shopify_app/app_proxy_controller/templates/index.html.erb

@@ -0,0 +1,19 @@
+<h2>App Proxy Page</h2>
+
+<p>Congratulations! You have successfully configured App Proxy for your shopify application.</p>
+<p>Any valid liquid code included in this page will be parsed and rendered by Shopify.</p>
+
+<br>
+
+<pre>
+Your Shop Details:
+<hr>
+	Shop Name 			: {{ shop.name }}
+	myshopify name 			: {{ shop.permanent_domain }}
+	Primary Domain of Shop 		: {{ shop.domain }}
+	Shop URL 			: {{ shop.url }}
+	Shop Currency 			: {{ shop.currency }}
+	No. of products in this shop 	: {{ shop.products_count }}
+<br>	
+<hr>	
+</pre>

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

@@ -7,12 +7,14 @@ module ShopifyApp
       include Rails::Generators::Migration
       source_root File.expand_path('../templates', __FILE__)
 
+      class_option :application_name, type: :string
       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
+        @application_name = options['application_name']
         @api_key = options['api_key']
         @secret = options['secret']
         @scope = options['scope']
@@ -43,14 +45,6 @@ module ShopifyApp
         end
       end
 
-      def inject_into_application_controller
-        inject_into_class(
-          "app/controllers/application_controller.rb",
-          'ApplicationController',
-          "  include ShopifyApp::LoginProtection\n"
-        )
-      end
-
       def create_embedded_app_layout
         if embedded_app?
           copy_file 'embedded_app.html.erb', 'app/views/layouts/embedded_app.html.erb'

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

@@ -2,8 +2,10 @@
 <html lang="en">
   <head>
     <meta charset="utf-8" />
-    <title>Shopify Embedded Example App</title>
+    <% application_name = ShopifyApp.configuration.application_name %>
+    <title><%= application_name.presence || 'Embedded Shopify App Example' %></title>
     <%= stylesheet_link_tag 'application' %>
+    <%= javascript_include_tag 'application', "data-turbolinks-track" => true %>
     <%= csrf_meta_tags %>
   </head>
 
@@ -29,8 +31,6 @@
       });
     </script>
 
-    <%= javascript_include_tag 'application', "data-turbolinks-track" => true %>
-
     <% if content_for?(:javascript) %>
       <div id="ContentForJavascript" data-turbolinks-temporary>
         <%= yield :javascript %>

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

@@ -1,4 +1,7 @@
 ShopifyApp.configure do |config|
+<% if @application_name.present? %>
+  config.application_name = "<%= @application_name %>"
+<% end %>
   config.api_key = "<%= @api_key %>"
   config.secret = "<%= @secret %>"
   config.scope = "<%= @scope %>"

data/lib/shopify_app/app_proxy_verification.rb

@@ -3,7 +3,12 @@ module ShopifyApp
     extend ActiveSupport::Concern
 
     included do
-      skip_before_action :verify_authenticity_token, raise: false
+      if Rails.version >= '5.0'
+        skip_before_action :verify_authenticity_token, raise: false
+      else
+        skip_before_action :verify_authenticity_token
+      end
+
       before_action :verify_proxy_request
     end
 

data/lib/shopify_app/configuration.rb

@@ -4,6 +4,7 @@ module ShopifyApp
     # Shopify App settings. These values should match the configuration
     # for the app in your Shopify Partners page. Change your settings in
     # `config/initializers/shopify_app.rb`
+    attr_accessor :application_name
     attr_accessor :api_key
     attr_accessor :secret
     attr_accessor :scope
@@ -12,6 +13,10 @@ module ShopifyApp
     attr_accessor :webhooks
     attr_accessor :scripttags
 
+    # customise ActiveJob queue names
+    attr_accessor :scripttags_manager_queue_name
+    attr_accessor :webhooks_manager_queue_name
+
     # configure myshopify domain for local shopify development
     attr_accessor :myshopify_domain
 
@@ -26,6 +31,14 @@ module ShopifyApp
     def has_scripttags?
       scripttags.present?
     end
+
+    def scripttags_manager_queue_name
+      @scripttags_manager_queue_name ||= Rails.application.config.active_job.queue_name
+    end
+
+    def webhooks_manager_queue_name
+      @webhooks_manager_queue_name ||= Rails.application.config.active_job.queue_name
+    end
   end
 
   def self.configuration

data/lib/shopify_app/scripttags_manager_job.rb

@@ -1,5 +1,10 @@
 module ShopifyApp
   class ScripttagsManagerJob < ActiveJob::Base
+
+    queue_as do
+      ShopifyApp.configuration.webhooks_manager_queue_name
+    end
+
     def perform(shop_domain:, shop_token:, scripttags:)
       ShopifyAPI::Session.temp(shop_domain, shop_token) do
         manager = ScripttagsManager.new(scripttags)

data/lib/shopify_app/sessions_concern.rb

@@ -2,6 +2,10 @@ module ShopifyApp
   module SessionsConcern
     extend ActiveSupport::Concern
 
+    included do
+      include ShopifyApp::LoginProtection
+    end
+
     def new
       authenticate if params[:shop].present?
     end

data/lib/shopify_app/version.rb

@@ -1,3 +1,3 @@
 module ShopifyApp
-  VERSION = '7.0.11'
+  VERSION = '7.1.0'
 end

data/lib/shopify_app/webhook_verification.rb

@@ -3,7 +3,12 @@ module ShopifyApp
     extend ActiveSupport::Concern
 
     included do
-      skip_before_action :verify_authenticity_token, raise: false
+      if Rails.version >= '5.0'
+        skip_before_action :verify_authenticity_token, raise: false
+      else
+        skip_before_action :verify_authenticity_token
+      end
+
       before_action :verify_request
     end
 
@@ -30,6 +35,5 @@ module ShopifyApp
     def shopify_hmac
       request.headers['HTTP_X_SHOPIFY_HMAC_SHA256']
     end
-
   end
 end

data/lib/shopify_app/webhooks_manager_job.rb

@@ -1,5 +1,10 @@
 module ShopifyApp
   class WebhooksManagerJob < ActiveJob::Base
+
+    queue_as do
+      ShopifyApp.configuration.webhooks_manager_queue_name
+    end
+
     def perform(shop_domain:, shop_token:, webhooks:)
       ShopifyAPI::Session.temp(shop_domain, shop_token) do
         manager = WebhooksManager.new(webhooks)

data/shopify_app.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = ">= 2.2.4"
 
   s.add_runtime_dependency('rails', '>= 4.2.6')
-  s.add_runtime_dependency('shopify_api', '~> 4.2.2')
+  s.add_runtime_dependency('shopify_api', '>= 4.2.2')
   s.add_runtime_dependency('omniauth-shopify-oauth2', '~> 1.1.11')
 
   s.add_development_dependency('rake')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 7.0.11
+  version: 7.1.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-11 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,14 +28,14 @@ dependencies:
   name: shopify_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.2
 - !ruby/object:Gem::Dependency
@@ -130,9 +130,11 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
-- CHANGELOG
+- CHANGELOG.md
 - Gemfile
 - Gemfile.rails50
+- Gemfile.ruby22
+- Gemfile.ruby22.rails50
 - ISSUE_TEMPLATE.md
 - LICENSE
 - QUICKSTART.md
@@ -149,6 +151,10 @@ files:
 - images/app-proxy-screenshot.png
 - lib/generators/shopify_app/add_webhook/add_webhook_generator.rb
 - lib/generators/shopify_app/add_webhook/templates/webhook_job.rb
+- lib/generators/shopify_app/app_proxy_controller/app_proxy_controller_generator.rb
+- lib/generators/shopify_app/app_proxy_controller/templates/app_proxy_controller.rb
+- lib/generators/shopify_app/app_proxy_controller/templates/app_proxy_route.rb
+- lib/generators/shopify_app/app_proxy_controller/templates/index.html.erb
 - lib/generators/shopify_app/controllers/controllers_generator.rb
 - lib/generators/shopify_app/home_controller/home_controller_generator.rb
 - lib/generators/shopify_app/home_controller/templates/home_controller.rb
@@ -208,7 +214,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: This gem is used to get quickly started with the Shopify API