its-ruby-auth 0.0.1

data/app/models/ibrain/user.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Ibrain
+  class User < Ibrain::Base
+    attr_accessor :jwt_token
+
+    include Devise::JWT::RevocationStrategies::JTIMatcher
+
+    self.abstract_class = true
+    self.table_name = Ibrain::Auth::Config.user_table_name
+
+    devise(*Ibrain::Auth::Config.devise_enabled_modules, jwt_revocation_strategy: self, omniauth_providers: Ibrain::Auth::Config.devise_omniauth_providers)
+
+    scope :find_by_line, ->(uid) {
+      find_by(uid: uid, provider: 'line')
+    }
+
+    scope :find_by_apple, ->(uid) {
+      find_by(uid: uid, provider: 'apple')
+    }
+
+    def jwt_payload
+      # for hasura
+      hasura_keys = {
+          'https://hasura.io/jwt/claims': {
+          'x-hasura-allowed-roles': Ibrain.user_class.roles.keys,
+          'x-hasura-default-role': role,
+          'x-hasura-user-id': id.to_s
+        }
+      }
+
+      super.merge(
+        {
+          'role' => role,
+          'exp' => determine_expiration
+        }, hasura_keys)
+    end
+
+    def can_skip_confirmation?
+      try(:is_admin?) || email.blank?
+    end
+
+    class << self
+      def ibrain_find(params, available_columns)
+        matched_value = params[:username] || params[:email]
+
+        if matched_value.present?
+          query = available_columns.map do |column_name|
+            <<~RUBY
+              #{column_name} = '#{matched_value}'
+            RUBY
+          end.join(' OR ')
+
+          where(query).first
+        end
+      end
+
+      def social_find_or_initialize(params)
+        user = find_by(provider: params[:provider], uid: params[:uid])
+        return user if user.present?
+
+        create!(params)
+      end
+
+      def create_with_line!(params)
+        user = created!({
+          uid: params['uid'],
+          provider: 'line',
+          remote_avatar_url: params['info']['image']
+        })
+
+        user.skip_confirmation! unless user&.confirmed?
+        user
+      end
+
+      def random_password
+        (('A'..'Z').to_a.sample(4) + ["~", "!", "@", "#", "$", "%", "^", "&", "*", "_", "-"].sample(1) + ('0'..'9').to_a.sample(2) + ('a'..'z').to_a.sample(4)).join
+      end
+    end
+
+    private
+
+    def determine_expiration
+      expiration_time = IbrainJwtExpiration.expiration_time[role] || IbrainJwtExpiration.expiration_time['default']
+      expiration_time.from_now.to_i
+    end
+  end
+end

data/app/repositories/apple_repository.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class AppleRepository < Ibrain::BaseRepository
+  def initialize(record, params)
+    super(nil, record)
+
+    @params = params
+    @collection = Ibrain.user_class
+  end
+
+  def find_or_initialize!
+    user = @collection.find_by_apple(uid: params['uid'])
+    return user if user.present?
+
+    @collection.create_with_line!
+  end
+end

data/app/repositories/auth_repository.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+ACCOUNT_COUMNS = %w[username email phone phone_number]
+
+class AuthRepository < Ibrain::BaseRepository
+  def initialize(record, params)
+    super(nil, record)
+
+    @params = params
+    @collection = Ibrain.user_class
+  end
+
+  def create
+    user = collection.new(provider: 'manual')
+    user.assign_attributes(normalize_params.except(:id_token))
+    user.save!
+
+    user
+  end
+
+  def sign_in
+    return firebase_verify if is_social?
+
+    user = collection.ibrain_find(manual_params, available_columns)
+    return unless user.try(:valid_password?, manual_params[:password])
+
+    user
+  end
+
+  private
+
+  attr_reader :params, :collection
+
+  def firebase_url
+    "https://www.googleapis.com/identitytoolkit/v3/relyingparty/getAccountInfo?key=#{firebase_api_key}"
+  end
+
+  def firebase_update_url
+    "https://identitytoolkit.googleapis.com/v1/accounts:update?key=#{firebase_api_key}"
+  end
+
+  def firebase_api_key
+    Ibrain::Auth::Config.firebase_api_key
+  end
+
+  def base_headers
+    {
+      'Content-Type' => 'application/json'
+    }
+  end
+
+  def normalize_params
+    params.permit(permitted_attributes)
+  end
+
+  def manual_params
+    params.permit(:username, :password)
+  end
+
+  def firebase_verify
+    response = HTTParty.post(firebase_url, headers: base_headers, body: { 'idToken' => normalize_params[:id_token] }.to_json )
+    user_information = response.try(:fetch, 'users', []).try(:at, 0)
+
+    uid = user_information.try(:fetch, 'localId', nil)
+    provider = user_information.
+      try(:fetch, 'providerUserInfo', []).
+      try(:at, 0).try(:fetch, 'providerId', '').
+      try(:gsub, '.com', '')
+    raise ActionController::InvalidAuthenticityToken, I18n.t('ibrain.errors.account.not_found') if uid.blank?
+
+    provider = 'custom' if user_information.try(:fetch, 'customAuth', false) && provider.blank?
+
+    collection.social_find_or_initialize({
+      uid: uid,
+      provider: provider,
+      remote_avatar_url: user_information.try(:fetch, 'photoUrl', nil),
+      email: user_information.try(:fetch, 'email', nil),
+      password: collection.random_password
+    })
+  end
+
+  def available_columns
+    collection.column_names.select { |f| ACCOUNT_COUMNS.include?(f) }
+  end
+
+  def is_social?
+    normalize_params[:id_token].present?
+  end
+
+  def permitted_attributes
+    Ibrain.user_class.permitted_attributes.reject { |k| permintted_columns.include?(k) }.map(&:to_sym).concat([:id_token]).concat([:password])
+  end
+
+  def permintted_columns
+    %w[
+      reset_password_token reset_password_sent_at
+      remember_created_at sign_in_count uid jti
+      current_sign_in_at last_sign_in_at current_sign_in_ip
+      last_sign_in_ip role encrypted_password id_token
+    ]
+  end
+end

data/app/repositories/firebase_repository.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'open-uri'
+
+class FirebaseRepository < Ibrain::BaseRepository
+  def initialize(record, params)
+    super(nil, record)
+
+    @private_key_json = load_private_file
+    @firebase_owner_email = Ibrain::Auth::Config.firebase_owner_email
+    @params = params
+  end
+
+  def generate_custom_token!
+    iat = Time.now.to_i
+    exp = 60.minutes.from_now.to_i
+    uid = retrieve_uid_execution
+
+    raise IbrainErrors::UnknownError.new I18n.t("ibrain.errors.custom_token.not_retrieve_uid") unless uid
+
+    payload = {
+      iss: firebase_owner_email,
+      sub: firebase_owner_email,
+      aud: Ibrain::Auth::Config.firebase_auth_url,
+      iat: iat,
+      exp: exp,
+      uid: uid,
+      claims: {}
+    }
+
+    JWT.encode payload, private_key, "RS256"
+  end
+
+  private
+
+  attr_reader :private_key_json, :firebase_owner_email, :params
+
+  def json_firebase
+    JSON.parse(private_key_json, symbolize_names: true)
+  end
+
+  def private_key
+    OpenSSL::PKey::RSA.new json_firebase[:private_key]
+  end
+
+  def load_private_file
+    is_remote = Ibrain::Auth::Config.firebase_private_key_path.include?("http")
+
+    if is_remote
+      uri = URI.parse(Ibrain::Auth::Config.firebase_private_key_path)
+      content = uri.open { |f| f.read }
+
+      return content
+    end
+
+    File.open(Ibrain::Auth::Config.firebase_private_key_path).read
+  end
+
+  def retrieve_uid_execution
+    if params[:access_token].present?
+      return LineRepository.singleton.retrieve_uid_by_access_token(access_token: params[:access_token])
+    end
+
+    LineRepository.singleton.retrieve_uid(
+      code: params[:code],
+      redirect_uri: params[:redirect_uri]
+    )
+  end
+end

data/app/repositories/line_repository.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+class LineRepository
+  LINE_BASE_HEADERS = {
+    'Content-Type': "application/x-www-form-urlencoded"
+  }.freeze
+
+  LINE_TOKEN_URL = "https://api.line.me/oauth2/v2.1/token"
+  LINE_INFORMATION_URL = "https://api.line.me/v2/profile"
+
+  def self.singleton
+    @singleton ||= new
+  end
+
+  def retrieve_access_token(redirect_uri:, code:)
+    response = HTTParty.post(
+      LINE_TOKEN_URL,
+      headers: LINE_BASE_HEADERS,
+      body: URI.encode_www_form({
+        grant_type: "authorization_code",
+        code: code,
+        redirect_uri: redirect_uri,
+        client_id: Ibrain::Auth::Config.line_client_id,
+        client_secret: Ibrain::Auth::Config.line_client_secret
+      })
+    )
+
+    response.try(:fetch, "access_token", nil)
+  end
+
+  def retrieve_uid(redirect_uri:, code:)
+    token = retrieve_access_token(
+      redirect_uri: redirect_uri,
+      code: code
+    )
+
+    response = HTTParty.get(
+      LINE_INFORMATION_URL,
+      headers: LINE_BASE_HEADERS.merge({
+        'Authorization' => "Bearer #{token}"
+      })
+    )
+
+    response.try(:fetch, 'userId', nil)
+  end
+
+  def retrieve_uid_by_access_token(access_token:)
+    response = HTTParty.get(
+      LINE_INFORMATION_URL,
+      headers: LINE_BASE_HEADERS.merge({
+        'Authorization' => "Bearer #{access_token}"
+      })
+    )
+
+    response.try(:fetch, 'userId', nil)
+  end
+end

data/config/initializers/devise.rb

@@ -0,0 +1,314 @@
+# frozen_string_literal: true
+
+# Assuming you have not yet modified this file, each configuration option below
+# is set to its default value. Note that some are commented out while others
+# are not: uncommented lines are intended to protect your configuration from
+# breaking changes in upgrades (i.e., in the event that future versions of
+# Devise change the default values for those options).
+#
+# Use this hook to configure devise mailer, warden hooks and so forth.
+# Many of these configuration options can be set straight in your model.
+Devise.setup do |config|
+  # The secret key used by Devise. Devise uses this key to generate
+  # random tokens. Changing this key will render invalid all existing
+  # confirmation, reset password and unlock tokens in the database.
+  # Devise will use the `secret_key_base` as its `secret_key`
+  # by default. You can change it below and use your own secret key.
+  config.secret_key = SecureRandom.hex(50).inspect
+
+  # ==> Controller configuration
+  # Configure the parent class to the devise controllers.
+  # config.parent_controller = 'DeviseController'
+
+  # ==> Mailer Configuration
+  # Configure the e-mail address which will be shown in Devise::Mailer,
+  # note that it will be overwritten if you use your own mailer class
+  # with default "from" parameter.
+  config.mailer_sender = 'please-change-me-at-config-initializers-devise@example.com'
+
+  # Configure the class responsible to send e-mails.
+  # config.mailer = 'Devise::Mailer'
+
+  # Configure the parent class responsible to send e-mails.
+  # config.parent_mailer = 'ActionMailer::Base'
+
+  # ==> ORM configuration
+  # Load and configure the ORM. Supports :active_record (default) and
+  # :mongoid (bson_ext recommended) by default. Other ORMs may be
+  # available as additional gems.
+  require 'devise/orm/active_record'
+
+  # ==> Configuration for any authentication mechanism
+  # Configure which keys are used when authenticating a user. The default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating a user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # You can also supply a hash where the value is a boolean determining whether
+  # or not authentication should be aborted when the value is not present.
+  config.authentication_keys = [:username, :email]
+
+  # Configure parameters from the request object used for authentication. Each entry
+  # given should be a request method and it will automatically be passed to the
+  # find_for_authentication method and considered in your model lookup. For instance,
+  # if you set :request_keys to [:subdomain], :subdomain will be used on authentication.
+  # The same considerations mentioned for authentication_keys also apply to request_keys.
+  # config.request_keys = []
+
+  # Configure which authentication keys should be case-insensitive.
+  # These keys will be downcased upon creating or modifying a user and when used
+  # to authenticate or find a user. Default is :username.
+  config.case_insensitive_keys = [:username, :email]
+
+  # Configure which authentication keys should have whitespace stripped.
+  # These keys will have whitespace before and after removed upon creating or
+  # modifying a user and when used to authenticate or find a user. Default is :username.
+  config.strip_whitespace_keys = [:username, :email]
+
+  # Tell if authentication through request.params is enabled. True by default.
+  # It can be set to an array that will enable params authentication only for the
+  # given strategies, for example, `config.params_authenticatable = [:database]` will
+  # enable it only for database (email + password) authentication.
+  # config.params_authenticatable = true
+
+  # Tell if authentication through HTTP Auth is enabled. False by default.
+  # It can be set to an array that will enable http authentication only for the
+  # given strategies, for example, `config.http_authenticatable = [:database]` will
+  # enable it only for database authentication.
+  # For API-only applications to support authentication "out-of-the-box", you will likely want to
+  # enable this with :database unless you are using a custom strategy.
+  # The supported strategies are:
+  # :database      = Support basic authentication with authentication key + password
+  # config.http_authenticatable = false
+
+  # If 401 status code should be returned for AJAX requests. True by default.
+  # config.http_authenticatable_on_xhr = true
+
+  # The realm used in Http Basic Authentication. 'Application' by default.
+  # config.http_authentication_realm = 'Application'
+
+  # It will change confirmation, password recovery and other workflows
+  # to behave the same regardless if the e-mail provided was right or wrong.
+  # Does not affect registerable.
+  # config.paranoid = true
+
+  # By default Devise will store the user in session. You can skip storage for
+  # particular strategies by setting this option.
+  # Notice that if you are skipping storage for all authentication paths, you
+  # may want to disable generating routes to Devise's sessions controller by
+  # passing skip: :sessions to `devise_for` in your config/routes.rb
+  config.skip_session_storage = [:http_auth]
+
+  # By default, Devise cleans up the CSRF token on authentication to
+  # avoid CSRF token fixation attacks. This means that, when using AJAX
+  # requests for sign in and sign up, you need to get a new CSRF token
+  # from the server. You can disable this option at your own risk.
+  # config.clean_up_csrf_token_on_authentication = true
+
+  # When false, Devise will not attempt to reload routes on eager load.
+  # This can reduce the time taken to boot the app but if your application
+  # requires the Devise mappings to be loaded during boot time the application
+  # won't boot properly.
+  # config.reload_routes = true
+
+  # ==> Configuration for :database_authenticatable
+  # For bcrypt, this is the cost for hashing the password and defaults to 12. If
+  # using other algorithms, it sets how many times you want the password to be hashed.
+  # The number of stretches used for generating the hashed password are stored
+  # with the hashed password. This allows you to change the stretches without
+  # invalidating existing passwords.
+  #
+  # Limiting the stretches to just one in testing will increase the performance of
+  # your test suite dramatically. However, it is STRONGLY RECOMMENDED to not use
+  # a value less than 10 in other environments. Note that, for bcrypt (the default
+  # algorithm), the cost increases exponentially with the number of stretches (e.g.
+  # a value of 20 is already extremely slow: approx. 60 seconds for 1 calculation).
+  config.stretches = Rails.env.test? ? 1 : 12
+
+  # Set up a pepper to generate the hashed password.
+  # config.pepper = '3df46a10f22a3580f28b33634134bfbfe9c62f8fb9dc18c8d310d174f7699b939e6fa64761c45674580487804f1f514d0d9b11538d3fc90a1c514e21dd4f1ce1'
+
+  # Send a notification to the original email when the user's email is changed.
+  # config.send_email_changed_notification = false
+
+  # Send a notification email when the user's password is changed.
+  # config.send_password_change_notification = false
+
+  # ==> Configuration for :confirmable
+  # A period that the user is allowed to access the website even without
+  # confirming their account. For instance, if set to 2.days, the user will be
+  # able to access the website for two days without confirming their account,
+  # access will be blocked just in the third day.
+  # You can also set it to nil, which will allow the user to access the website
+  # without confirming their account.
+  # Default is 0.days, meaning the user cannot access the website without
+  # confirming their account.
+  # config.allow_unconfirmed_access_for = 2.days
+
+  # A period that the user is allowed to confirm their account before their
+  # token becomes invalid. For example, if set to 3.days, the user can confirm
+  # their account within 3 days after the mail was sent, but on the fourth day
+  # their account can't be confirmed with the token any more.
+  # Default is nil, meaning there is no restriction on how long a user can take
+  # before confirming their account.
+  # config.confirm_within = 3.days
+
+  # If true, requires any email changes to be confirmed (exactly the same way as
+  # initial account confirmation) to be applied. Requires additional unconfirmed_email
+  # db field (see migrations). Until confirmed, new email is stored in
+  # unconfirmed_email column, and copied to email column on successful confirmation.
+  config.reconfirmable = true
+
+  # Defines which key will be used when confirming an account
+  # config.confirmation_keys = [:email]
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # Invalidates all the remember me tokens when the user signs out.
+  config.expire_all_remember_me_on_sign_out = true
+
+  # If true, extends the user's remember period when remembered via cookie.
+  # config.extend_remember_period = false
+
+  # Options to be passed to the created cookie. For instance, you can set
+  # secure: true in order to force SSL only cookies.
+  # config.rememberable_options = {}
+
+  # ==> Configuration for :validatable
+  # Range for password length.
+  config.password_length = 6..128
+
+  # Email regex used to validate email formats. It simply asserts that
+  # one (and only one) @ exists in the given string. This is mainly
+  # to give user feedback and not to assert the e-mail validity.
+  config.email_regexp = /\A[^@\s]+@[^@\s]+\z/
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again. Default is 30 minutes.
+  # config.timeout_in = 30.minutes
+
+  # ==> Configuration for :lockable
+  # Defines which strategy will be used to lock an account.
+  # :failed_attempts = Locks an account after a number of failed attempts to sign in.
+  # :none            = No lock strategy. You should handle locking by yourself.
+  # config.lock_strategy = :failed_attempts
+
+  # Defines which key will be used when locking and unlocking an account
+  # config.unlock_keys = [:email]
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Re-enables login after a certain amount of time (see :unlock_in below)
+  # :both  = Enables both strategies
+  # :none  = No unlock strategy. You should handle unlocking by yourself.
+  # config.unlock_strategy = :both
+
+  # Number of authentication tries before locking an account if lock_strategy
+  # is failed attempts.
+  # config.maximum_attempts = 20
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # Warn on the last attempt before the account is locked.
+  # config.last_attempt_warning = true
+
+  # ==> Configuration for :recoverable
+  #
+  # Defines which key will be used when recovering the password for an account
+  # config.reset_password_keys = [:email]
+
+  # Time interval you can reset your password with a reset password key.
+  # Don't put a too small interval or your users won't have the time to
+  # change their passwords.
+  config.reset_password_within = 6.hours
+
+  # When set to false, does not sign a user in automatically after their password is
+  # reset. Defaults to true, so a user is signed in automatically after a reset.
+  # config.sign_in_after_reset_password = true
+
+  # ==> Configuration for :encryptable
+  # Allow you to use another hashing or encryption algorithm besides bcrypt (default).
+  # You can use :sha1, :sha512 or algorithms from others authentication tools as
+  # :clearance_sha1, :authlogic_sha512 (then you should set stretches above to 20
+  # for default behavior) and :restful_authentication_sha1 (then you should set
+  # stretches to 10, and copy REST_AUTH_SITE_KEY to pepper).
+  #
+  # Require the `devise-encryptable` gem when using anything other than bcrypt
+  # config.encryptor = :sha512
+
+  # ==> Scopes configuration
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "users/sessions/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = false
+
+  # Configure the default scope given to Warden. By default it's the first
+  # devise role declared in your routes (usually :user).
+  # config.default_scope = :user
+
+  # Set this configuration to false if you want /users/sign_out to sign out
+  # only the current scope. By default, Devise signs out all scopes.
+  # config.sign_out_all_scopes = true
+
+  # ==> Navigation configuration
+  # Lists the formats that should be treated as navigational. Formats like
+  # :html, should redirect to the sign in page when the user does not have
+  # access, but formats like :xml or :json, should return 401.
+  #
+  # If you have any extra navigational formats, like :iphone or :mobile, you
+  # should add them to the navigational formats lists.
+  #
+  # The "*/*" below is required to match Internet Explorer requests.
+  # config.navigational_formats = ['*/*', :html]
+
+  # The default HTTP method used to sign out a resource. Default is :delete.
+  config.sign_out_via = :delete
+
+  # ==> OmniAuth
+  # Add a new OmniAuth provider. Check the wiki for more information on setting
+  # up on your models and hooks.
+  # config.omniauth :github, 'APP_ID', 'APP_SECRET', scope: 'user,public_repo'
+
+  # ==> Warden configuration
+  # If you want to use other strategies, that are not supported by Devise, or
+  # change the failure app, you can configure them inside the config.warden block.
+  #
+  # config.warden do |manager|
+  #   manager.intercept_401 = false
+  #   manager.default_strategies(scope: :user).unshift :some_external_strategy
+  # end
+
+  # ==> Mountable engine configurations
+  # When using Devise inside an engine, let's call it `MyEngine`, and this engine
+  # is mountable, there are some extra configurations to be taken into account.
+  # The following options are available, assuming the engine is mounted as:
+  #
+  #     mount MyEngine, at: '/my_engine'
+  #
+  # The router that invoked `devise_for`, in the example above, would be:
+  # config.router_name = :my_engine
+  #
+  # When using OmniAuth, Devise cannot automatically set OmniAuth path,
+  # so you need to do it manually. For the users scope, it would be:
+  # config.omniauth_path_prefix = '/my_engine/users/auth'
+
+  # ==> Turbolinks configuration
+  # If your app is using Turbolinks, Turbolinks::Controller needs to be included to make redirection work correctly:
+  #
+  # ActiveSupport.on_load(:devise_failure_app) do
+  #   include Turbolinks::Controller
+  # end
+
+  # ==> Configuration for :registerable
+
+  # When set to false, does not sign a user in automatically after their password is
+  # changed. Defaults to true, so a user is signed in automatically after changing a password.
+  # config.sign_in_after_change_password = true
+
+  config.remember_for = 2.weeks
+  config.timeout_in = 2.weeks
+end

data/config/initializers/ibrain_jwt_expiration.rb

@@ -0,0 +1,9 @@
+module IbrainJwtExpiration
+  mattr_accessor :expiration_time
+
+  self.expiration_time = {
+    'admin' => 8.hours,
+    'user' => 30.days,
+    'default' => 8.hours
+  }
+end

data/config/locales/en.yml

@@ -0,0 +1,17 @@
+en:
+  ibrain:
+    system:
+      messages:
+        success: Retrieving data successfully
+        ok: Retrieving data successfully
+    errors:
+      session:
+        invalid_session: Invalid login session. Please try again!
+        expired_session: The login session has expired.
+      account:
+        not_found: Account not found
+        incorrect: Username or Password is incorrect!
+        not_verified: Please verify your account before login
+        is_deactivated: Account inactive
+      custom_token:
+        not_retrieve_uid: Can not retrieve uid