rest_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7fbfcc915cc6cd4b87ab45165c5ae83644327250414b2695ac6792afcb938903
+  data.tar.gz: 45955c0053d64c977ed9f4460681e2972503ca9c84ae739eb6b173553898a447
+SHA512:
+  metadata.gz: 21952e44ba928b34a0232bd4e49a6dd38e60adebbc9f8c590d4fa8e94f2eed6f92a0064d15d2112e65c9b542232d5ce7e9cda3736aaa4a12ea39817b6d61725b
+  data.tar.gz: 8d6968c5743e3002095fccef95bdaf48b53032320c3a2349b4bc1e8265b5c2095c1a911f4d855095da55d17609765ae65e4dc4485efdc4f01d17660f7c502c44

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Sergio Rivas
+
+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 @@
+# RestRails
+Rails Plugin for quick intelligent API Creation by Tuitu Technology Solutions
+
+## How To Use
+
+Add To Gemfile:  `gem 'rest_rails'`
+
+Then place in the bottom of Rails Routes:
+
+```
+mount RestRails::Engine => '/api/v1', as: 'rest'
+```
+## TODO
+
+- Add Documentation
+- Add Test Suite

data/Rakefile

@@ -0,0 +1,32 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'RestRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/assets/config/rest_rails_manifest.js

@@ -0,0 +1 @@
+// no need for js

data/app/assets/stylesheets/rest_rails/application.css

@@ -0,0 +1 @@
+/* no need for CSS*/

data/app/controllers/rest_rails/application_controller.rb

@@ -0,0 +1,36 @@
+module RestRails
+  class ApplicationController < ActionController::API
+    before_action :authenticate_user!, if: -> {self.respond_to?("authenticate_user!") && RestRails.authenticatable}
+    before_action :set_locale
+
+    rescue_from StandardError, with: :internal_server_error
+    rescue_from RestRails::Error, with: :internal_server_error
+    rescue_from ActiveRecord::RecordNotFound, with: :not_found
+
+    private
+
+    def not_found(exception)
+      if RestRails.debug
+        raise exception
+      else
+        render json: { error: exception.message }, status: :not_found
+      end
+    end
+
+    def internal_server_error(exception)
+      if RestRails.debug
+        raise exception
+      elsif Rails.env.development?
+        response = { type: exception.class.to_s, error: exception.message }
+      else
+        response = { error: "Internal Server Error" }
+      end
+      render json: response, status: :internal_server_error
+    end
+
+    def set_locale
+      I18n.locale = params[:locale] || session[:locale] || I18n.default_locale
+      session[:locale] = I18n.locale
+    end
+  end
+end

data/app/controllers/rest_rails/data_controller.rb

@@ -0,0 +1,180 @@
+require 'json'
+module RestRails
+  class DataController < RestRails::ApplicationController
+    include RestRails::ApplicationHelper
+    before_action :set_model, only: [:index, :show, :create, :update, :destroy, :fetch_column, :attach, :unattach]
+    before_action :set_object, only: [:show, :update, :destroy, :fetch_column, :attach, :unattach]
+
+    def index
+      p_hash = index_params.to_h
+
+      @objects = @model.all.in_groups_of(100) if p_hash.blank?
+      @objects = @model.where(p_hash).in_groups_of(100) if p_hash.present?
+
+      if params[:page].blank? || (params[:page].to_i < 1)
+        if @objects.empty?
+          render json: []
+        else
+          render json: @objects[0].reject{|x|x.nil?}.map{|x| standardize_json(x) }
+        end
+      else
+        i = params[:page].to_i - 1
+        render json: @objects[i].reject{|x|x.nil?}.map{|x| standardize_json(x) }
+      end
+    end
+
+    def show
+      render json: {code: 200}.merge(standardize_json(@object))
+    end
+
+    def create
+      @object = @model.new(model_params)
+
+      attach_files
+      if @object.save
+        render json: {code: 200, msg: "success", object: standardize_json(@object)}
+      else
+        render json: {code: 300, msg: "FAILED!"}
+      end
+    end
+
+    def update
+      attach_files
+      if @object.update(model_params)
+        render json: {code: 200, msg: "success", object: standardize_json(@object)}
+      else
+        render json: {code: 300, msg: "FAILED!"}
+      end
+    end
+
+    def destroy
+      if @object.destroy
+        render json: {code: 200, msg: "success"}
+      else
+        render json: {code: 300, msg: "FAILED!"}
+      end
+    end
+
+    def fetch_column
+      raise RestRails::Error.new "Column '#{params[:column]}' does not exist for #{params[:table_name]} table!" unless @model.attribute_names.include?(params[:column])
+
+      render json: {code: 200, value: @object.public_send(params[:column])}
+    end
+
+    def attach
+      # post   '/:table_name/:id/attach/:attachment_name' => 'data#attach'
+      raise RestRails::Error.new "No Attached file!" unless params[:attachment].is_a?(ActionDispatch::Http::UploadedFile)
+      raise RestRails::Error.new "Attachment '#{params[:attachment_name]}' does not exist for #{params[:table_name]} table!" unless attachments_for(@model.new).include?(params[:attachment_name].to_sym)
+
+      @object.public_send(params[:attachment_name].to_sym).attach(params[:attachment])
+      render json: {code: 200, msg: "attached!"}
+    end
+
+    def unattach
+      # delete '/:table_name/:id/unattach/:attachment_id' => 'data#unattach'
+      att = ActiveStorage::Attachment.find(params[:attachment_id])
+
+      raise RestRails::Error.new "Unauthorized! Attachment does not belong to object!" unless (@object.id == att.record_id) && (@object.is_a? att.record_type.constantize)
+
+      att.purge
+
+      render json: {code: 200, msg: "success"}
+    end
+
+    private
+
+    def set_model
+      # /api/v1/:table_name/...
+      # e.g. /api/v1/users  => User
+
+      # Take the tablename, and make the Model of the relative table_name
+      @model = model_for(params[:table_name])
+    end
+
+    def set_object
+      # Take model from "set_model"
+      @object = @model.find(params[:id])
+    end
+
+    def index_params
+      mn = @model.model_name.singular.to_sym
+      # {user: {name: "something", other_column_name: "somevalue"}}
+      return {} if params[mn].blank?
+      # MAKE LIST OF THINGS TO PERMIT:
+      arr = @model.attribute_names.map(&:to_sym)
+      arr.delete(:created_at)
+      arr.delete(:updated_at)
+
+      # allow arrays for all columns for flexible where queries
+      arr += arr.map do |attr|
+        {attr=>[]}
+      end
+      params.require(mn).permit(arr)
+    end
+
+    def attach_files
+      # BASED ON ACTIVE STORAGE
+      mn = @model.model_name.singular.to_sym # /users => user
+      #
+      file_set = attachments_for(@model.new)
+      file_set.each do |fs|
+        next if params[mn].blank? || params[mn][fs].blank?
+        attachment = params[mn][fs]
+
+        if attachment.is_a?(ActionDispatch::Http::UploadedFile)
+          @object.public_send(fs).attach(attachment)
+        elsif attachment.is_a?(Array) && attachment.first.is_a?(ActionDispatch::Http::UploadedFile)
+          @object.public_send(fs).attach(attachment)
+        elsif attachment.is_a?(Array)
+          params[mn][fs] = attachment.reject{|x| x.include?("/rails/active_storage/blobs")}
+        elsif attachment.is_a? String
+          params[mn][fs] = nil if attachment.include?("/rails/active_storage/blobs")
+        end
+      end
+    end
+
+    # ==========UNIVERSAL STRONG PARAMS SETUP=================
+    def model_params
+      mn = @model.model_name.singular.to_sym
+      # {user: {name: "something", other_column_name: "somevalue"}}
+      return {} if params[mn].blank? # to allow create for empty items
+
+      # params.require(:table_name).permit(:column_name1, :column_name2, etc., array_type: [], array_type2: [])
+      params.require(mn).permit(permitted_columns)
+    end
+
+    def permit_array?(attr)
+      permitable_classes = [ActiveStorage::Attached::Many, Array]
+      permitable_classes.include?(@model.new.send(attr).class)
+    end
+
+    def permitted_columns
+      @columns = @model.attribute_names.map(&:to_sym)
+      @columns.delete(:id)
+      @columns.delete(:created_at)
+      @columns.delete(:updated_at)
+
+      @columns.map! do |attr|
+        new_val = permit_array?(attr) ? {attr=>[]} : attr
+        new_val
+      end
+      permitted_attachments if RestRails.active_storage_attachments
+    end
+
+    def permitted_attachments
+      file_set = attachments_for(@model.new)
+      file_set += file_set.select{|x| permit_array?(x)}.map do |attr|
+        {attr=>[]}
+      end
+
+      @columns = @columns + file_set
+    end
+  end
+end
+
+
+
+
+
+
+

data/app/helpers/rest_rails/application_helper.rb

@@ -0,0 +1,59 @@
+module RestRails
+  module ApplicationHelper
+    def standardize_json(ar_object)
+      h = ar_object.serializable_hash
+      h.merge!(serial_attachments(ar_object)) if attachments_for(ar_object).present?
+      h
+    end
+
+    # ==========================================================================
+    #           SERIALIZE ATTACHMENTS FOR JSON
+    # ==========================================================================
+
+    def serial_attachments(ar_object)
+      h = {}
+      attachment_types = attachments_for(ar_object)
+      attachment_types.each do |att|
+        attached = self.public_send(att)
+        att_h    = {attachment_id: att.id, url: link_for_attached(attached)}
+        h[att]   = att_h
+      end
+      return h
+    end
+
+    def blob_link(x)
+      host = RestRails.domain
+      Rails.application.routes.url_helpers.rails_blob_url(x, host: host)
+    end
+
+    def link_for_attached(attached)
+      if attached.class == ActiveStorage::Attached::Many
+        return attached.map{|x| blob_link(x) }
+      elsif attached.class == ActiveStorage::Attached::One
+        x = attached.attachment
+        return blob_link(x) unless x.nil?
+      end
+    end
+
+    def attachments_for(ar_object)
+      meths = ar_object.class.methods.map(&:to_s)
+      attach_meths = meths.select{|x| x.include?("with_attached")}
+      attach_meths.map{|x| x[14..-1].to_sym}
+    end
+
+    # ==========================================================================
+    #                 OTHER HELPERS
+    # ==========================================================================
+
+    def model_for(table_name)
+      ignored = ["active_storage_blobs", "active_storage_attachments",
+        "schema_migrations", "ar_internal_metadata"]
+      tables = ActiveRecord::Base.connection.tables.reject{ |x| ignored.include?(x) }
+
+      raise  RestRails::Error.new "Table '#{table_name}' does not exist in your database!" unless tables.include?(table_name)
+
+      # Take the tablename, and make the Model of the relative table_name
+      table_name.classify.constantize # "users" => User
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,15 @@
+RestRails::Engine.routes.draw do
+  scope module: 'rest_rails' do
+    get    '/:table_name'            => 'data#index',        as: 'data_index'
+    post   '/:table_name'            => 'data#create'
+
+    get    '/:table_name/:id'        => 'data#show',         as: 'data_show'
+    patch  '/:table_name/:id'        => 'data#update'
+    delete '/:table_name/:id'        => 'data#destroy',      as: 'data_destroy'
+
+    post   '/:table_name/:id/attach/:attachment_name' => 'data#attach'
+    delete '/:table_name/:id/unattach/:attachment_id' => 'data#unattach'
+
+    get    '/:table_name/:id/:column' => 'data#fetch_column'
+  end
+end

data/lib/rest_rails/engine.rb

@@ -0,0 +1,12 @@
+module RestRails
+  class Engine < ::Rails::Engine
+    isolate_namespace RestRails
+
+    def self.mounted_path
+      route = Rails.application.routes.routes.detect do |route|
+        route.app == self
+      end
+      route && route.path
+    end
+  end
+end

data/lib/rest_rails/error.rb

@@ -0,0 +1,4 @@
+module RestRails
+  class Error < StandardError
+  end
+end

data/lib/rest_rails/version.rb

@@ -0,0 +1,3 @@
+module RestRails
+  VERSION = '0.1.0'
+end

data/lib/rest_rails.rb

@@ -0,0 +1,12 @@
+require "rest_rails/engine"
+
+module RestRails
+  mattr_accessor :debug, default: false
+  mattr_accessor :authenticatable, default: false
+  mattr_accessor :active_storage_attachments, default: true
+  mattr_accessor :domain, default: 'localhost:3000'
+
+  def self.configure
+    yield self
+  end
+end

data/lib/tasks/rest_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rest_rails do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: rest_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sergio Rivas
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.2
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.2.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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: Build a Full Rails REST API in 10 seconds
+email:
+- sergiorivas@aliyun.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/rest_rails_manifest.js
+- app/assets/stylesheets/rest_rails/application.css
+- app/controllers/rest_rails/application_controller.rb
+- app/controllers/rest_rails/data_controller.rb
+- app/helpers/rest_rails/application_helper.rb
+- config/routes.rb
+- lib/rest_rails.rb
+- lib/rest_rails/engine.rb
+- lib/rest_rails/error.rb
+- lib/rest_rails/version.rb
+- lib/tasks/rest_rails_tasks.rake
+homepage: http://rubygems.org/gems/rest_rails
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Simple, Mountable, rails REST API
+test_files: []