RubyGems - shopify_app_lrb3 - Versions diffs - 5.0.0 - Mend

shopify_app_lrb3 5.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (61) hide show

data/lib/generators/shopify_app/templates/public/422.html ADDED

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>422 Error: Your change was rejected</title>
+  <style>
+  .container { text-align:center;}
+  .navbar .brand { float:none;}
+  </style>
+</head>
+<body>
+  <div class="navbar navbar-fixed-top">
+    <div class="navbar-inner">
+      <div class="container">
+        <a href="/" class="brand">Shopify Demo App</a>
+      </div>
+    </div>
+  </div>
+  <div class="container">
+    <div class="content">
+      <div class="page-header">
+        <h1>422 Error</h1>
+      </div>
+      <h3><i class="icon-warning-sign" style="margin-top:6px; opacity:.5;"></i> Sorry, the change you requested was rejected.</h3>
+      <p class="muted">Did you try to change something you don't have access to?</p>
+      <p><button type="button" value ="back" onClick="window.history.back();" class='btn btn-primary'><i class="icon-chevron-left" style="opacity:.25"></i> Back to the app</button></p>
+    </div>
+    <footer>
+      <p>A Shopify app by (company name here)</p>
+    </footer>
+  </div> <!-- /container -->
+</body>
+</html>

data/lib/generators/shopify_app/templates/public/500.html ADDED

@@ -0,0 +1,40 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>500 Error: Something went horribly wrong</title>
+  <style>
+  .container { text-align:center;}
+  .navbar .brand { float:none;}
+  </style>
+</head>
+<body>
+  <div class="navbar navbar-fixed-top">
+    <div class="navbar-inner">
+      <div class="container">
+        <a href="/" class="brand">Shopify Demo App</a>
+      </div>
+    </div>
+  </div>
+  <div class="container">
+    <div class="content">
+      <div class="page-header">
+        <h1>AH! 500 Error!</h1>
+      </div>
+      <h3><i class="icon-warning-sign" style="margin-top:6px; opacity:.5;"></i> We're sorry, but something went wrong.</h3>
+      <p class="muted">The developer of this app has been notified.</p>
+      <p><button type="button" value ="back" onClick="window.history.back();" class='btn btn-primary'><i class="icon-chevron-left" style="opacity:.25"></i> Back to the app</button></p>
+    </div>
+    <footer>
+      <p>A Shopify app by (company name here)</p>
+    </footer>
+  </div> <!-- /container -->
+</body>
+</html>

data/lib/generators/shopify_app/templates/public/favicon.png ADDED

Binary file

data/lib/generators/shopify_app/templates/public/shopify-114.png ADDED

Binary file

data/lib/generators/shopify_app/templates/public/shopify-57.png ADDED

Binary file

data/lib/generators/shopify_app/templates/public/shopify-72.png ADDED

Binary file

data/lib/shopify_app.rb ADDED

@@ -0,0 +1,20 @@
+require 'shopify_api'
+require 'omniauth-shopify-oauth2'
+module ShopifyApp
+  def self.configuration
+    @configuration ||= ShopifyApp::Configuration.new
+  end
+  def self.setup_session
+    ShopifyAPI::Session.setup(:api_key => ShopifyApp.configuration.api_key, :secret => ShopifyApp.configuration.secret)
+  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'
+require 'shopify_app/version'

data/lib/shopify_app/configuration.rb ADDED

@@ -0,0 +1,46 @@
+class ShopifyApp::Configuration
+  VALID_KEYS = [:api_key, :secret]
+  attr_writer *VALID_KEYS
+  def initialize(params={})
+    self.params = default_params.merge(params)
+  end
+  VALID_KEYS.each do |meth|
+    define_method meth do
+      meth = meth.to_s
+      config_from_env(meth) || config_from_rails(meth) || config_from_file(meth) || ''
+    end
+  end
+  private
+  attr_accessor :params
+  def config_from_env(meth)
+    ENV["SHOPIFY_APP_#{meth.upcase}"]
+  end
+  def config_from_rails(meth)
+    instance_variable_get("@#{meth}")
+  end
+  def config_from_file(meth)
+    @config_file ||= load_config
+    @config_file[Rails.env].try(:[], meth) || @config_file['common'].try(:[], meth)
+  end
+  def load_config
+    File.exist?(config_filepath) ? YAML.load_file(config_filepath) : {}
+  end
+  def config_filepath
+    params[:config_file]
+  end
+  def default_params
+    {
+      config_file: File.join(Rails.root, 'config', 'shopify_app.yml')
+    }
+  end
+end

data/lib/shopify_app/in_memory_session_store.rb ADDED

@@ -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 ADDED

@@ -0,0 +1,39 @@
+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
+        ShopifyAPI::Base.clear_session
+      end
+    else
+      session[:return_to] = request.fullpath if request.get?
+      redirect_to login_path(shop: params[:shop])
+    end
+  end
+  def 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
+  end
+  protected
+  def close_session
+    session[:shopify] = nil
+    redirect_to login_path
+  end
+end

data/lib/shopify_app/railtie.rb ADDED

@@ -0,0 +1,17 @@
+require 'rails'
+class ShopifyApp::Railtie < ::Rails::Railtie
+  config.before_configuration do
+    config.shopify = ShopifyApp.configuration
+  end
+  initializer "shopify_app.action_controller_integration" do
+    ActionController::Base.send :include, ShopifyApp::LoginProtection
+    ActionController::Base.send :helper_method, :shop_session
+  end
+  initializer "shopify_app.setup_session" do
+    ShopifyApp.setup_session
+  end
+end

data/lib/shopify_app/shopify_session_repository.rb ADDED

@@ -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 ADDED

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

data/shipit.rubygems.yml ADDED

	@@ -0,0 +1 @@
1	+ # using the default shipit config

data/shopify_app.gemspec ADDED

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "shopify_app/version"
+Gem::Specification.new do |s|
+  s.name        = "shopify_app_lrb3"
+  s.version     = ShopifyApp::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = "Shopify"
+  s.email       = ["gareth@bencrudo.com"]
+  s.homepage    = "http://www.shopify.com/developers"
+  s.summary     = %q{Fork of shopify_app upgrade to Less Rails Bootstrap 3.1.1}
+  s.description = %q{Required Boostrap 3 so cloned and upgraded to Less Rails Bootstrap 3.1.1}
+  s.rubyforge_project = "shopify-api"
+  s.add_runtime_dependency('rails', '>= 3.1', '< 5.0')
+  s.add_runtime_dependency('shopify_api', '~> 3.2.0')
+  s.add_runtime_dependency('omniauth-shopify-oauth2', '~> 1.1.4')
+  s.add_runtime_dependency('less-rails-bootstrap', '~> 3.1.1')
+  s.add_development_dependency('rake')
+  s.add_development_dependency('minitest')
+  s.add_development_dependency('mocha')
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/config/development_config_file.yml ADDED

@@ -0,0 +1,7 @@
+common:
+  api_key: should never see this api key value
+  secret: should never see this secret value
+development:
+  api_key: development key
+  secret: development secret

data/test/config/empty_config_file.yml ADDED

	@@ -0,0 +1 @@
1	+ common:

data/test/config/other_config_file.yml ADDED

@@ -0,0 +1,3 @@
+common:
+  api_key: api key from other file
+  secret: secret from other file

data/test/config/shopify_app.yml ADDED

@@ -0,0 +1,3 @@
+common:
+  api_key: api key from default file
+  secret: secret from default file

data/test/lib/shopify_app/configuration_test.rb ADDED

@@ -0,0 +1,78 @@
+require 'test_helper'
+class ConfigurationTest < Minitest::Test
+  def setup
+    Rails.stubs(:env).returns('development')
+    Rails.stubs(:root).returns(File.expand_path('../..', File.dirname(__FILE__)))
+  end
+  def config_file(filename)
+    filepath = File.expand_path("../../config/#{filename}", File.dirname(__FILE__))
+  end
+  def test_define_method_creates_readers
+    config = ShopifyApp::Configuration.new
+    config.respond_to?(:api_key)
+    config.respond_to?(:secret)
+  end
+  def test_defaults_to_empty_string
+    config = ShopifyApp::Configuration.new(config_file: config_file('empty_config_file.yml'))
+    assert_equal '', config.api_key
+    assert_equal '', config.secret
+  end
+  def test_environment_has_precedence_over_common
+    config = ShopifyApp::Configuration.new(config_file: config_file('development_config_file.yml'))
+    assert_equal 'development key', config.api_key
+    assert_equal 'development secret', config.secret
+  end
+  def test_rails_has_precedence_over_environment
+    config = ShopifyApp::Configuration.new(config_file: config_file('development_config_file.yml'))
+    assert_equal 'development key', config.api_key
+    assert_equal 'development secret', config.secret
+    config.api_key = 'rails key'
+    config.secret = 'rails secret'
+    assert_equal 'rails key', config.api_key
+    assert_equal 'rails secret', config.secret
+  end
+  def test_env_has_precedence_over_rails
+    config = ShopifyApp::Configuration.new
+    config.api_key = 'rails key'
+    config.secret = 'rails secret'
+    assert_equal 'rails key', config.api_key
+    assert_equal 'rails secret', config.secret
+    ENV.expects(:[]).with('SHOPIFY_APP_API_KEY').returns('env key')
+    ENV.expects(:[]).with('SHOPIFY_APP_SECRET').returns('env secret')
+    assert_equal 'env key', config.api_key
+    assert_equal 'env secret', config.secret
+  end
+  def test_reads_config_from_default_config_file
+    config = ShopifyApp::Configuration.new
+    assert_equal 'api key from default file', config.api_key
+    assert_equal 'secret from default file', config.secret
+  end
+  def test_reads_config_from_specified_config_file
+    config = ShopifyApp::Configuration.new(config_file: config_file('other_config_file.yml'))
+    assert_equal 'api key from other file', config.api_key
+    assert_equal 'secret from other file', config.secret
+  end
+  def test_handles_missing_config_file
+    config = ShopifyApp::Configuration.new(config_file: config_file('missing_config_file.yml'))
+    assert_equal '', config.api_key
+    assert_equal '', config.secret
+  end
+end

data/test/lib/shopify_app/in_memory_session_store_test.rb ADDED

@@ -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 ADDED

@@ -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