strelka 0.0.1pre4 → 0.0.1.pre129

data/History.rdoc

@@ -1,4 +1,4 @@
-== 0.0.1 [2011-08-29] Michael Granger <ged@FaerieMUD.org>
+== v0.0.1 [2011-08-29] Michael Granger <ged@FaerieMUD.org>
 
 Initial release.
 

data/IDEAS.rdoc

@@ -0,0 +1,62 @@
+= Strelka Ideas
+
+This is in-progress documentation for stuff that doesn't yet work, but is
+planned for a future release.
+
+Everything here is subject to change, but we'll try to keep this document
+up-to-date if it does.
+
+== Leash
+
+Setting up a new server from scratch:
+
+    $ leash setup
+
+Adding an admin server to an existing server config:
+
+    $ leash setup existing.sqlite
+
+Start all the configured apps for every server in the default config:
+
+    $ leash start
+
+The admin app will then let you examine and edit the configuration for your
+existing mongrel2 server, just as you would with a new server.
+
+
+=== Join a Mongrel2 Cluster
+
+Once you have the first node set up, you need only point 'leash' to the admin
+server running on the first host to set up and automatically configure
+additional Mongrel2 front-ends:
+
+	server2$ leash join server1
+
+This uses a 0MQ service running from the admin server that publishes the
+config using Mongrel2's "config from anything" protocol, so when Mongrel2
+itself supports the 'zmq.so' plugin, you won't even need a local SQLite
+database.
+
+
+== Strelka Applications
+
+* Apps have an appid constant (the mongrel2 UUID)
+* Apps are distributed in gems
+* A larger app can be split across multiple applets within a gem
+  - The gem can suggest a set of routes
+  - The Strelka admin interface can display the gem with its suggested routes
+* The framework provides convenience methods for looking up the route to
+  another app via its appid.
+
+For example, a CMS called "Snipper" might come in a gem called 'snipper'
+
+=== Future Plugins
+
+* CORS (cors) — manage {Cross-Origin Resource Sharing}[http://www.html5rocks.com/en/tutorials/cors/]
+  headers
+
+
+
+
+== Deployment
+

data/Manifest.txt

@@ -1,38 +1,69 @@
+.gemtest
 History.rdoc
-IDEAS.textile
+IDEAS.rdoc
 Manifest.txt
 README.rdoc
 Rakefile
 bin/leash
-data/strelka/apps/strelka-admin
-data/strelka/apps/strelka-setup
-data/strelka/bootstrap-config.rb
-data/strelka/templates/admin/console.tmpl
-data/strelka/templates/layout.tmpl
+contrib/hoetemplate/.autotest.erb
+contrib/hoetemplate/History.rdoc.erb
+contrib/hoetemplate/Manifest.txt.erb
+contrib/hoetemplate/README.rdoc.erb
+contrib/hoetemplate/Rakefile.erb
+contrib/hoetemplate/data/file_name/apps/file_name_app
+contrib/hoetemplate/data/file_name/templates/layout.tmpl.erb
+contrib/hoetemplate/data/file_name/templates/top.tmpl.erb
+contrib/hoetemplate/lib/file_name.rb.erb
+contrib/hoetemplate/spec/file_name_spec.rb.erb
+data/strelka/apps/hello-world
 lib/strelka.rb
 lib/strelka/app.rb
 lib/strelka/app/defaultrouter.rb
+lib/strelka/app/errors.rb
+lib/strelka/app/exclusiverouter.rb
 lib/strelka/app/filters.rb
+lib/strelka/app/negotiation.rb
 lib/strelka/app/parameters.rb
+lib/strelka/app/paramvalidator.rb
 lib/strelka/app/plugins.rb
+lib/strelka/app/restresources.rb
+lib/strelka/app/router.rb
 lib/strelka/app/routing.rb
 lib/strelka/app/templating.rb
 lib/strelka/behavior/plugin.rb
 lib/strelka/constants.rb
+lib/strelka/exceptions.rb
 lib/strelka/httprequest.rb
+lib/strelka/httprequest/acceptparams.rb
+lib/strelka/httprequest/negotiation.rb
+lib/strelka/httpresponse.rb
+lib/strelka/httpresponse/negotiation.rb
 lib/strelka/logging.rb
 lib/strelka/mixins.rb
-lib/strelka/process.rb
+spec/data/error.tmpl
 spec/data/layout.tmpl
 spec/data/main.tmpl
 spec/lib/constants.rb
 spec/lib/helpers.rb
 spec/strelka/app/defaultrouter_spec.rb
+spec/strelka/app/errors_spec.rb
+spec/strelka/app/exclusiverouter_spec.rb
+spec/strelka/app/filters_spec.rb
+spec/strelka/app/negotiation_spec.rb
 spec/strelka/app/parameters_spec.rb
+spec/strelka/app/paramvalidator_spec.rb
 spec/strelka/app/plugins_spec.rb
+spec/strelka/app/restresources_spec.rb
+spec/strelka/app/router_spec.rb
 spec/strelka/app/routing_spec.rb
 spec/strelka/app/templating_spec.rb
 spec/strelka/app_spec.rb
+spec/strelka/exceptions_spec.rb
+spec/strelka/httprequest/acceptparams_spec.rb
+spec/strelka/httprequest/negotiation_spec.rb
 spec/strelka/httprequest_spec.rb
+spec/strelka/httpresponse/negotiation_spec.rb
+spec/strelka/httpresponse_spec.rb
 spec/strelka/logging_spec.rb
+spec/strelka/mixins_spec.rb
 spec/strelka_spec.rb

data/README.rdoc

@@ -1,24 +1,143 @@
-= strelka
+= Strelka
 
 * http://deveiate.org/projects/Strelka
 
 == Description
 
 Strelka is a framework for creating and deploying Mongrel2 web applications
-in Ruby. It's still pre-alpha.
+in Ruby, and for managing a Mongrel2 cluster.
 
-Strelka is named after a Russian dog who was one of the first space travelers
+It's named after the Russian dog who was one of the first space travelers
 to orbit the Earth and return alive.
 
 
+== Prerequisites
+
+* Mongrel2[http://mongrel2.org/]
+* Ruby 1.9.3 or better
+
+
 == Installation
 
-    gem install strelka
+    $ gem install strelka
 
 
 == Usage
 
+Strelka is an application framework built on top of the Ruby-Mongrel2
+connector. It also includes a command-line tool for discovering Strelka
+application gems that are installed, setting up an application's
+runtime directory, and starting a Strelka application.
+
+
+=== Leash
+
+Strelka comes with a command-line tool called 'leash' that you can use to
+make setting up and starting a Strelka application backend a little bit easier.
+
+To see a list of the available Strelka applications, run
+<tt>leash discover</tt>:
+
+    $ leash discover
+    Searching for Strelka applications...
+    Found:
+    
+    hello-world
+    
+    $ gem install strelka-admin
+    Successfully installed strelka-admin-1.1.0
+    1 gem installed
+    
+    $ leash discover
+    Searching for Strelka applications...
+    Found:
+    
+    hello-world     strelka-admin      config-service
+
+
+To set up a new application runtime directory, run <tt>leash setup</tt>
+with the path to the directory and the name of the application:
+
+    $ leash setup /usr/local/myapp hello-world
+    Creating directory...
+    Creating barebones config...
+
+
+=== The Application Framework
+
+The application framework is primarily geared towards developing web (HTTP)
+applications at the moment, but the intention is to make Strelka useful for
+developing applications that use the other protocols supported by Mongrel2
+at some point as well.
+
+The framework is centered around the Strelka::App class, which is what you'll
+subclass when creating your own applications. It's pretty minimal by itself;
+Strelka applications are composed out of plugins that mix in the specific
+framework parts you specify, so you get exactly what you need and nothing
+more.
+
+The plugins system itself is contained in the Strelka::App::Plugins mixin,
+which is included in Strelka::App already. This adds the +plugins+
+declarative, which you use from your app to load the plugins you want to use.
+
+A very basic application might look like this:
+
+    #!/usr/bin/env ruby
+
+    require 'strelka'
+
+    # The Strelka admin web console.
+    class HelloWorldApp < Strelka::App
+
+        # The route appid that will configure this app's
+        # connection to Mongrel2 if no appid is given
+        # to App.run
+        ID = 'hello-world'
+
+        # Use Sinatra-like routing
+        plugins :routing
+
+        # Set responses to plaintext if they don't specify differently
+        default_type 'text/plain'
+
+        # Handle all GET requests the same way
+        get do |req|
+            res = req.response
+            res.status = HTTP::OK
+            res << 'Hello, world!'
+            return res
+        end
+
+    end # class HelloWorldApp
+
+
+    # Run the app
+    HelloWorldApp.run if __FILE__ == $0
+
+This app uses the 'routing' plugin, which adds Sinatra-like hooks for matching
+callbacks to requests. The example app above responds only to 'GET' requests,
+and ignores the path of the request altogether.
+
+Strelka comes with a few default plugins, but you can define your own fairly
+easily.
+
+
+=== Default Plugins
 
+[routing[rdoc-ref:Strelka::App::Routing]]
+    Sinatra-ish request routing.
+[parameters[rdoc-ref:Strelka::App::Parameters]]
+    Query and URI path-parameter validation and untainting.
+[filters[rdoc-ref:Strelka::App::Filters]]
+    Request/response filters, for doing things like compression, content-type
+    negotiation, or other things that somehow modify every request or response.
+[templating[rdoc-ref:Strelka::App::Templating]]
+    Templating via the Inversion template engine.
+[errors[rdoc-ref:Strelka::App::Errors]]
+    Custom error-handling.
+[restresources[rdoc-ref:Strelka::App::RestResources]]
+    Automatically set up RESTful service resources for Sequel::Model-derived
+	classes.
 
 == Contributing
 
@@ -36,7 +155,7 @@ and generate the API documentation.
 
 == License
 
-Copyright (c) 2011, Michael Granger
+Copyright (c) 2011-2012, Michael Granger
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Rakefile

@@ -1,5 +1,7 @@
 #!/usr/bin/env rake
 
+require 'rake/clean'
+
 begin
 	require 'hoe'
 rescue LoadError
@@ -8,25 +10,33 @@ end
 
 Hoe.plugin :mercurial
 Hoe.plugin :signing
+Hoe.plugin :manualgen
 
 Hoe.plugins.delete :rubyforge
 
 hoespec = Hoe.spec 'strelka' do
 	self.readme_file = 'README.rdoc'
 	self.history_file = 'History.rdoc'
-	self.extra_rdoc_files << 'README.rdoc' << 'History.rdoc'
+	self.extra_rdoc_files = FileList[ '*.rdoc' ]
 
 	self.developer 'Michael Granger', 'ged@FaerieMUD.org'
 
-	self.dependency 'mongrel2',        '~> 0.2.3'
+	self.dependency 'mongrel2',        '~> 0.15'
 	self.dependency 'configurability', '~> 1.0'
-	self.dependency 'inversion',       '~> 0.1'
+	self.dependency 'inversion',       '~> 0.2'
+	self.dependency 'trollop',         '~> 1.16'
+	self.dependency 'highline',        '~> 1.6'
+	self.dependency 'formvalidator',   '~> 0.1.5'
+	self.dependency 'uuidtools',       '~> 2.1.2'
+	self.dependency 'sysexits',        '~> 1.0'
+	self.dependency 'pluginfactory',   '~> 1.0'
 
-	self.dependency 'tilt',            '~> 1.3', :developer
 	self.dependency 'rspec',           '~> 2.6', :developer
 
 	self.spec_extras[:licenses] = ["BSD"]
-	self.require_ruby_version( '>=1.8.7' )
+	self.require_ruby_version( '>=1.9.2' )
+	self.hg_sign_tags = true if self.respond_to?( :hg_sign_tags= )
+	self.check_history_on_release = true if self.respond_to?( :check_history_on_release= )
 
 	self.rdoc_locations << "deveiate:/usr/local/www/public/code/#{remote_rdoc_dir}"
 end
@@ -34,7 +44,7 @@ end
 ENV['VERSION'] ||= hoespec.spec.version.to_s
 
 # Ensure the specs pass before checking in
-task 'hg:precheckin' => :spec
+task 'hg:precheckin' => [ :check_history, :check_manifest, :spec ]
 
 ### Make the ChangeLog update if the repo has changed since it was last built
 file '.hg/branch'
@@ -62,3 +72,9 @@ if Rake::Task.task_defined?( '.gemtest' )
 		$stderr.puts "Not including a .gemtest until I'm confident the test suite is idempotent."
 	end
 end
+
+
+# Add admin app testing directories to the clobber list
+CLOBBER.include( 'static', 'run', 'log', 'strelka.sqlite' )
+
+