shopify_app 0.1.0

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+.yardoc
+doc/

data/CHANGELOG

@@ -0,0 +1,2 @@
+* Require shopify_api gem
+* Don't require shopify.yml when using environment variables [cody]

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in shopify_app.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,58 @@
+= Shopify application generator for Rails 3
+
+== Description
+
+This plugin makes it easy to get a Rails 3 app up and running with the
+Shopify API.
+
+The generator creates a basic login controller for authenticating with your
+shop and a controller called "home" 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 return URL to
+<tt>http://localhost:3000/login/finalize</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.
+
+== 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 read or read/write API permission by the
+shop, you're ready to start experimenting with the Shopify API.
+
+== Questions or problems?
+
+http://api.shopify.com <= Read up on the possible API calls!
+
+http://forums.shopify.com/categories/9 <= Talk to new friends!
+
+http://wiki.shopify.com/Shopify_App_Development <= Edit the docs!

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/install.rb

@@ -0,0 +1,25 @@
+puts
+puts "Shopify App Generator"
+puts "---------------------"
+puts
+puts "To get started, first register your app as a Shopify Partner:"
+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
+puts " * Install the Shopify API gem:
+
+           $ gem install shopify_api"
+puts
+puts " * Run 
+
+           $ rails generate shopify_app your_app_api_key your_app_secret"
+puts
+puts " * Set up a test shop to install your app in (do this on the Partner site)"
+puts
+puts " * Run $ rails server"
+puts
+puts " * Visit http://localhost:3000 and use the test shop's URL to install this app"
+puts

data/lib/generators/shopify_app/README

@@ -0,0 +1,23 @@
+
+
+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>.
+
+Then, start your application with:
+
+  $ rails server
+
+Now visit http://localhost:3000 and install your application in a Shopify store.
+
+After your application has been given read or read/write API permission by the
+shop, you're ready to start experimenting with the Shopify API.
+
+Questions or problems?
+----------------------
+
+API Reference     http://api.shopify.com
+Developer Forums  http://forums.shopify.com/categories/9
+Developer Wiki    http://wiki.shopify.com/Shopify_App_Development

data/lib/generators/shopify_app/USAGE

@@ -0,0 +1,22 @@
+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
+    Shop and a controller called "home" 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.
+
+Usage:
+    Pass your API key and then your Secret, which the login 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
+
+    
+Examples:
+    script/generate shopify_app edffbb1bb793e2750686e6f4647a384a abbcee050...
+        
+    This will create a login controller and a home controller and views.

data/lib/generators/shopify_app/shopify_app_generator.rb

@@ -0,0 +1,50 @@
+require 'rails/generators'
+
+class ShopifyAppGenerator < Rails::Generators::Base
+  argument :api_key, :type => :string, :required => false
+  argument :secret, :type => :string, :required => false
+  
+  class_option :skip_routes, :type => :boolean, :default => false, :desc => 'pass true to skip route generation'
+  
+  def self.source_root
+    File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  def copy_files
+    directory 'app'
+    directory 'public'
+  end
+  
+  def remove_static_index
+    remove_file 'public/index.html'
+  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
+    
+    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}
+    DATA
+  end
+  
+  def add_routes
+    unless options[:skip_routes]
+      route "match 'login/logout'       => 'login#logout'"
+      route "match 'login/finalize'     => 'login#finalize'"
+      route "match 'login/authenticate' => 'login#authenticate'"
+      route "match 'login'              => 'login#index'"
+      route "match 'design'             => 'home#design'"
+      route "match 'welcome'            => 'home#welcome'"
+      route "root :to                   => 'home#index'"
+    end
+  end
+  
+  def display_readme
+    readme '../README'
+  end
+end

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

@@ -0,0 +1,18 @@
+class HomeController < ApplicationController
+  
+  around_filter :shopify_session, :except => 'welcome'
+  
+  def welcome
+    current_host = "#{request.host}#{':' + request.port.to_s if request.port != 80}"
+    @callback_url = "http://#{current_host}/login/finalize"
+  end
+  
+  def index
+    # get 3 products
+    @products = ShopifyAPI::Product.find(:all, :params => {:limit => 3})
+
+    # get latest 3 orders
+    @orders   = ShopifyAPI::Order.find(:all, :params => {:limit => 3, :order => "created_at DESC" })
+  end
+  
+end

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

@@ -0,0 +1,50 @@
+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 :controller => 'login', :action => "authenticate", :shop => params[:shop]
+    end
+  end
+
+  def authenticate
+    if params[:shop].present?
+      redirect_to ShopifyAPI::Session.new(params[:shop].to_s).create_permission_url
+    else
+      redirect_to return_address
+    end
+  end
+  
+  # Shopify redirects the logged-in user back to this action along with
+  # the authorization token t.
+  # 
+  # This token is later combined with the developer's shared secret to form
+  # the password used to call API methods.
+  def finalize
+    shopify_session = ShopifyAPI::Session.new(params[:shop], params[:t], params)
+    if shopify_session.valid?
+      session[:shopify] = shopify_session
+      flash[:notice] = "Logged in to shopify store."
+      
+      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

data/lib/generators/shopify_app/templates/app/helpers/home_helper.rb

@@ -0,0 +1,3 @@
+module HomeHelper
+
+end

data/lib/generators/shopify_app/templates/app/helpers/login_helper.rb

@@ -0,0 +1,3 @@
+module LoginHelper  
+  
+end

data/lib/generators/shopify_app/templates/app/helpers/tabs_helper.rb

@@ -0,0 +1,10 @@
+module TabsHelper
+  # Create a tab as <li> and give it the id "current" if the current action matches that tab
+  def tab(name, url, options = {})
+    if controller.action_name =~ (options[:highlight] = /#{name}/i)
+      content_tag :li, link_to(options[:label] || name.to_s.capitalize, url, {:id => "current"})
+    else
+      content_tag :li, link_to(options[:label] || name.to_s.capitalize, url)
+    end    
+  end
+end

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

@@ -0,0 +1,164 @@
+<h1 class="blue">Overview of the styles used</h1>
+
+<div class="info">
+  <%= image_tag '/images/info.gif', :style => "float:left" %>
+  <p>You are free to use this demo application as a base to create new applications that use the Shopify API.</p>
+</div>
+
+<table id="style-table">
+  <tr>
+    <td style="width: 33%">
+      <pre><code>&lt;h1&gt;Lorem ipsum&lt;/h1&gt;</code></pre>
+    </td>
+    
+    <td style="width: 66%">
+      <h1>Lorem ipsum</h1>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <pre><code>&lt;h2&gt;Lorem ipsum&lt;/h2&gt;</code></pre>
+    </td>
+    
+    <td>
+      <h2>Lorem ipsum</h2>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <pre><code>&lt;h3&gt;Lorem ipsum&lt;/h3&gt;</code></pre>
+    </td>
+    
+    <td>
+      <h3>Lorem ipsum</h3>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <pre><code>&lt;h4&gt;Lorem ipsum&lt;/h4&gt;</code></pre>
+    </td>
+    
+    <td>
+      <h4>Lorem ipsum</h4>
+    </td>
+  </tr>    
+
+  <tr>
+    <td>
+      <pre><code>&lt;p&gt;&hellip;&lt;/p&gt;</code></pre>
+    </td>
+    
+    <td>
+      <p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <pre><code>&lt;p class="note"&gt;&hellip;&lt;/p&gt;</code></pre>
+    </td>
+    
+    <td>
+      <p class="note">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <pre><code>&lt;span class="highlight"&gt;&hellip;&lt;/span&gt;</code></pre>
+    </td>
+    
+    <td>
+      <span class="highlight">Lorem ipsum dolor sit amet</p>
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <pre><code>&lt;h3 class="blue"&gt;&hellip;&lt;/h3&gt;</code></pre>
+    </td>
+    
+    <td>
+      <h3 class="blue">Lorem ipsum</h3>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <pre><code>&lt;h3 class="green"&gt;&hellip;&lt;/h3&gt;</code></pre>
+    </td>
+    
+    <td>
+      <h3 class="green">Lorem ipsum</h3>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <pre><code>&lt;h3 class="orange"&gt;&hellip;&lt;/h3&gt;</code></pre>
+    </td>
+    
+    <td>
+      <h3 class="orange">Lorem ipsum</h3>
+    </td>
+  </tr>  
+
+  <tr>
+    <td>
+      <pre><code>&lt;p class="blue"&gt;&hellip;&lt;/p&gt;</code></pre>
+    </td>
+    
+    <td>
+      <p class="blue">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <pre><code>&lt;p class="green"&gt;&hellip;&lt;/p&gt;</code></pre>
+    </td>
+    
+    <td>
+      <p class="green">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
+    </td>
+  </tr>
+  <tr>
+    <td>
+      <pre><code>&lt;p class="orange"&gt;&hellip;&lt;/p&gt;</code></pre>
+    </td>
+    
+    <td>
+      <p class="orange">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
+    </td>
+  </tr>  
+
+  <tr>
+    <td>
+      <pre><code>&lt;div class="box"&gt;<br />&nbsp;&nbsp;&lt;div class="wrapper"&gt;&hellip;&lt;/div&gt;<br />&lt;/div&gt;</code></pre>
+    </td>
+    
+    <td>
+      <div class="box"><div class="wrapper">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</div></div>
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <pre><code>&lt;p class="dark"&gt;&hellip;&lt;/p&gt;</code></pre>
+    </td>
+    
+    <td>
+      <p class="dark">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
+    </td>
+  </tr>
+
+  <tr>
+    <td>
+      <pre><code>&lt;p class="light"&gt;&hellip;&lt;/p&gt;</code></pre>
+    </td>
+    
+    <td>
+      <p class="light">Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.</p>
+    </td>
+  </tr>
+
+
+
+</table>

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

@@ -0,0 +1,103 @@
+<div id="sidebar">
+  <h3>Where to start</h3>
+  <h4>Check out the <code style="font-size: 140%">home_controller</code></h4>
+
+  <p class="description">
+    The controller in this demo application fetches the latest 3 orders and products and makes them available as instance variables <code style="color: #218BCE">@orders</code> and <code style="color: #218BCE">@products</code>.
+  </p>
+
+  <h4>Check out the <code>index</code> template</h4>
+
+  <p class="description">
+    This is the Ruby template you are currently looking at. It is located at:<br />  
+  </p>
+
+  <p style="background: #fff; margin-left: 4px"><code>views/home/index.html.erb</code></p>
+
+  <p class="description">
+    Have a look at the markup and Ruby code to see how the Shopify API is being used.
+  </p>
+  
+  <h3>Additional documentation</h3>
+
+  <p class="description">
+    Become an expert:
+  </p>
+
+  <ul>
+    <li>
+      <%= link_to 'API documentation', 'http://www.shopify.com/developers/api/' %>
+      <span class="note">The reference: what you can do with the Shopify API.</span>
+    </li>
+    <li>
+      <%= link_to 'Wiki', 'http://wiki.shopify.com/' %>
+      <span class="note">Get more information and share your knowledge.</span>
+    </li>
+    <li>
+      <%= link_to 'Forum', 'http://forums.shopify.com/community' %>
+      <span class="note">Ask questions and see what others already wanted to know.</span>
+    </li>
+  </ul>
+
+  <h3>Once you're ready</h3>
+
+  <p class="description">
+    We'd love to see what you create using the Shopify API. 
+    Find out how to share your application with the world and read the latest information on the <%= link_to 'API Publishing Page', 'http://www.shopify.com/developers/publishing/' %>.
+  </p>
+</div>
+
+
+<div id="orders">
+  <h2>Your recent orders</h2>
+
+  <% if @orders.blank? %>  
+
+    <em class="note">There are no orders in your store.</em>
+
+  <% else %>
+
+    <ul>
+    <% @orders.each do |order| %>
+      <li>
+        <div class="order box">
+          <div class="wrapper">
+            <strong><%= link_to order.name, "http://#{current_shop.url}/admin/orders/#{order.id}" %></strong>
+            <span class="price"><%= order.total_price %> <%= order.currency %></span>
+            <span class="highlight"><%= order.financial_status %></span>
+            by <span class="note"><%= order.billing_address.name %></span>
+          </div>
+        </div>
+      </li>
+    <% end %>
+    </ul>
+
+  <% end %>
+</div>
+
+
+<h2>Some of your products</h2>
+
+<% if @products.blank? %>
+
+  <em class="note">There are no products in your store.</em>
+
+<% else %>
+
+  <% @products.each do |product| %>
+    <div class="product box">
+      <div class="wrapper">
+        <%= image_tag product.images.first.small rescue '' %>
+
+        <h4><%= link_to product.title, "http://#{current_shop.url}/admin/products/#{product.id}" %></h4>
+
+        <p class="price"><%= product.price_range %> <%= current_shop.shop.currency %></p>
+        <p style="margin-bottom: 0"><%= product.product_type %> <span class="note">type</span></p>
+        <p style="margin: 0"><%= product.vendor %> <span class="note">vendor</span></p>
+      
+        <div style="clear:left"></div>
+      </div>
+    </div>
+  <% end %>
+
+<% end %>

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

@@ -0,0 +1,110 @@
+<h1 class="green">Welcome</h1>
+
+<p>
+  This is an example Shopify application that shows what you can do with the Shopify API.
+</p>
+
+<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/>
+  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/>
+
+  <p><strong>Note:</strong> There are no examples for <em>creating or editing</em> objects, but you are also able to do that with the Shopify API!</p>
+</div>
+
+<h3>1. Make sure you've entered a valid <em>API-Key</em> and <em>Secret</em></h3>
+
+<ul style="list-style-type: lower-alpha;">
+  <li>
+    <p>
+      If you haven't registered your application yet, then enter your shop's <strong>URL</strong> or <strong>subdomain</strong> here:<br/>
+    </p>
+    
+    <div class="box grey" style="width: 500px;text-align: center">
+      <script type="text/javascript" charset="utf-8">
+        function getApiUrl() {
+          var name = $('shop').value; 
+          if (name.indexOf('.') == -1) {
+            var api_url = name + '.myshopify.com';
+          } else {
+            var api_url = name.replace(/^https?:\/\//, ''); // Remove the "http://"
+          }
+          api_url = api_url.replace(/\/$/, ''); // Trim trailing slashes
+          $('api-form').action = 'http://' + api_url + '/admin/api_clients/new';
+        }
+      </script>
+      
+      <% form_tag '', :method => 'get', :id => 'api-form', :onsubmit => "getApiUrl(); return true;", :style => 'margin-left: 16px;' do %>
+        <%= text_field_tag 'shop', '', :size => 40 %>
+        <%= hidden_field_tag 'api_client[return_url]', @callback_url %>
+        <%= submit_tag 'Get API key' %>
+      <% end %>
+    </div>
+
+    <p>
+      After registering your application with Shopify, you need to edit the <code>config/shopify.yml</code> file,
+      and insert your <em>API-Key</em> and <em>Secret</em> there. Then restart this application.
+    </p>
+  </li>
+  <li>
+    <p><strong>If you've already supplied those to the generator</strong>, then move on to <%= link_to 'Step #2', '#callback-step' %>.</p>
+  </li>
+</ul>
+
+<h3 id="callback-step">2. Make sure your <em>callback URL</em> is correct</h3>
+
+The URL should be <code><%= @callback_url %></code>, 
+with the host portion of the URL pointing to whichever domain is currently hosting this application. <br/> 
+The callback URL of your app can be changed in the API screen of your Shopify admin interface.
+
+<h3>3. <%= link_to 'Login', '/login' %> to your shop</h3>
+
+<div class="border-wrap">
+  <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/>
+    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/>
+    
+    <p><strong>Note:</strong> There are no examples for <em>creating or editing</em> objects, but you are also able to do that with the Shopify API!</p>
+  </div>
+</div>
+
+<h3>4. Check out the source code of the <code>home_controller</code> and its <code>index</code> template</h3>
+
+<p class="description">
+  You can analyze those files to see how the ShopifyAPI is used and get a glimpse of what's possible.
+</p>
+
+<h3>5. Read additional documentation</h3>
+
+<p class="description">
+  Become an expert.
+</p>
+
+<ul>
+  <li>
+    <%= link_to 'API documentation', 'http://www.shopify.com/developers/api' %>
+    <span class="hint">(An overview of what you can do with the Shopify API.)
+  </li>
+  <li>
+    <%= link_to 'Wiki (needs its own API section)', 'http://wiki.shopify.com/' %>
+    <span class="hint">(Get more information and share your knowledge.)
+  </li>
+  <li>
+    <%= link_to 'Forum (needs its own API section)', 'http://forums.shopify.com/community' %>
+    <span class="hint">(Ask questions and see what others already wanted to know.)
+  </li>
+</ul>
+
+<h3>6. Publish your application</h3>
+
+<p class="description">
+  This feature is not implemented yet, but it in the future it will allow you to register your application, 
+  so that will be shown in a public directory with a description, so that more users will take notice of it.
+</p>

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

@@ -0,0 +1,39 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Shopify Application</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+
+<body>
+  <div id="header">
+    <h1><%= link_to 'Shopify Demo Application', '/' %></h1>
+    
+    <p id="login-link">
+      <% if current_shop %>
+          <span class="note">current shop</span> <%= link_to current_shop.url, "http://#{current_shop.url}", :class => 'shop_name' %> <span class="note">|</span>
+          <%= link_to 'logout', :controller => "login", :action => 'logout' %>
+      <% end %>
+    </p>
+  </div>
+
+  <div id="container" class="clearfix">
+    <ul id="tabs">
+      <%= tab :index, {:controller => 'home'}, :label => 'Home' %>
+      <%= tab :design, {:controller => 'home', :action => 'design'}, :label => 'Design Help' %>
+    </ul>
+    
+    <!-- Flash error & notice-->
+    <% if flash[:error] %> <div id="flasherrors"><%= flash[:error] %></div><% end %>
+    <% if flash[:notice] %><div id="flashnotices"><%= flash[:notice] %></div><% end %>
+  
+    <!-- begin div.main-->
+    <div id="main">
+      <%= yield %>
+    </div>
+    <!-- end div.main -->
+  </div>
+</body>
+</html>

data/lib/generators/shopify_app/templates/app/views/login/index.html.erb

@@ -0,0 +1,15 @@
+<h1>Install</h1>
+
+<p>Install this app in a shop to get access to its private admin data.</p>
+
+<p style="padding-bottom: 1em"><span class="hint">Don&rsquo;t have a shop to install your app in handy? <a href="https://app.shopify.com/services/partners/api_clients/test_shops">Create a test shop.</a></span></p>
+
+<%= form_tag '/login/authenticate' do %>
+  <label for='shop'><strong>The URL of the Shop</strong>
+    <span class="hint">(or just the subdomain if it&rsquo;s at myshopify.com)</span>
+  </label>
+  <p>
+    <%= text_field_tag 'shop', nil, {:size => 45} %>
+    <%= submit_tag 'Install' %>
+  </p>
+<% end %>

data/lib/generators/shopify_app/templates/public/stylesheets/application.css

@@ -0,0 +1,285 @@
+body {
+  margin: 0;
+  font: 0.8em/1.3em "Lucida Grande", Arial, Arial, sans-serif; 
+  background: #ededed;
+}
+
+h1 { font-weight: normal; font-size: 24px; }
+h1 a { color: #FFFAD5; text-decoration: none; }
+h2 { font-weight: normal; margin-top: 24px; }
+h3 { margin-top: 24px; }
+
+#header {
+  background: #2d3337 url('../images/shopify-logo.png') 20px 50% no-repeat;
+  padding: 25px 25px 25px 70px;
+  border-top: 5px solid #1f2326;
+  border-bottom: 1px solid #252a2e;
+}
+
+#header h1 { color: #fffad5; }
+
+#login-link {
+  float: right;
+  position: relative;
+  bottom: 43px;
+  right: 15px;
+  color: #ededed;
+}
+
+#login-link a { color: #ebff7c; }
+#login-link a:hover { text-decoration: underline; }
+#login-link a.shop_name { color: inherit; text-decoration: none; }
+#login-link a.shop_name:hover { text-decoration: underline; }
+
+#container {
+  width: 90%;
+  min-width: 800px;
+  margin: 40px auto;
+  background: #fff;
+  border-right: 1px solid #e5e5e5;
+  border-bottom: 1px solid #e5e5e5;
+}
+
+#container h1 { margin: 18px 0 27px 0; }
+
+#main { padding: 18px; }
+
+#tabs {
+  margin: 0;
+  padding: 0;
+  height: 20px;
+  position: absolute;
+  top: 123px;
+}
+
+#tabs li {
+  margin: 0;
+  padding: 0;
+  display: inline;
+  list-style-type: none;
+}
+
+#tabs a:link, #tabs a:visited {
+  float: left;
+  padding: 3px 8px  ;
+  margin: 0 10px 4px 0px;
+  text-decoration: none;
+  color: #888;
+  background: #ddd;
+}
+
+#tabs a:link#current, #tabs a:visited#current, #tabs a:hover { color: #000 !important; }
+#tabs a:link#current, #tabs a:visited#current { font-weight: bold; background: #fff; }
+
+a { color: #22658b; }
+a:hover { color: #359cd7; }
+
+dl { margin: 10px 15px; }
+dt { margin: 10px 0; }
+dd { margin: 5px 0 15px 0; }
+dl input { margin: 0 !important; }
+
+code { font-size: 140%; }
+
+/* UTILITY CLASSES */
+
+.clearfix:after {
+  content: "."; 
+  display: block; 
+  height: 0; 
+  clear: both; 
+  visibility: hidden;
+}
+
+.clearfix {display: inline-table;}
+
+/* Hides from IE-mac \*/
+* html .clearfix {height: 1%;}
+.clearfix {display: block;}
+/* End hide from IE-mac */
+
+.ta-left { text-align: left; }
+.ta-right { text-align: right; }
+.ta-center { text-align: center; }
+.pl { padding-left: 10px !important; }
+.note { color: #777; font-size: 85%; }
+.highlight { background: #ffc; }
+
+/*
+ * LOGIN / WELCOME
+ */
+
+#left, #right {
+  width: 40%;
+  float: left;
+  margin: 0 2% 30px 2%;
+}
+
+#left { min-width: 390px; }
+
+#logout { float: right; margin: 10px; }
+#logout a { color: #330; }
+
+/*
+ * DASHBOARD
+ */
+
+.order, .product { width: 55%; }
+.product { margin: 10px; } 
+
+.product img {
+  margin: 0 10px 0 0;
+  float: left;
+}
+
+.product h4 {
+  margin: 0 0 12px 0;
+  font-size: 14px;
+}
+
+.price {
+  color: #666;
+  font-size: 15px;
+  font-family: Times, "Times New Roman";
+  font-style: italic;
+}
+
+#orders ul {
+  list-style-type: none; 
+  padding: 0 0 0 7px;
+}
+
+#orders li { padding: 3px; }
+
+#sidebar {
+  float: right; 
+  width: 280px; 
+  background: #f5fbfe; 
+  border-left: 1px solid #D7E4EA; 
+  color: #003366; 
+  padding: 0 20px 20px 20px;
+  margin-bottom: 18px;
+}
+
+#sidebar ul {
+  padding-left: 20px;
+  list-style-type: square;
+}
+
+#sidebar li { margin: 8px 0; }
+
+/* STYLE OVERVIEW */
+
+#style-table { margin: 20px 0; }
+#style-table td * { margin: 0; }
+#style-table td { padding: 10px; border-bottom: 1px dotted #e5e5e5; }
+#style-table td:first-child {
+  background:#Fefefe url('../images/box-bg2.gif') repeat-x scroll left bottom;
+}
+/* Flash */
+
+#flasherrors, #flashnotices {
+  background: #faf7ea;
+  border-bottom: 1px solid #e8e6d9;
+	padding: 10px;
+  font-weight: bold;
+  text-align:center;
+}
+
+#flasherrors { color: #6e290b; }
+#flashnotices { color: #549d19; }
+
+/* CLASSES */
+
+.description {
+	margin: 0px 0px 0px 4px; 
+	font-weight: normal;
+}
+
+.box {
+  padding: 0;
+  background:#FAFAFA url('../images/box-bg2.gif') repeat-x scroll left top;
+  border:1px solid #CCCCCC;
+}
+
+.wrapper {
+  border:1px solid #FFFFFF;
+  padding: 10px;
+}
+
+.info {
+	padding: 0;
+	margin: 8px auto;
+	background: #009ad6 url('../images/info-bg.gif') top left repeat-x;
+  border: 1px solid #61abda;
+  font: 1.2em/1.7em "Comic Sans MS"; 
+  color: #fff;
+  height: 85px;
+}
+
+.info code {
+  font-size: 14px;
+  background: none;
+}
+
+.info a { color: #fff; }
+.info a:hover { color: #dcfaff; }
+
+.grey {
+  background: #eee;
+  border: 1px solid #ccc;
+}
+
+.green, .orange, .blue { padding: 10px; }
+h1.green, h2.green, h3.green, h1.orange, h2.orange, h3.orange, h1.blue, h2.blue, h3.blue { padding: 0; }
+
+.green {
+  background: #61b41e;
+  border: 1px solid #60b31d;
+  color: #ddecd0;
+}
+
+h1.green, h2.green, h3.green {
+  color: #6ece21;
+  background: none;
+  border: none;
+}
+
+.orange {
+  background: #ce6e21;
+  border: 1px solid #bc641e;
+  color: #fce0ca;
+  padding: 10px;
+}
+
+h1.orange, h2.orange, h3.orange {
+  color: #ce6e21;
+  background: none;
+  border: none;
+}
+
+.blue {
+  background: #218bce;
+  border: 1px solid #1e80be;
+  color: #d9ecf8;
+  padding: 10px;
+}
+
+h1.blue, h2.blue, h3.blue {
+  color: #218bce;
+  background: none;
+  border: none;
+}
+
+.light {
+  background: #faf7ea;
+  border: 1px solid #e8e6d9;
+  padding: 18px;
+}
+
+.dark {
+  background: #333;
+  border: 1px solid #000;
+  color: #fff;
+  padding: 10px;
+}

data/lib/shopify_app.rb

@@ -0,0 +1,17 @@
+require 'shopify_api'
+
+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/login_protection'
+require 'shopify_app/configuration'
+require 'shopify_app/railtie'
+require 'shopify_app/version'

data/lib/shopify_app/configuration.rb

@@ -0,0 +1,6 @@
+class ShopifyApp::Configuration
+  
+  attr_accessor :api_key
+  
+  attr_accessor :secret
+end

data/lib/shopify_app/login_protection.rb

@@ -0,0 +1,21 @@
+module ShopifyApp::LoginProtection
+
+  def shopify_session
+    if session[:shopify]
+      begin
+        # session[:shopify] set in LoginController#finalize
+        ShopifyAPI::Base.site = session[:shopify].site
+        yield
+      ensure 
+        ShopifyAPI::Base.site = nil
+      end
+    else
+      session[:return_to] = request.fullpath
+      redirect_to :controller => 'login'
+    end
+  end
+  
+  def current_shop
+    session[:shopify]
+  end
+end

data/lib/shopify_app/railtie.rb

@@ -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, :current_shop
+  end
+  
+  initializer "shopify_app.setup_session" do
+    ShopifyApp.setup_session
+  end
+end

data/lib/shopify_app/version.rb

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

data/shopify_app.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "shopify_app/version"
+
+Gem::Specification.new do |s|
+  s.name        = "shopify_app"
+  s.version     = ShopifyApp::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = "Shopify"
+  s.email       = ["edward@shopify.com", "jonathan@shopify.com", "willem@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.rubyforge_project = "shopify-api"
+
+  s.add_runtime_dependency('rails', '~> 3')
+  s.add_runtime_dependency('shopify_api')
+  
+  s.add_development_dependency('rake')
+
+  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

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification 
+name: shopify_app
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Shopify
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-26 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        version: "3"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shopify_api
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+description: Creates a basic login controller for authenticating with your Shop and also a product controller which lets your edit your products easily.
+email: 
+- edward@shopify.com
+- jonathan@shopify.com
+- willem@shopify.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- CHANGELOG
+- Gemfile
+- README.rdoc
+- Rakefile
+- install.rb
+- lib/generators/shopify_app/README
+- lib/generators/shopify_app/USAGE
+- lib/generators/shopify_app/shopify_app_generator.rb
+- 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/helpers/home_helper.rb
+- lib/generators/shopify_app/templates/app/helpers/login_helper.rb
+- lib/generators/shopify_app/templates/app/helpers/tabs_helper.rb
+- lib/generators/shopify_app/templates/app/views/home/design.html.erb
+- 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/public/images/box-bg2.gif
+- lib/generators/shopify_app/templates/public/images/info-bg.gif
+- lib/generators/shopify_app/templates/public/images/info.gif
+- lib/generators/shopify_app/templates/public/images/shopify-logo.png
+- lib/generators/shopify_app/templates/public/stylesheets/application.css
+- lib/shopify_app.rb
+- lib/shopify_app/configuration.rb
+- lib/shopify_app/login_protection.rb
+- lib/shopify_app/railtie.rb
+- lib/shopify_app/version.rb
+- shopify_app.gemspec
+has_rdoc: true
+homepage: http://www.shopify.com/developers
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: shopify-api
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: This gem is used to get quickly started with the Shopify API
+test_files: []
+