decidim-verifications 0.8.4 → 0.9.0

data/lib/decidim/verifications/default_action_authorizer.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Verifications
+    class DefaultActionAuthorizer
+      #
+      # Initializes the DefaultActionAuthorizer class.
+      #
+      # authorization - The existing authorization record to be evaluated. Can be nil.
+      # options       - A hash with options related only to the current authorization process.
+      #
+      def initialize(authorization, options)
+        @authorization = authorization
+        @options = options.deep_dup # options hash is cloned to allow changes applied to it without risks
+      end
+
+      #
+      # Checks the status of the given authorization.
+      #
+      # Returns:
+      #   first value    - A symbol describing the authorization status.
+      #     ok                - When everything is OK and the user is correctly authorized.
+      #     missing           - When no authorization can be found.
+      #     expired           - The validity time for the given authorization has run out, and
+      #                         needs to be re-validated.
+      #     pending           - When an authorization was found, but is not complete (eg. is
+      #                         waiting for admin manual confirmation).
+      #     unauthorized      - When an authorization was found, but the value of some of its fields
+      #                         is not the expected one (eg. the user is authorized for scope A,
+      #                         but this action is only for users in scope B).
+      #     incomplete        - An authorization was found, but lacks some required fields. User
+      #                         should re-authenticate.
+      #   last value     - A hash with information to be shown to the users.
+      #     action            - Translation key to be used in the "authorize" button. A close button will be shown is missing.
+      #     cancel            - If present and true a cancel button will be shown.
+      #     fields            - Wrong fields to be shown. It could be a list of names or a hash with names a current values.
+      #     extra_explanation - Hash with an additional key and params to be translated and shown to the user.
+      #
+      def authorize
+        if !authorization
+          [:missing, action: :authorize]
+        elsif authorization_expired?
+          [:expired, action: :authorize]
+        elsif !authorization.granted?
+          [:pending, action: :resume]
+        elsif unmatched_fields.any?
+          [:unauthorized, fields: unmatched_fields]
+        elsif missing_fields.any?
+          [:incomplete, fields: missing_fields, action: :reauthorize, cancel: true]
+        else
+          [:ok, {}]
+        end
+      end
+
+      #
+      # Allow to add params to redirect URLs, to modify forms behaviour based on the authorization process options.
+      #
+      # Returns a hash with keys added to redirect URLs.
+      #
+      def redirect_params
+        {}
+      end
+
+      protected
+
+      attr_reader :authorization, :options
+
+      def unmatched_fields
+        @unmatched_fields ||= (options.keys & authorization.metadata.to_h.keys).each_with_object({}) do |field, unmatched|
+          unmatched[field] = options[field] if authorization.metadata[field] != options[field]
+          unmatched
+        end
+      end
+
+      def missing_fields
+        @missing_fields ||= options.keys.each_with_object([]) do |field, missing|
+          missing << field if authorization.metadata[field].blank?
+          missing
+        end
+      end
+
+      def authorization_expired?
+        authorization.expires_at.present? && authorization.expired?
+      end
+    end
+  end
+end

data/lib/decidim/verifications/dummy.rb

@@ -2,4 +2,6 @@
 
 Decidim::Verifications.register_workflow(:dummy_authorization_handler) do |workflow|
   workflow.form = "Decidim::DummyAuthorizationHandler"
+  workflow.action_authorizer = "Decidim::DummyAuthorizationHandler::ActionAuthorizer"
+  workflow.expires_in = 1.hour
 end

data/lib/decidim/verifications/registry.rb

@@ -14,6 +14,10 @@ module Decidim
         add_workflow(manifest)
       end
 
+      def unregister_workflow(manifest)
+        workflow_collection.delete(manifest)
+      end
+
       def add_workflow(manifest)
         manifest.validate!
         workflow_collection.add(manifest)

data/lib/decidim/verifications/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-verifications version.
   module Verifications
     def self.version
-      "0.8.4"
+      "0.9.0"
     end
   end
 end

data/lib/decidim/verifications/workflow_manifest.rb

@@ -2,6 +2,8 @@
 
 module Decidim
   module Verifications
+    autoload :DefaultActionAuthorizer, "decidim/verifications/default_action_authorizer"
+
     #
     # This class serves as a DSL to declaratively specify a verification method.
     #
@@ -28,6 +30,8 @@ module Decidim
       attribute :engine, Rails::Engine
       attribute :admin_engine, Rails::Engine
       attribute :form, String
+      attribute :expires_in, ActiveSupport::Duration, default: 0.minutes
+      attribute :action_authorizer, String
 
       validate :engine_or_form
 
@@ -45,12 +49,20 @@ module Decidim
       alias key name
 
       def fullname
-        I18n.t("#{key}.name", scope: "decidim.authorization_handlers")
+        I18n.t("#{key}.name", scope: "decidim.authorization_handlers", default: name.humanize)
       end
 
       def description
         "#{fullname} (#{I18n.t(type, scope: "decidim.authorization_handlers")})"
       end
+
+      def action_authorizer_class
+        if @action_authorizer.present?
+          @action_authorizer.constantize
+        else
+          DefaultActionAuthorizer
+        end
+      end
     end
   end
 end

data/lib/decidim/verifications/workflows.rb

@@ -27,6 +27,15 @@ module Decidim
         registry.register_workflow(name, &block)
       end
 
+      #
+      # Registers a verification workflow using the workflow manifest API
+      #
+      def unregister_workflow(name)
+        manifest = find_workflow_manifest(name)
+
+        registry.unregister_workflow(manifest)
+      end
+
       #
       # Finds a verification workflow by name
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: decidim-verifications
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.9.0
 platform: ruby
 authors:
 - David Rodriguez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-16 00:00:00.000000000 Z
+date: 2018-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-core
@@ -16,42 +16,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: decidim-admin
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 0.9.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.8.4
+        version: 0.9.0
 description: Several verification methods for your decidim instance
 email:
 - deivid.rodriguez@riseup.net
@@ -84,6 +84,7 @@ files:
 - app/services/decidim/authorization_handler.rb
 - app/services/decidim/dummy_authorization_handler.rb
 - app/uploaders/decidim/verifications/attachment_uploader.rb
+- app/views/decidim/verifications/authorizations/_granted_authorization.html.erb
 - app/views/decidim/verifications/authorizations/first_login.html.erb
 - app/views/decidim/verifications/authorizations/index.html.erb
 - app/views/decidim/verifications/authorizations/new.html.erb
@@ -94,21 +95,26 @@ files:
 - app/views/decidim/verifications/postal_letter/admin/pending_authorizations/index.html.erb
 - app/views/decidim/verifications/postal_letter/authorizations/edit.html.erb
 - app/views/decidim/verifications/postal_letter/authorizations/new.html.erb
+- app/views/dummy_authorization/_form.html.erb
 - config/locales/ca.yml
 - config/locales/en.yml
 - config/locales/es.yml
 - config/locales/eu.yml
 - config/locales/fi.yml
 - config/locales/fr.yml
+- config/locales/gl.yml
 - config/locales/it.yml
 - config/locales/nl.yml
 - config/locales/pl.yml
+- config/locales/pt-BR.yml
 - config/locales/pt.yml
 - config/locales/ru.yml
+- config/locales/sv.yml
 - config/locales/uk.yml
 - db/migrate/20171030133426_move_authorizations_to_new_api.rb
 - lib/decidim/verifications.rb
 - lib/decidim/verifications/adapter.rb
+- lib/decidim/verifications/default_action_authorizer.rb
 - lib/decidim/verifications/dummy.rb
 - lib/decidim/verifications/engine.rb
 - lib/decidim/verifications/id_documents.rb
@@ -145,8 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Verifications plugin for decidim
+summary: Decidim verifications module
 test_files: []