warden-line 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf89e84c98d0ccbd978273e5f310a3ed9e404c2e1b2c0a1165d914801ed01dc3
+  data.tar.gz: a6c8f47dbbc5f2a411b703908d7277820da749677ca55dc17509f0e5b714c6d5
+SHA512:
+  metadata.gz: 892f8989af1ba3dfa61385bf2746d4dc2a05329d4c88f4fdcfe38be9bc5cecffbf9ec5511d24a0999f381a0dfaae40278585eb24c18fc5dbcb56a053005ee603
+  data.tar.gz: f8b698b5e62f02a2dcd8b77e044ba63c69685a22ddfcdf97241d5c90ce853284dce1cd99c7267bc6f55a2be9b77576e8ff464591944c096f521d65a7b29cf2fe

data/.gitignore

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

data/.overcommit.yml

@@ -0,0 +1,17 @@
+PreCommit:
+  AuthorName:
+    enabled: false
+  RuboCop:
+    enabled: true
+    on_warn: fail # Treat all warnings as failures
+  TrailingWhitespace:
+    enabled: true
+  BundleAudit:
+    enabled: true
+
+PostCheckout:
+  ALL: # Special hook name that customizes all hooks of this type
+    quiet: true # Change all post-checkout hooks to only display output on failure
+
+  IndexTags:
+    enabled: true # Generate a tags file with `ctags` each time HEAD changes

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,7 @@
+require:
+  - rubocop-rspec
+  - rubocop-rake
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*.rb

data/.travis.yml

@@ -0,0 +1,15 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script:
+  - bundle exec rspec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at elct9620@frost.tw. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in warden-line.gemspec
+gemspec
+
+gem 'rake', '~> 12.0'
+gem 'rspec', '~> 3.0'
+
+gem 'simplecov'
+
+gem 'rubocop', '~> 1.8.1'
+gem 'rubocop-rake'
+gem 'rubocop-rspec'
+
+gem 'bundler-audit'
+gem 'overcommit'

data/Gemfile.lock

@@ -0,0 +1,85 @@
+PATH
+  remote: .
+  specs:
+    warden-line (0.1.0)
+      warden (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    bundler-audit (0.7.0.1)
+      bundler (>= 1.2.0, < 3)
+      thor (>= 0.18, < 2)
+    childprocess (4.0.0)
+    diff-lcs (1.4.4)
+    docile (1.3.5)
+    iniparse (1.5.0)
+    overcommit (0.57.0)
+      childprocess (>= 0.6.3, < 5)
+      iniparse (~> 1.4)
+    parallel (1.20.1)
+    parser (3.0.0.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rainbow (3.0.0)
+    rake (12.3.3)
+    regexp_parser (2.0.3)
+    rexml (3.2.4)
+    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)
+    rubocop (1.8.1)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.4.1)
+      parser (>= 2.7.1.5)
+    rubocop-rake (0.5.1)
+      rubocop
+    rubocop-rspec (2.2.0)
+      rubocop (~> 1.0)
+      rubocop-ast (>= 1.1.0)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.2)
+    thor (1.1.0)
+    unicode-display_width (2.0.0)
+    warden (1.2.9)
+      rack (>= 2.0.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler-audit
+  overcommit
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.8.1)
+  rubocop-rake
+  rubocop-rspec
+  simplecov
+  warden-line!
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,125 @@
+# Warden::Line
+
+This gem is created for use LINE ID Token as warden strategies to use in LIFF application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'warden-line'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install warden-line
+
+## Usage
+
+Currently, the workable version is tested with `rails_warden` gem.
+
+```
+# config/initialize/warden.rb
+
+Rails.configuration.middleware.use RailsWarden::Manager do |manager|
+  manager.failure_app = proc do |env|
+    [
+      401,
+      { 'Content-Type' => 'application/json' },
+      [{ error: 'Unauthorized', code: 401, reason: env['warden'].message }.to_json]
+    ]
+  end
+  manager.default_strategies :line
+  manager.line_client_id = ENV['LINE_CLIENT_ID']
+end
+
+# Rails Warden will use `id` to find user, but we want plain hash
+module Warden
+  class SessionSerializer
+    def serialize(user)
+      user
+    end
+
+    def deserialize(key)
+      key
+    end
+  end
+end
+```
+
+Create a plain object as model for decoded user.
+
+```ruby
+# app/models/user.rb
+
+class User
+  include ActiveModel::Model
+  include ActiveModel::Attributes
+
+  attribute :sub, :string
+  attribute :exp, :integer
+  attribute :name, :string
+  attribute :picture, :string
+  attribute :email, :string
+
+  def id
+    sub
+  end
+
+  def expired_at
+    @expired_at ||= Time.zone.at(exp)
+  rescue TypeError
+    Time.zone.now
+  end
+
+  def expired?
+    Time.zone.now >= expired_at
+  end
+end
+```
+
+Implement a controller to handle the session creation for sign-in and sign-out.
+
+```ruby
+# app/controller/sessions.rb
+
+class SessionsController < ActionController::Metal
+  include Authenticatable
+
+  def authenticate
+    # Ensure clear expired session
+    request.env['warden'].logout
+    request.env['warden'].authenticate!
+
+    @user = User.new(request.env['warden'].user.slice(*User.attribute_names))
+    # Post login actions
+  end
+end
+```
+
+## Roadmap
+
+* [x] Strategy for LINE ID Token
+* [ ] Rails Support
+  * [ ] Remove `rails_warden` dependency
+  * [ ] Helpers similar to `devise`
+* [ ] User object
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/elct9620/warden-line. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/elct9620/warden-line/blob/master/CODE_OF_CONDUCT.md).
+
+
+## Code of Conduct
+
+Everyone interacting in the Warden::Line project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/elct9620/warden-line/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'warden/line'
+
+# 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/warden/line.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'warden/line/version'
+require 'warden/strategies/line'
+
+module Warden
+  # Warden Strategies for LINE ID Token
+  #
+  # @since 0.1.0
+  module Line
+  end
+end
+
+Warden::Config.hash_accessor :line_client_id
+Warden::Strategies.add(:line, Warden::Strategies::Line)

data/lib/warden/line/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Warden
+  module Line
+    VERSION = '0.1.0'
+  end
+end

data/lib/warden/strategies/line.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'warden'
+
+module Warden
+  module Strategies
+    # LINE ID Token Strategies
+    #
+    # @since 0.1.0
+    class Line < Warden::Strategies::Base
+      # @since 0.1.0
+      VERIFY_TOKEN_URI = URI('https://api.line.me/oauth2/v2.1/verify')
+
+      # @return [TrueClass|FalseClass]
+      #
+      # @see Warden::Strategies::Base#valid?
+      #
+      # @since 0.1.0
+      def valid?
+        params['id_token'] != nil
+      end
+
+      # @see Warden::Strategies::Base#authenticate!
+      #
+      # @since 0.1.0
+      def authenticate!
+        success? ? success!(result) : fail!(result['error_description'])
+      end
+
+      # Token verify result
+      #
+      # @return [Hash] the verify result
+      #
+      # @since 0.1.0
+      def result
+        @result ||= JSON.parse(response.body)
+      rescue TypeError, JSON::ParserError
+        {}
+      end
+
+      # Token verify success or not
+      #
+      # @return [TrueClass|FalseClass]
+      #
+      # @since 0.1.0
+      def success?
+        response.code.to_i == 200
+      end
+
+      private
+
+      # @since 0.1.0
+      def response
+        @response ||= Net::HTTP.post_form(
+          VERIFY_TOKEN_URI,
+          id_token: params['id_token'],
+          client_id: @env['warden'].config[:line_client_id]
+        )
+      end
+    end
+  end
+end

data/warden-line.gemspec

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'lib/warden/line/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'warden-line'
+  spec.version       = Warden::Line::VERSION
+  spec.authors       = ['蒼時弦也']
+  spec.email         = ['contact@aotoki.dev']
+
+  spec.summary       = 'The warden strategies for LINE ID Token'
+  spec.description   = 'The warden strategies for LINE ID Token'
+  spec.homepage      = 'https://github.com/elct9620/warden-line'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/elct9620/warden-line'
+
+  # 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(__dir__)) 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_dependency 'warden', '~> 1.0'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: warden-line
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- 蒼時弦也
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: warden
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: The warden strategies for LINE ID Token
+email:
+- contact@aotoki.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".overcommit.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/warden/line.rb
+- lib/warden/line/version.rb
+- lib/warden/strategies/line.rb
+- warden-line.gemspec
+homepage: https://github.com/elct9620/warden-line
+licenses: []
+metadata:
+  homepage_uri: https://github.com/elct9620/warden-line
+  source_code_uri: https://github.com/elct9620/warden-line
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.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: The warden strategies for LINE ID Token
+test_files: []