decidim-api 0.32.0 → 0.32.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0d0eddc032a0b48736746b609b28e9b73854f3559673d05607fdafe0babe019
-  data.tar.gz: 34c8d3ba36cba38b7f290bd1d903bf72407a9e179de511dec6f7ef0de1b47dcf
+  metadata.gz: 711ce76f6b6ef54bacaa6bc29c43a19b85700f4774f27e103d40e20431951e4a
+  data.tar.gz: 914f1dd7ea6ef1aa92ac99b571c42d9d469190d9834969b820a0b088e8bbddc0
 SHA512:
-  metadata.gz: 96734ffd4b043c6a6806e053f25a8c3c2ce895e8553d3961053d8339e84e87a9ce0c136b461aaa34ac09db5bcd291543b2111b89592d926b83b8b7b78dcaea86
-  data.tar.gz: a86d42ef455a52e18685645186fcf37ffe9dca7de7c8358cbd608318af8c7f7d913488fd0270f4f816b3d8c908eaf45f6af2569d162f1d123ab5a72ba6937a90
+  metadata.gz: 05c4829b1bc14b3e49fb8b5a2063fb2a9342503dba997f9ae4c7872a6cbaebd2aaa8dcdb15fc0d0f9801f34631cd3b99ff1d6f6ff998715e8a58945c4ada5ca1
+  data.tar.gz: ffdc03c642bbb04d4c325eb48a53be3bc8951b1a86b2900d4c8a8718d167368051eeef3821a7616a4f7be3761e94e48373324462003c9e0ec7d74131da51ecd5

data/app/models/concerns/decidim/api/user_extension.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module Decidim
+  module Api
+    # This concern adds the JWT authenticable strategy for the User models to
+    # allow regular users to sign in through the API (if configured from the
+    # system panel). Allows normal users to utilize the API e.g. through mobile
+    # applications.
+    module UserExtension
+      extend ActiveSupport::Concern
+
+      included do
+        devise :jwt_authenticatable, jwt_revocation_strategy: Decidim::Api::JwtDenylist
+      end
+    end
+  end
+end

data/decidim-api.gemspec

@@ -3,7 +3,7 @@
 $LOAD_PATH.push File.expand_path("lib", __dir__)
 
 Gem::Specification.new do |s|
-  version = "0.32.0"
+  version = "0.32.1"
   s.version = version
   s.authors = ["Josep Jaume Rey Peroy", "Marc Riera Casals", "Oriol Gual Oliva"]
   s.email = ["josepjaume@gmail.com", "mrc2407@gmail.com", "oriolgual@gmail.com"]

data/lib/decidim/api/engine.rb

@@ -41,6 +41,45 @@ module Decidim
         end
       end
 
+      initializer "decidim_api.devise", before: "add_routing_paths" do |app|
+        config.to_prepare do
+          Decidim::User.include Decidim::Api::UserExtension
+        end
+
+        # Required for the development environment because otherwise the JWT
+        # authentication strategy would be lost during code reloads.
+        app.reloader.after_class_unload do
+          Decidim::User.include Decidim::Api::UserExtension
+        end
+      end
+
+      initializer "decidim_api.devise_jwt", after: "devise.secret_key" do
+        Devise.jwt do |jwt|
+          # In order to be compatible with the JWT authentication, we need to set these
+          # configurations. JWT secret is being used by the devise-jwt to sign the
+          # tokens, once the user authenticated. The token signature ensures the
+          # validity of the token and that the user has not tampered with it. If the
+          # secret is not set correctly, the API authentication does not work.
+          #
+          # Note that the `dispatch_requests` and `revocation_requests` paths are the
+          # full paths because we do not want the JWT tokens to be dispatched or revoked
+          # during normal Decidim user sign ins or sign outs. This also requires a small
+          # override to `Warden::JWTAuth` which is defined at
+          # `decidim-api/lib/warden/jwt_auth/decidim_overrides.rb`.
+          jwt.secret = Decidim::Env.new("DECIDIM_API_JWT_SECRET").value || Devise.secret_key
+          raise "Please define the secret key for Devise" unless jwt.secret
+
+          jwt.dispatch_requests = [
+            ["POST", %r{^/api/sign_in$}]
+          ]
+          jwt.revocation_requests = [
+            ["DELETE", %r{^/api/sign_out$}]
+          ]
+          jwt.expiration_time = Decidim::Api.jwt_expires_in.minutes.to_i
+          jwt.aud_header = "X_JWT_AUD"
+        end
+      end
+
       initializer "decidim_api.data_migrate", after: "decidim_core.data_migrate" do
         DataMigrate.configure do |config|
           config.data_migrations_path << root.join("db/data").to_s

data/lib/decidim/api/version.rb

@@ -4,7 +4,7 @@ module Decidim
   # This holds the decidim-api version.
   module Api
     def self.version
-      "0.32.0"
+      "0.32.1"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-api
 version: !ruby/object:Gem::Version
-  version: 0.32.0
+  version: 0.32.1
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -17,14 +17,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.32.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.32.1
 - !ruby/object:Gem::Dependency
   name: devise-jwt
   requirement: !ruby/object:Gem::Requirement
@@ -111,56 +111,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.32.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.32.1
 - !ruby/object:Gem::Dependency
   name: decidim-comments
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.32.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.32.1
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.32.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.32.1
 - !ruby/object:Gem::Dependency
   name: decidim-participatory_processes
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.32.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.32.0
+        version: 0.32.1
 description: API engine for decidim
 email:
 - josepjaume@gmail.com
@@ -177,6 +177,7 @@ files:
 - app/controllers/decidim/api/graphiql_controller.rb
 - app/controllers/decidim/api/queries_controller.rb
 - app/controllers/decidim/api/sessions_controller.rb
+- app/models/concerns/decidim/api/user_extension.rb
 - app/models/decidim/api/api_user.rb
 - app/models/decidim/api/jwt_denylist.rb
 - app/packs/entrypoints/decidim_api_docs.js
@@ -189,7 +190,6 @@ files:
 - app/views/decidim/api/graphiql/show.html.erb
 - app/views/layouts/decidim/api/documentation.html.erb
 - config/assets.rb
-- config/initializers/devise.rb
 - config/locales/am-ET.yml
 - config/locales/ar.yml
 - config/locales/bg.yml

data/config/initializers/devise.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-Devise.jwt do |jwt|
-  # In order to be compatible with the JWT authentication, we need to set these
-  # configurations. JWT secret is being used by the devise-jwt to sign the
-  # tokens, once the user authenticated. The token signature ensures the
-  # validity of the token and that the user has not tampered with it. If the
-  # secret is not set correctly, the API authentication does not work.
-  #
-  # Note that the `dispatch_requests` and `revocation_requests` paths are the
-  # full paths because we do not want the JWT tokens to be dispatched or revoked
-  # during normal Decidim user sign ins or sign outs. This also requires a small
-  # override to `Warden::JWTAuth` which is defined at
-  # `decidim-api/lib/warden/jwt_auth/decidim_overrides.rb`.
-  jwt.secret = Decidim::Env.new("DECIDIM_API_JWT_SECRET").value
-  next unless jwt.secret
-
-  jwt.dispatch_requests = [
-    ["POST", %r{^/api/sign_in$}]
-  ]
-  jwt.revocation_requests = [
-    ["DELETE", %r{^/api/sign_out$}]
-  ]
-  jwt.expiration_time = Decidim::Api.jwt_expires_in.minutes.to_i
-  jwt.aud_header = "X_JWT_AUD"
-end