restfulness 0.2.4 → 0.2.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cfa898034332002c6aca448027bc52cf29abfbd7
-  data.tar.gz: 17961f1c4475131c07321a775575b7c32f66360a
+  metadata.gz: 4f2ec8e38fd8c7293981c340ac6e925b976f4a99
+  data.tar.gz: e74639ca882ffea8494af1f6dc2e0a7c970b5957
 SHA512:
-  metadata.gz: 493a6d814a922764739e3698bea3a8bf16573bb207f940b0f240f7e70a27c50a9607cc2a3e5d7ad2053ddad95593109fd8370e591e07669cbbd0f6ec23d6185c
-  data.tar.gz: a62d90e70f22d2db78e0df083ecaf77c8fa769b6c2372874ad0b88b544cd963a95d8d5ac35d6d064f2aac6d6c56afcba6a7ce1969f20f27b493394c4723ae109
+  metadata.gz: bc120a4ca69100131aef149de8e0029611c2e1d5ed584a94a3adabbf50e598ab52463088884c6844e5008c375632cb64cb3df7a69afbf7f4b62a38cbe64bdf01
+  data.tar.gz: 19e0694cd4b9f4b609762c70abdd07c9d2df487b65bb4884ccf8097b3c3ae59423cc6a0b4e13f496a7109b84162caa618ba96fade17c5b07a9e26f70cca686ad

data/README.md

@@ -59,8 +59,10 @@ Restfulness takes a different approach. The following example attempts to show h
 class TwitterAPI < Restfullness::Application
   routes do
     add 'status',             StatusResource
-    add 'timeline', 'public', PublicTimelineResource
-    add 'timeline', 'home',   HomeTimelineResource
+    scope 'timeline' do
+      add 'public', Timelines::PublicResource
+      add 'home',   Timelines::HomeResource
+    end
   end
 end
 
@@ -70,19 +72,21 @@ class StatusResource < Restfulness::Resource
   end
 end
 
-class PublicTimelineResource < Restfulness::Resource
-  def get
-    Status.limit(20)
+module Timelines
+  class PublicResource < Restfulness::Resource
+    def get
+      Status.limit(20)
+    end
   end
-end
 
-# Authentication requires more cowbell, so assume the ApplicationResource is already defined
-class HomeTimelineResource < ApplicationResource
-  def authorized?
-    authenticate!
-  end
-  def get
-    current_user.statuses.limit(20)
+  # Authentication requires more cowbell, so assume the ApplicationResource is already defined
+  class HomeResource < ApplicationResource
+    def authorized?
+      authenticate!
+    end
+    def get
+      current_user.statuses.limit(20)
+    end
   end
 end
 
@@ -156,19 +160,31 @@ The aim of routes in Restfulness are to be stupid simple. These are the basic ru
  * Strings are matched directly.
  * Symbols match anything, and are accessible as path attributes.
  * Every route automically gets an :id parameter at the end, that may or may not have a null value.
+ * Scopes save repeating shared route array entries.
 
 Lets see a few examples:
 
 ```ruby
 routes do
-  # Simple route to access a project, access with:
-  #   * PUT /project
-  #   * GET /project/1234
-  add 'project',  ProjectResource
-
-  # Parameters are also supported.
-  # Access the project id using `request.path[:project_id]`
-  add 'project', :project_id, 'status', ProjectStatusResource
+  scope 'api' do
+    # Simple route to access a project, access with:
+    #   * PUT /api/project
+    #   * GET /api/project/1234
+    add 'project',  ProjectResource
+
+    # Parameters are also supported.
+    # Access the project id using `request.path[:project_id]`
+    add 'project', :project_id, 'status', ProjectStatusResource
+
+    # Scope's can be embedded
+    scope 'journeys' do
+      add 'active',     Journeys::ActiveResource
+      add 'terminated', Journeys::TerminatedResource
+    end
+    
+    # Add a general purpose list resource *after* scope
+    add 'journeys', Journeys::ListResource
+  end
 end
 ```
 
@@ -589,6 +605,10 @@ Restfulness is still a work in progress but at Cabify we are using it in product
 
 ## History
 
+### 0.2.5 - March 7, 2014
+
+ * Added support for scope in routes. (@samlown)
+
 ### 0.2.4 - February 7, 2014
 
  * Added I18n support with the help of the http_accept_language gem. (@samlown)

data/lib/restfulness/router.rb

@@ -3,15 +3,23 @@ module Restfulness
 
   class Router
 
-    attr_accessor :routes
+    attr_accessor :routes, :current_scope
 
     def initialize(&block)
       self.routes = []
+      self.current_scope = []
       instance_eval(&block) if block_given?
     end
 
     def add(*args)
-      routes << Route.new(*args)
+      routes << Route.new(*(current_scope + args))
+    end
+
+    def scope(*args, &block)
+      old_scope = current_scope
+      self.current_scope += args
+      instance_eval(&block) if block_given?
+      self.current_scope = old_scope
     end
 
     def route_for(path)

data/lib/restfulness/version.rb

@@ -1,3 +1,3 @@
 module Restfulness
-  VERSION = "0.2.4"
+  VERSION = "0.2.5"
 end

data/spec/unit/router_spec.rb

@@ -22,7 +22,6 @@ describe Restfulness::Router do
     end
 
     it "should prepare routes with instance eval block" do
-      block = lambda {}
       obj = klass.new do
         @foo = 'bar'
       end
@@ -42,6 +41,47 @@ describe Restfulness::Router do
     end
   end
 
+  describe "#scope" do
+    it "should append to the current_scope attribute in block and reset" do
+      obj = klass.new
+      subscope = nil # Can't use rspec inside instance eval!
+      obj.scope 'api' do
+        subscope = current_scope
+      end
+      subscope.should eql(['api'])
+      obj.current_scope.should eql([])
+    end 
+
+    it "should add scope properties to add call" do
+      obj = klass.new
+      res = resource
+      obj.scope 'api' do
+        add 'projects', res
+      end
+      route = obj.routes.first
+      route.path.should eql(['api', 'projects'])
+    end
+
+    it "should allow for scopes within scopes" do
+      obj = klass.new
+      res = resource
+      subscope = nil
+      subsubscope = nil
+      obj.scope 'api' do
+        scope 'projects' do
+          add 'active', res
+          subsubscope = current_scope
+        end
+        subscope = current_scope
+      end
+      subsubscope.should eql(['api', 'projects'])
+      subscope.should eql(['api'])
+      obj.current_scope.should eql([])
+      route = obj.routes.first
+      route.path.should eql(['api', 'projects', 'active'])
+    end
+  end
+
   describe "#route_for" do
     let :obj do
       res = resource

metadata

@@ -1,111 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: restfulness
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
 platform: ruby
 authors:
 - Sam Lown
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-07 00:00:00.000000000 Z
+date: 2014-03-06 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: http_accept_language
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.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.
@@ -115,8 +115,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -164,17 +164,17 @@ 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
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Use to create a powerful, yet simple REST API in your application.