shopify_app 6.2.0 → 6.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d25df222f8b66d4fa412f29bf0d467fa7c8926d
-  data.tar.gz: 22b43d52a0dd8c63d7dac595f11bc2edbc617a01
+  metadata.gz: 24a872186951e1f4c991d937f7f2a30e798f357e
+  data.tar.gz: 38c56b9a5e8255b6b59a425819b3390d5962ad7b
 SHA512:
-  metadata.gz: 453e91f835f95f13f51ddf570674eb691d28dca37f45d650411949ec8d52f58de7d9349e72c367da3296d6afefe4ad8206ab535982c9c970a0ec0416d0e27ec1
-  data.tar.gz: 48dac86145f7a9433e8e23574099630caaca1d95336e4d481dc656a93d37c11442617170a07aee68e49bdd6d82c854fb61b3627169acbe1b95a145a5c29c98e3
+  metadata.gz: a2ccfb1a9ef061db062030078ee3015d9e832abedf8ba01a65eb826dc3a51c7f2f47787b3cf822c2bb4ac31b08b4c6dbc2ee2615981631d30459a7aff9cbe615
+  data.tar.gz: 1b7dee2021821fe6182b747b6392ae9887d746f33c86c8b41b292d3e4b041220c225d86c7df54c4ec48194e139c998d5f93548bbac26304f118b84ac8fbda889

data/CHANGELOG

@@ -1,3 +1,9 @@
+6.2.1
+-----
+
+* add callback url to omniauth provider
+* add default redirect_uri
+
 6.2.0
 -----
 

data/README.md

@@ -57,18 +57,19 @@ $ rails generate shopify_app:install
 
 # or optionally with arguments:
 
-$ rails generate shopify_app:install -api_key=<your_api_key> -secret=<your_app_secret> -redirect_uri=<your_redirect_uri>
+$ 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.
 
 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.
 
-After running the `install` generator you can start your app with `bundle exec rails server` and install your app by visiting localhost.
+After running the `install` generator, you can start your app with `bundle exec rails server` and install your app by visiting localhost.
 
 
 ### Shop Model Generator
@@ -77,7 +78,7 @@ After running the `install` generator you can start your app with `bundle exec r
 $ rails generate shopify_app:shop_model
 ```
 
-The install generator doesn't create any database models for you and if you are starting a new app its quite likely that you will want one (most our internally developed apps do!). This generator creates a simple shop model and a migration. It also create a model called `SessionStorage` which interacts with `ShopifyApp::SessionRepository`. Check out the later section to learn more about `ShopifyApp::SessionRepository`
+The install generator doesn't create any database models for you and if you are starting a new app its quite likely that you will want one (most our internally developed apps do!). This generator creates a simple shop model and a migration. It also creates a model called `SessionStorage` which interacts with `ShopifyApp::SessionRepository`. Check out the later section to learn more about `ShopifyApp::SessionRepository`
 
 *Note that you will need to run rake db:migrate after this generator*
 
@@ -95,13 +96,13 @@ If you just run `rails generate shopify_app` then all the generators will be run
 Managing Api Keys
 -----------------
 
-The `install` generator places your Api credentials directly into the shopify_app initializer which is convient 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:
+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.api_key = ENV['SHOPIFY_CLIENT_API_KEY']
   config.secret = ENV['SHOPIFY_CLIENT_API_SECRET']
-  config.redirect_uri = "<%= your_redirect_uri %>"
+  config.redirect_uri = "http://localhost:3000/auth/shopify/callback"
   config.scope = 'read_customers, read_orders, write_products'
   config.embedded_app = true
 end
@@ -157,6 +158,17 @@ 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.
 
+Troubleshooting
+---------------
+
+### Generator shopify_app:install hangs
+
+Rails uses spring by default to speed up development. To run the generator, spring has to be stopped:
+```sh
+$ bundle exec spring stop
+```
+Run shopify_app generator again.
+
 
 Questions or problems?
 ----------------------

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

@@ -19,7 +19,7 @@ module ShopifyApp
         {
           api_key: '<api_key>',
           secret: '<secret>',
-          redirect_uri: '<redirect_uri>',
+          redirect_uri: 'http://localhost:3000/auth/shopify/callback',
           scope: 'read_orders, read_products',
           embedded: 'true'
         }

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

@@ -4,4 +4,6 @@
 
     :redirect_uri => ShopifyApp.configuration.redirect_uri,
 
+    :callback_url => ShopifyApp.configuration.redirect_uri,
+
     :scope => ShopifyApp.configuration.scope

data/lib/shopify_app/version.rb

@@ -1,3 +1,3 @@
 module ShopifyApp
-  VERSION = '6.2.0'
+  VERSION = '6.2.1'
 end

data/test/generators/install_generator_test.rb

@@ -17,7 +17,7 @@ class InstallGeneratorTest < Rails::Generators::TestCase
     assert_file "config/initializers/shopify_app.rb" do |shopify_app|
       assert_match 'config.api_key = "<api_key>"', shopify_app
       assert_match 'config.secret = "<secret>"', shopify_app
-      assert_match 'config.redirect_uri = "<redirect_uri>"', shopify_app
+      assert_match 'config.redirect_uri = "http://localhost:3000/auth/shopify/callback"', shopify_app
       assert_match 'config.scope = "read_orders, read_products"', shopify_app
       assert_match "config.embedded_app = true", shopify_app
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.2.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2015-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails