omniauth-feishu 0.1.0 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7bef3b09e1ac850ed6010582efdfb2fb6751279f6e86ab1cfbc55f1ad60eb6f
-  data.tar.gz: 4200cef9f0e4d3801e45331b6dec4579e57e4abe8ae6b5c42ef30994918ed35c
+  metadata.gz: bd59f95721489e7949dc0289eca3441dd317ed19bb8def94f757063e7d90cd7f
+  data.tar.gz: 67c141202a467cac93c3267938a637ab820fed6678757b6e8a835faf56006720
 SHA512:
-  metadata.gz: 3b12f3b0768c268d351ce9edf8eae01abed9d4300a3f46add1336d8a0f7e085338959dd253d61e1e0645f571b29c1f116dd6b5a5129ad38e695bf587d7c4b14a
-  data.tar.gz: fa41d87117206a3b5a15bccc8e9b4c701c7c4819260b642e93f451540f8608431a7f36f55d86d4f172580bf23a81e9e8a26be0cfda7394dada2e89417ba2ca29
+  metadata.gz: 82e1e911346a351f7d7bd0a6b092f587d691489578dc49ce0ad71a793e3028fda368b926e1f2fa9c350227d807f0e3f9db176d613b68863932a06c3fda787629
+  data.tar.gz: a71bbda1517549ce0f99b152fa4b1ac7ec4471a5abbb10a1496b7c3e94c46314a99a61bf643f7b238349253646592bbec6ea914a50b037c84e5a511f78f8bf0b

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - '2.4.1'
+  - '2.6.3'

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    omniauth-feishu (0.1.5)
+      omniauth-oauth2 (~> 1.6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.0)
+    hashie (4.1.0)
+    jwt (2.2.2)
+    multi_json (1.15.0)
+    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.1)
+      hashie (>= 3.4.6)
+      rack (>= 1.6.2, < 3)
+    omniauth-oauth2 (1.6.0)
+      oauth2 (~> 1.1)
+      omniauth (~> 1.9)
+    rack (2.2.3)
+    rake (12.3.2)
+    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.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    ruby2_keywords (0.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  omniauth-feishu!
+  rake (~> 12.0)
+  rspec
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Renny Ren
+
+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

@@ -1,8 +1,9 @@
-# Omniauth::Feishu
+# OmniAuth Feishu
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/omniauth/feishu`. To experiment with that code, run `bin/console` for an interactive prompt.
+Strategy to authenticate with Feishu via OAuth2 in OmniAuth.
 
-TODO: Delete this and the text above, and describe your gem
+[![Gem Version](https://badge.fury.io/rb/omniauth-feishu.svg)](http://badge.fury.io/rb/omniauth-feishu)
+[![Build Status](https://travis-ci.org/renny-ren/omniauth-feishu.svg?branch=master)](https://travis-ci.org/renny-ren/omniauth-feishu)
 
 ## Installation
 
@@ -20,17 +21,76 @@ Or install it yourself as:
 
     $ gem install omniauth-feishu
 
+## Before You Begin
+
+You should have already created your app in feishu platform, if not, go to https://open.feishu.cn/app/ to create one.
+
+Take note of your App Id and App Secret because that is what your web application will use to authenticate against the Feishu API.
+Make sure to set a redirect URL or else you may get authentication error.
+
 ## Usage
 
-TODO: Write usage instructions here
+Here's an example for adding the middleware to a Rails app in `config/initializers/omniauth.rb`:
+
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :feishu, 'App ID', 'App Secret'
+end
+```
+
+## Devise Usage
+Adapted from [Devise OmniAuth Instructions](https://github.com/plataformatec/devise/wiki/OmniAuth:-Overview)
 
-## Development
+```ruby
+# app/models/user.rb
+class User < ApplicationRecord
+  #...
+  devise :omniauthable, omniauth_providers: %i[feishu]
+  #...
+end
+
+# config/initializers/devise.rb
+config.omniauth :feishu, 'App ID', 'App Secret'
+
+# Below controller assumes callback route configuration following 
+# in config/routes.rb
+Devise.setup do |config|
+  # ...
+  devise_for :users, controllers: { omniauth_callbacks: 'users/omniauth_callbacks' }
+end
+
+# app/controllers/users/omniauth_callbacks_controller.rb
+class Users::OmniauthCallbacksController < Devise::OmniauthCallbacksController
+  def feishu
+    @user = User.from_omniauth(request.env["omniauth.auth"])
+    if @user.persisted?
+      sign_in_and_redirect @user, event: :authentication
+    else
+      session["devise.feishu"] = request.env["omniauth.auth"]
+      redirect_to new_user_registration_url
+    end
+  end
+
+  def failure
+    flash[:alert] = request.env["omniauth.error"]
+    redirect_to root_path
+  end
+end
+```
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Devise will create the following url methods:
+- user_feishu_omniauth_authorize_path
+- user_feishu_omniauth_callback_path
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+So you may add a button like this:
+```
+<%= link_to "Sign in with feishu", user_feishu_omniauth_authorize_path, class: "btn" %>
+```
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/omniauth-feishu.
+Bug reports and pull requests are welcome on GitHub at https://github.com/renny-ren/omniauth-feishu.
+
+## License
 
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

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

data/_config.yml

@@ -0,0 +1,2 @@
+theme: jekyll-theme-cayman
+show_downloads: true

data/lib/omniauth/feishu.rb

@@ -1,4 +1,5 @@
 require "omniauth/feishu/version"
+require "omniauth/strategies/feishu"
 
 module Omniauth
   module Feishu

data/lib/omniauth/feishu/version.rb

@@ -1,5 +1,5 @@
 module Omniauth
   module Feishu
-    VERSION = "0.1.0"
+    VERSION = "0.1.6"
   end
 end

data/lib/omniauth/strategies/feishu.rb

@@ -17,11 +17,22 @@ module OmniAuth
         user_info_url: "https://open.feishu.cn/open-apis/authen/v1/user_info"
       }
 
+      uid { raw_info['user_id'] }
+
       info do
         {
           name: raw_info['name'],
           email: raw_info['email'],
-          mobile: raw_info['mobile']
+          mobile: raw_info['mobile'],
+          avatar_url: raw_info['avatar_url'],
+          avatar_thumb: raw_info['avatar_thumb'],
+          avatar_middle: raw_info['avatar_middle'],
+          avatar_big: raw_info['avatar_big'],
+          user_id: raw_info['user_id'],
+          union_id: raw_info['union_id'],
+          open_id: raw_info['open_id'],
+          en_name: raw_info['en_name'],
+          app_access_token: @app_access_token
         }
       end
 
@@ -37,6 +48,12 @@ module OmniAuth
         end
       end
 
+      def authorize_params
+        super.tap do |params|
+          params[:app_id] = options.client_id
+        end
+      end
+
       def build_access_token
         resp = Faraday.post(
           options.client_options.token_url,

data/omniauth-feishu.gemspec

@@ -11,12 +11,13 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
   spec.license       = "MIT"
 
-  # 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(File.expand_path('..', __FILE__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.add_dependency "omniauth-oauth2", "~> 1.6.0"
+
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+  spec.files         = `git ls-files`.split("\n")
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 end

metadata

@@ -1,26 +1,74 @@
 --- !ruby/object:Gem::Specification
 name: omniauth-feishu
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.6
 platform: ruby
 authors:
 - Renny
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2021-01-06 00:00:00.000000000 Z
-dependencies: []
+date: 2021-07-08 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.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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:
 email:
 - rennyallen@hotmail.com
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
+- Gemfile.lock
+- LICENSE
 - README.md
 - Rakefile
+- _config.yml
 - bin/console
 - bin/setup
 - lib/omniauth/feishu.rb
@@ -46,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: Lark(Feishu) OAuth2 Strategy for OmniAuth