shopify_app_lrb3 5.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0c161a8e46435589a6f6ce0bb35cd0531019b06e
+  data.tar.gz: fe0f9dcb3ddf9b8ccc61b79fbb7a43faf6a66b56
+SHA512:
+  metadata.gz: c2d8958764f430c420a0f748c090107dbcaabaa616aac82e3ac757f9ff42c6535d20bd4cb001fba680e2e7dd4c18229aeb61d7cc175a020ab4a837711c67454c
+  data.tar.gz: adba2d4c05acb67fea15431b99e1700d61f82e392b9533c7d6a15a0c2a3ba2267f4d4f8e2a96451733513784befaf50db9993165b05f24e083c22238a0e44b95

data/.gitignore

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

data/CHANGELOG

@@ -0,0 +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
+* Replace old LoginController with a RESTful SessionsController

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013 Shopify 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,182 @@
+# Shopify App
+
+[![Build Status](https://travis-ci.org/Shopify/shopify_app.png)](https://travis-ci.org/Shopify/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 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 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/apps/private.
+
+### 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 up your ShopifySessionRepository.store
+
+`ShopifySessionRepository` allows you as a developer to define how your sessions are retrieved and
+stored for a shop. This can simply be your `Shop` model that stores the API Token and shop name. If
+you are using ActiveRecord, then all you need to implement is `self.store(shopify_session)` and
+`self.retrieve(id)` in order to store the record on disk or retrieve it for use at a later point.
+It is imperative that your store method returns the identifier for the session. Typically this is
+just the record ID.
+
+Your ActiveRecord model would look something like this:
+
+```ruby
+class Shop < ActiveRecord::Base
+  def self.store(session)
+    shop = Shop.new(domain: session.url, token: session.token)
+    shop.save!
+    shop.id
+  end
+
+  def retrieve(id)
+    shop = Shop.find(id)
+    ShopifyAPI::Session.new(shop.domain, shop.token)
+  end
+end
+```
+
+By default you will have an in memory store but it really won't work on multi-server environments since
+they won't be sharing the static data that would be required in case your user gets directed to a
+different server by your load balancer.
+
+The in memory store also does not behave well on Heroku because the session data would be destroyed
+when a dyno is killed due to inactivity.
+
+Changing the `ShopifySessionRepository.storage` can simply be done by editing
+`config/initializers/shopify_session_repository.rb` to use the correct model.
+
+## 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://docs.shopify.com/api/the-basics/getting-started <= Read the docs!

data/RELEASING

@@ -0,0 +1,16 @@
+Releasing ShopifyApp
+
+1. Check the Semantic Versioning page for info on how to version the new release: http://semver.org
+2. Update the version of ShopifyApp in lib/shopify_app/version.rb
+3. Add a CHANGELOG entry for the new release with the date
+4. Commit the changes with a commit message like "Packaging for release X.Y.Z"
+5. Tag the release with the version (Leave REV blank for HEAD or provide a SHA)
+  $ git tag vX.Y.Z REV
+6. Push out the changes
+  $ git push
+7. Push out the tags
+  $ git push --tags
+8. Build the new .gem from the updated .gemspec
+  $ gem build shopify_app.gemspec
+9. Publish the Gem to gemcutter
+  $ gem push shopify_app-X.Y.Z.gem

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+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/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 Application URL to http://localhost:3000/login 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 Application URL of the application in your Shopify partner account 
+to <tt>http://localhost:3000/login</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 sessions 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 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
+
+    
+Examples:
+    script/generate shopify_app edffbb1bb793e2750686e6f4647a384a abbcee050...
+        
+    This will create a sessions controller and a home controller and views.

data/lib/generators/shopify_app/shopify_app_generator.rb

@@ -0,0 +1,69 @@
+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'
+    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/templates/app/assets/javascripts/application.js

@@ -0,0 +1,15 @@
+// This is a manifest file that'll be compiled into including all the files listed below.
+// Add new JavaScript/Coffee code in separate files in this directory and they'll automatically
+// be included in the compiled file accessible from http://example.com/assets/application.js
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// If you need to customize any bootstrap js, we've placed the un-minified versions in
+// assets/javascripts/bootstrap including the test suite that ships with bootstrap.
+// Love,
+// Shopify
+//
+//= require jquery
+//= require jquery_ujs
+//= require twitter/bootstrap
+//= require_tree .

data/lib/generators/shopify_app/templates/app/assets/stylesheets/application.css

@@ -0,0 +1,10 @@
+/*
+ * This is a manifest file that'll automatically include all the stylesheets available in this directory
+ * and any sub-directories. You're free to add application-wide styles to this file and they'll appear at
+ * the top of the compiled file, but it's generally better to create a new file per style scope.
+ *= require_self
+ *= require twitter/bootstrap
+ *= require imports
+ *= require shopify_app_buttons
+ *= require shopify_app
+*/