Decidim CiviCRM integration module

This module provides certain integrations in order to use CiviCRM with Decidim.

Currently, the implementation supported is using CiviCRM 5.3 with Drupal 7.8.

Features:

• Omniauth integration (aka: "Login with CiviCRM")
• Verification handler for all users logged via Omniauth. Handler: civicrm
• Verification handler for every group available in CiviCRM (and intelligent groups). Handler: groups
• Contact & groups synchronization to internal Rails models
• Administrator interface to enable which user/groups must be synchronized
• Ability to sincronize users from groups in CiviCRM automatically with private participatory space members
• Ability to redirect users to external url after joining a meeting (admin configurable)

Install

Add into the Gemfile

gem "decidim-civicrm", git: "https://github.com/Platoniq/decidim-module-civicrm", branch: "main"

Install dependencies:

bundle

Install (and run) migrations:

bundle exec rails decidim_civicrm:install:migrations
bundle exec rails db:migrate

Configuration

Customize your integration by creating an initializer (ie: config/initializes/decidim_civicrm.rb) and set some of the variables:

# config/initializers/decidim_civicrm.rb

Decidim::Civicrm.configure do |config|
  # Configure api credentials
  config.api =   {
    key: Rails.application.secrets.dig(:civicrm, :api, :key),
    secret: Rails.application.secrets.dig(:civicrm, :api, :secret),
    url: Rails.application.secrets.dig(:civicrm, :api, :url)
  }

  # Configure omniauth secrets
  config.omniauth =   {
    client_id: Rails.application.secrets.dig(:omniauth, :civicrm, :client_id),
    client_secret: Rails.application.secrets.dig(:omniauth, :civicrm, :client_secret),
    site: Rails.application.secrets.dig(:omniauth, :civicrm, :site)
  }

  # whether to send notifications to user when they auto-verified or not:
  config.send_verification_notifications = false

  # Optional: enable or disable verification methods (all enableD by default)
  config.authorizations = [:civicrm, :civicrm_groups]
end

IMPORTANT: Remember to activate the verification methods (civicrm and civicrm_groups) in the Decidim /system admin page

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/Platoniq/decidim-module-civicrm.

Developing

To start contributing to this project, first:

• Install the basic dependencies (such as Ruby and PostgreSQL)
• Clone this repository

Decidim's main repository also provides a Docker configuration file if you prefer to use Docker instead of installing the dependencies locally on your machine.

You can create the development app by running the following commands after cloning this project:

$ bundle
$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake development_app

Note that the database user has to have rights to create and drop a database in order to create the dummy test app database.

Then to test how the module works in Decidim, start the development server:

$ cd development_app
$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rails s

In case you are using rbenv and have the rbenv-vars plugin installed for it, you can add the environment variables to the root directory of the project in a file named .rbenv-vars. If these are defined for the environment, you can omit defining these in the commands shown above.

Code Styling

Please follow the code styling defined by the different linters that ensure we are all talking with the same language collaborating on the same project. This project is set to follow the same rules that Decidim itself follows.

Rubocop linter is used for the Ruby language.

You can run the code styling checks by running the following commands from the console:

$ bundle exec rubocop

To ease up following the style guide, you should install the plugin to your favorite editor, such as:

• Atom - linter-rubocop
• Sublime Text - Sublime RuboCop
• Visual Studio Code - Rubocop for Visual Studio Code

Testing

To run the tests run the following in the gem development path:

$ bundle
$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rake test_app
$ DATABASE_USERNAME=<username> DATABASE_PASSWORD=<password> bundle exec rspec

Note that the database user has to have rights to create and drop a database in order to create the dummy test app database.

In case you are using rbenv and have the rbenv-vars plugin installed for it, you can add these environment variables to the root directory of the project in a file named .rbenv-vars. In this case, you can omit defining these in the commands shown above.

Test code coverage

If you want to generate the code coverage report for the tests, you can use the SIMPLECOV=1 environment variable in the rspec command as follows:

$ SIMPLECOV=1 bundle exec rspec

This will generate a folder named coverage in the project root which contains the code coverage report.

Localization

If you would like to see this module in your own language, you can help with its translation at Crowdin:

https://crowdin.com/project/decidim-module-civicrm

License

See LICENSE-AGPLv3.txt.