decidim-system 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50acb919493651bd5ad9897250e52372538f872e
-  data.tar.gz: 7e76fb5f1bf9fc6cb0fb25e1a384c8dac7711b2e
+  metadata.gz: 2c1e17e92f4d745c061701294e94aa16f21c2c2b
+  data.tar.gz: 6eee551e0453c5e95d03ae3bf0f1ab4c562e042c
 SHA512:
-  metadata.gz: fff304f54eb28d60a34cf60bfa88330cb0d99b8dc44596539d9c4bbb54df7239ff0f83f0f11c56633069e60d95af4765adfc108fd1719502d7a9e76cccccbbcf
-  data.tar.gz: 87d57032b097afb23dcd1be547fa773d4664309663efa3000e48f6602d9310f898e934bc9c4a58cd236fd89a53f63ea9ddc241e48b27cc3b8f29fd4a671352c6
+  metadata.gz: 2da66c51684f0885600c8262662de381eab489a1a0bf4a2d633b0bcf41a3be71f16190eac8a29e7184a705e97dc86cdd07ff9ec16b55ab07e35874b87b7a3ad5
+  data.tar.gz: bc71de0f4c691aeaecd41dce1479c4d8131ab86f01ad47e4608dd1b1de48077f5dbee2205337ce7404bea9370b2ed1200c3f1afe67c5728a8ddb1b60eb4b6672

data/README.md

@@ -1,10 +1,12 @@
 # Decidim::System
-Short description and motivation.
+
+This engine adds an administration dashboard so admin can manage a Decidim deploy
+and its organizations when working in a multi-tenant environment.
 
 ## Usage
-How to use my plugin.
 
-## Installation
+`decidim-system` is already included in the `decidim` gem, but you can also include it separately:
+
 Add this line to your application's Gemfile:
 
 ```ruby
@@ -16,13 +18,48 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install decidim-system
+## Multi-tenancy in Decidim
+
+A single Decidim deploy can be used by multiple organizations (tenants) at the same time. All resources and entities are always scoped to an organization.
+
+When using Decidim as multi-tenant, you should keep these in mind:
+
+* All organizations share the same database.
+* Each organization must have a different hostname.
+* Users aren't shared between each organization (the same email can be registered in different organizations and it will be considered as different users).
+* All configuration related to Decidim (`Decidim.config`) is shared between the organizations.
+* Stylesheets aren't customizable per-tenant so UI styles (colors and other variables) are shared.
+
+## Glossary
+
+* **Organization**: Each of the tenants using a Decidim deploy.
+* **System admin**: Users that can manage organizations in a Decidim deploy.
+* **Admins**: Users that can manage a **single** organization in a Decidim deploy.
+* **Participatory process admins**: Users that can manage a **single participatory process** in an organization in a Decidim deploy.
+
+## Managing System admins
+
+Currently Decidim doesn't provide a way to create the first System Admin in a new deployment. To do it, you should open a Rails console in your application and
+create it:
+
+```ruby
+Decidim::System::Admin.create!(
+  email: "your-email@example.org",
+  password: "your-safe-password",
+  password_confirmation: "your-safe-password"
+)
 ```
 
-## Contributing
-Contribution directions go here.
+Once you have created your first admin you can access the system dashboard at `https://your-decidim-deployment-host/system` and login with your newly created user.
+From the system dashboard you can add new admins.
+
+## Managing organizations
+
+Once you have your system admin setup you can also start managing the organizations in your deploy. To do it, login at the system dashboard and create a new organization
+following the form instructions. After creating it, a new admin user will be created and invited to start managing it.
+
+Remember that System admins and regular Admins are completely different users (they don't even share the same database table), so you can't use your
+system user to login in as an organization admin.
 
 ## License
 The gem is available as open source under the terms of the [AGPLv3 License](https://opensource.org/licenses/AGPL-3.0).

data/app/commands/decidim/system/register_organization.rb

@@ -42,7 +42,10 @@ module Decidim
         Decidim::Organization.create!(
           name: form.name,
           host: form.host,
+          secondary_hosts: form.clean_secondary_hosts,
+          reference_prefix: form.reference_prefix,
           available_locales: form.available_locales,
+          available_authorizations: form.clean_available_authorizations,
           default_locale: form.default_locale
         )
       end

data/app/commands/decidim/system/update_organization.rb

@@ -42,6 +42,8 @@ module Decidim
       def save_organization
         organization.name = form.name
         organization.host = form.host
+        organization.secondary_hosts = form.clean_secondary_hosts
+        organization.available_authorizations = form.clean_available_authorizations
 
         organization.save!
       end

data/app/controllers/decidim/system/application_controller.rb

@@ -4,10 +4,12 @@ module Decidim
     # The main application controller that inherits from Rails.
     class ApplicationController < ActionController::Base
       include FormFactory
+      include PayloadInfo
       protect_from_forgery with: :exception, prepend: true
 
       helper Decidim::TranslationsHelper
       helper Decidim::DecidimFormHelper
+      helper Decidim::ReplaceButtonsHelper
     end
   end
 end

data/app/forms/decidim/system/register_organization_form.rb

@@ -12,6 +12,7 @@ module Decidim
       attribute :organization_admin_name, String
       attribute :available_locales, Array
       attribute :default_locale, String
+      attribute :reference_prefix
 
       validates :organization_admin_email, :organization_admin_name, :name, :host, presence: true
       validates :available_locales, presence: true

data/app/forms/decidim/system/update_organization_form.rb

@@ -12,9 +12,27 @@ module Decidim
 
       attribute :name, String
       attribute :host, String
+      attribute :secondary_hosts, String
+      attribute :available_authorizations, Array[String]
 
+      validates :name, presence: true
+      validates :host, presence: true
       validate :validate_organization_uniqueness
 
+      def map_model(model)
+        self.secondary_hosts = model.secondary_hosts.join("\n")
+      end
+
+      def clean_secondary_hosts
+        return unless secondary_hosts
+        secondary_hosts.split("\n").map(&:chomp).select(&:present?)
+      end
+
+      def clean_available_authorizations
+        return unless available_authorizations
+        available_authorizations.select(&:present?)
+      end
+
       private
 
       def validate_organization_uniqueness

data/app/views/decidim/system/organizations/edit.html.erb

@@ -7,6 +7,16 @@
     <%= f.text_field :host %>
   </div>
 
+  <div class="field">
+    <%= f.text_area :secondary_hosts %>
+    <p class="help-text"><%= t(".secondary_hosts_hint") %></p>
+  </div>
+
+  <div class="field">
+    <%= f.label :available_authorizations %>
+    <%= f.collection_check_boxes :available_authorizations, Decidim.authorization_handlers, :name, :name %>
+  </div>
+
   <div class="actions">
     <%= f.submit t("decidim.system.actions.save") %>
   </div>

data/app/views/decidim/system/organizations/new.html.erb

@@ -7,10 +7,19 @@
     <%= f.text_field :name, autofocus: true %>
   </div>
 
+  <div class="field">
+    <%= f.text_field :reference_prefix %>
+  </div>
+
   <div class="field">
     <%= f.text_field :host %>
   </div>
 
+  <div class="field">
+    <%= f.text_area :secondary_hosts %>
+    <p class="help-text"><%= t(".secondary_hosts_hint") %></p>
+  </div>
+
   <div class="field">
     <%= f.text_field :organization_admin_name %>
   </div>
@@ -20,29 +29,34 @@
   </div>
 
   <%= f.fields_for :locales do |fields| %>
-  <div class="field">
-    <%= f.label :organization_locales, '', class: @form.respond_to?(:errors) && @form.errors[:default_locale].present? ? "is-invalid-label" : "" %>
-    <table>
-      <thead>
-        <tr>
-          <td>Locale</td>
-          <td>Enabled <%= f.error_for(:available_locales) %></td>
-          <td>Default? <%= f.error_for(:default_locale) %></td>
-        </tr>
-      </thead>
-      <tbody>
-        <% localized_locales.each do |locale| %>
+    <div class="field">
+      <%= f.label :organization_locales, '', class: @form.respond_to?(:errors) && @form.errors[:default_locale].present? ? "is-invalid-label" : "" %>
+      <table>
+        <thead>
           <tr>
-            <td><%= locale.name %></td>
-            <td><%= check_box_tag "organization[available_locales][#{locale.id}]", locale.id, @form.available_locales.include?(locale.id) %></td>
-            <td><%= radio_button_tag "organization[default_locale]", locale.id, @form.default_locale == locale.id %></td>
+            <td>Locale</td>
+            <td>Enabled <%= f.error_for(:available_locales) %></td>
+            <td>Default? <%= f.error_for(:default_locale) %></td>
           </tr>
-        <% end %>
-      </tbody>
-    </table>
-  </div>
+        </thead>
+        <tbody>
+          <% localized_locales.each do |locale| %>
+            <tr>
+              <td><%= locale.name %></td>
+              <td><%= check_box_tag "organization[available_locales][#{locale.id}]", locale.id, @form.available_locales.include?(locale.id) %></td>
+              <td><%= radio_button_tag "organization[default_locale]", locale.id, @form.default_locale == locale.id %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
   <% end %>
 
+  <div class="field">
+    <%= f.label :available_authorizations %>
+    <%= f.collection_check_boxes :available_authorizations, Decidim.authorization_handlers, :name, :name %>
+  </div>
+
   <div class="actions">
     <%= f.submit t("decidim.system.models.organization.actions.save_and_invite") %>
   </div>

data/config/locales/ca.yml

@@ -54,9 +54,12 @@ ca:
         create:
           error: S'ha produït un error en crear una nova organització.
           success: L'organització s'ha creat correctament.
+        edit:
+          secondary_hosts_hint: Introdueix cada un d'ells en una nova línia
         index:
           title: Organitzacions
         new:
+          secondary_hosts_hint: Introdueix cada un d'ells en una nova línia
           title: Nova organització
         update:
           error: S'ha produït un error en actualitzar aquesta organització.

data/config/locales/en.yml

@@ -55,9 +55,12 @@ en:
         create:
           error: There was an error when creating a new organization.
           success: Organization created successfully.
+        edit:
+          secondary_hosts_hint: Enter each one of them in a new line
         index:
           title: Organizations
         new:
+          secondary_hosts_hint: Enter each one of them in a new line
           title: New organization
         update:
           error: There was an error when updating this organization.

data/config/locales/es.yml

@@ -54,9 +54,12 @@ es:
         create:
           error: Se ha producido un error al crear una nueva organización.
           success: Organización creada correctamente.
+        edit:
+          secondary_hosts_hint: Introduce cada uno de ellos en una nueva línea
         index:
           title: Organizaciones
         new:
+          secondary_hosts_hint: Introduce cada uno de ellos en una nueva línea
           title: Nueva organización
         update:
           error: Se ha producido un error al actualizar esta organización.

data/config/locales/eu.yml

@@ -1,6 +1,9 @@
 eu:
   decidim:
     system:
+      admins:
+        create:
+          success: Admin sortu da
       models:
         admin:
           fields:

data/config/locales/fi.yml

@@ -0,0 +1,68 @@
+fi:
+  decidim:
+    system:
+      actions:
+        confirm_destroy: Haluatko varmasti poistaa tämän?
+        destroy: Poista
+        edit: Muokkaa
+        new: Uusi %{name}
+        save: Tallenna
+        title: Toiminnot
+      admins:
+        create:
+          error: Uuden hallinnoijan luonnissa tapahtui virhe.
+          success: Hallinnoija luotu onnistuneesti
+        destroy:
+          success: Hallinnoija poistettu onnistuneesti
+        edit:
+          title: Muokkaa hallinnoijaa
+          update: Päivitä hallinnoija
+        index:
+          title: Hallinnoijat
+        new:
+          create: Luo hallinnoija
+          title: Uusi hallinnoija
+        update:
+          error: Hallinnoijan päivityksessä tapahtui virhe.
+          success: Hallinnoija päivitetty onnistuneesti
+      default_pages:
+        placeholders:
+          content: Lisää sisältöä tälle sivulle hallintapaneelista.
+          title: Oletusotsikko sivulle %{page}
+      menu:
+        admins: Hallinnoijat
+        dashboard: Hallintapaneeli
+        organizations: Organisaatiot
+      models:
+        admin:
+          fields:
+            created_at: Luotu
+            email: Sähköposti
+          name: Hallinnoija
+          validations:
+            email_uniqueness: toinen hallinnointikäyttäjä on jo olemassa samalla sähköpostilla
+        organization:
+          actions:
+            save_and_invite: Luo organisaatioita ja kutsu hallinnointikäyttäjiä
+          fields:
+            created_at: Luotu
+            name: Nimi
+          name: Organisaatio
+        page:
+          name: Sivu
+      organizations:
+        create:
+          error: Uuden organisaation luonnissa tapahtui virhe.
+          success: Organisaatio luotu onnistuneesti.
+        edit:
+          secondary_hosts_hint: Syötä jokainen niistä omalle rivilleen
+        index:
+          title: Organisaatiot
+        new:
+          secondary_hosts_hint: Syötä jokainen niistä omalle rivilleen
+          title: Uusi organisaatio
+        update:
+          error: Organisaation päivityksessä tapahtui virhe.
+          success: Organisaatio päivitetty onnistuneesti.
+      titles:
+        dashboard: Hallintapaneeli

data/db/seeds.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 if !Rails.env.production? || ENV["SEED"]
   Decidim::System::Admin.create!(
-    email: "system@decidim.org",
+    email: "system@example.org",
     password: "decidim123456",
     password_confirmation: "decidim123456"
   )

data/lib/decidim/system/engine.rb

@@ -9,6 +9,7 @@ require "jquery-rails"
 require "sassc-rails"
 require "foundation-rails"
 require "foundation_rails_helper"
+require "autoprefixer-rails"
 require "rectify"
 
 module Decidim

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: decidim-system
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Josep Jaume Rey Peroy
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-17 00:00:00.000000000 Z
+date: 2017-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: decidim-core
@@ -18,34 +18,28 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0.1
+        version: 5.0.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.0.0
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 5.0.0.1
+        version: 5.0.2
 - !ruby/object:Gem::Dependency
   name: devise
   requirement: !ruby/object:Gem::Requirement
@@ -94,14 +88,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.7.0
+        version: 1.7.1
 - !ruby/object:Gem::Dependency
   name: sassc-rails
   requirement: !ruby/object:Gem::Requirement
@@ -164,14 +158,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.0.5
+        version: 0.0.6
 description: System administration to create new organization in an installation.
 email:
 - josepjaume@gmail.com
@@ -238,6 +232,7 @@ files:
 - config/locales/en.yml
 - config/locales/es.yml
 - config/locales/eu.yml
+- config/locales/fi.yml
 - config/routes.rb
 - db/migrate/20160919105637_devise_create_decidim_admins.rb
 - db/seeds.rb