decidim-odoo 0.1.0

data/db/migrate/20230713143501_create_decidim_odoo_users.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class CreateDecidimOdooUsers < ActiveRecord::Migration[6.0]
+  def change
+    create_table :decidim_odoo_users do |t|
+      t.references :decidim_organization, null: false, foreign_key: { to_table: :decidim_organizations }, index: { name: :index_odoo_users_on_decidim_organization_id }
+      t.references :decidim_user, null: false, foreign_key: { to_table: :decidim_users }, index: { name: :index_odoo_users_on_decidim_user_id }
+
+      t.integer :odoo_user_id
+      t.string :ref
+      t.boolean :coop_candidate, default: false
+      t.boolean :member, default: false
+
+      t.timestamps
+
+      t.index %w(decidim_organization_id odoo_user_id), name: "index_unique_odoo_user_and_organization", unique: true
+      t.index %w(decidim_organization_id ref), name: "index_unique_ref_and_organization", unique: true
+    end
+  end
+end

data/lib/decidim/odoo/admin.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Odoo
+    # This module contains all the domain logic associated to the decidim-odoo
+    # module admin panel.
+    module Admin
+    end
+  end
+end

data/lib/decidim/odoo/admin_engine.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Odoo
+    # This is the engine that runs on the admin interface of decidim-odoo.
+    class AdminEngine < ::Rails::Engine
+      isolate_namespace Decidim::Odoo::Admin
+
+      paths["db/migrate"] = nil
+      paths["lib/tasks"] = nil
+
+      routes do
+        resources :members, only: [:index] do
+          collection do
+            get :sync
+          end
+        end
+
+        root to: "members#index"
+      end
+
+      initializer "decidim_odoo.webpacker.assets_path" do
+        Decidim.register_assets_path File.expand_path("app/packs", root)
+      end
+
+      initializer "decidim.odoo.mount_admin_engine" do
+        Decidim::Core::Engine.routes do
+          mount Decidim::Odoo::AdminEngine, at: "/admin/odoo", as: "decidim_odoo_admin"
+        end
+      end
+
+      initializer "decidim.odoo.admin_menu" do
+        Decidim.menu :admin_menu do |menu|
+          menu.add_item :odoo,
+                        "Odoo",
+                        decidim_odoo_admin.members_path,
+                        icon_name: "people",
+                        position: 5.75,
+                        active: is_active_link?(decidim_odoo_admin.members_path, :inclusive),
+                        if: defined?(current_user) && current_user&.read_attribute("admin")
+        end
+      end
+
+      def load_seed
+        nil
+      end
+    end
+  end
+end

data/lib/decidim/odoo/api/base/base_query.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Odoo
+    module Api
+      module Base
+        class BaseQuery
+          attr_reader :result, :request
+
+          def response
+            @request.response
+          end
+
+          protected
+
+          def parsed_response
+            raise NotImplementedError
+          end
+
+          def store_result
+            @result = parsed_response
+            @result = @result.deep_symbolize_keys if @result.is_a? Hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/odoo/api/base/request.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Odoo
+    module Api
+      module Base
+        class Request
+          def initialize(verify_ssl: true)
+            @verify_ssl = verify_ssl
+          end
+
+          attr_accessor :response, :body
+
+          %w(get post).each do |method|
+            define_singleton_method(method) do |path, params: {}, headers: {}, verify_ssl: true|
+              instance = Request.new(verify_ssl: verify_ssl)
+              response = instance.connection.public_send(method, instance.url(path)) do |request|
+                request.params = instance.base_params.merge(params)
+                request.headers = instance.base_headers.merge(headers)
+              end
+
+              raise Decidim::Odoo::Error, response.reason_phrase unless response.success?
+
+              instance.response = JSON.parse(response.body)
+              instance
+            end
+          end
+
+          def connection
+            @connection ||= Faraday.new(ssl: { verify: @verify_ssl })
+          end
+
+          def url(path)
+            "#{Decidim::Odoo::Api.base_url}/#{path}"
+          end
+
+          def base_params
+            {}
+          end
+
+          def base_headers
+            { "api-key" => Decidim::Odoo::Api.api_key }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/decidim/odoo/api/find_partner.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Odoo
+    module Api
+      class FindPartner < Base::BaseQuery
+        def initialize(ref)
+          @request = Base::Request.get("partner/#{ref}")
+
+          store_result
+        end
+
+        protected
+
+        def parsed_response
+          response
+        end
+      end
+    end
+  end
+end

data/lib/decidim/odoo/api/find_partner_by_vat.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Decidim
+  module Odoo
+    module Api
+      class FindPartnerByVat < Base::BaseQuery
+        def initialize(vat)
+          @request = Base::Request.get("partner", params: { vat: vat })
+
+          store_result
+        end
+
+        protected
+
+        def parsed_response
+          response
+        end
+      end
+    end
+  end
+end

data/lib/decidim/odoo/api.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "api/base/base_query"
+require_relative "api/base/request"
+require_relative "api/find_partner"
+require_relative "api/find_partner_by_vat"
+
+module Decidim
+  module Odoo
+    # This namespace holds the logic to connect to the Odoo REST API.
+    module Api
+      def self.config
+        Decidim::Odoo.api
+      end
+
+      def self.api_key
+        config[:api_key]
+      end
+
+      def self.base_url
+        config[:base_url]
+      end
+    end
+  end
+end

data/lib/decidim/odoo/engine.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "omniauth/strategies/odoo_keycloak"
+
+module Decidim
+  module Odoo
+    # This is the engine that runs on the public interface of odoo.
+    class Engine < ::Rails::Engine
+      isolate_namespace Decidim::Odoo
+
+      config.to_prepare do
+        Decidim::User.include(Decidim::Odoo::UserOverride)
+      end
+
+      initializer "decidim_odoo.omniauth" do
+        next unless Decidim::Odoo.keycloak_omniauth && Decidim::Odoo.keycloak_omniauth[:client_id]
+
+        Rails.application.config.middleware.use OmniAuth::Builder do
+          provider :odoo_keycloak, Decidim::Odoo.keycloak_omniauth[:client_id], Decidim::Odoo.keycloak_omniauth[:client_secret],
+                   client_options: Decidim::Odoo.keycloak_omniauth[:client_options]
+        end
+      end
+
+      initializer "decidim_odoo.user_sync" do
+        ActiveSupport::Notifications.subscribe "decidim.user.omniauth_registration" do |_name, data|
+          Decidim::Odoo::OmniauthUserSyncJob.perform_later(data) if data[:provider] == Decidim::Odoo::OMNIAUTH_PROVIDER_NAME
+        end
+        ActiveSupport::Notifications.subscribe "decidim.odoo.user.updated" do |_name, data|
+          Decidim::Odoo::AutoVerificationJob.perform_later(data)
+        end
+      end
+
+      initializer "decidim_odoo.authorizations" do
+        next unless Decidim::Odoo.authorizations
+
+        if Decidim::Odoo.authorizations.include?(:odoo_member)
+          Decidim::Verifications.register_workflow(:odoo_member) do |workflow|
+            workflow.form = "Decidim::Odoo::Verifications::OdooMember"
+          end
+        end
+      end
+
+      initializer "decidim_odoo.webpacker.assets_path" do
+        Decidim.register_assets_path File.expand_path("app/packs", root)
+      end
+    end
+  end
+end

data/lib/decidim/odoo/test/factories.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "decidim/core/test/factories"
+
+module Decidim::Odoo::Faker
+  class << self
+    def vat
+      "ES#{Faker::IDNumber.spanish_citizen_number.tr("-", "")}"
+    end
+  end
+end
+
+FactoryBot.define do
+  factory :odoo_user, class: "Decidim::Odoo::User" do
+    user
+    organization { user.organization }
+    odoo_user_id { Faker::Number.between(from: 1, to: 100_000) }
+    ref { Faker::Number.between(from: 1, to: 100_000).to_s }
+    coop_candidate { false }
+    member { false }
+  end
+end

data/lib/decidim/odoo/test/shared_contexts.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+shared_context "with stubs example api" do
+  let(:http_method) { :get }
+  let(:http_status) { 200 }
+  let(:data) { { "foo" => "bar" } }
+  let(:params) { {} }
+
+  before do
+    stub_request(http_method, /api\.example\.org/).to_return(status: http_status, body: data.to_json, headers: {})
+  end
+end
+
+shared_examples_for "no authorization is created" do
+  it "does not create an authorization" do
+    expect { subject.perform_now(params) }.not_to change(Decidim::Authorization, :count)
+  end
+end

data/lib/decidim/odoo/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Decidim
+  # This holds the decidim-meetings version.
+  module Odoo
+    VERSION = "0.1.0"
+    DECIDIM_VERSION = "0.26.7"
+    COMPAT_DECIDIM_VERSION = [">= 0.25.0", "< 0.27"].freeze
+  end
+end

data/lib/decidim/odoo.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require "decidim/odoo/admin"
+require "decidim/odoo/admin_engine"
+require "decidim/odoo/api"
+require "decidim/odoo/engine"
+
+module Decidim
+  # This namespace holds the logic of the `Odoo` component. This component
+  # allows users to create odoo in a participatory space.
+  module Odoo
+    include ActiveSupport::Configurable
+
+    OMNIAUTH_PROVIDER_NAME = "odoo_keycloak"
+
+    config_accessor :api do
+      {
+        base_url: ENV["ODOO_API_BASE_URL"].presence,
+        api_key: ENV["ODOO_API_API_KEY"].presence
+      }
+    end
+
+    config_accessor :keycloak_omniauth do
+      {
+        enabled: ENV["OMNIAUTH_ODOO_KEYCLOAK_CLIENT_ID"].present?,
+        client_id: ENV["OMNIAUTH_ODOO_KEYCLOAK_CLIENT_ID"].presence,
+        client_secret: ENV["OMNIAUTH_ODOO_KEYCLOAK_CLIENT_SECRET"].presence,
+        client_options: {
+          site: ENV["OMNIAUTH_ODOO_KEYCLOAK_SITE"].presence,
+          realm: ENV["OMNIAUTH_ODOO_KEYCLOAK_REALM"].presence
+        },
+        icon_path: ENV["OMNIAUTH_ODOO_KEYCLOAK_ICON_PATH"].presence || "media/images/odoo_logo.svg"
+      }
+    end
+
+    config_accessor :authorizations do
+      [:odoo_member]
+    end
+
+    class Error < StandardError; end
+  end
+end

data/lib/generators/decidim/odoo/install_generator.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Decidim
+  module Odoo
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        desc "This generator modifies secrets file adding odoo to omniauth methods"
+        def secrets
+          case Rails.env
+          when "development"
+            inject_into_file "development_app/config/secrets.yml", after: "icon: phone" do
+              <<~YAML
+                |
+                |    odoo_keycloak:
+                |      enabled: true
+                |      icon_path: media/images/odoo_logo.svg
+              YAML
+                .gsub(/^ *\|/, "").rstrip
+            end
+          when "test"
+            inject_into_file "spec/decidim_dummy_app/config/secrets.yml", after: "app_secret: fake-facebook-app-secret" do
+              <<~YAML
+                |
+                |    odoo_keycloak:
+                |      enabled: false
+                |      icon_path: media/images/odoo_logo.svg
+              YAML
+                .gsub(/^ *\|/, "").rstrip
+            end
+          end
+        end
+
+        desc "This generator copies the initializer file"
+        def initializers
+          Dir.chdir(Rails.env.test? ? "spec/decidim_dummy_app" : "development_app") do
+            FileUtils.cp(
+              "#{__dir__}/templates/#{Rails.env}_odoo_config.rb",
+              "config/initializers/odoo_config.rb"
+            )
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/decidim/odoo/templates/development_odoo_config.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+Decidim::Odoo.configure do |config|
+  # Configure api credentials
+  config.api = {
+    base_url: ENV["ODOO_API_BASE_URL"].presence,
+    api_key: ENV["ODOO_API_API_KEY"].presence
+  }
+
+  # Configure omniauth secrets
+  config.keycloak_omniauth = {
+    enabled: ENV["OMNIAUTH_ODOO_KEYCLOAK_CLIENT_ID"].present?,
+    client_id: ENV["OMNIAUTH_ODOO_KEYCLOAK_CLIENT_ID"].presence,
+    client_secret: ENV["OMNIAUTH_ODOO_KEYCLOAK_CLIENT_SECRET"].presence,
+    client_options: {
+      site: ENV["OMNIAUTH_ODOO_KEYCLOAK_SITE"].presence,
+      realm: ENV["OMNIAUTH_ODOO_KEYCLOAK_REALM"].presence
+    },
+    icon_path: ENV["OMNIAUTH_ODOO_KEYCLOAK_ICON_PATH"].presence || "media/images/odoo_logo.svg"
+  }
+end

data/lib/generators/decidim/odoo/templates/test_odoo_config.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+Decidim::Odoo.configure do |config|
+  # Configure api credentials
+  config.api = {
+    base_url: "https://test.odoo.api.example.org",
+    api_key: "test-api-key"
+  }
+
+  # Configure omniauth secrets
+  config.keycloak_omniauth = {
+    enabled: true,
+    client_id: "test-client-id",
+    client_secret: "test-client-secret",
+    client_options: {
+      site: "https://test.odoo.oauth.example.org",
+      realm: "test-realm"
+    }
+  }
+end

data/lib/omniauth/strategies/odoo_keycloak.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "omniauth-keycloak"
+
+module OmniAuth
+  module Strategies
+    class OdooKeycloak < OmniAuth::Strategies::KeycloakOpenId
+      option :name, "odoo_keycloak"
+
+      uid { odoo_info[:ref] }
+
+      info do
+        {
+          nickname: odoo_info[:vat],
+          name: odoo_info[:name],
+          email: odoo_info[:email]
+        }
+      end
+
+      def odoo_info
+        @odoo_info ||= ::Decidim::Odoo::Api::FindPartnerByVat.new(raw_info["preferred_username"]).result
+      end
+    end
+  end
+end

data/lib/tasks/decidim_odoo.rake

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+namespace :decidim do
+  namespace :odoo do
+    # invoke with 'bundle exec rake "civicrm:sync:groups"'
+
+    namespace :sync do
+      desc "Sync members with Odoo API"
+      task members: :environment do
+        Decidim::Organization.find_each do |organization|
+          Decidim::Odoo::SyncUsersJob.perform_later(organization.id)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: decidim-odoo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Francisco Bolívar
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: decidim-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+- !ruby/object:Gem::Dependency
+  name: omniauth-keycloak
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: decidim-dev
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.25.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+description: A Decidim module to sync Odoo users who connect to the platform using
+  Keycloak OpenID OAuth.
+email:
+- francisco.bolivar@nazaries.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE-AGPLv3.txt
+- README.md
+- Rakefile
+- app/commands/decidim/odoo/sync_user.rb
+- app/controllers/concerns/decidim/odoo/admin/members/filterable.rb
+- app/controllers/decidim/odoo/admin/members_controller.rb
+- app/forms/decidim/odoo/verifications/odoo_member.rb
+- app/helpers/decidim/odoo/admin/odoo_helper.rb
+- app/jobs/decidim/odoo/auto_verification_job.rb
+- app/jobs/decidim/odoo/omniauth_user_sync_job.rb
+- app/jobs/decidim/odoo/sync_users_job.rb
+- app/models/concerns/decidim/odoo/user_override.rb
+- app/models/decidim/odoo/user.rb
+- app/packs/entrypoints/decidim_odoo.js
+- app/packs/images/odoo_logo.svg
+- app/views/decidim/odoo/admin/members/index.html.erb
+- config/assets.rb
+- config/i18n-tasks.yml
+- config/locales/en.yml
+- db/migrate/20230713143501_create_decidim_odoo_users.rb
+- lib/decidim/odoo.rb
+- lib/decidim/odoo/admin.rb
+- lib/decidim/odoo/admin_engine.rb
+- lib/decidim/odoo/api.rb
+- lib/decidim/odoo/api/base/base_query.rb
+- lib/decidim/odoo/api/base/request.rb
+- lib/decidim/odoo/api/find_partner.rb
+- lib/decidim/odoo/api/find_partner_by_vat.rb
+- lib/decidim/odoo/engine.rb
+- lib/decidim/odoo/test/factories.rb
+- lib/decidim/odoo/test/shared_contexts.rb
+- lib/decidim/odoo/version.rb
+- lib/generators/decidim/odoo/install_generator.rb
+- lib/generators/decidim/odoo/templates/development_odoo_config.rb
+- lib/generators/decidim/odoo/templates/test_odoo_config.rb
+- lib/omniauth/strategies/odoo_keycloak.rb
+- lib/tasks/decidim_odoo.rake
+homepage: https://github.com/decidim/decidim-module-odoo
+licenses:
+- AGPL-3.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A decidim odoo module
+test_files: []