herbert 0.0.1 → 0.0.2

data/lib/herbert/Ajaxify.rb

@@ -1,5 +1,9 @@
 module Herbert
+	
+	# Enhances AJAJ/AJAX support
   module Ajaxify
+		
+		# Headers to send with each request
     Headers = {
       'Access-Control-Allow-Methods' => %w{POST GET PUT DELETE OPTIONS},
       'Access-Control-Allow-Headers' => %w{Content-Type X-Requested-With},
@@ -8,6 +12,14 @@ module Herbert
       'X-Build' => [Herbert::Utils.version]
     }
 
+		# * Loads config/headers.rb
+		# 
+		# * Enables header processing
+		# 
+		# * Registers CORS proxy for external services
+		# 
+		# @param [Sinatra::Base descendant]
+		#
     def self.registered(app)
       # Heeeaderzz!!! Gimme heaaaderzzz!!!
       path = File.join(app.settings.root, 'config','headers.rb')
@@ -23,7 +35,7 @@ module Herbert
       end
 
       app.before do
-      # Add the headers to the response
+				# Add the headers to the response
         Headers.each {|name, value|
           value = [value] unless value.is_a?(Array)
           value.map! {|val|
@@ -35,16 +47,15 @@ module Herbert
 
       # Proxy for not CORS enables services such as 
       # Google Maps
-      # /proxy/<url to fetch>
-      if app.get '/proxy/:url' do
-        url = URI.parse(URI.decode(params[:url]))
-        res = Net::HTTP.start(url.host, 80) {|http|
-          http.get(url.path + (url.query ? '?' + url.query : ''))
-        }
-        response['content-type'] = res['content-type']
-        res.body
-      end
+      # /proxy/url?=
+      app.get '/proxy/' do
+				url = URI.parse(URI.encode(params[:url]))
+				res = Net::HTTP.start(url.host, 80) {|http|
+					http.get(url.path + '?' + url.query)
+				}
+				response['content-type'] = res['content-type']
+				res.body
+			end
     end
-   end
-  end
+	end
 end

data/lib/herbert/AppLogger.rb

@@ -2,14 +2,22 @@ module Herbert
   # Full-fledged request & response logger with
   # several storage providers (console, mongo, cache)
   class AppLogger
+		
+		# Provider getter
     def self.provider
       @@provider
     end
-
+		
+		# Provider setter
     def self.provider=(prov)
       @@provider = prov
     end
 
+		# Creates log message and passes it to stograge provider
+		#
+		# @param [Sinatra::Request]
+		# @param [Sinatra::Response]
+		#
     def self.log(request, response)
       log = {
         "request"=> {
@@ -44,7 +52,7 @@ module Herbert
         }
       }
 
-      # Extract tha headerz
+      # Extract the headers
       request.env.keys.each do |key|
         if key =~ /^HTTP_/ then
           log['request']['headers'][key.gsub(/^HTTP_/,'')] = request.env[key]
@@ -52,7 +60,7 @@ module Herbert
       end
       # do not log bodies from GET/DELETE/HEAD
       log["request"].delete("body") if %{GET DELETE HEAD}.include?(log["request"]["method"])
-      # If an error occured, add it
+      # If an error has occured, add it
       log["response"]["error"] = request.env['sinatra.error'].to_hash if request.env['sinatra.error']
       id = @@provider.save(log)
       response['X-RequestId'] = id.to_s if @@provider.respond_to?(:id) && response.app.settings.append_log_id
@@ -60,6 +68,8 @@ module Herbert
   end
 	
 	module LoggingProviders
+		
+		# Dumps all logs to STDOUT with pretty formating
 		class StdoutProvider
 			def initialize
 				require 'pp'
@@ -70,18 +80,22 @@ module Herbert
 			end
 		end
 
+		# Persists log in DB
 		class MongoProvider
-
-			Collection = 'logs'
-    
+			Collection = 'logs' 
 			def initialize(db)
 				@db = db
 			end
 
+			# @param [Hash]
 			def save(log)
 				@db[Collection].save(log)
 			end
     
+			# FIXME
+			# "Flag" indicating that this provider returns IDs
+			# 
+			# @return [Boolean]
 			def id
 				true
 			end

data/lib/herbert/ApplicationError.rb

@@ -51,6 +51,8 @@ end
 
 module Sinatra
   class NotFound
+		
+		# Enables Sinatra built-in exceptions to be logged
     def to_hash
       {
         :code => 1003,

data/lib/herbert/Configurator.rb

@@ -1,6 +1,10 @@
 module Herbert
   module Configurator
+		
+		# Sets up the environment so we can set up Herbert
     module Prepatch
+			
+			#
       def self.registered(app)
         # Enable envs such as development;debug, where debug is herberts debug flag
         env = ENV['RACK_ENV'].split(';')

data/lib/herbert/Jsonify.rb

@@ -20,7 +20,7 @@ module Sinatra
     class Sinatra::Request
 
       @is_json = false
-      # Encapsulates #Rack::Request.body in order to remove #IO.String
+      # Encapsulates Rack::Request.body in order to remove #IO.String
       # and therefore to enable repeated reads
       def body_raw
         @body_raw ||= body(true).read
@@ -39,7 +39,7 @@ module Sinatra
         end
       end
 
-      # Overrides #Rack::Request.body, returns native #Hash
+      # Overrides Rack::Request.body, returns native #Hash
       # Preserves access to underlying @env['rack.input'] #IO.String
       def body(rack = false)
         if rack then

data/lib/herbert/Resource.rb

@@ -1,19 +1,15 @@
 module Herbert
-  # This class allows you to organize code by REST resources.
-	# Any class that subclasses Herbert::Resource is automatically "merged" 
-	# into the application. Resource name will be derived from the class name.
+	# When extended, it virtually "merges" the overriding class into the app.
 	# 
-	# For instance,
-	#   class Messages < Herbert::Resource
-  #     get '/' do
-  #    	  "here's a message for you!"
-  #     end
+	#  class Messages
+	#   get '/'
 	#   end
-	# will respond to 
-	#   GET /messages/
-	# 
-	
+	#  end
+	# will enable your app to respond to
+	#  GET /messages/
   class Resource
+		
+		# Instantizing this class is forbidden
     def self.new
       raise StandardError.new('You are not allowed to instantize this class directly')
     end
@@ -28,15 +24,17 @@ module Herbert
     end
   end
 
-	# Loads all Herbert resources
+	# Loads all Herberts' resources
   module ResourceLoader
+		
+		# Loads all application resources
     def self.registered(app)
 			# Inject refence to the app into Resource
       Resource.class_eval do
 				define_singleton_method :app do
 					app
 				end
-			end
+			end			
 			
 			# And load all resource definitions
       path = File.join(app.settings.root, 'Resources')

data/lib/herbert/loader.rb

@@ -4,6 +4,8 @@ require 'memcache'
 require 'sinatra/base'
 require 'kwalify'
 require 'active_support'
+$:.unshift(File.dirname(__FILE__))
+require 'version'
 
 module Herbert
   ::Logger.class_eval do
@@ -19,23 +21,27 @@ module Herbert
   # Plug it in, the monkey style :]
   module ::Kernel
     @@logger = Logger.new(STDOUT)
+		
+		# @return [Logger] The globally available logger
     def log
       @@logger
     end
   end
 	
+	# Bootstraps Herbert
   module Loader
     $HERBERT_PATH = File.dirname(__FILE__)
-    log.h_info("Here comes Herbert. He's a berserker!")
+    log.h_info("Here comes Herbert (v#{Herbert::VERSION}). He's a berserker!")
     # because order matters
     %w{Utils Jsonify Configurator Error Services Ajaxify AppLogger Log Resource}.each {|file|
       require $HERBERT_PATH + "/#{file}.rb"
     }
-
+		
+		# Sets up some default settings and loads all components
     def self.registered(app)
       # Set some default
       # TODO to external file?
-      app.set :log_requests, :db
+      app.set :log_requests, :db unless app.respond_to? :log_requests
       app.enable :append_log_id # If logs go to Mongo, IDs will be appended to responses
       ## register the ;debug flag patch first to enable proper logging
       app.register Herbert::Configurator::Prepatch
@@ -52,12 +58,14 @@ module Herbert
       app.helpers Sinatra::Database
       app.register Sinatra::Cache
       app.helpers Sinatra::Cache
-      app.register Sinatra::Validation::Extension
-      app.helpers Sinatra::Validation::Helpers
+      if app.respond_to?(:validation) && app.validation then
+				app.register Sinatra::Validation::Extension
+				app.helpers Sinatra::Validation::Helpers
+			end
       app.register Herbert::Ajaxify
       app.helpers Sinatra::Log
       app.register Sinatra::Log::Extension
-			app.register Herbert::ResourceLoader
+			app.register Herbert::ResourceLoader if app.respond_to?(:resources) && app.resources
     end
   end
 end

data/lib/herbert/version.rb

@@ -1,3 +1,3 @@
 module Herbert
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Pavel Kalvoda
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-18 00:00:00 +02:00
+date: 2011-06-24 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -134,7 +134,6 @@ files:
 - Gemfile
 - Rakefile
 - herbert.gemspec
-- lib/file.rb
 - lib/herbert.rb
 - lib/herbert/Ajaxify.rb
 - lib/herbert/AppLogger.rb

data/lib/file.rb

@@ -1,2 +0,0 @@
-puts "file got loaded"
-