omniauth-teamwork 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c794bffd4ee256ed8ef34e6ec5871c600306d8ca137a22411591228ae5667d5b
+  data.tar.gz: ace126d606b9aa0ab738376b9a58b5fe0ce1a61cb03ce263f16bab7f4cfd6fac
+SHA512:
+  metadata.gz: 8e0ee15cee3947e00ff4e211134ef2c11d8ebbc235926bffbaeb8c86b1070d300fc9f9b4cd4b29179250475b7e8a251d70f23ed3343825a3d34f4f7065019e6d
+  data.tar.gz: 193495e99ed2e2dcf4b18c4d5c3ffcb599f74e9e857d0b806409322b1195b7cb2a3631f4913a749fa20fc0f3ae993a9e49753d746e1c8270b5d657ab12ed23e0

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on: [push, pull_request]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          - ubuntu
+        ruby:
+          - "2.5"
+          - "2.6"
+          - "2.7"
+          - "3.0"
+          - "3.1"
+          - "3.2"
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # 'bundle install' and cache
+    - name: Run tests
+      run: bundle exec rake

data/.github/workflows/stale.yml

@@ -0,0 +1,21 @@
+name: Mark stale issues and pull requests
+
+on:
+  schedule:
+  - cron: "0 0 * * *"
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/stale@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        stale-issue-message: 'This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you  for your contributions.'
+        stale-pr-message: 'This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.'
+        stale-issue-label: 'no-issue-activity'
+        stale-pr-label: 'no-pr-activity'
+        days-before-stale: 30
+        days-before-close: 5
+        exempt-pr-label: 'pinned'
+        exempt-issue-label: 'pinned'

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp
+bin

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Kalpana
+
+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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/omniauth/strategies/teamwork.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'omniauth/strategies/oauth2'
+
+module OmniAuth
+  module Strategies
+    class Teamwork < OmniAuth::Strategies::OAuth2
+      option :name, 'teamwork'
+
+      option :client_options, {
+        site: 'https://www.teamwork.com/',
+        authorize_url: 'https://www.teamwork.com/launchpad/login',
+        token_url: 'https://www.teamwork.com/launchpad/v1/token'
+      }
+
+      uid { raw_info['id'] }
+
+      info do
+        {
+          email: raw_info['email_address'],
+          first_name: raw_info['first_name'],
+          last_name: raw_info['last_name'],
+          avatar_url: raw_info['avatar_url']
+        }
+      end
+
+      credentials { { token: access_token.token } }
+
+      extra { { raw_info: raw_info } }
+
+      def callback_url
+        options[:redirect_uri] || (full_host + script_name + callback_path)
+      end
+
+      def raw_info
+        url = "#{access_token.response.parsed.installation.api_end_point}me.json"
+        @raw_info ||= access_token.get(url).parsed.person
+      end
+    end
+  end
+end

data/lib/omniauth/teamwork/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module Teamwork
+    VERSION = '1.0.0'
+  end
+end

data/lib/omniauth-teamwork.rb

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

data/omniauth-teamwork.gemspec

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require File.expand_path('./lib/omniauth/teamwork/version', __dir__)
+
+Gem::Specification.new do |gem|
+  gem.name           = 'omniauth-teamwork'
+  gem.summary        = 'Unofficial OmniAuth strategy for Teamwork.'
+  gem.description    = 'Unofficial OmniAuth strategy for Teamwork.'
+  gem.authors        = ['Kalpana']
+  gem.homepage       = ''
+  gem.license        = 'MIT'
+
+  gem.files          = `git ls-files`.split("\n")
+  gem.require_paths  = ['lib']
+  gem.version        = OmniAuth::Teamwork::VERSION
+
+  gem.add_runtime_dependency 'omniauth-oauth2', '>= 1.2', '< 3'
+
+  gem.add_development_dependency 'rspec', '~> 3.12'
+  gem.add_development_dependency 'rake', '~> 13.0'
+end

data/spec/fixtures/raw_info.json

@@ -0,0 +1,83 @@
+{
+  "marketo_id": "0",
+  "user_hash": "e3ba22a2d1699984884917f6695a3e14488799cce9e2d61332646818cb6f1b80",
+  "permissions": {
+    "can_access_templates": true,
+    "can_view_project_templates": true,
+    "can_add_projects": true,
+    "can_manage_custom_fields": true,
+    "can_manage_project_templates": true,
+    "can_access_calendar": true,
+    "is_admin_on_a_project": false,
+    "can_manage_people": true
+  },
+  "avatar_url": "https://s3.amazonaws.com/TWFiles/1021139/userAvatar/twia_a158142a5a47ade8d410a6ae0e34a7e5.png",
+  "current_feature_announcement": {
+    "date": "2023-07-28T15:55:00Z",
+    "code": "",
+    "link_text": "Learn more",
+    "callout_image": "",
+    "link": "https://www3.teamwork.com/everything-you-need-to-know-about-what-we-released-in-july",
+    "is_read": false,
+    "title": "What's new in Teamwork.com | July 2023",
+    "text": "Get the scoop on the latest product releases we've been cooking up at Teamwork.com.",
+    "html": "",
+    "id": "2520",
+    "type": "announcement"
+  },
+  "last_changed_on": "",
+  "email_address": "test_user@example.com",
+  "last_login": "2023-08-03T06:16:09Z",
+  "document_editor_installed": false,
+  "user_name": "testusername",
+  "id": "136576",
+  "phone_number_fax": "",
+  "site_owner": true,
+  "company_name": "Awesome Company",
+  "user_invited_date": "",
+  "phone_number_mobile": "",
+  "user_type": "account",
+  "has_feature_updates": true,
+  "open_id": "",
+  "address": { "city": "", "country": "", "countrycode": "", "zipcode": "", "state": "", "line1": "", "line2": "" },
+  "phone_number_office": "+01 123457890",
+  "im_handle": "",
+  "ld_hash": "99d2ae9093b3a812d74e4b7e411ea22fdb38b821259d374572f6f79f524dee41",
+  "is_client_user": false,
+  "two_factor_auth_enabled": false,
+  "tags": [],
+  "has_access_to_new_projects": true,
+  "installation_id": "1021139",
+  "im_service": "",
+  "deleted": false,
+  "notes": "",
+  "in_owner_company": "1",
+  "profile": "",
+  "user_invited_status": "COMPLETE",
+  "user_uuid": "",
+  "user_invited": "0",
+  "created_at": "2023-07-31T10:37:41Z",
+  "is_service_account": false,
+  "company_id": "1371610",
+  "has_desk_account": false,
+  "integrations": { "microsoft_connector": { "enabled": false } },
+  "phone_number_home": "",
+  "company_role_id": "5",
+  "profile_text": "",
+  "private_notes_text": "",
+  "pid": "",
+  "phone_number_mobile_parts": { "country_code": "", "prefix": "", "phone": "" },
+  "login_count": "50",
+  "private_notes": "",
+  "email_alt_1": "",
+  "administrator": true,
+  "email_alt_2": "",
+  "email_alt_3": "",
+  "feature_updates_count": "8",
+  "title": "",
+  "last_name": "User",
+  "first_name": "Test",
+  "phone_number_office_ext": "",
+  "twitter": "",
+  "length_of_day": "8.0"
+}

data/spec/omniauth/strategies/teamwork_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+require 'omniauth-teamwork'
+
+describe OmniAuth::Strategies::Teamwork do
+  let(:client_id) { '123' }
+  let(:client_secret) { 'asdfgh' }
+  let(:raw_info) { JSON.parse(File.read('./spec/fixtures/raw_info.json')) }
+  let(:request) { double('Request') }
+  let(:access_token) { double('OAuth2::AccessToken') }
+
+  before do
+    allow(request).to receive(:params).and_return({})
+  end
+
+  subject do
+    args = [client_id, client_secret].compact
+    OmniAuth::Strategies::Teamwork.new(nil, *args).tap do |strategy|
+      allow(strategy).to receive(:request).and_return(request)
+    end
+  end
+
+  describe '#client' do
+    it 'has correct Teamwork site' do
+      expect(subject.client.site).to eq('https://www.teamwork.com/')
+    end
+
+    it 'has correct authorize url' do
+      expect(subject.client.options[:authorize_url]).to eq('https://www.teamwork.com/launchpad/login')
+    end
+
+    it 'has correct token url' do
+      expect(subject.client.options[:token_url]).to eq('https://www.teamwork.com/launchpad/v1/token')
+    end
+  end
+
+  describe '#info' do
+    before do
+      allow(subject).to receive(:raw_info).and_return(raw_info)
+    end
+
+    context 'when data is present in raw info' do
+      it 'returns the name' do
+        expect(subject.info[:first_name]).to eq(raw_info['first_name'])
+        expect(subject.info[:last_name]).to eq(raw_info['last_name'])
+      end
+
+      it 'returns the avatar url' do
+        expect(subject.info[:avatar_url]).to eq(raw_info['avatar_url'])
+      end
+
+      it 'return the email' do
+        expect(subject.info[:email]).to eq(raw_info['email_address'])
+      end
+    end
+  end
+
+  describe '#credentials' do
+    before do
+      allow(access_token).to receive(:token).and_return('xxxxx')
+      allow(access_token).to receive(:expires?)
+      allow(subject).to receive(:access_token).and_return(access_token)
+    end
+
+    it 'returns a Hash' do
+      expect(subject.credentials).to be_a(Hash)
+    end
+
+    it 'returns the token' do
+      expect(subject.credentials[:token]).to eq('xxxxx')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'bundler/setup'
+require 'rspec'
+require 'json'
+
+Dir[File.expand_path('./spec/fixtures/**/*', __dir__)].each { |f| require f }

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-teamwork
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Kalpana
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: Unofficial OmniAuth strategy for Teamwork.
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ci.yml"
+- ".github/workflows/stale.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE.md
+- Rakefile
+- lib/omniauth-teamwork.rb
+- lib/omniauth/strategies/teamwork.rb
+- lib/omniauth/teamwork/version.rb
+- omniauth-teamwork.gemspec
+- spec/fixtures/raw_info.json
+- spec/omniauth/strategies/teamwork_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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: Unofficial OmniAuth strategy for Teamwork.
+test_files: []