omniauth-digitalocean 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 570bb5803a60b925bc0e4887acd7357ef6a06a5e99743d9bfad405ed89bc9ea4
-  data.tar.gz: 7fd81e141f01263a8ecc20e1e962246bbb564be8f220dd8aa6630943aa55b41e
+  metadata.gz: b45abccf34e5f64011732e0e4bc3e561f0821761913645daaa6cc7b8f5df7446
+  data.tar.gz: b9837b5b7369fe9e658875cf97308238ee5daeaaed966eda8bec1024df2c80ae
 SHA512:
-  metadata.gz: 393b6e6920c1ffe5a99a7768415edb2857d6a8b15f8bac34b511c34d8e6de47e75b31053b710f039cf44c90ea761c7736b7b496aaef115e9f1cf9fb9b07705f5
-  data.tar.gz: cd004a7c54f78e04fe77e1083c1721c4acf67b028569ae6c7dcc14c0ee7ec77872874dadbea4b57ac7b1768efa84225a08783889ef9f88f477d3a51f9d0f08ae
+  metadata.gz: 864b58dd0082be7e73f58cae71db3507cbae47f15d936688dc6abd30c387161696820844bd4dd35ca67bc6a3604b26cce72909612aa5b1af30ea37f71705a9f5
+  data.tar.gz: cc7c71fa365f27b7e0acbb99931788c7142d09d7dac43d942ce25715c3f60ab803e16ead91e47831698f4206a13cdd7602a225fb4bd2539dd0662b0a21817ae3

data/.github/workflows/ci.yaml

@@ -12,25 +12,15 @@ jobs:
       fail-fast: true
       matrix:
         os: [ ubuntu-latest, macos-latest ]
-        ruby: [ 2.5, 2.6, 2.7 ]
+        ruby: [ 2.5, 2.6, 2.7, '3.0' ]
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - uses: ruby/setup-ruby@v1
       with:
         ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
 
-    # Cache dependencies.
-    - uses: actions/cache@v1
-      with:
-        path: vendor/bundle
-        key: bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: |
-          bundle-use-ruby-${{ matrix.os }}-${{ matrix.ruby }}-
-    - name: Setup
-      run: |
-        gem install bundler
-        bundle install --jobs 4 --retry 3
     - name: Test
       run: |
         bundle exec rspec ./spec

data/.github/workflows/release.yaml

@@ -13,18 +13,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
 
-    - uses: actions/setup-ruby@v1
+    - uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 2.6
-
-    - uses: actions/cache@v1
-      with:
-        path: vendor/bundle
-        key: bundle-use-ruby-ubuntu-latest-2.6-${{ hashFiles('**/Gemfile.lock') }}
-        restore-keys: |
-          bundle-use-ruby-ubuntu-latest-2.6-
+        ruby-version: 2.7
 
     - name: Publish to RubyGems
       run: |

data/README.md

@@ -32,13 +32,37 @@ Rails.application.config.middleware.use OmniAuth::Builder do
 end
 ```
 
-- The scope needs to be separated by space and not comma: "public redeploy" instead of "public,redeploy" !
+- The scope needs to be separated by space and not comma: "read write" instead of "read,write" !
 
 For additional information, refer to the [OmniAuth wiki](https://github.com/intridea/omniauth/wiki).
 
 See the [example](https://github.com/digitaloceancloud/omniauth-digitalocean/blob/master/examples/sinatra/config.ru) Sinatra app for full examples
 
-Note: before running example app, please add your application id and secret to ` example/config.ru ` file.
+## Auth Hash Schema
+
+The following information is provided in the auth hash accessible to the callback at `request.env["omniauth.auth"]`:
+
+* `provider` - The OmniAuth provider, i.e. `digitalocean`
+* `uid` - The UUID of the authenticating user
+* `info` - A hash containing information about the user
+  * `uuid` - The UUID of the authenticating user
+  * `name` - The user's display name
+  * `email` - The e-mail of the authenticating user
+  * `team_uuid` - The UUID of the team when authenticated in a team context
+  * `team_name` - The team's display name when authenticated in a team context
+* `credentials` - A hash containing authentication information
+  * `token` - The DigitalOcean OAuth access token
+  * `refresh_token` - A refresh token that can be exchanged for a new OAuth access token
+  * `expires` - Boolean indicating whether the access token has an expiry date
+  * `expires_at` - Timestamp of the expiry time
+* `extra` - Contains extra information returned from the `/v2/account` endpoint of the DigitalOcean API.
+  * `droplet_limit` - The total number of Droplets current user or team may have active at one time
+  * `floating_ip_limit`  - The total number of Floating IPs the current user or team may have
+  * `email` - The email address for the current user
+  * `uuid` - The UUID for the current user.
+  * `email_verified` - If true, the user has verified their account via email
+  * `status` - This value is one of `active`, `warning`, or `locked`
+  * `status_message` - A human-readable message giving more details about the status of the account
 
 ## License
 

data/examples/sinatra/Gemfile

@@ -1,6 +1,7 @@
 source 'https://rubygems.org'
 
 gem 'sinatra'
-gem 'omniauth'
+gem 'omniauth', '~> 2.0'
 gem 'omniauth-digitalocean', :path => '../../'
 gem 'multi_json'
+gem 'thin'

data/examples/sinatra/README.md

@@ -1,7 +1,17 @@
 # Sinatra Example
 
-How to use omniauth-digitalocean strategy with Sinatra.
+A simple example of how to use `omniauth-digitalocean` strategy with Sinatra.
 
 ## Setup
 
-Create an application on http://cloud.digitalocean.com/settings/application and set the ENV variables DIGITALOCEAN_APP_ID and DIGITALOCEAN_SECRET.
+Create an OAuth application in the [DigitalOcean control panel](https://cloud.digitalocean.com/account/api/applications).
+The callback URL should be `http://127.0.0.1:4567/auth/digitalocean/callback`.
+
+Next, set the environment variables `DIGITALOCEAN_APP_ID`
+and `DIGITALOCEAN_SECRET` with the values from the control panel. Then run the
+app with:
+
+    bundle install
+    bundle exec ruby config.ru
+
+Now visit `http://127.0.0.1:4567` in the browser to login via DigitalOcean.

data/examples/sinatra/config.ru

@@ -7,12 +7,22 @@ class DigitalOceanExample < Sinatra::Base
   use Rack::Session::Cookie
 
   get '/' do
-    redirect '/auth/digitalocean'
+    <<~HTML
+      <form method='post' action='/auth/digitalocean'>
+        <input type="hidden" name="authenticity_token" value='#{request.env["rack.session"]["csrf"]}'>
+        <button type='submit'>Login with DigitalOcean</button>
+      </form>
+    HTML
   end
 
   get '/auth/:provider/callback' do
-    content_type 'text/plain'
-    request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
+    auth = request.env["omniauth.auth"]
+    <<~HTML
+      <b>User:</b> #{auth['info']['name']}<br/>
+      <b>Team:</b> #{auth['info']['team_name']}<br/>
+      <b>Full response:</b><br/>
+      <pre>#{JSON.pretty_generate(auth)}</pre>
+    HTML
   end
 
   get '/auth/failure' do

data/lib/omniauth/strategies/digitalocean.rb

@@ -19,13 +19,15 @@ module OmniAuth
         option :client_options, {
           :authorize_url => "#{BASE_URL}/v1/oauth/authorize",
           :token_url => "#{BASE_URL}/v1/oauth/token",
-          :site => BASE_URL
+          :site => BASE_URL,
+          :auth_scheme => :request_body
         }
       else
         option :client_options, {
           :authorize_url => "http://localhost:3000/v1/oauth/authorize",
           :token_url => "http://localhost:3000/v1/oauth/token",
-          :site => "http://localhost:3000"
+          :site => "http://localhost:3000",
+          :auth_scheme => :request_body
         }
       end
 

data/lib/omniauth-digitalocean/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Digitalocean
-    VERSION = "0.3.1"
+    VERSION = "0.3.2"
   end
 end

data/omniauth-digitalocean.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "omniauth", "~> 2.0"
   spec.add_dependency "omniauth-oauth2", "~> 1.0"
+  spec.add_dependency "multi_json", '~> 1.15'
 
   spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-digitalocean
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - DigitalOcean API Engineering team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-22 00:00:00.000000000 Z
+date: 2023-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +178,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Official OmniAuth strategy for Digitalocean