shopify-routes 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in shopify-routes.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Travis Haynes
+
+MIT License
+
+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,100 @@
+# Shopify::Routes
+
+Provides routes that redirect back to Shopify pages.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'shopify-routes'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install shopify-routes
+
+## Usage
+
+Adding the routes to your app is dead simple. All you need to do is add a single
+line of code to your `config/routes.rb` file. However, it's highly recommended
+that you add your routes to a namespace to prevent conflicts with your
+application. Here's an example of how to add all the Shopify routes under a
+`:shopify` namespace:
+
+    namespace :shopify do
+      ShopifyAPI::Routes.draw(self)
+    end
+
+You can also specify which routes you want to include, or exclude, as you would
+normally with a Rails resource:
+
+    ShopifyAPI::Routes.draw self, only: [ :orders, :products ]
+    ShopifyAPI::Routes.draw self, except: [ :articles, :blogs ]
+
+To include a referrer ID for the `:signup` and `:brochure` pages, add a
+`:referrer` option to the routes:
+
+    ShopifyAPI::Routes.draw self, :referrer => "travishaynes"
+
+The above example would route `shopify_brochure_path` to
+[http://www.shopify.com?ref=travishaynes](http://www.shopify.com?ref=travishaynes),
+and `shopify_signup_path` to
+[https://app.shopify.com/services/signup?ref=travishaynes](https://app.shopify.com/services/signup?ref=travishaynes).
+
+## Routes
+
+Here's a list of all the routes that will be added to your app, outside of any
+namespace to keep things simple.
+
+                      brochure        /
+                        signup        /signup(.:format)
+                         admin        /:shop/admin(.:format)
+                        orders        /:shop/admin/orders(.:format)
+                         order        /:shop/admin/orders/:id(.:format)
+                     customers        /:shop/admin/customers(.:format)
+                      customer        /:shop/admin/customers/:id(.:format)
+                  new_customer        /:shop/admin/customers/new(.:format)
+                      products        /:shop/admin/products(.:format)
+                       product        /:shop/admin/products/:id(.:format)
+                   new_product        /:shop/admin/products/new(.:format)
+            custom_collections        /:shop/admin/custom_collections(.:format)
+             custom_collection        /:shop/admin/custom_collections/:id(.:format)
+         new_custom_collection        /:shop/admin/custom_collections/new(.:format)
+             smart_collections        /:shop/admin/smart_collections(.:format)
+              smart_collection        /:shop/admin/smart_collections/:id(.:format)
+          new_smart_collection        /:shop/admin/smart_collections/new(.:format)
+                         pages        /:shop/admin/pages(.:format)
+                          page        /:shop/admin/pages/:id(.:format)
+                      new_page        /:shop/admin/pages/new(.:format)
+                         blogs        /:shop/admin/blogs(.:format)
+                          blog        /:shop/admin/blogs/:id(.:format)
+                      new_blog        /:shop/admin/blogs/new(.:format)
+                    navigation        /:shop/admin/links(.:format)
+                    promotions        /:shop/admin/marketing(.:format)
+                        themes        /:shop/admin/themes(.:format)
+                         theme        /:shop/admin/themes/:id(.:format)
+                theme_settings        /:shop/admin/themes:id/settings(.:format)
+              general_settings        /:shop/admin/general_preferences(.:format)
+                       regions        /:shop/admin/countries(.:format)
+                        region        /:shop/admin/countries/:id(.:format)
+                    new_region        /:shop/admin/countries/new(.:format)
+          checkout_and_payment        /:shop/admin/payments(.:format)
+                shipping_rates        /:shop/admin/shipping(.:format)
+    weight_based_shipping_rate        /:shop/admin/weight_based_shipping_rates/:id(.:format)
+     price_based_shipping_rate        /:shop/admin/price_based_shipping_rates/:id(.:format)
+          fulfillment_services        /:shop/admin/fulfillment_services(.:format)
+                 notifications        /:shop/admin/notifications(.:format)
+                  notification        /:shop/admin/notifications/:id(.:format)
+                       domains        /:shop/admin/domains(.:format)
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/shopify-routes/version.rb

@@ -0,0 +1,5 @@
+module ShopifyAPI
+  module Routes
+    VERSION = "0.0.1"
+  end
+end

data/lib/shopify-routes.rb

@@ -0,0 +1,441 @@
+require 'shopify_api'
+
+module ShopifyAPI
+  class << self
+    # use this in your `config/routes.rb` file to draw the Shopify routes
+    # @param [ActionDispatch::Routing::RouteSet] router The router
+    # @param [Hash] options The options for drawing the routes
+    # @option options [String] :referrer Your Shopify Partner referrer ID
+    # @option options [Array] :only An Array of resources to included in the routes
+    # @option options [Array] :except An Array of resources to exclude from the routes
+    # @example Draw all the Shopify routes
+    #     MyApp::Application.routes.draw do
+    #       ShopifyAPI::Routes.draw(self)
+    #     end
+    # @example Drawing only the Products and Orders routes
+    #     MyApp::Application.routes.draw do
+    #       ShopifyAPI::Routes.draw self, only: [:products, :orders]
+    #     end
+    # @example Drawing every route except for :custom_collections
+    #     MyApp::Application.routes.draw do
+    #       ShopifyAPI::Routes.draw self, except: [:custom_collections]
+    #     end
+    # @example Including a referrer ID
+    #     MyApp::Application.routes.draw do
+    #       ShopifyAPI::Routes.draw self, referrer: "travishaynes"
+    #     end
+    # @api public
+    def routes(router, options = {})
+      # cache the router
+      @router = router
+
+      # extract the referrer from the options, if it's included
+      @ref = "?ref=#{options[:referrer]}" if options.include? :referrer
+
+      # default namespace
+      options[:namespace] ||= :shopify
+
+      # extract the :only, or :except options, if they're included
+      @only = Array(options[:only]) if options.include?(:only)
+      @except = Array(options[:except]) if options.include?(:except)
+
+      # draw the routes
+      draw
+    end
+
+    private
+
+    # ensures a shop domain is suffixed with ".myshopify.com"
+    # @param [String] shop The shop's domain, with or without ".myshopify.com"
+    # @return [String] The shop's domain with ".myshopify.com"
+    # @api private
+    def shop_domain(shop)
+      shop =~ /.*myshopify\.com/ ? shop : shop + ".myshopify.com"
+    end
+
+
+    # draws a route for the given path, actions and alias
+    # @param [String] path The path for the route
+    # @param [Array] actions List of actions to draw for this route
+    # @param [String] nom Alias for the route if the path name does not suffice
+    # @api private
+    def match(path, actions, nom = path)
+
+      # only draw this route if it's included
+      return unless include?(path)
+
+      actions.each do |action|
+
+        # create the route, and it's name
+        route = ":shop/admin/#{path.to_s}"
+        name  = nom.to_s
+
+        case action
+
+        # route for show
+        when :show
+          route << "/:id"
+          name = name.singularize
+
+        # route for new
+        when :new
+          route << "/new"
+          name = "new_#{name.singularize}"
+
+        # custom routes
+        else
+          unless action == :index
+            route << action
+            action = ""
+          end
+        end
+
+        # draw the route
+        match_admin_path(
+          route       => name,
+          :action     => action,
+          :controller => "shopify_#{nom.to_s.pluralize}"
+        )
+      end
+
+    end
+
+
+    # generates a path to a resource in the Shopify namespace
+    # @param [String] path The path to match
+    # @param [String] resource The name of the resource - plural or singular
+    # @param [ActionDispatch::Routing::RouteSet] The router to add the matches
+    # @api private
+    def match_admin_path(options = {})
+
+      # use the router from the options, or the cached one
+      router = options[:router] || @router
+
+      # get the path and resource
+      path, resource = options.first
+
+      # default to using the resource for the named route
+      options[:as] ||= resource
+
+      # generate the match route
+      router.match path => router.redirect { |params, r|
+
+        # ensure the ".myshopify.com" suffix exists
+        shop = shop_domain(params[:shop])
+
+        # path to the shop's admin resource
+        uri = "https://#{shop}/admin/#{resource}"
+
+        # check if we need to include an id
+        uri << "/#{params[:id]}" if params.include?(:id)
+
+        # return the redirect URI
+        uri
+      },
+
+      :as         => options[:as],
+      :action     => options[:action],
+      :controller => options[:controller]
+
+    end
+
+
+    # checks if a resource should be included in the routes
+    # @param [Symbol] name The name of the resource
+    # @return [Boolean] true when it should be included
+    # @api private
+    def include?(name)
+      (@only.nil? && @except.nil?) ||
+      (!@only.nil? && @only.include?(name)) ||
+      (!@except.nil? && !@except.include?(name))
+    end
+
+
+    # draws the Shopify routes
+    # @param [ActionDispatch::Routing::RouteSet] r The router
+    # @api private
+    def draw(r = @router)
+
+      if include?(:brochure)
+        # route to the Shopify brochure path
+        brochure_path = "http://www.shopify.com#{@ref}"
+        r.match(
+          "/"           => r.redirect(brochure_path),
+          :as           => "brochure",
+          :controller   => "shopify",
+          :action       => "index"
+        )
+      end
+
+      if include?(:signup)
+        # route to the Shopify sign up path
+        signup_path = "https://app.shopify.com/services/signup#{@ref}"
+        r.match(
+          "signup"      => r.redirect(signup_path),
+          :as           => "signup",
+          :controller   => "shopify",
+          :action       => "signup"
+        )
+      end
+
+      if include?(:admin)
+        # route to a shop's admin path
+        r.match ":shop/admin" => r.redirect { |p,r|
+            "https://#{p[:shop]}.myshopify.com/admin"
+          },
+          :as         => "admin",
+          :controller => "shopify_admin",
+          :action     => "index"
+      end
+
+      # draw the routes
+      match :orders,                      [:index, :show]
+      match :customers,                   [:index, :show, :new]
+      match :products,                    [:index, :show, :new]
+      match :custom_collections,          [:index, :show, :new]
+      match :smart_collections,           [:index, :show, :new]
+      match :pages,                       [:index, :show, :new]
+      match :blogs,                       [:index, :show, :new]
+      match :links,                       [:index],               "navigation"
+      match :marketing,                   [:index],               "promotions"
+      match :themes,                      [:index, :show]
+      match :themes,                      [":id/settings"],       "theme_settings"
+      match :general_preferences,         [:index],               "general_settings"
+      match :countries,                   [:index, :show, :new],  "regions"
+      match :payments,                    [:index],               "checkout_and_payment"
+      match :shipping,                    [:index],               "shipping_rates"
+      match :weight_based_shipping_rates, [:show]
+      match :price_based_shipping_rates,  [:show]
+      match :fulfillment_services,        [:index]
+      match :notifications,               [:index, :show]
+      match :domains,                     [:index]
+    end
+  end
+end
+
+
+module ShopifyAPI
+  class Routes
+    class << self
+      # use this in your `config/routes.rb` file to draw the Shopify routes
+      # @param [ActionDispatch::Routing::RouteSet] router The router
+      # @param [Hash] options The options for drawing the routes
+      # @option options [String] :referrer Your Shopify Partner referrer ID
+      # @option options [Array] :only An Array of resources to included in the routes
+      # @option options [Array] :except An Array of resources to exclude from the routes
+      # @example Draw all the Shopify routes
+      #     MyApp::Application.routes.draw do
+      #       ShopifyAPI::Routes.draw(self)
+      #     end
+      # @example Drawing only the Products and Orders routes
+      #     MyApp::Application.routes.draw do
+      #       ShopifyAPI::Routes.draw self, only: [:products, :orders]
+      #     end
+      # @example Drawing every route except for :custom_collections
+      #     MyApp::Application.routes.draw do
+      #       ShopifyAPI::Routes.draw self, except: [:custom_collections]
+      #     end
+      # @example Including a referrer ID
+      #     MyApp::Application.routes.draw do
+      #       ShopifyAPI::Routes.draw self, referrer: "travishaynes"
+      #     end
+      # @api public
+      def routes(router, options = {})
+        # cache the router
+        @router = router
+
+        # extract the referrer from the options, if it's included
+        @ref = "?ref=#{options[:referrer]}" if options.include? :referrer
+
+        # default namespace
+        options[:namespace] ||= :shopify
+
+        # extract the :only, or :except options, if they're included
+        @only = Array(options[:only]) if options.include?(:only)
+        @except = Array(options[:except]) if options.include?(:except)
+
+        # draw the routes
+        draw
+      end
+
+
+      # ensures a shop domain is suffixed with ".myshopify.com"
+      # @param [String] shop The shop's domain, with or without ".myshopify.com"
+      # @return [String] The shop's domain with ".myshopify.com"
+      # @api private
+      def shop_domain(shop)
+        shop =~ /.*myshopify\.com/ ? shop : shop + ".myshopify.com"
+      end
+
+
+      # generates a path to a resource in the Shopify namespace
+      # @param [String] path The path to match
+      # @param [String] resource The name of the resource - plural or singular
+      # @param [ActionDispatch::Routing::RouteSet] The router to add the matches
+      # @api private
+      def match_admin_path(options = {})
+
+        # use the router from the options, or the cached one
+        router = options[:router] || @router
+
+        # get the path and resource
+        path, resource = options.first
+
+        # generate the match route
+        router.match path => router.redirect { |params, r|
+
+          # ensure the ".myshopify.com" suffix exists
+          shop = shop_domain(params[:shop])
+
+          # path to the shop's admin resource
+          uri = "https://#{shop}/admin/#{resource}"
+
+          # check if we need to include an id
+          uri << "/#{params[:id]}" if params.include?(:id)
+
+          # return the redirect URI
+          uri
+        },
+
+        :as => options[:as]
+
+      end
+
+
+      # parses the options for the resource and resources methods
+      # @param [Hash] options The options Hash to parse
+      # @option options [String] :resource The name of the resource
+      # @option options [ActionDispatch::Routing::RouteSet] :router The router
+      # @api private
+      def resource_options(name)
+        name = name.to_s
+
+        {
+          :router   => @router ||= options[:router],
+          :plural   => name.pluralize,
+          :singular => name.singularize,
+          :route    => ":shop/admin/#{name.pluralize}"
+        }
+      end
+
+
+      # creates a singular match path for a resource
+      # @param [Hash] options The options for this resource.
+      # @option options [String] :resource The name of the resource
+      # @option options [ActionDispatch::Routing::RouteSet] :router The router
+      # @api private
+      def resource(name)
+        options   = resource_options(name)
+        path      = options[:route]
+        resource  = options[:plural]
+        match_admin_path path => resource, as: resource
+        options
+      end
+
+
+      # creates a plural match path for a resource
+      # @param [Hash] options The options for this resource.
+      # @option options [String] :resource The name of the resource
+      # @option options [ActionDispatch::Routing::RouteSet] :router The router
+      # @api private
+      def resources(name)
+        # draw the singular resource to go with this resource
+        options   = resource(name)
+
+        # route for the resource by its ID
+        path      = "#{options[:route]}/:id"
+        resource  = options[:singular]
+        match_admin_path path => resource, as: resource
+
+        # route for a new resource
+        path      = "#{options[:route]}/new"
+        resource  = "new_#{options[:singular]}"
+        match_admin_path path => resource, as: resource
+
+        options
+      end
+
+
+      # checks if a resource should be included in the routes
+      # @param [Symbol] name The name of the resource
+      # @return [Boolean] true when it should be included
+      # @api private
+      def include?(name)
+        (@only.nil? && @except.nil?) ||
+        (!@only.nil? && @only.include?(name)) ||
+        (!@except.nil? && !@except.include?(name))
+      end
+
+
+      # draws the Shopify routes
+      # @param [ActionDispatch::Routing::RouteSet] r The router
+      # @api private
+      def draw(r = @router)
+
+        if include?(:brochure)
+          # route to the Shopify brochure path
+          brochure_path = "http://www.shopify.com#{@ref}"
+          r.match "/" => r.redirect(brochure_path), as: "brochure"
+        end
+
+        if include?(:signup)
+          # route to the Shopify sign up path
+          signup_path = "https://app.shopify.com/services/signup#{@ref}"
+          r.match "signup" => r.redirect(signup_path), as: "signup"
+        end
+
+        if include?(:admin)
+          # route to a shop's admin path
+          r.match ":shop/admin" => r.redirect { |p,r|
+            "https://#{p[:shop]}.myshopify.com/admin"
+          }, as: "admin"
+        end
+
+        # draw the routes
+        match :orders,                      [:index, :show]
+        match :customers,                   [:index, :show, :new]
+        match :products,                    [:index, :show, :new]
+        match :custom_collections,          [:index, :show, :new]
+        match :smart_collections,           [:index, :show, :new]
+        match :pages,                       [:index, :show, :new]
+        match :blogs,                       [:index, :show, :new]
+        match :links,                       [:index],               "navigation"
+        match :marketing,                   [:index],               "promotions"
+        match :themes,                      [:index, :show]
+        match :themes,                      [":id/settings"],       "theme_settings"
+        match :general_preferences,         [:index],               "general_settings"
+        match :countries,                   [:index, :show, :new],  "regions"
+        match :payments,                    [:index],               "checkout_and_payment"
+        match :shipping,                    [:index],               "shipping_rates"
+        match :weight_based_shipping_rates, [:show]
+        match :price_based_shipping_rates,  [:show]
+        match :fulfillment_services,        [:index]
+        match :notifications,               [:index, :show]
+        match :domains,                     [:index]
+      end
+
+    end
+
+    def match(path, actions, nom = path)
+
+      actions.each do |action|
+
+        route = ":shop/admin/#{path.to_s}"
+
+        case action
+        when :show
+          route << "/:id"
+        when :new
+          route << "/new"
+        else
+          route << action unless action == :index
+        end
+
+        match_admin_path route => path.to_s, as: nom
+      end
+
+    end
+
+  end
+
+end

data/shopify-routes.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/shopify-routes/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Travis Haynes"]
+  gem.email         = ["travis.j.haynes@gmail.com"]
+  gem.description   = "Provides routes that redirect back to Shopify pages."
+  gem.summary       = "Provides routes that redirect back to Shopify pages."
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "shopify-routes"
+  gem.require_paths = ["lib"]
+  gem.version       = "0.0.1"
+
+  gem.add_runtime_dependency "shopify_api", ">= 3.0.0"
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: shopify-routes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Travis Haynes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shopify_api
+  requirement: &13651460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *13651460
+description: Provides routes that redirect back to Shopify pages.
+email:
+- travis.j.haynes@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/shopify-routes.rb
+- lib/shopify-routes/version.rb
+- shopify-routes.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Provides routes that redirect back to Shopify pages.
+test_files: []
+has_rdoc: