equipment 0.1.0

data/lib/ext/security.rb

@@ -0,0 +1,83 @@
+require 'equipment'
+require 'ext/patches'
+require 'ext/forward'
+
+module Ext
+
+  # Generic authentication module. Used by BasicAuth for example.
+  #
+  # == Dependencies
+  # 
+  # * Equipment
+  # * Forward
+  # * Patches
+  #
+  # == TODO
+  #
+  # * More doc
+  module Security
+    extend Equipment
+    depends_on Patches
+    depends_on Forward
+
+    def self.equip(app)
+      super
+      app::Controllers::Unauthorized.send :include, app::C, app::Base, app::Models
+      app::Controllers::Unauthenticated.send :include, app::C, app::Base, app::Models
+    end
+
+    module Base
+      # Blank authentication, returns [nil, nil]
+      def authenticate; return nil, nil end
+
+      # Blank authorization, returns true
+      def authorize(user, pass, force=false); not force; end
+
+      # Checks the credencials when serving a page if `authorize` is defined
+      # in your app, Base or controller.
+      def service(*a)
+        puts "Walking trough service"
+        user, pass = authenticate
+        if authorize(user, pass)
+          super
+        elsif not user
+          puts "Forwarding to Unauthenticated"
+          forward(app::Controllers::Unauthenticated)
+        else
+          puts "Forwarding to Unauthorized"
+          forward(app::Controllers::Unauthorized, user)
+        end
+        self
+      end
+
+    end
+
+    module Controllers
+      # Called when an url is not authorized. You can override this is your app.
+      # Or create an `unauthorized` view. @bad_user is the user name.
+      class Unauthorized
+        def self.urls; [] end # do not serve urls directly.
+        def authenticate; return nil, nil end
+        def authorize(user, pass, force=false); true; end
+
+        def get(bad_user)
+          @bad_user = bad_user
+          render(:unauthorized) rescue "Unauthorized user : #@bad_user"
+        end
+      end
+
+      # Customize by creating an "unauthenticated" view
+      class Unauthenticated
+        def self.urls; [] end # do not serve urls directly.
+        def authenticate; return nil, nil end
+        def authorize(user, pass, force=false); true; end
+
+        def get
+          render(:unauthenticated) rescue 'Unauthenticated'
+        end
+      end
+
+    end
+  end
+end
+

data/lib/ext/sendfile.rb

@@ -0,0 +1,84 @@
+require 'equipment'
+require 'ext/app_util'
+require 'ext/forward'
+
+begin
+  require 'mime/types' # requires that package
+rescue LoadError
+  STDERR.puts '*** mime/types not available. You will have to specify mime \
+types in Equipment::Sendfile.'
+end
+
+module Ext
+
+  # The Sendfile equipment allows you to send files to the browser. See
+  # Base#sendfile for more options.
+  #
+  # == Features
+  #
+  # * Autodetects if the `sendfile` extension is used in mongrel.
+  # * Provides mime-type resolution trough the 'mime/types' library. 
+  # I encourage everybody to use that lib when dealing with mime types.
+  # 
+  # == Dependencies
+  #
+  # * Equipment
+  # * AppUtil
+  # * Forward
+  # * `mime-types` package. Available as a gem.
+  # * `sendfile` package (optional). Available as a gem.
+  # 
+  # == Example
+  # 
+  #  module Controllers
+  #    class ShowPasswd
+  #      def get
+  #        # ...
+  #        sendfile('/etc/password')
+  #      end
+  #    end
+  #  end
+  #
+  # == TODO
+  # 
+  # * Implement force_download
+  #
+  module Sendfile
+    extend Equipment
+    depends_on AppUtil
+    depends_on Forward
+
+    module Base
+      # Sends the file passed in the path to the browser.
+      #
+      # If content_type is given, it won't try to lookup in the MIME::Types
+      # library.
+      #
+      def sendfile(path, content_type = nil)
+        # Kind of check if the file exists using the rescue
+        file = File.open(path.to_s)
+
+        unless content_type
+          mime = MIME::Types.type_for(path).first || MIME::Types['text/plain'].first
+          @headers['Content-Type']     = mime.to_s
+          @headers['Content-Encoding'] = mime.encoding
+        else
+          @headers['Content-Type']     = content_type
+        end
+
+        # Sendfile is used ?
+        if $mongrel_has_sendfile
+          @headers['X-Sendfile'] = path
+        else
+          @body = file.read
+        end
+
+      rescue Errno::ENOENT, Errno::EISDIR # File not found
+        forward(app::Controllers::NotFound, @env.PATH_INFO)
+      ensure
+        file.close if file
+      end
+    end
+  end
+end
+

data/lib/ext/template_view.rb

@@ -0,0 +1,72 @@
+require 'equipment'
+require 'ext/patches'
+
+module Ext
+  # A microcospical extension to decouple views from camping. Especially
+  # the ones based on templates.
+  #
+  # Adds a V class to your app on which all instance variables
+  # will be sent before rendering the view.
+  #
+  # == Dependencies
+  #
+  # * Equipment
+  # * Patches
+  #
+  # == TODO
+  #
+  # * Add support for layouts
+  module TemplateView
+    extend Equipment
+    depends_on Patches
+
+    def self.equip(app)
+      super
+      app.module_eval <<-SOME_VIEW
+        # Some kind of view data proxy for template-based renderers
+        class V
+          include Helpers
+          include Controllers
+          def bind(m,*a,&b); binding; end
+          def R(klass, *args); self / super; end
+        end
+      SOME_VIEW
+    end
+
+    module Base
+      # Takes template_root from ViewsClassMethods#template_root.
+      #
+      # You can change that by setting @template_root in your controller.
+      def template_root; @template_root || app::Views.template_root || '' end
+
+      # Same as #template_root
+      def use_cache; @use_cache || app::Views.use_cache; end
+    end
+
+    module ViewsClassMethods
+      # Sets the template_root. Usage is up to the template.
+      attr_accessor :template_root
+
+      # Set to true to add cache. Usage is up to the template.
+      attr_accessor :use_cache
+    end
+  end
+
+end
+
+class Object
+
+  # Sets all instance variables of an object to another
+  #
+  # if force is set to true, existing instance variables will be overwritten
+  def instance_variables_send(obj, force=false)
+    instance_variables.each do |v|
+      if force or not obj.instance_variables.include? v
+        obj.instance_variable_set(v, instance_variable_get(v))
+      end
+    end
+    obj
+  end
+  alias :ivs_send :instance_variables_send
+end
+

data/lib/ext/use_helper.rb

@@ -0,0 +1,83 @@
+require 'equipment'
+require 'ext/app_util'
+
+module Ext
+
+  # The UseHelper allows you to define in your view what js and css scripts
+  # you're using.
+  #
+  # That can then be later used in the layout.
+  #
+  # This is useful when you descript external styles.
+  #
+  # == Example
+  #
+  #  def layout
+  #    html do
+  #      head do
+  #        javascripts.each { |js| script :type=>'text/javascript', :src=>js }
+  #        stylesheets.each { |css| link :type=>'text/css', :rel=>'stylesheet', :href=>css }
+  #      end
+  #      body { yield }
+  #    end
+  #  end
+  #
+  #  def someview
+  #    use 'prototype.js', 'layout.css'
+  #    # ...
+  #  end
+  #
+  # == Dependency
+  #
+  # * Equipment
+  # * AppUtil
+  #
+  # == TODO
+  #
+  # * More doc
+  # 
+  # == Possible issues
+  #
+  # It is possible that the @__flash instance variable is not transmitted well
+  # between the controller and the view. This may cause unwanted behavior.
+  module UseHelper
+    extend Equipment
+    def self.equip(app)
+      app::Base.module_eval do
+        def intialize(r,env,m)
+        @__javascripts ||= []  # initializing those vars is needed
+        @__stylesheets ||= []
+        puts "UseHelper::Base : Initialized well" if $DBG
+        super
+      end
+    end
+      super
+    end
+
+    module Helpers
+      def javascripts
+        @__javascripts ||= []
+      end
+      def stylesheets
+        @__stylesheets ||= []
+      end
+      def use(*elems)
+        elems.each do |elem|
+          case elem
+          when /\.js$/
+            javascripts << elem unless javascripts.include? elem
+          when /\.css$/
+            stylesheets << elem unless stylesheets.include? elem
+          else
+            raise "Unknow type : #{elem}"
+          end
+        end
+      end
+      def use?(elem)
+        javascripts.include? elem or stylesheets.include? elem
+      end
+    end
+
+  end
+end 
+

data/lib/ext/xml_view.rb

@@ -0,0 +1,47 @@
+require 'equipment'
+
+module Ext
+  # Uses the Builder::XmlMarkup to build xml views. Not working as I want yet.
+  #
+  # == Depencency
+  #
+  # * Equipment
+  #
+  # == TODO
+  #
+  # * Reimplement this
+  #
+  module XmlView
+    extend Equipment
+
+    module Base
+
+
+=begin
+      def xml_view?(view)
+        return /application\/xml|\*\/\*/ =~ (env.HTTP_ACCEPT || '*/*')
+      end
+
+      def view(m, *a, &b)
+        if xml_view?(m)
+          return xml_view(m, *a, &b)
+        end
+        super
+      end
+=end
+
+      # For controllers which pass back XML directly, this method allows quick assignment
+      # of the status code and takes care of generating the XML headers.  Takes a block
+      # which receives the Builder::XmlMarkup object.
+      def xml_view(m, *a, &b)
+        xml = Builder::XmlMarkup.new
+        xml.instruct! :xml, :version=>"1.0", :encoding=>"UTF-8"
+        yield xml
+        @headers['Content-Type'] = 'application/xml'
+        @headers['Encoding']     = 'UTF-8'
+        xml.target!
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: equipment
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+date: 2006-07-06 00:00:00 +02:00
+summary: Camping equipments
+require_paths: 
+- lib
+email: zimba.tm@gmail.com
+homepage: http://equipment.rubyforge.org
+rubyforge_project: equipment
+description: 
+autorequire: 
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: 
+- Jonas Pfenniger
+files: 
+- lib
+- .
+- examples
+- lib/ext
+- lib/ext/patches.rb
+- examples/erubytest.rb
+- examples/index.erb
+- lib/ext/eruby_view.rb
+- lib/ext/template_view.rb
+- lib/ext/og_session.rb
+- examples/sendfiletest.rb
+- lib/ext/basic_auth.rb
+- lib/ext/xml_view.rb
+- README
+- lib/ext/use_helper.rb
+- lib/equipment.rb
+- lib/ext/js_helpers.rb
+- lib/ext/controls.rb
+- lib/ext/ressource.rb
+- examples/basicauthtest.rb
+- examples/patchestest.rb
+- examples/flashtest.rb
+- lib/ext/app_util.rb
+- lib/ext/forward.rb
+- lib/ext/security.rb
+- lib/ext/sendfile.rb
+- examples/ogtest.rb
+- examples/mounttest.rb
+- lib/ext/forms.rb
+- lib/ext/og_scaffold.rb
+- lib/ext/mount.rb
+- lib/ext/og.rb
+- ProjectInfo
+- lib/ext/flash.rb
+test_files: []
+
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+