croods 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa04a8d021dcb13f1a16fb7e8cbff426ff88212cc2961f7b6ab37c11dec6205a
+  data.tar.gz: 6eaf5e2422fc7673d79af1f371bfc3d84f667beabf7725be8bfb979f56f211b5
+SHA512:
+  metadata.gz: e3c2a7f41a1684b68d97fd5b5157a0827cc4921c187de659c328762220ac2f1fe47cbf450a9240e665b7ae908ea4814f7e625d563640d305e843369aa8e8f29e
+  data.tar.gz: 583726e9874be44c8817d082ec6286cadec710be19eac125ee3251f1aeaacc11e2268311fd36eeb936faad066273861984602bb7205ad6a5ed323af94127d3ab

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2020 Daniel Weinmann
+
+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,28 @@
+# Croods
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'croods'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install croods
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,19 @@
+# frozen_string_literal: true
+
+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    = 'Croods'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'

data/lib/croods.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'rack/cors'
+require 'committee'
+require 'devise'
+require 'devise_token_auth'
+require 'pundit'
+require 'schema_associations'
+require 'schema_auto_foreign_keys'
+require 'schema_validations'
+
+module Croods
+  cattr_accessor :namespaces, :json_schema, :multi_tenancy_by
+
+  class << self
+    def initialize_for(*namespaces, multi_tenancy_by: nil)
+      self.multi_tenancy_by = multi_tenancy_by
+      self.namespaces = namespaces.map(&:to_s).freeze
+      Middleware.insert!
+    end
+
+    def resources
+      namespaces.map do |namespace|
+        "#{namespace.camelcase(:upper)}::Resource".constantize
+      end
+    end
+
+    def multi_tenancy?
+      !multi_tenancy_by.nil?
+    end
+
+    def tenant_attribute
+      "#{Croods.multi_tenancy_by}_id".to_sym
+    end
+
+    def application_controller(&block)
+      return unless block
+
+      application_controller_blocks << block
+    end
+
+    def application_controller_blocks
+      @application_controller_blocks ||= []
+    end
+  end
+end
+
+require 'croods/railtie'
+require 'croods/model'
+require 'croods/attribute'
+require 'croods/controller'
+require 'croods/service'
+require 'croods/action'
+require 'croods/policy'
+require 'croods/resource'
+require 'croods/routes'
+require 'croods/middleware'
+require 'croods/api'

data/lib/croods/action.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Croods
+  class Action
+    attr_accessor :name, :public, :roles, :method, :on, :block, :service
+
+    def initialize(name, **options)
+      self.name = name.to_sym
+      self.public = options[:public]
+      self.roles = options[:roles]
+      self.method = options[:method]
+      self.on = options[:on]
+      self.block = options[:block]
+      self.service = options[:service]
+    end
+  end
+end

data/lib/croods/api.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Croods
+  module Api
+    class << self
+      def initial_schema
+        File.read(File.expand_path('api/initial_schema.json', __dir__))
+      end
+
+      def json_schema
+        schema = JSON.parse(initial_schema)
+
+        Croods.resources.each do |resource|
+          next unless resource.table_exists?
+
+          name = resource.resource_name
+          schema['definitions'][name] = resource.json_schema
+          schema['properties'][name] = resource.ref
+        end
+
+        schema.deep_stringify_keys!
+        Committee::Drivers::HyperSchema::Driver.new.parse(schema)
+      end
+    end
+  end
+end

data/lib/croods/api/initial_schema.json

@@ -0,0 +1,52 @@
+{
+  "$schema": "http://interagent.github.io/interagent-hyper-schema",
+  "type": [
+    "object"
+  ],
+  "definitions": {
+    "error": {
+      "$schema": "http://json-schema.org/draft-04/hyper-schema",
+      "stability": "prototype",
+      "strictProperties": true,
+      "type": [
+        "object"
+      ],
+      "definitions": {
+        "id": {
+          "readOnly": true,
+          "pattern": "^\\w+$",
+          "type": [
+            "string"
+          ]
+        },
+        "message": {
+          "readOnly": true,
+          "type": [
+            "string"
+          ]
+        },
+        "identity": {
+          "anyOf": [
+            {
+              "$ref": "#/definitions/error/definitions/id"
+            }
+          ]
+        }
+      },
+      "links": [],
+      "properties": {
+        "id": {
+          "$ref": "#/definitions/error/definitions/id"
+        },
+        "message": {
+          "$ref": "#/definitions/error/definitions/message"
+        }
+      }
+    }
+  },
+  "properties": {
+    "error": {
+      "$ref": "#/definitions/error"
+    }
+  }
+}

data/lib/croods/attribute.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Croods
+  class Attribute
+    attr_accessor :name, :type, :null, :default, :default_function
+
+    def initialize(name, type, null: nil, default: nil, default_function: nil)
+      self.name = name.to_s
+      self.type = type
+      self.null = null
+      self.default = default
+      self.default_function = default_function
+    end
+  end
+end

data/lib/croods/controller.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'controller/actions'
+require_relative 'controller/authentication'
+require_relative 'controller/authorization'
+require_relative 'controller/multi_tenancy'
+require_relative 'controller/resource'
+require_relative 'controller/model'
+require_relative 'controller/member'
+require_relative 'controller/collection'
+require_relative 'controller/not_found'
+require_relative 'controller/already_taken'
+require_relative 'controller/record_invalid'
+
+module Croods
+  class Controller < ActionController::API
+    include Authentication
+    include Authorization
+    include MultiTenancy
+    include Resource
+    include Model
+    include Member
+    include Collection
+    include NotFound
+    include AlreadyTaken
+    include RecordInvalid
+  end
+end

data/lib/croods/controller/actions.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Croods
+  class Controller < ActionController::API
+    module Actions
+      class << self
+        def index
+          lambda do
+            authorize model
+
+            json = execute_service(collection, params) do
+              collection
+            end
+
+            render json: json
+          end
+        end
+
+        def show
+          lambda do
+            authorize member
+
+            json = execute_service(member, params) do
+              member
+            end
+
+            render json: json
+          end
+        end
+
+        def create
+          lambda do
+            member = new_member
+
+            authorize member
+            json = execute_service(member, member_params) do
+              member.save!
+              member
+            end
+
+            render status: :created, json: json
+          end
+        end
+
+        def update
+          lambda do
+            authorize member
+
+            json = execute_service(member, member_params) do
+              member.update!(member_params)
+              member
+            end
+
+            render json: json
+          end
+        end
+
+        def destroy
+          lambda do
+            authorize member
+            json = execute_service(member, params) do
+              member.destroy!
+            end
+
+            render json: json
+          end
+        end
+      end
+    end
+  end
+end

data/lib/croods/controller/already_taken.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Croods
+  class Controller < ActionController::API
+    module AlreadyTaken
+      extend ActiveSupport::Concern
+
+      included do
+        rescue_from ActiveRecord::RecordNotUnique, with: :already_taken
+      end
+
+      protected
+
+      def already_taken(exception)
+        match = exception.message.match(/\((.+)\)=\(.+\) already exists/)
+        attribute = match && model.human_attribute_name(match[1])
+
+        message = attribute ? "#{attribute} already taken" : 'Already taken'
+
+        render status: :unprocessable_entity, json: {
+          id: 'already_taken',
+          message: message
+        }
+      end
+    end
+  end
+end

data/lib/croods/controller/authentication.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Croods
+  class Controller < ActionController::API
+    module Authentication
+      extend ActiveSupport::Concern
+
+      included do
+        before_action :authenticate_user!, unless: :devise_controller?
+      end
+
+      protected
+
+      def user_params(model)
+        return {} unless resource.user_is_the_owner?
+        return {} unless model.has_attribute?(:user_id)
+
+        { user_id: current_user&.id }
+      end
+    end
+  end
+end

data/lib/croods/controller/authorization.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Croods
+  class Controller < ActionController::API
+    module Authorization
+      extend ActiveSupport::Concern
+      include Pundit
+
+      included do
+        after_action :verify_authorized, unless: :devise_controller?
+        after_action :verify_policy_scoped, unless: :devise_controller?
+        rescue_from Pundit::NotAuthorizedError, with: :forbidden
+      end
+
+      def policy_scope(scope)
+        @_pundit_policy_scoped = true
+        resource.policy_scope(action_name)
+          .new(tenant: header_tenant, user: current_user, scope: scope).resolve
+      end
+
+      protected
+
+      def forbidden(exception)
+        render status: :forbidden, json: {
+          id: 'forbidden',
+          message: exception.message
+        }
+      end
+    end
+  end
+end

data/lib/croods/controller/collection.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Croods
+  class Controller < ActionController::API
+    module Collection
+      protected
+
+      def collection
+        resource
+          .apply_filters(policy_scope(model), params)
+          .order(resource.sort_by)
+      end
+    end
+  end
+end