sinatra-shopified 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2343b62036985b9109049add0a9645499b1ce6a6
+  data.tar.gz: 76739915fe2a7bf9015643e26d7ff3d03435be3c
+SHA512:
+  metadata.gz: 14f4e691a67039e50549f50a30cafefda82fc9ea96fb44d75a566dc320150b348f67a1111fa83d77ae0076700cf74f4fef211e99e6141525707663b5597e45d0
+  data.tar.gz: 8a6f8ec0c1a1e1ce391da8f3a7df0c53f56d37cd881786d94335bb4345624efee6e04669bc07e389227b268c472c2799122af537019e3626d0869766451810b5

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/Gemfile.lock
+/pkg/
+/sinatra-shopified-*.gem
+/doc
+/.yardoc
+/coverage
+/db/schema.rb
+/db/*.sqlite3

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - 2.1
+  - 2.2
+env:
+  - NO_COVERAGE=true
+before_script:
+  - bundle exec rake db:create
+  - bundle exec rake db:migrate
+  - bundle exec rake db:seed

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --protected --private lib/ - README.md LICENSE

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Tyler King
+
+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,187 @@
+# Sinatra::Shopified
+
+[![Build Status](https://secure.travis-ci.org/tyler-king/sinatra-shopified.svg?branch=master)](http://travis-ci.org/tyler-king/sinatra-shopified) [![Docs](https://inch-ci.org/github/tyler-king/sinatra-shopified.svg?branch=master)](https://inch-ci.org/github/tyler-king/sinatra-shopified)
+
+This is a work-in-progress extension for Sinatra which provides some basic helpers and routes to create a Sinatra-powered Shopify application.
+
+## Installation
+
+### Gem Installation
+
+Add this line to your application's Gemfile:
+
+``` ruby
+gem "sinatra-shopified"
+```
+
+Then, execute `bundle` to install then Gem.
+
+### Sinatra Installation
+
+This assumes you have ActiveRecord up and running and you are using a modular-style Sinatra application.
+
+In your Sinatra application, load the Gem:
+
+``` ruby
+require "sinatra/shopified"
+```
+
+Now, register it. As an example:
+
+``` ruby
+require "sinatra/base"
+require "sinatra/shopified"
+
+class MyCoolApp < Sinatra::Base
+  # ...
+  register Sinatra::Shopified
+  # ...
+end
+```
+
+#### ActiveRecord / Database Installation
+
+This Gem provides a model of Shop which contains a couple of basic columns (shop domain and token).
+
+Here is the migration for ActiveRecord if you wish to use it:
+
+``` ruby
+class Shop < ActiveRecord::Migration
+  def up
+    create_table :shops do |t|
+      t.string :shop
+      t.string :token, null: true
+    end
+  end
+
+  def down
+    drop_table :shops
+  end
+end
+```
+
+Alternatively, you can just load in the SQL:
+
+``` 
+CREATE TABLE `shops` (
+  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
+  `shop` text NOT NULL,
+  `token` text NULL,
+  PRIMARY KEY (`id`)
+) ENGINE=InnoDB DEFAULT CHARSET=utf8;
+```
+
+You can extends the built-in Shop model if need-be by doing the following in your own app:
+
+``` ruby
+module YourApp
+  module Models
+    class Shop < Sinatra::Shopified::Models::Shop
+      # Your extra code here
+    end
+  end
+end
+```
+
+## Configuration
+
+This Gem uses environment variables (`ENV`) for the Shopify config. [dotenv](https://rubygems.org/gems/dotenv) Gem is a great way to manage environment variables.
+
+Here is a guide for all required environment variables you can set:
+
+``` bash
+SHOPIFY_API_KEY='YOUR APP API KEY'
+SHOPIFY_API_SECRET='YOUR APP API PASSWORD'
+SHOPIFY_API_SCOPE='YOUR APP SCOPES' # Comma-separated example: "read_themes,write_themes"
+SHOPIFY_APP_REDIRECT_AFTER_AUTH='/' # Where to redirect after authentication is completed (example: /admin)
+```
+
+## Code Documentation
+
+YARD is used for documentation. Simply run `bundle exec yardoc` to generate the documentation of the code and open `doc/index.html` in your browser.
+
+## Testing
+
+For initial runs, simply setup the database, migrate the db, and load the seeds in.
+
+```bash
+bundle exec rake db:create
+bundle exec rake db:migrate
+bundle exec rake db:seed
+bundle exec rake test
+```
+
+## Usage
+
+There are a couple noteable helper methods.
+
+#### current_shop
+
+This will return the current authenticated shop from your database
+
+``` ruby
+You are <%= current_shop.shop %>
+```
+
+#### authorize_shop
+
+This is a helper method you can run which will ensure the shop can access the page. If it can, it will activate the shop's session with Shopify. If it can not, it will redirect the shop to the auth page.
+
+You can place this anywhere you need to use the Shopify API, such as at the top of a route.
+
+``` ruby
+class PendingController < Sinatra::Base
+  # ...
+  register Sinatra::Shopified
+  # ...
+  get "/admin" do
+    authorize_shop
+
+    product = ShopifyAPI::Product.find 1787887
+    # ...
+  end
+  # ...
+end
+```
+
+or, use it in a before filter:
+
+``` ruby
+# ...
+before do
+  authorize_shop if request.path.include? "/admin"
+end
+# ...
+```
+
+#### esdk_redirect
+
+If you are using ESDK and need to escape the iFrame to do a redirect (maybe go to /admin/products, an off-site link) this method can help.
+
+``` ruby
+  return esdk_redirect "https://#{current_shop.shop}/admin/products"
+```
+
+#### shopify_session_with
+
+Useful for if you wish to temporarily use the Shopify API with another shop.
+
+``` ruby
+shop = Shopified::Models::Shop.find_by(shop: "coolshop.myshopify.com")
+shopify_session_with shop do
+  ShopifyAPI::Product.find 42
+end
+```
+
+## Routes
+
+This module adds one route.
+
+#### /auth
+
+With the use of `authorize_shop` or simply visting `/auth`. When creating your app in the Partner section, set this as the `redirect_uri`.
+
+## License
+
+The Gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,25 @@
+begin
+  require "bundler/setup"
+rescue LoadError
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
+end
+
+Bundler::GemHelper.install_tasks
+
+require "sinatra/activerecord/rake"
+require "rake/testtask"
+
+namespace :db do
+  task :load_config do
+    require "./test/test_app"
+  end
+end
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/db/migrate/20160303165323_create_shop.rb

@@ -0,0 +1,12 @@
+class CreateShop < ActiveRecord::Migration
+  def up
+    create_table :shops do |t|
+      t.string :shop
+      t.string :token, null: true
+    end
+  end
+
+  def down
+    drop_table :shops
+  end
+end

data/db/seeds.rb

@@ -0,0 +1 @@
+Sinatra::Shopified::Models::Shop.create(shop: "existing_shop.myshopify.com", token: "a_token")

data/lib/sinatra/shopified.rb

@@ -0,0 +1,53 @@
+require "shopify_api"
+require "sinatra/base"
+require "sinatra/activerecord"
+require "sinatra/shopified/version"
+require "sinatra/shopified/helpers"
+require "sinatra/shopified/models"
+
+# Sinatra module namespace
+module Sinatra
+  # This Gem's module namespace
+  module Shopified
+    # Register the module with Sinatra
+    # @param [Object] app the Sinatra App
+    def self.registered(app)
+      # Register the helpers for this Gem
+      app.helpers Shopified::Helpers
+      
+      # Disable iFrame protection (for ESDK)
+      app.set :protection, except: :frame_options
+      
+      # Setup Shopify session with the app's credentials
+      ShopifyAPI::Session.setup(api_key: ENV["SHOPIFY_API_KEY"], secret: ENV["SHOPIFY_API_SECRET"])
+      
+      # Auth controller which handles creating shop sessions,
+      # hanlding app permissions, and more
+      app.get "/auth" do
+        # Setup our session
+        session[:shopify_domain] = params[:shop] if params.key?("shop")
+        api_session = ShopifyAPI::Session.new session[:shopify_domain]
+
+        if params.key? "code"
+          # Create the shop if its new, update the token, and activate the session
+          Models::Shop.create(shop: session[:shopify_domain]) unless current_shop
+          current_shop.update_attribute :token, api_session.request_token(params)
+          shopify_session_activate
+          
+          redirect to(ENV["SHOPIFY_APP_REDIRECT_AFTER_AUTH"])
+        else
+          # No code, lets ask for app permissions
+          redirect api_session.create_permission_url(ENV["SHOPIFY_API_SCOPE"].split(","), to("/auth", true))
+        end
+      end
+      
+      # Catch ant UnauthrorizedAccess from Shopify and redirect to auth
+      app.error ActiveResource::UnauthorizedAccess do
+        params[:shop] = session[:shopify_domain] if session[:shopify_domain]
+        authorize_shop_fallback
+      end
+    end
+  end
+  
+  register Shopified
+end

data/lib/sinatra/shopified/helpers.rb

@@ -0,0 +1,72 @@
+module Sinatra
+  module Shopified
+    # Helper module for the Gem
+    module Helpers
+      # Instance variable for storing shop object
+      attr_reader :shop
+      
+      # Grab the current shop from the database
+      # @return [Object, nil] the shop object
+      def current_shop
+        return nil if session[:shopify_domain] == nil
+        @shop ||= Models::Shop.find_by(shop: session[:shopify_domain])
+      end
+
+      # Activates Shopify session
+      def shopify_session_activate
+        api_session = ShopifyAPI::Session.new current_shop.shop, current_shop.token
+        ShopifyAPI::Base.activate_session api_session
+      end
+
+      # Clears all sessions
+      def shopify_session_clear
+        session[:shopify_domain] = nil
+        ShopifyAPI::Base.clear_session
+      end
+      
+      # Allowing using a temporary session for a shop
+      # @param [Object] shop the shop's object
+      # @example
+      #   shop = Shopify::Models::Shop.find(shop: "coolshop.myshopify.com")
+      #   shopify_session_with shop do
+      #     ShopifyAPI::Product.find 42
+      #   end
+      def shopify_session_with(shop, &block)
+        ShopifyAPI::Session.temp shop.shop, shop.token, &block
+      end
+        
+      # Clears session and reidrects to auth
+      def authorize_shop_fallback
+        shopify_session_clear
+        redirect to("/auth?shop=#{params[:shop]}")
+      end
+      
+      # Check if shop is authorized to view a page.
+      # If they are, we activate the Shopify session.
+      # If not, they are redirected to auth.
+      def authorize_shop
+        if current_shop == nil
+          # No session yet, or shop domains are different
+          authorize_shop_fallback.call
+        end
+        
+        if params[:shop] and session[:shopify_domain] != params[:shop]
+          # Shops are different
+          authorize_shop_fallback.call
+        end
+        
+        # Activate the session
+        shopify_session_activate
+      end
+  
+      # Forces a redirect to get out of the iFrame for embedded apps
+      # @param [String] redirect_url the URL to redirect to
+      # @return [String] the Javascript for redirecting
+      # @example
+      #  esdk_redirect "/admin/products"
+      def esdk_redirect(redirect_url)
+        "<script type='text/javascript'>top.window.location.href = '#{redirect_url}';</script>"
+      end
+    end
+  end
+end

data/lib/sinatra/shopified/models.rb

@@ -0,0 +1,19 @@
+module Sinatra
+  module Shopified
+    # Models for the Gem
+    module Models
+      # Base Shop model
+      class Shop < ActiveRecord::Base
+        validates_uniqueness_of :shop
+        validates_presence_of :shop
+        after_initialize :init
+  
+        private
+        # Initializer for a Shop
+        def init
+          self[:token] ||= nil
+        end
+      end
+    end
+  end
+end

data/lib/sinatra/shopified/version.rb

@@ -0,0 +1,6 @@
+module Sinatra
+  module Shopified
+    # Gem version
+    VERSION = "0.10.0"
+  end
+end

data/sinatra-shopified.gemspec

@@ -0,0 +1,32 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "sinatra/shopified/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra-shopified"
+  spec.version       = Sinatra::Shopified::VERSION
+  spec.authors       = ["Tyler King"]
+  spec.homepage      = "http://tylerking.me/"
+  spec.email         = ["tyler.n.king@outlook.com"]
+
+  spec.summary       = "Shopify apps with Sinatra"
+  spec.description   = "Provides some boilerplate helpers and routes for Shopify apps with Sinatra"
+  spec.homepage      = "https://github.com/tyler-king/sinatra-shopified"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "shopify_api", "~> 4.0"
+  spec.add_dependency "sinatra", "~> 1.4"
+  spec.add_dependency "sinatra-activerecord", "~> 2.0"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "inch", "~> 0.7"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rack-test", "~> 0.6"
+  spec.add_development_dependency "webmock", "~> 1.24"
+  spec.add_development_dependency "sqlite3", "~> 1.3"
+  spec.add_development_dependency "simplecov", "~> 0.11"
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-shopified
+version: !ruby/object:Gem::Version
+  version: 0.10.0
+platform: ruby
+authors:
+- Tyler King
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shopify_api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: sinatra-activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: inch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.24'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Provides some boilerplate helpers and routes for Shopify apps with Sinatra
+email:
+- tyler.n.king@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- db/migrate/20160303165323_create_shop.rb
+- db/seeds.rb
+- lib/sinatra/shopified.rb
+- lib/sinatra/shopified/helpers.rb
+- lib/sinatra/shopified/models.rb
+- lib/sinatra/shopified/version.rb
+- sinatra-shopified.gemspec
+homepage: https://github.com/tyler-king/sinatra-shopified
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Shopify apps with Sinatra
+test_files: []
+has_rdoc: