iwamot-rupta 0.9.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 IWAMOTO Takashi
+
+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.rdoc

@@ -0,0 +1,70 @@
+= README
+
+== Descrption
+
+Rupta is a router library for Web applications. The routes can be defined with {URI Template}[http://bitworking.org/projects/URI-Templates/]. The usage is so simple. See the following examples.
+
+== Installation
+
+  $ sudo gem install iwamot-rupta --source http://gems.github.com
+
+== Examples
+
+=== examples/fixtures/routes.yml
+
+  bookmark:
+    - http://example.com/bookmarks/{bookmark_id}
+    - http://example.com/bookmarks/{bookmark_id}.{format}
+  static_path:
+    - http://example.com/static_path
+  search:
+    - http://example.com/search
+
+=== examples/routing_with_yaml.rb
+
+  yaml_path = File.expand_path('fixtures/routes.yml', File.dirname(__FILE__))
+
+  require 'rupta/factory'
+  rupta = Rupta::Factory.new.create
+
+  # Rupta#detect returns the name of a detected route, a matched URI template and extracted URI parameters
+  p rupta.detect(yaml_path, 'http://example.com/bookmarks/123.atom')
+  # => ["user", "http://example.com/bookmarks/{bookmark_id}.{format}", {"bookmark_id"=>"123", "format"=>"atom"}]
+
+  # if the uri is static, the extracted parameters is empty
+  p rupta.detect(yaml_path, 'http://example.com/static_path')
+  # => ["static_path", "http://example.com/static_path", {}]
+
+  # query strings are omitted
+  p rupta.detect(yaml_path, 'http://example.com/search?q=foo')
+  # => ["search", "http://example.com/search", {}]
+
+  # when no route is found, Rupta#detect returns nil
+  p rupta.detect(yaml_path, 'http://example.com/not_found')
+  # => nil
+
+=== examples/routing_with_hash.rb
+
+  routes = {'bookmark'    => ['http://example.com/bookmarks/{bookmark_id}',
+                              'http://example.com/bookmarks/{bookmark_id}.{format}'],
+            'static_path' => ['http://example.com/static_path'],
+            'search'      => ['http://example.com/search']}
+
+  require 'rupta/factory'
+  rupta = Rupta::Factory.new.create
+
+  # use Rupta#detect_with_hash, if you can create the routes manually
+  p rupta.detect_with_hash(route, 'http://example.com/bookmarks/123.atom')
+  # => ["user", "http://example.com/bookmarks/{bookmark_id}.{format}", {"bookmark_id"=>"123", "format"=>"atom"}]
+
+== Requirement
+
+Rupta-0.9.0 was tested with Ruby 1.8.7 and 1.9.1.
+
+== Dependencies
+
+ * addressable-2.1.0
+
+== Copyright
+
+Copyright (c) 2009 IWAMOTO Takashi. See LICENSE for details.

data/lib/rupta.rb

@@ -0,0 +1,22 @@
+class Rupta
+  def initialize(uri_purifier, uri_extractor, yaml_loader)
+    @uri_purifier = uri_purifier
+    @uri_extractor = uri_extractor
+    @yaml_loader = yaml_loader
+  end
+
+  def detect_with_hash(routes, uri, omittable_uri_components = [:query])
+    pure_uri = @uri_purifier.purify(uri, omittable_uri_components)
+    routes.each do |route_name, uri_templates|
+      uri_template, uri_parameters = @uri_extractor.extract(uri_templates, pure_uri)
+      return [route_name, uri_template, uri_parameters] if uri_template
+    end
+    nil
+  end
+
+  def detect_with_file(yaml_path, uri, omittable_uri_components = [:query])
+    self.detect_with_hash(@yaml_loader.load_file(yaml_path), uri, omittable_uri_components)
+  end
+
+  alias :detect :detect_with_file
+end

data/lib/rupta/factory.rb

@@ -0,0 +1,17 @@
+require 'rupta'
+require 'rupta/uri_extract_processor/default'
+require 'rupta/uri_extractor'
+require 'rupta/uri_purifier'
+require 'rupta/yaml_loader'
+
+class Rupta
+  class Factory
+    def create(uri_extract_processor = Rupta::UriExtractProcessor::Default.new)
+      Rupta.new(
+        Rupta::UriPurifier.new,
+        Rupta::UriExtractor.new(uri_extract_processor),
+        Rupta::YamlLoader.new
+      )
+    end
+  end
+end

data/lib/rupta/uri_extract_processor/default.rb

@@ -0,0 +1,9 @@
+class Rupta
+  module UriExtractProcessor
+    class Default
+      def match(name)
+        '[^/.]*'
+      end
+    end
+  end
+end

data/lib/rupta/uri_extractor.rb

@@ -0,0 +1,18 @@
+require 'rubygems' if RUBY_VERSION < '1.9.0'
+require 'addressable/template'
+
+class Rupta
+  class UriExtractor
+    def initialize(uri_extract_processor)
+      @uri_extract_processor = uri_extract_processor
+    end
+
+    def extract(uri_templates, uri)
+      uri_templates.each do |uri_template|
+        uri_parameters = Addressable::Template.new(uri_template).extract(uri, @uri_extract_processor)
+        return [uri_template, uri_parameters] if uri_parameters
+      end
+      nil
+    end
+  end
+end

data/lib/rupta/uri_purifier.rb

@@ -0,0 +1,10 @@
+require 'rubygems' if RUBY_VERSION < '1.9.0'
+require 'addressable/uri'
+
+class Rupta
+  class UriPurifier
+    def purify(uri, omittable_uri_components)
+      Addressable::URI.parse(uri).omit(*omittable_uri_components)
+    end
+  end
+end

data/lib/rupta/yaml_loader.rb

@@ -0,0 +1,9 @@
+require 'yaml'
+
+class Rupta
+  class YamlLoader
+    def load_file(path)
+      YAML.load_file(path)
+    end
+  end
+end

data/spec/routing_with_hash_spec.rb

@@ -0,0 +1,49 @@
+begin
+  require 'rupta/factory'
+rescue LoadError
+  $LOAD_PATH << File.expand_path('../lib', File.dirname(__FILE__))
+  require 'rupta/factory'
+end
+
+describe "Rupta#detect_with_hash" do
+  before(:all) do
+    @routes = {'bookmark'    => ['http://example.com/bookmarks/{bookmark_id}',
+                                'http://example.com/bookmarks/{bookmark_id}.{format}.{lang}',
+                                'http://example.com/bookmarks/{bookmark_id}.{format}/',
+                                'http://example.com/bookmarks/{bookmark_id}.{format}'],
+               'static_path' => ['http://example.com/static_path'],
+               'search'      => ['http://example.com/search']}
+
+    @rupta = Rupta::Factory.new.create
+  end
+
+  it "should detect a correct route" do
+    route_name, uri_template, uri_parameters = @rupta.detect_with_hash(@routes, 'http://example.com/bookmarks/123.atom')
+    route_name.should == 'bookmark'
+    uri_template.should == 'http://example.com/bookmarks/{bookmark_id}.{format}'
+    uri_parameters.values_at('bookmark_id', 'format').should == ['123', 'atom']
+  end
+
+  describe "when passed a static URI" do
+    it "should return an empty hash as the URI parameters" do
+      route_name, uri_template, uri_parameters = @rupta.detect_with_hash(@routes, 'http://example.com/static_path')
+      uri_parameters.should be_empty
+    end
+  end
+
+  describe "when passed a URI which has query strings" do
+    it "should omit the query strings" do
+      route_name, uri_template, uri_parameters = @rupta.detect_with_hash(@routes, 'http://example.com/search?q=foo')
+      route_name.should == 'search'
+      uri_template.should == 'http://example.com/search'
+      uri_parameters.should be_empty
+    end
+  end
+
+  describe "when passed an invalid URI" do
+    it "should return nil" do
+      result = @rupta.detect_with_hash(@routes, 'http://example.com/not_found')
+      result.should be_nil
+    end
+  end
+end

data/spec/routing_with_yaml_spec.rb

@@ -0,0 +1,43 @@
+begin
+  require 'rupta/factory'
+rescue LoadError
+  $LOAD_PATH << File.expand_path('../lib', File.dirname(__FILE__))
+  require 'rupta/factory'
+end
+
+describe "Rupta#detect" do
+  before(:all) do
+    @yaml_path = File.expand_path('fixtures/routes.yml', File.dirname(__FILE__))
+    @rupta = Rupta::Factory.new.create
+  end
+
+  it "should detect a correct route" do
+    route_name, uri_template, uri_parameters = @rupta.detect(@yaml_path, 'http://example.com/bookmarks/123.atom')
+    route_name.should == 'bookmark'
+    uri_template.should == 'http://example.com/bookmarks/{bookmark_id}.{format}'
+    uri_parameters.values_at('bookmark_id', 'format').should == ['123', 'atom']
+  end
+
+  describe "when passed a static URI" do
+    it "should return an empty hash as the URI parameters" do
+      route_name, uri_template, uri_parameters = @rupta.detect(@yaml_path, 'http://example.com/static_path')
+      uri_parameters.should be_empty
+    end
+  end
+
+  describe "when passed a URI which has query strings" do
+    it "should omit the query strings" do
+      route_name, uri_template, uri_parameters = @rupta.detect(@yaml_path, 'http://example.com/search?q=foo')
+      route_name.should == 'search'
+      uri_template.should == 'http://example.com/search'
+      uri_parameters.should be_empty
+    end
+  end
+
+  describe "when passed an invalid URI" do
+    it "should return nil" do
+      result = @rupta.detect(@yaml_path, 'http://example.com/not_found')
+      result.should be_nil
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: iwamot-rupta
+version: !ruby/object:Gem::Version 
+  version: 0.9.0
+platform: ruby
+authors: 
+- IWAMOTO Takashi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-21 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: addressable
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+description: Rupta is a router library for Web applications. The routes can be defined with URI Template.
+email: hello@iwamot.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- lib/rupta.rb
+- lib/rupta/factory.rb
+- lib/rupta/uri_extract_processor/default.rb
+- lib/rupta/uri_extractor.rb
+- lib/rupta/uri_purifier.rb
+- lib/rupta/yaml_loader.rb
+has_rdoc: false
+homepage: http://github.com/iwamot/rupta
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: A template-based URI router
+test_files: 
+- spec/routing_with_yaml_spec.rb
+- spec/routing_with_hash_spec.rb