shopify_app 6.3.0 → 6.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b424982cf65b0c9b98ba51dd08c9c6a4ce992c3
-  data.tar.gz: 10e9c18f779eec012ab057afd1c5e2d220900aa3
+  metadata.gz: 9fdbb7537a49e1636bfed63000bcad7c99080486
+  data.tar.gz: fd61682e6ec442674b7fd0e340ad25ea5c1a1ed1
 SHA512:
-  metadata.gz: 439c8119016ab19b45dee3dcab077626438cea6d7c16c151e5c06cf441a7d3131e8660c29939f4e303a164412b7dbe048e8ba8bf43e77e6e851ebc0f0ad186ea
-  data.tar.gz: cbfdb0d91cdd3af92b08bff988f1389f85ac348e923a63c8d43d7e98007835593b432d6240dcf4248de6ce9d05fa65e42623ca9b9b3559ca1560f58903b0bbe7
+  metadata.gz: 02d042ee94d3c5a9beab3a1c2df59472b88acf4a415c70982689f28af8ff5f5552f28b16a24901afea9071a5753da6e27cd6ffb8b3e0d9675666748c109fb052
+  data.tar.gz: 56d11b9ded7132222e769d140f60107c16ae67531dfbe3fa37351bdca0dd997eb64ff76666a2e7292e7b1076652d23669adeb270805e8db603f5720e4ab77d62

data/CHANGELOG

@@ -1,3 +1,11 @@
+6.4.0
+-----
+
+* More semantic and accessible markup in the sessions/new, embedded_app, and product
+  index views.
+* Moved all JavaScript to load at the bottom of the page instead of the head, for
+  page loading better performance.
+
 6.3.0
 -----
 

data/QUICKSTART.md

@@ -0,0 +1,73 @@
+Quickstart
+==========
+
+Build and deploy a new Shopify App to Heroku in minutes
+
+1. New Rails App (with postgres)
+--------------------------------
+
+```
+rails new test-app --database=postgresql
+cd test-app
+git init
+git add .
+git commit -m 'new rails app'
+```
+
+2. Create a new Heroku app
+--------------------------
+
+The next step is to create a new heroku app. Pull up your heroku dashboard and make a new app!
+
+cli:
+```
+heroku new
+git remote -v
+git remote set-url heroku git@heroku.com:<name>.git
+  ```
+
+now we need to let git know where the remote server is so we'll be able to deploy later
+
+web:
+```
+https://dashboard.heroku.com/new
+git remote add heroku git@heroku.com:appinfive.git
+```
+
+3. Create a new App in the partners area
+-----------------------------------------
+[https://app.shopify.com/services/partners/api_clients](https://app.shopify.com/services/partners/api_clients)
+* set the callback url to `https://<name>.herokuapp.com/`
+* choose an embedded app
+* set the redirect_uri to `https://<name>.herokuapp.com/auth/shopify/callback`
+
+
+4. Add ShopifyApp to gemfile
+----------------------------
+```
+vim Gemfile
+  add
+    gem 'shopify_app', '~> 6.0.6'
+
+bundle install
+```
+
+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
+git add .
+git commit -m 'generated shopify app'
+```
+
+6. Deploy
+---------
+```
+git push heroku
+heroku run rake db:migrate
+```
+
+7. Install the App!
+-------------------
+`https://<name>.herokuapp.com/`

data/README.md

@@ -18,6 +18,7 @@ Check out this screencast on how to create and deploy a new Shopify App to Herok
 
 [https://vimeo.com/130247240](https://vimeo.com/130247240)
 
+Or if you prefer text instructions the steps in the video are written out [here](https://github.com/Shopify/shopify_app/blob/master/QUICKSTART.md)
 
 Becoming a Shopify App Developer
 --------------------------------
@@ -122,7 +123,7 @@ end
 WebhooksManager
 ---------------
 
-ShopifyApp can manage your app's webhooks for you (requires ActiveJob). Set which webhooks you require in the initializer:
+ShopifyApp can manage your app's webhooks for you by setting which webhooks you require in the initializer:
 
 ```ruby
 ShopifyApp.configure do |config|
@@ -149,6 +150,8 @@ end
 
 The module skips the `verify_authenticity_token` before_action and adds an action to verify that the webhook came from Shopify.
 
+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::SessionRepository
 -----------------------------
@@ -175,6 +178,14 @@ $ bundle exec spring stop
 
 Run shopify_app generator again.
 
+Testing an embedded app outside the Shopify admin
+-------------------------------------------------
+
+By default, loading your embedded app will redirect to the Shopify admin, with the app view loaded in an `iframe`. If you need to load your app outside of the Shopify admin (e.g., for performance testing), you can change `forceRedirect: false` to `true` in `ShopifyApp.init` block in the `embedded_app` view. To keep the redirect on in production but off in your `development` and `test` environments, you can use:
+
+```javascript
+forceRedirect: <%= Rails.env.development? || Rails.env.test? ? 'false' : 'true' %>
+```
 
 Questions or problems?
 ----------------------

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

@@ -1,17 +1,94 @@
 <!DOCTYPE html>
-<html>
+<html lang="en">
 <head>
-  <title>Install Page</title>
+  <title>Shopify App — Installation</title>
+
+  <style>
+    html, body { padding: 0; margin: 0; }
+
+    body {
+      font-family: "ProximaNovaLight", "Helvetica Neue", Helvetica, Arial, sans-serif;
+      background-color: #f2f7fa;
+    }
+
+    h1 {
+      font-weight: 300;
+      font-size: 40px;
+      margin-bottom: 10px;
+    }
+
+    .subhead {
+      font-size: 17px;
+      line-height: 32px;
+      font-weight: 300;
+      color: #969A9C;
+    }
+
+    input {
+      width: 300px;
+      height: 50px;
+      padding: 10px;
+      border: 1px solid #479CCf;
+      color: #575757;
+      background-color: #ffffff;
+      box-sizing: border-box;
+      border-radius: 4px 0 0 4px;
+      font-size: 18px;
+      float: left;
+    }
+
+    button {
+      color: #ffffff;
+      background-color: #3793cb;
+      width: 100px;
+      height: 50px;
+      padding: 10px 20px 10px 20px;
+      box-sizing: border-box;
+      border: none;
+      text-shadow: 0 1px 0 #3188bc;
+      font-size: 18px;
+      cursor: pointer;
+      border-radius: 0 4px 4px 0;
+      float: right;
+    }
+
+    button:hover {
+      background-color: #479CCf;
+    }
+
+    form {
+      display: block;
+    }
+
+    .container {
+      text-align: center;
+      margin-top: 100px;
+      padding: 20px;
+    }
+
+    .container__form {
+      width: 400px;
+      margin: auto;
+    }
+  </style>
 </head>
 <body>
 
-  <h2>Install the application</h2>
+  <main class="container" role="main">
+    <header>
+      <h1>Shopify App — Installation</h1>
+      <p class="subhead">
+        <label for="shop">Please enter the “myshopify” domain of your store</label>
+      </p>
+    </header>
 
-  <form method="GET" action="login">
-    <label>Type shop name:</label>
-    <input type="text" name="shop" placeholder="blabla.myshopify.com"/>
-    <button type='submit'>Install</button>
-  </form>
+    <div class="container__form">
+      <form method="GET" action="login">
+        <input type="text" name="shop" id="shop" placeholder="blabla.myshopify.com"/>
+        <button type="submit">Install</button>
+      </form>
+    </div>
+  </main>
 
 </body>
 </html>

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

@@ -76,7 +76,7 @@ module ShopifyApp
         if embedded_app?
           prepend_to_file(
             'app/views/home/index.html.erb',
-            File.read(File.expand_path(find_in_source_paths('shopify_app_ready_script.html')))
+            File.read(File.expand_path(find_in_source_paths('shopify_app_ready_script.html.erb')))
           )
         end
       end

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

@@ -1,3 +1,4 @@
+<% content_for :javascript do %>
 <script type="text/javascript">
   var eventName = typeof(Turbolinks) !== 'undefined' ? 'page:change' : 'DOMContentLoaded';
 
@@ -11,3 +12,4 @@
     <% end %>
   });
 </script>
+<% end %>

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

@@ -1,24 +1,40 @@
 <!DOCTYPE html>
 <html lang="en">
-<head>
-  <title>Shopify Embedded Example App</title>
+  <head>
+    <meta charset="utf-8" />
+    <title>Shopify Embedded Example App</title>
+    <%= stylesheet_link_tag 'application' %>
+    <%= csrf_meta_tags %>
+  </head>
 
-  <script src="//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' %>
-    });
-  </script>
+  <body>
+    <div class="app-wrapper">
+      <div class="app-content">
+        <main role="main">
+          <%= yield %>
+        </main>
+      </div>
+    </div>
 
-  <%= stylesheet_link_tag 'application' %>
-  <%= javascript_include_tag 'application' %>
-  <%= csrf_meta_tags %>
-</head>
+    <%= render 'layouts/flash_messages' %>
 
-<body>
-  <%= yield %>
-  <%= render 'layouts/flash_messages' %>
-</body>
+    <script src="//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
+      });
+    </script>
+
+    <%= javascript_include_tag 'application', "data-turbolinks-track" => true %>
+
+    <% if content_for?(:javascript) %>
+      <div id="ContentForJavascript" data-turbolinks-temporary>
+        <%= yield :javascript %>
+      </div>
+    <% end %>
+  </body>
 </html>

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

@@ -1,12 +1,7 @@
-<h3>Products</h3>
-<table>
-  <tbody>
-    <% @products.each do |product| %>
-      <tr>
-        <td>
-          <a href='https://<%="#{@shop_session.url}/admin/products/#{product.id}"%>' target="_blank"> <%= product.id %> </a>
-        </td>
-      </tr>
-    <% end %>
-  </tbody>
-</table>
+<h2>Products</h2>
+
+<ul>
+  <% @products.each do |product| %>
+    <li><%= link_to product.title, "https://#{@shop_session.url}/admin/products/#{product.id}", target: "_top" %></li>
+  <% end %>
+</ul>

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

@@ -0,0 +1,11 @@
+<% content_for :javascript do %>
+  <script type="text/javascript">
+    ShopifyApp.ready(function(){
+      ShopifyApp.Bar.initialize({
+        title: "Home",
+        icon: "<%= asset_path('favicon.ico') %>"
+      });
+    });
+  </script>
+<% end %>
+

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

@@ -1,9 +1,5 @@
   provider :shopify,
     ShopifyApp.configuration.api_key,
     ShopifyApp.configuration.secret,
-
-    :redirect_uri => ShopifyApp.configuration.redirect_uri,
-
-    :callback_url => ShopifyApp.configuration.redirect_uri,
-
-    :scope => ShopifyApp.configuration.scope
+    redirect_uri: ShopifyApp.configuration.redirect_uri,
+    scope: ShopifyApp.configuration.scope

data/lib/shopify_app/sessions_controller.rb

@@ -25,7 +25,7 @@ module ShopifyApp
         redirect_to return_address
       else
         flash[:error] = "Could not log in to Shopify store."
-        redirect_to action: 'new'
+        redirect_to login_url
       end
     end
 
@@ -33,7 +33,7 @@ module ShopifyApp
       session[:shopify] = nil
       session[:shopify_domain] = nil
       flash[:notice] = "Successfully logged out."
-      redirect_to action: 'new'
+      redirect_to login_url
     end
 
     protected

data/lib/shopify_app/version.rb

@@ -1,3 +1,3 @@
 module ShopifyApp
-  VERSION = '6.3.0'
+  VERSION = '6.4.0'
 end

data/shopify_app.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
   s.add_dependency('rails', '>= 3.1', '< 5.0')
 
   s.add_runtime_dependency('shopify_api', '~> 4.0.2')
-  s.add_runtime_dependency('omniauth-shopify-oauth2', '~> 1.1.10')
+  s.add_runtime_dependency('omniauth-shopify-oauth2', '~> 1.1.11')
 
   s.add_development_dependency('rake')
   s.add_development_dependency('byebug')

data/test/support/generator_test_helpers.rb

@@ -1,4 +1,4 @@
-class ActiveSupport::TestCase
+module GeneratorTestHelpers
   TEMPLATE_PATH = File.expand_path("../../app_templates", __FILE__)
 
   def provide_existing_application_controller

data/test/test_helper.rb

@@ -11,3 +11,7 @@ require 'byebug'
 Minitest.backtrace_filter = Minitest::BacktraceFilter.new
 
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+class ActiveSupport::TestCase
+  include GeneratorTestHelpers
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 6.3.0
+  version: 6.4.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-06 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -50,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.10
+        version: 1.1.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.10
+        version: 1.1.11
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -140,6 +140,7 @@ files:
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE
+- QUICKSTART.md
 - README.md
 - RELEASING
 - Rakefile
@@ -155,7 +156,7 @@ files:
 - lib/generators/shopify_app/install/templates/index.html.erb
 - lib/generators/shopify_app/install/templates/omniauth.rb
 - lib/generators/shopify_app/install/templates/shopify_app.rb
-- lib/generators/shopify_app/install/templates/shopify_app_ready_script.html
+- lib/generators/shopify_app/install/templates/shopify_app_ready_script.html.erb
 - lib/generators/shopify_app/install/templates/shopify_provider.rb
 - lib/generators/shopify_app/install/templates/shopify_session_repository.rb
 - lib/generators/shopify_app/routes/routes_generator.rb

data/lib/generators/shopify_app/install/templates/shopify_app_ready_script.html

@@ -1,8 +0,0 @@
-<script type="text/javascript">
-  ShopifyApp.ready(function(){
-    ShopifyApp.Bar.initialize({
-      title: "Home",
-      icon: "<%= asset_path('favicon.ico') %>"
-    });
-  });
-</script>