decidim-api 0.23.5 → 0.24.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfef0c50ddcc300ffc202131e5632b6616f44c012ddf786f9e1e3041d7df6010
-  data.tar.gz: fb9d3a27b1d024019cf183792f3efd8ef8e985c89dbe7c78cf7c2798782167de
+  metadata.gz: 2238ab506e29f89b55e6ebca83fbcc108ee4d7f8a8a9cf16ceb8ea5225389278
+  data.tar.gz: 89dcce0b4b30bfb1a0cd91fabc8b137bc8fb579cb453237d755c702da30f257a
 SHA512:
-  metadata.gz: 7f9f160391e99346efc41b0b81a59c1ba9b53dabb69a667705c5c08d7ecf69d73c087954c446e7b93fff1631671d059099c66e6592701d000dd4a1a4c97bb8ee
-  data.tar.gz: 5c2df81547d7732aa7ea54fc6e93e038bcd7a6219d96e52001902dbd4e1f71dcb9e9e02dc26f83985bd1d2d4ccbd631b1cb662124fc0a254392e847cc4c54672
+  metadata.gz: 44f83cf9d38e440a35dfa63fbf2f9edc82be6913a7f7c57e8166ff4194829ec9197863dc18bac1741e0b9fd665372c40e879d892c6e278d32ff5bb6a11927777
+  data.tar.gz: 40d1cfc7b68e9e1a1cd76c9c569902a55305a65cfc83d2975151e0d79c9f531d391441fe661874a53ec625a17fd3365ccef996f51793660572abe9842c04b452

data/app/controllers/decidim/api/queries_controller.rb

@@ -6,10 +6,22 @@ module Decidim
     # the Schema to be executed, later returning the response as JSON.
     class QueriesController < Api::ApplicationController
       def create
-        query_string = params[:query]
-        query_variables = ensure_hash(params[:variables])
-        result = Schema.execute(query_string, variables: query_variables, context: context)
+        variables = prepare_variables(params[:variables])
+        query = params[:query]
+        operation_name = params[:operationName]
+        result = Schema.execute(query, variables: variables, context: context, operation_name: operation_name)
         render json: result
+      rescue StandardError => e
+        logger.error e.message
+        logger.error e.backtrace.join("\n")
+
+        message = if Rails.env.development?
+                    { message: e.message, backtrace: e.backtrace }
+                  else
+                    { message: "Internal Server error" }
+                  end
+
+        render json: { errors: [message], data: {} }, status: :internal_server_error
       end
 
       private
@@ -21,13 +33,22 @@ module Decidim
         }
       end
 
-      def ensure_hash(query_variables)
-        if query_variables.blank?
+      def prepare_variables(variables_param)
+        case variables_param
+        when String
+          if variables_param.present?
+            JSON.parse(variables_param) || {}
+          else
+            {}
+          end
+        when Hash
+          variables_param
+        when ActionController::Parameters
+          variables_param.to_unsafe_hash # GraphQL-Ruby will validate name and type of incoming variables.
+        when nil
           {}
-        elsif query_variables.is_a?(String)
-          JSON.parse(query_variables)
         else
-          query_variables
+          raise ArgumentError, "Unexpected parameter: #{variables_param}"
         end
       end
     end

data/lib/decidim/api.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "decidim/api/engine"
+require "decidim/api/types"
 
 module Decidim
   # This module holds all business logic related to exposing a Public API for

data/lib/decidim/api/engine.rb

@@ -19,7 +19,7 @@ module Decidim
         app.config.middleware.insert_before 0, Rack::Cors do
           allow do
             origins "*"
-            resource "*", headers: :any, methods: [:get, :post, :options]
+            resource "/api", headers: :any, methods: [:post, :options]
           end
         end
       end

data/{app/types → lib}/decidim/api/mutation_type.rb

@@ -3,8 +3,7 @@
 module Decidim
   module Api
     # This type represents the root mutation type of the whole API
-    MutationType = GraphQL::ObjectType.define do
-      name "Mutation"
+    class MutationType < Decidim::Api::Types::BaseObject
       description "The root mutation of this schema"
     end
   end

data/{app/types → lib}/decidim/api/query_type.rb

@@ -3,8 +3,7 @@
 module Decidim
   module Api
     # This type represents the root query type of the whole API.
-    QueryType = GraphQL::ObjectType.define do
-      name "Query"
+    class QueryType < Decidim::Api::Types::BaseObject
       description "The root query of this schema"
     end
   end

data/{app/types → lib}/decidim/api/schema.rb

@@ -3,17 +3,15 @@
 module Decidim
   module Api
     # Main GraphQL schema for decidim's API.
-    Schema = GraphQL::Schema.define do
-      query QueryType
-      mutation MutationType
+    class Schema < GraphQL::Schema
+      mutation(MutationType)
+      query(QueryType)
 
       default_max_page_size 50
       max_depth 15
       max_complexity 300
 
       orphan_types(Api.orphan_types)
-
-      resolve_type ->(_type, _obj, _ctx) {}
     end
   end
 end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require "decidim/api/test/type_context"
+
+shared_context "with a graphql decidim component" do
+  include_context "with a graphql class type"
+
+  let(:schema) { Decidim::Api::Schema }
+
+  let(:locale) { "en" }
+
+  let(:participatory_process) { create :participatory_process, organization: current_organization }
+  let(:category) { create(:category, participatory_space: participatory_process) }
+
+  let(:component_type) {}
+  let(:component_fragment) {}
+
+  let(:participatory_process_query) do
+    %(
+      participatoryProcess(id: #{participatory_process.id}) {
+        components(filter: {type: "#{component_type}"}){
+          id
+          name {
+            translation(locale: "#{locale}")
+          }
+          weight
+          __typename
+          ...fooComponent
+        }
+        id
+      }
+    )
+  end
+
+  let(:query) do
+    %(
+      query {
+        #{participatory_process_query}
+      }
+      #{component_fragment}
+    )
+  end
+end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-shared_context "with a graphql type" do
+shared_context "with a graphql class type" do
   let!(:current_organization) { create(:organization) }
   let!(:current_user) { create(:user, organization: current_organization) }
   let(:model) { OpenStruct.new({}) }
@@ -10,13 +10,9 @@ shared_context "with a graphql type" do
 
   let(:schema) do
     klass = type_class
-
-    GraphQL::Schema.define do
+    Class.new(Decidim::Api::Schema) do
       query klass
-
       orphan_types(Decidim::Api.orphan_types)
-
-      resolve_type ->(_type, _obj, _ctx) {}
     end
   end
 
@@ -35,14 +31,14 @@ shared_context "with a graphql type" do
       variables: variables
     )
 
-    raise Exception, result["errors"].map { |e| e["message"] }.join(", ") if result["errors"]
+    raise StandardError, result["errors"].map { |e| e["message"] }.join(", ") if result["errors"]
 
     result["data"]
   end
 end
 
-shared_context "with a graphql scalar type" do
-  include_context "with a graphql type"
+shared_context "with a graphql scalar class type" do
+  include_context "with a graphql class type"
 
   let(:root_value) do
     OpenStruct.new(value: model)
@@ -51,11 +47,11 @@ shared_context "with a graphql scalar type" do
   let(:type_class) do
     klass = described_class
 
-    GraphQL::ObjectType.define do
-      name "Test#{klass.name}"
+    Class.new(GraphQL::Schema::Object) do
+      graphql_name "ScalarFieldType"
       description "Fake test type"
 
-      field :value, klass
+      field :value, klass, null: false
     end
   end
 

data/lib/decidim/api/types.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Api
+    autoload :QueryType, "decidim/api/query_type"
+    autoload :MutationType, "decidim/api/mutation_type"
+    autoload :Schema, "decidim/api/schema"
+
+    module Types
+      autoload :BaseArgument, "decidim/api/types/base_argument"
+      autoload :BaseEnum, "decidim/api/types/base_enum"
+      autoload :BaseField, "decidim/api/types/base_field"
+      autoload :BaseInputObject, "decidim/api/types/base_input_object"
+      autoload :BaseInterface, "decidim/api/types/base_interface"
+      autoload :BaseMutation, "decidim/api/types/base_mutation"
+      autoload :BaseObject, "decidim/api/types/base_object"
+      autoload :BaseScalar, "decidim/api/types/base_scalar"
+      autoload :BaseUnion, "decidim/api/types/base_union"
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Api
+    module Types
+      class BaseArgument < GraphQL::Schema::Argument
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Api
+    module Types
+      class BaseEnum < GraphQL::Schema::Enum
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Api
+    module Types
+      class BaseField < GraphQL::Schema::Field
+        argument_class Types::BaseArgument
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Api
+    module Types
+      class BaseInputObject < GraphQL::Schema::InputObject
+        argument_class Types::BaseArgument
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Api
+    module Types
+      module BaseInterface
+        include GraphQL::Schema::Interface
+
+        field_class Types::BaseField
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Api
+    module Types
+      class BaseMutation < GraphQL::Schema::RelayClassicMutation
+        object_class BaseObject
+        field_class BaseField
+        input_object_class BaseInputObject
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Api
+    module Types
+      class BaseObject < GraphQL::Schema::Object
+        field_class Types::BaseField
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Api
+    module Types
+      class BaseScalar < GraphQL::Schema::Scalar
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Api
+    module Types
+      class BaseUnion < GraphQL::Schema::Union
+      end
+    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.23.5"
+      "0.24.2"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-api
 version: !ruby/object:Gem::Version
-  version: 0.23.5
+  version: 0.24.2
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-08 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: graphiql-rails
@@ -38,14 +38,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.12'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.12.3
 - !ruby/object:Gem::Dependency
   name: rack-cors
   requirement: !ruby/object:Gem::Requirement
@@ -66,14 +72,20 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
+        version: '3.5'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.1
 - !ruby/object:Gem::Dependency
   name: sprockets-es6
   requirement: !ruby/object:Gem::Requirement
@@ -94,56 +106,56 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.5
+        version: 0.24.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.5
+        version: 0.24.2
 - !ruby/object:Gem::Dependency
   name: decidim-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.5
+        version: 0.24.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.5
+        version: 0.24.2
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.5
+        version: 0.24.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.5
+        version: 0.24.2
 - !ruby/object:Gem::Dependency
   name: decidim-participatory_processes
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.5
+        version: 0.24.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.23.5
+        version: 0.24.2
 description: API engine for decidim
 email:
 - josepjaume@gmail.com
@@ -164,9 +176,6 @@ files:
 - app/controllers/decidim/api/graphiql_controller.rb
 - app/controllers/decidim/api/queries_controller.rb
 - app/helpers/decidim/api/application_helper.rb
-- app/types/decidim/api/mutation_type.rb
-- app/types/decidim/api/query_type.rb
-- app/types/decidim/api/schema.rb
 - app/views/decidim/api/documentation/show.html.erb
 - app/views/layouts/decidim/api/documentation.html.erb
 - config/routes.rb
@@ -174,7 +183,21 @@ files:
 - lib/decidim/api.rb
 - lib/decidim/api/engine.rb
 - lib/decidim/api/graphiql-initial-query.txt
+- lib/decidim/api/mutation_type.rb
+- lib/decidim/api/query_type.rb
+- lib/decidim/api/schema.rb
+- lib/decidim/api/test/component_context.rb
 - lib/decidim/api/test/type_context.rb
+- lib/decidim/api/types.rb
+- lib/decidim/api/types/base_argument.rb
+- lib/decidim/api/types/base_enum.rb
+- lib/decidim/api/types/base_field.rb
+- lib/decidim/api/types/base_input_object.rb
+- lib/decidim/api/types/base_interface.rb
+- lib/decidim/api/types/base_mutation.rb
+- lib/decidim/api/types/base_object.rb
+- lib/decidim/api/types/base_scalar.rb
+- lib/decidim/api/types/base_union.rb
 - lib/decidim/api/version.rb
 - vendor/assets/javascripts/decidim/api/graphql-docs.js
 - vendor/assets/javascripts/decidim/api/react-dom.js
@@ -191,14 +214,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
 summary: Decidim API module