halcyon 0.4.0 → 0.5.0

data/support/generators/halcyon_flat/templates/README

@@ -0,0 +1,26 @@
+= Application
+
+
+== Introduction
+
+...
+
+
+== Installation
+
+...
+
+
+=== Dependencies
+
+* Halcyon (halcyon >= 0.5.0)
+* ...
+
+== License
+
+...
+
+
+== Contact
+
+...

data/support/generators/halcyon_flat/templates/Rakefile

@@ -0,0 +1,32 @@
+%w(rubygems rake rake/clean rake/rdoctask fileutils pp halcyon).each{|dep|require dep}
+
+include FileUtils
+
+# Halcyon.root => the root application directory
+# Halcyon.app  => the application name
+
+desc "Start the application on port 4647"
+task :start do
+  sh "halcyon start -p 4647"
+end
+
+desc "Generate RDoc documentation"
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.options << '--line-numbers' << '--inline-source' <<
+    '--main' << 'README' <<
+    '--title' << "#{Halcyon.app} Documentation" <<
+    '--charset' << 'utf-8'
+  rdoc.rdoc_dir = "doc"
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('app/**/*.rb')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# = Custom Rake Tasks
+# 
+# Add your custom rake tasks here.
+
+# ...
+
+# = Default Task
+task :default => Rake::Task['start']

data/support/generators/halcyon_flat/templates/app.rb

@@ -0,0 +1,49 @@
+require 'halcyon'
+
+# = Required Libraries
+%w().each {|dep|require dep}
+
+# = Configuration
+# Halcyon.config = Halcyon::Runner.load_config
+Halcyon.config = {
+  :allow_from => 'all',
+  :logging => {
+    :type => 'Logger',
+    # :file => nil, # STDOUT
+    :level => 'debug'
+  }
+}.to_mash
+
+# = Environment
+# Set the environment if not set above; create the <tt>Halcyon.environment</tt>
+# configurable attribute. Maps to <tt>Halcyon.config[:environment]</tt>.
+Halcyon.configurable_attr(:environment)
+Halcyon.environment = :development unless Halcyon.environment
+
+# = Routes
+Halcyon::Application.route do |r|
+  r.match('/time').to(:controller => 'application', :action => 'time')
+  
+  r.match('/').to(:controller => 'application', :action => 'index')
+  
+  # failover
+  {:action => 'not_found'}
+end
+
+# = Hooks
+Halcyon::Application.startup do |config|
+  logger.info 'Define startup tasks in Halcyon::Application.startup {}'
+end
+
+# = Application
+class Application < Halcyon::Controller
+  
+  def index
+    ok('Nothing here')
+  end
+  
+  def time
+    ok(Time.now.to_s)
+  end
+  
+end

data/support/generators/halcyon_flat/templates/lib/client.rb

@@ -0,0 +1,17 @@
+%w(rubygems halcyon).each{|dep|require dep}
+
+module <%= app %>
+  
+  class Client < Halcyon::Client
+    
+    def self.version
+      VERSION.join('.')
+    end
+    
+    def time
+      get('/time')[:body]
+    end
+    
+  end
+  
+end

data/support/generators/halcyon_flat/templates/runner.ru

@@ -0,0 +1,8 @@
+require 'halcyon'
+require 'app'
+
+puts "(Starting in #{Halcyon.root})"
+
+Thin::Logging.silent = true if defined? Thin
+
+run Halcyon::Runner.new

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: halcyon
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Matt Todd
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-02-10 00:00:00 -05:00
+date: 2008-05-29 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -19,7 +19,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.0
+        version: 0.3.0
     version: 
 - !ruby/object:Gem::Dependency 
   name: merb
@@ -28,7 +28,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.4.1
+        version: 0.9.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: json_pure
@@ -37,7 +37,16 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.1.1
+        version: 1.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rubigen
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.4
     version: 
 description: A JSON App Server Framework
 email: chiology@gmail.com
@@ -50,26 +59,70 @@ extra_rdoc_files:
 files: 
 - lib
 - Rakefile
+- README
+- LICENSE
+- AUTHORS
 - spec/halcyon
-- spec/halcyon/error_spec.rb
+- spec/halcyon/application_spec.rb
+- spec/halcyon/client_spec.rb
+- spec/halcyon/controller_spec.rb
+- spec/halcyon/halcyon_spec.rb
+- spec/halcyon/logging_spec.rb
 - spec/halcyon/router_spec.rb
-- spec/halcyon/server_spec.rb
+- spec/halcyon/runner_spec.rb
 - spec/spec_helper.rb
 - lib/halcyon
+- lib/halcyon/application
+- lib/halcyon/application/router.rb
+- lib/halcyon/application.rb
 - lib/halcyon/client
-- lib/halcyon/client/base.rb
-- lib/halcyon/client/exceptions.rb
-- lib/halcyon/client/router.rb
+- lib/halcyon/client/ssl.rb
 - lib/halcyon/client.rb
+- lib/halcyon/controller.rb
 - lib/halcyon/exceptions.rb
-- lib/halcyon/server
-- lib/halcyon/server/auth
-- lib/halcyon/server/auth/basic.rb
-- lib/halcyon/server/base.rb
-- lib/halcyon/server/exceptions.rb
-- lib/halcyon/server/router.rb
-- lib/halcyon/server.rb
+- lib/halcyon/logging
+- lib/halcyon/logging/analogger.rb
+- lib/halcyon/logging/helpers.rb
+- lib/halcyon/logging/log4r.rb
+- lib/halcyon/logging/logger.rb
+- lib/halcyon/logging/logging.rb
+- lib/halcyon/logging.rb
+- lib/halcyon/runner
+- lib/halcyon/runner/commands.rb
+- lib/halcyon/runner/helpers
+- lib/halcyon/runner/helpers/command_helper.rb
+- lib/halcyon/runner/helpers.rb
+- lib/halcyon/runner.rb
 - lib/halcyon.rb
+- support/generators
+- support/generators/halcyon
+- support/generators/halcyon/halcyon_generator.rb
+- support/generators/halcyon/templates
+- support/generators/halcyon/templates/app
+- support/generators/halcyon/templates/app/application.rb
+- support/generators/halcyon/templates/config
+- support/generators/halcyon/templates/config/config.yml
+- support/generators/halcyon/templates/config/init
+- support/generators/halcyon/templates/config/init/environment.rb
+- support/generators/halcyon/templates/config/init/hooks.rb
+- support/generators/halcyon/templates/config/init/requires.rb
+- support/generators/halcyon/templates/config/init/routes.rb
+- support/generators/halcyon/templates/lib
+- support/generators/halcyon/templates/lib/client.rb
+- support/generators/halcyon/templates/Rakefile
+- support/generators/halcyon/templates/README
+- support/generators/halcyon/templates/runner.ru
+- support/generators/halcyon/USAGE
+- support/generators/halcyon_flat
+- support/generators/halcyon_flat/halcyon_flat_generator.rb
+- support/generators/halcyon_flat/templates
+- support/generators/halcyon_flat/templates/app.rb
+- support/generators/halcyon_flat/templates/lib
+- support/generators/halcyon_flat/templates/lib/client.rb
+- support/generators/halcyon_flat/templates/Rakefile
+- support/generators/halcyon_flat/templates/README
+- support/generators/halcyon_flat/templates/runner.ru
+- support/generators/halcyon_flat/USAGE
 has_rdoc: true
 homepage: http://halcyon.rubyforge.org
 post_install_message: 
@@ -81,7 +134,7 @@ rdoc_options:
 - --line-numbers
 - --inline-source
 - --title
-- "\"Halcyon Documentation\""
+- "\"Halcyon API\""
 - --exclude
 - "\"^(_darcs|spec|pkg|.svn)/\""
 require_paths: 
@@ -100,8 +153,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: 
 - install the json gem to get faster JSON parsing
-rubyforge_project: 
-rubygems_version: 0.9.5
+rubyforge_project: halcyon
+rubygems_version: 1.1.0
 signing_key: 
 specification_version: 2
 summary: A JSON App Server Framework

data/lib/halcyon/client/base.rb

@@ -1,261 +0,0 @@
-#--
-#  Created by Matt Todd on 2007-12-14.
-#  Copyright (c) 2007. All rights reserved.
-#++
-
-#--
-# dependencies
-#++
-
-%w(net/http uri json).each {|dep|require dep}
-
-#--
-# module
-#++
-
-module Halcyon
-  class Client
-    
-    DEFAULT_OPTIONS = {}
-    USER_AGENT = "JSON/#{JSON::VERSION} Compatible (en-US) Halcyon/#{Halcyon.version} Client/#{Halcyon::Client.version}"
-    CONTENT_TYPE = 'application/json'
-    
-    # = Building Custom Clients
-    # 
-    # Once your Halcyon JSON Server App starts to take shape, it may be useful
-    # to begin to write tests on expected functionality, and then to implement
-    # API calls with a designated Client lib for your Ruby or Rails apps, etc.
-    # The Base class provides a standard implementation and several options for
-    # wrapping up functionality of your app from the server side into the
-    # client side so that you may begin to use response data.
-    # 
-    # == Creating Your Client
-    # 
-    # Creating a simple client can be as simple as this:
-    # 
-    #   class Simple < Halcyon::Client::Base
-    #     def greet(name)
-    #       get("/hello/#{name}")
-    #     end
-    #   end
-    # 
-    # The only thing simply may be actually using the Simple client you just
-    # created.
-    # 
-    # But to actually get in and use the library, one has to take full
-    # advantage of the HTTP request methods, +get+, +post+, +put+, and
-    # +delete+. These methods simply return the JSON-parsed data from the
-    # server, effectively returning a hash with two key values, +status+ which
-    # contains the HTTP status code, and +body+ which contains the body of the
-    # content returned which can be any number of objects, including, but not
-    # limited to Hash, Array, Numeric, Nil, Boolean, String, etc.
-    # 
-    # You are not limited to what your methods can call: they are arbitrarily
-    # and solely up to your whims and needs. It is simply a matter of good
-    # design and performance when it comes to structuring and implementing
-    # client actions which can be complex or simple series of requests to the
-    # server.
-    # 
-    # == Acceptable Clients
-    # 
-    # The Halcyon Server is intended to be very picky with whom it will speak
-    # to, so it requires that we specifically mention that we speak only
-    # "application/html", that we're "JSON/1.1.1 Compatible", and that we're
-    # local to the server itself (in process, anyways). This ensures that it
-    # has to deal with as little noise as possible and focus it's attention on
-    # performing our requests.
-    # 
-    # This shouldn't affect usage when working with the Client or in production
-    # but might if you're trying to check things in your browser. Just make
-    # certain that the debug option is turned on (-d for the +halcyon+ command)
-    # when you start the server so that it knows to be a little more lenient
-    # about to whom it speaks.
-    class Base
-      
-      #--
-      # Initialization and setup
-      #++
-      
-      # = Connecting to the Server
-      # 
-      # Creates a new Client object to allow for requests and responses from
-      # the specified server.
-      # 
-      # The +uri+ param contains the URL to the actual server, and should be in
-      # the format: "http://localhost:3801" or "http://app.domain.com:3401/"
-      # 
-      # == Server Connections
-      # 
-      # Connecting only occurs at the actual event that a request is performed,
-      # so there is no need to worry about closing connections or managing
-      # connections in general other than good object housecleaning. (Be nice
-      # to your Garbage Collector.)
-      # 
-      # == Usage
-      # 
-      # You can either provide a block to perform all of your requests and
-      # processing inside of or you can simply accept the object in response
-      # and call your request methods off of the returned object.
-      # 
-      # Alternatively, you could do both.
-      # 
-      # An example of creating and using a Simple client:
-      # 
-      #   class Simple < Halcyon::Client::Base
-      #     def greet(name)
-      #       get("/hello/#{name}")
-      #     end
-      #   end
-      #   Simple.new('http://localhost:3801') do |s|
-      #     puts s.greet("Johnny").inspect
-      #   end
-      # 
-      # This should effectively call +inspect+ on a response hash similar to
-      # this:
-      # 
-      #   {:status => 200, :body => 'Hello Johnny'}
-      # 
-      # Alternatively, you could perform the same with the following:
-      # 
-      #   s = Simple.new('http://localhost:3801')
-      #   puts s.greet("Johnny").inspect
-      # 
-      # This should generate the exact same outcome as the previous example,
-      # except that it is not executed in a block.
-      # 
-      # The differences are purely semantic and of personal taste.
-      def initialize(uri)
-        @uri = URI.parse(uri)
-        if block_given?
-          yield self
-        end
-      end
-      
-      #--
-      # Reverse Routing
-      #++
-      
-      # = Reverse Routing
-      # 
-      # The concept of writing our Routes in our Client is to be able to
-      # automatically generate the appropriate URL based on the hash given
-      # and where it was called from. This makes writing actions in Clients
-      # go from something like this:
-      # 
-      #   def greet(name)
-      #     get("/hello/#{name}")
-      #   end
-      # 
-      # to this:
-      # 
-      #   def greet(name)
-      #     get(url_for(__method__, :name))
-      #   end
-      # 
-      # This doesn't immediately seem to be beneficial, but it is better for
-      # automating URL generating, taking out the hardcoding, and has room to
-      # to improve in the future.
-      def url_for(action, params = {})
-       Halcyon::Client::Router.route(action, params)
-      end
-      
-      # Sets up routing for creating preparing +url_for+ URLs. See the
-      # +url_for+ method documentation and the Halcyon::Client::Router docs.
-      def self.route
-        if block_given?
-          Halcyon::Client::Router.prepare do |r|
-            Halcyon::Client::Router.default_to yield(r)
-          end
-        else
-          warn "Routes should be defined in a block."
-        end
-      end
-      
-      #--
-      # Request Handling
-      #++
-      
-      # Performs a GET request on the URI specified.
-      def get(uri, headers={})
-        req = Net::HTTP::Get.new(uri)
-        request(req, headers)
-      end
-      
-      # Performs a POST request on the URI specified.
-      def post(uri, data, headers={})
-        req = Net::HTTP::Post.new(uri)
-        req.body = format_body(data)
-        request(req, headers)
-      end
-      
-      # Performs a DELETE request on the URI specified.
-      def delete(uri, headers={})
-        req = Net::HTTP::Delete.new(uri)
-        request(req, headers)
-      end
-      
-      # Performs a PUT request on the URI specified.
-      def put(uri, data, headers={})
-        req = Net::HTTP::Put.new(uri)
-        req.body = format_body(data)
-        request(req, headers)
-      end
-      
-    private
-      
-      # Performs an arbitrary HTTP request, receive the response, parse it with
-      # JSON, and return it to the caller. This is a private method because the
-      # user/developer should be quite satisfied with the +get+, +post+, +put+,
-      # and +delete+ methods.
-      # 
-      # == Request Failures
-      # 
-      # If the server responds with any kind of failure (anything with a status
-      # that isn't 200), Halcyon will in turn raise the respective exception
-      # (defined in Halcyon::Exceptions) which all inherit from
-      # +Halcyon::Exceptions::Base+. It is up to the client to handle these
-      # exceptions specifically.
-      def request(req, headers={})
-        # define essential headers for Halcyon::Server's picky requirements
-        req["Content-Type"] = CONTENT_TYPE
-        req["User-Agent"] = USER_AGENT
-        
-        # apply provided headers
-        headers.each do |pair|
-          header, value = pair
-          req[header] = value
-        end
-        
-        # provide hook for modifying the headers
-        req = headers(req) if respond_to? :headers
-        
-        # prepare and send HTTP request
-        res = Net::HTTP.start(@uri.host, @uri.port) {|http|http.request(req)}
-        
-        # parse response
-        body = JSON.parse(res.body)
-        body.symbolize_keys!
-        
-        # handle non-successes
-        raise Halcyon::Client::Base::Exceptions.lookup(body[:status]).new unless res.kind_of? Net::HTTPSuccess
-        
-        # return response
-        body
-      rescue Halcyon::Exceptions::Base => e
-        # log exception if logger is in place
-        raise
-      end
-      
-      # Formats the data of a POST or PUT request (the body) into an acceptable
-      # format according to Net::HTTP for sending through as a Hash.
-      def format_body(data)
-        data = {:body => data} unless data.is_a? Hash
-        data.symbolize_keys!
-        # uses the Merb Hash#to_params method defined in merb/core_ext.
-        data.to_params
-      end
-      
-    end
-    
-  end
-end