croods 0.1.0

data/lib/croods/resource/json_schema/links/show.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module JsonSchema
+      module Links
+        module Show
+          class << self
+            def link(resource)
+              {
+                href: resource.member_path,
+                method: 'GET',
+                rel: 'self',
+                schema: schema,
+                targetSchema: target_schema(resource)
+              }
+            end
+
+            def schema
+              {
+                strictProperties: true,
+                properties: {},
+                type: ['object']
+              }
+            end
+
+            def target_schema(resource)
+              {
+                anyOf: [
+                  resource.ref,
+                  { '$ref': '#/definitions/error' }
+                ]
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/croods/resource/json_schema/links/update.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module JsonSchema
+      module Links
+        module Update
+          class << self
+            def link(resource)
+              {
+                href: resource.member_path,
+                method: 'PUT',
+                rel: 'self',
+                schema: schema(resource),
+                targetSchema: target_schema(resource)
+              }
+            end
+
+            def schema(resource)
+              {
+                additionalProperties: false,
+                properties: Properties.schema(resource, request: true),
+                type: ['object']
+              }
+            end
+
+            def target_schema(resource)
+              {
+                anyOf: [
+                  resource.ref,
+                  { '$ref': '#/definitions/error' }
+                ]
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/croods/resource/json_schema/properties.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module JsonSchema
+      module Properties
+        class << self
+          def schema(resource, request: false)
+            attributes = {}
+
+            properties = resource.response_attributes
+            properties = resource.request_attributes if request
+
+            properties.each_value do |attribute|
+              next if ignore?(request, attribute)
+
+              attributes[attribute.name] = resource.ref(attribute.name)
+            end
+
+            attributes
+          end
+
+          def ignore?(request, attribute)
+            return unless request
+
+            %w[id created_at updated_at].include?(attribute.name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/croods/resource/json_schema/required.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module JsonSchema
+      module Required
+        class << self
+          def schema(resource, request: false)
+            required = []
+
+            properties = resource.response_attributes
+            properties = resource.request_attributes if request
+
+            properties.each_value do |attribute|
+              next if ignore?(request, attribute)
+
+              required << attribute.name unless attribute.null
+            end
+
+            required
+          end
+
+          def ignore?(request, attribute)
+            return unless request
+
+            return true if attribute.default || attribute.default_function
+
+            %w[created_at updated_at].include?(attribute.name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/croods/resource/model.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module Model
+      def extend_model(&block)
+        return unless block
+
+        model_blocks << block
+      end
+
+      def model_blocks
+        @model_blocks ||= []
+      end
+
+      def model
+        model_name.constantize
+      end
+
+      def create_model!
+        Object.const_set(model_name, Class.new(Croods::Model))
+
+        model_blocks.each do |block|
+          model.instance_eval(&block)
+        end
+      end
+
+      def table_exists?
+        ActiveRecord::Base.connection.table_exists? route_name
+      rescue ActiveRecord::NoDatabaseError
+        false
+      end
+    end
+  end
+end

data/lib/croods/resource/names.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module Names
+      def namespace
+        to_s.split('::').first
+      end
+
+      def route_name
+        namespace.underscore
+      end
+
+      def model_name
+        namespace.singularize
+      end
+
+      def resource_name
+        model_name.underscore
+      end
+    end
+  end
+end

data/lib/croods/resource/paths.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module Paths
+      def collection_path
+        "/#{route_name}"
+      end
+
+      def member_path
+        "/#{route_name}/{(%23%2Fdefinitions" \
+          "%2F#{resource_name}%2Fdefinitions%2Fid)}"
+      end
+    end
+  end
+end

data/lib/croods/resource/policy.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module Policy
+      def extend_policy(&block)
+        return unless block
+
+        policy_blocks << block
+      end
+
+      def policy_blocks
+        @policy_blocks ||= []
+      end
+
+      def policy
+        policy_name.constantize
+      end
+
+      def policy_scope(action)
+        policy_scope_name(action).constantize
+      end
+
+      def policy_name
+        "#{model_name}Policy"
+      end
+
+      def policy_scope_name(action)
+        "#{model_name}#{action.to_s.titleize}Scope"
+      end
+
+      def create_policy!
+        Object.const_set(policy_name, Class.new(Croods::Policy))
+        policy_blocks.each { |block| policy.instance_eval(&block) }
+        create_policy_actions!
+      end
+
+      def create_policy_actions!
+        (actions + additional_actions).each do |action|
+          policy.define_method("#{action.name}?") { authorize_action(action) }
+
+          Object.const_set(
+            policy_scope_name(action.name), Class.new(Croods::Policy::Scope)
+          )
+
+          policy_scope(action.name).define_method(:action) { action }
+        end
+      end
+    end
+  end
+end

data/lib/croods/resource/services.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module Services
+      def use_service(service, on: nil)
+        name = on || service.to_s.split('::').last.downcase
+        actions.find { |action| action.name == name.to_sym }.service = service
+      end
+
+      def use_services(*services)
+        services.each do |service|
+          use_service(service)
+        end
+      end
+    end
+  end
+end

data/lib/croods/resource/sorting.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module Sorting
+      def sort_by(attribute = nil)
+        return @sort_by ||= :created_at unless attribute
+
+        @sort_by = attribute
+      end
+    end
+  end
+end

data/lib/croods/routes.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module ActionDispatch
+  module Routing
+    class Mapper
+      def mount_croods
+        create_application_controller!
+
+        Croods.resources.each do |resource|
+          resource.create_model!
+          resource.create_policy!
+          resource.create_controller!
+          create_resource_routes!(resource)
+        end
+
+        Croods.json_schema = Croods::Api.json_schema
+      end
+
+      def create_resource_routes!(resource)
+        resources(
+          resource.route_name,
+          param: resource.identifier,
+          only: resource.actions.map(&:name)
+        ) do
+          resource.additional_actions.each do |action|
+            public_send(action.method, action.name, on: action.on)
+          end
+        end
+      end
+
+      def create_application_controller!
+        Croods::Controller.instance_eval do
+          include DeviseTokenAuth::Concerns::SetUserByToken
+        end
+
+        Object.const_set(
+          'ApplicationController', Class.new(Croods::Controller)
+        )
+
+        Croods.application_controller_blocks.each do |block|
+          ApplicationController.instance_eval(&block)
+        end
+      end
+    end
+  end
+end

data/lib/croods/service.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Croods
+  class Service
+    attr_accessor :member_or_collection, :params, :current_user
+
+    def self.about(name = nil)
+      return @about unless name
+
+      @about = name
+      attr_accessor name
+    end
+
+    def self.execute(member_or_collection, params, current_user)
+      new(member_or_collection, params, current_user).execute
+    end
+
+    def initialize(member_or_collection, params, current_user)
+      if self.class.about
+        public_send("#{self.class.about}=", member_or_collection)
+      end
+
+      self.member_or_collection = member_or_collection
+      self.params = params
+      self.current_user = current_user
+    end
+  end
+end

data/lib/croods/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Croods
+  VERSION = '0.1.0'
+end

data/lib/tasks/croods_tasks.rake

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

metadata

@@ -0,0 +1,316 @@
+--- !ruby/object:Gem::Specification
+name: croods
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Weinmann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: committee
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: devise_token_auth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.3
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 5.2.4.2
+- !ruby/object:Gem::Dependency
+  name: schema_associations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.7
+- !ruby/object:Gem::Dependency
+  name: schema_auto_foreign_keys
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: schema_validations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  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'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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'
+- !ruby/object:Gem::Dependency
+  name: rack-cors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.1
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0.rc1
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.80.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.38.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.38.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.0
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+description: A framework for creating CRUDs in Rails APIs
+email:
+- danielweinmann@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/croods.rb
+- lib/croods/action.rb
+- lib/croods/api.rb
+- lib/croods/api/initial_schema.json
+- lib/croods/attribute.rb
+- lib/croods/controller.rb
+- lib/croods/controller/actions.rb
+- lib/croods/controller/already_taken.rb
+- lib/croods/controller/authentication.rb
+- lib/croods/controller/authorization.rb
+- lib/croods/controller/collection.rb
+- lib/croods/controller/member.rb
+- lib/croods/controller/model.rb
+- lib/croods/controller/multi_tenancy.rb
+- lib/croods/controller/not_found.rb
+- lib/croods/controller/record_invalid.rb
+- lib/croods/controller/resource.rb
+- lib/croods/middleware.rb
+- lib/croods/middleware/base.rb
+- lib/croods/middleware/request_validation.rb
+- lib/croods/middleware/response_validation.rb
+- lib/croods/model.rb
+- lib/croods/policy.rb
+- lib/croods/policy/scope.rb
+- lib/croods/railtie.rb
+- lib/croods/resource.rb
+- lib/croods/resource/actions.rb
+- lib/croods/resource/attributes.rb
+- lib/croods/resource/attributes/base.rb
+- lib/croods/resource/attributes/request.rb
+- lib/croods/resource/attributes/response.rb
+- lib/croods/resource/authentication.rb
+- lib/croods/resource/authorization.rb
+- lib/croods/resource/controller.rb
+- lib/croods/resource/filters.rb
+- lib/croods/resource/identifier.rb
+- lib/croods/resource/json_schema.rb
+- lib/croods/resource/json_schema/definition.rb
+- lib/croods/resource/json_schema/definitions.rb
+- lib/croods/resource/json_schema/initial_schema.json
+- lib/croods/resource/json_schema/links.rb
+- lib/croods/resource/json_schema/links/collection.rb
+- lib/croods/resource/json_schema/links/create.rb
+- lib/croods/resource/json_schema/links/destroy.rb
+- lib/croods/resource/json_schema/links/index.rb
+- lib/croods/resource/json_schema/links/member.rb
+- lib/croods/resource/json_schema/links/show.rb
+- lib/croods/resource/json_schema/links/update.rb
+- lib/croods/resource/json_schema/properties.rb
+- lib/croods/resource/json_schema/required.rb
+- lib/croods/resource/model.rb
+- lib/croods/resource/names.rb
+- lib/croods/resource/paths.rb
+- lib/croods/resource/policy.rb
+- lib/croods/resource/services.rb
+- lib/croods/resource/sorting.rb
+- lib/croods/routes.rb
+- lib/croods/service.rb
+- lib/croods/version.rb
+- lib/tasks/croods_tasks.rake
+homepage: https://github.com/SeasonedSoftware/croods-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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A framework for creating CRUDs in Rails APIs
+test_files: []