lunetas 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.md
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Iván Valdés (@ivanvc)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,6 @@
+Lunetas
+-------
+
+A mini framework based on top of Rack for APIs.
+
+![Lunetas](http://dulcemexico.com/productos/lunetasgrand.jpg)

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "lunetas"
+    gem.summary = %Q{Rack micro framework intended for APIs}
+    gem.description = %Q{This is a micro framework based in Rack, inspired in Sinatra, camping and many others. The intention is to have fast responses for simple API calls. The base unit of this framework are the classes, which registers a regular expression that will match this resource.}
+    gem.email = "iv@nvald.es"
+    gem.homepage = "http://github.com/ivanvc/lunetas"
+    gem.authors = ["Iván Valdés (@ivanvc)"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_development_dependency "yard", ">= 0"
+    gem.add_development_dependency "shotgun", ">= 0"
+    gem.add_dependency "rack", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/examples/config.ru

@@ -0,0 +1,3 @@
+require 'testing'
+
+run Lunetas::Bag

data/examples/testing.rb

@@ -0,0 +1,29 @@
+require '../lib/lunetas'
+
+class Testing
+  include Lunetas::Candy
+  matches '/hello/(\w+)', :name
+
+  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

data/lib/lunetas.rb

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

data/lib/lunetas/bag.rb

@@ -0,0 +1,33 @@
+# This is the module that keeps the register of all the Lunetas. It will add the 
+# classes to a register, and whenever rack receives a call, it delegates it.
+# If Lunetas is not run as a stand alone rack application, then this module
+# lacks of responsability, ie. Running as a Rails Metal.
+module Lunetas::Bag
+  # Registers new classes to a given regular expression. It should be called from
+  # a Luneta.
+  # @param [Regexp] regex the regular expression for this Luneta Class.
+  # @param [Luneta] candy the class that owns the regular expresion.
+  def self.register(regex, candy)
+    # TODO: Log: "Registering #{regex.inspect} #{candy.inspect}"
+    @@candies ||= {}
+    @@candies[regex] = candy
+  end
+
+  # Rack's call method. Will be called with the env, from rack. If it matches
+  # a regular expression, it will start a new instance of the propiertary class.
+  # If there's no matching class, it will return a 404.
+  #
+  # @param [Hash] env the rack's env.
+  # @return [Array] the rack response.
+  def self.call(env)
+    @url_match = nil
+    match_regex = @@candies.keys.find do |regex| 
+      @url_match = env['PATH_INFO'].match(regex)
+    end
+    unless match_regex
+      return [404, {"Content-Type" => "text/html", "X-Cascade" => "pass"}, ["Not Found"]]
+    end
+    candy = @@candies[match_regex].new(env, @url_match.to_a)
+    candy.bite
+  end
+end

data/lib/lunetas/candy.rb

@@ -0,0 +1,186 @@
+# This module should be included in any resource that should be exposed with
+# an API. Then the method matches should be called in order to register the
+# path for this resource.
+# @example Simple example
+#   class Testing
+#     include Lunetas::Candy
+#     matches '/test'
+#
+#     def get
+#       "This is what I answer then calling GET '/test'"
+#     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
+      response(e, e.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
+
+      # 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' => "application/json"}, [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
+
+    # 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
+        call = new(env, url_match.to_a)
+        call.process
+      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)
+        @_regex = regex
+        unless Regexp === @_regex
+          @_regex = Regexp.new(@_regex)
+        end
+        @_url_params = url_params
+        Lunetas::Bag.register(@_regex, self)
+      end
+  end
+
+  def self.included(receiver)
+    receiver.send :include, InstanceMethods
+    receiver.send :extend, ClassMethods
+  end
+end

data/lib/lunetas/error.rb

@@ -0,0 +1,42 @@
+module Lunetas::Error
+  class BaseError < StandardError
+    def to_json
+      {'error' => message}.to_json
+    end 
+    def code
+      400 
+    end 
+    def message
+      "Error"
+    end 
+    def to_s
+      message
+    end
+  end 
+  class AuthenticationError < BaseError
+    def code
+      401 
+    end 
+    def message
+      "Permission denied"
+    end 
+  end 
+
+  class BuildError < BaseError
+    def code
+      405 
+    end 
+    def message
+      "Build error"
+    end 
+  end 
+
+  class APIError < BaseError
+    def code
+      404 
+    end 
+    def message
+      "API route error"
+    end 
+  end 
+end

data/spec/lunetas/bag_spec.rb

@@ -0,0 +1,40 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Lunetas::Bag do
+
+  describe "register" do
+    before(:each) do
+      @luneta_class, @luneta_object = mock_candy
+    end
+
+    it 'should register a new class' do
+      Lunetas::Bag.register(/test/, @luneta_class)
+      @luneta_object.should_receive(:bite)
+      Lunetas::Bag.call(mock_env('/test'))
+    end
+  end
+
+  describe "call" do
+    before(:each) do
+      @luneta_class, @luneta_object = mock_candy
+    end
+
+    it 'should return a 404 if no matching path' do
+      Lunetas::Bag.call(mock_env('/123')).first.should == 404
+    end
+
+    it 'should return the bite of the called' do
+      Lunetas::Bag.register(/chunky/, @luneta_class)
+      @luneta_class.should_receive(:new).and_return(@luneta_object)
+      @luneta_object.should_receive(:bite).once
+      Lunetas::Bag.call(mock_env('/chunky')).first.should == 200
+    end
+
+    it 'should pass the matched regex and matches' do
+      Lunetas::Bag.register(/bacon\/(bbacon)/, @luneta_class)
+      env = mock_env('/bacon/bbacon')
+      @luneta_class.should_receive(:new).with(env, ['bacon/bbacon', 'bbacon'])
+      Lunetas::Bag.call(env)
+    end
+  end
+end

data/spec/lunetas/candy_spec.rb

@@ -0,0 +1,106 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Lunetas::Candy::InstanceMethods do
+  describe '.initialize' do
+    before(:each) do
+      @instance = TestClass.new(mock_env('/just_a_test'), ['/just_a_test', 'a', 'b'])
+    end
+
+    it 'should set the url variable' do
+      @instance.url.should == '/just_a_test'
+    end
+
+    it 'should set the url params' do
+      @instance.url_param(0).should == 'a'
+      @instance.url_param(1).should == 'b'
+    end
+  end
+
+  describe '.url_param' do
+    it 'should be accasible through its index' do
+      instance = TestClass.new(mock_env('/just_a_test'), ['/just_a_test', 'a'])
+      instance.url_param(0).should == 'a'
+    end
+
+    it 'should have none if no matches' do
+      instance = TestClass.new(mock_env('/just_a_test'), ['/just_a_test'])
+      instance.url_param(0).should be_nil
+    end
+  end
+
+  describe '.bite' do
+    before(:each) do
+      @instance = TestClass.new(mock_env('/just_a_test'), ['/just_a_test', 'a'])
+    end
+
+    it 'should call the before method' do
+      @instance.should_receive(:before).once
+      @instance.bite
+    end
+    
+    it 'should call to the response' do
+      @instance.should_receive(:response).once.and_return('')
+      @instance.bite
+    end
+
+    it 'should answer with the raised error' do
+      test_exception = TestException.new
+      @instance.should_receive(:before).and_raise(test_exception)
+      @instance.should_receive(:response).with(test_exception, 400)
+      @instance.bite
+    end
+
+    it 'should call to the get method' do
+      @instance.should_receive(:get)
+      @instance.bite
+    end
+
+    it 'should render the given response' do
+      @instance.bite.last.should == ['Chunky Bacon']
+    end
+
+    %w{post put delete head trace options}.each do |verb|
+      it 'should call to the #{verb} method if called with #{verb.upcase}' do
+        mock_env = mock_env('/just_a_test')
+        mock_env['REQUEST_METHOD'] = verb.upcase
+        @instance = TestClass.new(mock_env, ['/just_a_test'])
+        @instance.should_receive(verb)
+        @instance.bite
+      end
+
+      it 'should return an API Error to #{verb.upcase} if no defined' do
+        mock_env = mock_env('/just_a_test')
+        mock_env['REQUEST_METHOD'] = verb.upcase
+        @instance = TestClass.new(mock_env, ['/just_a_test'])
+        @instance.should_receive(verb).and_raise(Lunetas::Error::APIError)
+        @instance.bite.last.should == ["API route error"]
+      end
+    end
+
+    it 'should call to other_verb with the passed method' do
+      mock_env = mock_env('/just_a_test')
+      mock_env['REQUEST_METHOD'] = 'TEAPOT'
+      @instance = TestClass.new(mock_env, ['/just_a_test'])
+      @instance.should_receive(:other_verb).with('TEAPOT')
+      @instance.bite
+    end
+
+    it 'should call to other_verb with the passed method and return the response if method handled' do
+      mock_env = mock_env('/just_a_test')
+      mock_env['REQUEST_METHOD'] = 'TEAPOT'
+      @instance = TestClass.new(mock_env, ['/just_a_test'])
+      @instance.should_receive(:other_verb).with('TEAPOT').and_return('TEAPOT YEAH')
+      @instance.bite.last.should == ['TEAPOT YEAH']
+    end
+
+    it 'should call to other_verb with the passed method and return error if method not handled' do
+      mock_env = mock_env('/just_a_test')
+      mock_env['REQUEST_METHOD'] = 'TEAPOT'
+      @instance = TestClass.new(mock_env, ['/just_a_test'])
+      @instance.should_receive(:other_verb).with('TEAPOT')
+      @instance.bite.last.should == ['API route error']
+    end
+    
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'lunetas'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end
+
+def mock_candy
+  body = [200, {'Content-Type' => 'text/html'}, ["body"]]
+  luneta_object = mock(:Luneta, :bite => body)
+  [mock(:Luneta, :new => luneta_object), luneta_object]
+end
+
+def mock_env(path)
+  Rack::MockRequest.env_for(path)
+end
+
+class TestClass
+  include Lunetas::Candy
+  matches '/just_a_test'
+  def get
+    'Chunky Bacon'
+  end
+end
+
+class TestException < StandardError
+  def code
+    400
+  end
+  def message
+    'a'
+  end
+end
+
+

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification 
+name: lunetas
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 0
+  version: 0.0.0
+platform: ruby
+authors: 
+- "Iv\xC3\xA1n Vald\xC3\xA9s (@ivanvc)"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-21 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: shotgun
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: This is a micro framework based in Rack, inspired in Sinatra, camping and many others. The intention is to have fast responses for simple API calls. The base unit of this framework are the classes, which registers a regular expression that will match this resource.
+email: iv@nvald.es
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- VERSION
+- examples/config.ru
+- examples/testing.rb
+- lib/lunetas.rb
+- lib/lunetas/bag.rb
+- lib/lunetas/candy.rb
+- lib/lunetas/error.rb
+- spec/lunetas/bag_spec.rb
+- spec/lunetas/candy_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/ivanvc/lunetas
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rack micro framework intended for APIs
+test_files: 
+- spec/lunetas/bag_spec.rb
+- spec/lunetas/candy_spec.rb
+- spec/spec_helper.rb
+- examples/testing.rb