RubyGems - exocora - Versions diffs - 0.1.0 - Mend

exocora 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (17) hide show

data/LICENSE ADDED Viewed

@@ -0,0 +1,27 @@
+Copyright (c) 2008 Aphyr <aphyr@aphyr.com>.
+All rights reserved.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright notice,
+      this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice,
+      this list of conditions and the following disclaimer in the documentation
+      and/or other materials provided with the distribution.
+    * Neither the name of the <ORGANIZATION> nor the names of its contributors
+      may be used to endorse or promote products derived from this software
+      without specific prior written permission.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/examples/hello_world.cgi ADDED Viewed

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby
+require File.dirname(__FILE__) + '/../lib/exocora'
+#require '/home/aphyr/exocora/lib/exocora'
+class HelloWorld < Exocora::Sheet
+  def process
+    {:body => "Hello, world"}
+  end
+end
+HelloWorld.run

data/examples/hello_world.rhtml ADDED Viewed

@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <title>Test</title>
+  </head>
+  <body>
+    <h1><%= @body %></h1>
+  </body>
+</html>

data/examples/request.cgi ADDED Viewed

@@ -0,0 +1,12 @@
+#!/usr/bin/ruby
+require File.dirname(__FILE__) + '/../lib/exocora'
+#require '/home/aphyr/exocora/lib/exocora'
+class Request < Exocora::Sheet
+  def process
+    {:r => request}
+  end
+end
+Request.run

data/examples/request.rhtml ADDED Viewed

@@ -0,0 +1,35 @@
+<html>
+  <head>
+    <title>Request Test</title>
+  </head>
+  <body>
+    <h1>Inferred URI information</h1>
+    <ul>
+      <li>Host URI: <%== @r.host_uri %></li>
+      <li>Relative URI: <%==@r.relative_uri %></li>
+      <li>Full URI: <%== @r.uri %></li>
+    </ul>
+    <h1>Request Parameters</h1>
+    <% names = [
+    'AUTH_TYPE', 'HTTP_HOST', 'REMOTE_IDENT',
+'CONTENT_LENGTH', 'HTTP_NEGOTIATE', 'REMOTE_USER',
+'CONTENT_TYPE', 'HTTP_PRAGMA', 'REQUEST_METHOD',
+'GATEWAY_INTERFACE', 'HTTP_REFERER', 'SCRIPT_NAME',
+'HTTP_ACCEPT', 'HTTP_USER_AGENT', 'SERVER_NAME',
+'HTTP_ACCEPT_CHARSET', 'PATH_INFO', 'SERVER_PORT',
+'HTTP_ACCEPT_ENCODING', 'PATH_TRANSLATED', 'SERVER_PROTOCOL',
+'HTTP_ACCEPT_LANGUAGE', 'QUERY_STRING', 'SERVER_SOFTWARE',
+'HTTP_CACHE_CONTROL', 'REMOTE_ADDR',
+'HTTP_FROM', 'REMOTE_HOST'
+    ] %>
+    <table>
+    <% names.each do |name| %>
+      <tr>
+        <td><%== name %></td>
+        <td><%== @r.send(name.downcase.sub(/^http_/, '')).inspect %></td>
+      </tr>
+    <% end %>
+    </table>
+  </body>
+</html>

data/examples/validation.cgi ADDED Viewed

@@ -0,0 +1,20 @@
+#!/usr/bin/ruby
+require File.dirname(__FILE__) + '/../lib/exocora'
+#require '/home/aphyr/exocora/lib/exocora'
+class Validation < Exocora::Sheet
+  validate(:short) do |value|
+    value.length < 4
+  end
+  validate(:num, "must be a number").when Numeric
+  validate(:empty).unless(lambda { |s| s.size > 0 }).because("must be empty")
+  def process
+    {:params => params, :errors => errors}
+  end
+end
+Validation.run

data/examples/validation.rhtml ADDED Viewed

@@ -0,0 +1,20 @@
+<html>
+  <head>
+    <title>Validation Test</title>
+  </head>
+  <body>
+    <h1>Errors</h1>
+    <ul>
+      <% @errors.each do |name, errors| %>
+        <li><%= name %> <%= errors.to_sentence %>.</li>
+      <% end %>
+    </ul>
+    <h1>All Parameters</h1>
+    <ul>
+      <% @params.each do |name, value| %>
+        <li><%= name %>: <%= value.inspect %></li>
+      <% end %>
+    </ul>
+  </body>
+</html>

data/lib/array.rb ADDED Viewed

@@ -0,0 +1,18 @@
+class Array
+  # Convert an array to a nice sentence. Method is called on each element of the array, and should return a string.
+  def to_sentence(method = :to_s)
+    case size
+    when 0
+      ''
+    when 1
+      first.send method
+    when 2
+      first.send(method) + ' and ' + last.send(method)
+    else
+      sentence = self[1..-2].inject(first.send(method)) do |sentence, element|
+        sentence += ', ' + element.send(method)
+      end
+      sentence + ', and ' + last.send(method)
+    end
+  end
+end

data/lib/cgi.rb ADDED Viewed

@@ -0,0 +1,46 @@
+class CGI
+  HTTP_PORT = 80
+  HTTPS_PORT = 443
+  # Returns a full uri for a given uri fragment.
+  # full_uri_for 'foo.cgi' => 'http://localhost/dir/foo.cgi'
+  # full_uri_for '/images/' => 'http://localhost/images/'
+  def full_uri_for(fragment)
+    case fragment
+    when /^http:\/\//
+      # The fragment is a complete URI
+      fragment
+    when /^\//
+      # The fragment is relative to the root of this host
+      host_uri + fragment
+    else
+      # The fragment is relative to this directory
+      relative_uri + fragment
+    end
+  end
+  # Try to guess the uri for the host alone (http://host/)
+  def host_uri
+    uri = ''
+    case server_port
+    when HTTP_PORT
+      uri << 'http://' + server_name
+    when HTTPS_PORT
+      uri << 'https://' + server_name
+    else
+      uri << 'https://' + server_name + ':' + server_port
+    end
+    uri
+  end
+  # Try to guess the relative path for this request. (http://host/directory/)
+  def relative_uri
+    uri.sub(/[^\/]*$/, '')
+  end
+  # Try to guess the full uri for this script (http://host/directory/script.cgi)
+  def uri
+    host_uri.chop + script_name
+  end
+end

data/lib/exocora/errors.rb ADDED Viewed

@@ -0,0 +1,47 @@
+class Exception
+  def to_html
+    "<p><b>#{self.class}</b>: #{Erubis::XmlHelper::escape_xml(to_s)}</p>" +
+    "<p>Backtrace:" +
+    '<ul>' + backtrace.map { |line|
+      '<li><code>' + Erubis::XmlHelper::escape_xml(line) + '</code></li>'
+    }.join + '</ul></p>'
+  end
+end
+module Exocora
+  # An error encountered when validating data
+  class ValidationError < RuntimeError
+    attr_accessor :value, :message
+    def initialize(value, message = 'is invalid')
+      @value = value
+      @message = message
+    end
+    def to_s
+      @message
+    end
+  end
+  # Represents an error encountered in an Exocora sheet.
+  class SheetError < RuntimeError
+  end
+  # Represents an error encountered when processing a template.
+  class TemplateError < RuntimeError
+    attr_accessor :message, :exception
+    def initialize(message, exception)
+      @message = message
+      @exception = exception
+    end
+    def to_html
+      "<p>" + Erubis::XmlHelper::escape_xml(@message) + "</p>" +
+      "<p>The original exception was:</p>" +
+      if @exception.respond_to? :to_html
+        @exception.to_html
+      else
+        Erubis::XmlHelper::escape_xml(@exception.to_s)
+      end
+    end
+  end
+end

data/lib/exocora/sheet.rb ADDED Viewed

@@ -0,0 +1,205 @@
+module Exocora
+  # A single CGI script. Requests are processed through a chain of actions
+  #
+  # validate - extract and sanitize data from the CGI request
+  # process  - do stuff
+  # render   - render to the specified template.
+  class Sheet
+    # Parameters with validations
+    @@validations = Hash.new
+    attr_reader :params, :errors
+    def initialize
+      @cgi = CGI.new
+      @headers = {
+      }
+      @params = {}
+      @errors = {}
+      @template = self.class.to_s.module_path
+      @log_file = self.class.to_s.underscore + '.log'
+    end
+    # Adds a validation condition for a parameter.
+    # validate :query { |q| q.size > 0 }
+    # validate :query, "is invalid" { |q|
+    def self.validate(param, message='must be valid', &block)
+      validation = Validation.new(nil, message)
+      if block_given?
+        validation.when block
+      end
+      @@validations[param.to_s] ||= []
+      @@validations[param.to_s] << validation
+      validation
+    end
+    # Creates an instance of this sheet, and runs it.
+    def self.run
+      new.run
+    end
+    # Casts incoming CGI parameters to nil, numerics, collapses single-element
+    # arrays, and so forth.
+    def cast_params(params)
+      cast = {}
+      params.each do |key, values|
+        cast_values = values.map do |value|
+          if value =~ /^\d+$/
+            value.to_i
+          elsif value =~ /^[\d.]+$/
+            value.to_f
+          else
+            value
+          end
+        end
+        if values.empty?
+          cast[key] = nil
+        elsif values.size == 1
+          cast[key] = cast_values.first
+        else
+          cast[key] = cast_values
+        end
+      end
+      cast
+    end
+    # Logs a message to a file.
+    def log(message)
+      File.open(@log_file, 'a') do |file|
+        file.puts message
+      end
+    end
+    # Chooses the file for logging.
+    def log_to(file)
+      @log_file = file
+    end
+    # Sends output to the client. The first time output is called, it sends an
+    # HTTP header first.
+    def output(string)
+      unless @headers_sent
+        puts @cgi.header(@headers)
+        @headers_sent = true
+      end
+      puts string
+    end
+    # Process is the meat of the script.
+    # It returns a hash like {:a => 2}, which become instance
+    # variables @a = 2 in the template.
+    def process
+    end
+    # Breaks the normal rendering flow, and outputs an HTTP redirect header.
+    def redirect_to(uri_fragment)
+      @headers['Status'] = '302 Moved'
+      @headers['Location'] = @cgi.full_uri_for uri_fragment
+      output
+    end
+    # Renders the erubis template for this action. Takes a hash of variables to
+    # render. The default template is determined by underscoring this sheet's
+    # class name, but another template can be specified using #template.
+    def render(context = Erubis::Context.new)
+      # Read template data
+      template_filename = "#{@template}.rhtml"
+      begin
+        template = File.read(template_filename)
+      rescue Errno::ENOENT
+        raise ScriptError.new("Template #{template_filename} does not exist!")
+      end
+      # Prepare template and variables
+      eruby = Erubis::Eruby.new template
+      # Perform templating
+      begin
+        result = eruby.evaluate context
+      rescue
+        raise TemplateError.new("Encountered error processing template #{template_filename}.", $!)
+      end
+      # Output result
+      output result
+    end
+    # Accessor for the CGI object
+    def request
+      @cgi
+    end
+    # This is the action which initiates processing of the script.
+    def run
+      begin
+        # Cast parameters
+        @params = cast_params @cgi.params
+        # Check parameters
+        validate
+        # Run process
+        context = process
+        # Render output
+        render context
+      rescue
+        # Handle errors
+        output "<html><head><title>Exocora Error</title></head><body>"
+        output "<h1>#{$!.class}</h1>"
+        output $!.to_html
+        output "</body></html>"
+      end
+    end
+    # Sets the name of the template to render.
+    def use_template(template)
+      @template = template
+    end
+    # Returns true if the specified (or all) parameters have no errors.
+    def valid?(param = nil)
+      if param.nil?
+        @errors.empty?
+      else
+        @errors[param].nil? or @errors[param].empty?
+      end
+    end
+    # Validates CGI parameters according to @@validations.
+    #
+    # Parameters which fail validation have entries recorderd in @errors.
+    def validate(params = @params)
+      @@validations.each do |param, validations|
+        validations.each do |validation|
+          values = params[param]
+          # If there are multiple values, check each one.
+          unless values.kind_of? Array
+            values = [values]
+          end
+          values.each do |value|
+            begin
+              validation.validate(value)
+            rescue ValidationError => e
+              @errors[param] ||= []
+              @errors[param] << e
+            end
+          end
+        end
+      end
+      params
+    end
+  end
+end

data/lib/exocora/support.rb ADDED Viewed

@@ -0,0 +1,4 @@
+module Exocora
+  module Support
+  end
+end

data/lib/exocora/validation.rb ADDED Viewed

@@ -0,0 +1,73 @@
+module Exocora
+  # Validates a parameter. If a block is provided, the block is applied to
+  # values passed to apply; the return value determines if the value is valid.
+  # Otherwise, compares filter === value.
+  class Validation
+    attr_accessor :message, :filter, :negate
+    def initialize(filter = Object, message = 'must be valid')
+      @filter = filter
+      @message = message
+      @negate = false
+    end
+    # Change the message given when this validation fails.
+    def because(message)
+      @message = message
+      self
+    end
+    alias :explain :because
+    def to_s
+      "#{@message} #{@negate ? 'unless' : 'when'} #{@filter.inspect}"
+    end
+    # Adds the opposite of this filter
+    def unless(filter, &block)
+      @filter = block_given? ? block : filter
+      @negate = true
+      self
+    end
+    # Applies this validation to a valie. Returns true, or raises a
+    # ValidationError.
+    def validate(value)
+      # Treat the filter as a function or a rubric
+      if @filter.respond_to? :call
+        method = :call
+      else
+        method = :===
+      end
+      # Check the value
+      begin
+        result = @filter.send method, value
+      rescue
+        result = false
+      end
+      # If we're a negative filter, negate the result
+      if negate
+        result = ! result
+      end
+      # Return
+      if result
+        value
+      else
+        raise ValidationError.new(value, @message)
+      end
+    end
+    # Sets the filter used
+    def if(filter, &block)
+      @filter = block_given? ? block : filter
+      @negate = false
+      self
+    end
+    alias :with :if
+    alias :when :if
+  end
+end

data/lib/exocora/version.rb ADDED Viewed

@@ -0,0 +1,8 @@
+module Exocora
+  APP_NAME = 'exocora'
+  APP_VERSION = '0.1.0'
+  APP_AUTHOR = 'aphyr'
+  APP_EMAIL = 'aphyr@aphyr.com'
+  APP_URL = 'http://aphyr.com/'
+  APP_COPYRIGHT = 'Copyright (c) 2008 aphyr <aphyr@aphyr.com>. All rights reserved.'
+end

data/lib/exocora.rb ADDED Viewed

@@ -0,0 +1,26 @@
+# Exocora is an obscure species of spider, in the sheet weaver family.
+#
+# It is also a small web framework for writing CGI scripts, or "sheets". Each
+# request has a three-stage lifecycle, in which it extracts and checks incoming
+# data for safety, performs some operations, and renders a templated result.
+require 'rubygems'
+require 'cgi'
+require 'erubis'
+APPDIR = File.dirname(File.expand_path($0))
+BASEDIR = File.dirname(File.expand_path(__FILE__))
+$LOAD_PATH.unshift(BASEDIR)
+$LOAD_PATH.uniq!
+require 'string'
+require 'array'
+require 'cgi'
+require 'exocora/support'
+require 'exocora/errors'
+require 'exocora/validation'
+require 'exocora/sheet'
+module Exocora
+end

data/lib/string.rb ADDED Viewed

@@ -0,0 +1,62 @@
+# Provides support methods for string manipulation
+class String
+  # Converts dashes, underscores, and spaces to camelcase
+  #
+  # "foo_bar_baz".camelcase => "FooBarBaz"
+  # "FooBarBaz".camelcase(false) => "fooBarBaz"
+  def camelcase(first_letter_capitalized = true)
+    # Convert separators
+    camelcase = gsub(/[ _-]([^ _-])/) do |match|
+      $1.upcase
+    end
+    # Convert first letter
+    if first_letter_capitalized
+      camelcase[0..0].upcase + camelcase[1..-1]
+    else
+      camelcase[0..0].downcase + camelcase[1..-1]
+    end
+  end
+  # Removes module and class prefixes
+  #
+  # "Foo::Bar::Baz".demodulize => "Baz"
+  def demodulize
+    self[/([^:]+)$/]
+  end
+  # Splits the string into module and class components
+  #
+  # "Foo::Bar::Baz".module_split => ["Foo", "Bar", "Baz"]
+  def module_split
+    self.split /::/
+  end
+  # Converts the string into a conventional path.
+  def module_path
+    File.join(module_split.map {|e| e.underscore })
+  end
+  # Converts dashes, spaces, and capitals to underscore separators.
+  #
+  # "FooBar-Baz Whee".underscore => 'foo_bar_baz_whee'
+  def underscore(force_lower_case = true)
+    # Convert separators
+    underscore = gsub(/[ -]/, '_')
+    # Convert capitals
+    underscore.gsub!(/(.)([A-Z])/) do |match|
+      $1 + '_' + $2
+    end
+    # Drop double underscores
+    underscore.gsub!(/_+/, '_')
+    if force_lower_case
+      underscore.downcase
+    else
+      underscore
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+rubygems_version: 0.9.4
+specification_version: 1
+name: exocora
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+date: 2008-03-27 00:00:00 -05:00
+summary: A small framework for cgi scripts
+require_paths:
+- lib
+email: aphyr@aphyr.com
+homepage: http://aphyr.com/
+rubyforge_project:
+description:
+autorequire:
+default_executable:
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.8.6
+  version:
+platform: ruby
+signing_key:
+cert_chain:
+post_install_message:
+authors:
+- aphyr
+files:
+- examples/validation.rhtml
+- examples/hello_world.rhtml
+- examples/validation.cgi
+- examples/hello_world.cgi
+- examples/request.rhtml
+- examples/request.cgi
+- lib/cgi.rb
+- lib/array.rb
+- lib/exocora.rb
+- lib/string.rb
+- lib/exocora
+- lib/exocora/support.rb
+- lib/exocora/validation.rb
+- lib/exocora/sheet.rb
+- lib/exocora/errors.rb
+- lib/exocora/version.rb
+- LICENSE
+test_files: []
+rdoc_options: []
+extra_rdoc_files: []
+executables: []
+extensions: []
+requirements: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: erubis
+  version_requirement:
+  version_requirements: !ruby/object:Gem::Version::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+    version: