shopify_app 4.0.1 → 4.1.0

data/CHANGELOG

@@ -1,4 +1,5 @@
 * re-styled with Twitter Bootstrap css framework and updated docs [warren]
 * Require shopify_api gem via proper railtie setup [willem]
 * Don't require shopify.yml when using environment variables [cody]
-* Renamed instances of current_shop to shop_session to maintain logic
+* Renamed instances of current_shop to shop_session to maintain logic
+* Replace old LoginController with a RESTful SessionsController

data/README.rdoc

@@ -5,7 +5,7 @@
 This gem makes it easy to get a Rails 3.2 app up and running with the
 Shopify API.
 
-The generator creates a basic login controller for authenticating with your
+The generator creates a basic SessionsController for authenticating with your
 shop and a HomeController which displays basic information about your
 products, orders and articles.
 
@@ -26,8 +26,8 @@ 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 return URL to
-<tt>http://localhost:3000/login/finalize</tt>
+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

data/install.rb

@@ -7,7 +7,7 @@ puts
 puts " * Go to http://www.shopify.com/partners and create or login to your Partner account."
 puts
 puts " * Jump over to the Apps tab and hit the 'Create a new app' button"
-puts "   (Make sure to set the Return URL to http://localhost:3000/login/finalize during development)"
+puts "   (Make sure to set the Application URL to http://localhost:3000/login during development)"
 puts
 puts " * Install the Shopify API gem:
 

data/lib/generators/shopify_app/README

@@ -3,8 +3,8 @@
 What's next?
 ------------
 
-Make sure to set the return URL of the application your Shopify partner account 
-to <tt>http://localhost:3000/login/finalize</tt>.
+Make sure to set the Application URL of the application in your Shopify partner account 
+to <tt>http://localhost:3000/login</tt>.
 
 Then, start your application with:
 

data/lib/generators/shopify_app/USAGE

@@ -2,7 +2,7 @@ Description:
     This is a generator for creating a basic Shopify application to quickly get
     you started. You can see some examples on how to use the Shopify API.
     
-    The generator creates a basic login controller for authenticating with your
+    The generator creates a basic sessions controller for authenticating with your
     Shop and a controller called "home" which displays basic information 
     about your products, orders and articles.
     
@@ -10,7 +10,7 @@ Description:
           generator won't overwrite/delete some of your files.
 
 Usage:
-    Pass your API key and then your Secret, which the login controller 
+    Pass your API key and then your Secret, which the sessions controller 
     will need to authenticate with your shop. 
     If you don't have an API key yet, register your application in our
     partner system at http://www.shopify.com/partners
@@ -19,4 +19,4 @@ Usage:
 Examples:
     script/generate shopify_app edffbb1bb793e2750686e6f4647a384a abbcee050...
         
-    This will create a login controller and a home controller and views.
+    This will create a sessions controller and a home controller and views.

data/lib/generators/shopify_app/shopify_app_generator.rb

@@ -40,14 +40,15 @@ class ShopifyAppGenerator < Rails::Generators::Base
   
   def add_routes
     unless options[:skip_routes]
-      route "root :to                   => 'home#index'"
-      route "match 'login/logout'       => 'login#logout',       :as => :logout"
-      route "match 'login/finalize'     => 'login#finalize',     :as => :finalize"
-      route "match 'login/authenticate' => 'login#authenticate', :as => :authenticate"
-      route "match 'login'              => 'login#index',        :as => :login"
-      route "match 'design'             => 'home#design'"
-      route "match 'welcome'            => 'home#welcome'"
-      route "match 'auth/shopify/callback' => 'login#finalize'"
+      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 "match 'design' => 'home#design'"
+      route_without_newline "match 'welcome' => 'home#welcome'"
     end
   end
   
@@ -55,4 +56,11 @@ class ShopifyAppGenerator < Rails::Generators::Base
     `bundle install`
     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/templates/app/controllers/home_controller.rb

@@ -4,7 +4,7 @@ class HomeController < ApplicationController
   
   def welcome
     current_host = "#{request.host}#{':' + request.port.to_s if request.port != 80}"
-    @callback_url = "http://#{current_host}/login/finalize"
+    @callback_url = "http://#{current_host}/login"
   end
   
   def index

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

@@ -0,0 +1,49 @@
+class SessionsController < ApplicationController
+  def new
+    authenticate if params[:shop].present?
+  end
+
+  def create
+    authenticate
+  end
+  
+  def show
+    if response = request.env['omniauth.auth']
+      sess = ShopifyAPI::Session.new(params[:shop], response[:credentials][:token])
+      session[:shopify] = sess        
+      flash[:notice] = "Logged in"
+      redirect_to return_address
+    else
+      flash[:error] = "Could not log in to Shopify store."
+      redirect_to :action => 'new'
+    end
+  end
+  
+  def destroy
+    session[:shopify] = nil
+    flash[:notice] = "Successfully logged out."
+    
+    redirect_to :action => 'new'
+  end
+  
+  protected
+  
+  def authenticate
+    if shop_name = sanitize_shop_param(params)
+      redirect_to "/auth/shopify?shop=#{shop_name}"
+    else
+      redirect_to return_address
+    end
+  end
+  
+  def return_address
+    session[:return_to] || root_url
+  end
+  
+  def sanitize_shop_param(params)
+    return unless params[:shop].present?
+    name = params[:shop].to_s.strip
+    name += '.myshopify.com' if !name.include?("myshopify.com") && !name.include?(".")
+    name.sub('https://', '').sub('http://', '')
+  end
+end

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

@@ -45,12 +45,12 @@
           
           <ul class="nav pull-right">
             <li class="dropdown">
-              <%= link_to raw(shop_session.url+' <b class="caret"></b>'), "https://#{shop_session.url}", :class => 'shop_name dropdown-toggle', :'data-toggle' => 'dropdown'  %>
+              <%= link_to raw(shop_session.url+' <b class="caret"></b>'), "https://#{shop_session.url}", :class => 'shop_name dropdown-toggle', :'data-toggle' => 'dropdown', :'data-target' => '#' %>
               <ul class="dropdown-menu">
                 <li><%= link_to raw('<i class="icon-home"></i> Storefront'), "http://"+shop_session.url, :target => 'blank' %></li>
                 <li><%= link_to raw('<i class="icon-cog"></i> Shopify Admin'), "http://"+shop_session.url+"/admin", :target => 'blank' %></li>
                 <li class="divider"></li>
-                <li><%= link_to raw('<i class="icon-off"></i> logout'), logout_path %></li>
+                <li><%= link_to raw('<i class="icon-off"></i> Logout'), logout_path, :method => :delete %></li>
               </ul>
             </li>
           </ul>

data/lib/generators/shopify_app/templates/app/views/{login/index.html.erb → sessions/new.html.erb}

@@ -4,7 +4,7 @@
 </div>
 
 <div style="width:340px; margin:0 auto;">
-  <%= form_tag '/login/authenticate', :class => 'form-search' do %>
+  <%= form_tag login_path, :class => 'form-search' do %>
     <%= text_field_tag 'shop', nil, :placeholder => 'Shop URL', :class => 'btn-large' %>
     <%= submit_tag 'Install', :class => 'btn btn-primary btn-large' %>
   <% end %>

data/lib/shopify_app/version.rb

@@ -1,3 +1,3 @@
 module ShopifyApp
-  VERSION = "4.0.1"
+  VERSION = "4.1.0"
 end

data/shopify_app.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.email       = ["edward@shopify.com", "willem@shopify.com", "david.underwood@shopify.com"]
   s.homepage    = "http://www.shopify.com/developers"
   s.summary     = %q{This gem is used to get quickly started with the Shopify API}
-  s.description = %q{Creates a basic login controller for authenticating with your Shop and also a product controller which lets your edit your products easily.}
+  s.description = %q{Creates a basic sessions controller for authenticating with your Shop and also a product controller which lets your edit your products easily.}
 
   s.rubyforge_project = "shopify-api"
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify_app
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-07 00:00:00.000000000 Z
+date: 2012-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -75,8 +75,8 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Creates a basic login controller for authenticating with your Shop and
-  also a product controller which lets your edit your products easily.
+description: Creates a basic sessions controller for authenticating with your Shop
+  and also a product controller which lets your edit your products easily.
 email:
 - edward@shopify.com
 - willem@shopify.com
@@ -107,7 +107,7 @@ files:
 - 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/home_controller.rb
-- lib/generators/shopify_app/templates/app/controllers/login_controller.rb
+- lib/generators/shopify_app/templates/app/controllers/sessions_controller.rb
 - lib/generators/shopify_app/templates/app/helpers/home_helper.rb
 - lib/generators/shopify_app/templates/app/helpers/login_helper.rb
 - lib/generators/shopify_app/templates/app/helpers/tabs_helper.rb
@@ -115,7 +115,7 @@ files:
 - lib/generators/shopify_app/templates/app/views/home/index.html.erb
 - lib/generators/shopify_app/templates/app/views/home/welcome.html.erb
 - lib/generators/shopify_app/templates/app/views/layouts/application.html.erb
-- lib/generators/shopify_app/templates/app/views/login/index.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/public/404.html
 - lib/generators/shopify_app/templates/public/422.html

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

@@ -1,44 +0,0 @@
-class LoginController < ApplicationController
-  def index
-    # Ask user for their #{shop}.myshopify.com address
-    
-    # If the #{shop}.myshopify.com address is already provided in the URL, just skip to #authenticate
-    if params[:shop].present?
-      redirect_to authenticate_path(:shop => params[:shop])
-    end
-  end
-
-  def authenticate
-    if params[:shop].present?
-      redirect_to "/auth/shopify?shop=#{params[:shop].to_s.strip}"
-    else
-      redirect_to return_address
-    end
-  end
-  
-  def finalize
-    if response = request.env['omniauth.auth']
-      sess = ShopifyAPI::Session.new(params['shop'], response['credentials']['token'])
-      session[:shopify] = sess        
-      flash[:notice] = "Logged in"
-      redirect_to return_address
-      session[:return_to] = nil
-    else
-      flash[:error] = "Could not log in to Shopify store."
-      redirect_to :action => 'index'
-    end
-  end
-  
-  def logout
-    session[:shopify] = nil
-    flash[:notice] = "Successfully logged out."
-    
-    redirect_to :action => 'index'
-  end
-  
-  protected
-  
-  def return_address
-    session[:return_to] || root_url
-  end
-end