shopify-sinatra-app 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ecb9d81878d71aa112a589d76932f041c53e1d9a
-  data.tar.gz: 81d6eb212418d81c89fbad68595d3b6fdcde01b9
+  metadata.gz: 553b8af66b43f827feabdaafecbb73e36fd24ebb
+  data.tar.gz: 47b7c7fcf76e78fccfb081f74980ad5a989d591a
 SHA512:
-  metadata.gz: a9738522aa12eec39f3b87267a0a72af1b01788dcdc0acba8280b83b53fabb28ae71dad9ef9a19329fd62f273ebf4abd014f9f07fbb7db3ee9dc61ba5997bad7
-  data.tar.gz: 176f8fc34e159c4f01ea4eb9f5f779a6bc4ff29a85fab83562c8d78c01bb2448a9848cea1484b3960cb3bad5002208705bc622a518b8b152df82418e8fe5e644
+  metadata.gz: 6e1871bf85da48aa12e719f526603557796cd1881f6afbb9c421ed27159319fd3b389b281ed27777a0c98dfca4ddb403f5c4730021320a0b425014e8741e1530
+  data.tar.gz: 2dd73b4cc83692cc4edd42f0405bfc46caa0ac052066a1ac02a3e9c360d92bf0aeeb2e0f47ecf9618437ebcade35debff86911e8b055c45de057ceeb0235f7be

data/README.md

@@ -58,6 +58,10 @@ This will create a new skeleton shopify-sinatra-app. The generator will create s
 
 You'll need to create a Shopify Partner Account and a new application. You can make an account [here](http://www.shopify.ca/partners) and see this [tutorial](http://docs.shopify.com/api/the-basics/getting-started) for creating a new application.
 
+Note - The shopify-sinatra-app creates an embedded app! You need change the embedded setting to enabled in the [Shopify Partner area](https://app.shopify.com/services/partners/api_clients) for your app. If you don't want your app to be embedded then remove the related code in `layout/application.erb` and delete the `layout/_top_bar.erb` file and the references to it in the other views.
+
+Also note that when developing locally you'll need to enable unsafe javascripts in your browser for the embedded sdk to function. Read more [here](http://docs.shopify.com/embedded-app-sdk/getting-started)
+
 After creating your new application you need to create a `.env` file and add the following lines:
 
 ```
@@ -121,7 +125,17 @@ end
 Deploying
 ---------
 
-This template was created with deploying to Heroku in mind. Heroku is a great cloud based app hosting provider that makes it incredibly easy to get an application into a product environment. To create a new heroku application download the [Heroku Toolbelt](https://devcenter.heroku.com/articles/quickstart) and create a new application:
+This template was created with deploying to Heroku in mind. Heroku is a great cloud based app hosting provider that makes it incredibly easy to get an application into a product environment.
+
+Before you can get started with Heroku you need to create a git repo for you application:
+
+```
+git init
+git add .
+git commit -m "initial commit"
+```
+
+Now you can create a new heroku application. Download the [Heroku Toolbelt](https://devcenter.heroku.com/articles/quickstart) and run the following command to create a new application:
 
 ```
 heroku apps:create <your new app name>
@@ -134,6 +148,26 @@ heroku addons:add heroku-postgresql
 heroku addons:add rediscloud
 ```
 
+Now we can deploy the new application to Heroku. Deploying to Heroku is as simple as pushing the code using git:
+
+```
+git push heroku master
+```
+
+A `rake deploy2heroku` command is included in the generated Rakefile which does just this.
+
+Now that our application is deployed we need to run `rake db:migrate` to initialize our database on Heroku. To do this run:
+
+```
+heroku run rake db:migrate
+```
+
+We also need to set our environment variables on Heroku. The environment variables are stored in `.env` and are not tracked by git. This is to protect your credentials in the case of a source control breach. Heroku provides a command to set environment variables: `heroku config:set VAR=foo`. In the generated Rakefile there is a helper method that will properly set all the variables in your `.env` file:
+
+```
+rake creds2heroku
+```
+
 and make sure you have at least 1 dyno for web and resque:
 
 ```
@@ -142,6 +176,8 @@ heroku scale web=1 resque=1
 
 Note - if you are not using any background queue for processing webhooks then you do not need the redis add-on or the resque dyno so you can set it to 0.
 
+Make sure you set your shopify apps url to your Heroku app url in the Shopify Partner area https://app.shopify.com/services/partners/api_clients.
+
 Contributing
 ------------
 

data/bin/shopify-sinatra-app-generator

@@ -24,11 +24,12 @@ else
     FileUtils.cp_r(generator_dir + "/public",    app_dir + "/public")
     FileUtils.cp_r(generator_dir + "/views",     app_dir + "/views")
 
+    FileUtils.cp(generator_dir   + "/.env",      app_dir + "/.env")
     FileUtils.cp(generator_dir   + "/config.ru", app_dir + "/config.ru")
     FileUtils.cp(generator_dir   + "/Procfile",  app_dir + "/Procfile")
     FileUtils.cp(generator_dir   + "/Rakefile",  app_dir + "/Rakefile")
-    FileUtils.cp(generator_dir   + "/Gemfile",  app_dir + "/Gemfile")
-    FileUtils.cp(generator_dir   + "/README.md",  app_dir + "/README.md")
+    FileUtils.cp(generator_dir   + "/Gemfile",   app_dir + "/Gemfile")
+    FileUtils.cp(generator_dir   + "/README.md", app_dir + "/README.md")
 
     Dir.chdir(app_dir)
 

data/lib/generator/.gitignore

@@ -0,0 +1 @@
+.env

data/lib/generator/Rakefile

@@ -3,46 +3,20 @@ require 'resque/tasks'
 require 'rake/testtask'
 require './lib/app'
 
-task :server do
-  pipe = IO.popen("bundle exec rackup config.ru -p 4567")
-  while (line = pipe.gets)
-    print line
-  end
+task :creds2heroku do
+  Bundler.with_clean_env {
+    File.readlines('.env').each do |var|
+      pipe = IO.popen("heroku config:set #{var}")
+      while (line = pipe.gets)
+        print line
+      end
+    end
+  }
 end
 
-task :deploy do
+task :deploy2heroku do
   pipe = IO.popen("git push heroku master --force")
   while (line = pipe.gets)
     print line
   end
 end
-
-task :clear do
-  Rake::Task["clear_products"].invoke
-  Rake::Task["clear_charities"].invoke
-  Rake::Task["clear_shops"].invoke
-end
-
-task :clear_shops do
-  Shop.delete_all
-end
-
-task :clear_charities do
-  Charity.delete_all
-end
-
-task :clear_products do
-  Product.delete_all
-end
-
-task :creds2heroku do
-  Bundler.with_clean_env {
-    api_key = `sed -n '1p' .env`
-    shared_secret = `sed -n '2p' .env`
-    secret = `sed -n '3p' .env`
-
-    `heroku config:set #{api_key}`
-    `heroku config:set #{shared_secret}`
-    `heroku config:set #{secret}`
-  }
-end

data/lib/generator/lib/app.rb

@@ -6,7 +6,7 @@ class SinatraApp < Sinatra::Base
   get '/' do
     # your app's Home page
     shopify_session do |shop_name|
-      @shop = Shop.find_by(:name => shop_name)
+      @shop_name = shop_name
       @products = ShopifyAPI::Product.all(limit: 5)
       erb :home
     end

data/lib/generator/views/home.erb

@@ -9,7 +9,7 @@
     <% @products.each do |product| %>
       <tr>
         <td>
-          <a href=<%="https://#{@shop.name}/admin/products/#{product.product_id}"%> target="_blank"> <%= product.product_id %> </a>
+          <a href=<%="https://#{@shop_name}/admin/products/#{product.id}"%> target="_blank"> <%= product.id %> </a>
         </td>
       </tr>
     <% end %>

data/shopify-sinatra-app.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'shopify-sinatra-app'
-  s.version = '0.0.1'
+  s.version = '0.0.2'
 
   s.summary     = "A classy shopify app"
   s.description = "A Sinatra extension for building Shopify Apps. Akin to the shopify_app gem but for Sinatra"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shopify-sinatra-app
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Kevin Hughes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -234,6 +234,7 @@ files:
 - LICENSE
 - README.md
 - bin/shopify-sinatra-app-generator
+- lib/generator/.gitignore
 - lib/generator/Gemfile
 - lib/generator/Procfile
 - lib/generator/README.md