omniauth-digitalocean 0.0.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7a2026f9593fd5db82cbc423791d3d677075ecea
-  data.tar.gz: 2170318d211223151e5aab533e1bb2cee4d7a45e
+SHA256:
+  metadata.gz: 570bb5803a60b925bc0e4887acd7357ef6a06a5e99743d9bfad405ed89bc9ea4
+  data.tar.gz: 7fd81e141f01263a8ecc20e1e962246bbb564be8f220dd8aa6630943aa55b41e
 SHA512:
-  metadata.gz: 45c610ff7a46f2a066f2043db9d6d9600081bdd7c3ebd99f1233f72f5cbbcb7f7ebf3fd7e9b98d03a2c717ec0c025b19c205c5c907bf8491aaa7f2c8c078a005
-  data.tar.gz: 114836396c8bd959a8fd23241824270edac9b3631ad80d389a5c398de420ada5d67330fc0658b3348c0cd0b55608370a58151e7609882ea8d76a48e056a0c754
+  metadata.gz: 393b6e6920c1ffe5a99a7768415edb2857d6a8b15f8bac34b511c34d8e6de47e75b31053b710f039cf44c90ea761c7736b7b496aaef115e9f1cf9fb9b07705f5
+  data.tar.gz: cd004a7c54f78e04fe77e1083c1721c4acf67b028569ae6c7dcc14c0ee7ec77872874dadbea4b57ac7b1768efa84225a08783889ef9f88f477d3a51f9d0f08ae

data/.github/workflows/ci.yaml

@@ -0,0 +1,36 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    strategy:
+      fail-fast: true
+      matrix:
+        os: [ ubuntu-latest, macos-latest ]
+        ruby: [ 2.5, 2.6, 2.7 ]
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    # 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

@@ -0,0 +1,38 @@
+# Publishes Ruby Gem for release when a tag is created
+# that matches the pattern "v*" (ie. v0.1.0).
+name: Publish Ruby Gem
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - uses: actions/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-
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${RUBYGEMS_AUTH_TOKEN}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        RUBYGEMS_AUTH_TOKEN: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/README.md

@@ -36,9 +36,9 @@ end
 
 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/example/sinatra/config.ru) Sinatra app for full examples
+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 applicaation id and secret to ` example/config.ru ` file.
+Note: before running example app, please add your application id and secret to ` example/config.ru ` file.
 
 ## License
 

data/examples/sinatra/README.md

@@ -0,0 +1,7 @@
+# Sinatra Example
+
+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.

data/examples/sinatra/config.ru

@@ -3,22 +3,26 @@ require 'bundler/setup'
 require 'sinatra'
 require 'omniauth-digitalocean'
 
-get '/' do
-  redirect '/auth/digitalocean'
-end
+class DigitalOceanExample < Sinatra::Base
+  use Rack::Session::Cookie
 
-get '/auth/:provider/callback' do
-  content_type 'text/plain'
-  request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
-end
+  get '/' do
+    redirect '/auth/digitalocean'
+  end
 
-get '/auth/failure' do
-  content_type 'text/plain'
-  request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
-end
+  get '/auth/:provider/callback' do
+    content_type 'text/plain'
+    request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
+  end
 
-use Rack::Session::Cookie
+  get '/auth/failure' do
+    content_type 'text/plain'
+    request.env['omniauth.auth'].to_hash.inspect rescue "No Data"
+  end
 
-use OmniAuth::Builder do
-  provider :digitalocean, "2431aea9301744c9243e5777d31d6375cd4d8673f86569e125ad880b8f4f38b3", "a5e779f88e6f8053f400fb917aaa3cf89f23e2f72d85f3e375ebc02b93153787", scope: "read write"
+  use OmniAuth::Builder do
+    provider OmniAuth::Strategies::Digitalocean, ENV["DIGITALOCEAN_APP_ID"], ENV["DIGITALOCEAN_SECRET"], scope: "read write"
+  end
 end
+
+run DigitalOceanExample.run!

data/lib/omniauth-digitalocean/version.rb

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

data/lib/omniauth/strategies/digitalocean.rb

@@ -9,10 +9,11 @@ module OmniAuth
     #    use OmniAuth::Strategies::Digitalocean, 'consumerkey', 'consumersecret', :scope => 'read write', :display => 'plain'
     #
     class Digitalocean < OmniAuth::Strategies::OAuth2
-      AUTHENTICATION_PARAMETERS = %w(display state scope)
+      AUTHENTICATION_PARAMETERS = %w(display account state scope)
       BASE_URL = "https://cloud.digitalocean.com"
+      API_URL = "https://api.digitalocean.com"
 
-      option :name, :digitalocean
+      option :name, "digitalocean"
 
       unless OmniAuth.config.test_mode
         option :client_options, {
@@ -30,14 +31,26 @@ module OmniAuth
 
       option :authorize_options, AUTHENTICATION_PARAMETERS
 
+      extra do
+        raw_info.parsed['account']
+      end
+
       uid do
-        access_token.params['uid']
+        access_token.params['info']['uuid']
       end
 
       info do
         access_token.params['info']
       end
 
+      # Over-ride callback_url definition to maintain
+      # compatability with omniauth-oauth2 >= 1.4.0
+      #
+      # See: https://github.com/intridea/omniauth-oauth2/issues/81
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
       # Hook useful for appending parameters into the auth url before sending
       # to provider.
       def request_phase
@@ -50,6 +63,10 @@ module OmniAuth
         super
       end
 
+      def raw_info
+        @raw_info ||= access_token.get("#{API_URL}/v2/account")
+      end
+
       ##
       # You can pass +display+, +state+ or +scope+ params to the auth request, if
       # you need to set them dynamically. You can also set these options

data/omniauth-digitalocean.gemspec

@@ -5,11 +5,11 @@ require 'omniauth-digitalocean/version'
 Gem::Specification.new do |spec|
   spec.name          = "omniauth-digitalocean"
   spec.version       = Omniauth::Digitalocean::VERSION
-  spec.authors       = ["Phillip Baker"]
-  spec.email         = ["phillip@digitalocean.com"]
-  spec.summary       = %q{Oauth2 strategy for authentication via DO.}
-  spec.description   = %q{Write a longer description. Optional.}
-  spec.homepage      = ""
+  spec.authors       = ["DigitalOcean API Engineering team"]
+  spec.email         = ["api-engineering@digitalocean.com"]
+  spec.summary       = %q{Official OmniAuth strategy for Digitalocean}
+  spec.description   = %q{Official OmniAuth strategy for Digitalocean}
+  spec.homepage      = "https://github.com/digitalocean/omniauth-digitalocean"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -17,10 +17,10 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "omniauth", "~> 1.0"
+  spec.add_dependency "omniauth", "~> 2.0"
   spec.add_dependency "omniauth-oauth2", "~> 1.0"
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 2.7"
   spec.add_development_dependency "rack-test"

data/spec/omniauth/strategies/digitalocean_spec.rb

@@ -1,16 +1,57 @@
 require 'spec_helper'
 
-describe OmniAuth::Strategies::DigitalOcean do
+describe OmniAuth::Strategies::Digitalocean do
   subject do
-    OmniAuth::Strategies::DigitalOcean.new({})
+    described_class.new({})
   end
 
-  context "client options" do
-    it { expect(subject.options.name).to eq(:digitalocean) }
+  describe "production client options" do
+    it { expect(subject.options.name).to eq("digitalocean") }
 
     it { expect(subject.options.client_options.site).to eq("https://cloud.digitalocean.com") }
     it { expect(subject.options.client_options.authorize_url).to eq("https://cloud.digitalocean.com/v1/oauth/authorize") }
     it { expect(subject.options.client_options.token_url).to eq("https://cloud.digitalocean.com/v1/oauth/token") }
   end
 
-end
+  describe "callback phase instance methods" do
+    let(:uuid) { 123 }
+    let(:response_params) {
+      {
+        'info' => {
+          'uuid' => uuid
+        }
+      }
+    }
+    let(:account_response) {
+      { 'account' =>
+        {
+          'droplet_limit' => 25,
+          'email' => 'foo@example.com',
+          'uuid' => 'b6fc48dbf6d990634ce5f3c78dc9851e757381ef',
+          'email_verified' => true
+        }
+      }
+    }
+    let(:account_json) { double(:json, parsed: account_response) }
+    let(:access_token) { double('AccessToken', params: response_params, get: account_json) }
+
+    before do
+      allow(subject).to receive(:access_token).and_return(access_token)
+    end
+
+    describe "#uid" do
+      it "returns uuid from the info hash" do
+        expect(subject.uid).to eq(uuid)
+      end
+    end
+
+    describe '#extra' do
+      it 'includes the information returned from the account endpoint' do
+        expect(subject.extra['droplet_limit']).to eq(25)
+        expect(subject.extra['email']).to eq("foo@example.com")
+        expect(subject.extra['uuid']).to eq("b6fc48dbf6d990634ce5f3c78dc9851e757381ef")
+        expect(subject.extra['email_verified']).to eq(true)
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-digitalocean
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.3.1
 platform: ruby
 authors:
-- Phillip Baker
+- DigitalOcean API Engineering team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-22 00:00:00.000000000 Z
+date: 2021-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: omniauth
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: omniauth-oauth2
   requirement: !ruby/object:Gem::Requirement
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,19 +122,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Write a longer description. Optional.
+description: Official OmniAuth strategy for Digitalocean
 email:
-- phillip@digitalocean.com
+- api-engineering@digitalocean.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yaml"
+- ".github/workflows/release.yaml"
 - ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - examples/sinatra/Gemfile
+- examples/sinatra/README.md
 - examples/sinatra/config.ru
 - lib/omniauth-digitalocean.rb
 - lib/omniauth-digitalocean/version.rb
@@ -142,7 +145,7 @@ files:
 - omniauth-digitalocean.gemspec
 - spec/omniauth/strategies/digitalocean_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/digitalocean/omniauth-digitalocean
 licenses:
 - MIT
 metadata: {}
@@ -161,11 +164,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
-summary: Oauth2 strategy for authentication via DO.
+summary: Official OmniAuth strategy for Digitalocean
 test_files:
 - spec/omniauth/strategies/digitalocean_spec.rb
 - spec/spec_helper.rb