decidim 0.0.1.alpha7 → 0.0.1.alpha8

data/decidim-api/README.md

@@ -0,0 +1,28 @@
+# Decidim::Api
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'decidim-admin'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install decidim-admin
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [AGPLv3 License](https://opensource.org/licenses/AGPL-3.0).

data/decidim-api/Rakefile

@@ -0,0 +1,27 @@
+# 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/controllers/decidim/api/application_controller.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Decidim
+  module Api
+    # Base controller for `decidim-api`. All other controllers inherit from this.
+    class ApplicationController < ActionController::Base
+      include NeedsOrganization
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# 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 QueriesController < ApplicationController
+      def create
+        query_string = params[:query]
+        query_variables = ensure_hash(params[:variables])
+        result = Schema.execute(query_string, variables: query_variables, context: context)
+        render json: result
+      end
+
+      private
+
+      def context
+        {
+          current_organization: current_organization
+        }
+      end
+
+      def ensure_hash(query_variables)
+        if query_variables.blank?
+          {}
+        elsif query_variables.is_a?(String)
+          JSON.parse(query_variables)
+        else
+          query_variables
+        end
+      end
+    end
+  end
+end

data/decidim-api/app/schemas/decidim/api/schema.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+module Decidim
+  module Api
+    # Main GraphQL schema for decidim's API.
+    Schema = GraphQL::Schema.define do
+      query QueryType
+    end
+  end
+end

data/decidim-api/app/types/decidim/api/localized_string_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+module Decidim
+  module Api
+    # This type represents a localized string in a single language.
+    LocalizedStringType = GraphQL::ObjectType.define do
+      name "LocalizedStringFieldType"
+      description "Represents a particular translation of a LocalizedStringType"
+
+      field :locale, !types.String, "The standard locale of this translation."
+      field :text, types.String, "The content of this translation."
+    end
+  end
+end

data/decidim-api/app/types/decidim/api/process_step_type.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module Decidim
+  module Api
+    # This type represents a step on a participatory process.
+    ProcessStepType = GraphQL::ObjectType.define do
+      name "ParticipatoryProcessStep"
+      description "A participatory process step"
+
+      field :id, !types.ID, "The unique ID of this step."
+
+      field :process do
+        type ProcessType
+        description "The participatory process in which this step belongs to."
+        property :participatory_process
+      end
+
+      field :title, TranslatedFieldType, "The title of this step"
+
+      field :shortDescription do
+        type TranslatedFieldType
+        description "A short description of the step."
+        property :short_description
+      end
+    end
+  end
+end

data/decidim-api/app/types/decidim/api/process_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+module Decidim
+  module Api
+    # This type represents a ParticipatoryProcess.
+    ProcessType = GraphQL::ObjectType.define do
+      name "ParticipatoryProcess"
+      description "A participatory process"
+
+      field :id, !types.ID, "The Process' unique ID"
+
+      field :title, TranslatedFieldType, "The title of this process."
+
+      connection :steps, ProcessStepType.connection_type do
+        description "All the steps of this process."
+      end
+    end
+  end
+end

data/decidim-api/app/types/decidim/api/query_type.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+module Decidim
+  module Api
+    # This type represents the root type of the whole API.
+    QueryType = GraphQL::ObjectType.define do
+      name "Query"
+      description "The root query of this schema"
+
+      field :processes do
+        type !types[ProcessType]
+        description "Lists all processes."
+
+        resolve ->(_obj, _args, ctx) {
+          ctx[:current_organization].participatory_processes
+        }
+      end
+    end
+  end
+end

data/decidim-api/app/types/decidim/api/translated_field_type.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+module Decidim
+  module Api
+    # This type represents a translated field in multiple languages.
+    TranslatedFieldType = GraphQL::ObjectType.define do
+      name "TranslatedFieldType"
+      description "A translated field"
+
+      field :locales do
+        type types[types.String]
+        description "Lists all the locales in which this translation is available"
+        resolve ->(obj, _args, _ctx) { obj.keys }
+      end
+
+      field :translations do
+        type !types[LocalizedStringType]
+        description "All the localized strings for this translation."
+
+        argument :locales do
+          type types[types.String]
+          description "A list of locales to scope the translations to."
+        end
+
+        resolve ->(obj, args, _ctx) {
+          translations = obj.stringify_keys
+          translations = translations.slice(*args["locales"]) if args["locales"]
+
+          translations.map { |locale, text| OpenStruct.new(locale: locale, text: text) }
+        }
+      end
+
+      field :translation do
+        type types.String
+        description "Returns a single translation given a locale."
+        argument :locale, types.String, "A locale to search for"
+
+        resolve ->(obj, args, _ctx) {
+          translations = obj.stringify_keys
+          translations[args["locale"]]
+        }
+      end
+    end
+  end
+end

data/decidim-api/bin/rails

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+# This command will automatically be run when you run "rails" with Rails gems
+# installed from the root of your application.
+
+ENGINE_ROOT = File.expand_path("../..", __FILE__)
+ENGINE_PATH = File.expand_path("../../lib/decidim/api/engine", __FILE__)
+
+# Set up gems listed in the Gemfile.
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile", __FILE__)
+require "bundler/setup" if File.exist?(ENV["BUNDLE_GEMFILE"])
+
+require "rails/all"
+require "rails/engine/commands"

data/decidim-api/config/routes.rb

@@ -0,0 +1,6 @@
+# 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"
+end

data/decidim-api/decidim-api.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require_relative "../decidim-core/lib/decidim/core/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |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 "rack-cors", "~> 0.4.0"
+
+  s.add_development_dependency "decidim-dev", Decidim.version
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require "decidim/api/engine"
+
+module Decidim
+  # This module holds all business logic related to exposing a Public API for
+  # decidim.
+  module Api
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require "graphql"
+require "graphiql/rails"
+require "rack/cors"
+
+module Decidim
+  module Api
+    # Mountable engine that exposes a side-wide API for Decidim.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::Api
+
+      initializer "decidim-api.middleware" do |app|
+        app.config.middleware.insert_before 0, Rack::Cors do
+          allow do
+            origins "*"
+            resource "*", headers: :any, methods: [:get, :post, :options]
+          end
+        end
+      end
+    end
+  end
+end

data/decidim-api/lib/tasks/decidim/api_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :decidim_api do
+#   # Task goes here
+# end

data/decidim-api/spec/controllers/queries_controller_spec.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+module Decidim
+  module Api
+    describe QueriesController, type: :controller do
+      let!(:participatory_process) { create(:participatory_process) }
+      let!(:other_participatory_process) { create(:participatory_process) }
+
+      before do
+        @request.env["decidim.current_organization"] = participatory_process.organization
+      end
+
+      it "executes a query" do
+        post :create, params: { query: "{ processes { id }}" }
+
+        parsed_response = JSON.parse(response.body)["data"]
+        expect(parsed_response["processes"]).to eq(["id" => participatory_process.id.to_s])
+      end
+    end
+  end
+end

data/decidim-api/spec/factories.rb

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

data/decidim-api/spec/schemas/schema_spec.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require "spec_helper"
+
+module Decidim
+  module Api
+    describe Schema do
+      let!(:current_user) { create(:user) }
+      let!(:current_organization) { current_user.organization }
+
+      def execute_query(query, variables = {})
+        described_class.execute(
+          query,
+          context: {
+            current_organization: current_organization,
+            current_user: current_user
+          },
+          variables: variables
+        )
+      end
+
+      describe "processes" do
+        let!(:process1) { create(:participatory_process, organization: current_organization) }
+        let!(:process2) { create(:participatory_process, organization: current_organization) }
+        let!(:process3) { create(:participatory_process) }
+
+        let(:query) { %({ processes { id } }) }
+
+        it "returns all the processes" do
+          result = execute_query(query)
+
+          expect(result["data"]["processes"]).to     include("id" => process1.id.to_s)
+          expect(result["data"]["processes"]).to     include("id" => process2.id.to_s)
+          expect(result["data"]["processes"]).to_not include("id" => process3.id.to_s)
+        end
+      end
+    end
+  end
+end

data/decidim-api/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+ENV["ENGINE_NAME"] = File.dirname(File.dirname(__FILE__)).split("/").last
+require "decidim/test/base_spec_helper"

data/decidim-api/spec/support/type_helpers.rb

@@ -0,0 +1,46 @@
+module Decidim
+  module Api
+    module TypeHelpers
+      extend ActiveSupport::Concern
+
+      included do
+        let!(:current_organization) { create(: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
+      end
+
+      def execute_query(query, variables = {})
+        result = schema.execute(
+          query,
+          context: {
+            current_organization: current_organization
+          },
+          variables: variables
+        )
+
+        raise Exception, result["errors"].map { |e| e["message"] }.join(", ") if result["errors"]
+        result["data"]["type"]
+      end
+    end
+  end
+end