sinatra-rest-json 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: daf0fd1316a9beb76a91a4e42900046b18e45694
+  data.tar.gz: 7f3cacb357a23e1de9e11ab13d0087d0de1ab0f1
+SHA512:
+  metadata.gz: d04e344828d494ab5bff1befcaec243594b5c58c30254932b5dfea154f109b8ede48d48a4343bcab467c54a5ef8764fd483b378b46d8647f825b64ca271c5321
+  data.tar.gz: 244e427c9b11c64ce3dde86f91f7271470ad267c95f8e252f96640a4b9b868556bb2872becdef088b1719c1e7a4e0fa8ce26a24d0e38a49419c6b667b359d2cb

data/.gitignore

@@ -0,0 +1 @@
+pkg

data/Gemfile

@@ -0,0 +1,13 @@
+# A sample Gemfile
+gemspec
+source "https://rubygems.org"
+
+
+gem "sinatra"
+gem "minitest"
+gem "json"
+
+group :test do
+  gem "minitest"
+  gem "rack-test"
+end

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2014 Joshua Carver
+
+MIT License
+
+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.md

@@ -0,0 +1,57 @@
+# Easy REST JSON APIs for Sinatra & Active Record
+
+
+Getting started
+
+## 1. Setup your Gemfile
+
+```ruby
+# Gemfile
+
+gem "sinatra"
+gem "sinatra-activerecord" # see https://github.com/janko-m/sinatra-activerecord
+gem "sinatra-rest-json"
+gem "json"
+
+```
+
+## 2. Setup your Sinatra App
+
+```ruby
+require 'sinatra'
+require 'sinatra/activerecord'
+require 'sinatra/rest_json'
+require 'json'
+
+
+set :database, {adapter: "sqlite3", database: "foo.sqlite3"}
+
+
+# Assume some models & database tables exit
+# Make sure to provide a to_json method on them
+class Product < ActiveRecord::Base
+ def to_json
+  { :name => name, :price => price }.to_json
+ end
+end
+
+
+# Set up your REST routes
+rest_json Product
+```
+## 3. Profit
+
+### Now your app automatically has the following routes which returns JSON data from your model:
+
+- **GET** /products (all)
+- **GET** /products/:id (find)
+
+- **POST** /products (create)
+- **PUT** /products/:id (update)
+
+- **DELETE** /people/:id (destroy)
+
+
+*Note for POST/PUT operations the data parameters should be like so: { product: { name: "foo", price: 1 }}
+
+

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/sinatra/rest-json.rb

@@ -0,0 +1,78 @@
+require 'sinatra/base'
+require 'json'
+
+module Sinatra
+  module REST
+    NOT_FOUND = { :errors => ["record doesn't exist"] }.to_json
+    MODEL_REGEX = /([A-Z0-9]{1}[a-z0-9]+)/
+
+    def rest_json(model_class, opts = {})
+      model_name = model_class.name.scan(MODEL_REGEX).join("_").downcase
+      route_name = model_class.table_name
+
+      # all
+      get "/#{route_name}" do
+        content_type :json
+        "["  + model_class.all.collect { |m| m.to_json }.join(",") + "]"
+      end
+
+      # find
+      get "/#{route_name}/:id" do
+        content_type :json
+        model = model_class.find(params[:id].to_i)
+
+        if model.nil?
+         NOT_FOUND 
+        else
+          model.to_json
+        end
+      end
+
+      # create
+      post "/#{route_name}" do
+        content_type :json
+
+        model = model_class.new(params[model_name])
+
+        if model.save
+          model.to_json
+        else
+          { :errors => model.errors }.to_json
+        end
+      end
+
+      # update
+      put "/#{route_name}/:id" do
+        content_type :json
+
+        model = model_class.find(params[:id].to_i)
+
+        if model.nil?
+          NOT_FOUND
+        else
+          if model.update_attributes(params[model_name])
+            model.to_json
+          else
+            { :errors => model.errors }.to_json
+          end
+        end
+      end
+
+      # delete
+      delete "/#{route_name}/:id" do
+        content_type :json
+
+        model = model_class.find(params[:id].to_i)
+
+        if model.nil?
+          NOT_FOUND
+        else
+          model.destroy.to_json
+        end
+      end
+    end
+
+  end
+
+  register REST
+end

data/lib/sinatra/rest_json.rb

@@ -0,0 +1,78 @@
+require 'sinatra/base'
+require 'json'
+
+module Sinatra
+  module REST
+    NOT_FOUND = { :errors => ["record doesn't exist"] }.to_json
+    MODEL_REGEX = /([A-Z0-9]{1}[a-z0-9]+)/
+
+    def rest_json(model_class, opts = {})
+      model_name = model_class.name.scan(MODEL_REGEX).join("_").downcase
+      route_name = model_class.table_name
+
+      # all
+      get "/#{route_name}" do
+        content_type :json
+        "["  + model_class.all.collect { |m| m.to_json }.join(",") + "]"
+      end
+
+      # find
+      get "/#{route_name}/:id" do
+        content_type :json
+        model = model_class.find(params[:id].to_i)
+
+        if model.nil?
+         NOT_FOUND 
+        else
+          model.to_json
+        end
+      end
+
+      # create
+      put "/#{route_name}" do
+        content_type :json
+
+        model = model_class.new(params[model_name])
+
+        if model.save
+          model.to_json
+        else
+          { :errors => model.errors }.to_json
+        end
+      end
+
+      # update
+      post "/#{route_name}/:id" do
+        content_type :json
+
+        model = model_class.find(params[:id].to_i)
+
+        if model.nil?
+          NOT_FOUND
+        else
+          if model.update_attributes(params[model_name])
+            model.to_json
+          else
+            { :errors => model.errors }.to_json
+          end
+        end
+      end
+
+      # delete
+      delete "/#{route_name}/:id" do
+        content_type :json
+
+        model = model_class.find(params[:id].to_i)
+
+        if model.nil?
+          NOT_FOUND
+        else
+          model.destroy.to_json
+        end
+      end
+    end
+
+  end
+
+  register REST
+end

data/sinatra-rest-json.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |s|
+  s.name        = 'sinatra-rest-json'
+  s.version     = '0.1'
+
+  s.date        = '2014-05-05'
+  s.summary     = "Easy rest routes for Sinatra Applciations"
+  s.description = ""
+  s.authors     = ["Joshua Carver"]
+  s.homepage    = 'http://rubygems.org/gems/sinatra-rest-json'
+  s.license       = 'MIT'
+
+
+  s.files         = `git ls-files -z`.split("\x0")
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|s|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "rake"
+end

data/test/helper.rb

@@ -0,0 +1,77 @@
+class FooModel
+
+  @@models = []
+  @@next_id = 1
+
+  attr_accessor :id, :name, :errors
+
+  class << self
+    def table_name
+      "foo_models"
+    end
+
+    def all
+      @@models
+    end
+
+    def destroy_all
+      @@models = []
+      @@next_id = 1
+    end
+
+    def find(id)
+      @@models.select { |m| m.id == id }.first
+    end
+
+    def create(params)
+      @@models << FooModel.new(@@next_id, params[:name])
+      @@next_id += 1
+      @@models[-1]
+    end
+  end
+
+  def initialize(*args)
+    if args.size == 0
+      @id = nil
+      @name = nil
+    elsif args.size == 2
+      @id = args[0].to_i
+      @name = args[1]
+    else args.size == 1
+      update_attributes(args[0])
+    end
+  end
+
+  def save
+    if @name.nil?
+      @errors = [
+        { :name => "cant be blank" }
+      ]
+
+      false
+    else 
+      @@models << self
+      self.id = @@next_id
+      @@next_id += 1
+
+      true
+    end
+  end
+
+  def update_attributes(hash)
+    unless hash.empty?
+      @id = hash['id'].to_i if hash.include?('id')
+      @name = hash['name'] if hash.include?('name')
+    end
+  end
+
+  def destroy
+    @@models.delete(self)
+    self
+  end
+
+  def to_json
+    { :id => @id, :name => @name }.to_json
+  end
+end
+

data/test/test_sinatra_rest_json.rb

@@ -0,0 +1,107 @@
+ENV['RACK_ENV'] = 'test'
+
+require 'rack/test'
+require "minitest/autorun"
+
+require 'sinatra/base'
+require 'sinatra/rest-json'
+require 'json'
+
+require File.join(File.dirname(__FILE__), "helper")
+
+class TestApp < Sinatra::Base
+  register Sinatra::REST
+  rest_json FooModel
+end
+
+
+describe "app" do 
+  include Rack::Test::Methods
+
+  def app
+    TestApp
+  end
+
+  before do
+    FooModel.destroy_all
+  end
+
+  describe "GET /" do
+    it "should be empty when no models" do
+      get "/foo_models"
+      assert_equal last_response.body, "[]"
+    end
+
+    it "should not be empty when models present" do
+      FooModel.create(:name => "foo1")
+
+      get "/foo_models"
+      assert_equal last_response.body, "[{\"id\":1,\"name\":\"foo1\"}]"
+    end
+  end
+
+
+  describe "GET /foo_models/:id" do
+    it "should give error when no models" do
+      get "/foo_models/1"
+      assert_equal last_response.body, "{\"errors\":[\"record doesn\'t exist\"]}"
+    end
+
+    it "should find model when it exists" do 
+      model = FooModel.create(:name => "foo1")
+      get "/foo_models/#{model.id}"
+      assert_equal last_response.body, "{\"id\":#{model.id},\"name\":\"foo1\"}" 
+    end
+  end
+
+  describe "POST /foo_models" do
+    it "should create a new model" do
+      assert_equal FooModel.all.size, 0 
+      post "/foo_models", { :foo_model => { :name => "foo1" } }
+      assert_equal last_response.body, "{\"id\":1,\"name\":\"foo1\"}"
+      assert_equal FooModel.all.size, 1
+    end
+
+    it "should send back errors when validation fails" do
+      post "/foo_models", { :foo_model => { :name => nil } }
+      assert_equal last_response.body, "{\"errors\":[{\"name\":\"cant be blank\"}]}"
+    end
+  end
+
+
+  describe "PUT /foo_models/:id" do
+    it "should give error when not found" do
+      put "/foo_models/1", { :name => "boo" }
+      assert_equal last_response.body, "{\"errors\":[\"record doesn\'t exist\"]}"
+    end
+
+    it "should update model when it exists" do
+      FooModel.create(:name => "foo1")
+      put "/foo_models/1", { :foo_model => { :name => "boo" } }
+      assert_equal last_response.body, "{\"id\":1,\"name\":\"boo\"}"
+    end
+  end
+
+
+  describe "DELETE /foo_models/:id" do
+    it "should give error when not found" do
+      delete "/foo_models/1"
+      assert_equal last_response.body, "{\"errors\":[\"record doesn\'t exist\"]}"
+    end
+
+    it "should respond with delted object" do 
+      FooModel.create(:name => "foo1")
+      delete "/foo_models/1"
+      assert_equal last_response.body, "{\"id\":1,\"name\":\"foo1\"}"
+    end
+
+    it "should actually delete model" do 
+      FooModel.create(:name => "foo1")
+      assert_equal FooModel.all.size, 1 
+
+      delete "/foo_models/1"
+      assert_equal FooModel.all.size, 0 
+    end
+  end
+
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-rest-json
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Joshua Carver
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+description: ''
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sinatra/rest-json.rb
+- lib/sinatra/rest_json.rb
+- sinatra-rest-json.gemspec
+- test/helper.rb
+- test/test_sinatra_rest_json.rb
+homepage: http://rubygems.org/gems/sinatra-rest-json
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Easy rest routes for Sinatra Applciations
+test_files:
+- test/helper.rb
+- test/test_sinatra_rest_json.rb