swerling-synapse 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+pkg/
+doc/
+ext/Makefile
+ext/mkmf.log
+ext/*.o
+ext/*.so

data/History.txt

@@ -0,0 +1,3 @@
+== 0.0.1 / 2009-07-18
+
+* initial release

data/README.rdoc

@@ -0,0 +1,126 @@
+synapse
+    by Steven Swerling
+    http://tab-a.slot-z.net
+
+== DESCRIPTION:
+
+Synapse is an application framework that does almost nothing. 
+Basically this is just a tiny wrapper for the Rack::Router 
+(see http://github.com/carllerche/rack-router)
+
+very alpha-ish stuff here. Seems to work though.
+
+== SYNOPSIS:
+
+Here is an example Synapse application (foo_app.rb):
+
+  require 'synapse'
+
+  class FooApp < Synapse::App
+
+    def router
+      @router ||= Rack::Router.new(nil, {}) do |r|
+        r.map "/yip/",               :get, :to => self, :with => { :action => "yip" }
+        r.map "/yap/:yap_variable",  :get, :to => self, :with => { :action => "yapfoo" }
+        r.map "/yap/",               :get, :to => self, :with => { :action => "yap" }
+        r.map "/:anything",          :get, :to => self, :with => { :action => "no_route" }
+        r.map "/",                   :get, :to => self, :with => { :action => "home" }
+      end
+    end
+
+    def yip; "yip"; end
+    def yap; "yap"; end
+    def home; "home"; end
+
+    def no_route
+      # Note: 'self.env' is the rack env
+      self.response[:body] = "route not found for: '#{self.env['REQUEST_URI']}'"
+      self.response[:status_code] = 404
+    end
+
+    def yapfoo
+      "yapfoo, #{self.params[:yap_variable]}"
+    end
+
+  end
+
+And here is an example rack config, foo_app.ru:
+
+  require 'foo_app'
+  run FooApp.new.as_rack_app
+
+Run FooApp w/ rackup or shotgun:
+
+  rackup --server=thin foo.ru -p 3000
+
+    or
+
+  shotgun --server=thin foo.ru -p 3000
+
+== FEATURES
+
+When a Synapse application handles a rack request, it 
+
+1. Duplicates self (so it's thread safe)
+2. Sets @response, @params, @env (the rack env)
+3. Calls the action that Rack::Router route that matched. If the action returns a String, that is used for the @response[:body]
+
+The @response is a hash used to return rack status code, headers hash, and body.  Actions may do what they please with
+the response. Default response:
+
+    @response = {
+      :status_code => 200,
+      :headers => {'Content-Type' => 'text/html'},
+      :body => nil
+    }
+
+
+Actions are expected to side-effect the :status_code, :headers, and :body. As a convenience, if an action returns a
+string, it is assumed that that string is the :body. An exception is thrown if the :body is not set to something.
+
+That's it. Really not much to see here.  Just gives you a thread-safe rack-based web framework that consists of
+nothing but a router.
+
+== PROBLEMS
+
+None known.
+
+== REQUIREMENTS:
+
+* rack
+* Rack::Router (the rack-router gem), see http://github.com/carllerche/rack-router
+
+== INSTALL:
+
+* first install rack and rack-router
+* gem install synapse
+
+== Acknowledgements:
+
+rack and rack-router were used, obviously.
+'bones' used for gem generation.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Steven Swerling
+
+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.txt

@@ -0,0 +1,126 @@
+synapse
+    by Steven Swerling
+    http://tab-a.slot-z.net
+
+== DESCRIPTION:
+
+Synapse is an application framework that does almost nothing. 
+Basically this is just a tiny wrapper for the Rack::Router 
+(see http://github.com/carllerche/rack-router)
+
+very alpha-ish stuff here. Seems to work though.
+
+== SYNOPSIS:
+
+Here is an example Synapse application (foo_app.rb):
+
+  require 'synapse'
+
+  class FooApp < Synapse::App
+
+    def router
+      @router ||= Rack::Router.new(nil, {}) do |r|
+        r.map "/yip/",               :get, :to => self, :with => { :action => "yip" }
+        r.map "/yap/:yap_variable",  :get, :to => self, :with => { :action => "yapfoo" }
+        r.map "/yap/",               :get, :to => self, :with => { :action => "yap" }
+        r.map "/:anything",          :get, :to => self, :with => { :action => "no_route" }
+        r.map "/",                   :get, :to => self, :with => { :action => "home" }
+      end
+    end
+
+    def yip; "yip"; end
+    def yap; "yap"; end
+    def home; "home"; end
+
+    def no_route
+      # Note: 'self.env' is the rack env
+      self.response[:body] = "route not found for: '#{self.env['REQUEST_URI']}'"
+      self.response[:status_code] = 404
+    end
+
+    def yapfoo
+      "yapfoo, #{self.params[:yap_variable]}"
+    end
+
+  end
+
+And here is an example rack config, foo_app.ru:
+
+  require 'foo_app'
+  run FooApp.new.as_rack_app
+
+Run FooApp w/ rackup or shotgun:
+
+  rackup --server=thin foo.ru -p 3000
+
+    or
+
+  shotgun --server=thin foo.ru -p 3000
+
+== FEATURES
+
+When a Synapse application handles a rack request, it 
+
+1. Duplicates self (so it's thread safe)
+2. Sets @response, @params, @env (the rack env)
+3. Calls the action that Rack::Router route that matched. If the action returns a String, that is used for the @response[:body]
+
+The @response is a hash used to return rack status code, headers hash, and body.  Actions may do what they please with
+the response. Default response:
+
+    @response = {
+      :status_code => 200,
+      :headers => {'Content-Type' => 'text/html'},
+      :body => nil
+    }
+
+
+Actions are expected to side-effect the :status_code, :headers, and :body. As a convenience, if an action returns a
+string, it is assumed that that string is the :body. An exception is thrown if the :body is not set to something.
+
+That's it. Really not much to see here.  Just gives you a thread-safe rack-based web framework that consists of
+nothing but a router.
+
+== PROBLEMS
+
+None known.
+
+== REQUIREMENTS:
+
+* rack
+* Rack::Router (the rack-router gem), see http://github.com/carllerche/rack-router
+
+== INSTALL:
+
+* first install rack and rack-router
+* gem install synapse
+
+== Acknowledgements:
+
+rack and rack-router were used, obviously.
+'bones' used for gem generation.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Steven Swerling
+
+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/Rakefile

@@ -0,0 +1,45 @@
+# Look in the tasks/setup.rb file for the various options that can be
+# configured in this Rakefile. The .rake files in the tasks directory
+# are where the options are used.
+
+begin
+  require 'bones'
+  Bones.setup
+rescue LoadError
+  begin
+    load 'tasks/setup.rb'
+  rescue LoadError
+    raise RuntimeError, '### please install the "bones" gem ###'
+  end
+end
+
+ensure_in_path 'lib'
+require 'synapse_info'
+
+task :default => 'spec:run'
+
+PROJ.name = 'synapse'
+PROJ.authors = 'Steven Swerling'
+PROJ.email = 'sswerling@yahoo.com'
+PROJ.url = 'http://tab-a.slot-z.net'
+PROJ.version = Synapse::VERSION
+PROJ.rubyforge.name = 'synapse'
+PROJ.gem.dependencies = ['rack', 'rack-router']
+PROJ.rdoc.opts = ["--inline-source"]
+PROJ.rdoc.exclude = ["^tasks/setup\.rb$", "lib/synapse_info.rb"]
+
+PROJ.spec.opts << '--color'
+
+task :default => 'spec:run'
+namespace :my do
+  namespace :gem do
+    task :package => [:clobber] do
+      this_dir = File.join(File.dirname(__FILE__))
+      sh "rm -rf #{File.join(this_dir, 'pkg')}"
+      sh "rm -rf #{File.join(this_dir, 'doc')}"
+      sh "cp #{File.join(this_dir, 'README.txt')} #{File.join(this_dir, 'README.rdoc')} "
+      Rake::Task['gem:package'].invoke
+    end
+  end
+end
+

data/example/foo_app.rb

@@ -0,0 +1,30 @@
+require File.join(File.dirname(__FILE__),'../lib/synapse.rb')
+
+#
+# Example synapse application
+#
+class FooApp < Synapse::App
+
+  def router
+    return @router ||= Rack::Router.new(nil, {}) do |r|
+      r.map "/yip/",                     :get, :to => self, :with => { :action => "yip" }
+      r.map "/yap/:yap_variable",        :get, :to => self, :with => { :action => "yapfoo" }
+      r.map "/yap/",                     :get, :to => self, :with => { :action => "yap" }
+      r.map "/:anything",                :get, :to => self, :with => { :action => "no_route" }
+      r.map "/",                         :get, :to => self, :with => { :action => "home" }
+    end
+  end
+
+  def yip; "yip"; end
+  def yap; "yap"; end
+  def home; "home"; end
+
+  def no_route
+    self.response[:body] = "route not found for: '#{self.env['REQUEST_URI']}'"
+    self.response[:status_code] = 404
+  end
+
+  def yapfoo
+    "yapfoo, #{self.params[:yap_variable]}"
+  end
+end

data/example/foo_app.ru

@@ -0,0 +1,2 @@
+require File.join(File.dirname(__FILE__),'foo_app.rb')
+run FooApp.new.as_rack_app

data/lib/synapse.rb

@@ -0,0 +1,12 @@
+# base ruby requires
+require 'logger'
+
+# gems dependencies
+require 'rubygems'
+require 'rack'
+require 'rack/router'
+
+# my files (require_all_libs_relative_to is a bones util method in synapse_info.rb)
+require 'synapse_info'
+Synapse.require_all_libs_relative_to(__FILE__)
+

data/lib/synapse/base.rb

@@ -0,0 +1,95 @@
+module Synapse
+
+  #
+  # See the synopsis section of README.txt for usage.
+  # 
+  # See the RackRouter project for the kinds of routes you can setup.
+  #
+  # Variables of note:
+  #
+  #   @response
+  #      a hash with keys :body, :headers, :status_code, the 3 items all rack handlers are expected to set.
+  #      Body is a string, status code is an http status code integer, and headers is a hash that
+  #      should conform to rack's contract.
+  #
+  #   @env
+  #      The rack env passed into this apps #call method
+  #
+  #   @params
+  #      The params that the matching Rack::Router route set.
+  #
+  class App
+    attr_accessor :response, :params, :env, :logger
+
+    # Options:
+    #   :logger => where to log to.
+    #              Note this is not the same thing as the rack access log (although you
+    #              can pass that logger in if you want). Default: Logger.new(STDOUT)
+    def initialize(opts = {})
+      @logger = opts[:logger] || Logger.new(STDOUT)
+    end
+    
+    # the router for this Synapse::App. Subclasses are _required_ to override this.
+    # (see README.txt for example usage)
+    def router
+      raise "#{self.class} must implement a 'router' method that returns a Rack::Router"
+    end
+
+    # Alias for #router
+    def as_rack_app; self.router; end # alias_method doesn't seem to work here (it doesnt call the subclass)
+
+    # The rack #call method
+    def call(env)
+      dup._call(env) # be thread-safe
+    end
+
+    #
+    #  Misc Sugar
+    #
+
+    # The name of the action method, determined by the Route that Rack::Router bound to the incoming request 
+    def action
+      self.params[:action]
+    end
+
+    # Overridable method that handles missing action that was defined by a route
+    def theres_no_action
+      self.response[:body] = "Action '#{self.action}' not found in '#{self.class}'"
+      self.response[:status_code] = 500
+    end
+
+    protected
+
+      # :stopdoc:
+
+      def _call(env)
+        start_time = Time.now.to_f 
+
+        @env = env
+        @params = env['rack_router.params']
+        @response = {
+          :status_code => 200,
+          :headers => {'Content-Type' => 'text/html'},
+          :body => nil
+        }
+
+        action = self.action
+        if self.respond_to?(action)
+          body = self.send(self.action)
+        else
+          body = theres_no_action
+        end
+
+        response[:body] = body if body.is_a?(String)
+        raise "You have to set the response body" if response[:body].nil?
+
+        logger.debug("It took #{Time.now.to_f - start_time} sec for #{self.class} to handle request.")
+        [response[:status_code], response[:headers], response[:body]]
+      end
+
+      # :startdoc:
+  end
+end
+
+
+

data/lib/synapse_info.rb

@@ -0,0 +1,51 @@
+#
+# See README.txt for usage.
+#
+module Synapse
+
+  # :stopdoc:
+
+  VERSION = '0.0.1'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to require all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+
+  # :startdoc:
+  
+end  # module Synapse
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib synapse]))
+
+Spec::Runner.configure do |config|
+  # == Mock Framework
+  #
+  # RSpec uses it's own mocking framework by default. If you prefer to
+  # use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+end
+
+# EOF

data/spec/synapse_spec.rb

@@ -0,0 +1,7 @@
+
+require File.join(File.dirname(__FILE__), %w[spec_helper])
+
+describe Synapse do
+end
+
+# EOF

data/spstest.rb

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rack'
+
+require 'foo_app.rb' # loads $router
+
+#$router = FooApp.as_rack_app
+inner_app = FooApp.new.as_rack_app
+
+# create an env
+env = 'development' # anoher switch
+case env
+when "development"
+  app = Rack::Builder.new {
+    use Rack::CommonLogger, $stderr  
+    use Rack::ShowExceptions
+    use Rack::Lint
+    run inner_app
+  }
+when "production"
+  app = Rack::Builder.new {
+    use Rack::CommonLogger, $stderr  
+    run inner_app
+  }
+else
+  raise "don't recognize '#{env}' run env"
+end
+
+# pick a server
+begin
+#  (server = Rack::Handler::Mongrel) 
+#rescue LoadError => le 
+  (server = Rack::Handler::Thin) 
+rescue LoadError => le 
+  (server = Rack::Handler::WEBrick)
+end
+
+options = {:Port => 3000, :Host => "0.0.0.0", :AccessLog => []}
+server.run app, options

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: swerling-synapse
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Steven Swerling
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-18 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rack-router
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: bones
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.4.0
+    version: 
+description: Synapse is a web application framework that does practically nothing.  Basically this is just a tiny wrapper for the Rack::Router  (see http://github.com/carllerche/rack-router)  very alpha-ish stuff here. Seems to work though.
+email: sswerling@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- README.rdoc
+- README.txt
+files: 
+- .gitignore
+- History.txt
+- README.rdoc
+- README.txt
+- Rakefile
+- example/foo_app.rb
+- example/foo_app.ru
+- lib/synapse.rb
+- lib/synapse/base.rb
+- lib/synapse_info.rb
+- spec/spec_helper.rb
+- spec/synapse_spec.rb
+- spstest.rb
+- test/test_synapse.rb
+has_rdoc: false
+homepage: http://tab-a.slot-z.net
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: synapse
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Synapse is a web application framework that does practically nothing
+test_files: 
+- test/test_synapse.rb