sinatra-shopify 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jesse Storimer
+
+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 PURPOa AND
+NONINFRINGEMENT. IN NO EVENT SaALL 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,45 @@
+Sinatra-Shopify: A classy shopify_app
+====================================
+
+This is a Sinatra extension that allows you to work with the "Shopify API":http://shopify.com/developers. It's basically just a port of the "shopify_app":http://github.com/Shopify/shopify_app rails plugin to sinatra.
+
+== Why?
+
+I have been "having fun working on Shopify apps":http://www.jstorimer.com/blogs/my-blog/1133402-shopify-api-extensions lately, but I needed a simpler way than always generating a new rails app, new controllers, etc., for every little idea.
+
+Rails is great, but most of the "Shopify apps":http://apps.shopify.com that I have come up with are one page apps, maybe two or three pages. The point is, I don't need a controller for that, I don't need the 63 files or however many the rails generator generates for me.
+
+Sinatra is most awesome when you are working on a small app with just a few routes. You can clone this app and use it as a starting point for a shopify_app. All of the authentication logic/routes are in the lib folder, so they don't pollute the code of your app.
+
+So in app.rb, you just have to worry about the functionality of your app.
+
+== Usage
+
+Installable from rubygems as 'sinatra-shopify'.
+
+The current implementation for authentication is to add the @authorize!@ method at the top of any routes that you want to be authenticated, like so:
+
+```ruby
+get '/sensitive_data' do
+  authorize!
+  
+  # then do the sensitive stuff
+end
+```
+
+Example
+======
+
+This repo includes an example Sinatra app. The fastest way to get it running:
+
+* @git clone git://github.com/jstorimer/sinatra-shopify@
+* @cd sinatra-shopify@
+* @heroku create@ (make sure that you remember the name of your app as you will need that later)
+* visit the "Shopify Partners area":http://app.shopify.com/services/partners
+* Sign up for an account if you don't already have one
+* Log in to your Shopify partners account
+* Create a new application.
+* Make sure that the Callback URL is set to http://_yourapp_.heroku.com/login/finalize
+* In the lib/sinatra/shopify.yml file replace API_KEY and SECRET with the Api Key and Secret that you just got from the Shopify Partners area
+* @git push heroku master@
+* @heroku open@

data/lib/sinatra/shopify.rb

@@ -0,0 +1,81 @@
+require 'sinatra/base'
+require 'shopify_api'
+
+module Sinatra
+  module Shopify
+
+    module Helpers
+      def current_shop
+        session[:shopify]
+      end
+
+      def authorize!
+        redirect '/login' unless current_shop
+
+        ShopifyAPI::Base.site = session[:shopify].site
+      end
+
+      def logout!
+        session[:shopify] = nil
+      end
+    end
+
+    def self.registered(app)
+      app.helpers Shopify::Helpers
+      app.enable :sessions
+
+      app.template :login do
+        <<-SRC
+        <h1>Login</h1>
+
+        <p>
+          First you have to register this app with a shop to allow access to its private admin data.
+        </p>
+
+        <form action='/login/authenticate' method='post'>
+          <label for='shop'><strong>The URL of the Shop</strong>
+            <span class="hint">(or just the subdomain if it's at myshopify.com)</span>
+          </label>
+          <p>
+            <input type='text' name='shop' />
+          </p>
+          <input type='submit' value='Authenticate' />
+        </form>
+          SRC
+      end
+
+      unless ENV['SHOPIFY_API_KEY'] && ENV['SHOPIFY_API_SECRET']
+        puts "Set your Shopify api_key and secret via ENV['SHOPIFY_API_KEY'] and ENV['SHOPIFY_API_SECRET']"
+      end
+      ShopifyAPI::Session.setup(:api_key => ENV['SHOPIFY_API_KEY'], :secret => ENV['SHOPIFY_API_SECRET'])
+
+      app.get '/login' do
+        erb :login
+      end
+      
+      app.get '/logout' do
+        logout!
+        redirect '/'
+      end
+
+      app.post '/login/authenticate' do
+        redirect ShopifyAPI::Session.new(params[:shop]).create_permission_url
+      end
+      
+      app.get '/login/finalize' do
+        shopify_session = ShopifyAPI::Session.new(params[:shop], params[:t])
+        if shopify_session.valid?
+          session[:shopify] = shopify_session
+
+          return_address = session[:return_to] || '/'
+          session[:return_to] = nil
+          redirect return_address
+        else
+          redirect '/login'
+        end
+      end
+    end
+  end
+
+  register Shopify
+end

data/sinatra-shopify.gemspec

@@ -0,0 +1,18 @@
+Gem::Specification.new do |s|
+  s.name = 'sinatra-shopify'
+  s.version = '1.0.0'
+
+  s.summary     = "A classy shopify_app"
+  s.description = "A Sinatra extension for working with the Shopify API. Akin to the shopify_app gem but for Sinatra"
+
+  s.authors = ["Jesse Storimer"]
+  s.email = "jesse@gmail.com"
+  s.homepage = "https://github.com/jstorimer/sinatra-shopify/"
+
+  s.files = Dir.glob('lib/**/*.rb')
+  s.files += ['README.md', 'LICENSE', 'sinatra-shopify.gemspec']
+
+  s.add_dependency 'sinatra',     '~> 1.0'
+  s.add_dependency 'shopify_api', '~> 1.2'
+end
+

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: sinatra-shopify
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Jesse Storimer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-24 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  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 
+        hash: 11
+        segments: 
+        - 1
+        - 2
+        version: "1.2"
+  type: :runtime
+  version_requirements: *id002
+description: A Sinatra extension for working with the Shopify API. Akin to the shopify_app gem but for Sinatra
+email: jesse@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/sinatra/shopify.rb
+- README.md
+- LICENSE
+- sinatra-shopify.gemspec
+homepage: https://github.com/jstorimer/sinatra-shopify/
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A classy shopify_app
+test_files: []
+