RubyGems - shopify_app - Versions diffs - 5.0.2 → 6.0.0 - Mend

shopify_app 5.0.2 → 6.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 (110) hide show

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

@@ -0,0 +1,22 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <title>Shopify Embedded Example App</title>
+  <script src="//cdn.shopify.com/s/assets/external/app.js?<%= Time.now.strftime('%Y%m%d%H') %>"></script>
+  <script type="text/javascript">
+    ShopifyApp.init({
+      apiKey: "<%= ShopifyApp.configuration.api_key %>",
+      shopOrigin: '<%= "https://#{ @shop_session.url }" if @shop_session %>'
+    });
+  </script>
+  <%= stylesheet_link_tag 'application' %>
+  <%= javascript_include_tag 'application' %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+  <%= yield %>
+</body>
+</html>

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

@@ -0,0 +1,11 @@
+class HomeController < ApplicationController
+  around_filter :shopify_session
+<% if embedded_app? -%>
+  layout 'embedded_app'
+<% end -%>
+  def index
+    @products = ShopifyAPI::Product.find(:all, :params => {:limit => 10})
+  end
+end

data/lib/generators/shopify_app/install/templates/index.html.erb ADDED

@@ -0,0 +1,12 @@
+<h3>Products</h3>
+<table>
+  <tbody>
+    <% @products.each do |product| %>
+      <tr>
+        <td>
+          <a href='https://<%="#{@shop_session.url}/admin/products/#{product.id}"%>' target="_blank"> <%= product.id %> </a>
+        </td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

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

	@@ -0,0 +1,2 @@
1	+ Rails.application.config.middleware.use OmniAuth::Builder do
2	+ end

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

@@ -0,0 +1,6 @@
+ShopifyApp.configure do |config|
+  config.api_key = "<%= opts[:api_key] || '<api_key>' %>"
+  config.secret = "<%= opts[:secret] || '<secret>' %>"
+  config.scope = "<%= opts[:scope] || 'read_orders, read_products' %>"
+  config.embedded_app = <%= opts[:embedded_app] || true %>
+end

data/lib/generators/shopify_app/install/templates/shopify_app_ready_script.html ADDED

@@ -0,0 +1,8 @@
+<script type="text/javascript">
+  ShopifyApp.ready(function(){
+    ShopifyApp.Bar.initialize({
+      title: "Home",
+      icon: "<%= asset_path('faveicon.png') %>"
+    });
+  });
+</script>

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

@@ -0,0 +1,11 @@
+  provider :shopify,
+    ShopifyApp.configuration.api_key,
+    ShopifyApp.configuration.secret,
+    :scope => ShopifyApp.configuration.scope,
+    :setup => lambda {|env|
+       params = Rack::Utils.parse_query(env['QUERY_STRING'])
+       site_url = "https://#{params['shop']}"
+       env['omniauth.strategy'].options[:client_options][:site] = site_url
+    }

data/lib/generators/shopify_app/{templates/config/initializers → install/templates}/shopify_session_repository.rb RENAMED

@@ -8,16 +8,16 @@
 #
 # class Shop < ActiveRecord::Base
 #   def self.store(session)
-#     shop = Shop.new(domain: session.url, token: session.token)
+#     shop = self.new(domain: session.url, token: session.token)
 #     shop.save!
 #     shop.id
 #   end
 #
 #   def self.retrieve(id)
-#     if shop = Shop.where(id: id).first
+#     if shop = self.where(id: id).first
 #       ShopifyAPI::Session.new(shop.domain, shop.token)
 #     end
 #   end
 # end
-ShopifySessionRepository.storage = InMemorySessionStore
+ShopifyApp::SessionRepository.storage = InMemorySessionStore

data/lib/generators/shopify_app/routes/routes_generator.rb ADDED

@@ -0,0 +1,31 @@
+require 'rails/generators/base'
+module ShopifyApp
+  module Generators
+    class RoutesGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+      def inject_shopify_app_routes_into_application_routes
+        route(session_routes)
+      end
+      def disable_engine_routes
+        inject_into_file(
+          'config/initializers/shopify_app.rb',
+          "  config.routes = false\n",
+          before: 'end'
+        )
+      end
+      private
+      def session_routes
+        File.read(routes_file_path)
+      end
+      def routes_file_path
+        File.expand_path(find_in_source_paths('routes.rb'))
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/routes/templates/routes.rb ADDED

@@ -0,0 +1,7 @@
+  controller :sessions do
+    get 'login' => :new, :as => :login
+    post 'login' => :create, :as => :authenticate
+    get 'auth/shopify/callback' => :callback
+    get 'logout' => :destroy, :as => :logout
+  end

data/lib/generators/shopify_app/shop_model/shop_model_generator.rb ADDED

@@ -0,0 +1,42 @@
+require 'rails/generators/base'
+require 'rails/generators/active_record'
+module ShopifyApp
+  module Generators
+    class ShopModelGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('../templates', __FILE__)
+      def create_shop_model
+        copy_file 'shop.rb', 'app/models/shop.rb'
+      end
+      def create_shop_migration
+        copy_migration 'create_shops.rb'
+      end
+      def create_session_storage
+        copy_file 'session_storage.rb', 'app/models/session_storage.rb'
+      end
+      def create_session_storage_initializer
+        copy_file 'shopify_session_repository.rb', 'config/initializers/shopify_session_repository.rb', force: true
+      end
+      private
+      def copy_migration(migration_name, config = {})
+        migration_template(
+          "db/migrate/#{migration_name}",
+          "db/migrate/#{migration_name}",
+          config
+        )
+      end
+      # for generating a timestamp when using `create_migration`
+      def self.next_migration_number(dir)
+        ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+    end
+  end
+end

data/lib/generators/shopify_app/shop_model/templates/db/migrate/create_shops.rb ADDED

@@ -0,0 +1,15 @@
+class CreateShops < ActiveRecord::Migration
+  def self.up
+    create_table :shops  do |t|
+      t.string :shopify_domain, null: false
+      t.string :shopify_token, null: false
+      t.timestamps
+    end
+    add_index :shops, :shopify_domain, unique: true
+  end
+  def self.down
+    drop_table :shops
+  end
+end

data/lib/generators/shopify_app/shop_model/templates/session_storage.rb ADDED

@@ -0,0 +1,16 @@
+class SessionStorage
+  def self.store(session)
+    shop = self.find_or_initialize_by(shopify_domain: session.url)
+    shop.shopify_token = session.token
+    shop.save!
+    shop.id
+  end
+  def self.retrieve(id)
+    return unless id
+    shop = self.find(id)
+    ShopifyAPI::Session.new(shop.shopify_domain, shop.shopify_token)
+  rescue ActiveRecord::RecordNotFound
+    nil
+  end
+end

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

@@ -0,0 +1,3 @@
+class Shop < ActiveRecord::Base
+  include ShopifyApp::Shop
+end

data/lib/generators/shopify_app/shop_model/templates/shopify_session_repository.rb ADDED

@@ -0,0 +1,7 @@
+if Rails.configuration.cache_classes
+  ShopifyApp::SessionRepository.storage = SessionStorage
+else
+  ActionDispatch::Reloader.to_prepare do
+    ShopifyApp::SessionRepository.storage = SessionStorage
+  end
+end

data/lib/generators/shopify_app/shopify_app_generator.rb CHANGED

@@ -1,69 +1,16 @@
-require 'rails/generators'
+module ShopifyApp
+  module Generators
+    class ShopifyAppGenerator < Rails::Generators::Base
-class ShopifyAppGenerator < Rails::Generators::Base
-  argument :api_key, :type => :string, :required => false
-  argument :secret, :type => :string, :required => false
+      def run_all_generators
+        generate "shopify_app:install"
+        generate "shopify_app:shop_model"
-  class_option :skip_routes, :type => :boolean, :default => false, :desc => 'pass true to skip route generation'
+        generate "shopify_app:controllers"
+        generate "shopify_app:views"
+        generate "shopify_app:routes"
+      end
-  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}'
-    DATA
-  end
-  def add_bootstrap_gem
-    gem_group :development, :test do
-      gem "less-rails-bootstrap"
-      gem 'therubyracer', :platforms => :ruby
     end
   end
-  def add_routes
-    unless options[:skip_routes]
-      route_without_newline "root :to => 'home#index'"
-      route "end"
-      route_without_newline "  delete 'logout' => :destroy"
-      route_without_newline "  get 'auth/shopify/callback' => :show"
-      route_without_newline "  post 'login' => :create"
-      route_without_newline "  get 'login' => :new"
-      route_without_newline "controller :sessions do"
-      route "get 'design' => 'home#design'"
-      route_without_newline "get 'welcome' => 'home#welcome'"
-    end
-  end
-  def display_readme
-    Bundler.with_clean_env do
-      run 'bundle install'
-    end
-    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

data/lib/generators/shopify_app/views/views_generator.rb ADDED

@@ -0,0 +1,29 @@
+require 'rails/generators/base'
+module ShopifyApp
+  module Generators
+    class ViewsGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../../../..", __FILE__)
+      def create_views
+        views.each do |view|
+          copy_file view
+        end
+      end
+      private
+      def views
+        files_within_root('.', 'app/views/**/*.*')
+      end
+      def files_within_root(prefix, glob)
+        root = "#{self.class.source_root}/#{prefix}"
+        Dir["#{root}/#{glob}"].sort.map do |full_path|
+          full_path.sub(root, '.').gsub('/./', '/')
+        end
+      end
+    end
+  end
+end

data/lib/shopify_app.rb CHANGED

@@ -1,20 +1,21 @@
+require 'shopify_app/version'
+# deps
 require 'shopify_api'
 require 'omniauth-shopify-oauth2'
-module ShopifyApp
+# config
+require 'shopify_app/configuration'
+# engine
+require 'shopify_app/engine'
-  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
+# helpers and concerns
+require 'shopify_app/shop'
+require 'shopify_app/controller'
+require 'shopify_app/sessions_controller'
+require 'shopify_app/login_protection'
+# session repository
 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 CHANGED

@@ -1,46 +1,36 @@
-class ShopifyApp::Configuration
-  VALID_KEYS = [:api_key, :secret, :myshopify_domain]
-  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) || ''
+module ShopifyApp
+  class Configuration
+    # Shopify App settings. These values should match the configuration
+    # for the app in your Shopify Partners page. Change your settings in
+    # `config/initializers/shopify_app.rb`
+    attr_accessor :api_key
+    attr_accessor :secret
+    attr_accessor :scope
+    attr_accessor :embedded_app
+    alias_method  :embedded_app?, :embedded_app
+    # use the built in session routes?
+    attr_accessor :routes
+    def routes_enabled?
+      @routes
     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)
+    def initialize
+      @routes = true
+    end
   end
-  def load_config
-    File.exist?(config_filepath) ? YAML.load_file(config_filepath) : {}
+  def self.configuration
+    @configuration ||= Configuration.new
   end
-  def config_filepath
-    params[:config_file]
+  def self.configuration=(config)
+    @configuration = config
   end
-  def default_params
-    {
-      config_file: File.join(Rails.root, 'config', 'shopify_app.yml')
-    }
+  def self.configure
+    yield configuration
   end
 end