yodatra 0.1.8 → 0.2.0

data/lib/yodatra/base.rb

@@ -10,6 +10,7 @@ module Yodatra
   class Base < Sinatra::Base
     configure :development do
       register Sinatra::Reloader
+      also_reload File.expand_path './**/*.rb'
     end
 
     register Yodatra::Boot

data/lib/yodatra/models_controller.rb

@@ -1,74 +1,116 @@
 module Yodatra
+  # This is a generic model controller that expose a REST API for your models.
+  # The responses are encoded in JSON.
+  #
+  # Simply create your controller that inherits from this class, keeping the naming convention.
+  #
+  # For example, given a <b>User</b> model, creating a <b>class UsersController < Yodatra::ModelsController</b>, it will expose these routes:
+  # GET /users
+  #  => retrieves all users <i>(attributes exposed are limited by the <b>read_scope</b> method defined in the <b>UsersController</b>)</i>
+  #
+  # GET /users/:id
+  #  => retrieves a user <i>(attributes exposed are limited by the <b>read_scope</b> method defined in the <b>UsersController</b>)</i>
+  #
+  # POST /users
+  #  => creates a user <i>(attributes assignable are limited by the <b>user_params</b> method defined in the <b>UsersController</b>)</i>
+  #
+  # PUT /users/:id
+  #  => updates a user <i>(attributes assignable are limited by the <b>user_params</b> method defined in the <b>UsersController</b>)</i>
+  #
+  # DELETE /users/:id
+  #  => deletes a user
+  #
+  # If your model is referenced by another model, nested routes are also created for you. And you don't need to worry about the references/joins, they are done automaticly!
+  # For example, imagine a <b>Team</b> model that has many <b>User</b>s, the following routes will be exposed:
+  # GET /team/:team_id/users, GET /team/:team_id/users/:id, POST /team/:team_id/users, PUT /team/:team_id/users/:id and DESTROY /team/:team_id/users/:id
   class ModelsController < Sinatra::Base
 
     before do
       content_type 'application/json'
     end
 
+    # Generic route to target ONE resource
+    ONE_ROUTE =
+        %r{\A/([\w]+?)/([0-9]+)(?:/([\w]+?)/([0-9]+)){0,1}\Z}
+
+    # Generic route to target ALL resources
+    ALL_ROUTE =
+        %r{\A/([\w]+?)(?:/([0-9]+)/([\w]+?)){0,1}\Z}
+
     READ_ALL = :read_all
-    get "/*" do
-      pass unless involved?
-      no_route if disabled? READ_ALL
-      model_name.constantize.all.as_json(read_scope).to_json
+    get ALL_ROUTE do
+      retrieve_resources READ_ALL do |resource|
+        resource.all.as_json(read_scope).to_json
+      end
     end
 
     READ_ONE = :read
-    get "/*/:id" do
-      pass unless involved?
-      no_route if disabled? READ_ONE
-
-      @one = model_name.constantize.find params[:id]
-      @one.as_json(read_scope).to_json
+    get ONE_ROUTE do
+      retrieve_resources READ_ONE do |resource|
+        resource.as_json(read_scope).to_json
+      end
     end
 
     CREATE_ONE = :create
-    post "/*" do
-      pass unless involved?
-      no_route if disabled? CREATE_ONE
-
-      hash = self.send("#{model_name.underscore}_params".to_sym)
-      @one = model_name.constantize.new hash
+    post ALL_ROUTE do
+      retrieve_resources CREATE_ONE do |resource|
+        hash = self.send("#{model_name.underscore}_params".to_sym)
+        @one = resource.create hash
 
-      if @one.save
-        @one.as_json(read_scope).to_json
-      else
-        status 400
-        @one.errors.full_messages.to_json
+        if @one.save
+          @one.as_json(read_scope).to_json
+        else
+          status 400
+          @one.errors.full_messages.to_json
+        end
       end
     end
 
     UPDATE_ONE = :update
-    put "/*/:id" do
-      pass unless involved?
-      no_route if disabled? UPDATE_ONE
-
-      @one = model_name.constantize.find params[:id]
-
-      if !@one.nil? && @one.update_attributes(params)
-        @one.as_json(read_scope).to_json
-      else
-        status 400
-        if !@one.nil?
-          @one.errors.full_messages.to_json
+    put ONE_ROUTE do
+      retrieve_resources UPDATE_ONE do |resource|
+        hash = self.send("#{model_name.underscore}_params".to_sym)
+        if resource.update_attributes(hash)
+          resource.as_json(read_scope).to_json
         else
-          ['record not found'].to_json
+          status 400
+          resource.errors.full_messages.to_json
         end
       end
     end
 
     DELETE_ONE = :delete
-    delete "/*/:id" do
+    delete ONE_ROUTE do
+      retrieve_resources DELETE_ONE do |resource|
+        if resource.destroy
+          resource.as_json(read_scope).to_json
+        else
+          status 400
+          resource.errors.full_messages.to_json
+        end
+      end
+    end
+
+    # Defines a nested route or not and retrieves the correct resource (or resources)
+    # @param disables is the name to check if it was disabled
+    # @param &block to be yield with the retrieved resource
+    def retrieve_resources(disables)
       pass unless involved?
-      no_route if disabled? DELETE_ONE
+      no_route if disabled? disables
 
-      @one = model_name.constantize.find params[:id]
+      model = model_name.constantize
+      nested = nested_resources if nested?
 
-      if @one.destroy
-        @one.as_json(read_scope).to_json
+      if model.nil? || nested.nil? && nested?
+        raise ActiveRecord::RecordNotFound
       else
-        status 400
-        @one.errors.full_messages.to_json
+        model = nested if nested?
+        one_id = nested? ? params[:captures].fourth : params[:captures].second if params[:captures].length == 4
+        model = model.find one_id unless one_id.nil?
+        yield(model)
       end
+    rescue ActiveRecord::RecordNotFound
+      record_not_found
     end
 
     class << self
@@ -76,15 +118,51 @@ module Yodatra
         self.name.split('::').last.gsub(/sController/, '')
       end
 
-      def route_name
-        self.model_name.underscore
+      # This helper gives the ability to disable default root by specifying
+      # a list of routes to disable.
+      # @param *opts list of routes to disable (e.g. :create, :destroy)
+      def disable(*opts)
+        opts.each do |key|
+          method = "#{key}_disabled?".to_sym
+          undef_method method if method_defined? method
+          define_method method, Proc.new {|| true}
+        end
       end
     end
 
     private
 
+    def nested?
+      params[:captures].length >= 3 && params[:captures].first(3).none?(&:nil?)
+    end
+
+    def nested_resources
+      resources = nil
+      begin
+        parent_model = params[:captures].first.classify.constantize
+      rescue NameError
+        parent_model = nil
+      end
+
+      unless parent_model.nil?
+        parent = parent_model.find params[:captures].second
+        resources = parent.send(involved.to_sym) unless parent.reflections[involved.to_sym].nil?
+      end
+      resources
+    rescue ActiveRecord::RecordNotFound
+      nil
+    end
+
+    def involved
+      involved = params[:splat] && params[:splat].first
+      params[:captures].each_index { |i|
+        involved ||= params[:captures].last(i+1).first if !params[:captures].last(i+1).first.nil? && params[:captures].last(i+1).first.match(/[\d]+/).nil?
+      } unless params[:captures].nil?
+      involved
+    end
+
     def involved?
-      params[:splat].first == model_name.downcase
+      !involved.match(/#{model_name.underscore}[s]?/).nil?
     end
 
     # read_scope defaults to all attrs of the model
@@ -95,7 +173,7 @@ module Yodatra
     # create/update scope defaults to all data given in the POST/PUT
     def method_missing(name, *args)
       if name.to_s == "#{model_name.underscore}_params"
-        return params.reject{|k,v| %w(splat captures).include? k}
+        return params.reject{|k,v| %w(splat captures id updated_at created_at).include? k}
       end
     end
 
@@ -103,25 +181,18 @@ module Yodatra
       self.class.model_name
     end
 
-    def route_name
-      self.class.route_name
-    end
-
     def disabled? key
-      params[:splat].first != route_name || self.class.method_defined?(key) && self.send(key)
+      method = ((nested? ? 'nested_' : '')+"#{key}_disabled?").to_sym
+      self.class.method_defined?(method) && self.send(method)
     end
 
     def no_route
       pass
     end
 
-    class << self
-      def disable(*opts)
-        opts.each do |key|
-          undef_method(key) if method_defined? key
-          define_method(key, Proc.new {|| true})
-        end
-      end
+    def record_not_found
+      status 404
+      ['record not found'].to_json
     end
 
   end

data/lib/yodatra/throttling.rb

@@ -22,5 +22,5 @@ begin
     end
   end
 rescue LoadError
-  raise "Error: in order to use Yodatra's throttling middleware you will need Redis. Add 'redis' to your Gemfile or simply gem install 'redis'"
+  raise LoadError, "In order to use Yodatra's throttling middleware you will need Redis. Add 'redis' to your Gemfile or simply gem install 'redis'", __FILE__
 end

data/lib/yodatra/version.rb

@@ -1,3 +1,3 @@
 module Yodatra
-  VERSION = '0.1.8'
+  VERSION = '0.2.0'
 end

data/lib/yodatra.rb

@@ -1 +1,2 @@
-require 'yodatra/base'
+require 'yodatra/base'
+require 'yodatra/version'

data/spec/data/model.rb

@@ -0,0 +1,50 @@
+# Mock model constructed for the tests
+class Model
+  ALL = %w(a b c)
+  class << self
+    def all; ALL.map{ |e| Model.new({:data=> e }) }; end
+    def find(id)
+      if id.to_i < ALL.length
+        Model.new({:data => ALL[id.to_i]})
+      else
+        raise ActiveRecord::RecordNotFound
+      end
+    end
+    def create(param); me = self.new(param); me.save; me; end
+  end
+  def initialize(param); @data = param[:data]; self; end
+  def save
+    unless @data.nil? || @data.match(/[\d]+/)
+      ALL.push(@data) unless ALL.include?(@data)
+      true
+    else
+      false
+    end
+  end
+  def update_attributes params
+    if params[:data] != @data
+      unless params[:data].match(/[\d]+/)
+        ALL[ALL.index(@data)] = params[:data]
+        @data = params[:data]
+        true
+      else
+        false
+      end
+    end
+  end
+  def destroy
+    if ALL.include? @data
+      ALL.delete @data
+      true
+    else
+      false
+    end
+  end
+  def reflections
+    {:models => Hash.new}
+  end
+  def models
+    Model
+  end
+  def errors; []; end
+end

data/spec/unit/models_controller_spec.rb

@@ -1,31 +1,5 @@
 require File.expand_path '../../spec_helper.rb', __FILE__
-
-# Mock model constructed for the tests
-class Model
-  ALL = %w(a b c)
-  class << self
-    def all; ALL.map{ |e| Model.new({:data=> e }) }; end
-    def find(id); Model.new({:data => ALL[id.to_i]}); end
-  end
-  def initialize(param); @data = param[:data]; end
-  def save
-    if @data.is_a? String
-      ALL.push(@data)
-      true
-    else
-      false
-    end
-  end
-  def destroy
-    if ALL.include? @data
-      ALL.delete @data
-      true
-    else
-      false
-    end
-  end
-  def errors; []; end
-end
+require File.expand_path '../../data/model.rb', __FILE__
 
 describe 'Model controller' do
 
@@ -37,7 +11,15 @@ describe 'Model controller' do
   describe 'Getting a collection of the Model' do
     context 'default' do
       it 'should have a GET all route' do
-        get '/model'
+        get '/models'
+
+        last_response.should be_ok
+        expect(last_response.body).to eq(Model::ALL.map{|e| {:data => e} }.to_json)
+      end
+    end
+    context 'nested' do
+      it 'should have a GET all route' do
+        get '/models/1/models'
 
         last_response.should be_ok
         expect(last_response.body).to eq(Model::ALL.map{|e| {:data => e} }.to_json)
@@ -50,7 +32,7 @@ describe 'Model controller' do
         end
       end
       it 'should fail with no route available' do
-        get '/model'
+        get '/models'
 
         last_response.should_not be_ok
       end
@@ -58,7 +40,7 @@ describe 'Model controller' do
   end
   describe 'getting an specific Model instance' do
     it 'should have a GET one route' do
-      get '/model/2'
+      get '/models/2'
 
       last_response.should be_ok
       expect(last_response.body).to eq({ :data => 'c'}.to_json)
@@ -70,7 +52,7 @@ describe 'Model controller' do
         end
       end
       it 'should fail with no route available' do
-        get '/model/1'
+        get '/models/1'
 
         last_response.should_not be_ok
       end
@@ -78,18 +60,18 @@ describe 'Model controller' do
   end
   describe 'creating a Model instance' do
     context 'with correct model params' do
-      it 'adds creates an instance, saves it and succeed' do
+      it 'creates an instance, saves it and succeed' do
         expect{
-          post '/model', {:data => 'd'}
+          post '/models', {:data => 'd'}
         }.to change(Model::ALL, :length).by(1)
 
         last_response.should be_ok
       end
     end
     context 'with incorrect params' do
-      it 'doesn t create an instance and fails' do
+      it 'does not create an instance and fails' do
         expect{
-          post '/model', {}
+          post '/models', {}
         }.to change(Model::ALL, :length).by(0)
 
         last_response.should_not be_ok
@@ -103,26 +85,86 @@ describe 'Model controller' do
         end
       end
       it 'should fail with no route available' do
-        post '/model', {:data => 'd'}
+        post '/models', {:data => 'd'}
 
         last_response.should_not be_ok
       end
     end
   end
+  describe 'updating a Model instance' do
+    context 'that does not exist' do
+      it 'replies with an error' do
+        expect{
+          put '/models/21', {:data => 'e'}
+        }.to change(Model::ALL, :length).by(0)
+
+        last_response.should_not be_ok
+        expect(last_response.body).to eq(['record not found'].to_json)
+      end
+    end
+    context 'that already exist' do
+      context 'with correct model params' do
+        it 'updates the model, saves it and succeed' do
+          expect{
+            put '/models/2', {:data => 'e'}
+          }.to change(Model::ALL, :length).by(0)
+
+          last_response.should be_ok
+          expect(last_response.body).to eq({ :data => 'e'}.to_json)
+          expect(Model.find(2).to_json).to eq({ :data => 'e'}.to_json)
+        end
+      end
+      context 'with incorrect params' do
+        it 'replies with an error message' do
+          expect{
+            put '/models/2', {:data => 321}
+          }.to change(Model::ALL, :length).by(0)
+
+          last_response.should_not be_ok
+          expect(last_response.body).to eq(@errors.to_json)
+        end
+      end
+      context 'when the updating route is disabled' do
+        before do
+          class Yodatra::ModelsController
+            disable :update
+          end
+        end
+        it 'should fail with no route available' do
+          put '/models', {:data => 'd'}
+
+          last_response.should_not be_ok
+        end
+      end
+    end
+  end
   describe 'deleting a Model instance' do
     context 'targeting an existing instance' do
       it 'deletes the instance and succeed' do
         expect{
-          delete '/model/1'
+          delete '/models/1'
         }.to change(Model::ALL, :length).by(-1)
 
         last_response.should be_ok
       end
     end
+    context 'targeting an existing instance but deletion fails' do
+      before do
+        allow_any_instance_of(Model).to receive(:destroy).and_return(false)
+      end
+      it 'should not delete the instance and fails' do
+        expect{
+          delete '/models/1/models/1'
+        }.to change(Model::ALL, :length).by(0)
+
+        last_response.should_not be_ok
+        expect(last_response.body).to eq(@errors.to_json)
+      end
+    end
     context 'targeting a not existing instance' do
       it 'does not delete any instance and fails' do
         expect{
-          delete '/model/6'
+          delete '/models/6'
         }.to change(Model::ALL, :length).by(0)
 
         last_response.should_not be_ok
@@ -135,11 +177,39 @@ describe 'Model controller' do
         end
       end
       it 'should fail with no route available' do
-        delete '/model/2'
+        delete '/models/2'
 
         last_response.should_not be_ok
       end
     end
   end
 
+  describe 'non existing models' do
+    context 'in nested routes' do
+      context 'with wrong route name' do
+        before do
+          class Yodatra::ModelsController
+            method = "read_all_disabled?".to_sym
+            undef_method method if method_defined? method
+          end
+        end
+        it 'fails with a record not found message' do
+           get '/modeels/1/models'
+
+           last_response.should_not be_ok
+           expect(last_response.body).to eq(['record not found'].to_json)
+        end
+      end
+      context 'with non existant parent model' do
+        it 'fails with a record not found message' do
+          get '/models/123/models'
+
+          last_response.should_not be_ok
+          expect(last_response.body).to eq(['record not found'].to_json)
+        end
+      end
+    end
+
+  end
+
 end

data/spec/unit/throttling_spec.rb

@@ -0,0 +1,22 @@
+require File.expand_path '../../spec_helper.rb', __FILE__
+
+describe 'Throttling middleware' do
+  context 'When redis gem is not installed' do
+    it 'raises an exception when required' do
+      expect{
+        require 'yodatra/throttling'
+      }.to raise_error LoadError, /gem install 'redis'/
+    end
+  end
+
+  #context 'When redis is installed' do
+  #  it 'does not raise an exception when required' do
+  #    allow_any_instance_of(Kernel).to receive(:require).and_call_original
+  #    allow_any_instance_of(Kernel).to receive(:require).with('redis').and_return(true)
+  #
+  #    expect{
+  #      require 'yodatra/throttling'
+  #    }.not_to raise_error
+  #  end
+  #end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yodatra
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-07 00:00:00.000000000 Z
+date: 2014-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -142,8 +142,10 @@ files:
 - lib/yodatra/throttling.rb
 - lib/yodatra/utils.rb
 - lib/yodatra/version.rb
+- spec/data/model.rb
 - spec/spec_helper.rb
 - spec/unit/models_controller_spec.rb
+- spec/unit/throttling_spec.rb
 - yodatra.gemspec
 homepage: http://squareteam.github.io/yodatra
 licenses:
@@ -179,3 +181,4 @@ specification_version: 3
 summary: Classy backend development with the speed of Sinatra and the power of ActiveRecord
 test_files:
 - spec/unit/models_controller_spec.rb
+- spec/unit/throttling_spec.rb