resta 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f0effda84f46ab1d5add8af1cfa6ae8da98fb7fe
+  data.tar.gz: 842e996cdaa19a4936b24cf91529527811d68978
+SHA512:
+  metadata.gz: 0fc5521456a57f1e1b326f2995b903c820845dd905fd8eb75087be70401f66b2e7a600a97dd93bdf34f1b6f29727aa02dbe3694449c0ea6f2223c74e20e3cf5a
+  data.tar.gz: a1ddce2f5f1b17a800fea38e0c16011b9fa922de84fe502b988178ab1b154687de41321bf57c956297afcfb84767f50ba09abd02482a7a368cb88072269ab069

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+db.sqlite3

data/.travis.yml

@@ -0,0 +1,23 @@
+---
+language: ruby
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+  - 2.3.0
+  - rbx-2
+  - jruby
+  - jruby-head
+  - ruby-head
+
+sudo: false
+before_install: gem install bundler -v 1.11.2
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  fast_finish: true
+branches:
+  only: master

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org' unless ENV['QUICK']
+gemspec
+
+gem 'sinatra', '~> 1.4', '>= 1.4.6'
+gem 'sinatra-contrib', '~> 1.4', '>= 1.4.6'
+
+gem 'sequel', '~> 4.29'
+gem 'activesupport', '~> 4.2', '>= 4.2.5'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Vincent Ting
+
+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,16 @@
+## Resta
+
+[![Build Status](https://secure.travis-ci.org/waiiio/resta.svg?branch=master)][travis]
+[![Coverage Status](https://coveralls.io/repos/waiiio/resta/badge.svg)][coverage]
+
+[travis]: https://travis-ci.org/waiiio/resta
+[coverage]: https://coveralls.io/r/waiiio/resta
+
+---
+
+> Resta is a [sinatra](http://www.sinatrarb.com/) based web server that turns your [sequel](http://sequel.jeremyevans.net/documentation.html) model directly into a RESTful API.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,24 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+end
+
+task default: :test
+
+begin
+  require 'cane/rake_task'
+
+  desc 'Run cane to check quality metrics'
+  Cane::RakeTask.new(:quality) do |cane|
+    cane.abc_max = 15
+    cane.add_threshold 'coverage/.last_run.json', :>=, 95
+    cane.style_measure = 82
+    cane.style_glob = 'lib/**/*.rb'
+  end
+
+  task default: :quality
+rescue LoadError
+  warn 'cane not available, quality task not provided.'
+end

data/lib/resta.rb

@@ -0,0 +1 @@
+require 'resta/resource'

data/lib/resta/model.rb

@@ -0,0 +1,157 @@
+require 'sequel'
+require 'securerandom'
+
+module Resta
+
+  # Mixins for subclass for `Sequel::Model`.
+  module Model
+
+    # Current class isn't inherited from Sequel::Model.
+    class UnsupportedClassError < TypeError
+    end
+
+    # Some necessary field missing for current database.
+    # e.g.`_$version` field used for caching
+    class NecessaryFieldMissingError < StandardError
+    end
+
+    # Class methods for model after been included.
+    module ClassMethods
+      attr_reader :use_increased_id, :timestamps_opts
+
+      def enable_increased_id
+        @use_increased_id = true
+      end
+
+      def use_timestamps(fields_opts=nil)
+        fields_opts ||= { update_on_create: true }
+        self.plugin :timestamps, fields_opts
+      end
+    end
+
+    # Instance methods for model after been included.
+    module InstanceMethods
+      def before_create
+        return false if super == false
+        update_version
+        # generate a v4 random UUID for resource id unless use auto increase.
+        self.id ||= SecureRandom.uuid unless self.class.use_increased_id
+      end
+
+      def before_update
+        return false if super == false
+        update_version
+      end
+
+      private
+      def update_version
+        self[:'_$version'] = SecureRandom.hex(8)
+      end
+    end
+
+    COMMON_DATABASE_FIELDS = {:'_$version' => :string}.freeze
+
+    def self.included(receiver)
+      raise UnsupportedClassError.new(
+        "#{receiver.class.name} is not a subclass of Sequel::Model"
+      ) unless receiver < Sequel::Model
+      necessary_fields_checker receiver
+      receiver.extend ClassMethods
+      receiver.send :include, InstanceMethods
+    end
+
+    def self.necessary_fields_checker(receiver)
+      COMMON_DATABASE_FIELDS.each_pair do |field, type|
+        raise NecessaryFieldMissingError.new(
+          "Missing field `#{field}`##{type} in #{receiver.table_name}"
+        ) unless(receiver.db_schema.has_key?(field) &&
+                 receiver.db_schema[field][:type] == type)
+      end
+    end
+
+    private_class_method :necessary_fields_checker
+  end
+
+  # Sequel migration helpers for resta.
+  module MigrationHelpers
+
+    DEFAULT_PRIMARY_COLUMN_OPTS = {
+      type: :string,
+      auto_increment: false,
+    }.freeze
+
+    # Helpers used in schema modification.
+    module AlterTable
+      def add_primary_column(name, opts=nil)
+        opts = (opts || {}).merge DEFAULT_PRIMARY_COLUMN_OPTS
+        add_primary_key name, opts
+      end
+
+      def add_timestamp_columns
+        [:created_at, :updated_at].each do
+          |f| add_column f, :datetime
+        end
+      end
+
+      def add_version_column
+        add_column :'_$version', :string
+      end
+    end
+
+    # Helpers for AlterTableGenerator
+    module Reverser
+
+      private
+
+      def add_primary_column(name, opts=nil)
+        opts = (opts || {}).merge DEFAULT_PRIMARY_COLUMN_OPTS
+        @actions << [:drop_column, name, opts]
+      end
+
+      def add_timestamp_columns
+        @actions << [:drop_column, :created_at]
+        @actions << [:drop_column, :updated_at]
+      end
+
+      def add_version_column
+        @actions << [:drop_column, :'_$version']
+      end
+    end
+
+    # Helpers used in create table
+    module CreateTable
+      def primary_column(name, opts=nil)
+        opts = (opts || {}).merge DEFAULT_PRIMARY_COLUMN_OPTS
+        primary_key name, :string, opts
+      end
+
+      def timestamp_columns
+        [:created_at, :updated_at].each do
+          |f| column f, :datetime
+        end
+      end
+
+      def version_column
+        column :'_$version', :string
+      end
+    end
+  end
+
+end
+
+module Sequel
+
+  class MigrationAlterTableReverser
+    include Resta::MigrationHelpers::Reverser
+  end
+
+  module Schema
+    class AlterTableGenerator
+      include Resta::MigrationHelpers::AlterTable
+    end
+
+    class CreateTableGenerator
+      include Resta::MigrationHelpers::CreateTable
+    end
+  end
+end

data/lib/resta/resource.rb

@@ -0,0 +1,45 @@
+require 'active_support/inflector'
+require 'singleton'
+require 'sinatra/base'
+require 'sinatra/multi_route'
+
+require_relative 'model'
+
+# Sinatra based web server.
+# Turns your sequel model directly into a RESTful API.
+module Resta
+
+  module_function
+  def get_model_pluralize_name(m)
+    m.name.split(':').last.underscore.pluralize.to_sym
+  end
+
+  # Global singleton hash object for storing resource builder object.
+  class RestaStore < Hash
+    include Singleton
+  end
+
+  # Resta resource object builder class
+  class ResourceBuilder
+
+    # Current support restful methods for resta.
+    ALLOWED_METODS = [:update, :create, :delete, :get, :query, :patch].freeze
+  end
+end
+
+module Sinatra
+
+  # Resta related helpers for sinatra
+  module RestaHelpers
+
+  end
+  helpers RestaHelpers
+
+  class << Application
+    def resource(model, opts = {}, &block)
+
+    end
+  end
+  Delegator.delegate(:resource)
+
+end

data/lib/resta/version.rb

@@ -0,0 +1,3 @@
+module Resta
+  VERSION = "0.1.0"
+end

data/resta.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'resta/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "resta"
+  spec.version       = Resta::VERSION
+  spec.authors       = ["Vincent Ting"]
+  spec.email         = ["homerdd at gmail.com"]
+
+  spec.description   = %q{Sinatra based web server that turns your sequel model directly into a RESTful API.}
+  spec.summary       = spec.description
+  spec.homepage      = "https://github.com/waiiio/resta"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+   if RUBY_PLATFORM == 'java'
+    spec.add_development_dependency "jdbc-sqlite3", "~> 3.8"
+   else
+    spec.add_development_dependency "sqlite3", "~> 1.3"
+    spec.add_development_dependency "cane", "~> 2.6"
+   end
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "simplecov", "~> 0.11.1"
+  spec.add_development_dependency "coveralls", "~> 0.8.2"
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: resta
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Vincent Ting
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: cane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+description: Sinatra based web server that turns your sequel model directly into a
+  RESTful API.
+email:
+- homerdd at gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/resta.rb
+- lib/resta/model.rb
+- lib/resta/resource.rb
+- lib/resta/version.rb
+- resta.gemspec
+homepage: https://github.com/waiiio/resta
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Sinatra based web server that turns your sequel model directly into a RESTful
+  API.
+test_files: []
+has_rdoc: