omniauth-signalwire 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fe022a40564f239d9bf4a58592d184a6af7d313b98a78089327231c437ab3720
+  data.tar.gz: 05b024fdc96666498b9ac372249c71fcdb39f1888cf39d7d5d52097c35894448
+SHA512:
+  metadata.gz: 53464d07e371b46b501fb6753d8cc540bda3d48cf6ff16bf27f4290e40398a80b7ca510a63386182ff0e2bb154648f6b51f7a8d7356e2c3170c09b9b5ba02a79
+  data.tar.gz: 7e549735681827a7ccc241c25209fc1dedacec9b4788981047329f6b450dbc2b1abd7144614c09cedca38923d7c6445e7492fb18ea9aed2118ad1403c2c6e7d1

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1', '3.2', '3.3']
+
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Ruby ${{ matrix.ruby-version }}
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true
+    - name: Build and test with Rake
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  TargetRubyVersion: 2.7
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120
+
+Naming/FileName:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.13"
+gem "rubocop", "~> 1.21"
+gem "rubocop-rake"
+gem "rubocop-rspec"

data/README.md

@@ -0,0 +1,61 @@
+[![Ruby](https://github.com/ryanwi/omniauth-signalwire/actions/workflows/ruby.yml/badge.svg)](https://github.com/ryanwi/omniauth-signalwire/actions/workflows/ruby.yml)
+
+# OmniAuth SignalWire
+
+This is an OmniAuth strategy for authenticating to SignalWire.
+
+## Installation
+
+```ruby
+gem 'omniauth-signalwire', '~> 0.1'
+```
+
+## Basic Usage
+
+```ruby
+  use OmniAuth::Builder do
+    provider :signalwire, ENV['SIGNALWIRE_KEY'], ENV['SIGNALWIRE_SECRET']
+  end
+```
+
+## Basic Usage Rails
+
+In `config/initializers/signalwire.rb`
+
+```ruby
+  Rails.application.config.middleware.use OmniAuth::Builder do
+    provider :signalwire, ENV['SIGNALWIRE_KEY'], ENV['SIGNALWIRE_SECRET']
+  end
+```
+
+## Authentication Hash
+An example auth hash available in `request.env['omniauth.auth']`:
+
+```
+{
+  :provider => "signalwire",
+  :uid => "4d1bcf6e-88ed-4cfa-87bb-b986cd65678e",
+  :info => {
+    :email => "user@example.com",
+    :first_name => "Jane",
+    :last_name => "Doe",
+    :display_name => "Jane Doe",
+    ...
+  },
+  :credentials => {
+    :token => "a1b2c3d4...", # The OAuth 2.0 access token
+    :refresh_token => "2QY...",
+    :expires_at => 1709194759,
+    :expires => true
+  },
+  :extra = {
+    :raw_info => {
+      ...
+    }
+  }
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ryanwi/omniauth-signalwire.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "omniauth/signalwire"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/omniauth/strategies/signalwire.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class SignalWire < OmniAuth::Strategies::OAuth2
+      option :name, :signalwire
+
+      option :client_options, {
+        site: "https://fabric.signalwire.com",
+        authorize_url: "https://id.fabric.signalwire.com/login/oauth/authorize",
+        token_url: "https://id.fabric.signalwire.com/oauth/token"
+      }
+
+      option :pkce, true
+
+      uid { raw_info["id"] }
+
+      info do
+        {
+          email: raw_info["email"],
+          first_name: raw_info["first_name"],
+          last_name: raw_info["last_name"],
+          display_name: raw_info["display_name"],
+          job_title: raw_info["job_title"],
+          time_zone: raw_info["time_zone"],
+          country: raw_info["country"],
+          region: raw_info["region"],
+          company_name: raw_info["company_name"]
+        }
+      end
+
+      extra do
+        {
+          "raw_info" => raw_info
+        }
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("/subscriber/info").parsed
+      end
+    end
+  end
+end
+
+OmniAuth.config.add_camelization "signalwire", "SignalWire"

data/lib/omniauth-signalwire/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module OmniAuth
+  module SignalWire
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth-signalwire.rb

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

data/omniauth-signalwire.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require File.expand_path("lib/omniauth-signalwire/version", __dir__)
+
+Gem::Specification.new do |spec|
+  spec.authors = ["SignalWire Team"]
+  spec.email = ["open.source@signalwire.com"]
+  spec.description = "Official OmniAuth strategy for SignalWire."
+  spec.summary = "Official OmniAuth strategy for SignalWire."
+  spec.homepage = "https://github.com/signalwire/omniauth-signalwire"
+  spec.name = "omniauth-signalwire"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files`.split("\n")
+  spec.require_paths = ["lib"]
+  spec.version = OmniAuth::SignalWire::VERSION
+  spec.required_ruby_version = ">= 2.7"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/signalwire/omniauth-signalwire"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  # spec.files = Dir.chdir(__dir__) do
+  #   `git ls-files -z`.split("\x0").reject do |f|
+  #     (File.expand_path(f) == __FILE__) ||
+  #       f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+  #   end
+  # end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+
+  spec.add_dependency "omniauth", "~> 2.0"
+  spec.add_dependency "omniauth-oauth2", "~> 1.8"
+  spec.add_development_dependency "rack-test", "~> 2.1"
+  spec.add_development_dependency "rspec", "~> 3.13"
+  spec.add_development_dependency "webmock", "~> 3.23"
+end

data/spec/omniauth/strategies/signalwire_spec.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe OmniAuth::Strategies::SignalWire do
+  subject(:strategy) { described_class.new({}) }
+
+  describe "#client" do
+    it "has the correct site" do
+      expect(strategy.client.site).to eq("https://fabric.signalwire.com")
+    end
+
+    it "has the correct authorization url" do
+      expect(strategy.client.options[:authorize_url]).to eq("https://id.fabric.signalwire.com/login/oauth/authorize")
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path(__dir__)
+$LOAD_PATH.unshift File.expand_path("../lib", __dir__)
+require "rspec"
+require "rack/test"
+require "webmock/rspec"
+require "omniauth"
+require "omniauth-signalwire"
+
+RSpec.configure do |config|
+  config.include WebMock::API
+  config.include Rack::Test::Methods
+  config.extend  OmniAuth::Test::StrategyMacros, type: :strategy
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-signalwire
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SignalWire Team
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-02-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.13'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.23'
+description: Official OmniAuth strategy for SignalWire.
+email:
+- open.source@signalwire.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-signalwire.rb
+- lib/omniauth-signalwire/version.rb
+- lib/omniauth/strategies/signalwire.rb
+- omniauth-signalwire.gemspec
+- spec/omniauth/strategies/signalwire_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/signalwire/omniauth-signalwire
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/signalwire/omniauth-signalwire
+  source_code_uri: https://github.com/signalwire/omniauth-signalwire
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Official OmniAuth strategy for SignalWire.
+test_files: []