api-blocks 0.7.0 → 0.8.0

data/lib/api_blocks/doorkeeper/invitations/migration_generator.rb

@@ -8,27 +8,33 @@ require 'rails/generators/active_record'
 #
 # @private
 #
-class ApiBlocks::Doorkeeper::Invitations::MigrationGenerator < ::Rails::Generators::Base # rubocop:disable Metrics/LineLength
-  include ::Rails::Generators::Migration
+module ApiBlocks
+  module Doorkeeper
+    module Invitations
+      class MigrationGenerator < ::Rails::Generators::Base
+        include ::Rails::Generators::Migration
 
-  source_root File.expand_path('templates', __dir__)
-  desc 'Installs doorkeeper invitations api migrations'
+        source_root File.expand_path('templates', __dir__)
+        desc 'Installs doorkeeper invitations api migrations'
 
-  def install
-    migration_template(
-      'migration.rb.erb',
-      'db/migrate/add_invitation_uri_to_doorkeeper_applications.rb',
-      migration_version: migration_version
-    )
-  end
+        def install
+          migration_template(
+            'migration.rb.erb',
+            'db/migrate/add_invitation_uri_to_doorkeeper_applications.rb',
+            migration_version: migration_version
+          )
+        end
 
-  def self.next_migration_number(dirname)
-    ActiveRecord::Generators::Base.next_migration_number(dirname)
-  end
+        def self.next_migration_number(dirname)
+          ActiveRecord::Generators::Base.next_migration_number(dirname)
+        end
 
-  private
+        private
 
-  def migration_version
-    "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        def migration_version
+          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        end
+      end
+    end
   end
 end

data/lib/api_blocks/doorkeeper/passwords.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
 # ApiBlocks::Doorkeeper::Passwords implements an API reset password workflow.
-module ApiBlocks::Doorkeeper::Passwords
-  extend ActiveSupport::Autoload
+module ApiBlocks
+  module Doorkeeper
+    module Passwords
+      extend ActiveSupport::Autoload
 
-  autoload :Controller
-  autoload :User
-  autoload :Application
+      autoload :Controller
+      autoload :User
+      autoload :Application
+    end
+  end
 end

data/lib/api_blocks/doorkeeper/passwords/application.rb

@@ -8,10 +8,16 @@
 #
 # @private
 #
-module ApiBlocks::Doorkeeper::Passwords::Application
-  extend ActiveSupport::Concern
+module ApiBlocks
+  module Doorkeeper
+    module Passwords
+      module Application
+        extend ActiveSupport::Concern
 
-  included do
-    validates :reset_password_uri, "doorkeeper/redirect_uri": true
+        included do
+          validates :reset_password_uri, "doorkeeper/redirect_uri": true
+        end
+      end
+    end
   end
 end

data/lib/api_blocks/doorkeeper/passwords/controller.rb

@@ -53,107 +53,113 @@
 #     end
 #   end
 #
-module ApiBlocks::Doorkeeper::Passwords::Controller
-  extend ActiveSupport::Concern
-
-  included do # rubocop:disable Metrics/BlockLength
-    # Skip pundit after action hooks because there is no authorization to
-    # perform.
-    skip_after_action :verify_authorized
-    skip_after_action :verify_policy_scoped
-
-    # Initialize the reset password workflow, sends a reset password email to
-    # the user.
-    def create
-      user = user_model.send_reset_password_instructions(
-        create_params, application: oauth_application
-      )
-
-      if successfully_sent?(user)
-        render(status: :no_content)
-      else
-        respond_with(user)
+module ApiBlocks
+  module Doorkeeper
+    module Passwords
+      module Controller
+        extend ActiveSupport::Concern
+
+        included do # rubocop:disable Metrics/BlockLength
+          # Skip pundit after action hooks because there is no authorization to
+          # perform.
+          skip_after_action :verify_authorized
+          skip_after_action :verify_policy_scoped
+
+          # Initialize the reset password workflow, sends a reset password email to
+          # the user.
+          def create
+            user = user_model.send_reset_password_instructions(
+              create_params, application: oauth_application
+            )
+
+            if successfully_sent?(user)
+              render(status: :no_content)
+            else
+              respond_with(user)
+            end
+          end
+
+          # Handles the redirection from the email towards the application's
+          # `redirect_uri`.
+          def callback
+            query = {
+              reset_password_token: params[:reset_password_token]
+            }.to_query
+
+            redirect_to(
+              "#{oauth_application.reset_password_uri}?#{query}"
+            )
+          end
+
+          # Updates the user password and returns a new Doorkeeper::AccessToken.
+          def update
+            user = user_model.reset_password_by_token(update_params)
+
+            return respond_with(user) unless user.errors.empty?
+
+            user.unlock_access! if unlockable?(user)
+
+            respond_with(Doorkeeper::OAuth::TokenResponse.new(
+              access_token(oauth_application, user)
+            ).body)
+          end
+
+          private
+
+          # Create permitted parameters
+          def create_params
+            params.require(:user).permit(:email)
+          end
+
+          # Update permitted parameters
+          def update_params
+            params.require(:user).permit(
+              :reset_password_token, :password
+            )
+          end
+
+          # Copied over from devise base controller in order to clear user errors if
+          # `Devise.paranoid` is active.
+          def successfully_sent?(user)
+            if Devise.paranoid
+              user.errors.clear
+              true
+            elsif user.errors.empty?
+              true
+            end
+          end
+
+          # Copied over from devise base controller in order to determine wether a ser
+          # is unlockable or not.
+          def unlockable?(resource)
+            resource.respond_to?(:unlock_access!) &&
+              resource.respond_to?(:unlock_strategy_enabled?) &&
+              resource.unlock_strategy_enabled?(:email)
+          end
+
+          # Returns a new access token for this user.
+          def access_token(application, user)
+            Doorkeeper::AccessToken.find_or_create_for(
+              application,
+              user.id,
+              Doorkeeper.configuration.default_scopes,
+              Doorkeeper.configuration.access_token_expires_in,
+              true
+            )
+          end
+
+          def oauth_application
+            @oauth_application ||= Doorkeeper::Application.find_by!(
+              uid: params[:client_id]
+            )
+          end
+
+          # Returns the user model class.
+          def user_model
+            raise 'the method `user_model` must be implemented on your password controller'
+          end
+        end
       end
     end
-
-    # Handles the redirection from the email towards the application's
-    # `redirect_uri`.
-    def callback
-      query = {
-        reset_password_token: params[:reset_password_token]
-      }.to_query
-
-      redirect_to(
-        "#{oauth_application.reset_password_uri}?#{query}"
-      )
-    end
-
-    # Updates the user password and returns a new Doorkeeper::AccessToken.
-    def update
-      user = user_model.reset_password_by_token(update_params)
-
-      return respond_with(user) unless user.errors.empty?
-
-      user.unlock_access! if unlockable?(user)
-
-      respond_with(Doorkeeper::OAuth::TokenResponse.new(
-        access_token(oauth_application, user)
-      ).body)
-    end
-
-    private
-
-    # Create permitted parameters
-    def create_params
-      params.require(:user).permit(:email)
-    end
-
-    # Update permitted parameters
-    def update_params
-      params.require(:user).permit(
-        :reset_password_token, :password
-      )
-    end
-
-    # Copied over from devise base controller in order to clear user errors if
-    # `Devise.paranoid` is active.
-    def successfully_sent?(user)
-      if Devise.paranoid
-        user.errors.clear
-        true
-      elsif user.errors.empty?
-        true
-      end
-    end
-
-    # Copied over from devise base controller in order to determine wether a ser
-    # is unlockable or not.
-    def unlockable?(resource)
-      resource.respond_to?(:unlock_access!) &&
-        resource.respond_to?(:unlock_strategy_enabled?) &&
-        resource.unlock_strategy_enabled?(:email)
-    end
-
-    # Returns a new access token for this user.
-    def access_token(application, user)
-      Doorkeeper::AccessToken.find_or_create_for(
-        application,
-        user.id,
-        Doorkeeper.configuration.default_scopes,
-        Doorkeeper.configuration.access_token_expires_in,
-        true
-      )
-    end
-
-    def oauth_application
-      @oauth_application ||= Doorkeeper::Application.find_by!(
-        uid: params[:client_id]
-      )
-    end
-
-    # Returns the user model class.
-    def user_model
-      raise 'the method `user_model` must be implemented on your password controller' # rubocop:disable Metrics/LineLength
-    end
   end
 end

data/lib/api_blocks/doorkeeper/passwords/migration_generator.rb

@@ -8,27 +8,33 @@ require 'rails/generators/active_record'
 #
 # @private
 #
-class ApiBlocks::Doorkeeper::Passwords::MigrationGenerator < ::Rails::Generators::Base # rubocop:disable Metrics/LineLength
-  include ::Rails::Generators::Migration
+module ApiBlocks
+  module Doorkeeper
+    module Passwords
+      class MigrationGenerator < ::Rails::Generators::Base
+        include ::Rails::Generators::Migration
 
-  source_root File.expand_path('templates', __dir__)
-  desc 'Installs doorkeeper passwords api migrations'
+        source_root File.expand_path('templates', __dir__)
+        desc 'Installs doorkeeper passwords api migrations'
 
-  def install
-    migration_template(
-      'migration.rb.erb',
-      'db/migrate/add_reset_password_uri_to_doorkeeper_applications.rb',
-      migration_version: migration_version
-    )
-  end
+        def install
+          migration_template(
+            'migration.rb.erb',
+            'db/migrate/add_reset_password_uri_to_doorkeeper_applications.rb',
+            migration_version: migration_version
+          )
+        end
 
-  def self.next_migration_number(dirname)
-    ActiveRecord::Generators::Base.next_migration_number(dirname)
-  end
+        def self.next_migration_number(dirname)
+          ActiveRecord::Generators::Base.next_migration_number(dirname)
+        end
 
-  private
+        private
 
-  def migration_version
-    "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        def migration_version
+          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+        end
+      end
+    end
   end
 end

data/lib/api_blocks/doorkeeper/passwords/user.rb

@@ -9,42 +9,46 @@
 #     include ApiBlocks::Doorkeeper::Passwords::User
 #   end
 #
-module ApiBlocks::Doorkeeper::Passwords::User
-  extend ActiveSupport::Concern
+module ApiBlocks
+  module Doorkeeper
+    module Passwords
+      module User
+        extend ActiveSupport::Concern
 
-  included do
-    # Resets reset password token and send reset password instructions by email.
-    # Returns the token sent in the e-mail.
-    def send_reset_password_instructions(application = nil)
-      token = set_reset_password_token
-      send_reset_password_instructions_notification(token, application)
+        included do
+          # Resets reset password token and send reset password instructions by email.
+          # Returns the token sent in the e-mail.
+          def send_reset_password_instructions(application = nil)
+            token = set_reset_password_token
+            send_reset_password_instructions_notification(token, application)
 
-      token
-    end
+            token
+          end
 
-    protected
+          protected
 
-    def send_reset_password_instructions_notification(token, application = nil)
-      send_devise_notification(
-        :reset_password_instructions, token, application
-      )
-    end
-  end
+          def send_reset_password_instructions_notification(token, application = nil)
+            send_devise_notification(
+              :reset_password_instructions, token, application
+            )
+          end
+        end
 
-  class_methods do
-    # Attempt to find a user by its email. If a record is found, send new
-    # password instructions to it. If user is not found, returns a new user
-    # with an email not found error.
-    # Attributes must contain the user's email
-    def send_reset_password_instructions(attributes = {}, application: nil)
-      recoverable = find_or_initialize_with_errors(
-        reset_password_keys, attributes, :not_found
-      )
+        class_methods do
+          # Attempt to find a user by its email. If a record is found, send new
+          # password instructions to it. If user is not found, returns a new user
+          # with an email not found error.
+          # Attributes must contain the user's email
+          def send_reset_password_instructions(attributes = {}, application: nil)
+            recoverable = find_or_initialize_with_errors(
+              reset_password_keys, attributes, :not_found
+            )
 
-      if recoverable.persisted?
-        recoverable.send_reset_password_instructions(application)
+            recoverable.send_reset_password_instructions(application) if recoverable.persisted?
+            recoverable
+          end
+        end
       end
-      recoverable
     end
   end
 end

data/lib/api_blocks/interactor.rb

@@ -36,88 +36,90 @@ require 'dry/validation'
 #     end
 #   end
 #
-class ApiBlocks::Interactor
-  include Dry::Transaction
+module ApiBlocks
+  class Interactor
+    include Dry::Transaction
 
-  class << self
-    attr_accessor :input_schema
-  end
+    class << self
+      attr_accessor :input_schema
+    end
 
-  # Define a contract for the input of this interactor using
-  # `dry-validation`
-  #
-  # @example
-  #
-  #   class FooInteractor < ApiBlocks::Interactor
-  #     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
+    # Define a contract for the input of this interactor using
+    # `dry-validation`
+    #
+    # @example
+    #
+    #   class FooInteractor < ApiBlocks::Interactor
+    #     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 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
+    # 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
+    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
+    # 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)
+      result = self.class.input_schema.call(input)
 
-    if result.success?
-      Success(result.values)
-    else
-      Failure(result)
+      if result.success?
+        Success(result.values)
+      else
+        Failure(result)
+      end
     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
+    # 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
+      ActiveRecord::Base.transaction do
+        result = yield(Success(input))
+        raise ActiveRecord::Rollback if result.failure?
+      end
 
-    result
+      result
+    end
   end
 end