line_login 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 631de5088443f630a2563f89c5c311edcb98fc384ba7d1f545b958e98e64109e
+  data.tar.gz: 227520805ea4b7eaefc94c883239f6e6eb8d83f78c65c08fda00fb4c7676c6b4
+SHA512:
+  metadata.gz: 1a7cab9d6648aba29df4edd2a983f8b82053d309553a2e92ca916d3f2bda35bcc37c68c0d60112173bf93504f3a9064d73e7e36ac01246cce8b62398ab8ccc94
+  data.tar.gz: a900cc24fb2c84fcd7629efc65aaa66b64206cbc63189aea2ff452e265ef9a4072d14c14aae027ae3118f6df1e495a3586b6b0fbde3e59c1729028695da80e13

data/README.md

@@ -0,0 +1,78 @@
+# LINE Login
+
+LINE Login is a [LINE Login 2.1](https://developers.line.biz/en/reference/line-login/) Client for Ruby.
+
+## Installation
+
+Add the following code to your application's Gemfile:
+
+```ruby
+gem 'line_login'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install line_login
+
+## Usage
+
+### initialize client instance
+
+```ruby
+client = LineLogin::Client.new(
+  client_id: "your line login client id",
+  client_secret: "your line login client secret",
+  redirect_uri: "your redirect uri"
+)
+```
+
+### get auth link
+
+Describe all parameters of this method in [the LINE Login documentation](https://developers.line.biz/en/docs/line-login/integrate-line-login/#making-an-authorization-request).
+
+There are no required parameters, the default value of scope is `profile%20openid%20email`, and state is `state`.
+
+```ruby
+auth_link = client.get_auth_link
+```
+
+You can override any parameter by passing it.
+
+```ruby
+auth_link = client.get_auth_link(scope: "", state: "state")
+```
+
+### get access token
+
+```ruby
+code = "you can get code from redirect uri after user click the auth link"
+token = client.get_access_token(code)
+```
+
+
+### revoke access token
+
+```
+response = client.revoke(token)
+```
+
+## Testing
+
+Type the following command in your terminal to run the tests:
+
+```
+rake spec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/etrex/line_login.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

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

data/lib/line_login/client.rb

@@ -0,0 +1,178 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "json"
+
+module LineLogin
+  class Client
+    attr_accessor :client_id
+    attr_accessor :client_secret
+    attr_accessor :redirect_uri
+    attr_accessor :api_origin
+    attr_accessor :access_origin
+
+    def initialize(client_id: "client_id", client_secret: "client_secret", redirect_uri: "redirect_uri", api_origin: "https://api.line.me", access_origin: "https://access.line.me")
+      self.client_id = client_id
+      self.client_secret = client_secret
+      self.redirect_uri = redirect_uri
+      self.api_origin = api_origin
+      self.access_origin = access_origin
+    end
+
+    # Get Auth Link
+    #
+    # Authenticating users and making authorization requests
+    #
+    # Initiate the process of authenticating the user with the LINE Platform and authorizing your app.
+    # When the user clicks a LINE Login button, redirect them to an authorization URL with the required query parameters,
+    # as shown in the example below.
+    #
+    def get_auth_link(options = {})
+      data = {
+        scope: "profile%20openid%20email",
+        response_type: "code",
+        client_id: self.client_id,
+        redirect_uri: self.redirect_uri,
+        state: "state"
+      }.merge(options);
+      "#{self.access_origin}/oauth2/v2.1/authorize?#{URI.encode_www_form(data)}"
+    end
+
+    # Issues access tokens.
+    #
+    # The access tokens managed through the LINE Login API attest that an app has been granted permission to access user data
+    # (such as user IDs, display names, profile images, and status messages) saved on the LINE Platform.
+    #
+    # LINE Login API calls require you to provide an access token or refresh token that was sent in an earlier response.
+    def issue_access_token(code: , redirect_uri: nil, code_verifier: nil)
+      option = {
+        url: "#{api_origin}/oauth2/v2.1/token",
+        header: {
+          "Content-Type": "application/x-www-form-urlencoded",
+        },
+        param: {
+          grant_type: :authorization_code,
+          code: code,
+          redirect_uri: redirect_uri || self.redirect_uri,
+          client_id: client_id,
+          client_secret: client_secret,
+          code_verifier: code_verifier
+        }
+      }
+      response = post(option)
+      JSON.parse(response.body)
+    end
+
+    # Verifies if an access token is valid.
+    #
+    # For general recommendations on how to securely handle user registration and login with access tokens,
+    # see Creating a secure login process between your app and server in the LINE Login documentation.
+    #
+    def verify_access_token(access_token: )
+      option = {
+        url: "#{api_origin}/oauth2/v2.1/verify?access_token=#{access_token}",
+      }
+      response = get(option)
+      JSON.parse(response.body)
+    end
+
+    # Refresh access token
+    #
+    # Gets a new access token using a refresh token.
+    # A refresh token is returned along with an access token once user authentication is complete.
+    #
+    def refresh_access_token(refresh_token: )
+      option = {
+        url: "#{api_origin}/oauth2/v2.1/token",
+        header: {
+          "Content-Type": "application/x-www-form-urlencoded",
+        },
+        param: {
+          grant_type: :refresh_token,
+          refresh_token: refresh_token,
+          client_id: client_id,
+          client_secret: client_secret
+        }
+      }
+      response = post(option)
+      JSON.parse(response.body)
+    end
+
+    # Revoke access token
+    #
+    # Invalidates a user's access token.
+    #
+    def revoke_access_token(access_token: )
+      option = {
+        url: "#{api_origin}/oauth2/v2.1/revoke",
+        header: {
+          "Content-Type": "application/x-www-form-urlencoded",
+        },
+        param: {
+          access_token: access_token,
+          client_id: client_id,
+          client_secret: client_secret
+        }
+      }
+      response = post(option)
+      response.body
+    end
+
+    # Verify ID token
+    #
+    # ID tokens are JSON web tokens (JWT) with information about the user.
+    # It's possible for an attacker to spoof an ID token.
+    # Use this call to verify that a received ID token is authentic,
+    # meaning you can use it to obtain the user's profile information and email.
+    #
+    def verify_id_token(id_token: , nonce: nil, user_id: nil)
+      param = {
+        id_token: id_token,
+        client_id: client_id
+      }
+      param[:nonce] = nonce unless nonce.nil?
+      param[:user_id] = user_id unless user_id.nil?
+
+      option = {
+        url: "#{api_origin}/oauth2/v2.1/verify",
+        header: {
+          "Content-Type": "application/x-www-form-urlencoded",
+        },
+        param: param
+      }
+      response = post(option)
+      JSON.parse(response.body)
+    end
+
+    private
+
+    # 發送一個get
+    # option: :url, :header, :param, :ssl_verify
+    def get(option)
+      url = URI(option[:url])
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = option[:url]["https://"].nil? == false
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless option[:ssl_verify]
+      request = Net::HTTP::Get.new(url)
+      option[:header]&.each do |key, value|
+        request[key] = value
+      end
+      http.request(request)
+    end
+
+    # 發送一個post
+    # option: :url, :header, :param, :ssl_verify
+    def post(option)
+      url = URI(option[:url])
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = option[:url]["https://"].nil? == false
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE unless option[:ssl_verify]
+      request = Net::HTTP::Post.new(url)
+      option[:header]&.each do |key, value|
+        request[key] = value
+      end
+      request.set_form_data(option[:param] || {})
+      http.request(request)
+    end
+  end
+end

data/lib/line_login/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module LineLogin
+  VERSION = "0.1.0"
+end

data/lib/line_login.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "line_login/client"
+require "line_login/version"

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: line_login
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- etrex kuo
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-01-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '13.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'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  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: json
+  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: Line Login 2.1 Client for Ruby
+email:
+- et284vu065k3@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/line_login.rb
+- lib/line_login/client.rb
+- lib/line_login/version.rb
+homepage: https://github.com/etrex/line_login
+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.1.6
+signing_key:
+specification_version: 4
+summary: Line Login 2.1 Client
+test_files: []