halcyon 0.4.0 → 0.5.0

data/lib/halcyon/client/ssl.rb

@@ -0,0 +1,38 @@
+require 'net/https'
+
+module Halcyon
+  class Client
+    private
+    
+    def request(req, headers={})
+      # set default headers
+      req["Content-Type"] = CONTENT_TYPE
+      req["User-Agent"] = USER_AGENT
+      
+      # apply provided headers
+      self.headers.merge(headers).each do |(header, value)|
+        req[header] = value
+      end
+      
+      # prepare and send HTTPS request
+      serv = Net::HTTP.new(self.uri.host, self.uri.port)
+      serv.use_ssl = true if self.uri.scheme == 'https'
+      res = serv.start {|http|http.request(req)}
+      
+      # parse response
+      body = JSON.parse(res.body).to_mash
+      
+      # handle non-successes
+      if self.options[:raise_exceptions] && !res.kind_of?(Net::HTTPSuccess)
+        raise self.class.const_get(Exceptions::HTTP_STATUS_CODES[body[:status]].tr(' ', '_').camel_case.gsub(/( |\-)/,'')).new
+      end
+      
+      # return response
+      body
+    rescue Halcyon::Exceptions::Base => e
+      # log exception if logger is in place
+      raise
+    end
+    
+  end
+end

data/lib/halcyon/controller.rb

@@ -0,0 +1,154 @@
+module Halcyon
+  
+  # The base controller providing methods application controllers will need.
+  class Controller
+    include Exceptions
+    
+    attr_accessor :env
+    attr_accessor :request
+    attr_accessor :session
+    attr_accessor :cookies
+    
+    # Sets the <tt>@env</tt> and <tt>@request</tt> instance variables, used by
+    # various helping methods.
+    #   +env+ the request environment details
+    def initialize(env)
+      @env = env
+      @request = Rack::Request.new(@env)
+    end
+    
+    class << self
+      
+      # Not implemented.
+      def before method, &proc
+        raise NotImplemented.new
+      end
+      
+      # Not implemented.
+      def after method, &proc
+        raise NotImplemented.new
+      end
+      
+    end
+    
+    # Returns the request params and the route params.
+    # 
+    # Returns Hash:{route_params, get_params, post_params}.to_mash
+    def params
+      self.request.params.merge(self.env['halcyon.route']).to_mash
+    end
+    
+    # Returns any POST params, excluding GET and route params.
+    # 
+    # Returns Hash:{...}.to_mash
+    def post
+      self.request.POST.to_mash
+    end
+    
+    # Returns any GET params, excluding POST and route params.
+    # 
+    # Returns Hash:{...}.to_mash
+    def get
+      self.request.GET.to_mash
+    end
+    
+    # Returns query params (usually the GET params).
+    # 
+    # Returns Hash:{...}.to_mash
+    def query_params
+      Rack::Utils.parse_query(self.env['QUERY_STRING']).to_mash
+    end
+    
+    # The path of the request URL.
+    # 
+    # Returns String:/path/of/request
+    def uri
+      # special parsing is done to remove the protocol, host, and port that
+      # some Handlers leave in there. (Fixes inconsistencies.)
+      URI.parse(self.env['REQUEST_URI'] || self.env['PATH_INFO']).path
+    end
+    
+    # The request method.
+    # 
+    # Returns Symbol:get|post|put|delete
+    def method
+      self.env['REQUEST_METHOD'].downcase.to_sym
+    end
+    
+    # Formats message into the standard success response hash, with a status of
+    # 200 (the standard success response).
+    #   +body+ the body of the response
+    # 
+    # The <tt>body</tt> defaults to <tt>String:"OK"</tt> but can be anything,
+    # including hashes, arrays, and literal values.
+    # 
+    # Alternatively, if you choose to modify the message format, add a key in
+    # addition to <tt>:status</tt> and <tt>:body</tt>. For example:
+    # <tt>{:status=>200,:body=>'OK', :stats=>[...], :receipt=>...}</tt>
+    # 
+    # Changes to this method described above should be reflected for in the
+    # clients as well.
+    # 
+    # Aliases
+    #   <tt>success</tt>
+    # 
+    # Returns Hash:{:status=>200, :body=>body}
+    def ok(body='OK')
+      {:status => 200, :body => body}
+    end
+    alias_method :success, :ok
+    
+    # Formats message into the standard response hash, with a status of 404
+    # (the standard "Not Found" response value).
+    #   +body+ the body of the response
+    # 
+    # The <tt>body</tt> defaults to <tt>String:"Not Found"</tt> but can be
+    # anything, including hashes, arrays, and literal values. However, it is
+    # strongly discouraged since the <tt>body</tt> should simply describe the
+    # problem with processing their request.
+    # 
+    # Alternatively, if you choose to modify the message format, add a key in
+    # addition to <tt>:status</tt> and <tt>:body</tt>. For example:
+    # <tt>{:status=>404,:body=>'Not Found', :suggestions=>[...]}</tt>
+    # 
+    # Changes to this method described above should be reflected for in the
+    # clients as well.
+    # 
+    # Aliases
+    #   <tt>missing</tt>
+    # 
+    # Returns Hash:{:status=>404, :body=>body}
+    def not_found(body='Not Found')
+      {:status => 404, :body => body}
+    end
+    alias_method :missing, :not_found
+
+    # Returns the name of the controller in path form.
+    def self.controller_name
+      @controller_name ||= self.name.to_const_path
+    end
+
+    # Returns the name of the controller in path form.
+    def controller_name
+      self.class.controller_name
+    end
+
+    # Generates a URL based on the given name and passed
+    # options. Used with named routes and resources:
+    #
+    #  url(:users) # => "/users"
+    #  url(:admin_permissons) # => "/admin/permissions"
+    #  url(:user, @user) # => "/users/1"
+    #
+    # Based on the identical method of Merb's controller.
+    def url(name, rparams={})
+      Halcyon::Application::Router.generate(name, rparams,
+        { :controller => controller_name,
+          :action => method
+        }
+      )
+    end
+    
+  end
+  
+end

data/lib/halcyon/exceptions.rb

@@ -1,13 +1,17 @@
-#--
-#  Created by Matt Todd on 2007-12-14.
-#  Copyright (c) 2007. All rights reserved.
-#++
-
-#--
-# module
-#++
-
 module Halcyon
+  
+  # Included into Halcyon::Application in order to provide exception classes
+  # like NotModified, OK, Forbidden, or NotFound to simplify generating error
+  # methods and handling specific error instances.
+  # 
+  # It is not intended for these exceptions to be destructive or process-ending
+  # in the least, only to simplify finishing up processing and relaying
+  # appropriate status to the caller/client.
+  # 
+  # These classes inherit from StandardError because it is convenient to raise
+  # a given status and let Halcyon's dispatcher handle sending the message to
+  # the client, but it is possible to just instantiate an object without
+  # throwing an exception if necessary.
   module Exceptions #:nodoc:
     
     #--
@@ -15,19 +19,37 @@ module Halcyon
     #++
     
     class Base < StandardError #:nodoc:
-      attr_accessor :status, :error
-      def initialize(status, error)
+      attr_accessor :status, :body
+      def initialize(status, body)
         @status = status
-        @error = error
-        super "[#{@status}] #{@error}"
+        @body = body
+        super "[#{@status}] #{@body}"
       end
     end
     
     #--
-    # HTTP Error Codes and Errors
+    # HTTP Status Codes and Errors
     #++
     
-    HTTP_ERROR_CODES = {
+    HTTP_STATUS_CODES = {
+      100  => 'Continue',
+      101  => 'Switching Protocols',
+      102  => 'Processing',
+      200  => 'OK',
+      201  => 'Created',
+      202  => 'Accepted',
+      203  => 'Non-Authoritative Information',
+      204  => 'No Content',
+      205  => 'Reset Content',
+      206  => 'Partial Content',
+      207  => 'Multi-Status',
+      300  => 'Multiple Choices',
+      301  => 'Moved Permanently',
+      302  => 'Moved Temporarily',
+      303  => 'See Other',
+      304  => 'Not Modified',
+      305  => 'Use Proxy',
+      307  => 'Temporary Redirect',
       400  => 'Bad Request',
       401  => 'Unauthorized',
       402  => 'Payment Required',
@@ -44,55 +66,41 @@ module Halcyon
       413  => 'Request Entity Too Large',
       414  => 'Request-URI Too Large',
       415  => 'Unsupported Media Type',
+      416  => 'Requested Range Not Satisfiable',
+      417  => 'Expectation Failed',
+      422  => 'Unprocessable Entity',
+      423  => 'Locked',
+      424  => 'Failed Dependency',
+      425  => 'No Code',
+      426  => 'Upgrade Required',
       500  => 'Internal Server Error',
       501  => 'Not Implemented',
       502  => 'Bad Gateway',
       503  => 'Service Unavailable',
       504  => 'Gateway Time-out',
-      505  => 'HTTP Version not supported'
+      505  => 'HTTP Version not supported',
+      506  => 'Variant Also Negotiates',
+      507  => 'Insufficient Storage',
+      510  => 'Not Extended'
     }
+    
+    # Added extended HTTP status codes found from
+    # http://www.askapache.com/htaccess/apache-status-code-headers-errordocument.html
+    
+    #--
+    # Classify Status Codes
+    #++
+    
+    HTTP_STATUS_CODES.to_a.each do |http_status|
+      status, body = http_status
+      class_eval <<-"end;"
+        class #{body.gsub(/( |\-)/,'')} < Halcyon::Exceptions::Base
+          def initialize(s=#{status}, b='#{body}')
+            super
+          end
+        end
+      end;
+    end
+    
   end
 end
-
-# Taken from Rack's definition:
-# http://chneukirchen.org/darcs/darcsweb.cgi?r=rack;a=plainblob;f=/lib/rack/utils.rb
-# 
-# HTTP_STATUS_CODES = {
-#   100  => 'Continue',
-#   101  => 'Switching Protocols',
-#   200  => 'OK',
-#   201  => 'Created',
-#   202  => 'Accepted',
-#   203  => 'Non-Authoritative Information',
-#   204  => 'No Content',
-#   205  => 'Reset Content',
-#   206  => 'Partial Content',
-#   300  => 'Multiple Choices',
-#   301  => 'Moved Permanently',
-#   302  => 'Moved Temporarily',
-#   303  => 'See Other',
-#   304  => 'Not Modified',
-#   305  => 'Use Proxy',
-#   400  => 'Bad Request',
-#   401  => 'Unauthorized',
-#   402  => 'Payment Required',
-#   403  => 'Forbidden',
-#   404  => 'Not Found',
-#   405  => 'Method Not Allowed',
-#   406  => 'Not Acceptable',
-#   407  => 'Proxy Authentication Required',
-#   408  => 'Request Time-out',
-#   409  => 'Conflict',
-#   410  => 'Gone',
-#   411  => 'Length Required',
-#   412  => 'Precondition Failed',
-#   413  => 'Request Entity Too Large',
-#   414  => 'Request-URI Too Large',
-#   415  => 'Unsupported Media Type',
-#   500  => 'Internal Server Error',
-#   501  => 'Not Implemented',
-#   502  => 'Bad Gateway',
-#   503  => 'Service Unavailable',
-#   504  => 'Gateway Time-out',
-#   505  => 'HTTP Version not supported'
-# }

data/lib/halcyon/logging.rb

@@ -0,0 +1,31 @@
+module Halcyon
+  module Logging
+    
+    autoload :Helpers, 'halcyon/logging/helpers'
+    
+    autoload :Logger, 'halcyon/logging/logger'
+    autoload :Logging, 'halcyon/logging/logging'
+    autoload :Analogger, 'halcyon/logging/analogger'
+    autoload :Log4r, 'halcyon/logging/log4r'
+    
+    class << self
+      
+      # Sets up the Halcyon::Logger constant to reflect the logging
+      # configuration settings.
+      #   +logger+ the name of the logging type
+      # 
+      # Configs
+      #   <tt>Halcyon.config[:logging][:type]</tt> #=> <tt>String:Logger</tt>
+      #     Logger              => specifies Logger
+      #     Logging             => specifies Logging
+      #     Analogger           => specifies Analogger
+      #     Log4r               => specifies Log4r
+      def set(logger = 'Logger')
+        Halcyon.send(:remove_const, :Logger) if Halcyon.const_defined? :Logger
+        Halcyon.const_set :Logger, Halcyon::Logging.const_get(logger)
+      end
+      
+    end
+    
+  end
+end

data/lib/halcyon/logging/analogger.rb

@@ -0,0 +1,31 @@
+require 'swiftcore/Analogger/Client'
+module Halcyon
+  module Logging
+    class Analogger < Swiftcore::Analogger::Client
+      
+      class << self
+        
+        def setup(config)
+          self.new((config[:app] || Halcyon.app), config[:host], config[:port].to_s, config[:key])
+        end
+        
+      end
+      
+      %w(debug info warn error fatal unknown).each do |level|
+        
+        eval <<-"end;"
+          def #{level}(message)
+            self.log('#{level}', message)
+          end
+        end;
+        
+      end
+      
+      def <<(message)
+        # Should << be assumed as INFO level?
+        self.log('info', message)
+      end
+      
+    end
+  end
+end

data/lib/halcyon/logging/helpers.rb

@@ -0,0 +1,37 @@
+module Halcyon
+  module Logging
+    module Helpers
+      
+      def self.included(target)
+        target.extend(ClassMethods)
+      end
+      
+      # The current application logger instance.
+      # 
+      # Examples
+      #   self.logger.debug "Deleting user's cached data"
+      # 
+      # Returns Logger:logger
+      def logger
+        Halcyon.logger
+      end
+      
+      module ClassMethods
+        
+        # The current application logger instance, usable in the class context.
+        # This means you can call <tt>self.logger</tt> from inside of class
+        # methods, filters, etc.
+        # 
+        # Examples
+        #   self.logger.debug "Test message"
+        # 
+        # Returns Logger:logger
+        def logger
+          Halcyon.logger
+        end
+        
+      end
+      
+    end
+  end
+end