shopify-routes 0.0.1 → 0.0.2

data/README.md

@@ -1,4 +1,4 @@
-# Shopify::Routes
+# Shopify.routes
 
 Provides routes that redirect back to Shopify pages.
 
@@ -24,8 +24,10 @@ 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)
+    MyApp::Application.routes.draw do
+      namespace :shopify do
+        ShopifyAPI::Routes.draw(self)
+      end
     end
 
 You can also specify which routes you want to include, or exclude, as you would
@@ -46,12 +48,22 @@ and `shopify_signup_path` to
 
 ## Routes
 
+For all except the brochure and signup pages, you'll have to include the shop's
+domain in the url helper. For example:
+
+    orders_url(:shop => "my-shopify-domain")
+
+Or for redirecting to a specific order:
+
+    orders_url(:shop => "my-shopify-domain", :id => 1001)
+
 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)
+                  applications        /:shop/admin/applications(.:format)
                         orders        /:shop/admin/orders(.:format)
                          order        /:shop/admin/orders/:id(.:format)
                      customers        /:shop/admin/customers(.:format)

data/lib/shopify-routes.rb

@@ -189,6 +189,7 @@ module ShopifyAPI
       end
 
       # draw the routes
+      match :applications,                [:index]
       match :orders,                      [:index, :show]
       match :customers,                   [:index, :show, :new]
       match :products,                    [:index, :show, :new]
@@ -212,230 +213,3 @@ module ShopifyAPI
     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

@@ -1,5 +1,4 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/shopify-routes/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Travis Haynes"]
@@ -13,7 +12,7 @@ Gem::Specification.new do |gem|
   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.version       = "0.0.2"
 
   gem.add_runtime_dependency "shopify_api", ">= 3.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shopify-routes
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shopify_api
-  requirement: &13651460 !ruby/object:Gem::Requirement
+  requirement: &13236360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 3.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *13651460
+  version_requirements: *13236360
 description: Provides routes that redirect back to Shopify pages.
 email:
 - travis.j.haynes@gmail.com
@@ -35,7 +35,6 @@ files:
 - README.md
 - Rakefile
 - lib/shopify-routes.rb
-- lib/shopify-routes/version.rb
 - shopify-routes.gemspec
 homepage: ''
 licenses: []

data/lib/shopify-routes/version.rb

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