marley 0.2.0 → 0.3.0

data/lib/marley.rb

@@ -1,5 +1,6 @@
 #!/usr/bin/ruby
 require 'json/ext'
+require 'json/add/core'
 require 'rack'
 require 'rack/auth/basic'
 require 'rack/builder'
@@ -19,29 +20,52 @@ Sequel::Model.plugin :timestamps, :create => :date_created, :update => :date_upd
 log_fn='log/marley.log'
 $log=Logger.new(File.exists?(log_fn) ? log_fn : $stdout) 
 
-
-module Marley #The main Marley namespace.
+# This is the main Marley namespace
+module Marley 
   JOINT_DIRS=[File.expand_path("joints/",File.dirname(__FILE__)),"#{Dir.pwd}/joints"]
+  # @see config
   DEFAULT_OPTS={:http_auth => true,:app_name => 'Application',:port => 1620,:default_user_class => :User, :auth_class => :User,:default_resource => 'Menu', :server => 'thin'}
   RESP_CODES={'get' => 200,'post' => 201,'put' => 204,'delete' => 204}
   
-  module Resources #All objects in the Resources namespace are exposed by the server.
+  # All constants in the Resources namespace should refer to public resources accessible to clients, subject, of course, to authentication/authorization.
+  #
+  # Resources MUST respond to one or more of #controller, #rest_get, #rest_post, #rest_put, #rest_delete
+  #
+  # If a Resource implements a #controller method, the method MUST return an object which responds to one or more of #rest_get, #rest_post, #rest_put, #rest_delete
+  module Resources 
   end
+  # The default namespace for Joints. Joints MUST implement a #smoke method
   module Joints
   end
   require 'marley/joint' #this needs to happen after Marley::Resources is defined
+  
+  # Override default Marley configuration
+  # @param [Hash] opts A hash containing Marley configuration options
+  # @option opts [Boolean] :http_auth Whether or not to use http authentication
+  # @option opts [String] :app_name Currently used by Jamaica to set page title
+  # @option opts [Number] :port Port on which to run the server
+  # @option opts [Object] :default_user_class The default class of the new user assigned to $request[:user] if no actual user is authenticated
+  # @option opts [Object] :auth_class The class used to authenticate requests.  MUST respond to #authenticate
+  # @option opts [Object] :default_resource The resource called in response to a request to '/'
+  # @option opts [String] :server  the Rack web server to be used.
   def self.config(opts=nil)
     @marley_opts||=DEFAULT_OPTS
     @marley_opts.merge!(opts) if opts
     yield @marley_opts if block_given?
     @marley_opts
   end
+  
+  # Loads a joint and and calls its #smoke method
+  # @param [String] joint_name The name of the joint to load and smoke - additional paramters passed through to the joint itself
   def self.joint(joint_name, *opts)
     joint_d=JOINT_DIRS.find {|d| File.exists?("#{d}/#{joint_name}.rb") }
     require "#{joint_d}/#{joint_name}"
     @marley_opts && @marley_opts[:client] && @marley_opts[:client].joint(joint_d,joint_name)
     joint=Marley::Joints.const_get(joint_name.camelize).new(*opts).smoke
   end
+
+  # Runs the server
+  # @param (see #config)
   def self.run(opts={})
     @marley_opts||=DEFAULT_OPTS
     marley_opts=@marley_opts.merge!(opts)

data/lib/marley/controllers.rb

@@ -1,4 +1,5 @@
 module Marley
+  # Translates REST URL's into ORM calls to the model class with which it is initialized.
   class ModelController
     def initialize(model)
       @model=model

data/lib/marley/joint.rb

@@ -1,5 +1,9 @@
 module Marley
   module Joints
+    # @abstract Subclass and implement one or more of the following modules within the class namespace:
+    #    - Resources - All constansts in this module will be imported into Marley::Resources
+    #    - ClassMethods - Modules within this module will extend any constant in Marley::Resources with the same name.
+    #    - InstanceMethods - Modules within this module will append their features to any constant in Marley::Resources with the same name. 
     class Joint
       def initialize(opts={})
         config(opts)

data/lib/marley/reggae.rb

@@ -1,10 +1,14 @@
 
 module Marley
+  # @see file:reggae.ebnf for Raggae sytax
   class Reggae < Array
     class << self
-      attr_accessor :valid_properties
+      def properties(*args)
+        @properties=args if args
+        @properties
+      end
       def mk_prop_methods
-        @valid_properties && @valid_properties.each do |meth|
+        @properties && @properties.each do |meth|
           define_method(meth) {properties[meth].respond_to?(:to_resource) ? properties[meth].to_resource : properties[meth]} 
           define_method(:"#{meth}=") {|val|properties[meth]=val} 
         end
@@ -13,30 +17,28 @@ module Marley
         self.new(*args).to_resource
       end
     end
+    attr_reader :resource_type
+    attr_accessor :properties,:contents
+    # @param [Array] *args an array in Reggae syntax
     def initialize(*args)
       super
-      self[1]=Utils.hash_keys_to_syms(self[1]) if self[1].class==Hash
-      self.class.mk_prop_methods
-    end
-    def properties
-      self[1] || nil
-    end
-    def resource_type
-      [String, Symbol].include?(self[0].class) ? self[0].to_sym : nil
+      if is_resource?
+        @resource_type=self[0]=self[0].to_sym
+        self[1]=Utils.hash_keys_to_syms(self[1]) if self[1].class==Hash
+        @properties=self[1]
+        @contents=self[2 .. -1]
+        self.class.mk_prop_methods
+      else
+        replace(map {|r| Reggae.new(r).to_resource})
+      end
     end
     def is_resource?
-      ! resource_type.nil?
-    end
-    def contents
-      is_resource? ? Reggae.new(self[2 .. -1]) : nil
+      [String, Symbol].include?(self[0].class) && self[1].class==Hash
     end
     def contents=(*args)
       self[2]=*args
       while length>3;delete_at -1;end
     end
-    def [](*args)
-      super.class==Array ?  Reggae.new(super).to_resource : super
-    end
     def to_resource
       is_resource? ? Marley.const_get("Reggae#{resource_type.to_s.camelize}".to_sym).new(self) : self
     end
@@ -50,34 +52,34 @@ module Marley
     end
   end
   class ReggaeResource < Reggae
-    def resource_type
-      self.class.to_s.sub(/.*Reggae/,'').underscore.to_sym
-    end
     def initialize(*args)
+      @resource_type=self.class.to_s.sub(/.*Reggae/,'').underscore.to_sym
       if args[0].class==Hash
-        initialize [resource_type,args[0]]
+        initialize [@resource_type,args[0]]
       else
         super
       end
     end
   end
   class ReggaeSection < ReggaeResource
-    self.valid_properties=[:title,:description]
+    properties :title,:description
     def navigation
       properties[:navigation].map{|n|Reggae.get_resource(n)}
     end
   end
   class ReggaeLink < ReggaeResource
-    self.valid_properties=[:title,:description,:url]
+    properties :title,:description,:url
   end
   class ReggaeInstance < ReggaeResource
-    self.valid_properties=[:name,:new_rec,:schema,:search,:url,:get_actions,:delete_action]
+    properties :name,:new_rec,:schema,:search,:url,:get_actions,:delete_action
+    attr_accessor :schema
     def initialize(*args)
       super
-      self.schema=ReggaeSchema.new(self.schema)
+      @properties[:schema]=ReggaeSchema.new(self.schema)
+      @schema=@properties[:schema]
     end
     def to_params
-      schema.inject({}) do |params,spec| 
+      @schema.inject({}) do |params,spec| 
         params["#{name}[#{spec.col_name}]"]=spec.col_value unless (spec.col_restrictions & RESTRICT_RO > 0)
         params
       end
@@ -86,7 +88,7 @@ module Marley
       "#{url}#{action_name}" if get_actions.include?(action_name.to_s)
     end
     def col_value(col_name,col_value=nil)
-      col=schema[col_name]
+      col=@schema[col_name]
       col.col_value=col_value if col_value
       col.col_value
     end
@@ -96,14 +98,14 @@ module Marley
     end
   end
   class ReggaeInstanceList < ReggaeResource
-    self.valid_properties=[:name,:description,:get_actions,:delete_action,:items]
+    properties :name,:description,:get_actions,:delete_action,:items
     #not implemented yet
   end
   class ReggaeMsg < ReggaeResource
-    self.valid_properties=[:title,:description]
+    properties :title,:description
   end
   class ReggaeError < ReggaeResource
-    self.valid_properties=[:error_type,:description,:error_details]
+    properties :error_type,:description,:error_details
   end
   class ReggaeSchema < Array
     def initialize(*args)
@@ -111,11 +113,7 @@ module Marley
       replace(map{|spec| ReggaeColSpec.new(spec)})
     end
     def [](i)
-      if i.class==Fixnum
-        super
-      else
-        find {|cs|cs.col_name.to_s==i.to_s}
-      end
+      i.class==Fixnum ?  super : find {|cs|cs.col_name.to_s==i.to_s}
     end
   end
   class ReggaeColSpec < Array

data/lib/sequel/plugins/rest_convenience.rb

@@ -70,7 +70,7 @@ module Sequel::Plugins::RestConvenience
       respond_to?('name') ? name : id.to_s
     end
     def to_a
-      a=Marley::ReggaeInstance.new( {:name => self.class.resource_name,:url => url ,:new_rec => self.new?,:schema => rest_schema,:get_actions => get_actions})
+      a=Marley::ReggaeInstance.new( {:name => self.class.resource_name,:url => url ,:new_rec => self.new?,:schema => rest_schema,:get_actions => get_actions.class==Hash ? get_actions[$request[:user].class] : get_actions})
       if respond_to?(:rest_associations) && ! new?
         a.contents=rest_associations.map do |assoc|
           (assoc.class==Symbol ? send(assoc) : assoc).map{|instance| instance.to_a}

data/marley.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{marley}
-  s.version = "0.2.0"
+  s.version = "0.3.0"
   s.summary = %q{Irie default restful routes for your models and other objects}
   s.description = %q{Marley implements a web services microframework on top of Rack and Sequel on the server side and Jquery on the client side.}
   s.authors     = ["Herb Daily"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: marley
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Herb Daily
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-18 00:00:00 -03:00
+date: 2011-11-20 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -55,7 +55,6 @@ files:
 - Rakefile
 - Favicon.ico
 - README.rdoc
-- marley-0.1.0.gem
 - TODO
 - reggae.ebnf
 - forum_tests.rb