restfulness 0.1.0

data/spec/unit/response_spec.rb

@@ -0,0 +1,65 @@
+
+require 'spec_helper'
+
+describe Restfulness::Response do
+
+  class ResponseResource < Restfulness::Resource
+  end
+
+  let :klass do
+    Restfulness::Response
+  end
+  let :app do
+    Class.new(Restfulness::Application) do
+      routes do
+        add 'project', ResponseResource
+      end
+    end
+  end
+  let :request do
+    Restfulness::Request.new(app)
+  end
+  let :obj do
+    klass.new(request)
+  end
+
+  describe "#initialize" do
+    it "should assign request and headers" do
+      obj.request.should eql(request)
+      obj.headers.should eql({'Content-Type' => 'application/json; charset=utf-8'})
+      obj.code.should be_nil
+    end
+  end
+
+  describe "#run" do
+    context "without route" do
+      it "should not do anything" do
+        request.stub(:route).and_return(nil)
+        obj.run
+        obj.code.should eql(404)
+        obj.payload.should be_empty
+        obj.headers['Content-Length'].should eql(0.to_s)
+      end
+    end
+    context "with route" do
+      let :route do
+        app.router.routes.first
+      end
+
+      it "should try to build resource and run it" do
+        request.stub(:route).and_return(route)
+        request.action = :get
+        resource = double(:Resource)
+        resource.should_receive(:check_callbacks)
+        resource.should_receive(:call).and_return({:foo => 'bar'})
+        route.stub(:build_resource).and_return(resource)
+        obj.run 
+        obj.code.should eql(200)
+        str = "{\"foo\":\"bar\"}"
+        obj.payload.should eql(str)
+        obj.headers['Content-Length'].should eql(str.bytesize.to_s)
+      end      
+    end
+  end
+
+end

data/spec/unit/route_spec.rb

@@ -0,0 +1,160 @@
+
+require 'spec_helper'
+
+describe Restfulness::Route do
+
+  class ATestResource < Restfulness::Resource
+  end
+
+  let :klass do
+    Restfulness::Route
+  end
+
+  let :resource do
+    ATestResource
+  end
+
+  describe "#initialize" do
+
+    it "should assign basic path and resource" do
+      obj = klass.new('project', resource)
+      obj.path.should eql(['project'])
+      obj.resource_name.should eql(resource.to_s)
+    end
+
+    it "should assign path with symbols" do
+      obj = klass.new('project', :project_id, 'states', resource)
+      obj.path.should eql(['project', :project_id, 'states']) 
+    end
+
+    it "should remove :id from end" do
+      obj = klass.new('project', :project_id, 'states', :id, resource)
+      obj.path.should eql(['project', :project_id, 'states'])
+    end
+
+    it "should handle numbers in path" do
+      obj = klass.new('project', 120, resource)
+      obj.path.should eql(['project', 120])
+    end
+
+    it "should accept classes as strings" do
+      expect {
+        obj = klass.new('project', resource.to_s)
+      }.to_not raise_error
+    end
+
+    it "should raise name error if resource does not exist" do
+      expect {
+        klass.new('project')
+      }.to raise_error(NameError)
+    end
+
+    it "should raise name error if no arguments" do
+      expect {
+        klass.new()
+      }.to raise_error(ArgumentError)
+    end
+
+  end
+
+  describe "#resource" do
+    it "should provide constant to class" do
+      obj = klass.new('project', resource)
+      obj.resource.should eql(resource)
+    end
+  end
+
+  describe "#build_path" do
+    it "should build a new path object including self" do
+      obj = klass.new('project', resource)
+      path = obj.build_path("/project/12345")
+      path.should be_a(Restfulness::Path)
+      path.route.should eql(obj)
+    end
+  end
+
+  describe "#handles?" do
+
+    context "simple path" do
+      let :obj do 
+        klass.new('project', resource)
+      end
+      it "should return true for match" do
+        obj.handles?(['project']).should be_true
+      end
+      it "should return true for match with id" do
+        obj.handles?(['project', '12345']).should be_true
+      end
+      it "should return false for different name" do
+        obj.handles?(['projects']).should be_false
+      end
+      it "should return false for matching start" do
+        obj.handles?(['project', '12345', 'status']).should be_false
+      end
+    end
+
+    context "catch all path" do
+      let :obj do 
+        klass.new(resource)
+      end
+      it "should matching empty path" do
+        obj.handles?([]).should be_true
+      end
+      it "should matching empty path with id" do
+        obj.handles?(['12345']).should be_true
+      end
+      it "shold not match extended URL" do
+        obj.handles?(['foobar', '12345']).should be_false
+      end
+    end
+
+    context "single variable path" do
+      let :obj do 
+        klass.new(:project_id, resource)
+      end
+      it "should matching anything" do
+        obj.handles?(['foobar']).should be_true
+      end
+      it "should matching anything, with id" do
+        obj.handles?(['foobar', '12345']).should be_true
+      end
+      it "shold not match extended URL" do
+        obj.handles?(['foobar', 'status', '12345']).should be_false
+      end
+    end
+
+    context "complex path" do
+      let :obj do 
+        klass.new('project', :project_id, 'status', resource)
+      end
+      it "should return true for match" do
+        obj.handles?(['project', '1234', 'status']).should be_true
+      end
+      it "should return true for match with id" do
+        obj.handles?(['project', '1234', 'status', '12345']).should be_true
+      end
+      it "should not match short path" do
+        obj.handles?(['project']).should be_false
+      end
+      it "should not match path with different name" do
+        obj.handles?(['project', '12345', 'statuses']).should be_false
+      end
+      it "should not match extended path" do
+        obj.handles?(['project', '12345', 'status', '1234', 'test']).should be_false
+      end
+
+    end
+    
+  end
+
+  describe "#build_resource" do
+
+    it "should request a new resource" do
+      obj = klass.new('project', resource)
+      resource.should_receive(:new).with({}, {}).and_return(nil)
+      obj.build_resource({}, {})
+    end
+
+  end
+
+end

data/spec/unit/router_spec.rb

@@ -0,0 +1,103 @@
+
+require 'spec_helper'
+
+describe Restfulness::Router do
+
+  class RouterResource < Restfulness::Resource
+  end
+
+  let :klass do
+    Restfulness::Router
+  end
+
+  let :resource do
+    RouterResource
+  end
+
+  describe "#initialize" do
+
+    it "should prepare routes" do
+      obj = klass.new
+      obj.routes.should eql([])
+    end
+
+    it "should prepare routes with instance eval block" do
+      block = lambda {}
+      obj = klass.new do
+        @foo = 'bar'
+      end
+      obj.instance_variable_get(:@foo).should eql('bar')
+    end
+
+  end
+
+  describe "#add" do
+    it "should add route to object" do
+      obj = klass.new
+      obj.add 'projects', resource
+      obj.routes.length.should eql(1)
+      route = obj.routes.first
+      route.should be_a(Restfulness::Route)
+      route.path.should eql(['projects'])
+    end
+  end
+
+  describe "#route_for" do
+    let :obj do
+      res = resource
+      klass.new do
+        add 'projects', res
+        add 'project', :project_id, 'status', res
+        add :page, res
+        add res
+      end
+    end
+
+    it "should determine the route for a simple path" do
+      route = obj.route_for("/projects")
+      route.should_not be_nil
+      route.path.should eql(['projects'])
+    end
+
+    it "should determine the route for a simple path with id" do
+      route = obj.route_for("/projects")
+      route.should_not be_nil
+      route.path.should eql(['projects'])
+    end
+
+    it "should determine the route for a simple path with id and end /" do
+      route = obj.route_for("/projects/12345/")
+      route.should_not be_nil
+      route.path.should eql(['projects'])
+    end
+
+    it "should determine the route for a simple path with end /" do
+      route = obj.route_for("/projects/")
+      route.should_not be_nil
+      route.path.should eql(['projects'])
+    end
+
+    it "should determine route for more complex path" do
+      route = obj.route_for("/project/1235/status/1234")
+      route.should_not be_nil
+      route.path.should eql(['project', :project_id, 'status'])
+    end
+
+    it "should return nil if not matched" do
+      route = obj.route_for("/projects/1235/statuses/")
+      route.should be_nil
+    end
+
+    it "should match empty path" do
+      route = obj.route_for("/")
+      route.path.should eql([])
+    end
+
+    it "should match path with single parameter" do
+      route = obj.route_for("/something")
+      route.path.should eql([:page])
+    end
+  end
+
+
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: restfulness
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sam Lown
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: mono_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple REST server that focuses on resources instead of routes.
+email:
+- me@samlown.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- example/Gemfile
+- example/README.md
+- example/app.rb
+- example/config.ru
+- lib/restfulness.rb
+- lib/restfulness/application.rb
+- lib/restfulness/dispatcher.rb
+- lib/restfulness/dispatchers/rack.rb
+- lib/restfulness/exceptions.rb
+- lib/restfulness/log_formatters/quiet_formatter.rb
+- lib/restfulness/log_formatters/verbose_formatter.rb
+- lib/restfulness/path.rb
+- lib/restfulness/request.rb
+- lib/restfulness/resource.rb
+- lib/restfulness/response.rb
+- lib/restfulness/route.rb
+- lib/restfulness/router.rb
+- lib/restfulness/statuses.rb
+- lib/restfulness/version.rb
+- restfulness.gemspec
+- spec/spec_helper.rb
+- spec/unit/application_spec.rb
+- spec/unit/dispatcher_spec.rb
+- spec/unit/dispatchers/rack_spec.rb
+- spec/unit/exceptions_spec.rb
+- spec/unit/path_spec.rb
+- spec/unit/request_spec.rb
+- spec/unit/resource_spec.rb
+- spec/unit/response_spec.rb
+- spec/unit/route_spec.rb
+- spec/unit/router_spec.rb
+homepage: https://github.com/samlown/restfulness
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Use to create a powerful, yet simple REST API in your application.
+test_files:
+- spec/spec_helper.rb
+- spec/unit/application_spec.rb
+- spec/unit/dispatcher_spec.rb
+- spec/unit/dispatchers/rack_spec.rb
+- spec/unit/exceptions_spec.rb
+- spec/unit/path_spec.rb
+- spec/unit/request_spec.rb
+- spec/unit/resource_spec.rb
+- spec/unit/response_spec.rb
+- spec/unit/route_spec.rb
+- spec/unit/router_spec.rb