omniauth-webex 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9f04a4b531b28f901575e97cd5b4d9da553c310396aa57b99217dcb98aeb102e
+  data.tar.gz: b6c13682014360fd3ed2d19db5bfe5290847adbc4cb075d6b093db6010ae6e8b
+SHA512:
+  metadata.gz: a2c1e7ce242a33e99fb89b533b8c3a2a85a923ecc7ae2a069692984ebeb6a4183ddd836b72632f0206ff5b2868ef51097b3c6342d4c31a3914e112343496462a
+  data.tar.gz: ea090b5cdf2b222528f9ec83c5145a4ed28d2e5e6087f3f80a1dbe0d9a30c927cbaf9a11c856fcbeb78f710cf215b388c444ec8ee1838e767664c3540c86dbf9

data/.LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2021 Jamie Wright
+
+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/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec
+
+gem "rack", ">= 2.0"
+
+group :test do
+  gem "rspec", "~> 3.10.0"
+end

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    omniauth-webex (0.0.1)
+      omniauth-oauth2 (~> 1.7)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    hashie (4.1.0)
+    jwt (2.3.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.7)
+      faraday (>= 0.8, < 2.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.1)
+      oauth2 (~> 1.4)
+      omniauth (>= 1.9, < 3)
+    rack (2.2.3)
+    rack-protection (2.1.0)
+      rack
+    rake (13.0.6)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  omniauth-webex!
+  rack (>= 2.0)
+  rake (> 10.0.0)
+  rspec (~> 3.10.0)
+
+BUNDLED WITH
+   2.2.4

data/README.md

@@ -0,0 +1,124 @@
+OmniAuth Webex
+==============
+
+The [Webex](https://webex.com) strategy for [OmniAuth](https://github.com/omniauth/omniauth).
+
+## DESCRIPTION
+
+The Webex strategy for OmniAuth. This is for [Webex Integrations](https://developer.webex.com/docs/integrations) to allow a user to OAuth with a Webex instance and get access to it's API.
+
+## INSTALLATION
+
+Add the following to your `Gemfile`:
+
+```
+gem "omniauth-webex"
+```
+
+And then run `bundle install`
+
+## USAGE
+
+`OmniAuth::Strategies::Webex` is simply a Rack middleware. Read the OmniAuth docs detailed instructions https://github.com/omniauth/omniauth.
+
+### Rails app
+
+For a Rails app, you will need to configure it by creating an initializer in `config/initializers/omniauth.rb`. The following is an example:
+
+```
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :facebook, ENV["WEBEX_CLIENT_ID"], ENV["WEBEX_CLIENT_SECRET"],
+    provider_ignores_state: true,
+    scope: "spark:people_read"
+end
+```
+
+### Sinatra app
+
+For a Sinatra app, you will need to configure your Sinatra app to use the middleware. The following is an example:
+
+```
+class MyApp < Sinatra::Base
+  configure do
+    set :sessions, true
+  end
+
+  use OmniAuth::Builder do
+    provider :webex, ENV["WEBEX_CLIENT_ID"], ENV["WEBEX_CLIENT_SECRET"],
+      provider_ignores_state: true,
+      scope: "spark:people_read"
+  end
+end
+```
+
+### Auth Hash
+
+Here is an example of the data that will be available in `request.env["omniauth.auth"]`
+
+```
+{
+  "provider": "webex",
+  "uid": "YsdkjdfjdfklsfHDF",
+  "info"=> {
+    "id": "YsdkjdfjdfklsfHDF",
+    "emails": ["jimmy@example.com"],
+    "phoneNumbers": [],
+    "displayName": "Jimmy Page",
+    "nickName": "jimmy",
+    "firstName": "Jimmy",
+    "lastName": "Page",
+    "avatar": "https://avatar-prod-us-west-2.webexcontent.com/Avtr~auyadskasdhhd",
+    "orgId": "YHDHDKidhaH",
+    "created": "2021-08-19T20:59:20.767Z",
+    "lastModified": "2021-10-06T15:01:06.205Z",
+    "lastActivity": "2021-10-07T16:14:41.441Z",
+    "status": "active",
+    "type": "person"
+  },
+  "credentials": {
+    "token":  "HGDT7DGHyds",
+    "refresh_token":  "Zhdjks6GHD",
+    "expires_at": 1634832891,
+    "expires": true
+  },
+  "extra": {
+    "raw_info": {
+      "id": "YsdkjdfjdfklsfHDF",
+      "emails": ["jimmy@example.com"],
+      "phoneNumbers": [],
+      "displayName": "Jimmy Page",
+      "nickName": "jimmy",
+      "firstName": "Jimmy",
+      "lastName": "Page",
+      "avatar":  "https://avatar-prod-us-west-2.webexcontent.com/Avtr~auyadskasdhhd",
+      "orgId":  "YHDHDKidhaH",
+      "created": "2021-08-19T20:59:20.767Z",
+      "lastModified": "2021-10-06T15:01:06.205Z",
+      "lastActivity": "2021-10-07T16:14:41.441Z",
+      "status": "active",
+      "type": "person"
+    }
+  }
+}
+```
+
+## RUNNING TESTS
+
+This project is covered by unit tests. They can be run with the following command.
+
+```
+bundle exec rake spec
+```
+
+## CONTRIBUTING
+
+1. Fork the repository `gh repo fork https://github.com/jwright/omniauth-webex`
+1. Create a feature branch `git checkout -b my-awesome-feature`
+1. Codez!
+1. Commit your changes (small commits please)
+1. Push your new branch `git push origin my-awesome-feature`
+1. Create a pull request `gh pr create --head my-fork:my-awesome-feature`
+
+## LICENSE
+
+This project is licensed under the [MIT License](LICENSE.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/omniauth/strategies/webex.rb

@@ -0,0 +1,36 @@
+require "omniauth/strategies/oauth2"
+
+module OmniAuth
+  module Strategies
+    class Webex < OmniAuth::Strategies::OAuth2
+      option :name, "webex"
+
+      option :authorize_options, [:scope]
+
+      option :client_options,
+        site: "https://webexapis.com",
+        authorize_url: "https://webexapis.com/v1/authorize",
+        token_url: "https://webexapis.com/v1/access_token"
+
+      uid { raw_info["id"] }
+
+      info do
+        raw_info
+      end
+
+      extra do
+        hash = {}
+        hash["raw_info"] = raw_info unless skip_info?
+        hash
+      end
+
+      def callback_url
+        full_host + script_name + callback_path
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("v1/people/me").parsed || {}
+      end
+    end
+  end
+end

data/lib/omniauth/webex/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Webex
+    VERSION = "0.0.1"
+  end
+end

data/lib/omniauth/webex.rb

@@ -0,0 +1,2 @@
+require "omniauth/webex/version"
+require "omniauth/strategies/webex"

data/lib/omniauth-webex.rb

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

data/omniauth-webex.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require File.expand_path(
+  File.join("..", "lib", "omniauth", "webex", "version"),
+  __FILE__
+)
+
+Gem::Specification.new do |s|
+  s.name        = "omniauth-webex"
+  s.version     = OmniAuth::Webex::VERSION
+  s.authors     = ["Jamie Wright"]
+  s.email       = ["jamie@brilliantfantastic.com"]
+  s.homepage    = "https://github.com/jwright/omniauth-webex"
+  s.description = %(A Webex OAuth strategy for OmniAuth)
+  s.summary     = %(A Webex OAuth strategy for OmniAuth. This allows you to add login with Webex to your Ruby apps.)
+  s.license     = "MIT"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 2.2")
+
+  s.add_dependency "omniauth-oauth2", "~> 1.7"
+
+  s.add_development_dependency "rake", "> 10.0.0"
+end

data/spec/omniauth/strategies/webex_spec.rb

@@ -0,0 +1,79 @@
+require "spec_helper"
+
+RSpec.describe OmniAuth::Strategies::Webex do
+  let(:raw_info) do
+    {
+      "id" => "12345",
+      "emails" => ["jimmy@zeppelin.com"],
+      "nickName" => "jimmy",
+      "displayName" => "Jimmy Page"
+    }
+  end
+
+  subject(:strategy) do
+    OmniAuth::Strategies::Webex.new("appid", "secret")
+  end
+
+  describe "#options" do
+    it "has the correct name" do
+      expect(strategy.options.name).to eq "webex"
+    end
+
+    describe "#authorize_options" do
+      it "includes a scope option" do
+        expect(strategy.options.authorize_options).to include :scope
+      end
+    end
+
+    describe "#client_options" do
+      it "has the correct site" do
+        expect(strategy.options.client_options.site).to eq "https://webexapis.com"
+      end
+
+      it "has the correct authorize url" do
+        expect(strategy.options.client_options.authorize_url).to eq "https://webexapis.com/v1/authorize"
+      end
+
+      it "has the correct token url" do
+        expect(strategy.options.client_options.token_url).to eq "https://webexapis.com/v1/access_token"
+      end
+    end
+
+    describe "#callback_url" do
+      let(:env) { {} }
+      let(:request) do
+        double("Request",
+               scheme: "https",
+               url: "https://somewhere.com",
+               script_name: "",
+               query_string: "?foo=bar",
+               env: env)
+      end
+
+      before do
+        allow(strategy).to receive(:request).and_return(request)
+        strategy.instance_variable_set(:@env, env)
+      end
+
+      it "does not contain additional parameters" do
+        expect(strategy.callback_url).to eq "https://somewhere.com/auth/webex/callback"
+      end
+    end
+
+    describe "#info" do
+      before { allow(strategy).to receive(:raw_info).and_return raw_info }
+
+      it "returns the raw info for the user" do
+        expect(strategy.info).to eq raw_info
+      end
+    end
+
+    describe "#uid" do
+      before { allow(strategy).to receive(:raw_info).and_return raw_info }
+
+      it "returns the id for the user" do
+        expect(strategy.uid).to eq "12345"
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+require "rspec"
+require "omniauth/strategies/webex"
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.disable_monkey_patching!
+  config.warnings = true
+  if config.files_to_run.one?
+    config.default_formatter = "doc"
+  end
+  config.order = :random
+  Kernel.srand config.seed
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-webex
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Jamie Wright
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-10-07 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.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 10.0.0
+description: A Webex OAuth strategy for OmniAuth
+email:
+- jamie@brilliantfantastic.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".LICENSE"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/omniauth-webex.rb
+- lib/omniauth/strategies/webex.rb
+- lib/omniauth/webex.rb
+- lib/omniauth/webex/version.rb
+- omniauth-webex.gemspec
+- spec/omniauth/strategies/webex_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jwright/omniauth-webex
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: A Webex OAuth strategy for OmniAuth. This allows you to add login with Webex
+  to your Ruby apps.
+test_files:
+- spec/omniauth/strategies/webex_spec.rb
+- spec/spec_helper.rb