shopify_app 5.0.0 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5c13d2dc552acb4d83345cfa79458bacf0e7c289
-  data.tar.gz: 37d1d7d575a20c3e6ec31a74c5218890c16bcb6e
+  metadata.gz: 6b63a99a31c373bfa53cba58497efffb6dcd68cd
+  data.tar.gz: 13a5639e78cc51a29c668f5fb15ebf9e48fa1c92
 SHA512:
-  metadata.gz: 435f36ef8b451587c3b44ee238ef62cac08beccb1123159d9290618f9011ccb5e8b423d11417eab6a1f84dbc5621615cd3845e82a898d505e6d945c35a3b2fb4
-  data.tar.gz: 32f20ae9da3e54e4241eeccb5bbe52c63cc3454911749630e72fe8ba89c4415b81ff731bc040f941175b85f70c4d45436626f368df315e2a8c7688e97d9dd01f
+  metadata.gz: b200f8785a3b3a1ec14a0f295339b812ab86dd968307ac6cd1cf1982e38ea82830b24cda724f55708e95d6662375c7669aaa80a68793dc78b3211c353b4fc796
+  data.tar.gz: 7403b965254769f35af83b07a74602b7ea7ce7483f8f9d1aaf183dc7f1919af370e86e8e355dee4918a0e12efe8c7a562e80e9571dda2a33cd70de63c827b9b5

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in shopify_app.gemspec
 gemspec

data/README.md

@@ -34,7 +34,7 @@ If you don't have an API key yet, create a Shopify Partner account at http://sho
 
 When you create your app in the Shopify Partner Account, set the Application Callback URL to
 
-	http://localhost:3000
+	http://localhost:3000/login
 
 You can also create a private application that only works for your shop by visiting https://YOUR-SHOP.myshopify.com/admin/apps/private.
 
@@ -93,9 +93,10 @@ class Shop < ActiveRecord::Base
     shop.id
   end
 
-  def retrieve(id)
-    shop = Shop.find(id)
-    ShopifyAPI::Session.new(shop.domain, shop.token)
+  def self.retrieve(id)
+    if shop = Shop.where(id: id).first
+      ShopifyAPI::Session.new(shop.domain, shop.token)
+    end
   end
 end
 ```
@@ -110,6 +111,10 @@ when a dyno is killed due to inactivity.
 Changing the `ShopifySessionRepository.storage` can simply be done by editing
 `config/initializers/shopify_session_repository.rb` to use the correct model.
 
+```ruby
+ShopifySessionRepository.storage = 'Shop'
+```
+
 ## Set your required API permissions
 
 Before making API requests, your application must state which API permissions it requires from the shop it's installed in. These requested permissions will be listed on the screen the merchant sees when approving your app to be installed in their shop.

data/lib/generators/shopify_app/shopify_app_generator.rb

@@ -3,28 +3,28 @@ require 'rails/generators'
 class ShopifyAppGenerator < Rails::Generators::Base
   argument :api_key, :type => :string, :required => false
   argument :secret, :type => :string, :required => false
-  
+
   class_option :skip_routes, :type => :boolean, :default => false, :desc => 'pass true to skip route generation'
-  
+
   def self.source_root
     File.join(File.dirname(__FILE__), 'templates')
   end
-  
+
   def copy_files
     directory 'app'
     directory 'public'
     directory 'config'
   end
-  
+
   def remove_static_index
     remove_file 'public/index.html'
   end
-  
+
   def add_config_variables
     return if api_key.blank? || secret.blank?
-    
+
     inject_into_file 'config/application.rb', <<-DATA, :after => "class Application < Rails::Application\n"
-    
+
     # Shopify API connection credentials:
     config.shopify.api_key = '#{api_key}'
     config.shopify.secret = '#{secret}'
@@ -37,7 +37,7 @@ class ShopifyAppGenerator < Rails::Generators::Base
       gem 'therubyracer', :platforms => :ruby
     end
   end
-  
+
   def add_routes
     unless options[:skip_routes]
       route_without_newline "root :to => 'home#index'"
@@ -51,7 +51,7 @@ class ShopifyAppGenerator < Rails::Generators::Base
       route_without_newline "get 'welcome' => 'home#welcome'"
     end
   end
-  
+
   def display_readme
     Bundler.with_clean_env do
       run 'bundle install'
@@ -59,11 +59,11 @@ class ShopifyAppGenerator < Rails::Generators::Base
 
     readme '../README'
   end
-  
+
   private
-  
+
   def route_without_newline(routing_code)
     sentinel = /\.routes\.draw do(?:\s*\|map\|)?\s*$/
     inject_into_file 'config/routes.rb', "\n  #{routing_code}", { after: sentinel, verbose: false }
-  end  
+  end
 end

data/lib/generators/shopify_app/templates/app/views/home/index.html.erb

@@ -28,7 +28,7 @@
     
     <ul>
       <li>
-        <%= link_to 'API documentation', 'http://www.shopify.com/developers/api/' %>
+        <%= link_to 'API documentation', 'http://docs.shopify.com/api' %>
         <span class="note">Learn what you can do with the Shopify API</span>
       </li><br/>
       <li>
@@ -36,11 +36,11 @@
         <span class="note">Find out what you can do with Twitter Bootstrap</span>
       </li><br/>
       <li>
-        <%= link_to 'Wiki', 'http://wiki.shopify.com/' %>
+        <%= link_to 'Wiki', 'http://docs.shopify.com/' %>
         <span class="note">Get more information and share your knowledge</span>
       </li><br/>
       <li>
-        <%= link_to 'Forum', 'http://forums.shopify.com/community' %>
+        <%= link_to 'Forum', 'https://ecommerce.shopify.com/forums' %>
         <span class="note">Ask questions and see what others already wanted to know</span>
       </li>
     </ul>
@@ -49,11 +49,11 @@
   
     <h3>Once you're ready</h3>
   
-    <p>We'd love to see what you create using the Shopify API. You can keep up to date on the latest and greatest via the <%= link_to 'Shopify API Twitter Account', 'http://www.twitter.com/shopifyapi' %>. You can also read the latest information on the <%= link_to 'API Publishing Page', 'http://www.shopify.com/developers/publishing/' %>.</p>
+    <p>We'd love to see what you create using the Shopify API. You can keep up to date on the latest and greatest via the <%= link_to 'Shopify Developers Twitter Account', 'https://twitter.com/shopifydevs' %>. You can also read the latest information on the <%= link_to 'Building a Shopify App', 'http://docs.shopify.com/partners/partner-resources/for-partners/building-a-shopify-app' %>.</p>
     
     <br/>
     
-    <a href="https://twitter.com/shopifyapi" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @shopifyapi</a>
+    <a href="https://twitter.com/shopifydevs" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @ShopifyDevs</a>
     <script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0];if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src="//platform.twitter.com/widgets.js";fjs.parentNode.insertBefore(js,fjs);}}(document,"script","twitter-wjs");</script>
   </div> <!-- span3 / left-column -->
 
@@ -165,4 +165,4 @@
       
     </div> <!-- accordion -->
   </div> <!-- span8 / right-column -->
-</div>
+</div>

data/lib/generators/shopify_app/templates/app/views/home/welcome.html.erb

@@ -90,15 +90,15 @@ The callback URL of your app can be changed in the API screen of your Shopify ad
 <ul>
   <li>
     <%= link_to 'API documentation', 'http://www.shopify.com/developers/api' %>
-    <span class="hint">(An overview of what you can do with the Shopify API.)
+    <span class="hint">(An overview of what you can do with the Shopify API.)</span>
   </li>
   <li>
     <%= link_to 'Wiki (needs its own API section)', 'http://wiki.shopify.com/' %>
-    <span class="hint">(Get more information and share your knowledge.)
+    <span class="hint">(Get more information and share your knowledge.)</span>
   </li>
   <li>
     <%= link_to 'Forum (needs its own API section)', 'http://forums.shopify.com/community' %>
-    <span class="hint">(Ask questions and see what others already wanted to know.)
+    <span class="hint">(Ask questions and see what others already wanted to know.)</span>
   </li>
 </ul>
 

data/lib/generators/shopify_app/templates/config/initializers/rails_4_shim.rb

@@ -0,0 +1 @@
+Rails.application.config.assets.precompile += %w( twitter/bootstrap/* )

data/lib/generators/shopify_app/templates/config/initializers/shopify_session_repository.rb

@@ -12,9 +12,10 @@
 #     shop.id
 #   end
 #
-#   def retrieve(id)
-#     shop = Shop.find(id)
-#     ShopifyAPI::Session.new(shop.domain, shop.token)
+#   def self.retrieve(id)
+#     if shop = Shop.where(id: id).first
+#       ShopifyAPI::Session.new(shop.domain, shop.token)
+#     end
 #   end
 # end
 

data/lib/shopify_app/login_protection.rb

@@ -1,37 +1,42 @@
 module ShopifyApp::LoginProtection
   extend ActiveSupport::Concern
-  
+
   included do
     rescue_from ActiveResource::UnauthorizedAccess, :with => :close_session
   end
-  
+
   def shopify_session
     if shop_session
       begin
         # session[:shopify] set in LoginController#show
         ShopifyAPI::Base.activate_session(shop_session)
         yield
-      ensure 
+      ensure
         ShopifyAPI::Base.clear_session
       end
     else
-      session[:return_to] = request.fullpath if request.get?
-      redirect_to login_path(shop: params[:shop])
+      redirect_to_login
     end
   end
-  
+
   def shop_session
-    ShopifySessionRepository.retrieve(session[:shopify])
+    return unless session[:shopify]
+    @shop_session ||= ShopifySessionRepository.retrieve(session[:shopify])
   end
 
   def login_again_if_different_shop
     if shop_session && params[:shop] && params[:shop].is_a?(String) && shop_session.url != params[:shop]
-      redirect_to login_path(shop: params[:shop]) 
-    end  
+      redirect_to_login
+    end
   end
-  
+
   protected
-  
+
+  def redirect_to_login
+    session[:return_to] = request.fullpath if request.get?
+    redirect_to login_path(shop: params[:shop])
+  end
+
   def close_session
     session[:shopify] = nil
     redirect_to login_path

data/lib/shopify_app/shopify_session_repository.rb

@@ -1,22 +1,32 @@
 class ShopifySessionRepository
   class ConfigurationError < StandardError; end
 
-  def self.storage=(storage)
-    @@storage = storage
-  end
+  class << self
+    def storage=(storage)
+      @storage = storage
 
-  def self.retrieve(id)
-    validate
-    @@storage.retrieve(id)
-  end
+      unless storage.nil? || self.storage.respond_to?(:store) && self.storage.respond_to?(:retrieve)
+        raise ArgumentError, "storage must respond to :store and :retrieve"
+      end
+    end
 
-  def self.store(session)
-    validate
-    @@storage.store(session)
-  end
+    def retrieve(id)
+      storage.retrieve(id)
+    end
 
-  def self.validate
-    raise ConfigurationError.new("ShopifySessionRepository.store is not configured!") unless @@storage
-  end
+    def store(session)
+      storage.store(session)
+    end
 
+    def storage
+      load_storage || raise(ConfigurationError.new("ShopifySessionRepository.storage is not configured!"))
+    end
+
+    private
+
+    def load_storage
+      return unless @storage
+      @storage.respond_to?(:safe_constantize) ? @storage.safe_constantize : @storage
+    end
+  end
 end

data/lib/shopify_app/version.rb

@@ -1,3 +1,3 @@
 module ShopifyApp
-  VERSION = "5.0.0"
+  VERSION = "5.0.1"
 end

data/test/lib/shopify_app/login_protection_test.rb

@@ -0,0 +1,55 @@
+require 'test_helper'
+require 'action_controller'
+
+class LoginProtectionController < ActionController::Base
+  include ShopifyApp::LoginProtection
+  helper_method :shop_session
+
+  def index
+    render nothing: true
+  end
+end
+
+class LoginProtectionTest < ActionController::TestCase
+  tests LoginProtectionController
+
+  def setup
+    ShopifySessionRepository.storage = InMemorySessionStore
+  end
+
+  def test_calling_shop_session_returns_nil_when_session_is_nil
+    with_application_test_routes do
+      session[:shopify] = nil
+      get :index
+      assert_nil @controller.shop_session
+    end
+  end
+
+  def test_calling_shop_session_retreives_session_from_storage
+    with_application_test_routes do
+      session[:shopify] = "foobar"
+      get :index
+      ShopifySessionRepository.expects(:retrieve).returns(session).once
+      assert @controller.shop_session
+    end
+  end
+
+  def test_shop_session_is_memoized_and_does_not_retreive_session_twice
+    with_application_test_routes do
+      session[:shopify] = "foobar"
+      get :index
+      ShopifySessionRepository.expects(:retrieve).returns(session).once
+      assert @controller.shop_session
+      assert @controller.shop_session
+    end
+  end
+
+  def with_application_test_routes
+    with_routing do |set|
+      set.draw do
+        get '/' => 'login_protection#index'
+      end
+      yield
+    end
+  end
+end

data/test/lib/shopify_app/shopify_session_repository_test.rb

@@ -17,6 +17,14 @@ class TestSessionStore
   end
 end
 
+class TestSessionStoreClass
+  def self.store(session)
+  end
+
+  def self.retrieve(id)
+  end
+end
+
 class ShopifySessionRepositoryTest < Minitest::Test
   attr_reader :session_store, :session
   def setup
@@ -54,4 +62,9 @@ class ShopifySessionRepositoryTest < Minitest::Test
       ShopifySessionRepository.store(session)
     end
   end
+
+  def test_accepts_a_string_and_constantizes_it
+    ShopifySessionRepository.storage = 'TestSessionStoreClass'
+    assert_equal TestSessionStoreClass, ShopifySessionRepository.storage
+  end
 end

metadata

@@ -1,117 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 5.0.0
+  version: 5.0.1
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
-cert_chain: []
-date: 2014-06-09 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDcDCCAligAwIBAgIBATANBgkqhkiG9w0BAQUFADA/MQ8wDQYDVQQDDAZhZG1p
+  bnMxFzAVBgoJkiaJk/IsZAEZFgdzaG9waWZ5MRMwEQYKCZImiZPyLGQBGRYDY29t
+  MB4XDTE0MDUxNTIwMzM0OFoXDTE1MDUxNTIwMzM0OFowPzEPMA0GA1UEAwwGYWRt
+  aW5zMRcwFQYKCZImiZPyLGQBGRYHc2hvcGlmeTETMBEGCgmSJomT8ixkARkWA2Nv
+  bTCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAL0/81O3e1vh5smcwp2G
+  MpLQ6q0kejQLa65bPYPxdzWA1SYOKyGfw+yR9LdFzsuKpwWzKq6zX35lj1IckWS4
+  bNBEQzxmufUxU0XPM02haFB8fOfDJzdXsWte9Ge4IFwahwn68gpMqN+BvxL+KMYz
+  Iut9YmN44d4LZdsENEIO5vmybuG2vYDz7R56qB0PA+Q2P2CdhymsBad2DQs69FBo
+  uico9V6VMYYctL9lCYdzu9IXrOYNTt88suKIVzzAlHOKeN0Ng5qdztFoTR8sfxDr
+  Ydg3KHl5n47wlpgd8R0f/4b5gGxW+v9pyJCgQnLlRu7DedVSvv7+GMtj3g9r3nhJ
+  KqECAwEAAaN3MHUwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0OBBYEFI/o
+  maf34HXbUOQsdoLHacEKQgunMB0GA1UdEQQWMBSBEmFkbWluc0BzaG9waWZ5LmNv
+  bTAdBgNVHRIEFjAUgRJhZG1pbnNAc2hvcGlmeS5jb20wDQYJKoZIhvcNAQEFBQAD
+  ggEBADkK9aj5T0HPExsov4EoMWFnO+G7RQ28C30VAfKxnL2UxG6i4XMHVs6Xi94h
+  qXFw1ec9Y2eDUqaolT3bviOk9BB197+A8Vz/k7MC6ci2NE+yDDB7HAC8zU6LAx8Y
+  Iqvw7B/PSZ/pz4bUVFlTATif4mi1vO3lidRkdHRtM7UePSn2rUpOi0gtXBP3bLu5
+  YjHJN7wx5cugMEyroKITG5gL0Nxtu21qtOlHX4Hc4KdE2JqzCPOsS4zsZGhgwhPs
+  fl3hbtVFTqbOlwL9vy1fudXcolIE/ZTcxQ+er07ZFZdKCXayR9PPs64heamfn0fp
+  TConQSX2BnZdhIEYW+cKzEC/bLc=
+  -----END CERTIFICATE-----
+date: 2014-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.1'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: shopify_api
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: omniauth-shopify-oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.1.4
 - !ruby/object:Gem::Dependency
   name: less-rails-bootstrap
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Creates a basic sessions controller for authenticating with your Shop
@@ -124,7 +146,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - CHANGELOG
 - Gemfile
 - LICENSE
@@ -158,6 +180,7 @@ files:
 - lib/generators/shopify_app/templates/app/views/layouts/application.html.erb
 - lib/generators/shopify_app/templates/app/views/sessions/new.html.erb
 - lib/generators/shopify_app/templates/config/initializers/omniauth.rb
+- lib/generators/shopify_app/templates/config/initializers/rails_4_shim.rb
 - lib/generators/shopify_app/templates/config/initializers/shopify_session_repository.rb
 - lib/generators/shopify_app/templates/public/404.html
 - lib/generators/shopify_app/templates/public/422.html
@@ -181,6 +204,7 @@ files:
 - test/config/shopify_app.yml
 - test/lib/shopify_app/configuration_test.rb
 - test/lib/shopify_app/in_memory_session_store_test.rb
+- test/lib/shopify_app/login_protection_test.rb
 - test/lib/shopify_app/shopify_session_repository_test.rb
 - test/test_helper.rb
 homepage: http://www.shopify.com/developers
@@ -192,12 +216,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -206,12 +230,4 @@ rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: This gem is used to get quickly started with the Shopify API
-test_files:
-- test/config/development_config_file.yml
-- test/config/empty_config_file.yml
-- test/config/other_config_file.yml
-- test/config/shopify_app.yml
-- test/lib/shopify_app/configuration_test.rb
-- test/lib/shopify_app/in_memory_session_store_test.rb
-- test/lib/shopify_app/shopify_session_repository_test.rb
-- test/test_helper.rb
+test_files: []