surveymonkey-omniauth 1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9d404166081d6bc7a8d74354a3917dd5c23e16937e6d74b45b5f9727276c0b1
+  data.tar.gz: 05e297f4fc6e5bf87825803b2eb519eddec10a388c2ec10f90db5678eb8fae4a
+SHA512:
+  metadata.gz: 266fa0946b892e7331663cec12628606412edf5dd5986151c57769e02270c7b8a21b2913701ed74f7274a003f6c2b8f8ddd13abba67757124d33ef2e67167959
+  data.tar.gz: 579698b1e82c6af5c4449f2b3d62bce13ed1061052571d7dd792020b39d501b95250bff3c8d23b80c2387fed611611c4da01b58bb8853fa425ba967cf8f3afe6

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gem 'omniauth-oauth2'

data/Gemfile.lock

@@ -0,0 +1,37 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (2.2.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.1)
+    hashie (5.0.0)
+    jwt (2.3.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    oauth2 (1.4.9)
+      faraday (>= 0.17.3, < 3.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (2.0.4)
+      hashie (>= 3.4.6)
+      rack (>= 1.6.2, < 3)
+      rack-protection
+    omniauth-oauth2 (1.7.2)
+      oauth2 (~> 1.4)
+      omniauth (>= 1.9, < 3)
+    rack (2.2.3)
+    rack-protection (2.2.0)
+      rack
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-oauth2
+
+BUNDLED WITH
+   2.2.22

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2022 Ahmad Ali
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Surveymonkey Strategy for OmniAuth
+
+SurveyMonkey OAuth2 strategy for OmniAuth
+## Get Started
+```ruby
+gem 'surveymonkey-omniauth'
+```
+## Usage
+
+In your config/initializers/omniauth.rb:
+
+    OmniAuth.config.logger = Rails.logger
+    Rails.application.config.middleware.use OmniAuth::Builder do
+      provider :surveymonkey, api_key: SURVEYMONKEY_API_KEY, client_secret: SURVEYMONKEY_API_SECRET,  client_id: SURVEYMONKEY_CLIENT_ID
+    end
+
+Note that this differs from normal Omniauth configurations!
+Note that this gem is an extended work on surveymonkey-with-omniauth gem
+
+# License
+
+Copyright (c) 2022 Ahmad Ali
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+
+desc "Build the gem"
+task :build do
+  system "gem build surveymonkey-omniauth.gemspec"
+end
+
+desc "Build and release the gem"
+task :release => :build do
+  system "gem push surveymonkey-omniauth-#{OmniAuth::Surveymonkey::VERSION}.gem"
+end

data/init.rb

@@ -0,0 +1 @@
+require 'surveymonkey-omniauth'

data/lib/omniauth/strategies/surveymonkey.rb

@@ -0,0 +1,103 @@
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Surveymonkey < OmniAuth::Strategies::OAuth2
+      DEFAULT_RESPONSE_TYPE = 'code'
+      DEFAULT_GRANT = 'authorization_code'
+      option :name, 'surveymonkey'
+
+      option :client_options, {
+        site: 'https://api.surveymonkey.net',
+        authorize_url: '/oauth/authorize',
+        token_url: '/oauth/token'
+      }
+
+      option :authorize_options, [:api_key, :client_id]
+
+      uid { raw_info['id'] }
+
+      info do
+        {
+          'username' => raw_info['username'],
+          'name' => [raw_info['first_name'], raw_info['last_name']].join(' '),
+          'email' => raw_info['email']
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/v3/users/me').parsed
+      end
+
+      def authorize_params
+        super.tap do |params|
+          params[:response_type] ||= DEFAULT_RESPONSE_TYPE
+          params[:client_id] = options[:client_id]
+          params[:api_key] = options[:api_key]
+        end
+      end
+
+      def build_access_token
+        verifier = request.params['code']
+        token = client.auth_code.get_token(verifier, token_params)
+      end
+
+      def callback_phase
+        options[:client_options][:token_url] = "/oauth/token?api_key=#{options[:api_key]}"
+        self.access_token = build_access_token
+        self.env['omniauth.auth'] = auth_hash
+        call_app!
+
+        rescue ::OAuth2::Error, CallbackError => e
+          fail!(:invalid_credentials, e)
+        rescue ::Timeout::Error, ::Errno::ETIMEDOUT => e
+          fail!(:timeout, e)
+        rescue ::SocketError => e
+          fail!(:failed_to_connect, e)
+      end
+
+      def token_params
+        super.tap do |params|
+          params[:grant_type] ||= DEFAULT_GRANT
+          params[:client_id] = options[:client_id]
+          params[:client_secret] = options[:client_secret]
+          params[:redirect_uri] = callback_url
+        end
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      def full_host
+        case OmniAuth.config.full_host
+        when String
+          OmniAuth.config.full_host
+        when Proc
+          OmniAuth.config.full_host.call(env)
+        else
+          if request.scheme && request.url.match(URI::ABS_URI)
+            uri = URI.parse(request.url.gsub(/\?.*$/, ''))
+            uri.path = ''
+            uri.scheme = 'https' if ssl?
+            uri.to_s
+          end
+        end
+      end
+
+      def script_name
+        @env['SCRIPT_NAME'] || ''
+      end
+
+      def callback_path
+        @callback_path ||= begin
+          path = options[:callback_path] if options[:callback_path].is_a?(String)
+          path ||= current_path if options[:callback_path].respond_to?(:call) && options[:callback_path].call(env)
+          path ||= custom_path(:request_path)
+          path ||= "#{path_prefix}/#{name}/callback"
+          path
+        end
+      end
+    end
+  end
+end

data/lib/omniauth/surveymonkey/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Surveymonkey
+    VERSION = "1.0"
+  end
+end

data/lib/omniauth/surveymonkey.rb

@@ -0,0 +1 @@
+require 'omniauth/strategies/surveymonkey'

data/lib/surveymonkey-omniauth.rb

@@ -0,0 +1 @@
+require "omniauth/surveymonkey"

data/spec/omniauth/strategies/surveymonkey_spec.rb

@@ -0,0 +1,73 @@
+require 'surveymonkey-omniauth'
+
+describe OmniAuth::Strategies::Surveymonkey do
+  context 'with url context' do
+    subject do
+      OmniAuth::Strategies::Surveymonkey.new(nil, {})
+    end
+
+    describe '#client' do
+      it 'has correct surveymonkey api site' do
+        subject.options.client_options.site.should == ('https://api.surveymonkey.net')
+      end
+
+      it 'has correct access token path' do
+        subject.options.client_options.token_url.should == ('/oauth/token')
+      end
+
+      it 'has correct authorize url' do
+        subject.options.client_options.authorize_url.should == ('/oauth/authorize')
+      end
+    end
+
+    describe '#callback_path' do
+      it 'should have the correct callback path' do
+        subject.callback_path.should == ('/auth/surveymonkey/callback')
+      end
+    end
+  end
+
+  context 'with auth info' do
+    subject do
+      args = ['client_id', 'secret']
+
+      OmniAuth::Strategies::Surveymonkey.new(nil, *args).tap do |strategy|
+        strategy.stub(:request) { @request }
+      end
+    end
+
+    describe '#uid' do
+      before do
+        subject.stub(:raw_info) do
+          { 'id' => '123' }
+        end
+      end
+
+      it 'returns the id from raw_info' do
+        subject.uid.should eq('123')
+      end
+    end
+
+    describe '#info' do
+      before do
+        subject.stub(:raw_info) do
+          {
+            'username' => 'ahmad',
+            'first_name' => 'Ahmad',
+            'last_name' => 'Ali',
+            'email' => 'ahmad.ali@sendoso.com'
+          }
+        end
+      end
+
+      context 'when optional data is present in raw info' do
+        it 'has all the expecting attributes' do
+          subject.info.keys.should eq(['username', 'name', 'email'])
+          subject.info['username'].should eq('ahmad')
+          subject.info['name'].should eq('Ahmad Ali')
+          subject.info['email'].should eq('ahmad.ali@sendoso.com')
+        end
+      end
+    end
+  end
+end

data/surveymonkey-omniauth.gemspec

@@ -0,0 +1,24 @@
+require File.expand_path('../lib/omniauth/surveymonkey/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_dependency 'omniauth'
+  gem.add_dependency 'oauth2'
+  gem.add_dependency 'omniauth-oauth2'
+
+  gem.add_development_dependency 'rspec', '~> 2.7'
+  gem.add_development_dependency 'rack-test'
+
+  gem.authors = ["Ahmad Ali"]
+  gem.email = ["ahmad.ali@sendoso.com"]
+  gem.description = %q{Survemonkey OAuth2 strategy for OmniAuth}
+  gem.summary = %q{Survemonkey OAuth2 strategy for OmniAuth}
+
+
+  gem.files = `git ls-files`.split("\n")
+  gem.test_files = `git ls-files spec/*`.split("\n")
+  gem.name = "surveymonkey-omniauth"
+  gem.require_paths = ["lib"]
+  gem.version = OmniAuth::Surveymonkey::VERSION
+  gem.homepage = "https://github.com/sendoso/omniauth-surveymonkey"
+  gem.license = 'MIT'
+end

data/surveymonkey-omniauth.rb

@@ -0,0 +1 @@
+require 'surveymonkey-omniauth'

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: surveymonkey-omniauth
+version: !ruby/object:Gem::Version
+  version: '1.0'
+platform: ruby
+authors:
+- Ahmad Ali
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Survemonkey OAuth2 strategy for OmniAuth
+email:
+- ahmad.ali@sendoso.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- init.rb
+- lib/omniauth/strategies/surveymonkey.rb
+- lib/omniauth/surveymonkey.rb
+- lib/omniauth/surveymonkey/version.rb
+- lib/surveymonkey-omniauth.rb
+- spec/omniauth/strategies/surveymonkey_spec.rb
+- surveymonkey-omniauth.gemspec
+- surveymonkey-omniauth.rb
+homepage: https://github.com/sendoso/omniauth-surveymonkey
+licenses:
+- MIT
+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.2.22
+signing_key:
+specification_version: 4
+summary: Survemonkey OAuth2 strategy for OmniAuth
+test_files:
+- spec/omniauth/strategies/surveymonkey_spec.rb