omniauth-dex-energy 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: db21340318e6c6ec779b2ec49ceb443b2081d28d1f8a00f93609cf586ae99214
-  data.tar.gz: a173e8118f3c4f21d144b01ca4abdcce995b043ac3a50a2af7b0f7af41ed5c59
+  metadata.gz: 5dbe074b75d13e2fcf1e9eb2cc415f4fe585f4a9052dbb7f5692174cdd09c30a
+  data.tar.gz: f2458ef0c2c3c17b18a43b28e1cadcee00eee3061289ab574bd500f56c30c442
 SHA512:
-  metadata.gz: 15ee58797637d3598e51a380bb51f8e5fda5027f6fac39a5cd3648da7422b11e640e0413bc6ff8903a1490bc97b2e0734ab013b6dff05427961dc654645867e4
-  data.tar.gz: ce2d105652dae81d7146be104b2648ce6476c51941cf16f38c037c161b6ecaeed487da52161bb820f9487ba122fa5975cc264dbdf80c70648bdbcc8b7355f2e7
+  metadata.gz: 55565e958123c8652f7869acb2f5f39daae32f46f6745afe23f45af2e9c0fbd2f318d8446e61686d315029aedad2906389e8b75a47f220f3fafbc4d0af659583
+  data.tar.gz: 94e73012a8600ab4cdb63677bf27938a9dd1d93da0882680add3f51d6d5ebb4963a5231571ca56a7267769c0ad4b38852c37d9aecdcf1c9fbbb5d9af12fc5ddb

data/README.md

@@ -1,20 +1,22 @@
 # omniauth-dex-energy
 
 ![CI](https://github.com/greensync/omniauth-dex-energy/workflows/CI/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/omniauth-dex-energy.png)](https://badge.fury.io/rb/omniauth-dex-energy)
 
 An OmniAuth strategy to authenticate with deX.
 
 ## Table of Contents
 
 - [omniauth-dex-energy](#omniauth-dex-energy)
-  - [Table of Contents](#table-of-contents)
-  - [Installation](#installation)
-  - [Usage](#usage)
-    - [First Steps](#first-steps)
-    - [Sinatra](#sinatra)
-  - [Development](#development)
-  - [Contributing](#contributing)
-  - [License](#license)
+    - [Table of Contents](#table-of-contents)
+    - [Installation](#installation)
+    - [Usage](#usage)
+        - [First Steps](#first-steps)
+        - [Sinatra](#sinatra)
+    - [Development](#development)
+        - [Releasing a new version](#releasing-a-new-version)
+    - [Contributing](#contributing)
+    - [License](#license)
 
 ## Installation
 
@@ -26,11 +28,15 @@ gem 'omniauth-dex-energy'
 
 And then execute:
 
-    $ bundle install
+```sh
+bundle install
+```
 
 Or install it yourself as:
 
-    $ gem install omniauth-dex-energy
+```sh
+gem install omniauth-dex-energy
+```
 
 ## Usage
 
@@ -59,7 +65,16 @@ bundle exec foreman start
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+### Releasing a new version
+
+First, create and push a git tag off HEAD.
+
+- bump `version.rb`; commit and push
+- run `bin/publish-gem`
+
+This will publish the gem to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 

data/bin/publish-gem

@@ -2,7 +2,5 @@
 
 set -Eeuo pipefail
 
-version=$(git describe --exact-match HEAD)
-
 gem build omniauth-dex-energy
-gem push omniauth-dex-energy-${version}.gem
+gem push omniauth-dex-energy-*.gem

data/examples/sinatra/Gemfile.lock

@@ -11,7 +11,7 @@ GEM
     mustermann (1.1.0)
       ruby2_keywords (~> 0.0.1)
     nio4r (2.5.2)
-    oauth2 (1.4.3)
+    oauth2 (1.4.4)
       faraday (>= 0.8, < 2.0)
       jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
@@ -20,12 +20,12 @@ GEM
     omniauth (1.9.0)
       hashie (>= 3.4.6, < 3.7.0)
       rack (>= 1.6.2, < 3)
-    omniauth-dex-energy (0.1.0)
-      omniauth-oauth2 (~> 1.6.0)
+    omniauth-dex-energy (0.1.1)
+      omniauth-oauth2 (~> 1.6)
     omniauth-oauth2 (1.6.0)
       oauth2 (~> 1.1)
       omniauth (~> 1.9)
-    puma (4.3.1)
+    puma (4.3.3)
       nio4r (~> 2.0)
     rack (2.2.2)
     rack-protection (2.0.8.1)
@@ -53,4 +53,4 @@ DEPENDENCIES
   slim
 
 BUNDLED WITH
-   2.1.2
+   2.1.4

data/examples/sinatra/app.rb

@@ -31,7 +31,14 @@ get '/auth/dex_energy/callback' do
 end
 
 get '/logout' do
-  # Log the user out of their session in the app - but not in the Identity Provider.
+  # Log the user out of their session in the app, and then redirect them to the IdP
+  # so that it can log them out.
+  # The user will be redirect back to us afterwards.
   session.delete(:user)
-  redirect request.referrer
+
+  logout_url = OmniAuth::Strategies::DexEnergy.logout_uri(
+    client_id: oauth2_client_id,
+    redirect_uri: to('/'),
+  )
+  redirect logout_url
 end

data/lib/omniauth/strategies/dex_energy.rb

@@ -6,9 +6,13 @@ require 'omniauth-oauth2'
 module OmniAuth
   module Strategies
     class DexEnergy < OmniAuth::Strategies::OAuth2
+      DEFAULT_SITE = 'https://who.dex.energy'
+
       option :name, 'dex_energy'
 
-      option :client_options, site: 'https://who.dex.energy', auth_scheme: :basic_auth
+      option :client_options, site: DEFAULT_SITE, auth_scheme: :basic_auth
+
+      option :authorize_params, scope: 'openid'
 
       uid do
         raw_info['sub']
@@ -26,6 +30,16 @@ module OmniAuth
         }
       end
 
+      class << self
+        def logout_uri(client_id:, redirect_uri:, site: nil)
+          site ||= DEFAULT_SITE
+
+          encoded_redirect_uri = URI.encode_www_form_component(redirect_uri)
+
+          "#{site}/oauth/logout?client_id=#{client_id}&redirect_uri=#{encoded_redirect_uri}"
+        end
+      end
+
       private
 
       def raw_info

data/omniauth-dex-energy.gemspec

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-gem_version = `git describe --exact-match HEAD`.strip
+require_relative 'version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'omniauth-dex-energy'
-  spec.version       = gem_version
+  spec.version       = VERSION
   spec.authors       = ['Cera Davies', 'Nick Burgin', 'Mike Williams']
   spec.email         = [
     'internalplatform@greensync.com.au',
@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'pry-byebug', '~> 3.8.0'
-  spec.add_development_dependency 'rack', '~> 1.6.0'
+  spec.add_development_dependency 'rack', '~> 2.2.3'
   spec.add_development_dependency 'rake', '~> 12.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.77'

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-dex-energy
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Cera Davies
 - Nick Burgin
 - Mike Williams
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-28 00:00:00.000000000 Z
+date: 2020-07-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
@@ -60,14 +60,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 2.2.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.6.0
+        version: 2.2.3
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -152,7 +152,7 @@ metadata:
   homepage_uri: https://github.com/greensync/omniauth-dex-energy
   source_code_uri: https://github.com/greensync/omniauth-dex-energy
   changelog_uri: https://github.com/greensync/omniauth-dex-energy/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -168,7 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: an OmniAuth strategy for authenticating with deX
 test_files: []