jwt_api 0.1.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b98af57b80db1d208e37fea555f8840b0ef28d975b450e3d4913e5b43b90e49c
-  data.tar.gz: 37ab658dbc48fcaf0dc6fa332f64f85a5a16a654a1b603855df72d4d00d049f1
+  metadata.gz: c5cbc0f093c852b43cdb8b003aa0c01626e3be9028bf6b81e321e25c34f8b3bd
+  data.tar.gz: 4eff6628212209e189a8949f13860d3125e1df30f85580848f94935b7bf1d4d1
 SHA512:
-  metadata.gz: 325cb78e50548492bf4537a0b89b59e2c8bf9541481b9fc75dad97174251b0e2a7697ef5b8183dc67461375614a8fe22f576a8262df63db63116c0a65be04a54
-  data.tar.gz: 32143ac809d4b48c0b0afdd0274c04061f4fd0b094c8e35179d59515a0aecbfa5eabd0bb4a0fbf259f95d3e75387bb789741ffd8cd809de412ada9b8fa78db27
+  metadata.gz: 2cf65ed0499db74943eb7004f442f928463ee58bf6b50bef9643d71c100a90cd36588acc5bf0954e0547e1aa64ee9baa41efc4616a8f663dd940c9be198763ba
+  data.tar.gz: '0304883cd1deccf26f4d256a5141e0735ef9ce7f548b2acc91bed2fa5d8a809f6da0ddc7cfd8b1bd0465437f3d3c5321dc77961b5986c924927d59d2ae9ee080'

data/CHANGELOG.md

@@ -3,3 +3,12 @@
 ## [0.1.0] - 2021-08-26
 
 - Initial release
+
+
+## [0.1.1] - 2022-02-13
+
+- Clean up and refactor
+
+## 0.1.2 - 2022-02-13
+
+- Update gemspec description

data/README.md

@@ -1,6 +1,6 @@
 # JwtApi
 
-Generate user, session, and password api routes with JWT authentication.
+Scaffold a JSON Web Token API.
 
 ## Installation
 
@@ -56,8 +56,17 @@ Running via Spring preloader in process 56250
 
 1. Make sure that each user that needs access to the API has a JTI generated.
    1. `User.first.jti = SecureRandom.uuid`
-2. Request a JWT at the `/api/authenticate/` endpoint.
-3. Include that token as a `Bearer` token in all other requests.
+2. From your Rails console run `SecureRandom.hex(64)` and make note of the output.
+   - Sample output:
+      ```text
+      "0086870fb04cafbaa15b110cf78352fbca75537cc90e06892e206e07c24caa33ff5f6aadf2649cafac08c4acf6a1b7527b97bfa943481c282ba2480a0a922657"
+      ```
+3. Run `rails credentials:edit --environment=development` (and production, staging when applicable) and set your `jwt_secret` environment variable.
+   ```yml
+      jwt_secret: 0086870fb04cafbaa15b110cf78352fbca75537cc90e06892e206e07c24caa33ff5f6aadf2649cafac08c4acf6a1b7527b97bfa943481c282ba2480a0a922657
+   ```
+3. Request a JWT at the `/api/authenticate/` endpoint.
+4. Include that token as a `Bearer` token in all other requests.
 
 
 [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/6130650-059cc2e3-88f7-48a8-95d0-d7dca1d7caef?action=collection%2Ffork&collection-url=entityId%3D6130650-059cc2e3-88f7-48a8-95d0-d7dca1d7caef%26entityType%3Dcollection%26workspaceId%3D128e0ba1-898b-40bb-8006-a329fb1c28de)
@@ -67,11 +76,6 @@ Running via Spring preloader in process 56250
 
 ## Limitations
 - Currently this will only work with a devise User model.
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
@@ -83,8 +87,5 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the JwtApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jwt_api/blob/main/CODE_OF_CONDUCT.md).
-
+Everyone interacting in the JwtApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/leopolicastro/jwt_api/blob/main/CODE_OF_CONDUCT.md).
 
-## TODO
-- Create test suite and add to generator to copy into users app.

data/jwt_api.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Leo Policastro']
   spec.email         = ['lpolicastro@pm.me']
 
-  spec.summary       = 'Write a short summary, because RubyGems requires one.'
-  spec.description   = 'Write a longer description or delete this line.'
+  spec.summary       = 'Scaffold a JSON Web Token API'
+  spec.description   = 'Scaffold a JSON Web Token API.'
   spec.homepage      = 'https://github.com/leopolicastro/jwt_api/'
   spec.license       = 'MIT'
   spec.required_ruby_version = '>= 2.4.0'

data/lib/generators/jwt_api/setup_generator.rb

@@ -53,9 +53,5 @@ end\n\n"
     def generate_jti_migration
       generate 'migration', 'add_jti_to_users', 'jti:string:uniq:index'
     end
-
-    def run_migration
-      rake 'db:migrate'
-    end
   end
 end

data/lib/generators/jwt_api/templates/api/base_controller.rb

@@ -8,7 +8,7 @@ class Api::BaseController < ApplicationController
   protected
 
   def authenticate_request!
-    user_id_in_token?
+    http_token && auth_token && jti_matches?
   rescue JWT::VerificationError, JWT::DecodeError
     render json: { errors: ['Unauthorized'] }, status: :unauthorized
   end
@@ -21,8 +21,7 @@ class Api::BaseController < ApplicationController
 
   def auth_token
     @auth_token ||= jwt.decode(http_token)[0].to_h.symbolize_keys!
-    return nil if token_expired?
-    return @auth_token if @auth_token.present? && @auth_token[:user_id].present? && jti_matches?
+    return @auth_token if @auth_token.present? && @auth_token[:user_id].present? && !token_expired?
   end
 
   def token_expired?
@@ -34,10 +33,6 @@ class Api::BaseController < ApplicationController
     @current_user&.jti == @auth_token[:jti]
   end
 
-  def user_id_in_token?
-    http_token && auth_token
-  end
-
   def user_reset_token_in_params?
     params[:reset_password_token]
   end

data/lib/generators/jwt_api/templates/initializers/json_web_token.rb

@@ -2,7 +2,7 @@
 
 # JSON Web Token class
 class JsonWebToken
-  def initialize(key = Rails.application.credentials[:secret_key_base], algorithm = 'HS256')
+  def initialize(key = Rails.application.credentials[:jwt_secret], algorithm = 'HS256')
     @key = key
     @algorithm = algorithm
   end

data/lib/jwt_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module JwtApi
-  VERSION = '0.1.1'
+  VERSION = '0.1.5'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jwt_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.5
 platform: ruby
 authors:
 - Leo Policastro
@@ -30,7 +30,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.3
-description: Write a longer description or delete this line.
+description: Scaffold a JSON Web Token API.
 email:
 - lpolicastro@pm.me
 executables: []
@@ -48,7 +48,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- jwt_api-0.1.0.gem
+- jwt_api-0.1.4.gem
 - jwt_api.gemspec
 - lib/generators/jwt_api/setup_generator.rb
 - lib/generators/jwt_api/templates/api/base_controller.rb
@@ -84,8 +84,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Write a short summary, because RubyGems requires one.
+summary: Scaffold a JSON Web Token API
 test_files: []