decidim 0.0.1.alpha9 → 0.0.1

data/decidim-api/README.md

@@ -1,14 +1,20 @@
 # Decidim::Api
-Short description and motivation.
+
+This library exposes a [GraphQL](https://facebook.github.io/graphql/) API to programatically interact with the Decidim platform via HTTP.
 
 ## Usage
-How to use my plugin.
+Including `decidim-api` will get expose two nice endpoints:
+
+* `/api`: The main GraphQL endpoint that holds the actual API.
+* `/api/docs`: Nicely-written docs of the entities of the API.
+* `/api/grapiql`: A neat sandbox to interactively play with the API and its capabilities.
+
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'decidim-admin'
+gem 'decidim-api'
 ```
 
 And then execute:
@@ -16,13 +22,8 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install decidim-admin
-```
-
 ## Contributing
-Contribution directions go here.
+See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).
 
 ## License
-The gem is available as open source under the terms of the [AGPLv3 License](https://opensource.org/licenses/AGPL-3.0).
+See [Decidim](https://github.com/AjuntamentdeBarcelona/decidim).

data/decidim-api/Rakefile

@@ -1,27 +1,2 @@
 # frozen_string_literal: true
-
 require "decidim/common_rake"
-require "rdoc/task"
-
-RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = "rdoc"
-  rdoc.title    = "Decidim::Api"
-  rdoc.options << "--line-numbers"
-  rdoc.rdoc_files.include("README.md")
-  rdoc.rdoc_files.include("lib/**/*.rb")
-end
-
-load "rails/tasks/statistics.rake"
-
-require "bundler/gem_tasks"
-
-begin
-  require "rspec/core/rake_task"
-  RSpec::Core::RakeTask.new(:spec)
-  ENV["ENGINE_PATH"] = File.dirname(__FILE__)
-
-  task default: :spec
-
-  Rake::Task["spec"].enhance ["common:test_app"]
-rescue LoadError
-end

data/decidim-api/app/assets/config/decidim_api_manifest.js

@@ -0,0 +1 @@
+//= link decidim/api/docs.js

data/decidim-api/app/assets/javascripts/decidim/api/docs.js.es6

@@ -0,0 +1,23 @@
+// = require jquery
+// = require decidim/api/react
+// = require decidim/api/react-dom
+// = require decidim/api/graphql-docs
+
+const fetcherFactory = (path) => {
+  return (query) => {
+    return jQuery.ajax({
+      url: path,
+      data: JSON.stringify({ query }),
+      method: 'POST',
+      contentType: 'application/json',
+      dataType: 'json'
+    });
+  };
+}
+
+window.renderDocumentation = (path) => {
+  ReactDOM.render(
+    <GraphQLDocs.GraphQLDocs fetcher={fetcherFactory(path)} />,
+    document.getElementById('documentation'),
+  );
+};

data/decidim-api/app/controllers/decidim/api/documentation_controller.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Decidim
+  module Api
+    # This controller takes queries from an HTTP endpoint and sends them out to
+    # the Schema to be executed, later returning the response as JSON.
+    class DocumentationController < Api::ApplicationController
+      layout "decidim/api/documentation"
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ module Decidim
   module Api
     # This controller takes queries from an HTTP endpoint and sends them out to
     # the Schema to be executed, later returning the response as JSON.
-    class QueriesController < ApplicationController
+    class QueriesController < Api::ApplicationController
       def create
         query_string = params[:query]
         query_variables = ensure_hash(params[:variables])
@@ -15,7 +15,8 @@ module Decidim
 
       def context
         {
-          current_organization: current_organization
+          current_organization: current_organization,
+          current_user: current_user
         }
       end
 

data/decidim-api/app/views/decidim/api/documentation/show.html.erb

@@ -0,0 +1,10 @@
+<div style="text-align: center;">
+  <h1><%= current_organization.name %> API documentation</h1>
+  <%=link_to "Explore the API interactively with GraphiQL", graphiql_path %>
+</div>
+
+<div id="documentation"></div>
+
+<script>
+ window.renderDocumentation("<%= root_path %>");
+</script>

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

@@ -0,0 +1,9 @@
+<html>
+  <head>
+    <title><%= current_organization.name %> - API Documentation</title>
+    <%= javascript_include_tag 'decidim/api/docs', 'data-turbolinks-track': 'reload' %>
+  </head>
+  <body>
+    <%= yield %>
+  </body>
+</html>

data/decidim-api/config/routes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 Decidim::Api::Engine.routes.draw do
-  mount GraphiQL::Rails::Engine, at: "/graphiql", graphql_path: "/api"
-  get "/", to: redirect("/api/graphiql")
-  post "/" => "queries#create"
+  mount GraphiQL::Rails::Engine, at: "/graphiql", graphql_path: "/api", as: :graphiql
+  get "/docs", to: "documentation#show", as: :documentation
+  get "/", to: redirect("/api/docs")
+  post "/" => "queries#create", as: :root
 end

data/decidim-api/decidim-api.gemspec

@@ -6,22 +6,19 @@ require_relative "../decidim-core/lib/decidim/core/version"
 
 # Describe your gem and declare its dependencies:
 Gem::Specification.new do |s|
+  Decidim.add_default_gemspec_properties(s)
+
   s.name        = "decidim-api"
-  s.version     = Decidim.version
-  s.authors     = ["Josep Jaume Rey Peroy", "Marc Riera Casals", "Oriol Gual Oliva"]
-  s.email       = ["josepjaume@gmail.com", "mrc2407@gmail.com", "oriolgual@gmail.com"]
-  s.homepage    = "http://github.com/AjuntamentdeBarcelona/decidim"
   s.summary     = "API engine for decidim"
   s.description = "API engine for decidim"
-  s.license     = "AGPLv3"
 
   s.files = Dir["{app,config,db,lib}/**/*", "LICENSE.txt", "Rakefile", "README.md"]
 
-  s.add_dependency "decidim-core", Decidim.version
-  s.add_dependency "rails", Decidim.rails_version
-  s.add_dependency "graphql", "~> 0.19.4"
-  s.add_dependency "graphiql-rails", "~> 1.3.0"
+  s.add_dependency "rails", *Decidim.rails_version
+  s.add_dependency "graphql", "~> 1.3.0"
+  s.add_dependency "graphiql-rails", "~> 1.4.0"
   s.add_dependency "rack-cors", "~> 0.4.0"
+  s.add_dependency "sprockets-es6", "~> 0.9.2"
 
   s.add_development_dependency "decidim-dev", Decidim.version
 end

data/decidim-api/lib/decidim/api.rb

@@ -5,5 +5,12 @@ module Decidim
   # This module holds all business logic related to exposing a Public API for
   # decidim.
   module Api
+    autoload :MutationType, "decidim/api/types/mutation"
+    autoload :QueryType, "decidim/api/types/query"
+
+    autoload :TranslatedFieldType, "decidim/api/types/translated_field"
+    autoload :LocalizedStringType, "decidim/api/types/localized_string"
+
+    autoload :Schema, "decidim/api/schema"
   end
 end

data/decidim-api/lib/decidim/api/engine.rb

@@ -2,6 +2,7 @@
 require "graphql"
 require "graphiql/rails"
 require "rack/cors"
+require "sprockets/es6"
 
 module Decidim
   module Api
@@ -9,6 +10,10 @@ 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)
+      end
+
       initializer "decidim-api.middleware" do |app|
         app.config.middleware.insert_before 0, Rack::Cors do
           allow do
@@ -17,6 +22,15 @@ module Decidim
           end
         end
       end
+
+      initializer "decidim-api.graphiql" do
+        GraphiQL::Rails.config.tap do |config|
+          config.query_params = true
+          config.initial_query = File.read(
+            File.join(File.dirname(__FILE__), "graphiql-initial-query.txt")
+          ).html_safe
+        end
+      end
     end
   end
 end

data/decidim-api/lib/decidim/api/graphiql-initial-query.txt

@@ -0,0 +1,11 @@
+{
+  processes {
+    id
+    title {
+      translations {
+        locale
+        text
+      }
+    }
+  }
+}

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

@@ -4,6 +4,7 @@ module Decidim
     # Main GraphQL schema for decidim's API.
     Schema = GraphQL::Schema.define do
       query QueryType
+      mutation MutationType
     end
   end
 end

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+RSpec.shared_context "graphql type" do
+  let!(:current_organization) { create(:organization) }
+  let!(:current_user) { create(:user, organization: current_organization) }
+  let(:model) { OpenStruct.new({}) }
+
+  let(:schema) do
+    resolver = ->(_obj, _args, _ctx) { model }
+    type_class = described_class
+
+    query_type = GraphQL::ObjectType.define do
+      name "FakeTestQuery"
+
+      field :type, !type_class do
+        resolve resolver
+      end
+    end
+
+    GraphQL::Schema.define do
+      query query_type
+    end
+  end
+
+  let(:response) do
+    execute_query "{ type #{query}}"
+  end
+
+  def execute_query(query, variables = {})
+    result = schema.execute(
+      query,
+      context: {
+        current_organization: current_organization,
+        current_user: current_user
+      },
+      variables: variables
+    )
+
+    raise Exception, result["errors"].map { |e| e["message"] }.join(", ") if result["errors"]
+    result["data"]["type"]
+  end
+end

data/decidim-api/{app/types/decidim/api/localized_string_type.rb → lib/decidim/api/types/localized_string.rb}

@@ -3,7 +3,7 @@ module Decidim
   module Api
     # This type represents a localized string in a single language.
     LocalizedStringType = GraphQL::ObjectType.define do
-      name "LocalizedStringFieldType"
+      name "LocalizedString"
       description "Represents a particular translation of a LocalizedStringType"
 
       field :locale, !types.String, "The standard locale of this translation."

data/decidim-api/lib/decidim/api/types/mutation.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Decidim
+  module Api
+    # This type represents the root mutation type of the whole API
+    MutationType = GraphQL::ObjectType.define do
+      name "Mutation"
+      description "The root mutation of this schema"
+    end
+  end
+end

data/decidim-api/lib/decidim/api/types/query.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Decidim
+  module Api
+    # This type represents the root query type of the whole API.
+    QueryType = GraphQL::ObjectType.define do
+      name "Query"
+      description "The root query of this schema"
+    end
+  end
+end

data/decidim-api/{app/types/decidim/api/translated_field_type.rb → lib/decidim/api/types/translated_field.rb}

@@ -3,7 +3,7 @@ module Decidim
   module Api
     # This type represents a translated field in multiple languages.
     TranslatedFieldType = GraphQL::ObjectType.define do
-      name "TranslatedFieldType"
+      name "TranslatedField"
       description "A translated field"
 
       field :locales do
@@ -32,7 +32,7 @@ module Decidim
       field :translation do
         type types.String
         description "Returns a single translation given a locale."
-        argument :locale, types.String, "A locale to search for"
+        argument :locale, !types.String, "A locale to search for"
 
         resolve ->(obj, args, _ctx) {
           translations = obj.stringify_keys

data/decidim-api/spec/factories.rb

@@ -1 +1,2 @@
 require_relative "../../decidim-core/spec/factories"
+require_relative "../../decidim-comments/spec/factories"

data/decidim-api/spec/features/documentation_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+describe "Documentation", type: :feature do
+  let(:organization) { create(:organization) }
+
+  before do
+    switch_to_host(organization.host)
+  end
+
+  describe "documentation" do
+    it "shows the project's documentation" do
+      visit decidim_api.documentation_path
+
+      within "h1" do
+        expect(page).to have_content(organization.name)
+      end
+
+      expect(page).to have_content("Root query")
+    end
+  end
+end

data/decidim-api/spec/features/graphiql_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+describe "GraphiQL", type: :feature do
+  let!(:organization) { create(:organization) }
+
+  let!(:participatory_process) do
+    create(:participatory_process, organization: organization)
+  end
+
+  before do
+    switch_to_host(organization.host)
+    visit decidim_api.graphiql_path
+  end
+
+  it "is able to execute the default query" do
+    find(".execute-button").click
+    within ".result-window" do
+      expect(page).to have_content("\"id\": \"#{organization.id}\"")
+    end
+  end
+end

data/decidim-api/spec/types/localized_string_type_spec.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 require "spec_helper"
+require "decidim/api/test/type_context"
 
 module Decidim
   module Api
     describe LocalizedStringType do
-      include TypeHelpers
+      include_context "graphql type"
 
       let(:model) do
         OpenStruct.new(locale: "en", text: "A test locale.")

data/decidim-api/spec/types/mutation_type_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require "spec_helper"
+require "decidim/api/test/type_context"
+
+module Decidim
+  module Api
+    describe MutationType do
+      include_context "graphql type"
+
+      describe "addComment" do
+        let!(:participatory_process) { create(:participatory_process, organization: current_organization) }
+
+        let(:query) { 
+          "{ addComment(commentableId: \"#{participatory_process.id}\", commentableType: \"Decidim::ParticipatoryProcess\", body: \"This is a new comment\") { id, body } }" 
+        }
+
+        it "should create a new comment for the given commentable" do
+          expect(response["addComment"]).to include("body" => "This is a new comment")
+          comment = Decidim::Comments::Comment.last
+          expect(comment.commentable).to eq(participatory_process)
+          expect(response["addComment"]).to include("id" => comment.id.to_s)
+        end
+
+        context "if the query contains an argument alignment" do
+          let(:query) { 
+            "{ addComment(commentableId: \"#{participatory_process.id}\", commentableType: \"Decidim::ParticipatoryProcess\", body: \"This is positive comment\", alignment: 1) { alignment } }" 
+          }
+
+          it "should create a comment with that alignment" do
+            expect(response["addComment"]).to include("alignment" => 1)
+            comment = Decidim::Comments::Comment.last
+            expect(comment.alignment).to eq(1)
+          end
+        end
+      end
+    end
+  end
+end