anupom-anobik 0.0.2

data/CHANGELOG.txt

@@ -0,0 +1,14 @@
+=== 0.0.2 / 2009-05-24
+
+* 1 major changes
+
+  * Guard statements
+  * More tests
+  * Arrow anti-pattern
+
+=== 0.0.1 / 2009-05-21
+
+* 1 major enhancement
+
+  * Anobik's Birthday!
+

data/Manifest

@@ -0,0 +1,8 @@
+test/spec_rack_anobik.rb
+Rakefile
+CHANGELOG.txt
+lib/anobik.rb
+lib/rack/anobik.rb
+anobik-server
+Manifest
+README.rdoc

data/README.rdoc

@@ -0,0 +1,79 @@
+= Anobik
+
+* http://github.com/anupom/anobik
+
+== DESCRIPTION:
+
+Anobik is a simple rack middleware ruby microframework
+
+== FEATURES/PROBLEMS:
+
+Anobik is a Rack based microframework that provides an easy way to map URL patterns to classes.
+URL patterns can be literal strings or regular expressions.
+when URLs are processed:
+	* the beginning and end are anchored (^ $)
+	* an optional end slash is added (/?)
+	* the i option is added for case-insensitive searches
+	* respective class method is called depending on the request method (GET/POST etc.)
+
+It does not provide any view templating or database handling mechanism.
+you can ofcourse use any opensource view templating engine or database access layer with it.
+Anobik is very similar to web.py, but it is not a direct clone of web.py.
+It is ofcourse highly inspired by web.py and other similar lightweight microframeworks.
+
+Anobik acts as a Rack middleware app and that means you can use it with a
+number of webservers including Thin, LiteSpeed, Phusion Passangeretc.
+And BTW, you can also use it with Rails, Sinatra or any other Rack based frameworks.
+
+== SYNOPSIS:
+
+* routes.rb
+    class Routes
+      URLS = {
+        "/" => "index",
+        "/index/(\\d+)" => "index",
+      }
+    end
+
+* index.rb
+    class Index
+      def get(id=nil)
+        "Hello world from anobik! #{id}"
+      end
+    end
+
+* url
+    GET /index/1
+
+== REQUIREMENTS:
+
+Ruby 1.9 and Rack are the pre-requisites
+
+== INSTALL:
+
+    sudo gem install anobik
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 syamantics.com
+
+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,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('anobik', '0.0.2') do |p|
+  p.description    = "Rack middleware Ruby micro-framework"
+  p.url            = "http://github.com/anupom/anobik"
+  p.author         = "Anupom Syam"
+  p.email          = "anupom.syam@gmail.com"
+  p.ignore_pattern = ["nbproject", "tmp"]
+  p.development_dependencies = []
+  p.runtime_dependencies = ['rack']
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each 

data/anobik-server

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+ANOBIK_ROOT = "#{File.dirname(File.expand_path(__FILE__))}/" unless defined?(ANOBIK_ROOT)
+require 'rubygems'
+require 'anobik'
+AnobikServer::run

data/anobik.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{anobik}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Anupom Syam"]
+  s.date = %q{2009-05-24}
+  s.description = %q{Rack middleware Ruby micro-framework}
+  s.email = %q{anupom.syam@gmail.com}
+  s.extra_rdoc_files = ["CHANGELOG.txt", "lib/anobik.rb", "lib/rack/anobik.rb", "README.rdoc"]
+  s.files = ["test/spec_rack_anobik.rb", "Rakefile", "CHANGELOG.txt", "lib/anobik.rb", "lib/rack/anobik.rb", "anobik-server", "Manifest", "README.rdoc", "anobik.gemspec"]
+  s.has_rdoc = true
+  s.homepage = %q{http://github.com/anupom/anobik}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Anobik", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{anobik}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Rack middleware Ruby micro-framework}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+    else
+      s.add_dependency(%q<rack>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rack>, [">= 0"])
+  end
+end

data/lib/anobik.rb

@@ -0,0 +1,75 @@
+require 'rack'
+require 'rack/anobik'
+require 'optparse'
+
+class AnobikServer
+  #
+  # Runs the Anobik middleware app
+  #
+  def self.run
+    #partially stolen from Rails
+    options = {
+      :Port => 3001,
+      :Host => "0.0.0.0",
+      :detach => false,
+      :debugger => false,
+      :production => false
+    }
+
+    ARGV.clone.options do |option|
+      option.on("-p", "--port=port", Integer,
+              "Runs Server on the specified port.", "Default: #{options[:Port]}") { |v| options[:Port] = v }
+      option.on("-b", "--binding=ip", String,
+              "Binds Server to the specified ip.", "Default: #{options[:Host]}") { |v| options[:Host] = v }
+      option.on("-d", "--daemon", "Make server run as a Daemon.") { options[:detach] = true }
+      option.on("-x", "--production", "Run the server in production mode.") { options[:production] = true }
+      option.on("-u", "--debugger", "Enable rack server debugging.") { options[:debugger] = true }
+
+      option.separator ""
+
+      option.on("-h", "--help", "Show this help message.") { puts option.help; exit }
+      option.parse!
+    end
+
+    unless server = Rack::Handler.get(ARGV.first) rescue nil
+      begin
+        server = Rack::Handler::Mongrel
+      rescue LoadError => e
+        server = Rack::Handler::WEBrick
+      end
+    end
+
+    puts "=> Booting with #{server}"
+    puts "=> Running in production mode" if options[:production]
+    puts "=> Application starting on http://#{options[:Host]}:#{options[:Port]}#{options[:path]}"
+
+    if options[:detach]
+      puts "=> Running as deamon with pid: #{Process.pid}"
+      Process.daemon
+    else
+       puts "=> Call with -d to detach"
+    end
+
+    app = Rack::Builder.new {
+      use Rack::CommonLogger if options[:debugger]
+      use Rack::ShowExceptions
+      use Rack::ShowStatus
+      use Rack::Static, :urls => ['/statics']
+      use Rack::Anobik, :url => '/',  :production => options[:production]
+
+      run lambda { |env|
+          [404, {'Content-Type' => 'text/plain'}, 'Not a Anobik Request :)']
+       }
+    }.to_app
+
+    trap(:INT) { exit }
+
+    puts "=> Ctrl-C to shutdown server"
+
+    begin
+      server.run app, options.merge(:AccessLog => [])
+    ensure
+      puts "Exiting"
+    end
+  end
+end

data/lib/rack/anobik.rb

@@ -0,0 +1,159 @@
+module Rack
+#
+# Anobik is a Rack based microframework that provides an easy way to map URL patterns to classes.
+# URL patterns can be literal strings or regular expressions.
+# when URLs are processed:
+# 	* the beginning and end are anchored (^ $)
+# 	* an optional end slash is added (/?)
+# 	* the i option is added for case-insensitive searches
+# 	* respective class method is called depending on the request method (GET/POST etc.)
+#
+# It does not provide any view templating or database handling mechanism.
+# you can ofcourse use any opensource view templating engine or database access layer with it.
+# Anobik is very similar to web.py, but it is not a direct clone of web.py.
+# It is ofcourse highly inspired by web.py and other similar lightweight microframeworks.
+#
+# Anobik acts as a Rack middleware app and that means you can use it with a
+# number of webservers including Thin, LiteSpeed, Phusion Passangeretc.
+# And BTW, you can also use it with Rails, Sinatra or any other Rack based frameworks.
+#
+# e.g:
+#
+# * routes.rb
+# class Routes
+#   URLS = {
+#     "/" => "index",
+#     "/index/(\\d+)" => "index",
+#   }
+# end
+#
+# * index.rb
+# class Index
+#   def get (id=nil)
+#     "Hello world from web.rb! #{id}"
+#   end
+# end
+#
+# * url
+# GET /index/1
+#
+# MIT-License - Anupom Syam
+#
+  class Anobik
+
+    ERR_MESSAGES = {
+      :missing_method => "Method %s::#%s not supported",
+      :missing_class  => "Class %s not found in file %s.rb",
+      :missing_file   => "File %s.rb missing in directory %s",
+      :invalid_path   => "URL pattern unknown, Path %s not found",
+      :missing_routes_file   => "Routes file %s.rb is not present in directory %s",
+      :missing_routes_class   => "Class %s is missing in routes file %s.rb"
+    }
+    STATUSES = { :ok => 200, :bad_request => 404}
+    ROUTES_FILENAME = 'routes'
+    
+    def initialize app, options
+      @app = app
+      @url = options[:url] || ''
+      @url = '' if @url == '/'
+      @production = options[:production]
+      $LOAD_PATH << ANOBIK_ROOT
+    end
+
+    def call env
+      req = Rack::Request.new(env)
+      path = req.path_info
+      method = req.request_method
+
+      @headers = { 'Content-Type' => 'text/html' }
+
+      #guard statements:
+      unless path.index(@url) == 0
+        return @app.call(env)
+      end
+
+      begin
+        anobik_load ROUTES_FILENAME
+      rescue Exception
+        return anobik_error(:missing_routes_file, [ROUTES_FILENAME, ANOBIK_ROOT])
+      end
+      
+      routes_classname = to_class_name ROUTES_FILENAME
+      begin
+        raise NameError unless Object.const_get(routes_classname).kind_of? Class
+     rescue Exception
+        return anobik_error(:missing_routes_class, [routes_classname, ANOBIK_ROOT+ROUTES_FILENAME])
+      end
+      
+      begin
+        urls = Object.const_get(routes_classname)::URLS
+        raise unless urls.kind_of? Hash
+      rescue Exception
+        urls = {  "/" => "index" }
+      end
+      controller_filename = nil
+      matches = nil
+      urls.each do |regex, filename|
+        matches = path.match(Regexp.new('^' << @url << regex << '/?$', true))
+        unless  matches.nil?
+          controller_filename = filename
+          break
+        end
+      end
+
+      if controller_filename.nil?
+        return anobik_error(:invalid_path, [path])
+      end
+
+      begin
+        anobik_load controller_filename
+      rescue Exception
+        return anobik_error(:missing_file, [controller_filename, ANOBIK_ROOT])
+      end
+
+      controller_classname = to_class_name controller_filename
+      begin
+        raise NameError unless Object.const_get(controller_classname).kind_of? Class
+      rescue Exception
+        return anobik_error(:missing_class, [controller_classname, ANOBIK_ROOT+controller_filename])
+      end
+
+      controller = Object.const_get(controller_classname).new
+      unless controller.respond_to?(method)
+        return anobik_error(:missing_method, [controller_classname, method])
+      end
+
+      body = eval 'controller.' << method <<
+                        '(' << matches.captures.join(' , ') << ')'
+
+      [STATUSES[:ok], @headers, body]
+   end
+
+    def to_class_name filename
+      #shamelessly copied from Rails
+      filename.to_s.gsub(/\/(.?)/) { "::" + $1.upcase }.gsub(/(^|_)(.)/) { $2.upcase }
+    end
+
+    def anobik_error(err, array = [])
+      #will be handled by RACK::ShowExceptions
+      raise ERR_MESSAGES[err] % array unless @production
+      #will be handled by RACK::ShowStatus
+      return [STATUSES[:bad_request], @headers, '']
+    end
+
+    def anobik_root
+      ANOBIK_ROOT
+    end
+
+    def anobik_load filename
+      if (@production)
+        require filename
+      else
+        classname = to_class_name(filename).to_sym
+        Object.class_eval { remove_const classname } if Object.const_defined? classname
+        Kernel.load filename + '.rb'
+      end
+    end
+    
+  end
+end

data/test/spec_rack_anobik.rb

@@ -0,0 +1,248 @@
+require 'test/spec'
+
+require 'rack'
+require 'rack/mock'
+require 'rack/anobik'
+
+ANOBIK_ROOT = "#{File.dirname(File.expand_path(__FILE__))}/" unless defined?(ANOBIK_ROOT)
+
+describe "Rack::Anobik" do
+
+  class EqualResponse < Test::Spec::CustomShould
+    def assumptions(response)
+      response.status.should.equal(object[:status])
+      response.body.should.match(object[:body])
+    end
+  end
+
+  def equal_response(response)
+    EqualResponse.new(response)
+  end
+
+  class EqualNotFound < Test::Spec::CustomShould
+    def assumptions(response)
+      response.status.should.equal(404)
+      response.body.should.match('Not Found')
+    end
+  end
+
+  def equal_not_found()
+    EqualNotFound.new(nil)
+  end
+
+  setup do
+    remove_routes_file
+    remove_file 'index'
+  end
+
+  it "should return default when non-anobik URL with production" do
+    response = anobik_app_production( '/other/').get('/')
+    response.should equal_response({:status => 200, :body => 'Not a Anobik Request'})
+  end
+
+  it "should return default when non-anobik url requested with dev" do
+    response = anobik_app_dev('/other/').get('/')
+    response.should equal_response({:status => 200, :body => 'Not a Anobik Request'})
+  end
+
+  it "should have the same ANOBIK_ROOT" do
+      ANOBIK_ROOT.should.equal( Rack::Anobik.new(nil, options('/', false)).anobik_root)
+  end
+
+  it "should return 404 when routes.rb is not present with production" do
+    remove_routes_file
+    response = anobik_app_production.get('/')
+    response.should equal_not_found
+  end
+
+  it "should return 500 when routes.rb is not present with dev" do
+    remove_routes_file
+    response = anobik_app_dev.get('/')
+    response.should equal_response({:status => 500, :body => 'routes.rb ' << 'is not present in directory'})
+  end
+
+  it "should return 404 when Routes class is not defined with production" do
+    create_routes_file ''
+    response = anobik_app_production.get('/')
+    response.should equal_not_found
+    remove_routes_file
+  end
+
+  it "should return 500 when Routes class is not defined with dev" do
+    create_routes_file ''
+    response = anobik_app_dev.get('/')
+    response.should equal_response({:status => 500, :body => 'Class Routes ' << 'is missing in routes file'})
+    remove_routes_file
+  end
+
+  it "should return 404 when no URL pattern matches with production" do
+    create_routes_file "class Routes\nend"
+    response = anobik_app_production.get('/unknown/pattern')
+    response.should equal_not_found
+    remove_routes_file
+  end
+
+  it "should return 500 when no URL pattern matches with dev" do
+    create_routes_file "class Routes\nend"
+    response =anobik_app_dev.get('/unknown/pattern')
+    response.should equal_response({:status => 500, :body => 'URL pattern ' << 'unknown'})
+    remove_routes_file
+  end
+
+  it "should return 404 when filename does not exist with production" do
+    remove_file 'index'
+    create_routes_file "class Routes\nend"
+    response = anobik_app_production.get('/')
+    response.should equal_not_found
+    remove_routes_file
+  end
+
+  it "should return 500 when filename does not exist with dev" do
+    remove_file 'index'
+    create_routes_file "class Routes\nend"
+    response = anobik_app_dev.get('/')
+    response.should equal_response({:status => 500, :body => 'missing ' << 'in directory'})
+    remove_routes_file
+  end
+
+  it "should return 404 when filename exists but class missing with production" do
+    create_routes_file "class Routes\nend"
+    create_file 'index', ''
+    response = anobik_app_production.get('/')
+    response.should equal_not_found
+    remove_routes_file
+    remove_file 'index'
+  end
+
+  it "should return 500 when filename exists but class missing with dev" do
+    create_routes_file "class Routes\nend"
+    create_file 'index', ''
+    response = anobik_app_dev.get('/')
+    response.should equal_response({:status => 500, :body => 'Class Index ' << 'not found in file'})
+    remove_routes_file
+    remove_file 'index'
+  end
+
+  it "should return 404 when class exists but method missing with production" do
+    create_routes_file "class Routes\nend"
+    create_file 'index', "class Index\nend"
+    response = anobik_app_production.get('/')
+    response.should equal_not_found
+    remove_routes_file
+    remove_file 'index'
+  end
+
+  it "should return 500 when class exists but method missing with dev" do
+    create_routes_file "class Routes\nend"
+    create_file 'index', "class Index\nend"
+    response = anobik_app_dev.get('/')
+    response.should equal_response({:status => 500, :body => 'Method Index::#GET ' << 'not supported'})
+    remove_routes_file
+    remove_file 'index'
+  end
+
+  it "should return 200 for GET when everything's ok" do
+    create_routes_file routes_file
+    create_file 'index', index_file
+    response = anobik_app_dev.get('/')
+    response.should equal_response({:status => 200, :body => 'GET_' << 'SUCCESS'})
+    remove_routes_file
+    remove_file 'index'
+  end
+
+  it "should return 200 when regex is valid" do
+    create_routes_file routes_file
+    create_file 'index', index_file
+    response = anobik_app_dev.get('/index/98')
+    response.should equal_response({:status => 200, :body => 'GET_' << 'SUCCESS98'})
+    remove_routes_file
+    remove_file 'index'
+  end
+
+  xit "should return 200 when root URL is called and index is  present" do
+    create_routes_file routes_file
+    create_file 'index', index_file
+    response = anobik_app_dev.get('/')
+    response.should equal_response({:status => 200, :body => 'GET_' << 'SUCCESS'})
+    remove_routes_file
+    remove_file 'index'
+  end
+  
+  it "should handle POST data" do
+    create_routes_file routes_file
+    create_file 'index', index_file
+    response = anobik_app_dev.post('/')
+    response.should equal_response({:status => 200, :body => 'POST_SUC' << 'CESS'})
+    remove_routes_file
+    remove_file 'index'
+  end
+  
+  xit "should handle DELETE requests" do
+  end
+  
+  xit "should handle PUT request" do
+  end
+
+  xit "should handle pseudo-DELETE requests" do
+  end
+
+  xit "should handle pseudo-PUT request" do
+  end
+
+  def anobik_app options
+    Rack::Builder.new {
+      use Rack::ShowExceptions
+      use Rack::ShowStatus
+      use Rack::Static, :urls => ['/statics']
+      use Rack::Anobik, :url => options[:url],  :production => options[:production]
+      run lambda { |env|
+        [200, { 'Content-Type' => 'text/plain' }, 'Not a Anobik Request :)']
+      }
+    }.to_app
+  end
+
+  def anobik_app_production anobik_url=nil
+    anobik_url = '/' if anobik_url.nil?
+    Rack::MockRequest.new(anobik_app options(anobik_url, true))
+  end
+
+  def anobik_app_dev anobik_url=nil
+    anobik_url = '/' if anobik_url.nil?
+    Rack::MockRequest.new(anobik_app options(anobik_url, false))
+  end
+
+  def options url, production
+    { :url => url,  :production =>production }
+  end
+
+  def create_routes_file str
+    create_file 'routes', str
+  end
+
+  def remove_routes_file
+    remove_file 'routes'
+  end
+
+  def create_file filename, str
+    ::File.open(ANOBIK_ROOT + filename + '.rb', 'w') {|f| f.write(str) }
+  end
+
+  def remove_file filename
+    ::File.delete(ANOBIK_ROOT + filename + '.rb')  if ::File.exist?(ANOBIK_ROOT + filename + '.rb')
+  end
+
+  def index_file
+    return "class Index\n" <<
+              "def GET(id=nil)\n" <<
+                "'GET_SUCCESS'<<id.to_s\n" <<
+              "end\n" <<
+              "def POST()\n" <<
+                "'POST_SUCCESS'\n" <<
+              "end\n" <<
+            "end"
+  end
+  
+  def routes_file
+    "class Routes\nURLS = {\n'/' => 'index',\n'/index/(\\d+)' => 'index'\n}\nend"
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: anupom-anobik
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Anupom Syam
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-24 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: 
+description: Rack middleware Ruby micro-framework
+email: anupom.syam@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG.txt
+- lib/anobik.rb
+- lib/rack/anobik.rb
+- README.rdoc
+files: 
+- test/spec_rack_anobik.rb
+- Rakefile
+- CHANGELOG.txt
+- lib/anobik.rb
+- lib/rack/anobik.rb
+- anobik-server
+- Manifest
+- README.rdoc
+- anobik.gemspec
+has_rdoc: true
+homepage: http://github.com/anupom/anobik
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Anobik
+- --main
+- README.rdoc
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: anobik
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Rack middleware Ruby micro-framework
+test_files: []
+