jot-helpers 1.0.0.beta1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5dcde07a6ba725c5951e5d4ab452ffb1e7cd671a447cf0cdc0c42594c36f1627
+  data.tar.gz: 8fadc144567b415ae381ce4b412f4f2a2a4649f3ac75d232e6778047a5093185
+SHA512:
+  metadata.gz: b8bddc2c27c5edc08e629a500a36f32843e58e7550fcd4503d94b6e15aae56709a85df0b5faf426d9e7cb0460a0fbe213d306c2887d2eb96e1025150ed3611ab
+  data.tar.gz: f2b30a100261522e6e39f3aff5977cde6576ca4bcdda7459e7cdd38810f709cdcd05a569371364c2ed20f747f1ba316747c28459c5b57e9ac0adceaf63c0ce8e

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/README.md

@@ -0,0 +1,30 @@
+# Jot
+
+A light wrapper around the [JWT gem](https://github.com/jwt/ruby-jwt).
+
+## Setup
+
+Configure the gem:
+
+```ruby
+Jot.configure do |config|
+  config.algorithm = "HS256"
+  config.secret = # Something long and complex, such as a value generated by SecureRandom.hex(32)
+end
+```
+
+## Usage
+
+Encode a payload:
+
+```ruby
+JOT.encode({ user_id: 1 }) # => "eyJhbGciOiJIUz..."
+```
+
+Decode a payload:
+
+```ruby
+JOT.decode("eyJhbGciOiJIUz...") # => { "user_id" => 1 }
+```
+
+Exceptions raised for invalid / expired tokens will be the same as those raised by the JWT gem.

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/lib/jot/configuration.rb

@@ -0,0 +1,7 @@
+class Jot
+  class Configuration
+    attr_accessor :algorithm, :secret
+
+
+  end
+end

data/lib/jot/rails/authentication_helper.rb

@@ -0,0 +1,11 @@
+class Jot
+  module Rails
+    module AuthenticationHelper
+      def jot_decode(request)
+        token = request.headers["Authorization"].split(" ").last
+        payload, header = Jot.decode(token)
+        payload
+      end
+    end
+  end
+end

data/lib/jot/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Jot
+  VERSION = "1.0.0.beta1"
+end

data/lib/jot.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require "jwt"
+require_relative "jot/version"
+require_relative "jot/configuration"
+require_relative "jot/rails/authentication_helper"
+
+class Jot
+  class << self
+    attr_reader :config
+  end
+
+  def self.configure(&block)
+    @config = Configuration.new
+    block.call(@config)
+  end
+
+  def self.encode(payload)
+    JWT.encode(payload, config.secret, config.algorithm)
+  end
+
+  def self.decode(payload, verify: true)
+    JWT.decode(payload, config.secret, verify, { algorithm: config.algorithm })
+  end
+end

data/sig/jot.rbs

@@ -0,0 +1,4 @@
+module Jot
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: jot-helpers
+version: !ruby/object:Gem::Version
+  version: 1.0.0.beta1
+platform: ruby
+authors:
+- Ryan Bigg
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-07-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !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'
+description: Provides helper methods for working with JSON Web Tokens (JWTs)
+email:
+- me@ryanbigg.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- README.md
+- Rakefile
+- lib/jot.rb
+- lib/jot/configuration.rb
+- lib/jot/rails/authentication_helper.rb
+- lib/jot/version.rb
+- sig/jot.rbs
+homepage: https://github.com/radar/jwt
+licenses: []
+metadata:
+  homepage_uri: https://github.com/radar/jwt
+  source_code_uri: https://github.com/radar/jwt
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.3.16
+signing_key:
+specification_version: 4
+summary: Provides helper methods for working with JSON Web Tokens (JWTs)
+test_files: []