junkfood 0.2.0 → 0.3.0

data/README.md

@@ -361,6 +361,11 @@ The Middleware:
 * Junkfood::Rack::ErrorHandler
 * Junkfood::Rack::TransientSession
 
+Application and Middleware
+
+* Junkfood::Rack::ChainRouter - A way to call multiple applications in
+  order until one returns a result without the X-Cascade header set to pass.
+
 Requires:
 
 * json

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/junkfood.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{junkfood}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Benjamin Yu"]
-  s.date = %q{2010-11-15}
+  s.date = %q{2010-11-20}
   s.description = %q{My mesh of an all-in-one library for disjoint code.}
   s.email = %q{benjaminlyu@gmail.com}
   s.extra_rdoc_files = [
@@ -43,6 +43,7 @@ Gem::Specification.new do |s|
     "lib/junkfood/one_time.rb",
     "lib/junkfood/paperclip_string_io.rb",
     "lib/junkfood/rack.rb",
+    "lib/junkfood/rack/chained_router.rb",
     "lib/junkfood/rack/error.rb",
     "lib/junkfood/rack/sessions.rb",
     "lib/junkfood/settings.rb",
@@ -59,6 +60,7 @@ Gem::Specification.new do |s|
     "spec/junkfood/ceb/executors/event_executor_spec.rb",
     "spec/junkfood/one_time_spec.rb",
     "spec/junkfood/paperclip_string_io_spec.rb",
+    "spec/junkfood/rack/chained_router_spec.rb",
     "spec/junkfood/rack/error_spec.rb",
     "spec/junkfood/rack/sessions_spec.rb",
     "spec/junkfood/settings_spec.rb",
@@ -82,6 +84,7 @@ Gem::Specification.new do |s|
     "spec/junkfood/ceb/executors/event_executor_spec.rb",
     "spec/junkfood/one_time_spec.rb",
     "spec/junkfood/paperclip_string_io_spec.rb",
+    "spec/junkfood/rack/chained_router_spec.rb",
     "spec/junkfood/rack/error_spec.rb",
     "spec/junkfood/rack/sessions_spec.rb",
     "spec/junkfood/settings_spec.rb",

data/lib/junkfood/ceb/base_command.rb

@@ -13,6 +13,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'date'
 require 'junkfood/ceb/bus'
 require 'mongoid'
 
@@ -22,11 +23,45 @@ module Junkfood
     ##
     # BaseCommand abstract class from which one defines and implements
     # actual Commands to be run.
+    # * _id - The mongodb id of the created Command.
+    # * _type - The type of the command. Based off subclass Name.
+    # * created_at - When the event was created/saved to mongodb.
+    # * origin - A descriptive string about where this command originated.
+    #   For example, from the main web application or a separate web service
+    #   api.
+    #
+    # Example:
+    #
+    #   ##
+    #   # This is a simple command that creates a blog post, which is backed
+    #   # by an ActiveRecord based model.
+    #   #
+    #   class Post::CreateCommand < Junkfood::Ceb::BaseCommand
+    #
+    #     def perform
+    #       # The constructor is set to be a Mongoid document constructor,
+    #       # so all of the fields passed become dynamic attributes.
+    #       # We access such attributes with the read_attribute method.
+    #       #
+    #       # The following example reads specific attributes to be passed
+    #       # on to the actual Post model for creation.
+    #       params = {
+    #         'user_id' => read_attribute(:author_id),
+    #         'title' => read_attribute(:title),
+    #         'body' => read_attribute(:body),
+    #       }
+    #       post = Post.new(params)
+    #       # The BaseCommand object is an event_bus, so we can
+    #       # use it to send off events... then return the sent event.
+    #       if post.save
+    #         event, result = send_event :post_created, post
+    #       else
+    #         event, result = send_event :post_failed, post
+    #       end
+    #       return event
+    #     end
+    #   end
     #
-    # _id (id)
-    # _type
-    # created_at
-    # origin
     class BaseCommand
       include Junkfood::Ceb::Bus
       include Mongoid::Document
@@ -38,7 +73,7 @@ module Junkfood
         :inverse_of => :command,
         :class_name => 'Junkfood::Ceb::BaseEvent')
 
-      field :created_at, :type => Time
+      field :created_at, :type => DateTime
       field :origin, :type => String
 
       after_initialize :generate_default_values
@@ -55,7 +90,7 @@ module Junkfood
       # Before create hook to set the Command's default values.
       #
       def generate_default_values
-        self.created_at = Time.now unless self.created_at
+        self.created_at = DateTime.now unless self.created_at
       end
     end
   end

data/lib/junkfood/ceb/base_event.rb

@@ -13,20 +13,38 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+require 'date'
 require 'mongoid'
 
 module Junkfood
   module Ceb
 
     ##
-    # _id (id)
-    # _type
-    # created_at
-    # command_id
+    # The base class from which other classes derive Event modeling.
+    # This is a mongoid document model with the following fields:
+    # * _id - The mongodb id of the created Event.
+    # * _type - The type of the event. Based off subclass Name.
+    # * created_at - When the event was created/saved to mongodb.
+    # * command_id - The command id to which this event was created in response.
+    #
+    # Example:
+    #
+    #   class PostCreatedEvent < Junkfood::Ceb::BaseEvent
+    #     field :post_id, :type => Integer
+    #     field :post_title, :type => String
+    #     field :post_date, :type => DateTime
+    #     field :post_body, :type => String
+    #     field :post_author, :type => String
+    #   end
+    #
+    # Events are meant to state a fact that something occured, and also
+    # the relevant details of that event. In this case, we include all the
+    # details of the Post created.
+    #
     class BaseEvent
       include Mongoid::Document
 
-      field :created_at, :type => Time
+      field :created_at, :type => DateTime
 
       referenced_in :command, :class_name => 'Junkfood::Ceb::BaseCommand'
 
@@ -35,7 +53,7 @@ module Junkfood
       protected
 
       def generate_default_values
-        self.created_at = Time.now unless self.created_at
+        self.created_at = DateTime.now unless self.created_at
       end
     end
   end

data/lib/junkfood/rack.rb

@@ -22,5 +22,6 @@ module Junkfood
   end
 end
 
+require 'junkfood/rack/chained_router'
 require 'junkfood/rack/error'
 require 'junkfood/rack/sessions'

data/lib/junkfood/rack/chained_router.rb

@@ -0,0 +1,130 @@
+# encoding: utf-8
+# Copyright 2010 Benjamin Yu <http://benjaminyu.org/>
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Junkfood
+  module Rack
+
+    ##
+    # A Rack Application and Middleware that will execute a list
+    # of callables in order until it receives a response without the
+    # 'X-Cascade' header value set to 'pass'. ChainedRouter will then return
+    # the response of said execution. The response of the last callable will
+    # be returned if it is executed even if it has the 'X-Cascade' header set.
+    # As Middleware, the given app will be the last callable in the chain.
+    #
+    # Example as Middleware:
+    #
+    #   use Junkfood::Rack::ChainedRouter do |router|
+    #     router.add_route Proc.new { |env|
+    #       # This proc is called, but it returns a pass.
+    #       [404, { 'X-Cascade' => 'pass' }, []]
+    #     }
+    #     router.add_route Proc.new { |env|
+    #       # This proc is called, but it also returns a pass.
+    #       [404, { 'X-Cascade' => 'pass' }, []]
+    #     }
+    #   end
+    #   run Proc.new { |env|
+    #     # The main app is the last callable in ChainRouter's list.
+    #     # And this will be executed.
+    #     [200, { 'Content-Type' => 'text/plain' }, ['Hello World']]
+    #   }
+    #
+    # Example as Application:
+    #
+    #   run Junkfood::Rack::ChainedRouter.new do |router|
+    #     router.add_route Proc.new { |env|
+    #       # This proc is called, but it returns a pass.
+    #       [404, { 'X-Cascade' => 'pass' }, []]
+    #     }
+    #     router.add_route Proc.new { |env|
+    #       # This is the last app to run.
+    #       [200, { 'Content-Type' => 'text/plain' }, ['Hello World']]
+    #     }
+    #     router.add_route Proc.new { |env|
+    #       # So this proc is never called.
+    #       [200, { 'Content-Type' => 'text/plain' }, ['Never Run']]
+    #     }
+    #   end
+    #
+    class ChainedRouter
+
+      ##
+      # HTTP Not Found status code.
+      HTTP_NOT_FOUND = 404.freeze
+
+      ##
+      # Header to set the content type value in the response.
+      CONTENT_TYPE = 'Content-Type'.freeze
+
+      ##
+      # Header location where to look for the pass value.
+      X_CASCADE = 'X-Cascade'.freeze
+
+      ##
+      # The pass string to signify triggering the next callable in the list.
+      PASS = 'pass'.freeze
+
+      ##
+      # @param app the rack application. This will be last callable in chain.
+      # @yield [router] block to configure the ChainedRouter.
+      # @yieldparam router newly instantiated ChainedRouter
+      #
+      def initialize(app=nil, &block)
+        @chain = []
+        if block_given?
+          yield self
+        end
+        @chain << app if app.respond_to? :call
+
+        # Just validate the arguments
+        @chain.each do |link|
+          raise ArgumentError unless link.respond_to? :call
+        end
+      end
+
+      ##
+      # @param the rack request environment.
+      #
+      def call(env)
+        # Set some defaults if the route set is empty.
+        results = [
+          HTTP_NOT_FOUND,
+          {
+            X_CASCADE => PASS,
+            CONTENT_TYPE => 'text/plain'
+          },
+          []]
+        # Call each link in chain.
+        for link in @chain
+          results = link.call env
+          return results unless results[1][X_CASCADE] == PASS
+        end
+        # Return the results of the last link in chain, or the originally
+        # set results if chain is empty.
+        return results
+      end
+
+      ##
+      # Appends a callable to the end of the call chain.
+      #
+      # @param app the callable to append.
+      #
+      def add_route(app)
+        @chain << app
+      end
+    end
+  end
+end

data/lib/junkfood/rack/error.rb

@@ -56,7 +56,15 @@ module Junkfood
     class ErrorHandler
       ##
       # The default HTTP status code for caught errors.
-      DEFAULT_STATUS_CODE = 500
+      DEFAULT_STATUS_CODE = 500.freeze
+
+      ##
+      # Header to set the content type of error response
+      CONTENT_TYPE = 'Content-Type'.freeze
+
+      ##
+      # Json's content type value for the content type header.
+      JSON_CONTENT_TYPE = 'application/json'.freeze
 
       ##
       # @param app the rest of the rack stack
@@ -84,7 +92,7 @@ module Junkfood
         
         return [
           map['status_code'] ? map['status_code'].to_i : DEFAULT_STATUS_CODE,
-          { 'Content-Type' => 'application/json' },
+          { CONTENT_TYPE => JSON_CONTENT_TYPE },
           [error.to_json]]
       end
     end

data/lib/junkfood/rack/sessions.rb

@@ -52,8 +52,9 @@ module Junkfood
       # @return a Rack response from the application.
       #
       def call(env)
-        env['rack.session'] = {}
-        @app.call(env)
+        new_env = env.dup
+        new_env['rack.session'] = {}
+        @app.call(new_env)
       end
     end
   end

data/spec/junkfood/base32_spec.rb

@@ -33,7 +33,43 @@ describe 'Junkfood::Base32' do
     str1.string.should eql(str2.string)
   end
 
-  it 'should have optional splitlines'
+  it 'should support dash splits at every 10th character' do
+    str = Junkfood::Base32.encode(
+      '1234567890abcdefghijklmnopqrstuvwxyz',
+      :split => :dash,
+      :split_length => 10)
+    str.string.should eql(
+      'GEZDGNBVGY-3TQOJQMFRG-GZDFMZTWQ2-LKNNWG23TP-OBYXE43UOV-3HO6DZPI')
+    str.string.encoding.should eql(Encoding::ASCII)
+  end
+
+  it 'should support newline splits at every 10th character' do
+    str = Junkfood::Base32.encode(
+      '1234567890abcdefghijklmnopqrstuvwxyz',
+      :split => :newline,
+      :split_length => 10)
+    str.string.should eql(
+      "GEZDGNBVGY\n3TQOJQMFRG\nGZDFMZTWQ2\nLKNNWG23TP\nOBYXE43UOV\n3HO6DZPI")
+    str.string.encoding.should eql(Encoding::ASCII)
+  end
 
-  it 'should have splitlines at specified lengths'
+  it 'should support space splits at every 5th character' do
+    str = Junkfood::Base32.encode(
+      '1234567890abcdefgh',
+      :split => :space,
+      :split_length => 5)
+    str.string.should eql(
+      'GEZDG NBVGY 3TQOJ QMFRG GZDFM ZTWQ')
+    str.string.encoding.should eql(Encoding::ASCII)
+  end
+
+  it 'should support underscore splits at every 4th character' do
+    str = Junkfood::Base32.encode(
+      '1234567890abcdefgh',
+      :split => :underscore,
+      :split_length => 4)
+    str.string.should eql(
+      'GEZD_GNBV_GY3T_QOJQ_MFRG_GZDF_MZTW_Q')
+    str.string.encoding.should eql(Encoding::ASCII)
+  end
 end

data/spec/junkfood/rack/chained_router_spec.rb

@@ -0,0 +1,100 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../spec_helper')
+
+describe 'Junkfood::Rack' do
+  describe 'ChainedRouter' do
+
+    it 'should return a not found result if route set is empty' do
+      # Set the not found expected results
+      expected_results = [
+        404,
+        { 'X-Cascade' => 'pass', 'Content-Type' => 'text/plain'},
+        []]
+
+      # Create an empty router
+      router = Junkfood::Rack::ChainedRouter.new
+
+      # Execute and test
+      results = router.call({})
+      results.should eql expected_results
+    end
+
+    it 'should execute the next callable in chain when a pass is given' do
+      expected_results = [200, {}, ['Hello World']]
+
+      # Create the router
+      app = Proc.new { |env|
+        fail 'Should not be called'
+      }
+      router = Junkfood::Rack::ChainedRouter.new app do |router|
+        # This proc is called, but it returns a pass.
+        router.add_route Proc.new { |env|
+          [404, { 'X-Cascade' => 'pass' }, []]
+        }
+        # This proc is called, but it also returns a pass.
+        router.add_route Proc.new { |env|
+          [404, { 'X-Cascade' => 'pass' }, []]
+        }
+        # This proc is called and returns success
+        router.add_route Proc.new { |env|
+          [200, {}, ['Hello World']]
+        }
+        router.add_route Proc.new { |env|
+          fail 'Should not be called'
+        }
+      end
+
+      # Execute and test
+      results = router.call({})
+      results.should eql expected_results
+    end
+
+    it 'should execute the app as the last callable in the chain' do
+      expected_results = [200, {}, ['Hello World']]
+
+      # Last app to be called
+      app = Proc.new { |env|
+        [200, {}, ['Hello World']]
+      }
+
+      # Create the router
+      router = Junkfood::Rack::ChainedRouter.new app do |router|
+        # This proc is called, but it returns a pass.
+        router.add_route Proc.new { |env|
+          [404, { 'X-Cascade' => 'pass' }, []]
+        }
+        # This proc is called, but it also returns a pass.
+        router.add_route Proc.new { |env|
+          [404, { 'X-Cascade' => 'pass' }, []]
+        }
+      end
+
+      # Execute and test
+      results = router.call({})
+      results.should eql expected_results
+    end
+
+    it 'should return the last callable results even if it is a pass' do
+      expected_results = [404, { 'X-Cascade' => 'pass' }, ['last']]
+
+      # Last app to be called, and it's a pass
+      app = Proc.new { |env|
+        [404, { 'X-Cascade' => 'pass' }, ['last']]
+      }
+      # Create the router
+      router = Junkfood::Rack::ChainedRouter.new app do |router|
+        # This proc is called, but it returns a pass.
+        router.add_route Proc.new { |env|
+          [404, { 'X-Cascade' => 'pass' }, []]
+        }
+        # This proc is called, but it also returns a pass.
+        router.add_route Proc.new { |env|
+          [404, { 'X-Cascade' => 'pass' }, []]
+        }
+      end
+
+      # Execute and test
+      results = router.call({})
+      results.should eql expected_results
+    end
+  end
+end

data/spec/junkfood/rack/sessions_spec.rb

@@ -4,6 +4,9 @@ describe 'Junkfood::Rack' do
   describe 'TransientSession' do
 
     it 'should set the rack.session env parameter with an empty hash' do
+      original_env = {
+        'rack.session' => { 'hello' => 'world' }
+      }
       # We manually create a rack application with the TransientSession
       # acting as the only middleware. The application itself is a
       # proc object that just checks that the passed rack environment
@@ -14,7 +17,9 @@ describe 'Junkfood::Rack' do
         env.should eql 'rack.session' => {}
         [200, {}, []]
       }
-      app.call({})
+      app.call(original_env)
+
+      original_env['rack.session'].should eql({'hello' => 'world'})
     end
   end
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Benjamin Yu
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-15 00:00:00 -08:00
+date: 2010-11-20 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -330,6 +330,7 @@ files:
 - lib/junkfood/one_time.rb
 - lib/junkfood/paperclip_string_io.rb
 - lib/junkfood/rack.rb
+- lib/junkfood/rack/chained_router.rb
 - lib/junkfood/rack/error.rb
 - lib/junkfood/rack/sessions.rb
 - lib/junkfood/settings.rb
@@ -346,6 +347,7 @@ files:
 - spec/junkfood/ceb/executors/event_executor_spec.rb
 - spec/junkfood/one_time_spec.rb
 - spec/junkfood/paperclip_string_io_spec.rb
+- spec/junkfood/rack/chained_router_spec.rb
 - spec/junkfood/rack/error_spec.rb
 - spec/junkfood/rack/sessions_spec.rb
 - spec/junkfood/settings_spec.rb
@@ -365,7 +367,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 529643725
+      hash: 405223505
       segments: 
       - 0
       version: "0"
@@ -397,6 +399,7 @@ test_files:
 - spec/junkfood/ceb/executors/event_executor_spec.rb
 - spec/junkfood/one_time_spec.rb
 - spec/junkfood/paperclip_string_io_spec.rb
+- spec/junkfood/rack/chained_router_spec.rb
 - spec/junkfood/rack/error_spec.rb
 - spec/junkfood/rack/sessions_spec.rb
 - spec/junkfood/settings_spec.rb