excursion 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 91ab81cf91d566addc17aa5963965138a1c6592a
-  data.tar.gz: 32aae702c9c69c58bbb4c420e606a50990e51d5f
+  metadata.gz: 70d3b67fdc9a21e72d9d1c5571f3a2c3010f45a2
+  data.tar.gz: ebdec9417ed30b61d4eaa1eb966ea406a0ea6821
 SHA512:
-  metadata.gz: cb034cdfc374f4266221b176d3cf786981b7af4287446340530933ae097f9e8ba3f13df52b0bd7460a7bf3a1e5af72d241984a2df26c1674fdced47f6b98c376
-  data.tar.gz: eb5cfb2d550eee50c5b26db1ef89a5f188846dd3bebe29d46c89c430c219f3b3d58c16f6ecc10a02c78ac2769e5b8031a6f447b0b33eecca125d14917d4e8996
+  metadata.gz: 057db352ba02d3f2c41507b88237cb6ab6afb7c7c1b52cc526e6c4d99a117fd3408a1490b8936281c69b0f2d4953bac810d4af339e60d0212dd81792b6d00451
+  data.tar.gz: 3d3b389f2d04646bc130f9c970a34764864979cf7e546dcf8cafade41dcea0c64e2041e26ab9d3a69c4b77754f7cf0b18715c1ecbc28348eb7e3d4ec51688570

data/lib/excursion/configuration.rb

@@ -4,7 +4,8 @@ module Excursion
       # TODO
         # exclude_pattern: to exclude certain routes from being shared
         # include_pattern: to only include certain routes
-      default_url_options: {}
+      default_url_options: {}, # default_url_options used when building routes for this app
+      retry_limit: 3 # retry limit for datasources that user remote servers
     }
 
     #attr_reader *DEFAULT_CONFIGURATION_OPTIONS.keys

data/lib/excursion/datasources/file.rb

@@ -29,10 +29,13 @@ module Excursion
       protected
 
       def initialize(path=nil)
-        path = Excursion.configuration.datasource_file
+        path ||= Excursion.configuration.datasource_file
+        raise DatasourceConfigurationError, "You must configure the :file datasource with a datasource_file path" if path.nil?
         @path = ::File.expand_path(path)
+      rescue DatasourceConfigurationError => e
+        raise e
       rescue
-        raise "Could not initialize the File datasource. Make sure you have properly configured your datasource"
+        raise DatasourceConfigurationError, "Could not initialize the :file datasource. Make sure you have properly configured the datasource_file path"
       end
 
       def exists?
@@ -46,7 +49,10 @@ module Excursion
       end
 
       def write_file(results)
+        FileUtils.mkpath(::File.dirname(@path))
         ::File.open(@path, 'w') { |f| f.write(results.to_yaml)}
+      rescue
+        raise DatasourceConfigurationError, "Could not write to the excursion route pool file: #{@path}"
       end
     end
   end

data/lib/excursion/datasources/memcache.rb

@@ -0,0 +1,56 @@
+require 'dalli'
+require 'excursion/datasources/datasource'
+require 'excursion/exceptions/memcache'
+
+module Excursion
+  module Datasources
+    class Memcache < Datasource
+
+      def read(key)
+        @client.get(key.to_s)
+      rescue Dalli::RingError => e
+        rescue_from_dalli_ring_error(e) && retry
+      end
+      alias_method :get, :read
+
+      def write(key, value)
+        @client.set(key.to_s, value)
+      rescue Dalli::RingError => e
+        rescue_from_dalli_ring_error(e) && retry
+      end
+      alias_method :set, :write
+
+      def delete(key)
+        @client.delete(key)
+      rescue Dalli::RingError => e
+        rescue_from_dalli_ring_error(e) && retry
+      end
+      alias_method :unset, :delete
+
+      protected
+
+      def initialize(server=nil, options={})
+        server ||= Excursion.configuration.memcache_server
+        raise MemcacheConfigurationError, "You must configure the :memcache datasource with a memcache_server" if server.nil?
+        @client = Dalli::Client.new(server, options)
+      end
+
+      # TODO if we're using memcache, and the server goes away, it might be a good idea
+      # to make sure to re-register this app in the pool when it comes back, just in case
+      # the server crashed and the pool is lost.
+      def rescue_from_dalli_ring_error(e)
+        @dalli_retries ||= 0
+        
+        if @dalli_retries >= Excursion.configuration.retry_limit
+          retries = @dalli_retries
+          @dalli_retries = 0
+          raise MemcacheServerError, "Excursion memcache server is down! Retried #{retries} times."
+        end
+
+        STDERR.puts "Excursion memcache server has gone away! Retrying..."
+        sleep 1 # give it a chance to come back
+        @dalli_retries += 1
+      end
+    end
+  end
+end

data/lib/excursion/exceptions/datasources.rb

@@ -0,0 +1,7 @@
+module Excursion
+  class DatasourceError < Error; end
+  class NoDatasourceError < DatasourceError; end
+  class InvalidDatasourceError < DatasourceError; end
+
+  class DatasourceConfigurationError < DatasourceError; end
+end

data/lib/excursion/exceptions/memcache.rb

@@ -0,0 +1,5 @@
+module Excursion
+  class MemcacheError < Error; end
+  class MemcacheServerError < MemcacheError; end
+  class MemcacheConfigurationError < MemcacheError; end
+end

data/lib/excursion/exceptions/pool.rb

@@ -0,0 +1,3 @@
+module Excursion
+  class NotInPool < Error; end
+end

data/lib/excursion/exceptions.rb

@@ -0,0 +1,3 @@
+module Excursion
+  class Error < StandardError; end
+end

data/lib/excursion/helpers/application_helper.rb

@@ -1,24 +1,35 @@
 module Excursion
   module Helpers
-    class ApplicationHelper
-
-      def routes
-        @application.routes
+    module ApplicationHelper
+      
+      # Returns an Excursion::Helpers::ApplicationHelper if the app exists in the route pool.
+      #
+      # Raises an exception if the requested app is not in the route pool.
+      def excursion(app_name)
+        raise NotInPool, "Application is not registered in the excursion route pool: '#{app_name}'" unless app_exists?(app_name)
+        
+        return Helpers.helper(app_name) unless Helpers.helper(app_name).nil?
+        Helpers.register_helper(UrlHelper.new(excursion_app(app_name)))
       end
 
       def method_missing(meth, *args)
-        if meth.to_s.match(/\A(#{routes.collect { |name,route| name }.join("|")})_(url|path)\Z/)
-          ActionDispatch::Routing::RouteSet::NamedRouteCollection::UrlHelper.create(routes.get($1.to_sym), @application.default_url_options).call(Rails.application.routes, args)
+        if app_exists?(meth.to_s)
+          excursion(meth.to_s)
         else
           super
         end
       end
 
-      protected
+      def app_exists?(app_name)
+        !excursion_app(app_name).nil?
+      end
 
-      def initialize(app)
-        @application = app
+      def excursion_app(app_name)
+        Pool.application(app_name)
       end
     end
   end
 end
+
+ActionController::Base.send :include, Excursion::Helpers::ApplicationHelper
+ActionController::Base.send :helper, Excursion::Helpers::ApplicationHelper

data/lib/excursion/helpers/url_helper.rb

@@ -0,0 +1,25 @@
+module Excursion
+  module Helpers
+    class UrlHelper
+      attr_reader :application
+
+      def routes
+        @application.routes
+      end
+
+      def method_missing(meth, *args)
+        if meth.to_s.match(/\A(#{routes.collect { |name,route| name }.join("|")})_(url|path)\Z/)
+          ActionDispatch::Routing::RouteSet::NamedRouteCollection::UrlHelper.create(routes.get($1.to_sym), @application.default_url_options).call(Rails.application.routes, args)
+        else
+          super
+        end
+      end
+
+      protected
+
+      def initialize(app)
+        @application = app
+      end
+    end
+  end
+end

data/lib/excursion/helpers.rb

@@ -1,7 +1,31 @@
+require 'excursion/helpers/url_helper'
 require 'excursion/helpers/application_helper'
-require 'excursion/helpers/helper'
 
-module Exursion
+module Excursion
   module Helpers
+    def self.helpers
+      @helpers ||= {}
+    end
+
+    def self.helper(name)
+      helpers[name]
+    end
+
+    # Helpers register themselves here when they're created so they can be shared
+    # between different instances (like the StaticHelper below and ActionController)
+    def self.register_helper(h)
+      @helpers ||= {}
+      @helpers[h.application.name] = h
+      h
+    end
+  end
+
+  class StaticHelper
+    include Helpers::ApplicationHelper
+  end
+
+  # Provides quick global access to url helpers with using the StaticHelper
+  def self.url_helpers
+    @url_helpers ||= StaticHelper.new
   end
 end

data/lib/excursion/pool.rb

@@ -1,4 +1,6 @@
 require 'excursion/pool/application'
+require 'excursion/exceptions/pool'
+require 'excursion/exceptions/datasources'
 
 module Excursion
   module Pool
@@ -20,11 +22,14 @@ module Excursion
     end
 
     def self.datasource
-      raise if Excursion.configuration.datasource.nil?
+      raise NoDatasourceError, "You must configure excursion with a datasource." if Excursion.configuration.datasource.nil?
       require "excursion/datasources/#{Excursion.configuration.datasource.to_s}"
       @@datasource ||= "Excursion::Datasources::#{Excursion.configuration.datasource.to_s.camelize}".constantize.new
-    rescue
-      raise "Could not initialize your datasource. Make sure you have properly configured it"
+    #rescue NoDatasourceError => e
+      #raise e
+    rescue StandardError => e
+      raise e
+      #raise InvalidDatasourceError, "Could not initialize your datasource. Make sure you have properly configured it"
     end
   end
 end

data/lib/excursion/version.rb

@@ -1,3 +1,3 @@
 module Excursion
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/excursion.rb

@@ -1,3 +1,4 @@
+require 'excursion/exceptions'
 require 'excursion/configuration'
 
 module Excursion

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excursion
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Mark Rebec
@@ -48,13 +48,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/excursion/pool.rb
+- lib/excursion/exceptions/pool.rb
+- lib/excursion/exceptions/datasources.rb
+- lib/excursion/exceptions/memcache.rb
 - lib/excursion/pool/application.rb
 - lib/excursion/railtie.rb
 - lib/excursion/configuration.rb
 - lib/excursion/datasources/file.rb
 - lib/excursion/datasources/datasource.rb
+- lib/excursion/datasources/memcache.rb
+- lib/excursion/helpers/url_helper.rb
 - lib/excursion/helpers/application_helper.rb
-- lib/excursion/helpers/helper.rb
+- lib/excursion/exceptions.rb
 - lib/excursion/helpers.rb
 - lib/excursion/version.rb
 - lib/excursion.rb

data/lib/excursion/helpers/helper.rb

@@ -1,22 +0,0 @@
-module Excursion
-  module Helpers
-    module Helper
-      
-      def method_missing(meth, *args)
-        if !(app = Pool.application(meth.to_s)).nil?
-          @application_helpers ||= {}
-          @application_helpers[app.name] ||= ApplicationHelper.new(app)
-        else
-          begin
-            super
-          rescue NoMethodError => e
-            raise "Excursion URL helper method does not exist: #{meth}"
-          end
-        end
-      end
-    end
-  end
-end
-
-ActionController::Base.send :include, Excursion::Helpers::Helper
-ActionController::Base.send :helper, Excursion::Helpers::Helper