yalla_auth_ruby_client 1.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a742e8d8188ae6641429152574de7bc12a62fe0fb867d6383e302a8deada77e8
-  data.tar.gz: 97574dbd9b7c937fba1dd1e7c6fea16ec84d1e1d521cf1e80cd2609ce43d5023
+  metadata.gz: d5d0daaf481f7552506732d1fc02b5adcdd993eaebf7136981817b78eb052849
+  data.tar.gz: 6e2896599fe4d9820cab1117c45f5f5b91927add54c2b85a01b6aa6b7c4219d6
 SHA512:
-  metadata.gz: 834cc3bf8475fbfc977823dc7f07f8cca31bf72e07f4f15db69e1da39852902b312effc86f8b1bf31b29f7cd858d4d708ab3f41c24904ab28d4cb31f3cfd126c
-  data.tar.gz: 0c902721a7819f7260e4db25ac26cff60d09dd1f2098d28c280fd08210ad257daba5bc0dcc0480cd943c49ba4f1202bf3cd4eef1153360354ce9b27ef917a6ea
+  metadata.gz: 493756c3593d198b8a1d2178a7035b620eac083145bd82cae84cfc5bc5b10b837fc0a5bc7ed3c66119ebc87dc45dd7526e79656565ba5990ac1263e00f61a248
+  data.tar.gz: 9e23efe2ff05c8d85f44d82f32d49fed84966ca3df085bd7d19d4da74dee4e3ec4857fd84fee561353baee6d0de6a9aa12da4beea2a327b7459430a897c17e97

data/README.md

@@ -49,6 +49,49 @@ Include the Ruby code directly using `-I` as follows:
 ruby -Ilib script.rb
 ```
 
+### Install `yalla_id` column
+
+Create an `AppUser` model in your application first. Then run the generator to
+add the `yalla_id` column via a migration:
+
+```shell
+bin/rails generate yalla_auth_ruby_client:user
+```
+
+## Controller helpers
+
+Include `YallaAuthRubyClient::ControllerAuthentication` in your controllers to
+use a few helper methods:
+
+```ruby
+class ApplicationController < ActionController::Base
+  include YallaAuthRubyClient::ControllerAuthentication
+end
+```
+
+- `authenticate_user` validates the `auth_token` cookie and sets `current_user`.
+- `authenticate_user!` redirects to `ENV["AUTH_URL"]/users/sign_in` with a
+  `redirect_uri` back to the current URL when authentication fails.
+- `current_user` returns an instance of `AppUser` created using the `yalla_id`
+  provided by the authentication service.
+- `logout` clears the cookie and redirects to `ENV["AUTH_URL"]`.
+
+For controllers that inherit from `ActionController::API`, the engine includes
+`YallaAuthRubyClient::ApiControllerAuthentication`, which reads the bearer token
+from the `Authorization` header. It exposes the same helpers but responds with a
+`401` JSON body containing the `redirect_uri` when authentication fails instead
+of issuing an HTTP redirect.
+
+### Use the authentication middleware
+
+Add `YallaAuthRubyClient::AuthTokenMiddleware` to your Rails middleware stack
+to automatically validate a `token` parameter and store it in a signed cookie.
+
+```ruby
+# config/application.rb
+config.middleware.use YallaAuthRubyClient::AuthTokenMiddleware
+```
+
 ## Getting Started
 
 Please follow the [installation](#installation) procedure and then run the following code:

data/RELEASE.md

@@ -0,0 +1,9 @@
+# 2.0.0
+
+Include authenticate_user
+    Breaking changes
+Include AppUser yalla_id migration
+
+# 1.0.0
+
+Swagger client

data/lib/generators/yalla_auth_ruby_client/templates/add_yalla_id_to_app_users.rb

@@ -0,0 +1,6 @@
+class AddYallaIdToAppUsers < ActiveRecord::Migration[6.0]
+  def change
+    add_column :app_users, :yalla_id, :string, null: false
+    add_index :app_users, :yalla_id, unique: true
+  end
+end

data/lib/generators/yalla_auth_ruby_client/user_generator.rb

@@ -0,0 +1,28 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module YallaAuthRubyClient
+  module Generators
+    class UserGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+      source_root File.expand_path('templates', __dir__)
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          sprintf("%03d", current_migration_number(dirname) + 1)
+        end
+      end
+
+      def create_migration_file
+        unless File.exist?(File.join(destination_root, 'app/models/app_user.rb'))
+          say_status :error, 'AppUser model not found. Please create app/models/app_user.rb before running this generator.', :red
+          return
+        end
+
+        migration_template 'add_yalla_id_to_app_users.rb', 'db/migrate/add_yalla_id_to_app_users.rb'
+      end
+    end
+  end
+end

data/lib/openapi_client/configuration.rb

@@ -158,7 +158,7 @@ module OpenapiClient
 
     def initialize
       @scheme = ENV['AUTH_URL'].split("://").first
-      @host = ENV['AUTH_URL'].split("://").last
+      @host = ENV['AUTH_URL'].split("://").last.gsub("/", "")
       @base_path = ''
       @server_index = nil
       @server_operation_index = {}

data/lib/openapi_client/version.rb

@@ -11,5 +11,5 @@ Generator version: 7.12.0
 =end
 
 module OpenapiClient
-  VERSION = '1.0.0'
+  VERSION = '2.0.1'
 end

data/lib/yalla_auth_ruby_client/api_controller_authentication.rb

@@ -0,0 +1,58 @@
+module YallaAuthRubyClient
+  module ApiControllerAuthentication
+    def logout
+      render json: { redirect_uri: ENV["AUTH_URL"] }
+    end
+
+    def authenticate_user
+      token = bearer_token
+      return false unless token.present?
+
+      begin
+        api_client = OpenapiClient::AuthApi.new
+        response = api_client.auth_validate_token_get(token)
+
+        if response && response.success
+          @yalla_user = response.user
+          @current_user = find_or_create_app_user(@yalla_user)
+          true
+        else
+          false
+        end
+      rescue OpenapiClient::ApiError => e
+        Rails.logger.error "Authentication failed: #{e.message}"
+        false
+      end
+    end
+
+    def authenticate_user!
+      return if authenticate_user
+
+      render json: { error: 'unauthorized', redirect_uri: login_redirect_uri }, status: :unauthorized
+    end
+
+    def current_user
+      @current_user
+    end
+
+    private
+
+    def bearer_token
+      auth_header = request.headers['Authorization'].to_s
+      return unless auth_header.present?
+
+      scheme, token = auth_header.split(' ', 2)
+      return unless scheme&.casecmp('Bearer')&.zero?
+
+      token&.strip.presence
+    end
+
+    def find_or_create_app_user(user)
+      AppUser.find_or_create_by(yalla_id: user.id)
+    end
+
+    def login_redirect_uri
+      "#{ENV['AUTH_URL']}/users/sign_in?redirect_uri=#{request.original_url}"
+    end
+  end
+end

data/lib/yalla_auth_ruby_client/controller_authentication.rb

@@ -0,0 +1,47 @@
+module YallaAuthRubyClient
+  module ControllerAuthentication
+    def logout
+      cookies.delete(:auth_token, httponly: true)
+      redirect_to ENV["AUTH_URL"], allow_other_host: true
+    end
+
+    def authenticate_user
+      token = cookies.signed[:auth_token]
+      return false unless token.present?
+
+      begin
+        api_client = OpenapiClient::AuthApi.new
+        response = api_client.auth_validate_token_get(token)
+
+        if response && response.success
+          @yalla_user = response.user
+          @current_user = find_or_create_app_user(@yalla_user)
+          true
+        else
+          cookies.delete(:auth_token)
+          false
+        end
+      rescue OpenapiClient::ApiError => e
+        Rails.logger.error "Authentication failed: #{e.message}"
+        cookies.delete(:auth_token)
+        false
+      end
+    end
+
+    def authenticate_user!
+      return if authenticate_user
+
+      redirect_to "#{ENV['AUTH_URL']}/users/sign_in?redirect_uri=#{request.original_url}", allow_other_host: true
+    end
+
+    def current_user
+      @current_user
+    end
+
+    private
+
+    def find_or_create_app_user(user)
+      AppUser.find_or_create_by(yalla_id: user.id)
+    end
+  end
+end

data/lib/yalla_auth_ruby_client/middleware/auth_token_middleware.rb

@@ -0,0 +1,33 @@
+require "openapi_client"
+require "action_dispatch/middleware/cookies"
+
+module YallaAuthRubyClient
+  class AuthTokenMiddleware
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      request = Rack::Request.new(env)
+
+      if (token = request.params["token"])
+        api_client = OpenapiClient::AuthApi.new
+        begin
+          response = api_client.auth_validate_token_get(token)
+
+          if response && response.success
+            request_env = ActionDispatch::Request.new(env)
+            request_env.cookie_jar.signed[:auth_token] = { value: token, httponly: true }
+          end
+        rescue OpenapiClient::ApiError => e
+          Rails.logger.error "Authentication failed: #{e.message}"
+        end
+
+        clean_url = request.fullpath.gsub(/[\?&]token=[^&]*/, "").sub(/\?$/, "")
+        return [302, { "Location" => clean_url, "Content-Type" => "text/html" }, ["Redirecting..."]] unless clean_url == request.fullpath
+      end
+
+      @app.call(env)
+    end
+  end
+end

data/lib/yalla_auth_ruby_client.rb

@@ -0,0 +1,19 @@
+require 'openapi_client'
+require 'rails/railtie'
+require 'yalla_auth_ruby_client/controller_authentication'
+require 'yalla_auth_ruby_client/api_controller_authentication'
+require 'yalla_auth_ruby_client/middleware/auth_token_middleware'
+
+module YallaAuthRubyClient
+  class Engine < ::Rails::Engine
+    initializer 'yalla_auth_ruby_client.controller_methods' do
+      ActiveSupport.on_load(:action_controller_base) do
+        include YallaAuthRubyClient::ControllerAuthentication
+      end
+
+      ActiveSupport.on_load(:action_controller_api) do
+        include YallaAuthRubyClient::ApiControllerAuthentication
+      end
+    end
+  end
+end

data/yalla_auth_ruby_client.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
   s.metadata    = {}
 
   s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'rails', '>= 5'
 
   s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: yalla_auth_ruby_client
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Yalla auth openapi client
 bindir: bin
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -29,6 +29,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,6 +72,7 @@ extra_rdoc_files: []
 files:
 - Gemfile
 - README.md
+- RELEASE.md
 - Rakefile
 - docs/App.md
 - docs/AppsApi.md
@@ -69,6 +84,8 @@ files:
 - docs/UserRoleAdd.md
 - docs/UsersApi.md
 - git_push.sh
+- lib/generators/yalla_auth_ruby_client/templates/add_yalla_id_to_app_users.rb
+- lib/generators/yalla_auth_ruby_client/user_generator.rb
 - lib/openapi_client.rb
 - lib/openapi_client/api/apps_api.rb
 - lib/openapi_client/api/auth_api.rb
@@ -83,6 +100,10 @@ files:
 - lib/openapi_client/models/user_app_add.rb
 - lib/openapi_client/models/user_role_add.rb
 - lib/openapi_client/version.rb
+- lib/yalla_auth_ruby_client.rb
+- lib/yalla_auth_ruby_client/api_controller_authentication.rb
+- lib/yalla_auth_ruby_client/controller_authentication.rb
+- lib/yalla_auth_ruby_client/middleware/auth_token_middleware.rb
 - spec/api/apps_api_spec.rb
 - spec/api/auth_api_spec.rb
 - spec/api/users_api_spec.rb
@@ -112,17 +133,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.8
 specification_version: 4
 summary: API V1 Ruby Gem
 test_files:
-- spec/api/auth_api_spec.rb
 - spec/api/apps_api_spec.rb
+- spec/api/auth_api_spec.rb
 - spec/api/users_api_spec.rb
+- spec/models/app_spec.rb
 - spec/models/auth_validate_token_get200_response_spec.rb
+- spec/models/role_spec.rb
 - spec/models/user_app_add_spec.rb
 - spec/models/user_role_add_spec.rb
-- spec/models/app_spec.rb
 - spec/models/user_spec.rb
-- spec/models/role_spec.rb
 - spec/spec_helper.rb