omniauth-kitt 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f6c1d5b9fc0440b6c30d82cb18fb28cf4298f70246241f5e560fda83529fc8d
+  data.tar.gz: 95642dc0b6e4a35eb022aaf652b490a6b770041652e7a947fe653ba238118ab4
+SHA512:
+  metadata.gz: c193160d7721bb44867a6fc28127f0e92caedd3e56f767b6f4b6f73b091d10de79b62dc812ec47b3f1b9fdf4ff3d2232232cf4743fd06593ed5356ea4242fa00
+  data.tar.gz: 2247c55676b86f361e2a15795c5586184b728bca5cc9dece76e3d696b0c2ca5555d204f7cf82a3aa784365826a93e7d6acb8ca38b16d149d3d804578a4c97c84

data/.github/workflows/ruby.yml

@@ -0,0 +1,24 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in omniauth-kitt.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/Gemfile.lock

@@ -0,0 +1,42 @@
+PATH
+  remote: .
+  specs:
+    omniauth-kitt (0.1.0)
+      omniauth-oauth2
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (1.0.0)
+      multipart-post (>= 1.2, < 3)
+    hashie (3.6.0)
+    jwt (2.2.1)
+    minitest (5.14.0)
+    multi_json (1.14.1)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    oauth2 (1.4.4)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    omniauth (1.9.0)
+      hashie (>= 3.4.6, < 3.7.0)
+      rack (>= 1.6.2, < 3)
+    omniauth-oauth2 (1.6.0)
+      oauth2 (~> 1.1)
+      omniauth (~> 1.9)
+    rack (2.2.2)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  omniauth-kitt!
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Sébastien Saunier
+
+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,52 @@
+# OmniAuth::Kitt
+
+Provides an OAuth connection for Le Wagon alumni.
+
+## Usage with Devise
+
+Add this line to your application's `Gemfile`, then `bundle install`:
+
+```ruby
+gem 'omniauth-kitt'
+```
+
+Go to [kitt.lewagon.com/oauth/applications](https://kitt.lewagon.com/oauth/applications) and create a new application.
+
+Callback URL will be `http(s)://HOST/users/auth/kitt/callback`
+
+```ruby
+Devise.setup do |config|
+  config.omniauth :kitt, APP_ID, SECRET
+
+  # [...]
+end
+```
+
+Your `User` model needs this line:
+
+```ruby
+class User < ApplicationRecord
+  devise :omniauthable, omniauth_providers: [ :kitt ]
+
+  # [...]
+end
+```
+
+And your controller:
+
+```ruby
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  def kitt
+    auth = request.env["omniauth.auth"]
+    # [...]
+  end
+end
+```
+
+`auth` has the following keys:
+
+- `id` as an integer
+- `github_nickname` as a string
+- `email`, `first_name`, `last_name` & `avatar_url` as strings
+- `admin` as a boolean
+- `cities` as an array of _slugs_ (City managers)

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/lib/omniauth/kitt.rb

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

data/lib/omniauth/kitt/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module Kitt
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth/strategies/kitt.rb

@@ -0,0 +1,26 @@
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class Kitt < ::OmniAuth::Strategies::OAuth2
+      option :name, :kitt
+
+      option :client_options, {
+        :site => "https://kitt.lewagon.com",
+        :authorize_url => "/oauth/authorize"
+      }
+
+      uid do
+        raw_info[:id]
+      end
+
+      info do
+        raw_info
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get('/api/v1/me.json').parsed.symbolize_keys
+      end
+    end
+  end
+end

data/omniauth-kitt.gemspec

@@ -0,0 +1,24 @@
+require_relative 'lib/omniauth/kitt/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-kitt"
+  spec.version       = OmniAuth::Kitt::VERSION
+  spec.authors       = ["Sébastien Saunier"]
+  spec.email         = ["seb@saunier.me"]
+
+  spec.summary       = %q{OmniAuth strategy for Kitt}
+  spec.description   = %q{Le Wagon's alumni platform provides OAuth capabilities for the ecosystem}
+  spec.homepage      = "https://github.com/lewagon/omniauth-kitt"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lewagon/omniauth-kitt"
+
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+
+  spec.require_paths = ["lib"]
+  spec.add_dependency "omniauth-oauth2"
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-kitt
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sébastien Saunier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-24 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: Le Wagon's alumni platform provides OAuth capabilities for the ecosystem
+email:
+- seb@saunier.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth/kitt.rb
+- lib/omniauth/kitt/version.rb
+- lib/omniauth/strategies/kitt.rb
+- omniauth-kitt.gemspec
+homepage: https://github.com/lewagon/omniauth-kitt
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lewagon/omniauth-kitt
+  source_code_uri: https://github.com/lewagon/omniauth-kitt
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: OmniAuth strategy for Kitt
+test_files: []