decidim-api 0.31.3 → 0.32.0.rc1

data/lib/decidim/api/test/component_context.rb

@@ -43,25 +43,33 @@ shared_context "with a graphql decidim component" do
   end
 end
 
-shared_examples "with resource visibility" do
-  let(:process_space_factory) { :participatory_process }
+shared_examples "graphQL not found space" do
   let(:space_type) { "participatoryProcess" }
 
-  shared_examples "graphQL visible resource" do
-    it "is visible" do
-      expect(response[space_type]["components"].first[lookout_key]).to eq(query_result)
-    end
+  it "should not be visible" do
+    expect { response }.to raise_error(Decidim::Api::Errors::NotFoundError, "#{space_type.classify} not found")
   end
+end
 
-  shared_examples "graphQL hidden space" do
-    it "should not be visible" do
-      expect(response[space_type]).to be_nil
+shared_examples "with resource visibility" do
+  let(:process_space_factory) { :participatory_process }
+  let(:space_type) { "participatoryProcess" }
+
+  shared_examples "graphQL visible resource" do |visible: true|
+    if visible
+      it "should be visible" do
+        expect(response[space_type]["components"].first[lookout_key]).to eq(query_result)
+      end
+    else
+      it "should not be visible" do
+        expect(response[space_type]["components"]).to be_empty
+      end
     end
   end
 
   shared_examples "graphQL hidden component" do
     it "should not be visible" do
-      expect(response[space_type]["components"].first).to be_nil
+      expect(response[space_type]["components"]).to be_empty
     end
   end
 
@@ -76,7 +84,7 @@ shared_examples "with resource visibility" do
   shared_examples "graphQL space hidden to visitor" do
     context "when user is visitor" do
       let!(:current_user) { nil }
-      it_behaves_like "graphQL hidden space"
+      it_behaves_like "graphQL not found space"
     end
   end
 
@@ -119,13 +127,13 @@ shared_examples "with resource visibility" do
 
       context "when user is member" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
-        let!(:participatory_space_private_user) { create(:participatory_space_private_user, user: current_user, privatable_to: participatory_process) }
+        let!(:member) { create(:member, user: current_user, participatory_space: participatory_process) }
         it_behaves_like "graphQL visible resource"
       end
 
       context "when user is member" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
-        let!(:participatory_space_private_user) { create(:participatory_space_private_user, user: current_user, privatable_to: participatory_process) }
+        let!(:member) { create(:member, user: current_user, participatory_space: participatory_process) }
         it_behaves_like "graphQL visible resource"
       end
 
@@ -143,7 +151,7 @@ shared_examples "with resource visibility" do
       context "when the user is space admin" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "admin") }
-        it_behaves_like "graphQL visible resource"
+        it_behaves_like "graphQL visible resource", visible: false
       end
 
       context "when the user is space collaborator" do
@@ -161,7 +169,7 @@ shared_examples "with resource visibility" do
       context "when the user is space evaluator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "evaluator") }
-        it_behaves_like "graphQL visible resource"
+        it_behaves_like "graphQL visible resource", visible: false
       end
 
       context "when user is visitor" do
@@ -177,13 +185,13 @@ shared_examples "with resource visibility" do
 
       context "when user is member" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
-        let!(:participatory_space_private_user) { create(:participatory_space_private_user, user: current_user, privatable_to: participatory_process) }
+        let!(:member) { create(:member, user: current_user, participatory_space: participatory_process) }
         it_behaves_like "graphQL hidden component"
       end
     end
   end
 
-  context "when space is published, private and transparent" do
+  context "when space is published and transparent" do
     let(:process_space_factory) { :assembly }
     let(:space_type) { "assembly" }
 
@@ -203,7 +211,7 @@ shared_examples "with resource visibility" do
       }
     )
     end
-    let!(:participatory_process) { create(process_space_factory, :published, :private, :transparent, organization: current_organization) }
+    let!(:participatory_process) { create(process_space_factory, :published, :transparent, organization: current_organization) }
 
     context "when component is published" do
       let!(:current_component) { create(component_factory, :published, participatory_space: participatory_process) }
@@ -241,7 +249,7 @@ shared_examples "with resource visibility" do
 
       context "when user is member" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
-        let!(:participatory_space_private_user) { create(:assembly_private_user, user: current_user, privatable_to: participatory_process) }
+        let!(:member) { create(:assembly_member, user: current_user, participatory_space: participatory_process) }
         it_behaves_like "graphQL visible resource"
       end
 
@@ -259,13 +267,13 @@ shared_examples "with resource visibility" do
       context "when the user is space admin" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:assembly_user_role, assembly: participatory_process, user: current_user, role: "admin") }
-        it_behaves_like "graphQL visible resource"
+        it_behaves_like "graphQL visible resource", visible: false
       end
 
       context "when the user is space collaborator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:assembly_user_role, assembly: participatory_process, user: current_user, role: "collaborator") }
-        it_behaves_like "graphQL visible resource"
+        it_behaves_like "graphQL visible resource", visible: false
       end
 
       context "when the user is space moderator" do
@@ -277,7 +285,7 @@ shared_examples "with resource visibility" do
       context "when the user is space evaluator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:assembly_user_role, assembly: participatory_process, user: current_user, role: "evaluator") }
-        it_behaves_like "graphQL visible resource"
+        it_behaves_like "graphQL visible resource", visible: false
       end
 
       context "when user is visitor" do
@@ -292,14 +300,14 @@ shared_examples "with resource visibility" do
 
       context "when user is member" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
-        let!(:participatory_space_private_user) { create(:assembly_private_user, user: current_user, privatable_to: participatory_process) }
+        let!(:member) { create(:assembly_member, user: current_user, participatory_space: participatory_process) }
         it_behaves_like "graphQL hidden component"
       end
     end
   end
 
-  context "when space is published but private" do
-    let!(:participatory_process) { create(process_space_factory, :published, :private, :with_steps, organization: current_organization) }
+  context "when space is published but restricted" do
+    let!(:participatory_process) { create(process_space_factory, :published, :restricted, :with_steps, organization: current_organization) }
 
     context "when component is published" do
       let!(:current_component) { create(component_factory, :published, participatory_space: participatory_process) }
@@ -309,38 +317,38 @@ shared_examples "with resource visibility" do
       context "when the user is space admin" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "admin") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when the user is space collaborator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "collaborator") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when the user is space moderator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "moderator") }
 
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when the user is space evaluator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "evaluator") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       it_behaves_like "graphQL space hidden to visitor"
 
       context "when user is normal user" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when user is member" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
-        let!(:participatory_space_private_user) { create(:participatory_space_private_user, user: current_user, privatable_to: participatory_process) }
+        let!(:member) { create(:member, user: current_user, participatory_space: participatory_process) }
         it_behaves_like "graphQL visible resource"
       end
     end
@@ -353,36 +361,36 @@ shared_examples "with resource visibility" do
       context "when the user is space admin" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "admin") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when the user is space collaborator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "collaborator") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when the user is space moderator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "moderator") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when the user is space evaluator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "evaluator") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
       it_behaves_like "graphQL space hidden to visitor"
 
       context "when user is member" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
-        let!(:participatory_space_private_user) { create(:participatory_space_private_user, user: current_user, privatable_to: participatory_process) }
+        let!(:member) { create(:member, user: current_user, participatory_space: participatory_process) }
         it_behaves_like "graphQL hidden component"
       end
       context "when user is normal user" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
     end
   end
@@ -398,38 +406,38 @@ shared_examples "with resource visibility" do
       context "when the user is space admin" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "admin") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when the user is space collaborator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "collaborator") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when the user is space moderator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "moderator") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when the user is space evaluator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "evaluator") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       it_behaves_like "graphQL space hidden to visitor"
 
       context "when user is member" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
-        let!(:participatory_space_private_user) { create(:participatory_space_private_user, user: current_user, privatable_to: participatory_process) }
-        it_behaves_like "graphQL hidden space"
+        let!(:member) { create(:member, user: current_user, participatory_space: participatory_process) }
+        it_behaves_like "graphQL not found space"
       end
 
       context "when user is normal user" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
     end
 
@@ -441,38 +449,38 @@ shared_examples "with resource visibility" do
       context "when the user is space admin" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "admin") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when the user is space collaborator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "collaborator") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when the user is space moderator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "moderator") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
 
       context "when the user is space evaluator" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
         let!(:role) { create(:participatory_process_user_role, participatory_process:, user: current_user, role: "evaluator") }
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
       it_behaves_like "graphQL space hidden to visitor"
 
       context "when user is member" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
-        let!(:participatory_space_private_user) { create(:participatory_space_private_user, user: current_user, privatable_to: participatory_process) }
-        it_behaves_like "graphQL hidden space"
+        let!(:member) { create(:member, user: current_user, participatory_space: participatory_process) }
+        it_behaves_like "graphQL not found space"
       end
 
       context "when user is normal user" do
         let!(:current_user) { create(:user, :confirmed, organization: current_organization) }
 
-        it_behaves_like "graphQL hidden space"
+        it_behaves_like "graphQL not found space"
       end
     end
   end

data/lib/decidim/api/test/shared_examples/commentable_interface_examples.rb

@@ -10,4 +10,50 @@ shared_examples_for "commentable interface" do
       expect(response["totalCommentsCount"]).to eq(model.comments_count)
     end
   end
+
+  describe "with comments" do
+    let(:comments) { create_list(:comment, 5, commentable: model) }
+    let(:subcomments_level1) do
+      comments.map do |comment|
+        create_list(:comment, 2, commentable: comment)
+      end.flatten
+    end
+    let!(:subcomments_level2) do
+      subcomments_level1.map do |comment|
+        create(:comment, commentable: comment)
+      end
+    end
+
+    let(:query) do
+      %(
+        {
+          comments {
+            ...dataFragment
+            comments {
+              ...dataFragment
+            }
+          }
+        }
+        fragment dataFragment on Comment {
+          id
+          body
+          createdAt
+          author { name }
+        }
+      )
+    end
+
+    it "includes the comments" do
+      expect(response["comments"]).to be_a(Array)
+      expect(response["comments"].count).to eq(5)
+
+      response["comments"].each do |comment|
+        expect(comment["comments"]).to be_a(Array)
+        expect(comment["comments"].count).to eq(2)
+
+        subcomments = subcomments_level1.select { |c| c.commentable.id == comment["id"].to_i }
+        expect(comment["comments"].map { |c| c["id"].to_i }).to match_array(subcomments.map(&:id))
+      end
+    end
+  end
 end

data/lib/decidim/api/test/shared_examples/followable_interface_examples.rb

@@ -4,10 +4,21 @@ require "spec_helper"
 
 shared_examples_for "followable interface" do
   describe "follows_count" do
+    let!(:follow) { create(:follow, followable: model) }
     let(:query) { "{ followsCount }" }
 
     it "includes the field" do
-      expect(response["followsCount"]).to eq(model.follows_count)
+      expect(response["followsCount"]).to eq(model.reload.follows_count)
+    end
+  end
+
+  describe "followers" do
+    let!(:follow) { create(:follow, followable: model) }
+    let(:query) { "{ followers { id } }" }
+
+    it "includes the field" do
+      expect(response["followers"]).to be_present
+      expect(response["followers"]).to include({ "id" => model.reload.followers.first.id.to_s })
     end
   end
 end

data/lib/decidim/api/test/shared_examples/statistics_examples.rb

@@ -15,7 +15,6 @@ shared_examples "implements stats type" do
                              { name: "surveys_count", data: [0], tooltip_key: "surveys_count_tooltip" },
                              { name: "results_count", data: [0], tooltip_key: "results_count_tooltip" },
                              { name: "debates_count", data: [0], tooltip_key: "debates_count_tooltip" },
-                             { name: "sortitions_count", data: [0], tooltip_key: "sortitions_count_tooltip" },
                              { name: "posts_count", data: [0], tooltip_key: "posts_count_tooltip" },
                              { name: "collaborative_texts_count", data: [0], tooltip_key: "collaborative_texts_count_tooltip" }
                            ]))
@@ -36,7 +35,6 @@ shared_examples "implements stats type" do
           { "name" => { "translation" => "Surveys" }, "value" => 0 },
           { "name" => { "translation" => "Results" }, "value" => 0 },
           { "name" => { "translation" => "Debates" }, "value" => 0 },
-          { "name" => { "translation" => "Sortitions" }, "value" => 0 },
           { "name" => { "translation" => "Posts" }, "value" => 0 },
           { "name" => { "translation" => "Collaborative texts" }, "value" => 0 }
         ]

data/lib/decidim/api/test/type_context.rb

@@ -35,8 +35,17 @@ shared_context "with a graphql class type" do
     # Matches the error code with the Error class
     # For instance, if the error code is NOT_FOUND_ERROR then it will raise the "Decidim::Api::Errors::NotFoundError" class
     raise "Decidim::Api::Errors::#{code.downcase.classify}".constantize, error["message"] if %w(
-      INTROSPECTION_DISABLED_ERROR
+      LOCALE_ERROR
+      NOT_FOUND_ERROR
+      INVALID_LOCALE_ERROR
+      PERMISSION_NOT_SET_ERROR
+      ATTRIBUTE_VALIDATION_ERROR
+      UNAUTHORIZED_FIELD_ERROR
+      UNAUTHORIZED_OBJECT_ERROR
+      MUTATION_NOT_AUTHORIZED_ERROR
+      VALIDATION_ERROR
       TOO_MANY_ALIASES_ERROR
+      INTROSPECTION_DISABLED_ERROR
       RECURSION_LIMIT_EXCEEDED_ERROR
     ).include?(code)
 
@@ -103,7 +112,6 @@ shared_examples "when the introspection is disabled" do
       before do
         allow(Decidim::Api).to receive(:enable_anonymous_introspection).and_return(false)
       end
-
       it "raises an Decidim::Api::Errors::IntrospectionDisabledError" do
         expect { response }.to raise_error(Decidim::Api::Errors::IntrospectionDisabledError, "Introspection is disabled for this request")
       end

data/lib/decidim/api/test.rb

@@ -22,4 +22,5 @@ require "decidim/api/test/shared_examples/statistics_examples"
 require "decidim/api/test/shared_examples/taxonomizable_interface_examples"
 require "decidim/api/test/shared_examples/timestamps_interface_examples"
 require "decidim/api/test/shared_examples/traceable_interface_examples"
+require "decidim/api/test/shared_examples/mutation_context"
 require "decidim/api/test/type_context"

data/lib/decidim/api/types/access_mode_enum.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Api
+    module Types
+      class AccessModeEnum < Decidim::Api::Types::BaseEnum
+        description "The access modes for participatory spaces"
+
+        value "OPEN", value: "open", description: "Open to everyone"
+        value "TRANSPARENT", value: "transparent", description: "Transparent (visible but restricted participation)"
+        value "RESTRICTED", value: "restricted", description: "Restricted to members only"
+      end
+    end
+  end
+end

data/lib/decidim/api/types/base_mutation.rb

@@ -5,12 +5,40 @@ module Decidim
     module Types
       class BaseMutation < GraphQL::Schema::RelayClassicMutation
         include Decidim::Api::GraphqlPermissions
+        include Decidim::FormFactory
 
         object_class BaseObject
         field_class Types::BaseField
         input_object_class BaseInputObject
 
         required_scopes "api:read", "api:write"
+
+        def set_locale(locale:, toggle_translations:)
+          raise I18n::InvalidLocale, "#{locale} is not a valid locale" unless available_locales.include?(locale)
+
+          I18n.locale = locale.presence
+          RequestStore.store[:toggle_machine_translations] = toggle_translations
+        end
+
+        def current_user
+          context[:current_user]
+        end
+
+        def current_component
+          context[:current_component]
+        end
+
+        def current_organization
+          context[:current_organization]
+        end
+
+        def available_locales
+          if current_organization.present?
+            current_organization.available_locales
+          else
+            I18n.available_locales.map(&:to_s)
+          end
+        end
       end
     end
   end

data/lib/decidim/api/types/base_object.rb

@@ -10,6 +10,18 @@ module Decidim
         field_class Types::BaseField
 
         required_scopes "api:read"
+
+        def current_user
+          context[:current_user]
+        end
+
+        def current_component
+          context[:current_component]
+        end
+
+        def current_organization
+          context[:current_organization]
+        end
       end
     end
   end

data/lib/decidim/api/types.rb

@@ -2,9 +2,9 @@
 
 module Decidim
   module Api
-    autoload :RecursionAnalyzer, "decidim/api/recursion_analyzer"
     autoload :IntrospectionAnalyzer, "decidim/api/introspection_analyzer"
     autoload :AliasAnalyzer, "decidim/api/alias_analyzer"
+    autoload :RecursionAnalyzer, "decidim/api/recursion_analyzer"
     autoload :QueryType, "decidim/api/query_type"
     autoload :MutationType, "decidim/api/mutation_type"
     autoload :Schema, "decidim/api/schema"
@@ -14,7 +14,16 @@ module Decidim
 
     module Errors
       autoload :IntrospectionDisabledError, "decidim/api/errors/introspection_disabled_error"
+      autoload :LocaleError, "decidim/api/errors/locale_error"
       autoload :TooManyAliasesError, "decidim/api/errors/too_many_aliases_error"
+      autoload :InvalidLocaleError, "decidim/api/errors/invalid_locale_error"
+      autoload :AttributeValidationError, "decidim/api/errors/attribute_validation_error"
+      autoload :MutationNotAuthorizedError, "decidim/api/errors/mutation_not_authorized_error"
+      autoload :NotFoundError, "decidim/api/errors/not_found_error"
+      autoload :PermissionNotSetError, "decidim/api/errors/permission_not_set_error"
+      autoload :UnauthorizedFieldError, "decidim/api/errors/unauthorized_field_error"
+      autoload :UnauthorizedObjectError, "decidim/api/errors/unauthorized_object_error"
+      autoload :ValidationError, "decidim/api/errors/validation_error"
       autoload :RecursionLimitExceededError, "decidim/api/errors/recursion_limit_exceeded_error"
     end
 
@@ -28,6 +37,8 @@ module Decidim
       autoload :BaseObject, "decidim/api/types/base_object"
       autoload :BaseScalar, "decidim/api/types/base_scalar"
       autoload :BaseUnion, "decidim/api/types/base_union"
+
+      autoload :AccessModeEnum, "decidim/api/types/access_mode_enum"
     end
   end
 end

data/lib/decidim/api/version.rb

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