croods 0.1.0

data/lib/croods/resource/controller.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module Controller
+      def extend_controller(&block)
+        return unless block
+
+        controller_blocks << block
+      end
+
+      def controller_blocks
+        @controller_blocks ||= []
+      end
+
+      def controller_name
+        "#{namespace}Controller"
+      end
+
+      def controller
+        controller_name.constantize
+      end
+
+      def create_controller!
+        Object.const_set(controller_name, Class.new(ApplicationController))
+
+        controller_blocks.each do |block|
+          controller.instance_eval(&block)
+        end
+
+        create_actions!
+        create_additional_actions!
+      end
+
+      def create_actions!
+        actions.each do |action|
+          controller.define_method(
+            action.name, Croods::Controller::Actions.send(action.name)
+          )
+        end
+      end
+
+      def create_additional_actions!
+        additional_actions.each do |action|
+          controller.define_method(action.name, &action.block)
+        end
+      end
+    end
+  end
+end

data/lib/croods/resource/filters.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module Filters
+      def filter_by(name, optional: nil)
+        filters << Croods::Attribute.new(
+          name, :string, null: optional
+        )
+      end
+
+      def filters
+        @filters ||= []
+      end
+
+      def apply_filters(scope, params)
+        filters.each do |attribute|
+          unless model.has_attribute?(attribute.name)
+            attribute.name = "#{attribute.name}_id"
+          end
+
+          value = params[attribute.name]
+          next unless value
+
+          scope = scope.where(attribute.name => value)
+        end
+
+        scope
+      end
+    end
+  end
+end

data/lib/croods/resource/identifier.rb

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

data/lib/croods/resource/json_schema.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative 'json_schema/definition'
+require_relative 'json_schema/definitions'
+require_relative 'json_schema/properties'
+require_relative 'json_schema/required'
+require_relative 'json_schema/links'
+
+module Croods
+  module Resource
+    module JsonSchema
+      def json_schema
+        return @json_schema if @json_schema
+
+        path = File.expand_path('json_schema/initial_schema.json', __dir__)
+        @json_schema = JSON.parse(File.read(path))
+        @json_schema['definitions'] = Definitions.schema(self)
+        @json_schema['properties'] = Properties.schema(self)
+        @json_schema['required'] = Required.schema(self)
+        @json_schema['links'] = Links.schema(self)
+        @json_schema
+      end
+
+      def ref(attribute = nil)
+        {
+          '$ref': "#/definitions/#{resource_name}" +
+            (attribute ? "/definitions/#{attribute}" : '')
+        }
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module JsonSchema
+      module Definition
+        TYPES = { datetime: 'string', text: 'string', json: 'object' }.freeze
+
+        class << self
+          def schema(attribute)
+            { type: types(attribute) }.merge(format(attribute))
+          end
+
+          def format(attribute)
+            return {} unless attribute.type == :datetime
+
+            { format: 'date-time' }
+          end
+
+          def types(attribute)
+            types = []
+            types << type(attribute.type)
+            types << 'null' if attribute.null
+            types
+          end
+
+          def type(type)
+            TYPES[type] || type.to_s
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module JsonSchema
+      module Definitions
+        TYPES = { datetime: 'string', text: 'string', json: 'object' }.freeze
+
+        class << self
+          def schema(resource)
+            attributes(resource).merge(identity: identity(resource))
+          end
+
+          def attributes(resource)
+            attributes = {}
+
+            resource.definitions.each_value do |attribute|
+              attributes[attribute.name] = Definition.schema(attribute)
+            end
+
+            attributes
+          end
+
+          def identity(resource)
+            resource.ref(resource.identifier)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/croods/resource/json_schema/initial_schema.json

@@ -0,0 +1,8 @@
+{
+  "$schema": "http://json-schema.org/draft-04/hyper-schema",
+  "stability": "prototype",
+  "type": [
+    "object"
+  ],
+  "additionalProperties": false
+}

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative 'links/collection'
+require_relative 'links/member'
+require_relative 'links/index'
+require_relative 'links/create'
+require_relative 'links/update'
+require_relative 'links/destroy'
+require_relative 'links/show'
+
+module Croods
+  module Resource
+    module JsonSchema
+      module Links
+        class << self
+          def schema(resource)
+            additional_actions(resource) + actions(resource)
+          end
+
+          def actions(resource)
+            resource.actions.map do |action|
+              action_module(action.name).link(resource)
+            end
+          end
+
+          def additional_actions(resource)
+            resource.additional_actions.map do |action|
+              action_module(action.on).link(resource, action)
+            end
+          end
+
+          def action_module(name)
+            "Croods::Resource::JsonSchema::Links::#{name.to_s.titleize}"
+              .constantize
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module JsonSchema
+      module Links
+        module Collection
+          class << self
+            def link(resource, action = nil)
+              href = resource.collection_path
+              href += "/#{action.name}" if action
+
+              {
+                href: href,
+                method: action&.method&.upcase || 'GET',
+                rel: 'instances',
+                schema: schema(resource),
+                targetSchema: target_schema(resource)
+              }
+            end
+
+            def filters(resource)
+              filters = {}
+
+              resource.filters.each do |attribute|
+                unless resource.model.has_attribute?(attribute.name)
+                  attribute.name = "#{attribute.name}_id"
+                end
+
+                filters[attribute.name] = definition(attribute)
+              end
+
+              filters
+            end
+
+            def definition(attribute)
+              definition = Definition.schema(attribute)
+
+              {
+                anyOf: [{ type: ['array'], items: definition }, definition]
+              }
+            end
+
+            def required(resource)
+              resource.filters.reject(&:null).map(&:name)
+            end
+
+            def schema(resource)
+              {
+                additionalProperties: false,
+                properties: filters(resource),
+                required: required(resource),
+                type: ['object']
+              }
+            end
+
+            def target_schema(resource)
+              {
+                anyOf: [
+                  { type: ['array'], items: resource.ref },
+                  { '$ref': '#/definitions/error' }
+                ]
+              }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module JsonSchema
+      module Links
+        module Create
+          class << self
+            def link(resource)
+              {
+                href: resource.collection_path,
+                method: 'POST',
+                rel: 'new',
+                schema: schema(resource),
+                targetSchema: target_schema(resource)
+              }
+            end
+
+            def schema(resource)
+              {
+                additionalProperties: false,
+                properties: Properties.schema(resource, request: true),
+                required: Required.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/links/destroy.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module JsonSchema
+      module Links
+        module Destroy
+          class << self
+            def link(resource)
+              {
+                href: resource.member_path,
+                method: 'DELETE',
+                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/index.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module JsonSchema
+      module Links
+        module Index
+          class << self
+            def link(resource)
+              Collection.link(resource)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Croods
+  module Resource
+    module JsonSchema
+      module Links
+        module Member
+          class << self
+            def link(resource, action)
+              {
+                href: "#{resource.member_path}/#{action.name}",
+                method: action.method.upcase,
+                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