api-blocks 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6840a132c6e9d821734ded5b586cbc46d2399c071cd15bed72081c8babc99eb2
+  data.tar.gz: 7ca022286f2e3f0f989b8e77564450eb4ee01adcce2d7cb7603fa7f82d5ad115
+SHA512:
+  metadata.gz: 0d0e202aa2766ac5ffdfeb66be737cbb7976a866a9aec7a0f1c891ef61a10c87063f2e991ef66d6b3a09a70e3cb525c6d6c97396bfe77192c9036962cbf6eaae
+  data.tar.gz: 1ba5337c3cd30b24dfe60aee1963f8a3f972729e2fdcba477984c62e8a5d5ddab67ea8a0879e88943f6cef7c9f9fc6fbb7005af8b386f0c7b5e37c183c15f22e

data/lib/api_blocks.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'api_blocks/version'
+require 'active_support/concern'
+require 'active_support/dependencies/autoload'
+
+
+# ApiBlocks provides simple and consistent rails api extensions.
+module ApiBlocks
+  extend ActiveSupport::Autoload
+
+  autoload :Controller
+  autoload :Responder
+  autoload :Interactor
+end

data/lib/api_blocks/controller.rb

@@ -0,0 +1,58 @@
+# frozen_string_litreal: true
+
+require "pundit"
+
+# ApiBlocks::Controller provides a set of default configurations for
+# Ruby on Rails api controllers.
+#
+# It sets up `ApiBlocks::Responder` as a responder, `Pundit` and controller defaults.
+#
+# @example
+#
+#   class Api::V1::ApplicationController < ActionController::API
+#     include ApiBlocks::Controller
+#
+#     pundit_scope :api, :v1
+#   end
+#
+module ApiBlocks::Controller
+  extend ActiveSupport::Concern
+
+  included do
+    self.responder = ApiBlocks::Responder
+
+    before_action :verify_request_format!
+
+    include Pundit
+    rescue_from Pundit::NotAuthorizedError, with: :render_forbidden_error
+
+    # Enable pundit after_action hooks to ensure policies are consistently
+    # used.
+    after_action :verify_authorized
+    after_action :verify_policy_scoped, except: :create
+
+    # Override policy_scope to lookup pundit policies under the `scope`
+    # namespace
+    def policy_scope(scope)
+      super(self.class.pundit_api_scope + [scope])
+    end
+
+    # Override authorize to lookup pundit policies under the `scope`
+    # namespace
+    def authorize(record, query = nil)
+      super(self.class.pundit_api_scope + [record], query)
+    end
+  end
+
+  class_methods do
+    # Provide a default scope to pundit's `PolicyFinder`.
+    def pundit_scope(*scope)
+      @pundit_api_scope = scope
+    end
+
+    # Returns the scope for pundit's `PolicyFinder`.
+    def pundit_api_scope
+      @pundit_api_scope || []
+    end
+  end
+end

data/lib/api_blocks/interactor.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+require "dry/transaction"
+require "dry/validation"
+
+# ApiBlocks::Interactor implements a base interactor class.
+#
+# It is based on `Dry::Transaction` and implements input schema parsing and
+# validation as well as database transaction handling.
+#
+# @example
+#
+#   class InviteUser < ApplicationInteractor
+#     input do
+#       schema do
+#         required(:email).filled
+#         required(:password).filled
+#
+#         optional(:first_name)
+#         optional(:last_name)
+#       end
+#     end
+#
+#     around :database_transaction!
+#
+#     step :validate_input!
+#     try :create_user, catch: ActiveRecord::RecordInvalid
+#     tee :deliver_invitation
+#
+#     def create_user(params)
+#       Success(User.create!(params))
+#     end
+#
+#     def deliver_invitation(user, mailer)
+#       mailer.accept_invitation(user)
+#     end
+#   end
+#
+class ApiBlocks::Interactor
+  include Dry::Transaction
+
+  class << self
+    attr_accessor :input_schema
+  end
+
+  # Define a contract for the input of this interactor using
+  # `dry-validation`
+  #
+  # @example
+  #
+  #   class FooInteractor < ApplicationInteractor
+  #     input do
+  #       schema do
+  #         required(:bar).filled
+  #       end
+  #     end
+  #
+  #     step :validate_input!
+  #   end
+  #
+  def self.input(&block)
+    @input_schema = Class.new(Dry::Validation::Contract, &block).new
+  end
+
+  # Call the interactor with its arguments.
+  #
+  # @example
+  #
+  #   InviteUser.call(
+  #     email: "foo@example.com",
+  #     first_name: "Foo",
+  #     last_name: "Bar"
+  #   )
+  #
+  def self.call(*args)
+    new.call(*args)
+  end
+
+  # Call the interactor with additional step arguments.
+  #
+  # @example
+  #
+  #   InviteUser.with_step_args(deliver_invitation: [mailer: UserMailer])
+  #
+  def self.with_step_args(*args)
+    new.with_step_args(*args)
+  end
+
+  protected
+
+  # Validates input with the class attribute `schema` if it is
+  # defined.
+  #
+  # Add this step to your interactor if you want to validate its input.
+  #
+  def validate_input!(input)
+    return Success(input) unless self.class.input_schema
+
+    result = self.class.input_schema.call(input)
+
+    if result.success?
+      Success(result.values)
+    else
+      Failure(result)
+    end
+  end
+
+  # Wraps the steps inside an AR transaction.
+  #
+  # Add this step to your interactor if you want to wrap its operations inside a
+  # database transaction
+  #
+  def database_transaction!(input)
+    result = nil
+
+    ActiveRecord::Base.transaction do
+      result = yield(Success(input))
+      raise ActiveRecord::Rollback if result.failure?
+    end
+
+    result
+  end
+end

data/lib/api_blocks/responder.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "action_controller/responder"
+require "responders"
+require "dry/monads"
+
+# ApiBlocks::Responder provides a responder with better error handling and
+# `ApiBlocks::Interactor` through `Dry::Monads::Result` support.
+#
+class ApiBlocks::Responder < ActionController::Responder
+  include Responders::HttpCacheResponder
+
+  # Override resource_errors to handle more error kinds
+  def resource_errors
+    case @resource
+    when ApplicationRecord
+      { errors: @resource.errors }
+    when ActiveRecord::RecordInvalid
+      { errors: @resource.record.errors }
+    else
+      # propagate the error so it can be handled through the standard rails
+      # error handlers.
+      raise @resource
+    end
+  end
+
+  def to_format
+    return super unless resource.is_a?(Dry::Monads::Result)
+
+    # unwrap the result monad so it can be processed by ActionController::Responder
+    resource.fmap { |result| @resource = result }.or do |failure|
+      @resource = failure
+      @failure = true
+    end
+
+    super
+  end
+
+  def has_errors? # rubocop:disable Naming/PredicateName
+    return true if @failure
+
+    super
+  end
+
+  # Override ActionController::Responder#api_behavior in order to
+  # provide one that matches our API documentation.
+  #
+  # The only difference so far is that on POST we do not render `status:
+  # :created` along with a `Location` header.
+  #
+  # Moreover, we display the resource on PUT.
+  #
+  def api_behavior
+    raise(MissingRenderer, format) unless has_renderer?
+
+    if get? || post? || put?
+      display resource
+    else
+      head :no_content
+    end
+  end
+end

data/lib/api_blocks/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+#
+module ApiBlocks
+  # Current version of ApiBlocks
+  VERSION = '0.1.0'.freeze
+end

metadata

@@ -0,0 +1,271 @@
+--- !ruby/object:Gem::Specification
+name: api-blocks
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Paul d'Hubert
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: pundit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: dry-monads
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: dry-transaction
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: dry-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: responders
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: pry
+  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: rake
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.76.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  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: yard-activesupport-concern
+  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: mocha
+  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'
+description: Simple and consistent rails api extensions
+email: dev@tymate.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/api_blocks.rb
+- lib/api_blocks/controller.rb
+- lib/api_blocks/interactor.rb
+- lib/api_blocks/responder.rb
+- lib/api_blocks/version.rb
+homepage: https://github.com/tymate/api-blocks
+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: Simple and consistent rails api extensions
+test_files: []