shopify_app 8.1.0 → 8.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4542a5b3f58a2e7a539c6de59632620df01c36f8
-  data.tar.gz: '022092d414e237445b38a68476b03331362753c5'
+  metadata.gz: 638ecefa077fb7501468d89a5e84f6737c84a794
+  data.tar.gz: 960b0f8831db1fb97c04b30fc52f72b624b98387
 SHA512:
-  metadata.gz: c63e25613286a63914472aba0e791502e683fb2a4b32715f8f69426c4edf48e6b63efe07880d91a33437ea0ae3fec96acd3cff4e9b2ec113a3e064532280dee0
-  data.tar.gz: 9164dbf445acb30e6937cadea35bb2e4fa63a144cca5d97da8c4708e49b6122e5ccf850f400cd3963ed2c9aed0934b72fb68ba26aab841e17de65af0b8435458
+  metadata.gz: b29e463e3337b211e5e1ddf7c2c4e794db894235a05b39ee5ea6b7eabcd42ae095517c165165da3a98fdf0da17d5fb1bd03efe4efbab1ad1ad338b1923b2f466
+  data.tar.gz: 26854b97c8f6888c88c1950357a15a81352c4b18ad708436c6b5dd8bb40f25f196ee65084475a9ee6a2710ddaf0f84c88c9733bf78abc2f11bf90d17accb9756

data/CHANGELOG.md

@@ -1,7 +1,12 @@
+8.2.0
+-----
+* Add `webhook_jobs_namespace` config option. [[#463]](https://github.com/Shopify/shopify_app/pull/463)
+* Updates login page styles to match the [Polaris](https://polaris.shopify.com/) design system. [[#474]](https://github.com/Shopify/shopify_app/pull/474)
+
 8.1.0
 -----
 * Add support for per_user_authentication
-* Pass the shop param in the session for authentication instead of a url param (prevents csrf)
+* Pass the shop param in the session for authentication instead of a url param (prevents csrf). If you are upgrading from an older version of the gem you will need to update your omniauth.rb initializer file. Check the example app for what it what it should look like.
 
 8.0.0
 -----

data/README.md

@@ -182,14 +182,15 @@ Mounting the Engine will provide the basic routes to authenticating a shop with
 |GET     |'/logout'                      |Logout                        |
 |POST    |'/webhooks/:type'              |Webhook Callback              |
 
+### Nested Routes
 
-If required the engine can be mounted at a nested route, eg:
+The engine may also be mounted at a nested route, for example:
 
 ```ruby
 mount ShopifyApp::Engine, at: '/nested'
 ```
 
-This will create the Shopify engine routes under the specified subpath. You'll also need to make some updates to your `shopify_app.rb` and `omniauth.rb` initializers. First update the shopify_app initializer to include a custom `root_url` e.g:
+This will create the Shopify engine routes under the specified subpath. You'll also need to make some updates to your `shopify_app.rb` and `omniauth.rb` initializers. First update the shopify_app initializer to include a custom `root_url` e.g.:
 
 ```ruby
 ShopifyApp.configure do |config|
@@ -197,7 +198,7 @@ ShopifyApp.configure do |config|
 end
 ```
 
-then update the omniauth initializer to include a custom `callback_path` e.g:
+then update the omniauth initializer to include a custom `callback_path` e.g.:
 
 ```ruby
 provider :shopify,
@@ -242,7 +243,7 @@ end
 WebhooksManager
 ---------------
 
-ShopifyApp can manage your app's webhooks for you by setting which webhooks you require in the initializer:
+ShopifyApp can manage your app's webhooks for you if you set which webhooks you require in the initializer:
 
 ```ruby
 ShopifyApp.configure do |config|
@@ -254,7 +255,15 @@ 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.
 
-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.
+ShopifyApp also provides a WebhooksController that receives webhooks and queues a job based on the received topic. 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 would like to namespace your jobs you may set `webhook_jobs_namespace` in the config. For example if your app handles webhooks from other ecommerce applications as well, and you want Shopify cart update webhooks to be processed by a job living in `jobs/shopify/webhooks/carts_update_job.rb` rather than `jobs/carts_update_job.rb`):
+
+```ruby
+ShopifyApp.configure do |config|
+  config.webhook_jobs_namespace = 'shopify/webhooks'
+end
+```
 
 If you are only interested in particular fields, you can optionally filter the data sent by Shopify by specifying the `fields` parameter in `config/webhooks`. Note that you will still receive a webhook request from Shopify every time the resource is updated, but only the specified fields will be sent.
 
@@ -322,7 +331,7 @@ If your app needs to perform specific actions after it is installed ShopifyApp c
 
 ```ruby
 ShopifyApp.configure do |config|
-  config.add_after_authenticate_job = { job: Shopify::AfterAuthenticateJob }
+  config.after_authenticate_job = { job: Shopify::AfterAuthenticateJob }
 end
 ```
 
@@ -330,7 +339,7 @@ If you need the job to run synchronously add the `inline` flag:
 
 ```ruby
 ShopifyApp.configure do |config|
-  config.add_after_authenticate_job = { job: Shopify::AfterAuthenticateJob, inline: true }
+  config.after_authenticate_job = { job: Shopify::AfterAuthenticateJob, inline: true }
 end
 ```
 

data/app/controllers/shopify_app/webhooks_controller.rb

@@ -18,11 +18,19 @@ module ShopifyApp
     end
 
     def webhook_job_klass
-      "#{webhook_type.classify}Job".safe_constantize or raise ShopifyApp::MissingWebhookJobError
+      webhook_job_klass_name.safe_constantize or raise ShopifyApp::MissingWebhookJobError
+    end
+
+    def webhook_job_klass_name(type = webhook_type)
+      [webhook_namespace, "#{type}_job"].compact.join('/').classify
     end
 
     def webhook_type
       params[:type]
     end
+
+    def webhook_namespace
+      ShopifyApp.configuration.webhook_jobs_namespace
+    end
   end
 end

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

@@ -3,92 +3,111 @@
 <head>
   <title>Shopify App — Installation</title>
 
+  <meta http-equiv="x-ua-compatible" content="ie=edge">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+
   <style>
-    html, body { padding: 0; margin: 0; }
+    * {
+      -moz-box-sizing: border-box;
+      -webkit-box-sizing: border-box;
+      box-sizing: border-box;
+    }
 
     body {
-      font-family: "ProximaNovaLight", "Helvetica Neue", Helvetica, Arial, sans-serif;
-      background-color: #f2f7fa;
+      padding: 2.5em 0;
+      color: #212b37;
+      font-family: -apple-system,BlinkMacSystemFont,San Francisco,Roboto,Segoe UI,Helvetica Neue,sans-serif;
     }
 
-    h1 {
-      font-weight: 300;
-      font-size: 40px;
-      margin-bottom: 10px;
+    .container {
+      width: 100%;
+      text-align: center;
+      margin-left: auto;
+      margin-right: auto;
     }
 
-    .subhead {
-      font-size: 17px;
-      line-height: 32px;
-      font-weight: 300;
-      color: #969A9C;
+    @media screen and (min-width: 510px) {
+      .container {
+        width: 510px;
+      }
     }
 
-    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;
+    .title {
+      font-size: 1.5em;
+      margin: 2em auto;
+      display: flex;
+      align-items: center;
+      justify-content: center;
+      word-break: break-all;
     }
 
-    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;
+    .subtitle {
+      font-size: 0.8em;
+      font-weight: 500;
+      color: #64737f;
+      line-height: 2em;
     }
 
-    button:hover {
-      background-color: #479CCf;
+    input.marketing-input {
+      width: 100%;
+      height: 52px;
+      padding: 0 15px;
+      box-shadow: 0 0 0 1px #ddd;
+      border: 0;
+      border-radius: 5px;
+      background-color: #fff;
+      font-size: 1em;
+      margin-bottom: 15px;
     }
 
-    form {
-      display: block;
+    input.marketing-input:focus {
+      color: #000;
+      outline: 0;
+      box-shadow: 0 0 0 2px #5e6ebf;
     }
 
-    .container {
+    button.marketing-button {
+      display: inline-block;
+      width: 100%;
+      padding: 1.0625em 1.875em;
+      background-color: #5e6ebf;
+      color: #fff;
+      font-weight: 700;
+      font-size: 1em;
       text-align: center;
-      margin-top: 100px;
-      padding: 20px;
+      outline: none;
+      border: 0 solid transparent;
+      border-radius: 5px;
+      cursor: pointer;
+    }
+
+    button.marketing-button:hover {
+      background: linear-gradient(to bottom, #5c6ac4, #4959bd);
+      border-color: #3f4eae;
     }
 
-    .container__form {
-      width: 400px;
-      margin: auto;
+    button.marketing-button:focus {
+      box-shadow: 0 0 0.1875em 0.1875em rgba(94,110,191,0.5);
+      background-color: #223274;
+      color: #fff;
     }
   </style>
 </head>
 <body>
 
   <main class="container" role="main">
-    <header>
-      <% application_name = ShopifyApp.configuration.application_name %>
-      <h1><%= application_name.presence || 'Shopify App – Installation' %></h1>
-      <p class="subhead">
-        <label for="shop">Enter your shop domain to log in or install this app.</label>
-      </p>
-    </header>
+    <% application_name = ShopifyApp.configuration.application_name %>
+    <h3 class="title">
+      <%= application_name.presence || 'Shopify App – Installation' %>
+    </h3>
+    <p class="subtitle">
+      <label for="shop">Enter your shop domain to log in or install this app.</label>
+    </p>
 
-    <div class="container__form">
-      <form method="GET" action="login">
-        <input type="text" name="shop" id="shop" placeholder="example.myshopify.com"/>
-        <button type="submit">Install</button>
-      </form>
-    </div>
+    <form method="GET" action="login">
+      <input id="shop" name="shop" type="text" autofocus="autofocus" placeholder="example.myshopify.com" class="marketing-input">
+      <button type="submit" class="marketing-button">Install</button>
+    </form>
   </main>
 
 </body>

data/lib/shopify_app/configuration.rb

@@ -25,6 +25,9 @@ module ShopifyApp
     # configure myshopify domain for local shopify development
     attr_accessor :myshopify_domain
 
+    # allow namespacing webhook jobs
+    attr_accessor :webhook_jobs_namespace
+
     def initialize
       @root_url = '/'
       @myshopify_domain = 'myshopify.com'

data/lib/shopify_app/version.rb

@@ -1,3 +1,3 @@
 module ShopifyApp
-  VERSION = '8.1.0'
+  VERSION = '8.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 8.1.0
+  version: 8.2.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-29 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails