omniauth-smarthr 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0cc3deac75d12e05d3cbd68103c9806fe412121fc11faf7b0a1ffda9e48d88b9
+  data.tar.gz: 4898b08c710219287ce09c0ffe8f25d6589f60edfa9fe06563e3f6da5390236e
+SHA512:
+  metadata.gz: 1f2307db5d23c20a6d435f2e921dd4e8751d7e9e66497544c31bdb133ba4413533de6567a214af0999c85cf5f9fc0c7505fcfc8720bbbe46135f0e20c8d6313b
+  data.tar.gz: 370a55fbf6ff380eec40e3daad70b3b7e42e3a81d8e910aa7d7f66cae4814f97ca960b3905af945beee3fa86c550fd455d9232eca9dd422a00c44fd577c4bee8

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,87 @@
+
+# コントリビューター行動規範
+
+## 私たちの約束
+メンバー、コントリビューター、およびリーダーとして、年齢、体の大きさ、目に見えるまたは目に見えない障害、民族性、性別、
+性同一性、表現、経験のレベル、教育、社会経済的地位、国籍、人格、人種、宗教、または性的同一性と指向に関係なく、
+コミュニティへの参加をハラスメントのない体験にすることを誓います。
+
+私たちは、オープンで親しみやすく、多様で包括的で健全なコミュニティに貢献する方法で行動し、交流することを誓います。
+
+## 私たちの標準
+
+前向きな環境を作り上げることに貢献する行動の例：
+
+* 他人への共感と優しさを示す
+
+* 異なる意見、視点、経験を尊重する
+
+* 建設的なフィードバックを与え、礼儀正しく受け入れる
+
+* 私たちの過ちの影響を受けた人々に責任を受け入れ、謝罪し、そしてその経験から学ぶ
+
+* 個人としてだけでなく、コミュニティ全体にとっても最善であることに焦点を当てる
+
+許容できない行動の例は次のとおりです。
+
+* 性的な言葉や画像の使用、および性的な注意またはその他あらゆる種類の問題行為
+
+* トローリング、侮辱的または中傷的なコメント、個人的または政治的攻撃
+
+* 公的またはプライベートの嫌がらせ
+
+* 明示的な許可なしに、住所や電子メールアドレスなど、他者の個人情報を公開する
+
+* 職業上不適切と合理的に考えられるその他の行為
+
+## 執行責任
+
+コミュニティリーダーは、許容される行動の基準を明確にし、実施する責任があり、不適切、脅迫的、攻撃的、または有害と見なされる行動に応じて、適切で公正な是正措置を講じます。
+
+コミュニティリーダーは、コメント、コミット、コード、wikiの編集、問題、およびこの行動規範に沿っていないその他の貢献を削除、編集、または拒否する権利と責任を持ち、適切な場合はモデレーションの決定の理由を伝えます。
+
+## 適用範囲
+
+この行動規範は、すべてのコミュニティスペース内で適用され、個人がパブリックスペースでコミュニティを公式に代表している場合にも適用されます。
+私たちのコミュニティを代表する例には、公式の電子メールアドレスの使用、公式のソーシャルメディアアカウントを介した投稿、オンラインまたはオフラインのイベントでの指定代理人としての行動などがあります。
+
+## 執行
+
+虐待的、嫌がらせ、またはその他の許容できない行動の事例は、執行を担当するコミュニティリーダーに対して`oss@smarthr.co.jp`で報告される場合があります。
+すべての苦情は迅速かつ公正にレビューおよび調査されます。
+
+すべてのコミュニティリーダーは、問題の報告者のプライバシーとセキュリティを尊重する義務があります。
+
+## 執行ガイドライン
+
+コミュニティリーダーは、この行動規範に違反していると見なした行動への帰結を判断する際に、これらのコミュニティガイドラインに従います。
+
+### 1. 更生
+
+**コミュニティへの影響**: コミュニティで専門家にふさわしくない、または歓迎されないと思われる不適切な言葉の使用やその他の不適切な行動をすること。
+
+**帰結**: コミュニティリーダーからの非公開の書面による警告。違反の理由を明確にし、行動が不適切だった理由を説明します。 公の謝罪が要求される場合があります。
+
+### 2. 警告
+
+**コミュニティへの影響**: 単一の出来事または一連の動作による違反。
+
+**帰結**: 持続的な行動の結果を伴う警告。 指定された期間、行動規範の実施者との一方的な対話を含め、関係者との対話はありません。 これには、コミュニティスペースやソーシャルメディアなどの外部チャネルでの相互作用の回避が含まれます。 これらの条件に違反すると、一時的または永続的に禁止される場合があります。
+
+### 3. 一時的な禁止
+**コミュニティへの影響**: 持続的で不適切な行動を含む、コミュニティ標準の重大な違反。
+
+**帰結**: 指定された期間のコミュニティとのあらゆる種類の相互関係または公的なコミュニケーションの一時的な禁止。 この期間中、行動規範を実施する人々との一方的な対話を含め、関係する人々との公的または私的な対話は許可されません。
+これらの条件に違反すると、永久的に禁止される場合があります。
+### 4. 永久的な禁止
+**コミュニティへの影響**: 連続的な不適切な行動、個人への嫌がらせ、または個人の集団に対する攻撃または名誉毀損を含む、コミュニティの標準への違反のパターンを示す。
+
+**帰結**: コミュニティ内でのあらゆる種類の公的な相互関係の永久的な禁止。
+
+## 帰属
+この行動規範は、https://www.contributor-covenant.org/version/2/0/code_of_conduct.html で利用可能な [Contributor Covenant][homepage] バージョン2.0を基に作成されています。
+
+コミュニティへの影響ガイドラインは[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity)に適合しています。
+
+[homepage]: https://www.contributor-covenant.org
+この行動規範に関する一般的な質問への回答については、https://www.contributor-covenant.org/faq のFAQを参照してください。翻訳はhttps://www.contributor-covenant.org/translations で入手できます。

data/CONTRIBUTION.md

@@ -0,0 +1,24 @@
+SmartHR OSS プロダクトへのコントリビューションガイド
+===
+
+SmartHRのOSSプロダクトは、一部の例外を除き、GitHub上ですべてのやり取りを完結させ、情報の公開と共有を心がけてください。また、SmartHRのOSSにコントリビュートした場合、SmartHR CODE OF CONDUCT に同意したとみなします。
+
+# バグを発見した場合
+
+- **脆弱性に関わるバグを発見した場合、GitHub上ではレポートしないでください、必ず `oss@smarthr.co.jp` 経由でのコンタクトをお願いします**
+- すでに同様のバグがIssue上で報告されていないかどうかを確認してください
+- 同様の報告が見当たらない場合、新規にIssueをオープンしてください
+    - Issueのタイトルで簡潔にバグの内容を説明し、本文でその詳細を説明してください
+    - 動作環境など、再現情報は可能な限り提供してください
+    - 期待してる動作と実際の動作を明確に説明してください
+    - 問題を再現するための最小限のコードを記述してください
+
+# パッチを提供したい場合
+
+- 新規にPullRequestをオープンしてください
+    - PullRequestのタイトルで簡潔に修正の内容を説明し、本文でその詳細を説明してください
+    - 対応するIssueがある場合は、その番号を本文に含めてください
+
+# バグやパッチ以外の、ソースコードに関する質問
+
+各OSSのGitHub Discussionを通じて質問をしてください。

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in omniauth-smarthr.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 SmartHR, Inc.
+
+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,61 @@
+# OmniAuth SmartHR
+OmniAuth SmartHRはSmartHRとのOAuth連携処理を簡素化するための[OmniAuth](https://github.com/omniauth/omniauth) strategyです。
+
+## インストール
+
+```ruby
+gem 'omniauth-smarthr'
+```
+## 使い方
+
+### Rails
+
+OmniAuthをミドルウェアとして登録します。
+
+**config/initializers/omniauth.rb**:
+```ruby
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :smarthr, ENV['SMARTHR_CLIENT_ID'], ENV['SMARTHR_CLIENT_SECRET']
+end
+```
+※`SMARTHR_CLIENT_ID` 及び `SMARTHR_CLIENT_SECRET`を取得するには[SmartHR Plus について](https://www.smarthr.plus/about)をご参照の上、パートナープログラムについてお問い合わせください。
+
+環境変数を用意します。
+
+**.env**:
+```
+# Required
+SMARTHR_CLIENT_ID=YOUR_CLIENT_ID
+SMARTHR_CLIENT_SECRET=YOUR_CLIENT_SECRET
+
+# Optional
+# サンドボックス環境を利用する場合には、サンドボックス環境のエンドポイントを指定してください。
+SMARTHR_AUTH_ENDPOINT=SANDBOX_ENVIRONMENT_ENDPOINT
+```
+
+ルーティングとコントローラを用意します。
+
+**config/routes.rb**:
+
+```ruby
+  get 'auth/:provider/callback', to: 'sessions#create'
+```
+
+**app/controllers/sessions_controller.rb**:
+```ruby
+class SessionsController < ApplicationController
+  def create
+    user_info = request.env['omniauth.auth']
+    raise user_info # 適宜セッション管理を行います。
+  end
+end
+```
+
+ユーザーを`/auth/smarthr`に遷移させることでOAuth認可コードフローが開始されます。  
+OAuth認可コードフローが開始するとアプリケーションとの連携許可を求める認可画面が表示されます。  
+認可画面で連携を許可するとアプリケーションにリダイレクトされ`Sessions#create`が呼び出されます。  
+`Sessions#create`で`request.env['omniauth.auth']`を参照することでSmartHRから受け取ったユーザー情報(アクセストークン含む)を取得できます。
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kufu/omniauth-smarthr.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "omniauth/smarthr"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+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/smarthr/version.rb

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

data/lib/omniauth/smarthr.rb

@@ -0,0 +1,5 @@
+require "omniauth/smarthr/version"
+require "omniauth/strategies/smarthr"
+
+OmniAuth.config.add_camelization("smarthr", "SmartHR")
+OmniAuth.config.allowed_request_methods = %i(get post)

data/lib/omniauth/strategies/smarthr.rb

@@ -0,0 +1,55 @@
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class SmartHR < OmniAuth::Strategies::OAuth2
+
+      SMARTHR_AUTH_ENDPOINT = ENV.fetch("SMARTHR_AUTH_ENDPOINT", "https://app.smarthr.jp")
+      private_constant :SMARTHR_AUTH_ENDPOINT
+
+      option :name, "smarthr"
+      option :client_options, {
+        site: SMARTHR_AUTH_ENDPOINT,
+        authorize_url: "/oauth/authorization",
+        token_url: "/oauth/token",
+        auth_scheme: :request_body,
+      }
+      option :redirect_uri, nil
+      option :authorize_options, %i(scope state)
+
+      uid { raw_info["id"] }
+
+      info do
+        {
+          email: raw_info["email"],
+        }
+      end
+
+      extra do
+        skip_info? ? {} : {raw_info: raw_info}
+      end
+
+      def raw_info
+        @raw_info ||= access_token.get("/api/v1/users/me", headers: {}, parse: :json).parsed
+      end
+
+      def callback_url
+        options.redirect_uri || full_host + script_name + callback_path
+      end
+
+      def authorize_params
+        super.tap do |params|
+          options[:authorize_options].each do |k|
+            value = request.params[k.to_s]
+
+            next if [nil, ""].include?(value)
+
+            params[k] = value
+          end
+
+          session["omniauth.state"] = params[:state] if params[:state]
+        end
+      end
+    end
+  end
+end

data/lib/omniauth-smarthr.rb

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

data/omniauth-smarthr.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "omniauth/smarthr/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "omniauth-smarthr"
+  spec.version       = OmniAuth::SmartHR::VERSION
+  spec.licenses       = ["MIT"]
+  spec.authors       = ["SmartHR, Inc."]
+  spec.email         = ["oss@smarthr.co.jp"]
+
+  spec.summary       = "SmartHR OAuth2 Strategy for OmniAuth"
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/kufu/omniauth-smarthr"
+
+  # 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.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'omniauth', ">= 2.1.1"
+  spec.add_runtime_dependency 'omniauth-oauth2', ">= 1.8.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-smarthr
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- SmartHR, Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: SmartHR OAuth2 Strategy for OmniAuth
+email:
+- oss@smarthr.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- CONTRIBUTION.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/omniauth-smarthr.rb
+- lib/omniauth/smarthr.rb
+- lib/omniauth/smarthr/version.rb
+- lib/omniauth/strategies/smarthr.rb
+- omniauth-smarthr.gemspec
+homepage: https://github.com/kufu/omniauth-smarthr
+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.4.21
+signing_key:
+specification_version: 4
+summary: SmartHR OAuth2 Strategy for OmniAuth
+test_files: []