ez-sessions 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 445c175853224ec654356b2597d2a5437b9d1c52ab42de8e82d6509b5a6275f0
+  data.tar.gz: c75c20fccc7706167af11a2193b0486f583124dd1d35cb75bf19b8e2f62fff43
+SHA512:
+  metadata.gz: 5548ce03a1717e440e5237436c25d67577b5f666f3fa80661b726ee9da9cde6c6310c419681ccbad69644036b4bb85a883201e87a354cfe7e68d8f06a350817d
+  data.tar.gz: cac80f99e30a5de7202c6f8f09eae33c3d4fdad1e4f0c5669e30a7b9cbe40c06fe159b7c7124c606432593b17138d83815fea042250424eba2131845f189d025

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Volodya Sveredyuk
+
+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,43 @@
+# Ez::Sessions
+A simple `ActiveRecord` model for storing user sessions in the database and encode/decode tokens. Works perfectly for API-based apps.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ez-sessions'
+```
+
+Use built-in generators:
+```sh
+rails generate ez:sessions:install
+rails generate ez:sessions:migrations
+```
+
+## Usage
+
+Extend your module with api
+```ruby
+module Auth
+  extend Ez::Sessions::API
+end
+```
+
+Examples:
+
+```ruby
+session = Auth.create_session(user_id: 1, user_agent: 'Postman', expires_at: 90.days.from_now)
+session.user_id # => 1
+session.user_agent # => 'Postman'
+session.expires_at.to_s # => '2021-10-02 14:18:21 UTC'
+session.token # => Enctyped session token. Can be used for auth http headers like Authrorization Bearer
+
+decoded_session = Auth.decode_session(session.token)
+session == decoded_session.id # => true
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,15 @@
+# frozen_string_literal: true
+
+require 'bundler/setup'
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/app/models/ez/sessions/model.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'jwt'
+
+module Ez
+  module Sessions
+    class Model < ActiveRecord::Base
+      include Ez::Sessions::API
+
+      self.table_name = Ez::Sessions.config.sessions_table_name
+
+      def token
+        @token ||= encode_token(self)
+      end
+    end
+  end
+end

data/lib/ez/sessions/api.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'jwt'
+
+module Ez
+  module Sessions
+    module API
+      def create_session(user_id:, user_agent: nil, expires_at: nil)
+        Ez::Sessions::Model.create!(
+          user_id:    user_id,
+          user_agent: user_agent,
+          expires_at: expires_at || 30.days.from_now
+        )
+      end
+
+      def encode_token(session_record)
+        JWT.encode(
+          {
+            session_id: session_record.id,
+            user_id:    session_record.user_id,
+            exp:        session_record.expires_at.to_i
+          },
+          Ez::Sessions.config.token_secret_base
+        )
+      end
+
+      def decode_session(session_token)
+        payload = JWT.decode(session_token, Ez::Sessions.config.token_secret_base).first
+        Ez::Sessions::Model.find_by!(id: payload.fetch('session_id'))
+      rescue StandardError
+        Ez::Sessions.config.on_invalid_session_token.call
+      end
+    end
+  end
+end

data/lib/ez/sessions/engine.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Ez
+  module Sessions
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/ez/sessions/railtie.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Ez
+  module Sessions
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/ez/sessions/version.rb

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

data/lib/ez/sessions.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'ez/sessions/engine'
+require 'ez/sessions/version'
+require 'ez/sessions/railtie'
+require 'ez/sessions/api'
+require 'ez/configurator'
+
+module Ez
+  module Sessions
+    include Ez::Configurator
+
+    configure do |config|
+      config.token_secret_base = 'CHANGE_ME!'
+      config.sessions_table_name = 'ez_sessions'
+      config.on_invalid_session_token = -> { raise 'Invalid token!' }
+    end
+  end
+end

data/lib/generators/ez/sessions/install_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Ez
+  module Sessions
+    class InstallGenerator < Rails::Generators::Base
+      def create_migration
+        create_file 'config/initializers/ez_sessions.rb',
+                    "# frozen_string_literal: true
+
+Ez::Sessions.configure do |config|
+  # Tokens generation secret key
+  config.token_secret_base = '#{SecureRandom.hex(32)}'
+
+  # Modify sessions table name
+  # config.sessions_table_name = 'ez_sessions'
+
+  # Callback for invalid token case
+  # config.on_invalid_session_token = -> { raise 'Invalid token!' }
+end
+"
+      end
+    end
+  end
+end

data/lib/generators/ez/sessions/migrations_generator.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# rubocop:disable all
+module Ez
+  module Sessions
+    class MigrationsGenerator < Rails::Generators::Base
+      def config
+        Ez::Sessions.config
+      end
+
+      def create_migration
+        create_file "db/migrate/#{Time.current.strftime('%Y%m%d%H%M%S')}_create_ez_sessions.rb",
+                    "# frozen_string_literal: true
+
+class CreateEzSessions < ActiveRecord::Migration[5.0]
+  def change
+    create_table :#{config.sessions_table_name} do |t|
+      t.integer :user_id, null: false
+      t.string :user_agent
+      t.datetime :expires_at, null: false
+      t.timestamps null: false
+    end
+
+    add_index :#{config.sessions_table_name}, :user_id
+  end
+end
+"
+      end
+    end
+  end
+end
+# rubocop: enable all

data/lib/tasks/ez/sessions_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :ez_sessions do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,219 @@
+--- !ruby/object:Gem::Specification
+name: ez-sessions
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Volodya Sveredyuk
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-11-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ez-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.2'
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  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: guard-rspec
+  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: pry-rails
+  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: rspec-rails
+  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: rubocop
+  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: simplecov
+  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: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: Easy database persisted sessions for Rails
+email:
+- sveredyuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/ez/sessions/model.rb
+- lib/ez/sessions.rb
+- lib/ez/sessions/api.rb
+- lib/ez/sessions/engine.rb
+- lib/ez/sessions/railtie.rb
+- lib/ez/sessions/version.rb
+- lib/generators/ez/sessions/install_generator.rb
+- lib/generators/ez/sessions/migrations_generator.rb
+- lib/tasks/ez/sessions_tasks.rake
+homepage: https://github.com/ez-engines/ez-sessions
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ez-engines/ez-sessions
+  source_code_uri: https://github.com/ez-engines/ez-sessions
+  changelog_uri: https://github.com/ez-engines/ez-sessions/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: Easy database persisted sessions for Rails
+test_files: []