omniauth-decidim 0.1.0

data/README.md

@@ -0,0 +1,64 @@
+# OmniAuth::Decidim
+
+This is the [Decidim](https://github.com/decidim/decim) strategy for OmniAuth. It should be used when using a Decidim application as an OAuth provider.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-decidim', git: 'https://github.com/decidim/omniauth-decidim'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Configure the Decidim application which acts as the OAuth provider
+
+You need to create an OAuth application at your Decidim provider installation in order to get the Client ID, Client Secret and Site parameters. Check [Decidim's related documentation](https://docs.decidim.org/en/services/social_providers/#_decidim) in how to configure the Decidim social provider.
+
+### Configure the Decidim OAuth clients
+
+Enable `:decidim` as an OmniAuth strategy in the client application. To do it, set the `omniauth/decidim/enabled` key to true in `config/secrets.yml` .
+Optionally, the strategy can be further configured by also adding the `client_id`, `client_secret` and `site_url` keys with the values you got from your Decidim provider installation. This setting will be shared amongst all organizations in the instance, but can be selectively overriden in each organization's system administration panel.
+
+This is an example `config/secrets.yml`:
+
+```ruby
+  omniauth:
+    decidim:
+      enabled: true
+      client_id: <%= ENV["DECIDIM_CLIENT_ID"] %>
+      client_secret: <%= ENV["DECIDIM_CLIENT_SECRET"] %>
+      site_url: <%= ENV["DECIDIM_SITE_URL"] %>
+```
+
+Since Decidim v0.22.0, once enabled, the `:decidim` omniauth client strategy will be automatically loaded at boot time. Thus, there's no need to tell Devise about the omniauth strategy.
+
+## Authentication Hash
+
+An example auth hash available in `request.env['omniauth.auth']`:
+
+```ruby
+{
+  :provider => "decidim",
+  :uid => "123456",
+  :info => {
+    :nickname => "foobar",
+    :name => "Foo Bar",
+    :email => "foo@bar.com",
+    :image => "http://www.example.org/avatar.jpeg",
+  },
+  :credentials => {
+    :token => "a1b2c3d4...", # The OAuth 2.0 access token
+    :secret => "abcdef1234"
+  }
+}
+```
+
+## Following our license
+
+If you plan to release your application you'll need to publish it using the same license: GPL Affero 3. We recommend doing that on GitHub before publishing, you can read more on "[Being Open Source From Day One is Especially Important for Government Projects](http://producingoss.com/en/governments-and-open-source.html#starting-open-for-govs)". If you have any trouble you can contact us on [Gitter](https://gitter.im/decidim/decidim).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "omniauth/decidim"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omniauth/decidim/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Omniauth
+  module Decidim
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/decidim.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "omniauth/decidim/version"
+require "omniauth/strategies/decidim"

data/lib/omniauth/strategies/decidim.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "omniauth-oauth2"
+require "open-uri"
+
+module OmniAuth
+  module Strategies
+    class Decidim < OmniAuth::Strategies::OAuth2
+      args [:client_id, :client_secret, :site]
+
+      option :name, :decidim
+      option :site, nil
+      option :client_options, {}
+
+      uid do
+        raw_info["id"]
+      end
+
+      info do
+        {
+          email: raw_info["email"],
+          nickname: raw_info["nickname"],
+          name: raw_info["name"],
+          image: raw_info["image"]
+        }
+      end
+
+      def client
+        options.client_options[:site] = options.site
+        options.client_options[:authorize_url] = URI.join(options.site, "/oauth/authorize").to_s
+        options.client_options[:token_url] = URI.join(options.site, "/oauth/token").to_s
+        super
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("/oauth/me").parsed
+      end
+
+      # https://github.com/intridea/omniauth-oauth2/issues/81
+      def callback_url
+        full_host + script_name + callback_path
+      end
+    end
+  end
+end

data/omniauth-decidim.gemspec

@@ -0,0 +1,30 @@
+
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "omniauth/decidim/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "omniauth-decidim"
+  spec.version = Omniauth::Decidim::VERSION
+  spec.authors = ["Oriol Gual"]
+  spec.email = ["oriol@codegram.com"]
+
+  spec.summary = "OmniAuth strategy for Decidim"
+  spec.description = "OmniAuth strategy for Decidim"
+  spec.license = "AGPL-3.0"
+  spec.homepage = "https://github.com/decidim/omniauth-decidim"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "omniauth", "~> 1.5"
+  spec.add_dependency "omniauth-oauth2", ">= 1.4.0", "< 2.0"
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-decidim
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Oriol Gual
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  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: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: OmniAuth strategy for Decidim
+email:
+- oriol@codegram.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE-AGPLv3.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth/decidim.rb
+- lib/omniauth/decidim/version.rb
+- lib/omniauth/strategies/decidim.rb
+- omniauth-decidim.gemspec
+homepage: https://github.com/decidim/omniauth-decidim
+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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for Decidim
+test_files: []