yodatra 0.1.4 → 0.1.5

data/Gemfile

@@ -1,5 +1,11 @@
 source 'https://rubygems.org'
 
-gem 'sinatra-activerecord', :git => 'git://github.com/popox/sinatra-activerecord'
+group :test do
+  gem 'rake'
+  gem 'rspec', :require => false
+  gem 'simplecov', :require => false
+  gem 'coveralls', :require => false
+  gem 'mocha', :require => false
+end
 
 gemspec

data/README.md

@@ -0,0 +1,6 @@
+Yodatra [![Build Status](https://travis-ci.org/squareteam/yodatra.png?branch=master)](https://travis-ci.org/squareteam/yodatra) [![Coverage Status](https://coveralls.io/repos/squareteam/yodatra/badge.png)](https://coveralls.io/r/squareteam/yodatra)
+===
+
+Backend development you shall do. And yodatra you shall use.
+
+A minimalistic framework built on top of Sinatra it is.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |task|
+  task.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+  task.pattern    = 'spec/**/*_spec.rb'
+end
+
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+task :test_with_coveralls => [:spec, :features, 'coveralls:push']
+
+task :default => :spec

data/lib/yodatra/api_formatter.rb

@@ -13,7 +13,7 @@ module Yodatra
     def _call(env)
       status, headers, response = @app.call(env)
 
-      @block.yield status, headers, response unless @block.nil?
+      status, headers, response = @block.yield(status, headers, response) unless @block.nil?
 
       [status, headers, response]
     end

data/lib/yodatra/crypto.rb

@@ -0,0 +1,26 @@
+module Yodatra
+  class Crypto
+
+    class << self
+      # Computes the PBKDF2-SHA256 digest of a password using 10000 iterations and
+      # the given salt, and return a 32-byte output. If no salt is given, a random
+      # 8-byte salt is generated. The salt is also returned.
+      def generate_pbkdf(password, salt = nil)
+        new_salt = salt
+        iter = 1000
+
+        if salt.nil?
+          new_salt = SecureRandom.random_bytes(8)
+        end
+
+        digest = OpenSSL::Digest::SHA256.new
+        len = digest.digest_length
+        value = OpenSSL::PKCS5.pbkdf2_hmac(password, new_salt, iter, len, digest)
+
+        [new_salt, value]
+      end
+
+    end
+
+  end
+end

data/lib/yodatra/model_controller.rb

@@ -0,0 +1,100 @@
+module Yodatra
+  class ModelController < Sinatra::Base
+
+    before do
+      content_type 'application/json'
+    end
+
+    READ_ALL = :read_all
+    get "/*s" do
+      no_route if disabled? READ_ALL
+      model_name.constantize.all.to_json
+    end
+
+    READ_ONE = :read
+    get "/*s/:id" do
+      no_route if disabled? READ_ONE
+
+      @one = model_name.constantize.find params[:id]
+      @one.to_json
+    end
+
+    CREATE_ONE = :create
+    post "/*s" do
+      no_route if disabled? CREATE_ONE
+
+      @one = model_name.constantize.new params
+
+      if @one.save
+        @one.to_json
+      else
+        status 400
+        @one.errors.full_messages.to_json
+      end
+    end
+
+    UPDATE_ONE = :update
+    put "/*s/:id" do
+      no_route if disabled? UPDATE_ONE
+
+      @one = model_name.constantize.find params[:id]
+
+      if !@one.nil? && @one.update_attributes(params)
+        @one.to_json
+      else
+        status 400
+        if !@one.nil?
+          @one.errors.full_messages.to_json
+        else
+          ['record not found'].to_json
+        end
+      end
+    end
+
+    DELETE_ONE = :delete
+    delete "/*s/:id" do
+      no_route if disabled? DELETE_ONE
+
+      @one = model_name.constantize.find params[:id]
+
+      if @one.destroy
+        @one.to_json
+      else
+        status 400
+        @one.errors.full_messages.to_json
+      end
+    end
+
+    private
+
+    def model_params
+      params
+    end
+
+    def model_name
+      self.class.name.split('::').last.gsub(/sController/, '')
+    end
+
+    def route_name
+      self.send(:model_name).underscore
+    end
+
+    def disabled? key
+      params[:splat].first != route_name || self.class.method_defined?(key) && self.send(key)
+    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
+    end
+
+  end
+end

data/lib/yodatra/version.rb

@@ -1,3 +1,3 @@
 module Yodatra
-  VERSION = '0.1.4'
+  VERSION = '0.1.5'
 end

data/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+ENV['RACK_ENV'] ||= 'test'
+require 'simplecov'
+SimpleCov.start
+require 'coveralls'
+Coveralls.wear!
+require 'rack/test'
+require 'rspec'
+
+require File.expand_path '../../lib/yodatra.rb', __FILE__
+require File.expand_path '../../lib/yodatra/model_controller.rb', __FILE__
+
+module RSpecMixin
+  include Rack::Test::Methods
+  def app
+    Sinatra.new {
+      use Yodatra::Base
+      use Yodatra::ModelController
+    }
+  end
+end
+
+RSpec.configure do |c|
+  c.include RSpecMixin
+end

data/spec/unit/model_controller_spec.rb

@@ -0,0 +1,148 @@
+require File.expand_path '../../spec_helper.rb', __FILE__
+require 'mocha/setup'
+require 'mocha/api'
+
+# Mock model constructed for the tests
+class TestModel
+  ALL = %w(a b c)
+  class << self
+    def all; ALL.map{ |e| TestModel.new({:data=> e }) }; end
+    def find(id); TestModel.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
+
+describe 'Model controller' do
+  before do
+    @any_model = 'TestModel'
+    @errors = ['error']
+    Yodatra::ModelController.any_instance.stubs(:model_name).returns(@any_model)
+    Array.any_instance.stubs(:full_messages).returns(@errors)
+  end
+
+  describe 'Getting a collection of the Model' do
+    context 'default' do
+      it 'should have a GET all route' do
+        get '/test_models'
+
+        last_response.should be_ok
+        expect(last_response.body).to eq(TestModel::ALL.map{|e| {:data => e} }.to_json)
+      end
+    end
+    context 'forced GET all route disabled' do
+      before do
+        class Yodatra::ModelController
+          disable :read_all
+        end
+      end
+      it 'should fail with no route available' do
+        get '/test_models'
+
+        last_response.should_not be_ok
+      end
+    end
+  end
+  describe 'getting an specific Model instance' do
+    it 'should have a GET one route' do
+      get '/test_models/2'
+
+      last_response.should be_ok
+      expect(last_response.body).to eq({ :data => 'c'}.to_json)
+    end
+    context 'forced GET one route disabled' do
+      before do
+        class Yodatra::ModelController
+          disable :read
+        end
+      end
+      it 'should fail with no route available' do
+        get '/test_models/1'
+
+        last_response.should_not be_ok
+      end
+    end
+  end
+  describe 'creating a Model instance' do
+    context 'with correct model params' do
+      it 'adds creates an instance, saves it and succeed' do
+        expect{
+          post '/test_models', {:data => 'd'}
+        }.to change(TestModel::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
+        expect{
+          post '/test_models', {}
+        }.to change(TestModel::ALL, :length).by(0)
+
+        last_response.should_not be_ok
+        expect(last_response.body).to eq(@errors.to_json)
+      end
+    end
+    context 'when the creation route is disabled' do
+      before do
+        class Yodatra::ModelController
+          disable :create
+        end
+      end
+      it 'should fail with no route available' do
+        post '/test_models', {:data => 'd'}
+
+        last_response.should_not be_ok
+      end
+    end
+  end
+  describe 'deleting a Model instance' do
+    context 'targeting an existing instance' do
+      it 'deletes the instance and succeed' do
+        expect{
+          delete '/test_models/1'
+        }.to change(TestModel::ALL, :length).by(-1)
+
+        last_response.should be_ok
+      end
+    end
+    context 'targeting a not existing instance' do
+      it 'does not delete any instance and fails' do
+        expect{
+          delete '/test_models/6'
+        }.to change(TestModel::ALL, :length).by(0)
+
+        last_response.should_not be_ok
+      end
+    end
+    context 'when the deletion route is disabled' do
+      before do
+        class Yodatra::ModelController
+          disable :delete
+        end
+      end
+      it 'should fail with no route available' do
+        delete '/test_models/2'
+
+        last_response.should_not be_ok
+      end
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yodatra
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-02 00:00:00.000000000 Z
+date: 2014-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
@@ -124,19 +124,24 @@ email: paul+st@bonaud.fr
 executables: []
 extensions: []
 extra_rdoc_files:
-- README
+- README.md
 - LICENSE
 files:
 - Gemfile
 - LICENSE
-- README
+- README.md
+- Rakefile
 - lib/yodatra.rb
 - lib/yodatra/api_formatter.rb
 - lib/yodatra/base.rb
 - lib/yodatra/boot.rb
+- lib/yodatra/crypto.rb
 - lib/yodatra/initializers.rb
 - lib/yodatra/logger.rb
+- lib/yodatra/model_controller.rb
 - lib/yodatra/version.rb
+- spec/spec_helper.rb
+- spec/unit/model_controller_spec.rb
 - yodatra.gemspec
 homepage: http://squareteam.github.io/yodatra
 licenses:
@@ -170,4 +175,5 @@ rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Classy backend development with the speed of Sinatra and the power of ActiveRecord
-test_files: []
+test_files:
+- spec/unit/model_controller_spec.rb

data/README

@@ -1,6 +0,0 @@
-Yodatra
-===
-
-Backend development you shall do. And yodatra you shall use.
-
-A minimalistic framework built on top of Sinatra it is.