shopify_app 8.6.1 → 9.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2482fcdfb4e089d1dc4f846f5c9e2f59f5bfc1a731f6e44b4a62012b5f8f2281
-  data.tar.gz: 813a680edae0e083de4f29bb7e75622ccfaaf2fa913fbf89705306d6a9dc1bf5
+  metadata.gz: f969c97f90fa13571a9e8af4b509148c1bd90a2f3c417e48c7beaa5d42f783c0
+  data.tar.gz: a99fd49067d47fd6362c79eeb92f7c3c904ac52e14f5c7b59cf77e12ae3fb9b1
 SHA512:
-  metadata.gz: c20f5e2d266ecdb860bd2175b0ed4e3e6663110e518ab84d4b26fed44195a0dbb58c76bb129125fb6d3bf373efb4c78d8059db7f62953fabaab9124a2d64e95d
-  data.tar.gz: c2a2b9f8f2a27765f8878da4879222b4cf03a5eed99bee67c6a29c31e27da006e3d6226df4cf58de1eab1721f701d2e22c402cd28882cb22e50730f87f421f67
+  metadata.gz: 825cddcd43bb04d549a3ec295452283f55cccfda4d2608bb45f66c28548843af8c527a00ef2c49b1f9d44696634d669a6684909899f2012b0ed0e637a0559b9e
+  data.tar.gz: 8d4e54cef864888f554c64955feda1d03e9bfba3c2a237bbdb27f7a8364e12e4a3b2f49dfefa402b1799f5886539ca770aada0857e89a46c7098ab31ac3ee5d2

data/.travis.yml

@@ -15,9 +15,9 @@ cache:
   yarn: true
 
 rvm:
-  - 2.3.6
   - 2.4.3
   - 2.5.0
+  - 2.6.2
 
 install:
   - bundle install

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+9.0.0
+-----
+
+* Breaking change: Api version support added see [migration guide](README.md#upgrading-from-86-to-900)
+
 8.6.1
 -----
 

data/README.md

@@ -34,6 +34,7 @@ Table of Contents
 * [**Authenticated**](#authenticated)
 * [**AppProxyVerification**](#appproxyverification)
  * [Recommended Usage](#recommended-usage)
+* [**Upgrading from 8.6 to 9.0.0**](#upgrading-from-86-to-900)
 * [**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)
@@ -395,7 +396,7 @@ ShopifyApp::SessionRepository
 
 `ShopifyApp::SessionRepository` allows you as a developer to define how your sessions are retrieved and stored for shops. The `SessionRepository` is configured in the `config/initializers/shopify_app.rb` file and can be set to any object that implements `self.store(shopify_session)` which stores the session and returns a unique identifier and `self.retrieve(id)` which returns a `ShopifyAPI::Session` for the passed id. See either the `ShopifyApp::InMemorySessionStore` class or the `ShopifyApp::SessionStorage` concern for examples.
 
-If you only run the install generator then by default you will have an in memory store but it **won't work** on multi-server environments including Heroku. If you ran all the generators including the shop_model generator then the `Shop` model itself will be the `SessionRepository`. If you look at the implementation of the generated shop model you'll see that this gem provides a concern for the `SessionRepository`. You can use this concern on any model that responds to `shopify_domain` and `shopify_token`.
+If you only run the install generator then by default you will have an in memory store but it **won't work** on multi-server environments including Heroku. If you ran all the generators including the shop_model generator then the `Shop` model itself will be the `SessionRepository`. If you look at the implementation of the generated shop model you'll see that this gem provides a concern for the `SessionRepository`. You can use this concern on any model that responds to `shopify_domain`, `shopify_token` and `api_version`.
 
 Authenticated
 -------------
@@ -444,3 +445,57 @@ Questions or problems?
 
 - [Ask questions!](https://ecommerce.shopify.com/c/shopify-apis-and-technology)
 - [Read the docs!](https://help.shopify.com/api/guides)
+
+
+Upgrading from 8.6 to 9.0.0
+---------------------------
+
+### Configuration change
+
+Add an api version configuration in `config/initializers/shopify_app.rb`
+Set this to the version you want to run against by default see [url] for what versions are currently availabe
+```ruby
+config.api_version = '2019-04'
+```
+
+### Session storage change
+
+You will need to add an `api_version` method to you session storage object.  The default implmentation for this is.
+```ruby
+def api_version
+  ShopifyApp.configuration.api_version
+end
+```
+
+### Generated file change
+
+`embedded_app.html.erb` the useage of `shop_session.url` needs to be changed to `shop_session.domain`
+```erb
+<script type="text/javascript">
+  ShopifyApp.init({
+    apiKey: "<%= ShopifyApp.configuration.api_key %>",
+
+    shopOrigin: "<%= "https://#{ @shop_session.url }" if @shop_session %>",
+
+    debug: false,
+    forceRedirect: true
+  });
+</script>
+```
+is changed to
+```erb
+<script type="text/javascript">
+  ShopifyApp.init({
+    apiKey: "<%= ShopifyApp.configuration.api_key %>",
+
+    shopOrigin: "<%= "https://#{ @shop_session.domain }" if @shop_session %>",
+
+    debug: false,
+    forceRedirect: true
+  });
+</script>
+```
+
+### ShopifyAPI changes
+
+You will need to also follow the ShopifyAPI [upgrade guide](https://github.com/shopify/shopify_api/README.md#-breaking-change-notice-for-version-700-) to ensure your app is ready to work with api versioning.

data/app/controllers/shopify_app/callback_controller.rb

@@ -50,7 +50,11 @@ module ShopifyApp
     end
 
     def set_shopify_session
-      session_store = ShopifyAPI::Session.new(shop_name, token)
+      session_store = ShopifyAPI::Session.new(
+        domain: shop_name,
+        token: token,
+        api_version: ShopifyApp.configuration.api_version
+      )
 
       session[:shopify] = ShopifyApp::SessionRepository.store(session_store)
       session[:shopify_domain] = shop_name

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

@@ -14,6 +14,6 @@ Your Shop Details:
 	Shop URL 			: {{ shop.url }}
 	Shop Currency 			: {{ shop.currency }}
 	No. of products in this shop 	: {{ shop.products_count }}
-<br>	
-<hr>	
+<br>
+<hr>
 </pre>

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

@@ -2,7 +2,7 @@
 
 <ul>
   <% @products.each do |product| %>
-    <li><%= link_to product.title, "https://#{@shop_session.url}/admin/products/#{product.id}", target: "_top" %></li>
+    <li><%= link_to product.title, "https://#{@shop_session.domain}/admin/products/#{product.id}", target: "_top" %></li>
   <% end %>
 </ul>
 

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

@@ -12,6 +12,7 @@ module ShopifyApp
       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 create_shopify_app_initializer
         @application_name = format_array_argument(options['application_name'])
@@ -19,6 +20,7 @@ module ShopifyApp
         @secret = options['secret']
         @old_secret = options['old_secret']
         @scope = format_array_argument(options['scope'])
+        @api_version = options['api_version']
 
         template 'shopify_app.rb', 'config/initializers/shopify_app.rb'
       end

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

@@ -25,7 +25,7 @@
     <script type="text/javascript">
       ShopifyApp.init({
         apiKey: "<%= ShopifyApp.configuration.api_key %>",
-        shopOrigin: "<%= "https://#{ @shop_session.url }" if @shop_session %>",
+        shopOrigin: "<%= "https://#{ @shop_session.domain }" if @shop_session %>",
         debug: <%= Rails.env.development? ? 'true' : 'false' %>,
         forceRedirect: true
       });

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

@@ -7,5 +7,6 @@ ShopifyApp.configure do |config|
                                  # https://help.shopify.com/en/api/getting-started/authentication/oauth/scopes
   config.embedded_app = <%= embedded_app? %>
   config.after_authenticate_job = false
+  config.api_version = "<%= @api_version %>"
   config.session_repository = ShopifyApp::InMemorySessionStore
 end

data/lib/generators/shopify_app/shop_model/templates/shop.rb

@@ -1,3 +1,7 @@
 class Shop < ActiveRecord::Base
   include ShopifyApp::SessionStorage
+
+  def api_version
+    ShopifyApp.configuration.api_version
+  end
 end

data/lib/shopify_app/configuration.rb

@@ -15,6 +15,7 @@ module ShopifyApp
     attr_accessor :scripttags
     attr_accessor :after_authenticate_job
     attr_accessor :session_repository
+    attr_accessor :api_version
 
     # customise urls
     attr_accessor :root_url

data/lib/shopify_app/controller_concerns/login_protection.rb

@@ -32,7 +32,7 @@ module ShopifyApp
     end
 
     def login_again_if_different_shop
-      if shop_session && params[:shop] && params[:shop].is_a?(String) && (shop_session.url != params[:shop])
+      if shop_session && params[:shop] && params[:shop].is_a?(String) && (shop_session.domain != params[:shop])
         clear_shop_session
         redirect_to_login
       end

data/lib/shopify_app/jobs/scripttags_manager_job.rb

@@ -6,7 +6,8 @@ module ShopifyApp
     end
 
     def perform(shop_domain:, shop_token:, scripttags:)
-      ShopifyAPI::Session.temp(shop_domain, shop_token) do
+      api_version = ShopifyApp.configuration.api_version
+      ShopifyAPI::Session.temp(domain: shop_domain, token: shop_token, api_version: api_version) do
         manager = ScripttagsManager.new(scripttags, shop_domain)
         manager.create_scripttags
       end

data/lib/shopify_app/jobs/webhooks_manager_job.rb

@@ -6,7 +6,8 @@ module ShopifyApp
     end
 
     def perform(shop_domain:, shop_token:, webhooks:)
-      ShopifyAPI::Session.temp(shop_domain, shop_token) do
+      api_version = ShopifyApp.configuration.api_version
+      ShopifyAPI::Session.temp(domain: shop_domain, token: shop_token, api_version: api_version) do
         manager = WebhooksManager.new(webhooks)
         manager.create_webhooks
       end

data/lib/shopify_app/session/session_storage.rb

@@ -5,15 +5,21 @@ module ShopifyApp
     included do
       validates :shopify_domain, presence: true, uniqueness: { case_sensitive: false }
       validates :shopify_token, presence: true
+      validates :api_version, presence: true
     end
 
     def with_shopify_session(&block)
-      ShopifyAPI::Session.temp(shopify_domain, shopify_token, &block)
+      ShopifyAPI::Session.temp(
+        domain: shopify_domain,
+        token: shopify_token,
+        api_version: api_version,
+        &block
+      )
     end
 
     class_methods do
       def store(session)
-        shop = self.find_or_initialize_by(shopify_domain: session.url)
+        shop = find_or_initialize_by(shopify_domain: session.domain)
         shop.shopify_token = session.token
         shop.save!
         shop.id
@@ -23,10 +29,13 @@ module ShopifyApp
         return unless id
 
         if shop = self.find_by(id: id)
-          ShopifyAPI::Session.new(shop.shopify_domain, shop.shopify_token)
+          ShopifyAPI::Session.new(
+            domain: shop.shopify_domain,
+            token: shop.shopify_token,
+            api_version: shop.api_version
+          )
         end
       end
     end
-
   end
 end

data/lib/shopify_app/version.rb

@@ -1,3 +1,3 @@
 module ShopifyApp
-  VERSION = '8.6.1'.freeze
+  VERSION = '9.0.0'.freeze
 end

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shopify_app",
-  "version": "8.6.1",
+  "version": "9.0.0",
   "repository": "git@github.com:Shopify/shopify_app.git",
   "author": "Shopify",
   "license": "MIT",

data/shopify_app.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency('browser_sniffer', '~> 1.1.0')
   s.add_runtime_dependency('rails', '>= 5.0.0')
-  s.add_runtime_dependency('shopify_api', '>= 4.3.5', '< 7.0.0')
+  s.add_runtime_dependency('shopify_api', '>= 7.0.0')
   s.add_runtime_dependency('omniauth-shopify-oauth2', '~> 2.1.0')
 
   s.add_development_dependency('rake')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 8.6.1
+  version: 9.0.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-08 00:00:00.000000000 Z
+date: 2019-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: browser_sniffer
@@ -43,9 +43,6 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.3.5
-    - - "<"
       - !ruby/object:Gem::Version
         version: 7.0.0
   type: :runtime
@@ -53,9 +50,6 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: 4.3.5
-    - - "<"
       - !ruby/object:Gem::Version
         version: 7.0.0
 - !ruby/object:Gem::Dependency