shopify_app 4.4.6 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d016076a4a542e4eaa1c2ceae28cbe7e1790bd42
-  data.tar.gz: 2842f923938f4849ad339f03523324c19553ac0e
+  metadata.gz: 5c13d2dc552acb4d83345cfa79458bacf0e7c289
+  data.tar.gz: 37d1d7d575a20c3e6ec31a74c5218890c16bcb6e
 SHA512:
-  metadata.gz: 0581d9b17e081a8ad0606f659e87eabe08b46bb94a0ef41a493198545be521b1faf38fe48a701f74a3be5336ca695d0e74f99a3d46e890c6e8cc836ee1238edf
-  data.tar.gz: e1a8be720c1550592197518593f386fce7f9ec7b5666df00627a950a2b194da683793198d24aa323535122c30228607451bbeb4f78cfe3dd5480eb7b7c9f825d
+  metadata.gz: 435f36ef8b451587c3b44ee238ef62cac08beccb1123159d9290618f9011ccb5e8b423d11417eab6a1f84dbc5621615cd3845e82a898d505e6d945c35a3b2fb4
+  data.tar.gz: 32f20ae9da3e54e4241eeccb5bbe52c63cc3454911749630e72fe8ba89c4415b81ff731bc040f941175b85f70c4d45436626f368df315e2a8c7688e97d9dd01f

data/README.md

@@ -1,5 +1,7 @@
 # Shopify App
 
+[![Build Status](https://travis-ci.org/Shopify/shopify_app.png)](https://travis-ci.org/Shopify/shopify_app)
+
 Shopify application generator for Rails 3.1 and Rails 4.0
 
 ## Description
@@ -72,6 +74,42 @@ common:
   secret: your secret
 ```
 
+## Set up your ShopifySessionRepository.store
+
+`ShopifySessionRepository` allows you as a developer to define how your sessions are retrieved and
+stored for a shop. This can simply be your `Shop` model that stores the API Token and shop name. If
+you are using ActiveRecord, then all you need to implement is `self.store(shopify_session)` and
+`self.retrieve(id)` in order to store the record on disk or retrieve it for use at a later point.
+It is imperative that your store method returns the identifier for the session. Typically this is
+just the record ID.
+
+Your ActiveRecord model would look something like this:
+
+```ruby
+class Shop < ActiveRecord::Base
+  def self.store(session)
+    shop = Shop.new(domain: session.url, token: session.token)
+    shop.save!
+    shop.id
+  end
+
+  def retrieve(id)
+    shop = Shop.find(id)
+    ShopifyAPI::Session.new(shop.domain, shop.token)
+  end
+end
+```
+
+By default you will have an in memory store but it really won't work on multi-server environments since
+they won't be sharing the static data that would be required in case your user gets directed to a
+different server by your load balancer.
+
+The in memory store also does not behave well on Heroku because the session data would be destroyed
+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.
+
 ## 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/templates/app/controllers/sessions_controller.rb

@@ -10,7 +10,7 @@ class SessionsController < ApplicationController
   def show
     if response = request.env['omniauth.auth']
       sess = ShopifyAPI::Session.new(params[:shop], response['credentials']['token'])
-      session[:shopify] = sess        
+      session[:shopify] = ShopifySessionRepository.store(sess)
       flash[:notice] = "Logged in"
       redirect_to return_address
     else

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

@@ -0,0 +1,21 @@
+# You should replace InMemorySessionStore with what you will be using
+# in Production
+#
+# Interface to implement are self.retrieve(id) and self.store(ShopifyAPI::Session)
+#
+# Here is how you would add these functions to an ActiveRecord:
+#
+# class Shop < ActiveRecord::Base
+#   def self.store(session)
+#     shop = Shop.new(domain: session.url, token: session.token)
+#     shop.save!
+#     shop.id
+#   end
+#
+#   def retrieve(id)
+#     shop = Shop.find(id)
+#     ShopifyAPI::Session.new(shop.domain, shop.token)
+#   end
+# end
+
+ShopifySessionRepository.storage = InMemorySessionStore

data/lib/shopify_app.rb

@@ -12,6 +12,8 @@ module ShopifyApp
   end
 end
 
+require 'shopify_app/shopify_session_repository'
+require 'shopify_app/in_memory_session_store'
 require 'shopify_app/login_protection'
 require 'shopify_app/configuration'
 require 'shopify_app/railtie'

data/lib/shopify_app/in_memory_session_store.rb

@@ -0,0 +1,25 @@
+# WARNING - This really only works for development, see README for more details
+class InMemorySessionStore
+  class EnvironmentError < StandardError; end
+
+  def self.retrieve(id)
+    repo[id]
+  end
+
+  def self.store(session)
+    id = SecureRandom.uuid
+    repo[id] = session
+    id
+  end
+
+  def self.clear
+    @@repo = nil
+  end
+
+  def self.repo
+    if Rails.env.production?
+      raise EnvironmentError.new("Cannot use InMemorySessionStore in a Production environment")
+    end
+    @@repo ||= {}
+  end
+end

data/lib/shopify_app/login_protection.rb

@@ -6,10 +6,10 @@ module ShopifyApp::LoginProtection
   end
   
   def shopify_session
-    if session[:shopify]
+    if shop_session
       begin
         # session[:shopify] set in LoginController#show
-        ShopifyAPI::Base.activate_session(session[:shopify])
+        ShopifyAPI::Base.activate_session(shop_session)
         yield
       ensure 
         ShopifyAPI::Base.clear_session
@@ -21,7 +21,7 @@ module ShopifyApp::LoginProtection
   end
   
   def shop_session
-    session[:shopify]
+    ShopifySessionRepository.retrieve(session[:shopify])
   end
 
   def login_again_if_different_shop

data/lib/shopify_app/shopify_session_repository.rb

@@ -0,0 +1,22 @@
+class ShopifySessionRepository
+  class ConfigurationError < StandardError; end
+
+  def self.storage=(storage)
+    @@storage = storage
+  end
+
+  def self.retrieve(id)
+    validate
+    @@storage.retrieve(id)
+  end
+
+  def self.store(session)
+    validate
+    @@storage.store(session)
+  end
+
+  def self.validate
+    raise ConfigurationError.new("ShopifySessionRepository.store is not configured!") unless @@storage
+  end
+
+end

data/lib/shopify_app/version.rb

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

data/test/lib/shopify_app/configuration_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class ConfigurationTest < MiniTest::Unit::TestCase
+class ConfigurationTest < Minitest::Test
   def setup
     Rails.stubs(:env).returns('development')
     Rails.stubs(:root).returns(File.expand_path('../..', File.dirname(__FILE__)))

data/test/lib/shopify_app/in_memory_session_store_test.rb

@@ -0,0 +1,35 @@
+require 'test_helper'
+
+class InMemorySessionStoreTest < Minitest::Test
+  def teardown
+    InMemorySessionStore.clear
+  end
+
+  def test_storing_a_session
+    uuid = InMemorySessionStore.store('something')
+    assert_equal 'something', InMemorySessionStore.repo[uuid]
+  end
+
+  def test_retrieving_a_session
+    InMemorySessionStore.repo['abra'] = 'something'
+    assert_equal 'something', InMemorySessionStore.retrieve('abra')
+  end
+
+  def test_clearing_the_store
+    uuid = InMemorySessionStore.store('data')
+    assert_equal 'data', InMemorySessionStore.retrieve(uuid)
+    InMemorySessionStore.clear
+    assert !InMemorySessionStore.retrieve(uuid), 'The sessions should have been removed'
+  end
+
+  def test_it_should_raise_when_the_environment_is_not_valid
+    Rails.env.stubs(:production?).returns(true)
+    assert_raises InMemorySessionStore::EnvironmentError do
+      InMemorySessionStore.store('data')
+    end
+
+    assert_raises InMemorySessionStore::EnvironmentError do
+      InMemorySessionStore.retrieve('abracadabra')
+    end
+  end
+end

data/test/lib/shopify_app/shopify_session_repository_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class TestSessionStore
+  attr_reader :storage
+  def initialize
+    @storage = []
+  end
+
+  def retrieve(id)
+    storage[id]
+  end
+
+  def store(session)
+    id = storage.length
+    storage[id] = session
+    id
+  end
+end
+
+class ShopifySessionRepositoryTest < Minitest::Test
+  attr_reader :session_store, :session
+  def setup
+    @session_store = TestSessionStore.new
+    @session = ShopifyAPI::Session.new('shop.myshopify.com', 'abracadabra')
+    ShopifySessionRepository.storage = session_store
+  end
+
+  def teardown
+    ShopifySessionRepository.storage = nil
+  end
+
+  def test_adding_a_session_to_the_repository
+    assert_equal 0, ShopifySessionRepository.store(session)
+    assert_equal session, session_store.retrieve(0)
+  end
+
+  def test_retrieving_a_session_from_the_repository
+    session_store.storage[9] = session
+    assert_equal session, ShopifySessionRepository.retrieve(9)
+  end
+
+  def test_retrieving_a_session_for_an_id_that_does_not_exist
+    ShopifySessionRepository.store(session)
+    assert !ShopifySessionRepository.retrieve(100), "The session with id 100 should not exist in the Repository"
+  end
+
+  def test_retrieving_a_session_for_a_misconfigured_shops_repository
+    ShopifySessionRepository.storage = nil
+    assert_raises ShopifySessionRepository::ConfigurationError do
+      ShopifySessionRepository.retrieve(0)
+    end
+
+    assert_raises ShopifySessionRepository::ConfigurationError do
+      ShopifySessionRepository.store(session)
+    end
+  end
+end

data/test/test_helper.rb

@@ -2,4 +2,4 @@ require 'minitest/autorun'
 require 'minitest/pride'
 require 'mocha/setup'
 
-require File.expand_path('../../lib/shopify_app.rb', __FILE__)
+require File.expand_path('../../lib/shopify_app.rb', __FILE__)

metadata

@@ -1,139 +1,117 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 4.4.6
+  version: 5.0.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
-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-05-27 00:00:00.000000000 Z
+cert_chain: []
+date: 2014-06-09 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
@@ -146,7 +124,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - CHANGELOG
 - Gemfile
 - LICENSE
@@ -180,6 +158,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/shopify_session_repository.rb
 - lib/generators/shopify_app/templates/public/404.html
 - lib/generators/shopify_app/templates/public/422.html
 - lib/generators/shopify_app/templates/public/500.html
@@ -189,8 +168,10 @@ files:
 - lib/generators/shopify_app/templates/public/shopify-72.png
 - lib/shopify_app.rb
 - lib/shopify_app/configuration.rb
+- lib/shopify_app/in_memory_session_store.rb
 - lib/shopify_app/login_protection.rb
 - lib/shopify_app/railtie.rb
+- lib/shopify_app/shopify_session_repository.rb
 - lib/shopify_app/version.rb
 - shipit.rubygems.yml
 - shopify_app.gemspec
@@ -199,6 +180,8 @@ files:
 - 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
 homepage: http://www.shopify.com/developers
 licenses: []
@@ -209,18 +192,26 @@ 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: []
 rubyforge_project: shopify-api
-rubygems_version: 2.2.0
+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_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