Neurogami-restafarian 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/History.txt

@@ -0,0 +1,4 @@
+== 1.0.0 / 2008-12-20
+
+* 1 major enhancement
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,10 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/restafarian
+lib/restafarian.rb
+lib/restafarian/restafarian.rb
+spec/restafarian_spec.rb
+spec/spec_helper.rb
+test/test_restafarian.rb

data/README.md

@@ -0,0 +1,58 @@
+Neurogami::Restafarian
+=======================
+
+by James Britt /Neurogami
+www.neurogami.com
+
+
+DESCRIPTION
+-----------
+
+A bit of Rack middleware to do REST routing
+
+FEATURES/PROBLEMS
+-----------------
+
+* FIXME (list of features or problems)
+* too many FIXME's !
+
+SYNOPSIS
+-----------
+
+  FIXME (code sample of usage)
+
+REQUIREMENTS
+------------
+
+* FIXME (list of requirements)
+
+INSTALL
+---------
+
+* FIXME (sudo gem install, anything else)
+
+LICENSE
+-------
+
+(The MIT License)
+
+Copyright (c) 2008 James Britt /Neurogami LLC 
+
+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,26 @@
+# 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
+  load 'tasks/setup.rb'
+end
+
+ensure_in_path 'lib'
+require 'restafarian'
+
+task :default => 'spec:run'
+
+PROJ.name = 'restafarian'
+PROJ.authors = 'James Britt'
+PROJ.email = 'james@neurogami.com'
+PROJ.url = 'http:// neurogami.com/code/restafarian'
+PROJ.version = Restafarian::VERSION
+# PROJ.rubyforge.name = 'restafarian'
+
+PROJ.spec.opts << '--color'
+
+# EOF

data/bin/restafarian

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib restafarian]))
+
+# Put your code here
+
+# EOF

data/lib/restafarian.rb

@@ -0,0 +1,49 @@
+module Restafarian
+
+  # :stopdoc:
+  VERSION = '0.1.0'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # 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 rquire 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 )
+    (STDERR.puts( " \n :DEBUG\n #{__FILE__}:#{__LINE__} self.require_all_libs_relative_to  #{fname}" ); STDERR.flush ) if ENV['JAMES_SCA_JDEV_MACHINE'] # JGBDEBUG
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path( ::File.join(::File.dirname(fname), dir, '**', '*.rb'))
+    warn "search_me: #{search_me}" 
+       Dir.glob(search_me).sort.each {|rb| 
+                                     warn rb
+                                     require rb}
+  end
+
+end  # module Restafarian
+
+Restafarian.require_all_libs_relative_to(__FILE__)
+# EOF

data/lib/restafarian/restafarian.rb

@@ -0,0 +1,157 @@
+require 'pp'
+module Rack
+
+  # We use this to memoize rack.input reading so we do not
+  # lose this in the actual app after reading the stream in
+  # our middleware
+  # SEEMS TO BE UNCALLED FOR SINCE WE CAN REWIND THE REAL THING
+  #class InputWrapper
+
+  #  def initialize(input)
+  #    @input = input
+  #    @input_data = nil
+  #  end
+
+  #  ## * +gets+ must be called without arguments and return a string,
+  #  ##   or +nil+ on EOF.
+  #  def gets(*args)
+  #    return @input_data if @input_data 
+  #    @input_data = @input.gets
+  #    @input_data 
+  #  end
+
+
+  #  ## * +read+ must be called without or with one integer argument
+  #  ##   and return a string, or +nil+ on EOF.
+  #  def read(*args)
+  #    return @input_data if @input_data 
+  #    @input_data  = @input.read(*args)
+  #    @input_data 
+  #  end
+
+  #  ## * +each+ must be called without arguments and only yield Strings.
+  #  def each(*args)
+  #    (STDERR.puts( " :DEBUG #{__FILE__}:#{__LINE__} each" ); STDERR.flush ) if ENV['JAMES_SCA_JDEV_MACHINE'] # JGBDEBUG'']"}}"))
+  #    @input.each { |line|
+  #      yield line
+  #    }
+  #  end
+
+
+  #  def rewind *args
+  #    # ???
+  #  end
+
+
+
+  module Neurogami
+
+    class Restafarian
+
+      RESTA_METHODS = %w(index create delete update )
+      
+      F = ::File
+
+      def to_rest_parts(path)
+        # We have some scenarios:
+        #  '/'
+        #  ''
+        #  '/something'
+        #  '/something/'
+        #  '/foo/bar'
+        #
+        #  We can strip any wrapping '/' chars so that
+        #  we get
+        #  ''
+        #  'foo'
+        #  'foo/bar'
+        #
+        path.sub!( /^\//, '')
+        path.sub!( /\/$/, '')
+        path.strip!
+
+        return {:base => '', :args => [] }   if path.empty?
+
+        parts = path.split('/')
+        base = parts.shift
+        { :base => base, :args => parts }
+      end
+
+      def initialize app, path='./'
+        @app = app
+        @root =  F.expand_path(path)
+      end
+
+
+      def env_input_to_hash env
+        input_data = env['rack.input'].read
+        return {} if input_data.to_s.strip.empty?
+        input_data = CGI.unescape(input_data.to_s.strip)
+        return {} unless input_data =~ /=/
+        pairs = input_data.split('&')
+        h = {}
+        pairs.each { |pair| k,v = pair.split('='); h[k] = v }
+        h
+      end
+
+      def call env 
+        path = env["PATH_INFO"]
+        request_hash = env_input_to_hash(env) 
+        env['rack.input'].rewind
+        warn "request_hash  = #{request_hash.pretty_inspect }" 
+
+
+        # Allow for clients to pass psuedo request type via, say, a form field
+        # and update the values passed to the end app
+
+        # Ramaze seems to depend on the request methof being POST or GET; having
+        # PUT seems to prevent code from getting the posted values.
+        original_request_method  = env['REQUEST_METHOD'].to_s 
+        STDERR.puts( ":DEBUG #{__FILE__}:#{__LINE__}    request_hash = #{request_hash.inspect} " ) if ENV['JAMES_SCA_JDEV_MACHINE'] # JGBDEBUG 
+        env['REQUEST_METHOD'] = request_hash['X-REQUEST_METHOD'] if request_hash['X-REQUEST_METHOD']
+        path_segements = to_rest_parts(path)
+
+        STDERR.puts( "+++++ DEBUG #{__FILE__}:#{__LINE__}  env['REQUEST_METHOD'].upcase = #{env['REQUEST_METHOD'].upcase}" ) if ENV['JAMES_SCA_JDEV_MACHINE'] # JGBDEBUG 
+
+        # Do not allow direct calls to REST mappings
+        return [403, {'Content-Type' => 'text/plain'}, '' ]  if  RESTA_METHODS.include?(path_segements[:base])
+        return [403, {'Content-Type' => 'text/plain'}, '' ]  if path_segements[:args] && RESTA_METHODS.include?(path_segements[:args].first)
+
+        action = case env['REQUEST_METHOD'].upcase
+                 when 'GET'
+               '' 
+                 when 'PUT' 
+               'update'
+                 when 'DELETE'
+               'delete'
+                 when 'POST'
+                   #warn (env.methods - Object.methods).sort.join("\n")
+                   #rack_response = Rack::Response.new
+                   #rack_request = Rack::Request.new(env)
+                   #warn rack_request.class
+                   #warn (rack_request.methods - Object.methods).sort.join("\n")
+                   #warn "BODY: " + rack_request.body.read
+
+               'create'
+                 else
+               'index' # Maybe not?
+                 end
+
+        segments = [path_segements[:base], action, path_segements[:args] ].flatten
+        segments.delete_if{|a| a.strip.empty? } 
+
+        new_path = '/' + segments.flatten.join('/')
+        env['PATH_INFO']     = new_path 
+        env["REQUEST_PATH"]  = new_path 
+        env["REQUEST_URI"]   = new_path + ( env['QUERY_STRING'].to_s.strip.empty? ? '' : '?' + env['QUERY_STRING'].to_s.strip )
+        env['REQUEST_METHOD']  = original_request_method 
+        warn "Middleware Restafarian ..."
+       
+        STDERR.puts( ":DEBUG #{__FILE__}:#{__LINE__}  New env = #{env.pretty_inspect}" ) if ENV['JAMES_SCA_JDEV_MACHINE'] # JGBDEBUG
+        
+        
+        return @app.call(env)
+      end
+    end
+  end
+end

data/spec/restafarian_spec.rb

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

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+
+require File.expand_path(
+    File.join(File.dirname(__FILE__), %w[.. lib restafarian]))
+
+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

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: Neurogami-restafarian
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- James Britt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-12 00:00:00 -07:00
+default_executable: restafarian
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bones
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.0
+    version: 
+description: A bit of Rack middleware to do REST routing
+email: james@neurogami.com
+executables: 
+- restafarian
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.md
+- bin/restafarian
+files: 
+- .gitignore
+- History.txt
+- Manifest.txt
+- README.md
+- Rakefile
+- bin/restafarian
+- lib/restafarian.rb
+- lib/restafarian/restafarian.rb
+- restafarian.gemspec
+- spec/restafarian_spec.rb
+- spec/spec_helper.rb
+- test/test_restafarian.rb
+has_rdoc: false
+homepage: http://neurogami.com/code/restafarian
+post_install_message: 
+rdoc_options: 
+- --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: !binary |
+  AA==
+
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A bit of Rack middleware to do REST routing
+test_files: 
+- test/test_restafarian.rb