ruby_magic_link 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b388ac403bc4f6041bc487bcd64d8a7fff1712a1e2691aa5477ab52652f3f5f9
-  data.tar.gz: fc942055ed95c2ead29a6dae7cd8b9d332714a93fe9216590362d09fdbce3138
+  metadata.gz: 77385bf30e18ca3972349337694148c75264e91da47a21b630a76aaea350e1f8
+  data.tar.gz: e4fbc8d84e7d998451d38f3d72841936b11026cead7f3600462d570beb8194d0
 SHA512:
-  metadata.gz: 38d0072644a3b821b222652c96841c4e5321d503e78e980844e6a02498c53ee4d6d1a9b72e4968c6f50f2e8f98bbd332458761c26608354e1a6aa12fafad5e5a
-  data.tar.gz: e2e316ddc3cb71ae527400393a58285fca52101eb96e4aa322275d561760ba7fbd3ee2e2555415a3e2191bcde73781666a30899591373ec452634f041de8273d
+  metadata.gz: 5e2b691012719785f4d629afd8e7db3d31012947622f3fa03157858ffec3c56dfdde4db04cd15577115c0309ed8b95f66444f8aa0ee3f94a7a95ef62795391be
+  data.tar.gz: d107925bad7e6f38af7723331bf4baf1aeaebca1104462a91c634a439462ac12cbcf284533ec29fc46c123dc6ab8809644e79f33c7f058048a8452aaffc019ba

data/README.md

@@ -1,3 +1,78 @@
+# RubyMagicLink
+
+RubyMagicLink: A gem crafted for the secure generation of tokens, ensuring the safe transmission of data within your Ruby application. Useful for creating magic links—single-use URLs empowering users to perform actions without a password.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_magic_link'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it manually using:
+
+```bash
+gem install ruby_magic_link
+```
+
+## Usage
+### Configuration
+
+For Rails applications, create an initializer file in the `config/initializers directory`.
+
+```ruby
+# config/initializers/ruby_magic_link.rb
+
+RubyMagicLink.setup do |config|
+  config.secret_key = 'your_secret_key'
+end
+```
+
+Replace `your_secret_key` with a strong secret key. Keep this key confidential and do not expose it in your public repositories.
+
+To generate a secret key, run the following rake task:
+
+```bash
+bundle exec rake ruby_magic_link:generate_key
+```
+
+### Simple Example
+
+Encode your data:
+
+```ruby
+payload = {
+  user_id: 123_456,
+  action: :authenticate
+}
+encrypted_data = RubyMagicLink::Token.create(payload, expires_in: Time.now.to_i + 3600)
+url = "https://example.com/magic_links?data=#{encrypted_data}"
+
+# Send the generated URL in an email or through other communication channels.
+```
+
+Decode your data:
+
+```ruby
+class MagicLinksController < ApplicationController
+  def index
+    token = RubyMagicLink::Token.decode(params[:data])
+    if token.valid? && token.payload['action'] == 'authenticate'
+      sign_in(:user, token.payload['user_id'])
+      redirect_to home_path
+    end
+  end
+end
+```
+
+
 ## License
 
 Copyright (c) 2024 Igor Korepanov

data/lib/ruby_magic_link/tasks.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'securerandom'
+
+namespace :ruby_magic_link do
+  task :generate_key do
+    puts SecureRandom.hex(16)
+  end
+end

data/lib/ruby_magic_link/token.rb

@@ -6,7 +6,7 @@ require 'json'
 
 module RubyMagicLink
   module Token
-    DELIMITER = '!'
+    DELIMITER = '|'
     ALGORITHM = 'AES-256-CBC'
 
     class TokenObject
@@ -14,6 +14,10 @@ module RubyMagicLink
         @data = data
       end
 
+      def valid?
+        !expired?
+      end
+
       def expired?
         decoded_data['expires_in'] < Time.now.to_i
       end
@@ -46,7 +50,7 @@ module RubyMagicLink
     end
 
     def decode_token(data)
-      raw_iv, data =  Base64.urlsafe_decode64(data).split(DELIMITER, 2)
+      raw_iv, data = Base64.urlsafe_decode64(data).split(DELIMITER, 2)
       JSON.parse(decrypt(data, RubyMagicLink.config.secret_key, Base64.urlsafe_decode64(raw_iv)))
     end
 

data/lib/ruby_magic_link/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyMagicLink
-  VERSION = '0.0.1'
+  VERSION = '1.0.0'
 end

data/lib/ruby_magic_link.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 require 'ruby_magic_link/ruby_magic_link'
-require 'ruby_magic_link/token'
+require 'ruby_magic_link/token'
+require 'ruby_magic_link/tasks'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby_magic_link
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Igor Korepanov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-04 00:00:00.000000000 Z
+date: 2024-02-05 00:00:00.000000000 Z
 dependencies: []
 description: Magic links for ruby web applications
 email: noemail@example.com
@@ -20,6 +20,7 @@ files:
 - README.md
 - lib/ruby_magic_link.rb
 - lib/ruby_magic_link/ruby_magic_link.rb
+- lib/ruby_magic_link/tasks.rb
 - lib/ruby_magic_link/token.rb
 - lib/ruby_magic_link/version.rb
 homepage: https://github.com/igorkorepanov/ruby_magic_link