pg_rest 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 14805bcffd4e3ab056ba03d67cbbf95c5b55c8eef8151747128c642a9d6a6ec7
+  data.tar.gz: 3b6ae7e62b0c2219becdc4e0f9a5add180c705c063efefad2b017b477d6571f3
+SHA512:
+  metadata.gz: ac75e237f676378184bd70e9c0c91656c01a0a413fb338cb632d6238cbf9914e5962dc7994a5de797f10b3ea51dc83056609dfce548f0305814064cabc31a650
+  data.tar.gz: bc560603b0b5f5f51d600acff4c962cdc0ffa51059dc6f202926f41efacbe789322e8f7d31710f7e013414ed6fd93caeeaffe17baad8e161d20b1a51abdedc8b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Rami Bitar
+
+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,206 @@
+# PgRest
+PgRest is a REST API for managing Active Record database migrations. 
+
+Perform Active Record database migrations to manage database schema migrations.
+
+## Features
+PgRest supports the following database migrations using a REST API:
+ - Add table
+ - Drop table
+ - Add column
+ - Remove column
+
+PgRest operations are secured using an API token.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pg_rest'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Mount the PgRest API by updating your `config/routes.rb` file:
+
+```
+Rails.application.routes.draw do
+  ...
+  mount PgRest::Engine, at: "/pg-rest"
+  ...
+end 
+```
+
+You can also configure PgRest with an initializer by creating a file at `config/initializers/pg_rest.rb`.
+
+```
+# Place file at config/initializers/pg_rest.rb
+
+PgRest.tap |config|
+  config.api_token = ENV['PG_REST_API_TOKEN']
+end 
+```
+
+## Requirements
+
+PgRest requires Ruby on Rails and PostgreSQL, and below are recommended versions: 
+ - Rails 6+ 
+ - Ruby 2.7.4+
+ - Active Record supported database.
+
+## Documentation 
+
+PgRest is designed to remotely create common database migration tasks using a REST API.
+
+### Schema 
+
+Your database schema is available in order to inspect available tables and column data. 
+
+```
+GET /pg-rest
+```
+
+You can inspect any specific table using the schema endpoint:
+
+```
+GET /pg-rest/tables/<table_name>
+```
+
+### Create table
+
+Create a table migration.
+
+```
+POST /pg-rest/tables
+```
+
+Parameters
+
+| Parameter | Type | Description |
+| --- | --- |
+| name | string | The name of the database table. |
+
+
+### Drop table
+
+Drop a database table.
+
+```
+DELETE /pg-rest/tables/:table_name
+```
+
+Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| table_name | string | The name of the database table to drop.|
+
+### Add column
+
+Add a database column.
+
+```
+POST /pg-rest/tables/<table_name>/columns
+```
+
+Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| table_name | string | The name of the table.|
+| name | string | The column name. |
+| type | string | Active Record supported database field type.|
+| default | boolean | The default value. Defaults to `null`|
+| array | boolean  |The name of the database table.|
+| foreign_key | boolean | Column is a foreign_key. Defaults to `false`. |
+| primary_key | boolean | Column is a primary_key. Defaults to `false`. |
+
+
+### Remove column
+
+Remove a database column.
+
+```
+POST /pg-rest/tables/<table_name>/<column_name>
+```
+
+Parameters
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| table_name | string | The name of the table.|
+| column_name | string | The name of the column to remove.|
+
+
+## REST API client 
+
+PgRest also supports a ruby client for handling the API requests. 
+
+You can initialize the PgRest client using:
+
+```
+pg_client = PgRest::Api.new(api_key: <API_KEY>, api_url: <API_URL>)
+```
+
+### Database migrations using PgRest API client
+
+Create table:
+
+```
+pg_client.create_table(table_name: <TABLE_NAME>)
+```
+
+Drop table:
+
+```
+pg_client.drop_table(table_name: <TABLE_NAME>)
+```
+
+Add table column:
+
+```
+pg_client.add_column(
+  table_name: <TABLE_NAME>,
+  name: <COLUMN_NAME>,
+  type: <COLUMN_TYPE>,
+  default: <DEFAULT_VALUE>,
+  array: <IS_ARRAY>,
+  primary_key: <IS_PRIMARY_KEY>,
+  foreign_key: <IS_FOREIGN_KEY>,
+)
+```
+
+Remove table column:
+
+```
+pg_client.remove_column(
+  table_name: <TABLE_NAME>, 
+  name: <COLUMN_NAME>
+)
+```
+
+### API Token Authentication 
+
+The PgRest API is secured using an API token. 
+
+
+```
+# /config/initializers/pg_rest.rb
+
+PgRest.tap do |config|
+  config.api_token = ENV['PG_REST_API_TOKEN']  
+  ...
+end 
+```
+
+## Contributing
+Contributions are welcome by issuing a pull request at our github repository:
+https:/github.com/dash-api/pg-rest
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https:/opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
+load "rails/tasks/statistics.rake"
+
+require "bundler/gem_tasks"

data/app/assets/config/pg_rest_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/pg_rest.css

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

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/pg_rest/application_controller.rb

@@ -0,0 +1,30 @@
+module PgRest
+  class ApplicationController < ActionController::Base
+    
+    rescue_from Exception, with: :unprocessable_entity
+    rescue_from StandardError, with: :unprocessable_entity
+    rescue_from ActiveRecord::RecordNotFound, with: :unprocessable_entity
+    rescue_from ActiveRecord::ActiveRecordError, with: :unprocessable_entity
+  
+    def authenticate_request!       
+      auth_token === PgRest.api_token && !PgRest.api_token.blank?            
+    end 
+
+    private
+
+    def auth_token
+      http_token || params['token']      
+    end
+  
+    def http_token
+      if request.headers['Authorization'].present?
+        request.headers['Authorization'].split(' ').last
+      end
+    end
+  
+    def unprocessable_entity(e)
+      render json: { error: e }, status: :unprocessable_entity
+    end
+
+  end
+end

data/app/controllers/pg_rest/columns_controller.rb

@@ -0,0 +1,45 @@
+module PgRest
+  class ColumnsController < ApplicationController 
+
+    skip_before_action :verify_authenticity_token
+
+    before_action :authenticate_request!
+
+    def create   
+      result = PgService.add_column(
+        table_name: params[:table_id],
+        name: pg_params[:name],
+        type: pg_params[:type],
+        default: pg_params[:default],
+        array: pg_params[:array],
+        primary_key: pg_params[:primary_key],
+        foreign_key: pg_params[:foreign_key]
+      )
+      render json: { message: 'Column added.', data: result }
+    end 
+
+    def destroy  
+      result = PgService.remove_column(
+        table_name: params[:table_id],
+        name: params[:id]
+      )
+      render json: { message: 'Column removed.', data: result }
+    end 
+
+    private
+
+    def pg_params
+      params
+        .require(:column)
+        .permit(
+          :name,
+          :type,
+          :default,
+          :array,
+          :foreign_key,
+          :primary_key
+        )
+    end 
+
+  end 
+end 

data/app/controllers/pg_rest/tables_controller.rb

@@ -0,0 +1,38 @@
+module PgRest
+  class TablesController < ApplicationController 
+    
+    before_action :authenticate_request!
+    skip_before_action :verify_authenticity_token
+
+    def index 
+      schema = PgRest::Schema.pg_schema       
+      render json: { data: schema }
+    end 
+
+    def show 
+      table = PgRest::Schema.table_schema(params[:id])
+      render json: { data: table }
+    end 
+
+    def create  
+      PgService.create_table(table_name: pg_params[:name])
+      render json: { message: 'Table created.' }
+    end 
+
+    def destroy  
+      PgService.drop_table(table_name: params[:id])
+      render json: { message: 'Table dropped.' }
+    end 
+
+    private
+
+    def pg_params
+      params
+        .require(:table)
+        .permit(
+          :name
+        )
+    end 
+
+  end 
+end 

data/app/helpers/pg_rest/application_helper.rb

@@ -0,0 +1,4 @@
+module PgRest
+  module ApplicationHelper
+  end
+end

data/app/jobs/pg_rest/application_job.rb

@@ -0,0 +1,4 @@
+module PgRest
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/pg_rest/application_mailer.rb

@@ -0,0 +1,6 @@
+module PgRest
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/pg_rest/application_record.rb

@@ -0,0 +1,5 @@
+module PgRest
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/pg_rest/pg_table.rb

@@ -0,0 +1,17 @@
+module PgRest 
+  class PgTable < ApplicationRecord   
+    include PgSearch::Model 
+    
+    self.abstract_class = true    
+
+    def self.modelize(table_name) 
+      class_name = table_name.singularize.capitalize
+      if Object.const_defined? class_name
+        class_name.constantize
+      else 
+        Object.const_set class_name, Class.new(PgRest::PgTable)
+      end 
+    end 
+
+  end
+end

data/app/services/pg_rest/api.rb

@@ -0,0 +1,82 @@
+require 'rest-client'
+
+module PgRest 
+  class Api 
+
+    attr_accessor :api_url, :api_token
+
+    def initialize(api_url:, api_token: PgRest.api_token)
+      @api_url = api_url 
+      @api_token = api_token       
+    end 
+
+    def find_table(table_name:)      
+      url = "#{@api_url}/tables/#{table_name}"          
+      resp = RestClient.get(url, headers)      
+      result = handle_response(resp)
+    end 
+
+    def create_table(table_name:)      
+      url = "#{@api_url}/tables"    
+      params = {
+        name: table_name
+      }.to_json
+      resp = RestClient.post(url, params, headers)      
+      result = handle_response(resp)
+    end 
+
+    def drop_table(table_name:)      
+      url = "#{@api_url}/tables/#{table_name}"    
+      resp = RestClient.delete(url, headers)      
+      result = handle_response(resp)
+    end 
+
+    def add_column(
+        table_name:,
+        name:,
+        type:,
+        default: nil,
+        array: false,
+        primary_key: false,
+        foreign_key: false
+      )      
+      url = "#{@api_url}/tables/#{table_name}/columns"          
+      params = {
+        column: {
+          name: name, 
+          type: type,
+          default: default,
+          array: array,
+          primary_key: primary_key,
+          foreign_key: foreign_key
+        }
+      }.to_json
+      resp = RestClient.post(url, params, headers)      
+      result = handle_response(resp)
+    end 
+
+    def remove_column(table_name:,name:)
+      url = "#{@api_url}/tables/#{table_name}/columns/#{name}"    
+      resp = RestClient.delete(url, headers)      
+      result = handle_response(resp)
+    end
+
+    def schema 
+      url = "#{@api_url}/schema"    
+      resp = RestClient.get(url, headers)
+      result = handle_response(resp)        
+    end 
+
+    def headers 
+      {
+        "Content-Type": "application/json",
+        "Authorization": "Bearer #{@api_token}"
+      }
+    end 
+
+    def handle_response(resp)
+      JSON.parse(resp)
+    end
+
+  end
+end 

data/app/services/pg_rest/pg_service.rb

@@ -0,0 +1,51 @@
+module PgRest
+  class PgService
+
+    attr_accessor :uri
+
+    def initialize
+    end 
+
+    def self.create_table(table_name:)
+      self.with_transaction do  
+        ActiveRecord::Migration[6.0].create_table table_name.to_sym do |t|
+          t.timestamps
+        end
+      end 
+    end 
+
+    def self.drop_table(table_name:)
+      self.with_transaction do  
+        ActiveRecord::Migration[6.0].drop_table table_name.to_sym
+      end 
+    end 
+
+    def self.add_column(
+        table_name:, 
+        name:, 
+        type:, 
+        primary_key: false,
+        foreign_key: false, 
+        null: true, 
+        default: nil, 
+        array: false
+      )
+      self.with_transaction do  
+        ActiveRecord::Migration[6.0].add_column table_name.to_sym, name.to_sym, type.to_sym, null: null, default: default, array: array, foreign_key: foreign_key 
+      end
+    end 
+
+    def self.remove_column(table_name:, name:)
+      self.with_transaction do  
+        ActiveRecord::Migration[6.0].remove_column table_name.to_sym, name.to_sym
+      end 
+    end 
+
+    def self.with_transaction
+      ActiveRecord::Base.transaction do 
+        yield 
+      end        
+    end 
+
+  end 
+end 

data/app/services/pg_rest/schema.rb

@@ -0,0 +1,43 @@
+module PgRest
+  module Schema 
+
+    attr_accessor :tables 
+
+    def self.table_names
+      #ActiveRecord::Base.connection.query_cache.clear
+      @tables = ActiveRecord::Base.connection.tables
+    end 
+
+    def self.table_schema(table_name) 
+      @tables = table_names 
+      pg_table = PgRest::PgTable.modelize(table_name) 
+      pg_table.reset_column_information      
+      columns = []
+      pg_table.columns.each do |column|
+        columns << render_column(column) 
+      end 
+      columns
+    end 
+
+    def self.pg_schema 
+      @tables = table_names
+      schema = {
+        tables: @tables
+      }
+      @tables.each do |table_name|
+        schema[table_name] = table_schema(table_name)
+      end      
+      schema   
+    end 
+
+    def self.render_column(column)
+      {
+        name: column.name,
+        type: column.sql_type_metadata.type,
+        limit: column.sql_type_metadata.limit,
+        precision: column.sql_type_metadata.precision,
+      }
+    end 
+    
+  end 
+end 

data/app/views/layouts/dash_api/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>PgRest</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+  <%= stylesheet_link_tag "pg_rest/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,9 @@
+PgRest::Engine.routes.draw do
+
+  root 'tables#index'
+  
+  resources :tables do 
+    resources :columns, only: [:create, :destroy]
+  end 
+
+end

data/lib/pg_rest/engine.rb

@@ -0,0 +1,5 @@
+module PgRest
+  class Engine < ::Rails::Engine
+    isolate_namespace PgRest
+  end
+end

data/lib/pg_rest/version.rb

@@ -0,0 +1,3 @@
+module PgRest
+  VERSION = '0.0.2'
+end

data/lib/pg_rest.rb

@@ -0,0 +1,8 @@
+require "pg_rest/version"
+require "pg_rest/engine"
+
+module PgRest
+    
+  mattr_accessor :api_token
+
+end

data/lib/tasks/pg_rest_tasks.rake

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

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: pg_rest
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Rami Bitar
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: REST API for remote PostgreSQL database migrations.
+email:
+- rami@skillhire.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/pg_rest_manifest.js
+- app/assets/stylesheets/pg_rest/application.css
+- app/controllers/pg_rest/application_controller.rb
+- app/controllers/pg_rest/columns_controller.rb
+- app/controllers/pg_rest/tables_controller.rb
+- app/helpers/pg_rest/application_helper.rb
+- app/jobs/pg_rest/application_job.rb
+- app/mailers/pg_rest/application_mailer.rb
+- app/models/pg_rest/application_record.rb
+- app/models/pg_rest/pg_table.rb
+- app/services/pg_rest/api.rb
+- app/services/pg_rest/pg_service.rb
+- app/services/pg_rest/schema.rb
+- app/views/layouts/dash_api/application.html.erb
+- config/routes.rb
+- lib/pg_rest.rb
+- lib/pg_rest/engine.rb
+- lib/pg_rest/version.rb
+- lib/tasks/pg_rest_tasks.rake
+homepage: https://github.com/dash-api/pg-rest
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/dash-api/pg-rest
+  source_code_uri: https://github.com/dash-api/pg-rest
+  changelog_uri: https://github.com/dash-api/pg-rest
+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: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: REST API for PostgreSQL database migrations.
+test_files: []