shopify_app 4.1.1 → 4.2.0

data/README.md

@@ -0,0 +1,144 @@
+# Shopify App
+
+Shopify application generator for Rails 3.1 and Rails 4.0
+
+## Description
+
+This gem makes it easy to get a Rails 3.1 or Rails 4.0 app up and running with the Shopify API.
+
+The generator creates a basic SessionsController for authenticating with your shop and a HomeController which displays basic information about your products, orders and articles.
+
+*Note: It's recommended to use this on a new Rails project, so that the generator won't overwrite/delete some of your files.*
+
+## Installation
+
+``` sh
+# Create a new rails app
+$ rails new my_shopify_app
+$ cd my_shopify_app
+
+# Add the gem shopify_app to your Gemfile
+$ echo "gem 'shopify_app'" >> Gemfile
+$ bundle install
+```
+
+## Usage
+
+``` sh
+$ rails generate shopify_app your_app_api_key your_app_secret
+```
+
+If you don't have an API key yet, create a Shopify Partner account at http://shopify.com/partners and create an app. You can lso create test shops once you're logged in as a partner.
+
+When you create your app in the Shopify Partner Account, set the Application Callback URL to
+
+	http://localhost:3000
+
+You can also create a private application that only works for your shop by visiting https://YOUR-SHOP.myshopify.com/admin/api
+
+### Example
+
+``` sh
+$ rails generate shopify_app edffbb1bb793e2750686e6f4647a384a fed5bb18hde3e2750686e6f4647a781a
+```
+
+This will create a LoginController and a HomeController with their own views.
+
+## Configuring Shopify App
+
+It's possible to set your API key and secret key from different sources:
+
+* `SHOPIFY_APP_API_KEY` and `SHOPIFY_APP_SECRET` environment variables
+* Configuration in a Rails `<environment>.rb` config file
+
+``` ruby
+config.shopify.api_key = 'your api key'
+config.shopify.secret = 'your secret'
+```
+
+* Configuration loaded from `<environment>` key in `shopify_app.yml`
+
+``` yaml
+development:
+  api_key: your api key
+  secret: your secret
+```
+
+* Configuration loaded from common key in `shopify_app.yml`
+
+``` yaml
+common:
+  api_key: your api key
+  secret: your secret
+```
+
+## 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.
+
+Start by reviewing the documentation on API permission scopes: http://docs.shopify.com/api/tutorials/oauth
+
+When you know which ones your app will need, add a scope line to the `config/initializers/omniauth.rb` file.
+
+### Example
+
+Make this change to request write access to products and read access to orders:
+
+``` ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :shopify, 
+       ShopifyApp.configuration.api_key, 
+       ShopifyApp.configuration.secret,
+       :scope => "write_products,read_orders",
+       :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
+                 }
+end
+```
+
+*Note that you can change your API permission scopes on the fly, but the merchant will have to approve each change and your computed API password will change.*
+
+## After running the generator
+
+First, start your application:
+
+``` sh
+$ rails server
+```
+
+Now visit http://localhost:3000 and install your application in a Shopify store. Even if Rails tells you to visit your app at http://0.0.0.0:3000, go to http://localhost:3000.
+
+After your application has been given whatever API permissions you requested by the shop, you're ready to start experimenting with the Shopify API.
+
+## Rails 3.0 (as in before 3.1) Support
+
+Rails 3.0 (as in before the big changes in 3.1) is supported on a branch of our github repo: https://github.com/Shopify/shopify_app/tree/rails_3.0_support
+
+## Common problems
+
+If you are getting the following error:
+
+```
+Faraday::Error::ConnectionFailed error when accessing app.
+```
+    
+It probably means that the CA certificate on your computer is out of date. A simple solution on the Mac is to install XCode.
+
+If you are getting the following error:
+
+```
+ActiveResource::ForbiddenAccess in HomeController#index
+Failed.  Response code = 403.  Response message = Forbidden.
+```
+
+It means that you have not set appropriate permissions in your `config/initializers/omniauth.rb` file for what you are trying to do in your HomeController#index action. Example: you set your permissions to 'write_content' because that's what your app will do, but your HomeController#index still has that default code generated by shopify_app which attempts to read products and orders, neither being covered by the 'write_content' scope.
+
+## Questions or problems?
+
+http://api.shopify.com <= Read up on the possible API calls!
+
+http://ecommerce.shopify.com/c/shopify-apis-and-technology <= Ask questions!
+
+http://wiki.shopify.com/Shopify_App_Development <= Edit the docs!

data/Rakefile

@@ -1,2 +1,13 @@
-require 'bundler'
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
 Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/shopify_app'
+  t.libs << 'test'
+  t.test_files = FileList['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/generators/shopify_app/shopify_app_generator.rb

@@ -21,21 +21,21 @@ class ShopifyAppGenerator < Rails::Generators::Base
   end
   
   def add_config_variables
-    api_key_str = api_key.nil? ? "ENV['SHOPIFY_API_KEY']" : api_key.inspect
-    api_secret_str = secret.nil? ? "ENV['SHOPIFY_API_SECRET']" : secret.inspect
+    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_str}
-    config.shopify.secret = #{api_secret_str}
-    
+    config.shopify.api_key = '#{api_key}'
+    config.shopify.secret = '#{secret}'
     DATA
   end
 
   def add_bootstrap_gem
-    insert_into_file "Gemfile", "\ngem 'less-rails-bootstrap'\n\n", :before => '# Gems used only for assets and not required'
-    insert_into_file "Gemfile", "\ngem 'therubyracer', :platforms => :ruby\n\n", :before => 'end'
+    gem_group :development, :test do
+      gem "less-rails-bootstrap"
+      gem 'therubyracer', :platforms => :ruby
+    end
   end
   
   def add_routes
@@ -47,8 +47,8 @@ class ShopifyAppGenerator < Rails::Generators::Base
       route_without_newline "  post 'login' => :create"
       route_without_newline "  get 'login' => :new"
       route_without_newline "controller :sessions do"
-      route "match 'design' => 'home#design'"
-      route_without_newline "match 'welcome' => 'home#welcome'"
+      route "get 'design' => 'home#design'"
+      route_without_newline "get 'welcome' => 'home#welcome'"
     end
   end
   

data/lib/generators/shopify_app/templates/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+  
+  # Ask shop to authorize app again if additional permissions are required
+  # rescue_from ActiveResource::ForbiddenAccess do
+  #   session[:shopify] = nil
+  #   flash[:notice] = "This app requires additional permissions, please log in and authorize it."
+  #   redirect_to controller: :sessions, action: :create
+  # end
+end

data/lib/generators/shopify_app/templates/app/controllers/home_controller.rb

@@ -8,7 +8,7 @@ class HomeController < ApplicationController
   end
   
   def index
-    # get 5 products
+    # get 10 products
     @products = ShopifyAPI::Product.find(:all, :params => {:limit => 10})
 
     # get latest 5 orders

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

@@ -7,7 +7,7 @@
 <div class="info" style="clear: both">
   This will send the <strong>API-Key</strong> and <strong>Secret</strong> to a shop, and make sure that you have the rights to 
   access its private admin data.<br/>
-  After authenticating, you will be redirected to the <code>finalize</code> action of your <code>LoginController</code>, which stores the session, and then redirects you to your example dashboard.<br/>
+  After authenticating, you will be redirected to the <code>show</code> action of your <code>SessionsController</code>, which stores the session, and then redirects you to your example dashboard.<br/>
   Your <code>HomeController</code> will get your recent <code>Orders</code> and <code>Articles</code> through the 
   Shopify <%= link_to 'REST', 'http://www.xfront.com/REST-Web-Services.html', :title => "Get more information about REST web services in general" %> API and list them with all of your <code>Products</code>.
   You can click on a link of one of your objects and will then be taken to the corresponding admin area of your shop.<br/>
@@ -66,7 +66,7 @@ The callback URL of your app can be changed in the API screen of your Shopify ad
   <div class="info">
     This will send the <strong>API-Key</strong> and <strong>Secret</strong> to a shop, and make sure that you have the rights to 
     access its private admin data.<br/>
-    After authenticating, you will be redirected to the <code>finalize</code> action of your <code>LoginController</code>, which stores the session, and then redirects you to your example dashboard.<br/>
+    After authenticating, you will be redirected to the <code>show</code> action of your <code>SessionsController</code>, which stores the session, and then redirects you to your example dashboard.<br/>
     Your <code>HomeController</code> will get your recent <code>Orders</code> and <code>Articles</code> through the 
     Shopify <%= link_to 'REST', 'http://www.xfront.com/REST-Web-Services.html', :title => "Get more information about REST web services in general" %> API and list them with all of your <code>Products</code>.
     You can click on a link of one of your objects and will then be taken to the corresponding admin area of your shop.<br/>

data/lib/generators/shopify_app/templates/app/views/layouts/application.html.erb

@@ -62,6 +62,9 @@
   
   
   <div class="container">
+    <% flash.each do |type, message| %>
+      <div class="alert"><%= message %></div>
+    <% end %>
     
     <div class="content">
       <%= yield %>

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

@@ -3,7 +3,7 @@ Rails.application.config.middleware.use OmniAuth::Builder do
            ShopifyApp.configuration.api_key, 
            ShopifyApp.configuration.secret,
 
-           # Example permission scopes - see http://api.shopify.com/authentication.html for full listing
+           # Example permission scopes - see http://docs.shopify.com/api/tutorials/oauth for full listing
            :scope => 'read_orders, read_products',
 
            :setup => lambda {|env| 

data/lib/shopify_app/configuration.rb

@@ -1,3 +1,46 @@
-class ShopifyApp::Configuration  
-  attr_accessor :api_key, :secret
+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/login_protection.rb

@@ -8,7 +8,7 @@ module ShopifyApp::LoginProtection
   def shopify_session
     if session[:shopify]
       begin
-        # session[:shopify] set in LoginController#finalize
+        # session[:shopify] set in LoginController#show
         ShopifyAPI::Base.activate_session(session[:shopify])
         yield
       ensure 
@@ -16,7 +16,7 @@ module ShopifyApp::LoginProtection
       end
     else
       session[:return_to] = request.fullpath if request.get?
-      redirect_to login_path
+      redirect_to login_path(shop: params[:shop])
     end
   end
   

data/lib/shopify_app/version.rb

@@ -1,3 +1,3 @@
 module ShopifyApp
-  VERSION = "4.1.1"
+  VERSION = "4.2.0"
 end

data/shopify_app.gemspec

@@ -14,11 +14,14 @@ Gem::Specification.new do |s|
 
   s.rubyforge_project = "shopify-api"
 
-  s.add_runtime_dependency('rails', '~> 3.1')
+  s.add_runtime_dependency('rails', '>= 3.1', '< 5.0')
   s.add_runtime_dependency('shopify_api', '~> 3.0.0')
   s.add_runtime_dependency('omniauth-shopify-oauth2', '1.1.0')
+  s.add_runtime_dependency('less-rails-bootstrap', '>0')
   
   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")

data/test/config/development_config_file.yml

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

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

data/test/config/other_config_file.yml

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

data/test/config/shopify_app.yml

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

@@ -0,0 +1,78 @@
+require 'test_helper'
+
+class ConfigurationTest < MiniTest::Unit::TestCase
+  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/test_helper.rb

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

metadata

@@ -1,60 +1,134 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 4.1.1
   prerelease: 
+  version: 4.2.0
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-27 00:00:00.000000000 Z
+date: 2013-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
-  requirement: &70331226041240 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    none: false
+  name: rails
   type: :runtime
   prerelease: false
-  version_requirements: *70331226041240
-- !ruby/object:Gem::Dependency
-  name: shopify_api
-  requirement: &70331226040720 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - <
+      - !ruby/object:Gem::Version
+        version: '5.0'
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: 3.0.0
+    none: false
+  name: shopify_api
   type: :runtime
   prerelease: false
-  version_requirements: *70331226040720
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    none: false
 - !ruby/object:Gem::Dependency
-  name: omniauth-shopify-oauth2
-  requirement: &70331226040180 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
     none: false
+  name: omniauth-shopify-oauth2
+  type: :runtime
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.1.0
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: less-rails-bootstrap
   type: :runtime
   prerelease: false
-  version_requirements: *70331226040180
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
 - !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
   name: rake
-  requirement: &70331226039740 !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  name: minitest
   type: :development
   prerelease: false
-  version_requirements: *70331226039740
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+- !ruby/object:Gem::Dependency
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  name: mocha
+  type: :development
+  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
 description: Creates a basic sessions controller for authenticating with your Shop
   and also a product controller which lets your edit your products easily.
 email:
@@ -68,7 +142,7 @@ files:
 - .gitignore
 - CHANGELOG
 - Gemfile
-- README.rdoc
+- README.md
 - RELEASING
 - Rakefile
 - install.rb
@@ -86,6 +160,7 @@ files:
 - lib/generators/shopify_app/templates/app/assets/stylesheets/imports.css.less
 - lib/generators/shopify_app/templates/app/assets/stylesheets/shopify_app.css.scss
 - lib/generators/shopify_app/templates/app/assets/stylesheets/shopify_app_buttons.css.less
+- lib/generators/shopify_app/templates/app/controllers/application_controller.rb
 - lib/generators/shopify_app/templates/app/controllers/home_controller.rb
 - lib/generators/shopify_app/templates/app/controllers/sessions_controller.rb
 - lib/generators/shopify_app/templates/app/helpers/home_helper.rb
@@ -110,6 +185,12 @@ files:
 - lib/shopify_app/railtie.rb
 - lib/shopify_app/version.rb
 - shopify_app.gemspec
+- 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/test_helper.rb
 homepage: http://www.shopify.com/developers
 licenses: []
 post_install_message: 
@@ -117,22 +198,27 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: shopify-api
-rubygems_version: 1.8.11
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: This gem is used to get quickly started with the Shopify API
-test_files: []
-has_rdoc: 
+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/test_helper.rb

data/README.rdoc

@@ -1,89 +0,0 @@
-= Shopify application generator for Rails 3.2
-
-== Description
-
-This gem makes it easy to get a Rails 3.2 app up and running with the
-Shopify API.
-
-The generator creates a basic SessionsController for authenticating with your
-shop and a HomeController which displays basic information about your
-products, orders and articles.
-
-<i>Note: It's recommended to use this on a new Rails project, so that the
-generator won't overwrite/delete some of your files.</i>
-
-== Installation
-
-    # Add the gem shopify_app to your Gemfile
-    $ echo "gem 'shopify_app'" >> Gemfile
-    $ bundle install
-
-== Usage
-
-    $ rails generate shopify_app your_app_api_key your_app_secret
-
-If you don't have an API key yet, create a Shopify Partner account at
-http://shopify.com/partners and create an app. You can also create test shops
-once you're logged in as a partner.
-
-When you create your app in the Shopify Partner Account, set the Application URL to
-<tt>http://localhost:3000/login</tt>
-
-You can also create a private application that only works for your shop by
-visiting https://YOUR-SHOP.myshopify.com/admin/api
-
-=== Example
-
-    $ rails generate shopify_app edffbb1bb793e2750686e6f4647a384a fed5bb18hde3e2750686e6f4647a781a
-
-This will create a LoginController and a HomeController with their own views.
-
-
-== 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.
-
-Start by reviewing the documentation on API permission scopes: http://api.shopify.com/authentication.html
-
-When you know which ones your app will need, add a scope line to the <tt>config/initializers/omniauth.rb</tt> file.
-
-=== Example
-
-Make this change to request write access to products and read access to orders:
-
-    Rails.application.config.middleware.use OmniAuth::Builder do
-        provider :shopify, 
-           ShopifyApp.configuration.api_key, 
-           ShopifyApp.configuration.secret,
-           :scope => "write_products,read_orders",
-           :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
-                     }
-    end
-
-(Note that you can change your API permission scopes on the fly, but the merchant will have to approve each change and your computed API password will change.)
-
-== After running the generator
-
-First, start your application:
-
-    $ rails server
-
-Now visit http://localhost:3000 and install your application in a Shopify store.
-
-After your application has been given whatever API permissions you requested by the
-shop, you're ready to start experimenting with the Shopify API.
-
-== Rails 3.0 (as in before 3.1) Support
-
-Rails 3.0 (as in before the big changes in 3.1) is supported on a branch of our github repo: https://github.com/Shopify/shopify_app/tree/rails_3.0_support
-
-== Questions or problems?
-
-http://api.shopify.com <= Read up on the possible API calls!
-
-http://ecommerce.shopify.com/c/shopify-apis-and-technology <= Ask questions!
-
-http://wiki.shopify.com/Shopify_App_Development <= Edit the docs!