roda-endpoints 0.1.0

data/lib/roda/endpoints/endpoint.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require 'roda/endpoints'
+require 'roda/endpoints/endpoint/class_interface'
+require 'roda/endpoints/endpoint/namespace'
+require 'roda/endpoints/endpoint/operations'
+require 'roda/endpoints/endpoint/transactions'
+require 'roda/endpoints/endpoint/validations'
+require 'roda/endpoints/endpoint/verbs'
+require 'dry/monads'
+
+class Roda
+  module Endpoints
+    # Generic HTTP endpoint abstraction.
+    class Endpoint
+      extend ClassInterface
+      include Dry::Monads::Either::Mixin
+
+      autoload :Collection, 'roda/endpoints/endpoint/collection'
+      autoload :Item, 'roda/endpoints/endpoint/item'
+
+      self.attributes = %i(container type).freeze
+      self.defaults = EMPTY_HASH
+      self.statuses = {
+        get: { success: :ok, failure: :not_found },
+        put: { success: :accepted, failure: :unprocessable_entity },
+        post: { success: :created, failure: :unprocessable_entity },
+        patch: { success: :accepted, failure: :unprocessable_entity },
+        delete: { success: :no_content, failure: :unprocessable_entity }
+      }.freeze
+
+      self.verbs = EMPTY_SET
+
+      # @param attributes [{Symbol=>Object}]
+      def initialize(**attributes)
+        self.class.defaults.merge(attributes).each do |key, value|
+          # singleton_class.define_attribute(key) unless known_attribute?(key)
+          instance_variable_set(:"@#{key}", value)
+        end
+      end
+
+      prepend Namespace
+      prepend Verbs
+      prepend Validations
+      prepend Operations
+      include Transactions
+
+      # @return [Dry::Container::Mixin]
+      def container
+        @container || parent&.container
+      end
+
+      # @return [Symbol]
+      attr_reader :type
+
+      # @param [{Symbol=>Object}] attributes
+      # @param [:collection, :item] type
+      # @param [{Symbol=>Object}] attributes
+      def with(type: self.class, **attributes)
+        type.new to_hash.merge(attributes).merge(inheritable_attributes)
+      end
+
+      def inheritable_attributes
+        {
+          parent: self,
+          container: container
+        }
+      end
+
+      # @return [Proc]
+      def route
+        self.class.route
+      end
+
+      # @return [{Symbol=>Object}]
+      def to_hash
+        self.class.attributes.each_with_object({}) do |name, hash|
+          hash[name] = public_send(name)
+        end
+      end
+    end
+  end
+end

data/lib/roda/endpoints/functions.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'transproc'
+require 'roda/endpoints'
+
+class Roda
+  # Useful transformations.
+  module Functions
+    extend Transproc::Registry
+
+    import Transproc::HashTransformations
+
+    # Shortcut f
+    module Shortcut
+      # @param [Symbol] fn
+      # @param [Array] args
+      def f(fn, *args)
+        if args.any?
+          Functions[fn].call(*args)
+        else
+          Functions[fn]
+        end
+      end
+    end
+  end
+end

data/lib/roda/endpoints/repository.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'roda/endpoints'
+
+class Roda
+  module Endpoints
+    # Generic HTTP endpoint abstraction.
+    module Repository
+      # @param [<ROM::Struct>] _kwargs
+      def list(**_kwargs)
+        root.to_a
+      end
+
+      # @return [Time]
+      def last_modified
+        order(Sequel.desc(:updated_at)).first.updated_at
+      end
+
+      # @param [Integer] id
+      # @return [ROM::Struct]
+      def fetch(id)
+        root.fetch(id)
+      end
+    end
+  end
+end

data/lib/roda/endpoints/transactions.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'roda/endpoints'
+require 'dry-configurable'
+require 'dry-transaction'
+require 'forwardable'
+
+class Roda
+  module Endpoints
+    # The DSL for defining {Transactions transactions} used inside of
+    # The {Platform}.
+    class Transactions
+      extend Dry::Configurable
+      extend Forwardable
+
+      setting :container
+      setting :options, {}
+
+      def self.define
+        yield new
+      end
+
+      # @return [{Symbol=>Object}]
+      def self.options
+        { container: config.container }.merge(config.options)
+      end
+
+      # @param [Endpoint] endpoint
+      # @param [Hash] options
+      def initialize(endpoint:, **options)
+        @endpoint = endpoint
+        @container = endpoint.container
+        @options = self.class.options
+                       .merge(container: endpoint.container)
+                       .merge(options)
+      end
+
+      # @return [{Symbol=>Object}]
+      attr_reader :options
+
+      # @return [Endpoint]
+      attr_reader :endpoint
+
+      # @return [Dry::Container::Mixin]
+      attr_reader :container
+
+      def_delegators :endpoint, :operation_for, :validation_for
+
+      # @param [Symbol] shortcut
+      # @param [Proc] block
+      def define(shortcut, &block)
+        container.register(
+          key_for(shortcut),
+          Dry.Transaction(
+            container: container,
+            endpoint: endpoint,
+            &block
+          )
+        )
+      end
+
+      # @param [Symbol] verb
+      # @return [String]
+      def key_for(verb)
+        "transactions.#{endpoint.ns}.#{verb}"
+      end
+
+      # @param [Symbol] shortcut
+      def [](shortcut)
+        key = key_for(shortcut)
+        container[key]
+      end
+    end
+  end
+end

data/lib/roda/endpoints/types.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'roda/endpoints'
+require 'dry-types'
+
+class Roda
+  module Endpoints
+    # Generic HTTP endpoint abstraction.
+    module Types
+      include Dry::Types.module
+    end
+  end
+end

data/lib/roda/endpoints/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class Roda
+  module Endpoints
+    VERSION = '0.1.0'
+  end
+end

data/lib/roda/endpoints.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require 'roda/endpoints/version'
+require 'dry/core/constants'
+
+class Roda
+  # Endpoints abstractions
+  module Endpoints
+    include Dry::Core::Constants
+
+    autoload :Endpoint, 'roda/endpoints/endpoint'
+
+    VERBS = %i(get post delete patch put head).freeze
+
+    # @return [Dry::Container]
+    def self.container
+      @container ||= Dry::Container.new
+    end
+  end
+end
+
+require 'roda/plugins/endpoints'

data/lib/roda/plugins/endpoints.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+require 'roda'
+require 'roda/endpoints/endpoint/collection'
+require 'roda/endpoints/endpoint/item'
+require 'rom/struct/to_json'
+
+class Roda
+  # Module containing {Roda} plugins.
+  module RodaPlugins
+    # Endpoints plugin for {Roda}
+    module Endpoints
+      # @param [Class(Roda)] app
+      def self.load_dependencies(app)
+        app.plugin :all_verbs
+        app.plugin :head
+        app.plugin :caching
+        app.plugin :monads
+        app.plugin :symbol_status
+        app.plugin :symbol_matchers
+        app.plugin :slash_path_empty
+        app.plugin :json_parser
+        app.plugin :indifferent_params
+        app.plugin :json, classes: [Array, Hash, ROM::Struct]
+        return if app.respond_to?(:[])
+        require 'dry-container'
+        app.extend Dry::Container::Mixin
+        app.plugin :flow
+      end
+
+      # `Roda::RodaRequest` instant extensions.
+      module RequestMethods
+        # Implements collection endpoint using given args
+        #
+        # @param name [Symbol]
+        # @param item [{Symbol=>Object}]
+        # @param kwargs [{Symbol=>Object}]
+        # @param (see Endpoint::Collection#initialize)
+        # @see Endpoint::Collection.defaults
+        # @yieldparam endpoint [Collection]
+        # @yieldreturn [#to_json]
+        # @return [Endpoint]
+        #
+        # @example
+        #   r.collection :articles, item: { only: %i(get delete) }
+        #
+        #   # is equivalent to
+        #
+        #   r.on 'articles', item: { only: %i(get delete) } do
+        #     articles = Endpoint.new(
+        #       name: :articles,
+        #       container: container,
+        #     )
+        #
+        #     r.last_modified articles.last_modified
+        #
+        #     r.get do
+        #       articles.call(:get, r.params)
+        #     end
+        #
+        #     r.post do
+        #       articles.call(:post, r.params)
+        #     end
+        #
+        #     r.child :id, only: %i(get delete)
+        #   end
+        def collection(name, item: { by: :id }, path: name, **kwargs)
+          endpoint = Roda::Endpoints::Endpoint::Collection.new(
+            name: name,
+            container: roda_class,
+            item: item,
+            **kwargs
+          )
+          endpoints.push endpoint
+          on path.to_s do
+            # @route /:name
+            yield endpoint if block_given?
+            instance_exec(self, endpoint, &endpoint.route)
+          end
+          endpoints.pop #=> endpoint
+        end
+
+        # rubocop:enable Metrics/MethodLength, Metrics/AbcSize
+
+        # @param [Symbol] by
+        # @param [Endpoint::Collection] collection
+        # @param [Hash] kwargs
+        #
+        # @example
+        #   r.collection :articles do |articles|
+        #     r.child :id
+        #   end
+        #
+        #   # is equivalent to
+        #
+        #   r.collection :articles do |articles|
+        #     r.on :id do |id|
+        #
+        #       def article
+        #         @article ||= articles.repository.fetch(id)
+        #       end
+        #
+        #       r.get do
+        #         article
+        #       end
+        #     end
+        #   end
+        def child(by: :id, collection: endpoint, **kwargs)
+          # @route /{collection.name}/{id}
+          on by do |identifier|
+            item = collection.child(id: identifier, identifier: by, **kwargs)
+            endpoints.push item
+            yield item if block_given?
+            instance_exec(self, item, &item.route)
+            endpoints.pop
+          end
+        end
+
+        private
+
+        # @param [Symbol] verb
+        def match_transaction(verb)
+          resolve endpoint.transactions.key_for(verb) do |transaction|
+            transaction.call(params) do |m|
+              statuses = endpoint.class.statuses[verb]
+
+              m.success do |result|
+                response.status = statuses[:success]
+                result
+              end
+
+              m.failure do |result|
+                if result.is_a?(Array) && result.size == 2
+                  response.status, value = result
+                  value
+                else
+                  response.status = statuses[:failure]
+                  result
+                end
+              end
+            end
+          end
+        end
+
+        # @return [Endpoint]
+        def endpoint
+          endpoints.last
+        end
+
+        # @return [<Endpoint>]
+        def endpoints
+          @endpoints ||= [Roda::Endpoints::Endpoint.new(
+            name: :root, container: roda_class
+          )]
+        end
+      end
+    end
+
+    register_plugin :endpoints, Endpoints
+  end
+end

data/lib/rom/struct/to_json.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+require 'rom'
+require 'rom/struct'
+
+module ROM
+  # Simple data-struct
+  #
+  # By default mappers use this as the model
+  #
+  # @api public
+  class Struct
+    alias as_json to_hash
+
+    def to_json(*args)
+      as_json.to_json(*args)
+    end
+  end
+end

data/rakelib/bundle_audit.rake

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+require 'bundler/audit/task'
+
+Bundler::Audit::Task.new

data/rakelib/bundler.rake

@@ -0,0 +1,2 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'

data/rakelib/rspec.rake

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec do |t|
+  t.rspec_path = 'bin/rspec'
+end

data/rakelib/rubocop.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require 'rubocop/rake_task'
+require 'rubocop'
+
+RuboCop::RakeTask.new(:cop)

data/rakelib/yard.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+YARD::Rake::YardocTask.new :doc

data/roda-endpoints.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'roda/endpoints/version'
+
+# rubocop:disable Metrics/BlockLength
+Gem::Specification.new do |spec|
+  spec.name = 'roda-endpoints'
+  spec.version = Roda::Endpoints::VERSION
+  spec.authors = ['Alex Semyonov']
+  spec.email = ['alex@semyonov.us']
+
+  spec.summary = 'RESTful endpoints for Roda tree'
+  spec.description = 'Generic endpoints and specific implementations.'
+  spec.homepage = 'http://alsemyonov.gitlab.com/roda-endpoints/'
+  spec.license = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'dry-container'
+  spec.add_runtime_dependency 'dry-matcher'
+  spec.add_runtime_dependency 'dry-transaction'
+  spec.add_runtime_dependency 'dry-types'
+  spec.add_runtime_dependency 'dry-validation'
+  spec.add_runtime_dependency 'roda', '~> 2.21.0'
+  spec.add_runtime_dependency 'roda-flow', '~> 0.3.0'
+  spec.add_runtime_dependency 'roda-monads', '~> 0.1.0'
+  spec.add_runtime_dependency 'rom-repository'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'bundler-audit', '~> 0.5.0'
+  spec.add_development_dependency 'rack-test', '~> 0.6.3'
+  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rspec-roda', '~> 0.1.0'
+  spec.add_development_dependency 'rubocop', '~> 0.47.0'
+  spec.add_development_dependency 'simplecov', '~> 0.12.0'
+  spec.add_development_dependency 'yard', '~> 0.9.5'
+  spec.add_development_dependency 'rom-repository', '>= 0.3.1'
+  spec.add_development_dependency 'rom-sql', '>= 0.9'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'pry-byebug'
+end
+# rubocop:enable Metrics/BlockLength