shopify_app 5.0.2 → 6.0.0

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+#
+default: &default
+  adapter: sqlite3
+  pool: 5
+  timeout: 5000
+
+development:
+  <<: *default
+  database: db/development.sqlite3
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: db/test.sqlite3
+
+production:
+  <<: *default
+  database: db/production.sqlite3

data/test/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/dummy/config/environments/test.rb

@@ -0,0 +1,42 @@
+Rails.application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static file server for tests with Cache-Control for performance.
+  config.serve_static_files   = true
+  config.static_cache_control = 'public, max-age=3600'
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Randomize the order test cases are executed.
+  config.active_support.test_order = :random
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+
+  # Raises error for missing translations
+  # config.action_view.raise_on_missing_translations = true
+end

data/test/dummy/config/initializers/shopify_app.rb

@@ -0,0 +1,6 @@
+ShopifyApp.configure do |config|
+  config.api_key = "key"
+  config.secret = "secret"
+  config.scope = 'read_orders, read_products'
+  config.embedded_app = true
+end

data/test/dummy/config/routes.rb

@@ -0,0 +1,10 @@
+Rails.application.routes.draw do
+  root to: 'home#index'
+
+  controller :sessions do
+    get 'login' => :new, :as => :login
+    post 'login' => :create, :as => :authenticate
+    get 'auth/shopify/callback' => :callback
+    get 'logout' => :destroy, :as => :logout
+  end
+end

data/test/dummy/config/secrets.yml

@@ -0,0 +1,17 @@
+# Be sure to restart your server when you modify this file.
+
+# Your secret key is used for verifying the integrity of signed cookies.
+# If you change this key, all old signed cookies will become invalid!
+
+# Make sure the secret is at least 30 characters and all random,
+# no regular words or you'll be exposed to dictionary attacks.
+# You can use `rake secret` to generate a secure secret key.
+
+# Make sure the secrets in this file are kept private
+# if you're sharing your code publicly.
+
+development:
+  secret_key_base: aa26a2ea3384f82ea5ae33b4d80fc49ea0cda260418cf65a9c54958d02c4eadfba56e9e26728ee6e339c7f00628f0451abd7f0b0b042f5695097ec8b86b4e135
+
+test:
+  secret_key_base: ed1af7104003edfc9f3f55ff6eaa0bc0c4a70c240128ca9c33d2f19d3ac326f63944b40488ef87118b53174601ce488e1ae6075f7f6e18e7968755c6d9decefb

data/test/generators/install_generator_test.rb

@@ -0,0 +1,103 @@
+require 'test_helper'
+require 'generators/shopify_app/install/install_generator'
+
+class InstallGeneratorTest < Rails::Generators::TestCase
+  tests ShopifyApp::Generators::InstallGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+
+  setup do
+    prepare_destination
+    provide_existing_application_file
+    provide_existing_routes_file
+    provide_existing_application_controller
+  end
+
+  test "creates the ShopifyApp initializer" do
+    run_generator
+    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.scope = "read_orders, read_products"', shopify_app
+      assert_match "config.embedded_app = true", shopify_app
+    end
+  end
+
+  test "creats and injects into omniauth initializer" do
+    run_generator
+    assert_file "config/initializers/omniauth.rb" do |omniauth|
+      assert_match "provider :shopify", omniauth
+    end
+  end
+
+  test "creates the default shopify_session_repository" do
+    run_generator
+    assert_file "config/initializers/shopify_session_repository.rb" do |file|
+      assert_match "ShopifyApp::SessionRepository.storage = InMemorySessionStore", file
+    end
+  end
+
+  test "adds the embedded app options to application.rb" do
+    run_generator
+    assert_file "config/application.rb" do |application|
+      assert_match "config.action_dispatch.default_headers.delete('X-Frame-Options')", application
+      assert_match "config.action_dispatch.default_headers['P3P'] = 'CP=\"Not used\"'", application
+    end
+  end
+
+  test "doesn't add embedd options if -embedded false" do
+    stub_embedded_false
+    run_generator
+    assert_file "config/application.rb" do |application|
+      refute_match "config.action_dispatch.default_headers.delete('X-Frame-Options')", application
+      refute_match "config.action_dispatch.default_headers['P3P'] = 'CP=\"Not used\"'", application
+    end
+  end
+
+  test "injects into application controller" do
+    run_generator
+    assert_file "app/controllers/application_controller.rb" do |controller|
+      assert_match "  include ShopifyApp::Controller\n", controller
+    end
+  end
+
+  test "creates the embedded_app layout" do
+    run_generator
+    assert_file "app/views/layouts/embedded_app.html.erb"
+  end
+
+  test "creates the home controller" do
+    run_generator
+    assert_file "app/controllers/home_controller.rb"
+  end
+
+  test "creates the home index view with embedded options" do
+    run_generator
+    assert_file "app/views/home/index.html.erb" do |index|
+      assert_match "ShopifyApp.ready", index
+    end
+  end
+
+  test "creates the home index view with embedded false" do
+    stub_embedded_false
+    run_generator
+    assert_file "app/views/home/index.html.erb" do |index|
+      refute_match "ShopifyApp.ready", index
+    end
+  end
+
+  test "adds home route to routes" do
+    run_generator
+    assert_file "config/routes.rb" do |routes|
+      assert_match "root :to => 'home#index'", routes
+    end
+  end
+
+  private
+
+  def stub_embedded_false
+    ShopifyApp::Generators::InstallGenerator.any_instance.stubs(:opts).returns(
+      {embedded: 'false'}
+    )
+  end
+
+end

data/test/generators/routes_generator_test.rb

@@ -0,0 +1,33 @@
+require 'test_helper'
+require 'generators/shopify_app/routes/routes_generator'
+
+class ControllerGeneratorTest < Rails::Generators::TestCase
+  tests ShopifyApp::Generators::RoutesGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+
+  setup do
+    prepare_destination
+    provide_existing_routes_file
+    provide_existing_initializer_file
+  end
+
+  test "copies ShopifyApp routes to the host application" do
+    run_generator
+
+    assert_file "config/routes.rb" do |routes|
+      assert_match "get 'login' => :new, :as => :login", routes
+      assert_match "post 'login' => :create, :as => :authenticate", routes
+      assert_match "get 'auth/shopify/callback' => :callback", routes
+      assert_match "get 'logout' => :destroy, :as => :logout", routes
+    end
+  end
+
+  test "adds routes false to ShopifyApp initializer" do
+    run_generator
+
+    assert_file "config/initializers/shopify_app.rb" do |initializer|
+      assert_match "config.routes = false", initializer
+    end
+  end
+
+end

data/test/generators/shop_model_generator_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+require 'generators/shopify_app/shop_model/shop_model_generator'
+
+class ShopModelGeneratorTest < Rails::Generators::TestCase
+  tests ShopifyApp::Generators::ShopModelGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+
+  test "create the shop model" do
+    run_generator
+    assert_file "app/models/shop.rb" do |shop|
+      assert_match "class Shop < ActiveRecord::Base", shop
+      assert_match "include ShopifyApp::Shop", shop
+    end
+  end
+
+  test "creates ShopModel migration" do
+    run_generator
+    assert_migration "db/migrate/create_shops.rb" do |migration|
+      assert_match "create_table :shops  do |t|", migration
+    end
+  end
+
+  test "adds the session_storage model" do
+    run_generator
+    assert_file "app/models/session_storage.rb" do |session_storage|
+      assert_match "class SessionStorage", session_storage
+      assert_match "def self.store(session)", session_storage
+      assert_match " def self.retrieve(id)", session_storage
+    end
+  end
+
+  test "adds the shopify_session_repository initializer" do
+    run_generator
+    assert_file "config/initializers/shopify_session_repository.rb" do |file|
+      assert_match "ShopifyApp::SessionRepository.storage = SessionStorage", file
+    end
+  end
+
+end

data/test/generators/shopify_app_generator.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+require 'generators/shopify_app/shopify_app_generator'
+
+class ViewsGeneratorTest < Rails::Generators::TestCase
+  tests ShopifyApp::Generators::ViewsGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+
+  test "copies ShopifyApp views to the host application" do
+    run_generator
+    assert_directory "app/views"
+    assert_file "app/views/sessions/new.html.erb"
+  end
+
+end

data/test/generators/views_generator_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+require 'generators/shopify_app/views/views_generator'
+
+class ViewsGeneratorTest < Rails::Generators::TestCase
+  tests ShopifyApp::Generators::ViewsGenerator
+  destination File.expand_path("../tmp", File.dirname(__FILE__))
+  setup :prepare_destination
+
+  test "copies ShopifyApp views to the host application" do
+    run_generator
+    assert_directory "app/views"
+    assert_file "app/views/sessions/new.html.erb"
+  end
+
+end

data/test/shopify_app/configuration_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class ConfigurationTest < ActiveSupport::TestCase
+
+  test "configure" do
+    ShopifyApp.configure do |config|
+      config.embedded_app = true
+    end
+
+    assert_equal true, ShopifyApp.configuration.embedded_app
+  end
+
+ test "routes enabled" do
+    assert_equal true, ShopifyApp.configuration.routes_enabled?
+  end
+
+end

data/test/{lib/shopify_app → shopify_app}/in_memory_session_store_test.rb

@@ -1,28 +1,28 @@
 require 'test_helper'
 
-class InMemorySessionStoreTest < Minitest::Test
-  def teardown
+class InMemorySessionStoreTest < ActiveSupport::TestCase
+  teardown do
     InMemorySessionStore.clear
   end
 
-  def test_storing_a_session
+  test "storing a session" do
     uuid = InMemorySessionStore.store('something')
     assert_equal 'something', InMemorySessionStore.repo[uuid]
   end
 
-  def test_retrieving_a_session
+  test "retrieving a session" do
     InMemorySessionStore.repo['abra'] = 'something'
     assert_equal 'something', InMemorySessionStore.retrieve('abra')
   end
 
-  def test_clearing_the_store
+  test "clearing the store" do
     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
+  test "it should raise when the environment is not valid" do
     Rails.env.stubs(:production?).returns(true)
     assert_raises InMemorySessionStore::EnvironmentError do
       InMemorySessionStore.store('data')

data/test/{lib/shopify_app → shopify_app}/login_protection_test.rb

@@ -1,5 +1,6 @@
 require 'test_helper'
 require 'action_controller'
+require 'action_controller/base'
 
 class LoginProtectionController < ActionController::Base
   include ShopifyApp::LoginProtection
@@ -13,11 +14,11 @@ end
 class LoginProtectionTest < ActionController::TestCase
   tests LoginProtectionController
 
-  def setup
-    ShopifySessionRepository.storage = InMemorySessionStore
+  setup do
+    ShopifyApp::SessionRepository.storage = InMemorySessionStore
   end
 
-  def test_calling_shop_session_returns_nil_when_session_is_nil
+  test "calling shop session returns nil when session is nil" do
     with_application_test_routes do
       session[:shopify] = nil
       get :index
@@ -25,25 +26,27 @@ class LoginProtectionTest < ActionController::TestCase
     end
   end
 
-  def test_calling_shop_session_retreives_session_from_storage
+  test "calling shop session retreives session from storage" do
     with_application_test_routes do
       session[:shopify] = "foobar"
       get :index
-      ShopifySessionRepository.expects(:retrieve).returns(session).once
+      ShopifyApp::SessionRepository.expects(:retrieve).returns(session).once
       assert @controller.shop_session
     end
   end
 
-  def test_shop_session_is_memoized_and_does_not_retreive_session_twice
+  test "shop session is memoized and does not retreive session twice" do
     with_application_test_routes do
       session[:shopify] = "foobar"
       get :index
-      ShopifySessionRepository.expects(:retrieve).returns(session).once
+      ShopifyApp::SessionRepository.expects(:retrieve).returns(session).once
       assert @controller.shop_session
       assert @controller.shop_session
     end
   end
 
+  private
+
   def with_application_test_routes
     with_routing do |set|
       set.draw do

data/test/shopify_app/shopify_session_repository_test.rb

@@ -0,0 +1,73 @@
+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 TestSessionStoreClass
+  def self.store(session)
+  end
+
+  def self.retrieve(id)
+  end
+end
+
+class ShopifySessionRepositoryTest < ActiveSupport::TestCase
+  attr_reader :session_store, :session
+
+  setup do
+    @session_store = TestSessionStore.new
+    @session = ShopifyAPI::Session.new('shop.myshopify.com', 'abracadabra')
+    ShopifyApp::SessionRepository.storage = session_store
+  end
+
+  teardown do
+    ShopifyApp::SessionRepository.storage = nil
+  end
+
+  test "adding a session to the repository" do
+    assert_equal 0, ShopifyApp::SessionRepository.store(session)
+    assert_equal session, session_store.retrieve(0)
+  end
+
+  test "retrieving a session from the repository" do
+    session_store.storage[9] = session
+    assert_equal session, ShopifyApp::SessionRepository.retrieve(9)
+  end
+
+  test "retrieving a session for an id that does not exist" do
+    ShopifyApp::SessionRepository.store(session)
+    assert !ShopifyApp::SessionRepository.retrieve(100), "The session with id 100 should not exist in the Repository"
+  end
+
+  test "retrieving a session for a misconfigured shops repository" do
+    ShopifyApp::SessionRepository.storage = nil
+    assert_raises ShopifyApp::SessionRepository::ConfigurationError do
+      ShopifyApp::SessionRepository.retrieve(0)
+    end
+
+    assert_raises ShopifyApp::SessionRepository::ConfigurationError do
+      ShopifyApp::SessionRepository.store(session)
+    end
+  end
+
+  test "accepts a string and constantizes it" do
+    ShopifyApp::SessionRepository.storage = 'TestSessionStoreClass'
+    assert_equal TestSessionStoreClass, ShopifyApp::SessionRepository.storage
+  end
+
+end