lunetas 0.0.4 → 0.1.0

data/README.md

@@ -1,6 +1,80 @@
+![Lunetas](http://dulcemexico.com/productos/lunetasgrand.jpg)
+
 Lunetas
--------
+=======
 
-A mini framework based on top of Rack for APIs.
+A Rack based micro framework. 
 
-![Lunetas](http://dulcemexico.com/productos/lunetasgrand.jpg)
+Structure
+---------
+
+It is a class-url based framework. It means, that every class describes a route using
+a Regular Expression. It may respond to one or many HTTP methods. These responses are
+defined overwritting the methods get, put, post, delete, trace, head, etc.. It can
+also handle other non-native HTTP methods, using overwritting other_verb.
+
+What does all these means? Checkout an example. (Also you may want to take a look at
+the examples folder).
+
+Usage
+-----
+
+If you are going to use Lunetas as a stand alone Rack application. In order to get it
+running, you just need to add `run Lunetas::Bag` in your config.ru file. 
+
+If you are going to use Lunetas behind a framework like Rails. You just need to add
+the gem, `require 'lunetas'` in your metal, and you are ready to go.
+
+Examples
+--------
+
+### Simple example
+
+    require 'lunetas'
+    
+    class Testing
+      include Lunetas::Candy
+      matches '/hello/(\w+)', :name
+    
+      def before
+        @name = @name.capitalize
+      end
+    
+      def get
+        "Hello #{@name}! #{params[:chunky]}"
+      end
+    
+      def post
+        "Hey #{@name}, I see you're testing the POST method :)"
+      end
+    end
+    
+    class AnotherTest
+      include Lunetas::Candy
+      matches '^/(\d+)$', :number
+    
+      def get
+        "Is #{@number} your lucky number?"
+      end
+    
+      def other_verb(verb)
+        if verb == 'TEAPOT'
+          "I ain't a teapot!"
+        end
+      end
+    end
+
+### Defining a custom ContentType
+
+    require 'lunetas'
+    require 'json'
+    
+    class JaySon
+      include Lunetas::Candy
+      matches '^/something\.json$'
+      set_content_type 'application/json'
+    
+      def get
+        { :test => true, 'json' => "Yes, JSON", :amount => 1}.to_json
+      end
+    end

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.1.0

data/lib/lunetas.rb

@@ -4,8 +4,8 @@ require 'rack'
 
 module Lunetas
   base_dir = File.dirname(__FILE__) + '/lunetas/'
+  autoload :Bag,   base_dir + 'bag.rb'
   autoload :Candy, base_dir + 'candy.rb'
-  autoload :Bag, base_dir + 'bag.rb'
   autoload :Error, base_dir + 'error.rb'
 end
 

data/lib/lunetas/candy.rb

@@ -11,202 +11,19 @@
 #     end
 #   end
 module Lunetas::Candy
-  module InstanceMethods
-    # The matched url-regex for this resource.
-    attr_reader :url
-    attr_accessor :url_params
-    # The initialization of a class that includes a Candy, should be done
-    # with rack environment and the url matches from its regular expression.
-    # It will register all the passed url parameters from #matches as new
-    # instance variables.
-    # @param [Hash] env the Rack env.
-    # @param [Array] url_matches the matches from its regex. In most cases
-    #   (MatchData instance).to_a
-    def initialize(env, url_matches)
-      @req = Rack::Request.new(env)
-      @_url_params = url_matches
-      self.url_params = url_matches
-      @url = @_url_params.shift
-      begin
-        self.class._url_params.each_with_index do |option, index|
-          instance_variable_set "@#{option}", url_param(index)
-        end
-        # Provide an authentication method. Probably a method
-        # from the Lunetas::Bag.
-        #   authenticate!
-        # rescue Lunetas::Error::AuthenticationError
-        #   @_error = Lunetas::Error::AuthenticationError
-      end
-    end
-
-    # Returns the url parameter from the regular expresion. If a captured
-    # block is given, then they will be added in order of appearance.
-    # @param [Fixnum] index the index of the captured block.
-    # @return [String] the captured block.
-    def url_param(index)
-      @_url_params[index]
-    end
-  
-    # Bites the Candy (a.k.a process this resource). 
-    #
-    # @return [Array] a standard rack response.
-    def bite
-      raise @_error if @_error
-      before
-      response(handle_call)
-    rescue Exception => e
-      code, error = 500, e
-      if Lunetas::Error::BaseError === e
-        code = e.code
-      elsif development?
-        error = "Error: #{e.message}\nBacktrace: #{e.backtrace.join('\n')}"
-      end
-      response(error, code)
-    end
-
-    private
-      def handle_call
-        case @req.request_method
-        when 'GET'
-          get
-        when 'POST'
-          post
-        when 'PUT'
-          put
-        when 'DELETE'
-          delete
-        when 'HEAD'
-          head
-        when 'TRACE'
-          trace
-        when 'OPTIONS'
-          options
-        else
-          response = other_verb(@req.request_method)
-          raise Lunetas::Error::APIError unless response
-          response
-        end
-      end
-
-      def xhr?
-        @req.xhr?
-      end
-
-      def params
-        @req.params
-      end
-
-      def request
-        @req
-      end
-
-      def session
-        @req.session
-      end
-
-      def development?
-        ENV['RAILS_ENV'] == 'development' || ENV['RACK_ENV'].nil? || ENV['RACK_ENV'] == 'development'
-      end
-
-      # TODO: Polish this
-      # def authenticate!
-      #   @current_user = User.where(:single_access_token => token).first
-      #   raise Lunetas::Error::AuthenticationError unless @current_user
-      # end
-
-      def response(object, code = 200)
-        [code, {'Content-Type' => self.class.content_type}, [object.to_s]]
-      end
-
-      # The following methods should be overwritten by the including class
-      def before
-        nil
-      end
-
-      def get
-        raise Lunetas::Error::APIError
-      end
-
-      def post
-        raise Lunetas::Error::APIError
-      end
-
-      def put
-        raise Lunetas::Error::APIError
-      end
-
-      def delete
-        raise Lunetas::Error::APIError
-      end
-
-      def head
-        raise Lunetas::Error::APIError
-      end
-
-      def trace
-        raise Lunetas::Error::APIError
-      end
-
-      def options
-        raise Lunetas::Error::APIError
-      end
-
-      def other_verb(verb)
-        raise Lunetas::Error::APIError
-      end
-  end
-  
-  module ClassMethods
-    attr_reader :_url_params
-    attr_reader :content_type
-
-    # Support to be runned as a Rails Metal. 
-    # @param [Hash] env the Rack env.
-    # @return [Array] a standard Rack response.
-    def call(env)
-      url_match = env['PATH_INFO'].match(@_regex)
-      if url_match
-        candy = new(env, url_match.to_a)
-        candy.bite
-      else
-        [404, {"Content-Type" => "text/html", "X-Cascade" => "pass"}, ["Not Found"]]
-      end
-    end
-
-    private
-      # Registers a new regular expression. Will add it to the Lunetas::Bag.
-      # Will convert the regex to a Regular Expression, if passing a String. It
-      # also receives the instance variables for the matches of the regex.
-      # @example Regular expression as a Regexp
-      #   matches /\/test\/\w+/
-      # @example Regular expression as a double quoted string
-      #   matches "\\/test\\/\\w+"
-      # @example Regular expression as a single quoted string (my favorite)
-      #   matches '/test/\w+'
-      # @example Passing instance variables that will be set for the captures
-      #   matches '/test/(\d+)\.(\w+)', :id, :format
-      # @param [String, Regexp] regex the regular expression for this resource.
-      # @param [Array<Symbol, String>] url_params the instance variables that will
-      #   be set for the captures from the regex.
-      def matches(regex, *url_params)
-        @content_type = 'text/html'
-        @_regex = regex
-        unless Regexp === @_regex
-          @_regex = Regexp.new(@_regex)
-        end
-        @_url_params = url_params
-        Lunetas::Bag.register(@_regex, self)
-      end
-
-      # Sets the Content Type for this URL. Defaults to text/html.
-      # @param [String] content_type the ContentType for the response.
-      def set_content_type(content_type)
-        @content_type = content_type
-      end
-  end
+  base_dir = File.dirname(__FILE__) + '/candy/'
+  autoload :Initialization,  base_dir + 'initialization.rb'
+  autoload :MethodStrategy,  base_dir + 'method_strategy.rb'
+  autoload :RequestWrapper,  base_dir + 'request_wrapper.rb'
+  autoload :ResponseHandler, base_dir + 'response_handler.rb'
 
+  # @private
   def self.included(receiver)
-    receiver.send :include, InstanceMethods
-    receiver.send :extend, ClassMethods
+    receiver.send :include, Initialization::InstanceMethods
+    receiver.send :extend,  Initialization::ClassMethods
+    receiver.send :include, MethodStrategy::InstanceMethods
+    receiver.send :include, RequestWrapper::InstanceMethods
+    receiver.send :include, ResponseHandler::InstanceMethods
+    receiver.send :extend,  ResponseHandler::ClassMethods
   end
 end

data/lib/lunetas/candy/initialization.rb

@@ -0,0 +1,71 @@
+module Lunetas::Candy::Initialization
+  module InstanceMethods
+    # The matched url-regex for this resource.
+    attr_reader :url
+    # The url parameters hold by the instance.
+    attr_reader :lunetas_url_instance_params
+
+    # The initialization of a class that includes a Candy, should be done
+    # with rack environment and the url matches from its regular expression.
+    # It will register all the passed url parameters from #matches as new
+    # instance variables.
+    # @param [Hash] env the Rack env.
+    # @param [Array] url_matches the matches from its regex. In most cases
+    #   (MatchData instance).to_a
+    def initialize(env, url_matches)
+      @req = Rack::Request.new(env)
+      @lunetas_url_instance_params = url_matches
+      @url = @lunetas_url_instance_params.shift
+      begin
+        self.class.lunetas_url_params.each_with_index do |option, index|
+          instance_variable_set "@#{option}", url_param(index)
+        end
+        # Provide an authentication method. Probably a method
+        # from the Lunetas::Bag.
+        #   authenticate!
+        # rescue Lunetas::Error::AuthenticationError
+        #   @_error = Lunetas::Error::AuthenticationError
+      end
+    end
+  end
+
+  module ClassMethods
+    # Holds the URL params, this will be created as instance 
+    # variables when the class is initialized.
+    attr_reader :lunetas_url_params
+    # Holds the Content Type for this request.
+    attr_reader :lunetas_content_type
+    # Holds the Regular Expression for this class.
+    attr_reader :lunetas_regex
+
+    # Registers a new regular expression. Will add it to the Lunetas::Bag.
+    # Will convert the regex to a Regular Expression, if passing a String. It
+    # also receives the instance variables for the matches of the regex.
+    # @example Regular expression as a Regexp
+    #   matches /\/test\/\w+/
+    # @example Regular expression as a double quoted string
+    #   matches "\\/test\\/\\w+"
+    # @example Regular expression as a single quoted string (my favorite)
+    #   matches '/test/\w+'
+    # @example Passing instance variables that will be set for the captures
+    #   matches '/test/(\d+)\.(\w+)', :id, :format
+    # @param [String, Regexp] regex the regular expression for this resource.
+    # @param [Array<Symbol, String>] url_params the instance variables that will
+    #   be set for the captures from the regex.
+    def matches(regex, *url_params)
+      @lunetas_content_type = 'text/html'
+      @lunetas_regex = regex
+      unless Regexp === lunetas_regex
+        @lunetas_regex = Regexp.new(regex)
+      end
+      @lunetas_url_params = url_params
+      Lunetas::Bag.register(lunetas_regex, self)
+    end
+
+    # Sets the Content Type for this URL. Defaults to text/html.
+    # @param [String] content_type the ContentType for the response.
+    def set_content_type(content_type)
+      @lunetas_content_type = content_type
+    end
+  end
+end

data/lib/lunetas/candy/method_strategy.rb

@@ -0,0 +1,80 @@
+# This is an 'abstract' class for the response of the call.
+# The methods here can and should be overwritten. If they're
+# not (the http methods) will raise an exception, telling that
+# this method is not allowed for this route.
+module Lunetas::Candy::MethodStrategy
+  module InstanceMethods
+    # Called before getting the response. Useful to set instance
+    # variables that will be used in the methods. Analog to a
+    # before filter in Rails.
+    # @return [nil]
+    def before
+      nil
+    end
+
+    # The response of the GET HTTP method.
+    # @raise [Lunetas::Error::APIError] if the method is not
+    #  overwritten.
+    # @return [nil]
+    def get
+      raise Lunetas::Error::APIError
+    end
+
+    # The response of the POST HTTP method.
+    # @raise [Lunetas::Error::APIError] if the method is not
+    #  overwritten.
+    # @return [nil]
+    def post
+      raise Lunetas::Error::APIError
+    end
+
+    # The response of the PUT HTTP method.
+    # @raise [Lunetas::Error::APIError] if the method is not
+    #  overwritten.
+    # @return [nil]
+    def put
+      raise Lunetas::Error::APIError
+    end
+
+    # The response of the DELETE HTTP method.
+    # @raise [Lunetas::Error::APIError] if the method is not
+    #  overwritten.
+    # @return [nil]
+    def delete
+      raise Lunetas::Error::APIError
+    end
+
+    # The response of the HEAD HTTP method.
+    # @raise [Lunetas::Error::APIError] if the method is not
+    #  overwritten.
+    # @return [nil]
+    def head
+      raise Lunetas::Error::APIError
+    end
+
+    # The response of the TRACE HTTP method.
+    # @raise [Lunetas::Error::APIError] if the method is not
+    #  overwritten.
+    # @return [nil]
+    def trace
+      raise Lunetas::Error::APIError
+    end
+
+    # The response of the OPTIONS HTTP method.
+    # @raise [Lunetas::Error::APIError] if the method is not
+    #  overwritten.
+    # @return [nil]
+    def options
+      raise Lunetas::Error::APIError
+    end
+
+    # The response of the any other HTTP method.
+    # @raise [Lunetas::Error::APIError] if the method is not
+    #  overwritten.
+    # @param [String] verb the HTTP method that was called from.
+    # @return [nil]
+    def other_verb(verb)
+      raise Lunetas::Error::APIError
+    end
+  end
+end

data/lib/lunetas/candy/request_wrapper.rb

@@ -0,0 +1,40 @@
+# This module is a Wrapper for the request object. It exposes
+# several methods in order to get the session, params, etc.
+module Lunetas::Candy::RequestWrapper
+  module InstanceMethods
+    # Called from an XML Http Request?
+    # @return [true, false]
+    def xhr?
+      @req.xhr?
+    end
+
+    # Gets the request parameters.
+    # @return [Hash]
+    def params
+      @req.params
+    end
+
+    # Gets the current request object.
+    # @return [Rack::Request]
+    def request
+      @req
+    end
+
+    # Gets the current session.
+    # @return [Hash]
+    def session
+      @req.session
+    end
+
+    # Is lunetas running in development?
+    # @return [true, false]
+    def development?
+      if ENV['RAILS_ENV']
+        ENV['RAILS_ENV'] == 'development'
+      else
+        ENV['RACK_ENV'].nil? || ENV['RACK_ENV'] == 'development'
+      end
+    end
+  end
+end
+

data/lib/lunetas/candy/response_handler.rb

@@ -0,0 +1,81 @@
+# Handles the response to the client. Has the call method to
+# be called from Rack.
+module Lunetas::Candy::ResponseHandler
+  module InstanceMethods
+    # Handles the rack call. Delegates it to the method
+    # that matches the request method.
+    # @return [Array] a Rack::Request response.
+    def handle_call
+      case @req.request_method
+      when 'GET'
+        get
+      when 'POST'
+        post
+      when 'PUT'
+        put
+      when 'DELETE'
+        delete
+      when 'HEAD'
+        head
+      when 'TRACE'
+        trace
+      when 'OPTIONS'
+        options
+      else
+        response = other_verb(@req.request_method)
+        raise Lunetas::Error::APIError unless response
+        response
+      end
+    end
+
+    # Bites the Candy (a.k.a process this resource). 
+    #
+    # @return [Array] a standard rack response.
+    def bite
+      raise @_error if @_error
+      before
+      response(handle_call)
+    rescue Exception => e
+      code, error = 500, e
+      if Lunetas::Error::BaseError === e
+        code = e.code
+      elsif development?
+        error = "Error: #{e.message}\nBacktrace: #{e.backtrace.join("\n")}"
+      end
+      response(error, code)
+    end
+
+    # Returns the url parameter from the regular expresion. If a captured
+    # block is given, then they will be added in order of appearance.
+    # @param [Fixnum] index the index of the captured block.
+    # @return [String] the captured block.
+    def url_param(index)
+      @lunetas_url_instance_params[index]
+    end
+
+    private
+      # A Rack::Request response with the specified content type.
+      # @param [Object#to_s] object the object that will be the
+      #  response.
+      # @param [Fixnum] code the response code.
+      # @return [Array] a Rack::Request response.
+      def response(object, code = 200)
+        [code, {'Content-Type' => self.class.lunetas_content_type}, [object.to_s]]
+      end
+  end
+  
+  module ClassMethods
+    # Support to be runned as a Rails Metal.
+    # @param [Hash] env the Rack env.
+    # @return [Array] a standard Rack response.
+    def call(env)
+      url_match = env['PATH_INFO'].match(lunetas_regex)
+      if url_match
+        candy = new(env, url_match.to_a)
+        candy.bite
+      else
+        [404, {"Content-Type" => "text/html", "X-Cascade" => "pass"}, ["Not Found"]]
+      end
+    end
+  end
+end

data/spec/lunetas/candy_spec.rb

@@ -1,6 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
 
-describe Lunetas::Candy::InstanceMethods do
+describe Lunetas::Candy do
   describe '.initialize' do
     before(:each) do
       @instance = TestClass.new(mock_env('/just_a_test'), ['/just_a_test', 'a', 'b'])

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lunetas
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 27
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 4
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors: 
 - "Iv\xC3\xA1n Vald\xC3\xA9s (@ivanvc)"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-24 00:00:00 -05:00
+date: 2010-08-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -98,6 +98,10 @@ files:
 - lib/lunetas.rb
 - lib/lunetas/bag.rb
 - lib/lunetas/candy.rb
+- lib/lunetas/candy/initialization.rb
+- lib/lunetas/candy/method_strategy.rb
+- lib/lunetas/candy/request_wrapper.rb
+- lib/lunetas/candy/response_handler.rb
 - lib/lunetas/error.rb
 - spec/lunetas/bag_spec.rb
 - spec/lunetas/candy_spec.rb