sinatra-jwt 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23e0995306d0b2428617e6f3b6989a18075a1ee149b08bea4bc02be3163e4267
-  data.tar.gz: fa80fff93fbd3083ef40b4889114332363f1cf09e657e68a62e2b6b6eec4d4f3
+  metadata.gz: 301b2054a8ce75ff89406788b6aa02b58f7e8e4759646be044b307f1a905c4c8
+  data.tar.gz: d1e44bbb2a4b0a877f921bb1332f70fb4a17fade6c552bdb03f541b770530656
 SHA512:
-  metadata.gz: a771461b7047e1c69ea687e29faaf8dd9c7c3ae8b2039978991c1068dc48c10f64146ab219ebb5b779d726acdda091828e0cf5ec25a83e683e093911ebfc4d1e
-  data.tar.gz: ac5b2c2e407033c6c6b79dacce4284d2f8bc0e5d91be598e2efa33d0a773c2c140ba9cc4c240b1897641638cad526cd5131c288a4d1910bef4736b3b089bdeec
+  metadata.gz: 4667804039a5bd764b590e0cb2f9d9c33af226e47f3d64b0817bd1d380fb92100e62c18f6148a26e42a9cbb64d8a89f237375cb391409d1ec657c980bbf18e89
+  data.tar.gz: 421064e82c11236f259bfb5fbf1c0dcbbd1719b1636d0e0df61bf28eedc8bfeece4fd010ad449cf7165e04535dd025dd6265108dcf1a6bc67981036267ae7a69

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 0.2.0
+
+Allow a route to be marked by `:auth => false` or `:auth => [{ auth: false }]` to not require authentification. Can be usefull to programatically disable auth in certain environments.
+
+# 0.1.0
+
+First release

data/Gemfile

@@ -14,3 +14,5 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+
+gem "simplecov", "~> 0.21"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    sinatra-jwt (0.1.0)
+    sinatra-jwt (0.2.0)
       jwt (~> 2.5)
       sinatra (~> 2.2)
 
@@ -10,6 +10,7 @@ GEM
   specs:
     ast (2.4.2)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     json (2.6.2)
     jwt (2.5.0)
     mustermann (2.0.2)
@@ -54,6 +55,12 @@ GEM
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
     ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
     sinatra (2.2.2)
       mustermann (~> 2.0)
       rack (~> 2.2)
@@ -71,6 +78,7 @@ DEPENDENCIES
   rbs
   rspec (~> 3.0)
   rubocop (~> 1.21)
+  simplecov (~> 0.21)
   sinatra-jwt!
 
 BUNDLED WITH

data/README.md

@@ -1,8 +1,8 @@
-# Sinatra::Jwt
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sinatra/jwt`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![GitHub version](https://badge.fury.io/gh/suddani%2Fsinatra-jwt.svg)](https://badge.fury.io/gh/suddani%2Fsinatra-jwt)
+[![Gem Version](https://badge.fury.io/rb/sinatra-jwt.svg)](https://badge.fury.io/rb/sinatra-jwt)
+[![Ruby](https://github.com/suddani/sinatra-jwt/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/suddani/sinatra-jwt/actions/workflows/main.yml)
 
-TODO: Delete this and the text above, and describe your gem
+# Sinatra::Jwt
 
 ## Installation
 
@@ -17,7 +17,7 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 
 ```ruby
-require "sinatra-jwt"
+require "sinatra/jwt"
 
 class Application < Sinatra::Base
   register Sinatra::Jwt
@@ -27,7 +27,7 @@ end
 ## Use a single key
 If you wish to use a single key you can provide it directly
 ```ruby
-require "sinatra-jwt"
+require "sinatra/jwt"
 
 class Application < Sinatra::Base
   register Sinatra::Jwt
@@ -92,7 +92,7 @@ The file can contain as many keys as you want all with different algorithms.
 #### Files
 You can change the file that is loaded by either hardcoding the path
 ```ruby
-require "sinatra-jwt"
+require "sinatra/jwt"
 
 class Application < Sinatra::Base
   register Sinatra::Jwt
@@ -102,7 +102,7 @@ end
 ```
 or using the env helper method that takes the path from the environment variables
 ```ruby
-require "sinatra-jwt"
+require "sinatra/jwt"
 
 class Application < Sinatra::Base
   register Sinatra::Jwt
@@ -116,7 +116,7 @@ end
 #### Strings
 You can change the file that is loaded by either hardcoding the path
 ```ruby
-require "sinatra-jwt"
+require "sinatra/jwt"
 
 class Application < Sinatra::Base
   register Sinatra::Jwt
@@ -126,7 +126,7 @@ end
 ```
 or using the env helper method that takes the path from the environment variables
 ```ruby
-require "sinatra-jwt"
+require "sinatra/jwt"
 
 class Application < Sinatra::Base
   register Sinatra::Jwt
@@ -187,7 +187,7 @@ You can use a custom decoder by implementing an object that has a `decode` metho
 ```ruby
 require "base64"
 require "json"
-require "sinatra-jwt"
+require "sinatra/jwt"
 
 class DummyDecoder
   def self.decode(token, key = nil, verify = false, options = {})
@@ -212,7 +212,7 @@ end
 This decoder is bundled with the extension but will cause `unauthorized calls in any other environment than development`
 
 ```ruby
-require "sinatra-jwt"
+require "sinatra/jwt"
 
 class Application < Sinatra::Base
   register Sinatra::Jwt

data/lib/sinatra/jwt/version.rb

@@ -2,6 +2,6 @@
 
 module Sinatra
   module Jwt
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/sinatra/jwt.rb

@@ -51,16 +51,6 @@ module Sinatra
       set :jwt_auth_decoder, decoder
     end
 
-    def self.added_attr_or_appended?(diff)
-      return true unless diff[:added_attr].nil?
-      return true unless diff[:appended].nil?
-
-      diff.each do |_k, v|
-        return true if v.is_a?(Hash) && added_attr_or_appended?(v)
-      end
-      false
-    end
-
     # rubocop:disable Metrics/AbcSize
     # rubocop:disable Metrics/CyclomaticComplexity
     # rubocop:disable Metrics/MethodLength
@@ -78,27 +68,30 @@ module Sinatra
 
       app.set(:auth) do |options_data|
         condition do
+          return true if options_data == false
+
           options = options_data.is_a?(Hash) ? options_data : {}
+          return true if options[:auth] == false
+
           should_stop = !options.key?(:next) || !options[:next]
           decoded_key = if should_stop
                           authorize!
                         else
                           authorize
                         end
-          if decoded_key
-            if options.key?(:contains)
-              added_keys = settings.jwt_auth_auth_diff.added_attr_or_appended?(
-                decoded_key.first,
-                JSON.parse(options[:contains].to_json)
-              )
-              if should_stop && added_keys
-                halt 401, { status: "Unauthorized", message: "Missing rights" }.to_json
-              elsif added_keys
-                false
-              end
+
+          return false unless decoded_key
+
+          if options.key?(:contains)
+            added_keys = settings.jwt_auth_auth_diff.added_attr_or_appended?(
+              decoded_key.first,
+              JSON.parse(options[:contains].to_json)
+            )
+            if should_stop && added_keys
+              halt 401, { status: "Unauthorized", message: "Missing rights" }.to_json if should_stop && added_keys
+            elsif added_keys
+              return false
             end
-          else
-            false
           end
         end
       end

data/sinatra-jwt.gemspec

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "lib/sinatra/jwt/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "sinatra-jwt"
+  spec.version = Sinatra::Jwt::VERSION
+  spec.authors = ["Daniel Sudmann"]
+  spec.email = ["suddani@gmail.com"]
+
+  spec.summary = "Simple package to handle jwt auth in Sinatra"
+  spec.homepage = "https://github.com/suddani/sinatra-jwt"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/suddani/sinatra-jwt"
+  spec.metadata["changelog_uri"] = "https://github.com/suddani/sinatra-jwt/blob/master/CHANGELOG.md"
+  spec.metadata["rubygems_mfa_required"] = "true"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "jwt", "~> 2.5"
+  spec.add_dependency "sinatra", "~> 2.2"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-jwt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Sudmann
@@ -62,6 +62,7 @@ files:
 - lib/sinatra/jwt/top_level_key_array_diff.rb
 - lib/sinatra/jwt/version.rb
 - sig/sinatra/jwt.rbs
+- sinatra-jwt.gemspec
 homepage: https://github.com/suddani/sinatra-jwt
 licenses:
 - MIT