decidim-api 0.24.0 → 0.25.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dec8b6a402bb2be545b69809d6e05dc2979ba67e83d25ff858d2c9ba02a08981
-  data.tar.gz: 15fa13b5aeda25259ae58fd23199d4df6a14c918690f5c69d92f215e63837899
+  metadata.gz: 770bc3bb80ff9614494c1ec41f5578049a38bc1f32b127620a679870485c471f
+  data.tar.gz: 06e68463c60e2d24b8e6c6c73116a8655729829ae471ed897acb0dac0b204bcf
 SHA512:
-  metadata.gz: 150194286368c2a736c6c214655df39769759c3c22b831e35e68b825362866e5af6f5e9174346587d784b441032326fa8156a06d28fa1b2f3831f3622392ad08
-  data.tar.gz: 9790b1424eb5aecff273d306ebc89cfeea7b1a569d8e3826e9772d5f320baf6b0daaed798e4626e9c4d467a61e1d7b0a0b4bc094daf41b401adcde926ea0594d
+  metadata.gz: 9d53db17a10497edbf7151b568d0a2317af1478e13d92caa39e164dbb4db88c0b60d23721823c309c1e0cc28007c5b93a0bcf66da91418963f14814b0230eb0b
+  data.tar.gz: 2a3222f93141bb298f39f5fdcaeaa235c3393759ef8e937fdbeee619e291e68841f889a06b91174f4ace90c73e28b39743bbf83525dfd80a1c7ece8852d5a0a6

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

@@ -4,12 +4,15 @@ module Decidim
   module Api
     # Controller to serve the GraphiQL client. Used so that we can hook the
     # `ForceAuthentication` module.
-    class GraphiQLController < ::GraphiQL::Rails::EditorsController
+    class GraphiQLController < Api::ApplicationController
       include NeedsOrganization
       include ForceAuthentication
 
-      def self.controller_path
-        "graphiql/rails/editors"
+      def show; end
+
+      helper_method :graphql_endpoint_path
+      def graphql_endpoint_path
+        params[:graphql_path]
       end
     end
   end

data/app/{assets/javascripts/decidim/api/docs.js.es6 → packs/entrypoints/decidim_api_docs.js}

@@ -1,9 +1,9 @@
 /* eslint-disable react/jsx-no-undef */
 
-// = require jquery3
-// = require decidim/api/react
-// = require decidim/api/react-dom
-// = require decidim/api/graphql-docs
+import jQuery from "jquery"
+import { render } from "react-dom"
+import { GraphQLDocs } from "graphql-docs"
+import "stylesheets/decidim/api/docs.scss"
 
 const fetcherFactory = (path) => {
   return (query) => {
@@ -18,8 +18,9 @@ const fetcherFactory = (path) => {
 }
 
 window.renderDocumentation = (path) => {
-  ReactDOM.render(
-    <GraphQLDocs.GraphQLDocs fetcher={fetcherFactory(path)} />,
+  render(
+    <GraphQLDocs fetcher={fetcherFactory(path)} />,
     document.getElementById("documentation"),
   );
 };
+

data/app/packs/entrypoints/decidim_api_graphiql.js

@@ -0,0 +1,90 @@
+/* eslint-disable require-jsdoc */
+
+import "entrypoints/decidim_api_graphiql.scss";
+
+import React from "react";
+import ReactDOM from "react-dom";
+
+import GraphiQL from "graphiql";
+import Configuration from "src/decidim/configuration"
+
+window.Decidim = window.Decidim || {};
+window.Decidim.config = new Configuration()
+
+let parameters = {};
+
+// Parse the search string to get url parameters.
+const search = window.location.search;
+search.substr(1).split("&").forEach(function (entry) {
+  let eq = entry.indexOf("=");
+  if (eq >= 0) {
+    parameters[decodeURIComponent(entry.slice(0, eq))] =
+      decodeURIComponent(entry.slice(eq + 1));
+  }
+});
+// if variables was provided, try to format it.
+if (parameters.variables) {
+  try {
+    parameters.variables =
+      JSON.stringify(JSON.parse(parameters.variables), null, 2);
+  } catch (error) {
+    // Do nothing, we want to display the invalid JSON as a string, rather
+    // than present an error.
+  }
+}
+
+const updateURL = function() {
+  const newSearch = Object.keys(parameters).map(function (key) {
+    return `${encodeURIComponent(key)}=${encodeURIComponent(parameters[key])}`;
+  }).join("&");
+
+  history.replaceState(null, null, `?${newSearch}`);
+}
+
+// When the query and variables string is edited, update the URL bar so
+// that it can be easily shared
+const onEditQuery = function(newQuery) {
+  parameters.query = newQuery;
+  updateURL();
+}
+
+const onEditVariables = function(newVariables) {
+  parameters.variables = newVariables;
+  updateURL();
+}
+
+// Defines a GraphQL fetcher using the fetch API.
+const graphQLFetcher = function(graphQLParams) {
+  const graphQLEndpoint = window.Decidim.config.get("graphql_endpoint");
+  return fetch(graphQLEndpoint, {
+    method: "post",
+    headers: JSON.parse(window.Decidim.config.get("request_headers")),
+    body: JSON.stringify(graphQLParams),
+    credentials: "include"
+  }).then(function(response) {
+    try {
+      return response.json();
+    } catch (error) {
+      return {
+        "status": response.status,
+        "message": "The server responded with invalid JSON, this is probably a server-side error",
+        "response": response.text()
+      };
+    }
+  })
+}
+
+window.addEventListener("DOMContentLoaded", () => {
+  // Render <GraphiQL /> into the body.
+  ReactDOM.render(
+    React.createElement(GraphiQL, {
+      fetcher: graphQLFetcher,
+      defaultQuery: window.Decidim.config.get("default_query"),
+      query: parameters.query,
+      variables: parameters.variables,
+      onEditQuery: onEditQuery,
+      onEditVariables: onEditVariables
+    }),
+    document.getElementById("graphiql-container")
+  )
+});

data/app/packs/entrypoints/decidim_api_graphiql.scss

@@ -0,0 +1,10 @@
+html,
+body,
+#graphiql-container{
+  height: 100%;
+  margin: 0;
+  overflow: hidden;
+  width: 100%;
+}
+
+@import "graphiql/graphiql.css";

data/app/views/decidim/api/graphiql/show.html.erb

@@ -0,0 +1,24 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= Decidim::GraphiQL::Rails.config.title || "Decidim API" %></title>
+    <%= stylesheet_pack_tag("decidim_api_graphiql") %>
+    <%= javascript_pack_tag("decidim_api_graphiql") %>
+  </head>
+  <body>
+    <div id="graphiql-container">
+      Loading...
+    </div>
+
+    <%
+      js_configs = {
+        graphql_endpoint: graphql_endpoint_path,
+        default_query: Decidim::GraphiQL::Rails.config.initial_query,
+        request_headers: JSON.pretty_generate(Decidim::GraphiQL::Rails.config.resolve_headers(self))
+      }
+    %>
+    <script>
+      window.Decidim.config.set(<%== js_configs.to_json %>);
+    </script>
+  </body>
+</html>

data/app/views/layouts/decidim/api/documentation.html.erb

@@ -1,8 +1,8 @@
 <html>
   <head>
     <title><%= current_organization.name %> - API Documentation</title>
-    <%= javascript_include_tag "decidim/api/docs" %>
-    <%= stylesheet_link_tag "decidim/api/docs" %>
+    <%= javascript_pack_tag "decidim_api_docs" %>
+    <%= stylesheet_pack_tag "decidim_api_docs" %>
     <style>
     </style>
   </head>

data/config/assets.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+base_path = File.expand_path("..", __dir__)
+
+Decidim::Webpacker.register_path("#{base_path}/app/packs")
+Decidim::Webpacker.register_entrypoints(
+  decidim_api_docs: "#{base_path}/app/packs/entrypoints/decidim_api_docs.js",
+  decidim_api_graphiql: "#{base_path}/app/packs/entrypoints/decidim_api_graphiql.js"
+)

data/lib/decidim/api/engine.rb

@@ -1,9 +1,21 @@
 # frozen_string_literal: true
 
 require "graphql"
-require "graphiql/rails"
 require "rack/cors"
-require "sprockets/es6"
+
+require "decidim/core"
+require "decidim/api/graphiql/config"
+
+if ActiveSupport::Inflector.method(:inflections).arity.zero?
+  # Rails 3 does not take a language in inflections.
+  ActiveSupport::Inflector.inflections do |inflect|
+    inflect.acronym("GraphiQL")
+  end
+else
+  ActiveSupport::Inflector.inflections(:en) do |inflect|
+    inflect.acronym("GraphiQL")
+  end
+end
 
 module Decidim
   module Api
@@ -11,10 +23,6 @@ module Decidim
     class Engine < ::Rails::Engine
       isolate_namespace Decidim::Api
 
-      initializer "decidim_api.assets" do |app|
-        app.config.assets.precompile += %w(decidim_api_manifest.js decidim_api_manifest.css)
-      end
-
       initializer "decidim-api.middleware" do |app|
         app.config.middleware.insert_before 0, Rack::Cors do
           allow do
@@ -25,7 +33,7 @@ module Decidim
       end
 
       initializer "decidim-api.graphiql" do
-        GraphiQL::Rails.config.tap do |config|
+        Decidim::GraphiQL::Rails.config.tap do |config|
           config.query_params = true
           config.initial_query = File.read(
             File.join(__dir__, "graphiql-initial-query.txt")

data/lib/decidim/api/graphiql/config.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Decidim
+  module GraphiQL
+    module Rails
+      class Config
+        # @example Adding a header to the request
+        #    config.headers["My-Header"] = -> (view_context) { "My-Value" }
+        #
+        # @return [Hash<String => Proc>] Keys are headers to include in GraphQL requests, values are `->(view_context) { ... }` procs to determin values
+        attr_accessor :headers
+
+        attr_accessor :query_params, :initial_query, :csrf, :title, :logo
+
+        DEFAULT_HEADERS = {
+          "Content-Type" => ->(_) { "application/json" }
+        }.freeze
+
+        CSRF_TOKEN_HEADER = {
+          "X-CSRF-Token" => ->(view_context) { view_context.form_authenticity_token }
+        }.freeze
+
+        # rubocop:disable Metrics/ParameterLists
+        def initialize(query_params: false, initial_query: nil, title: nil, logo: nil, csrf: true, headers: DEFAULT_HEADERS)
+          @query_params = query_params
+          @headers = headers.dup
+          @initial_query = initial_query
+          @title = title
+          @logo = logo
+          @csrf = csrf
+        end
+        # rubocop:enable Metrics/ParameterLists
+
+        # Call defined procs, add CSRF token if specified
+        def resolve_headers(view_context)
+          all_headers = DEFAULT_HEADERS.merge(headers)
+
+          all_headers = all_headers.merge(CSRF_TOKEN_HEADER) if csrf
+
+          all_headers.transform_values do |value|
+            value.call(view_context)
+          end
+        end
+      end
+
+      class << self
+        attr_accessor :config
+      end
+
+      self.config = Config.new
+    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.24.0"
+      "0.25.0.rc1"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-api
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.25.0.rc1
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -10,28 +10,8 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-03-26 00:00:00.000000000 Z
+date: 2021-07-28 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: graphiql-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: graphql
   requirement: !ruby/object:Gem::Requirement
@@ -86,76 +66,62 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.5.1
-- !ruby/object:Gem::Dependency
-  name: sprockets-es6
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: decidim-comments
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.0.rc1
 - !ruby/object:Gem::Dependency
   name: decidim-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.0.rc1
 - !ruby/object:Gem::Dependency
   name: decidim-dev
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.0.rc1
 - !ruby/object:Gem::Dependency
   name: decidim-participatory_processes
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.24.0
+        version: 0.25.0.rc1
 description: API engine for decidim
 email:
 - josepjaume@gmail.com
@@ -167,22 +133,25 @@ extra_rdoc_files: []
 files:
 - README.md
 - Rakefile
-- app/assets/config/decidim_api_manifest.css
-- app/assets/config/decidim_api_manifest.js
-- app/assets/javascripts/decidim/api/docs.js.es6
-- app/assets/stylesheets/decidim/api/docs.scss
 - app/controllers/decidim/api/application_controller.rb
 - app/controllers/decidim/api/documentation_controller.rb
 - app/controllers/decidim/api/graphiql_controller.rb
 - app/controllers/decidim/api/queries_controller.rb
 - app/helpers/decidim/api/application_helper.rb
+- app/packs/entrypoints/decidim_api_docs.js
+- app/packs/entrypoints/decidim_api_graphiql.js
+- app/packs/entrypoints/decidim_api_graphiql.scss
+- app/packs/stylesheets/decidim/api/docs.scss
 - app/views/decidim/api/documentation/show.html.erb
+- app/views/decidim/api/graphiql/show.html.erb
 - app/views/layouts/decidim/api/documentation.html.erb
+- config/assets.rb
 - config/routes.rb
 - docs/usage.md
 - lib/decidim/api.rb
 - lib/decidim/api/engine.rb
 - lib/decidim/api/graphiql-initial-query.txt
+- lib/decidim/api/graphiql/config.rb
 - lib/decidim/api/mutation_type.rb
 - lib/decidim/api/query_type.rb
 - lib/decidim/api/schema.rb
@@ -199,9 +168,6 @@ files:
 - 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
-- vendor/assets/javascripts/decidim/api/react.js
 homepage: https://github.com/decidim/decidim
 licenses:
 - AGPL-3.0
@@ -217,11 +183,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: Decidim API module