strelka 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61bf9e26b28c2ed2b22d5b69924c2882ec985a54
+  data.tar.gz: 2c112fd724573c6bef02a4d24b8af0cf59af660e
+SHA512:
+  metadata.gz: e00fbbbda4e9f473311fe1de9e5d5dd6f0297e15835bfc9b487b932e3e5047abcaa3344ce87f76d1fb2c6008736a23918743375818108165af3f3c483b15b6be
+  data.tar.gz: 50452d6a4e88827c1a42f562bd576a38c3d8565eb53e4ff0d243c0ec44e57420ebec3f0a200184e76aaaaff96add79504053e994d76cec0551f9686c03851707

data/ChangeLog

@@ -1,11 +1,143 @@
+2013-02-25  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/paramvalidator.rb:
+	Fix API documentation
+	[5471a055ac2e] [tip]
+
+	* lib/strelka/app/restresources.rb:
+	Add some documentation to the REST Resources plugin
+	[bfbbcdf9ebe8]
+
+	* lib/strelka/paramvalidator.rb:
+	Remove accidentally-committed code.
+	[0875b2988d81]
+
+2013-02-22  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/httprequest.rb, spec/strelka/httprequest_spec.rb:
+	Guard against malformed URI query
+	[2e56a22dac4a]
+
+	* lib/strelka/httpresponse.rb:
+	Whitespace fix
+	[ebe06cfc1695]
+
+2013-02-06  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/app/auth.rb, spec/strelka/app/auth_spec.rb:
+	Fix multiple permission criteria in the auth plugin (fixes #2)
+	[d661773e0781] [github/master]
+
+2013-02-01  Michael Granger  <ged@FaerieMUD.org>
+
+	* History.rdoc, lib/strelka/app/restresources.rb,
+	lib/strelka/paramvalidator.rb,
+	spec/strelka/app/restresources_spec.rb,
+	spec/strelka/paramvalidator_spec.rb:
+	Remove pending status from specs for multiple parameters support
+
+	This was apparently implemented (by me) in 49716850bd29. Fixes #1.
+	[2c41e18bc237]
+
+2013-01-29  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/app/parameters.rb, lib/strelka/paramvalidator.rb,
+	spec/strelka/app/parameters_spec.rb,
+	spec/strelka/paramvalidator_spec.rb:
+	Add a paramvalidator constraint for JSON fields
+	[ac11b12f9366] [github/no-notes-auto-vivify]
+
+2013-01-25  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/httprequest.rb, lib/strelka/httpresponse.rb,
+	spec/strelka/app/filters_spec.rb, spec/strelka/httprequest_spec.rb:
+	Remove HTTP{Request,Response}#notes multi-level autovivification
+	[0dc702f6eacc]
+
+	* bin/strelka:
+	Add support for --requires to bin/strelka
+	[c844fb419c83]
+
+	* lib/strelka.rb, lib/strelka/app/parameters.rb,
+	spec/strelka/app/parameters_spec.rb,
+	spec/strelka/app/restresources_spec.rb:
+	Allow declaration of parameters with block constraints
+	[afb6cec9add0]
+
+	* .rvm.gems, .tm_properties, Rakefile,
+	lib/strelka/app/restresources.rb, lib/strelka/paramvalidator.rb,
+	spec/strelka/app/restresources_spec.rb:
+	Modify the restresources app plugin for new versions of Sequel
+	[543c22d3050e]
+
+2013-01-24  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/app/routing.rb, spec/strelka/app/routing_spec.rb:
+	Fix the routing plugin to super with a block like the other plugins
+	[9ac7a036f54a]
+
+2013-01-18  Michael Granger  <ged@FaerieMUD.org>
+
+	* .pryrc:
+	Fix the .pryrc for recent versions of pry
+	[779190d1cc55]
+
+2013-01-09  Michael Granger  <ged@FaerieMUD.org>
+
+	* .rvm.gems:
+	Update rvm gemset file
+	[2bedace701fe]
+
+2013-01-02  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/strelka/paramvalidator.rb:
+	Remove spurious return in ParamValidator#[]=
+	[39c9459daa02]
+
+2013-01-02  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/strelka/paramvalidator.rb, spec/strelka/paramvalidator_spec.rb:
+	Revalidate parameters when using the index operator.
+	[1d71e22f5f6e]
+
+2012-12-27  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.1.0 for changeset 943a0502da20
+	[43c3f7dddf0d]
+
+	* .hgsigs:
+	Added signature for changeset a6be71c3d94d
+	[943a0502da20] [v0.1.0]
+
+	* History.rdoc, lib/strelka.rb:
+	Bump the minor version, update history.
+	[a6be71c3d94d]
+
+	* spec/strelka/app_spec.rb:
+	Fix a spec for newer versions of Mongrel2
+	[ee1b3bcf1664]
+
 2012-11-02  Michael Granger  <ged@FaerieMUD.org>
 
+	* bin/strelka:
+	Add --version to the command line tool
+	[4581498edfaa]
+
+	* lib/strelka/paramvalidator.rb:
+	Fix documentation
+	[6523f90b76ac]
+
+	* lib/strelka/app/parameters.rb:
+	Remove accidentally-committed require.
+	[e98f2b302f1d]
+
 	* lib/strelka/app/parameters.rb, lib/strelka/app/restresources.rb,
 	lib/strelka/mixins.rb, lib/strelka/paramvalidator.rb,
 	lib/strelka/plugins.rb, spec/strelka/paramvalidator_spec.rb:
 	Rewrite ParamValidator to simplify, remove dependency on
 	FormValidator.
-	[49716850bd29] [github/master, tip]
+	[49716850bd29]
 
 2012-11-02  Mahlon E. Smith  <mahlon@martini.nu>
 

data/History.rdoc

@@ -1,3 +1,18 @@
+== v0.2.0 [2013-02-01] Michael Granger <ged@FaerieMUD.org>
+
+- Fixes for Ruby 2.0.
+- Fix API documentation
+- Guard against malformed URI query
+- Fix multiple permission criteria in the auth plugin (fixes #2)
+- Add a paramvalidator constraint for JSON fields
+- Remove HTTP{Request,Response}#notes multi-level autovivification
+- Add support for --requires to bin/strelka
+- Allow declaration of parameters with block constraints
+- Modify the restresources app plugin for new versions of Sequel
+- Fix the routing plugin to super with a block like the other plugins
+- Revalidate parameters when using ParamValidator#[].
+
+
 == v0.1.0 [2012-11-02] Michael Granger <ged@FaerieMUD.org>
 
 - Add --version to the command line tool

data/Rakefile

@@ -27,7 +27,7 @@ hoespec = Hoe.spec 'strelka' do
 	self.dependency 'highline',        '~> 1.6'
 	self.dependency 'inversion',       '~> 0.11'
 	self.dependency 'loggability',     '~> 0.4'
-	self.dependency 'mongrel2',        '~> 0.34'
+	self.dependency 'mongrel2',        '~> 0.35'
 	self.dependency 'pluginfactory',   '~> 1.0'
 	self.dependency 'sysexits',        '~> 1.1'
 	self.dependency 'trollop',         '~> 2.0'

data/bin/strelka

@@ -100,11 +100,14 @@ class Strelka::CLICommand
 				collect {|name,lvl| name.to_s }.
 				join( ', ' )
 			command_table = self.make_command_table
+			commands = self.available_commands
 
 			@option_parser = Trollop::Parser.new do
 				banner "Manage Strelka apps"
 				version( Strelka.version_string(true) )
 
+				stop_on( commands )
+
 				text ''
 				command_table.each {|line| text(line) }
 				text ''
@@ -113,6 +116,8 @@ class Strelka::CLICommand
 				opt :config, "Specify the config file to load.", :type => :string
 				opt :datadir, "Override the Strelka data directory.", :type => :string,
 					:short => :D
+				opt :requires, "Specify additional libraries to require.", :type => :strings,
+					:short => :r
 				text ''
 
 				text 'Other Options:'
@@ -259,6 +264,8 @@ class Strelka::CLICommand
 	def discover_command( *args )
 		header "Searching for Strelka applications..."
 
+		self.load_additional_requires
+
 		paths = Strelka::App.discover_paths
 		if paths.empty?
 			message "None found."
@@ -298,6 +305,9 @@ class Strelka::CLICommand
 		apps = Strelka::App.load( path )
 		Strelka.load_config( self.options.config ) if self.options.config
 		self.log.debug "  loaded: %p" % [ apps ]
+
+		self.load_additional_requires
+
 		apps.first.run
 	end
 	help :start, "Start a Strelka app"
@@ -325,6 +335,8 @@ class Strelka::CLICommand
 			Strelka::App.load( apppath )
 		end
 
+		self.load_additional_requires
+
 		message "  dumping config:"
 		$stdout.puts Configurability.default_config.dump
 	end
@@ -385,6 +397,17 @@ class Strelka::CLICommand
 	end
 
 
+	### Load any requires added to the command via the '-r' option.
+	def load_additional_requires
+		return unless self.options.requires
+
+		self.log.debug "  loading additional requires: %p" % [ self.options.requires ]
+		self.options.requires.each do |lib|
+			require( lib )
+		end
+	end
+
+
 	#
 	# Utility methods
 	#

data/lib/strelka.rb

@@ -24,10 +24,10 @@ module Strelka
 	log_as :strelka
 
 	# Library version constant
-	VERSION = '0.1.0'
+	VERSION = '0.2.0'
 
 	# Version-control revision constant
-	REVISION = %q$Revision: a6be71c3d94d $
+	REVISION = %q$Revision: afb6cec9add0 $
 
 	require 'strelka/constants'
 	require 'strelka/exceptions'

data/lib/strelka/app/auth.rb

@@ -286,8 +286,8 @@ module Strelka::App::Auth
 		@positive_auth_criteria  = {}
 		@negative_auth_criteria  = {}
 
-		@positive_perms_criteria = {}
-		@negative_perms_criteria = {}
+		@positive_perms_criteria = []
+		@negative_perms_criteria = []
 
 
 		##
@@ -409,17 +409,19 @@ module Strelka::App::Auth
 		### +pattern+. The +pattern+ is either a String or a Regexp which is tested against
 		### {the request's #app_path}[rdoc-ref:Strelka::HTTPRequest#app_path]. The +perms+ should
 		### be Symbols which indicate a set of permission types that must have been granted
-		### in order to carry out the request. The block should also return one or more
-		### permissions (as Symbols) if the request should undergo authorization, or nil
-		### if it should not.
+		### in order to carry out the request. The block, if given, should evaluate to +true+
+		### if the request should undergo authorization, or false if it should not.
 		### *NOTE:* using this declaration inverts the default security policy of
 		### restricting access to all requests.
 		def require_perms_for( pattern=nil, *perms, &block )
-			block ||= Proc.new { perms }
+			block ||= Proc.new {
+				self.log.debug "  using default perms: %p" % [ perms ]
+				true
+			}
 
 			pattern.gsub!( %r{^/+|/+$}, '' ) if pattern.respond_to?( :gsub! )
 			self.log.debug "  adding require_perms (%p) for %p" % [ perms, pattern ]
-			self.positive_perms_criteria[ pattern ] = block
+			self.positive_perms_criteria << [ pattern, block, perms ]
 		end
 
 
@@ -435,7 +437,7 @@ module Strelka::App::Auth
 
 			pattern.gsub!( %r{^/+|/+$}, '' ) if pattern.respond_to?( :gsub! )
 			self.log.debug "  adding no_auth for %p" % [ pattern ]
-			self.negative_perms_criteria[ pattern ] = block
+			self.negative_perms_criteria << [ pattern, block ]
 		end
 
 	end # module ClassMethods
@@ -502,7 +504,7 @@ module Strelka::App::Auth
 	### +nil+ if the request didn't require authentication.
 	def provide_authorization( credentials, request )
 		provider = self.auth_provider
-		perms = self.required_perms_for( request )
+		perms = self.perms_required_for( request )
 		self.log.debug "Perms required: %p" % [ perms ]
 		provider.authorize( credentials, request, perms ) unless perms.empty?
 	end
@@ -550,7 +552,7 @@ module Strelka::App::Auth
 
 	### Gather the set of permissions that apply to the specified +request+ and return
 	### them.
-	def required_perms_for( request )
+	def perms_required_for( request )
 		self.log.debug "Gathering required perms for: %s %s" % [ request.verb, request.app_path ]
 
 		# Return the empty set if any negative auth criteria match
@@ -565,6 +567,7 @@ module Strelka::App::Auth
 		# Apply positive auth criteria
 		return self.union_positive_perms_criteria( request )
 	end
+	alias_method :required_perms_for, :perms_required_for
 
 
 	#########
@@ -617,8 +620,8 @@ module Strelka::App::Auth
 		perms = []
 
 		self.log.debug "  positive perm criteria: %p" % [ self.class.positive_perms_criteria ]
-		self.class.positive_perms_criteria.each do |pattern, block|
-			newperms = self.request_matches_criteria( request, pattern, &block ) or next
+		self.class.positive_perms_criteria.each do |pattern, block, newperms|
+			next unless self.request_matches_criteria( request, pattern, &block )
 			newperms = Array( newperms )
 			newperms << self.default_permission if newperms.empty?
 

data/lib/strelka/app/parameters.rb

@@ -93,10 +93,16 @@ module Strelka::App::Parameters
 		### Declare a parameter with the specified +name+ that will be validated using the given
 		### +constraint+. The +constraint+ can be any of the types supported by
 		### Strelka::ParamValidator.
-		def param( name, *args )
+		def param( name, *args, &block )
 			self.log.debug "New param %p" % [ name ]
 			self.log.debug "  adding parameter %p to %p" % [ name, self.paramvalidator ]
-			self.paramvalidator.add( name, *args )
+			self.paramvalidator.add( name, *args, &block )
+		end
+
+
+		### Add a 'builtin' constraint type with the specified +name+.
+		def add_param_type( name, &block )
+			
 		end
 
 

data/lib/strelka/app/restresources.rb

@@ -43,14 +43,28 @@ require 'strelka/app' unless defined?( Strelka::App )
 # parameters[Strelka::App::Parameters] plugins, and will load them
 # automatically if they haven't been already.
 #
-# Stuff left to do:
+# Goals:
+#
+# [√] Composite resources generated from associations
+# [ ] Honor If-unmodified-since and If-match headers
+# [ ] Caching support (ETag, If-modified-since)
+# [ ] Means of tailoring responses for requests for which the response
+#     isn't clearly specified in the RFC (DELETE /resource)
+# [ ] Sequel plugin for adding links to serialized representations
+# 
+# == Caveats / Known Problems
+#
+# * Dataset methods declared using the 'subset' declaration don't allow the
+#   introspection necessary for automatically building routes, so you have
+#   to declare them as normal methods in a dataset module:
+#
+#       dataset_module do
+#           def by_name( string )
+#               filter(:name => string)
+#           end
+#       end
+#
 #
-# * Composite resources generated from associations
-# * Honor If-unmodified-since and If-match headers
-# * Caching support (ETag, If-modified-since)
-# * Means of tailoring responses for requests for which the response
-#   isn't clearly specified in the RFC (DELETE /resource)
-# * Sequel plugin for adding links to serialized representations
 module Strelka::App::RestResources
 	extend Strelka::Plugin
 
@@ -238,7 +252,7 @@ module Strelka::App::RestResources
 				# Add validations for limit, offset, and order parameters
 				req.params.add :limit, :integer
 				req.params.add :offset, :integer
-				req.params.add :order, colre
+				req.params.add :order, colre, :multiple
 
 				finish_with( HTTP::BAD_REQUEST, req.params.error_messages.join("\n") ) unless
 					req.params.okay?
@@ -444,23 +458,14 @@ module Strelka::App::RestResources
 		### Add routes for any associations +rsrcobj+ has as composite resources.
 		def add_composite_resource_handlers( route_prefix, rsrcobj, options )
 
-			# Add a method for each dataset method that only has a single argument
-			# :TODO: Support multiple args? (customers/by_city_state/{city}/{state})
-			rsrcobj.dataset_methods.each do |name, proc|
-				if proc.parameters.length > 1
-					self.log.debug "  skipping dataset method %p: more than 1 argument" % [ name ]
-					next
-				end
+			# Add methods declared by (user-declared) dataset modules.
+			ds_mods = rsrcobj.dataset_method_modules.select do |mod|
+				mod.is_a?( Sequel::Model::DatasetModule ) || mod.name.nil?
+			end.each
 
-				# Use the name of the dataset block's parameter
-				# :TODO: Handle the case where the parameter name doesn't match a column
-				#        or a parameter-type more gracefully.
-				unless proc.parameters.empty?
-					param = proc.parameters.first[1]
-					route = "%s/%s/:%s" % [ route_prefix, name, param ]
-					self.log.debug "  route for dataset method %s: %s" % [ name, route ]
-					self.add_dataset_read_handler( route, rsrcobj, name, param, options )
-				end
+			ds_mods.each do |mod|
+				self.log.debug "  adding dataset methods declared by %p" % [ mod ]
+				self.add_dataset_module_routes( route_prefix, rsrcobj, mod, options )
 			end
 
 			# Add composite service routes for each association
@@ -476,14 +481,44 @@ module Strelka::App::RestResources
 		end
 
 
+		### Add routes for the methods declared in the dataset module +mod+.
+		def add_dataset_module_routes( route_prefix, rsrcobj, mod, options )
+			self.log.debug "Adding dataset module routes."
+
+			mod.instance_methods.each do |methname|
+				meth = mod.instance_method( methname )
+				self.log.debug "    instance_method: %p" % [ meth ]
+
+				route  = "%s/%s" % [ route_prefix, methname ]
+				params = []
+					
+				# Add a route placeholder for each parameter of the dataset method
+				meth.parameters.each do |type, param|
+					self.log.debug "    adding parameter placeholder to the route for %s parameter %p" %
+						[ type, param ]
+					route  << "/:%s" % [ param ]
+					params << param
+				end
+
+				self.log.debug "  route for dataset method %s: %s" % [ methname, route ]
+				self.add_dataset_read_handler( route, rsrcobj, methname, params, options )
+			end
+
+			self.log.debug "  done with dataset module routes."
+		end
+
+
 		### Add a GET route for the dataset method +dsname+ for the given +rsrcobj+ at the
 		### given +path+.
-		def add_dataset_read_handler( path, rsrcobj, dsname, param, options )
+		def add_dataset_read_handler( path, rsrcobj, dsname, params, options )
 			self.log.debug "Adding dataset method read handler: %s" % [ path ]
 
-			config = rsrcobj.db_schema[ param ] or
-				raise ArgumentError, "no such column %p for %p" % [ param, rsrcobj ]
-			param( param, config[:type] )
+			# Only need to declare a parameter if the dataset method has one
+			params.each do |paramname|
+				config = rsrcobj.db_schema[ paramname ] or
+					raise ArgumentError, "no such column %p for %p" % [ paramname, rsrcobj ]
+				param( paramname, config[:type] )
+			end
 
 			self.add_route( :GET, path, options ) do |req|
 				self.log.debug "Resource dataset GET request for dataset %s on %p" %
@@ -491,10 +526,9 @@ module Strelka::App::RestResources
 				finish_with( HTTP::BAD_REQUEST, req.params.error_messages.join("\n") ) unless
 					req.params.okay?
 
-				# Get the parameter and make the dataset
-				res = req.response
-				arg = req.params[ param ]
-				dataset = rsrcobj.send( dsname, arg )
+				# Get the dataset, either with a parameter or without one
+				args    = req.params.values_at( *params )
+				dataset = rsrcobj.send( dsname, *args )
 				self.log.debug "  dataset is: %p" % [ dataset ]
 
 				# Apply offset and limit if they're present
@@ -507,6 +541,7 @@ module Strelka::App::RestResources
 				# Fetch and return the records as JSON or YAML
 				# :TODO: Handle other mediatypes
 				self.log.debug "  returning collection: %s" % [ dataset.sql ]
+				res = req.response
 				res.for( :json, :yaml ) { dataset.all }
 				res.for( :text ) { Sequel::PrettyTable.string(dataset) }