shopify_app 11.0.0 → 11.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99e91b542c6d5f2fb530c9d259e6d32d463bb6e8d0720dd11faa009e845d2ced
-  data.tar.gz: '0214085b33d8ccbb7dfe929430f81b75296ac5cf201c6b9969ba0b5d78ea7351'
+  metadata.gz: b874717cc161bca6ab8798663bffe95921d8996c0bb47bbee3088b39e475ced9
+  data.tar.gz: 951abd9f6de28d85017ea86ecf476c3a593a39a2c97d78b1de0c2730a66d2947
 SHA512:
-  metadata.gz: f8fb32cc915ecfeba1ee7db40f1cd3ec4e0c9b8c8bae697370248a8f6225f70504da6a3a160cdfb960426899c2d0abcbbe8f623a0771cef81c7ddb1e58ac779d
-  data.tar.gz: 73c4b7f0f49130ea808fd7b4c24cef408025a5fcaf89a8b29ee2c0baa0e00d0837b11ec6ecd7f35d4c57269a39e357a9d3cb7d5b55b66a76ff25b0444f503405
+  metadata.gz: 6294f63182cc288b07bf9fd4ec70ccc69503debd780693288982eea396f7b748ddb2da868971b616c470ae7fc1308598dbf64d4ece89e57953d80007e124b963
+  data.tar.gz: e45293b324384dad4db23338dbb9846a5f81db31d7dcd03fa4b14d985e64b281e3571d67ab7f7a70ff6ef62710b9cc39a808c016c9e56acd98810ea8dcccbb24

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+11.0.1
+-----
+
+* Add dotenv-rails gem to install generator, so apps fetch credentials from `.env` by default: [#776](https://github.com/Shopify/shopify_app/pull/776)
+
 11.0.0
 -----
 

data/README.md

@@ -26,7 +26,6 @@ Table of Contents
  * [App Proxy Controller Generator](#app-proxy-controller-generator)
  * [Controllers, Routes and Views](#controllers-routes-and-views)
 * [**Mounting the Engine**](#mounting-the-engine)
-* [**Managing Api Keys**](#managing-api-keys)
 * [**WebhooksManager**](#webhooksmanager)
 * [**ScripttagsManager**](#scripttagsmanager)
 * [**AfterAuthenticate Job**](#afterauthenticate-job)
@@ -104,11 +103,22 @@ Generators
 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>
+$ rails generate shopify_app
 ```
 
 After running the generator, you will need to run `rake db:migrate` to add tables to your database. You can start your app with `bundle exec rails server` and install your app by visiting localhost.
 
+### API Keys
+
+The default and install generators have been updated to source Shopify API key and secret from a `.env` file, which you will need to create with the following format:
+
+```
+SHOPIFY_API_KEY=your api key
+SHOPIFY_API_SECRET=your api secret
+```
+
+These values can be found on the "App Setup" page in the [Shopify Partners Dashboard][dashboard].
+
 ### Install Generator
 
 ```sh
@@ -116,7 +126,7 @@ $ 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
 ```
 
 Other options include:
@@ -244,21 +254,6 @@ The current Shopify user will be stored in the rails session at `session[:shopif
 
 This will change the type of token that Shopify returns and it will only be valid for a short time. Read more about `Online access` [here](https://help.shopify.com/api/getting-started/authentication/oauth). Note that this means you won't be able to use this token to respond to Webhooks.
 
-Managing Api Keys
------------------
-
-The `install` generator places your Api credentials directly into the shopify_app initializer which is convenient and fine for development but once your app goes into production **your api credentials should not be in source control**. When we develop apps we keep our keys in environment variables so a production shopify_app initializer would look like this:
-
-```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, write_products'
-  config.embedded_app = true
-end
-```
-
 
 WebhooksManager
 ---------------
@@ -439,7 +434,7 @@ class ReviewsController < ApplicationController
 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`.
+Create your app proxy url in the [Shopify Partners' Dashboard][dashboard], making sure to point it to `https://your_app_website.com/app_proxy`.
 ![Creating an App Proxy](/images/app-proxy-screenshot.png)
 
 Troubleshooting
@@ -515,3 +510,5 @@ is changed to
 ### ShopifyAPI changes
 
 You will need to also follow the ShopifyAPI [upgrade guide](https://github.com/Shopify/shopify_api/blob/master/README.md#-breaking-change-notice-for-version-700-) to ensure your app is ready to work with api versioning.
+
+[dashboard]:https://partners.shopify.com

data/config/locales/nl.yml

@@ -1,6 +1,6 @@
 ---
 nl:
-  logged_out: u bent afgemeld
+  logged_out: je bent afgemeld
   could_not_log_in: Kon niet aanmelden bij Shopify-winkel
   invalid_shop_url: Ongeldig winkeldomein
   enable_cookies_heading: Schakel cookies in van %{app}

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

@@ -7,18 +7,16 @@ module ShopifyApp
       source_root File.expand_path('../templates', __FILE__)
 
       class_option :application_name, type: :array, default: ['My', 'Shopify', 'App']
-      class_option :api_key, type: :string, default: '<api_key>'
-      class_option :secret, type: :string, default: '<secret>'
-      class_option :old_secret, type: :string, default: '<old_secret>'
       class_option :scope, type: :array, default: ['read_products']
       class_option :embedded, type: :string, default: 'true'
       class_option :api_version, type: :string, default: ShopifyAPI::ApiVersion.latest_stable_version.to_s
 
+      def add_dotenv_gem
+        gem('dotenv-rails', group: [:test, :development])
+      end
+
       def create_shopify_app_initializer
         @application_name = format_array_argument(options['application_name'])
-        @api_key = options['api_key']
-        @secret = options['secret']
-        @old_secret = options['old_secret']
         @scope = format_array_argument(options['scope'])
         @api_version = options['api_version']
 

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

@@ -1,7 +1,7 @@
 ShopifyApp.configure do |config|
   config.application_name = "<%= @application_name %>"
-  config.api_key = "<%= @api_key %>"
-  config.secret = "<%= @secret %>"
+  config.api_key = ENV['SHOPIFY_API_KEY']
+  config.secret = ENV['SHOPIFY_API_SECRET']
   config.old_secret = "<%= @old_secret %>"
   config.scope = "<%= @scope %>" # Consult this page for more scope options:
                                  # https://help.shopify.com/en/api/getting-started/authentication/oauth/scopes

data/lib/shopify_app/version.rb

@@ -1,3 +1,3 @@
 module ShopifyApp
-  VERSION = '11.0.0'.freeze
+  VERSION = '11.0.1'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 11.0.0
+  version: 11.0.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-03 00:00:00.000000000 Z
+date: 2019-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: browser_sniffer