api-blocks 0.7.0 → 0.8.0

data/lib/api_blocks/railtie.rb

@@ -1,22 +1,24 @@
 # frozen_string_literal: true
 
-require "problem_details-rails"
+require 'problem_details-rails'
 
 # ApiBlocks::Railtie implements the Rails integration for ApiBlocks.
 #
 # @private
 #
-class ApiBlocks::Railtie < Rails::Railtie
-  generators do
-    require_relative 'doorkeeper/passwords/migration_generator'
-    require_relative 'doorkeeper/invitations/migration_generator'
-  end
+module ApiBlocks
+  class Railtie < Rails::Railtie
+    generators do
+      require_relative 'doorkeeper/passwords/migration_generator'
+      require_relative 'doorkeeper/invitations/migration_generator'
+    end
 
-  initializer "blueprinter.batch_loader_integration" do |app|
-    app.config.after_initialize do
-      next unless ApiBlocks.config.blueprinter.use_batch_loader
+    initializer 'blueprinter.batch_loader_integration' do |app|
+      app.config.after_initialize do
+        next unless ApiBlocks.config.blueprinter.use_batch_loader
 
-      require_relative "blueprinter/association_extractor"
+        require_relative 'blueprinter/association_extractor'
+      end
     end
   end
 end

data/lib/api_blocks/responder.rb

@@ -1,102 +1,102 @@
 # frozen_string_literal: true
 
-require "action_controller/responder"
-require "responders"
-require "dry/monads/result"
-require "dry/validation/result"
+require 'action_controller/responder'
+require 'responders'
+require 'dry/monads/result'
+require 'dry/validation/result'
 
 # 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
+module ApiBlocks
+  class Responder < ActionController::Responder
+    include Responders::HttpCacheResponder
 
-  # Override resource_errors to handle more error kinds and return a status
-  # code.
-  #
-  def resource_errors
-    case resource
-    when Dry::Validation::Result
-      [{ errors: resource.errors.to_h }, :unprocessable_entity]
-    when ActiveRecord::RecordInvalid
-      [{ errors: resource.record.errors }, :unprocessable_entity]
-    when ActiveModel::ValidationError
-      [{ errors: resource.model.errors }, :unprocessable_entity]
-    when String
-      [{ detail: resource }, :internal_server_error]
-    when ProblemDetails::Document
-      [resource.to_h, resource.status]
-    when StandardError
-      # propagate the error so it can be handled through the standard rails
-      # error handlers.
-      raise resource
-    else
-      super
+    # Override resource_errors to handle more error kinds and return a status
+    # code.
+    #
+    def resource_errors
+      case resource
+      when Dry::Validation::Result
+        [{ errors: resource.errors.to_h }, :unprocessable_entity]
+      when ActiveRecord::RecordInvalid
+        [{ errors: resource.record.errors }, :unprocessable_entity]
+      when ActiveModel::ValidationError
+        [{ errors: resource.model.errors }, :unprocessable_entity]
+      when String
+        [{ detail: resource }, :internal_server_error]
+      when ProblemDetails::Document
+        [resource.to_h, resource.status]
+      when StandardError
+        # propagate the error so it can be handled through the standard rails
+        # error handlers.
+        raise resource
+      else
+        super
+      end
     end
-  end
 
-  # Display is just a shortcut to render a resource's errors with the current
-  # format using `problem_details` when format is set to JSON.
-  #
-  def display_errors
-    return super unless format == :json
+    # Display is just a shortcut to render a resource's errors with the current
+    # format using `problem_details` when format is set to JSON.
+    #
+    def display_errors
+      return super unless format == :json
 
-    errors, status = resource_errors
-
-    controller.render problem: errors, status: status
-  end
+      errors, status = resource_errors
 
-  # All other formats follow the procedure below. First we try to render a
-  # template, if the template is not available, we verify if the resource
-  # responds to :to_format and display it.
-  #
-  # In addition, if the resource is a Dry::Monads::Result we unwrap it and
-  # assign the failure instead.
-  #
-  def to_format
-    if resource.is_a?(Dry::Monads::Result)
-      unwrap_dry_result
+      controller.render problem: errors, status: status
     end
 
-    super
-  end
+    # All other formats follow the procedure below. First we try to render a
+    # template, if the template is not available, we verify if the resource
+    # responds to :to_format and display it.
+    #
+    # In addition, if the resource is a Dry::Monads::Result we unwrap it and
+    # assign the failure instead.
+    #
+    def to_format
+      unwrap_dry_result if resource.is_a?(Dry::Monads::Result)
+
+      super
+    end
 
-  def has_errors? # rubocop:disable Naming/PredicateName
-    return true if @failure
+    def has_errors? # rubocop:disable Naming/PredicateName
+      return true if @failure
 
-    super
-  end
+      super
+    end
 
-  def json_resource_errors
-    [{ errors: resource.errors }, :unprocessable_entity]
-  end
+    def json_resource_errors
+      [{ errors: resource.errors }, :unprocessable_entity]
+    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?
+    # 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
+      if get? || post? || put?
+        display resource
+      else
+        head :no_content
+      end
     end
-  end
 
-  private
+    private
 
-  def unwrap_dry_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
+    def unwrap_dry_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
     end
   end
 end

data/lib/api_blocks/version.rb

@@ -2,5 +2,5 @@
 
 module ApiBlocks
   # Current version of ApiBlocks
-  VERSION = "0.7.0"
+  VERSION = '0.8.0'
 end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: api-blocks
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Paul d'Hubert
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2019-10-29 00:00:00.000000000 Z
@@ -16,14 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 5.1.0
+- !ruby/object:Gem::Dependency
+  name: dry-configurable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: dry-monads
   requirement: !ruby/object:Gem::Requirement
@@ -122,20 +136,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: dry-configurable
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -226,14 +226,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: 1.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.82.0
+        version: 1.6.1
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -271,6 +271,7 @@ files:
 - lib/api-blocks.rb
 - lib/api_blocks.rb
 - lib/api_blocks/blueprinter/association_extractor.rb
+- lib/api_blocks/blueprinter/join_keys.rb
 - lib/api_blocks/controller.rb
 - lib/api_blocks/doorkeeper.rb
 - lib/api_blocks/doorkeeper/invitations.rb
@@ -290,7 +291,7 @@ homepage: https://github.com/tymate/api-blocks
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -305,8 +306,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.1.3
+signing_key:
 specification_version: 4
 summary: Simple and consistent rails api extensions
 test_files: []