shogun 6.2.1 → 6.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f356274d7c54f0cb104827d4d660b60f92ae669b
-  data.tar.gz: ac7bd5cc1e1f0c199cfef9af934bfbb59775a5f8
+  metadata.gz: b911d9b9871b623aa87e07a5595d93c302e78757
+  data.tar.gz: c8f17acac6f2758f5a754573f2e8723eebabe841
 SHA512:
-  metadata.gz: 9af314d1c7e1a54da5bbe3f66c2479bb8aa1cc4c2f5d4e82286bdbe8c676a0c699526e9396bf4da80ba8ba7e14682797b2ebd700b3728a1c922caace42e9eab5
-  data.tar.gz: 7a18afdec16f5a52a8ae7af54fefb91318f8e64fa7aa5bfa3ecb491cf778e7b73f41252a6677da7c0db2bebec3b0b4cc8c215ffb9a4b95790a4922c1f0747ab9
+  metadata.gz: 4c06a16488a91d424fd701f3365677fe5026c71323be678161d8270839706378844dad7fe0318702dd86a10064a6ebbd3985509668779656fe125373f5c32045
+  data.tar.gz: 8c89b10d59e721c3cca403e5e48506212b9d034f4197c6b4ce6b74c6bddc6263c923947c60e5bb7649060bc9790a066b30be4a5af6b1d4236e6a8a7028aa51e6

data/lib/shogun/version.rb

@@ -1,3 +1,3 @@
 module Shogun
-  VERSION = "6.2.1"
+  VERSION = "6.2.2"
 end

data/scaffold/generate/resource.rb

@@ -0,0 +1,15 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    NAMESPACE = "{{resource}}"
+
+    require_relative "{{resource}}/create"
+    require_relative "{{resource}}/destroy"
+    require_relative "{{resource}}/endpoint"
+    require_relative "{{resource}}/list"
+    require_relative "{{resource}}/model"
+    require_relative "{{resource}}/null"
+    require_relative "{{resource}}/presenter"
+    require_relative "{{resource}}/show"
+    require_relative "{{resource}}/update"
+  end
+end

data/scaffold/generate/resource/create.rb

@@ -0,0 +1,10 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Create
+      require_relative "create/control"
+      require_relative "create/denormalizer"
+      require_relative "create/normalizer"
+      require_relative "create/validator"
+    end
+  end
+end

data/scaffold/generate/resource/create/authorizer.rb

@@ -0,0 +1,21 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Create
+      class Authorizer
+        include Shogun::Authorizer
+        include {{resource_module}}
+
+        def initialize(requester:, resource:)
+          if requester
+            @requester = requester.account
+          end
+          @resource = resource
+        end
+
+        def allowed?
+          @requester == @resource
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/create/control.rb

@@ -0,0 +1,27 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Create
+      class Control
+        include Shogun::Control
+        include {{resource_module}}
+
+        def initialize(payload:)
+          @normalizer = Normalizer.new(raw: payload.to_hash)
+          @validator = Validator.new(data: @normalizer)
+
+          if @validator.valid?
+            @model = Model.create(@normalizer.to_hash)
+
+            @presenter = Presenter.new(resource: @model)
+            @denormalizer = Denormalizer.new(object: @presenter)
+            @status = OK
+          else
+            @presenters = Shogun::Presenters.new(resources: @validator.invalids, cast: Errors::Presenter)
+            @denormalizer = Errors::Denormalizer.new(object: @presenters)
+            @status = UNPROCESSABLE_ENTITY
+          end
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/create/denormalizer.rb

@@ -0,0 +1,31 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Create
+      class Denormalizer
+        include Shogun::Denormalizer
+        include {{resource_module}}
+
+        MAPPING = {
+          "id" => "id",
+          "created_at" => "created_at",
+          "destroyed_at" => "destroyed_at",
+          "updated_at" => "updated_at",
+          "href" => "href"
+        }
+
+        def initialize(object:)
+          @object = object
+          @meta = object.meta
+          @links = object.links
+          @linked = object.linked
+        end
+
+        private def document
+          mapping.inject({}) do |hash, (field, name)|
+            hash.merge(field => @object.public_send(name))
+          end
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/create/normalizer.rb

@@ -0,0 +1,22 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Create
+      class Normalizer
+        include Shogun::Normalizer
+        include {{resource_module}}
+
+        ATTRIBUTES = %w|attribute|
+
+        def initialize(raw:)
+          if raw[namespace]
+            @attribute = raw[namespace]["attribute"]
+          end
+        end
+
+        def attribute
+          @attribute.strip if @attribute.is_a?(String)
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/create/validator.rb

@@ -0,0 +1,14 @@
+module {{namepsace_module}}
+  module {{resource_module}}
+    module Create
+      class Validator
+        include Shogun::Validator
+        include {{resource_module}}
+
+        def initialize(data:)
+          @verifiers = []
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/destroy.rb

@@ -0,0 +1,11 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Destroy
+      require_relative "destroy/control"
+      require_relative "destroy/authorizer"
+      require_relative "destroy/denormalizer"
+      require_relative "destroy/normalizer"
+      require_relative "destroy/validator"
+    end
+  end
+end

data/scaffold/generate/resource/destroy/authorizer.rb

@@ -0,0 +1,21 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Destroy
+      class Authorizer
+        include Shogun::Authorizer
+        include {{resource_module}}
+
+        def initialize(requester:, resource:)
+          if requester
+            @requester = requester.account
+          end
+          @resource = resource
+        end
+
+        def allowed?
+          @requester == @resource
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/destroy/control.rb

@@ -0,0 +1,37 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Destroy
+      class Control
+        include Shogun::Control
+        include {{resource_module}}
+
+        def initialize(payload:)
+          @normalizer = Normalizer.new(raw: payload.to_hash)
+          @validator = Validator.new(data: @normalizer)
+
+          if @validator.valid?
+            @session = Sessions::Model.find_by(id: @normalizer.session)
+            @model = Model.find_by(id: @normalizer.id)
+            @authorizer = Authorizer.new(requester: @session, resource: @model)
+
+            case
+            when @model && @authorizer.allowed?
+              @model.destroy
+              @presenter = Presenter.new(resource: @model, meta: @normalizer.as_meta)
+              @denormalizer = Denormalizer.new(object: @presenter)
+              @status = OK
+            when @model && @authorizer.denied?
+              @status = UNAUTHORIZED
+            else
+              @status = NOT_FOUND
+            end
+          else
+            @presenters = Shogun::Presenters.new(resources: @validator.invalids, cast: Errors::Presenter)
+            @denormalizer = Errors::Denormalizer.new(object: @presenters)
+            @status = UNPROCESSABLE_ENTITY
+          end
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/destroy/denormalizer.rb

@@ -0,0 +1,31 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Destroy
+      class Denormalizer
+        include Shogun::Denormalizer
+        include {{resource_module}}
+
+        MAPPING = {
+          "id" => "id",
+          "created_at" => "created_at",
+          "destroyed_at" => "destroyed_at",
+          "updated_at" => "updated_at",
+          "href" => "href"
+        }
+
+        def initialize(object:)
+          @object = object
+          @meta = object.meta
+          @links = object.links
+          @linked = object.linked
+        end
+
+        private def document
+          mapping.inject({}) do |hash, (field, name)|
+            hash.merge(field => @object.public_send(name))
+          end
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/destroy/normalizer.rb

@@ -0,0 +1,28 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Destroy
+      class Normalizer
+        include Shogun::Normalizer
+        include {{resource_module}}
+
+        METADATA = %w|id|
+
+        def initialize(raw:)
+          @id = raw["id"]
+
+          if raw["rack.authentication"] && raw["rack.authentication"]["sessions"]
+            @session = raw["rack.authentication"]["sessions"]["id"]
+          end
+        end
+
+        def id
+          @id
+        end
+
+        def session
+          @session
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/destroy/validator.rb

@@ -0,0 +1,20 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module Destroy
+      class Validator
+        include Shogun::Validator
+        include {{resource_module}}
+
+        ID_MATCH = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
+
+        def initialize(data:)
+          @verifiers = [
+            Shogun::Verifier::Presence.new(data: data.id, name: "id"),
+            Shogun::Verifier::Match.new(data: data.id, name: "id", comparison: ID_MATCH),
+            Shogun::Verifier::Presence.new(data: data.session, name: "session")
+          ]
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/endpoint.rb

@@ -0,0 +1,16 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    class Endpoint
+      include {{resource_module}}
+      include Shogun::Endpoint
+
+      def initialize(router:)
+        router.push route: route(verb: :get, control: List::Control)
+        router.push route: route(verb: :post, control: Create::Control)
+        router.push route: route(verb: :get, matcher: /(?<id>.+)/, control: Show::Control)
+        router.push route: route(verb: :patch, matcher: /(?<id>.+)/, control: Update::Control)
+        router.push route: route(verb: :delete, matcher: /(?<id>.+)/, control: Destroy::Control)
+      end
+    end
+  end
+end

data/scaffold/generate/resource/list.rb

@@ -0,0 +1,10 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module List
+      require_relative "list/control"
+      require_relative "list/denormalizer"
+      require_relative "list/normalizer"
+      require_relative "list/validator"
+    end
+  end
+end

data/scaffold/generate/resource/list/authorizer.rb

@@ -0,0 +1,21 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module List
+      class Authorizer
+        include Shogun::Authorizer
+        include {{resource_module}}
+
+        def initialize(requester:, resource:)
+          if requester
+            @requester = requester.account
+          end
+          @resource = resource
+        end
+
+        def allowed?
+          @requester == @resource
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/list/control.rb

@@ -0,0 +1,26 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module List
+      class Control
+        include Shogun::Control
+        include {{resource_module}}
+
+        def initialize(payload:)
+          @normalizer = Normalizer.new(raw: payload.to_hash)
+          @validator = Validator.new(data: @normalizer)
+
+          if @validator.valid?
+            @models = Model.limit(@normalizer.limit).where(@normalizer.filters).includes(@normalizer.includes)
+            @presenters = Shogun::Presenters.new(resources: @models, cast: Presenter, includes: @normalizer.includes, meta: @normalizer.as_meta)
+            @denormalizer = Denormalizer.new(object: @presenters, fields: @normalizer.fields)
+            @status = OK
+          else
+            @presenters = Shogun::Presenters.new(resources: @validator.invalids, cast: Errors::Presenter)
+            @denormalizer = Errors::Denormalizer.new(object: @presenters)
+            @status = UNPROCESSABLE_ENTITY
+          end
+        end
+      end
+    end
+  end
+end

data/scaffold/generate/resource/list/denormalizer.rb

@@ -0,0 +1,33 @@
+module {{namespace_module}}
+  module {{resource_module}}
+    module List
+      class Denormalizer
+        include Shogun::Denormalizer
+        include {{resource_module}}
+
+        MAPPING = {
+          "id" => "id",
+          "created_at" => "created_at",
+          "destroyed_at" => "destroyed_at",
+          "updated_at" => "updated_at",
+          "href" => "href",
+          LINKS_KEY => "links",
+          META_KEY => "meta",
+          LINKED_KEY => "linked"
+        }
+
+        private def document
+          @object.map do |object|
+            if @fields.one?
+              object.public_send(@fields.first)
+            else
+              @fields.inject({}) do |hash, field|
+                hash.merge(field => object.public_send(mapping[field]))
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end