jay_doubleu_tee 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b97cdc198e67deb3e7bf32f6ea85eefb1b0a8a03f566c38205cd64ab017e412
-  data.tar.gz: 2d5177eec6bbd60fcdea34209c47a916efdf425668576436016f1754cc23ef22
+  metadata.gz: 1ca496fec80501e8e98bc75a5965dfc18cce6768e9285c7ec234de1296256e9f
+  data.tar.gz: 5ad933fb852efaff69de32b0d14066e4801fb6954e43e97c1bf29949a6b52b69
 SHA512:
-  metadata.gz: 5fe6669fbe10bb8a0d8bf6ee8f398cb34eac32811b0e9111102687491bbd5d3252ffc8fbde1c6bc48a6217c769e1bfdb9bc092c360d8d3403e6b4d927ce50c20
-  data.tar.gz: ca25e6aa0658a1266a2c6ba1b50580e2fda619be0ae34750417fbb2f5ea2b214eb11a748a000965b97554fcd6a5d4365b03025aead23f7af7908f68ee794c73f
+  metadata.gz: 7e124fc6bfe66c4ec3d9e65e6a1c07f9f509b174727b7e77f6cf1c18cb699876abea9c9e1174a0d166739dfc8aab6b4b2f4e5b95d88c97abd394f5d76130d6c3
+  data.tar.gz: d7c8b055c577e28513cede0ae6473df26d15c88b38f83829a6ab689aef397d692816e59f742125432478c2c9a61928bb236cc0933f9b0a83c3ba90d362597bf1

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jay_doubleu_tee (0.2.1)
+    jay_doubleu_tee (0.3.1)
       dry-configurable
       dry-effects
       dry-monads
@@ -62,4 +62,4 @@ DEPENDENCIES
   rspec (~> 3.0)
 
 BUNDLED WITH
-   2.1.4
+   2.4.3

data/README.md

@@ -49,12 +49,7 @@ class App
   include JayDoubleuTee::Auth
 
   def call(env)
-    status, body =
-      if auth.success?
-        [200, [{ message: "Hello, World!", auth: auth.value! }]]
-      else
-        [401, [{ error: auth.failure }.to_json]]
-      end
+    status, body = [200, [{ message: "Hello, World!", auth: auth.value! }]]
 
     [status, headers, body]
   end
@@ -66,7 +61,12 @@ class App
   end
 end
 
-use JayDoubleuTee::Authentication
+JayDoubleuTee.configure do |config|
+  config.algorithm = 'RS256'
+  config.secret = ENV['JAY_DOUBLEU_TEE_PUBLIC_KEY']
+end
+
+use JayDoubleuTee::Authorization
 
 run App.new
 ```
@@ -98,7 +98,7 @@ curl --location --request GET 'http://localhost:9292' \
 # config.ru
 
 require "jay_doubleu_tee"
-use JayDoubleuTee::Authentication
+use JayDoubleuTee::Authorization
 ```
 
 ### Rails
@@ -107,7 +107,7 @@ use JayDoubleuTee::Authentication
 # config.ru
 
 require "jay_doubleu_tee"
-use JayDoubleuTee::Authentication
+use JayDoubleuTee::Authorization
 ```
 
 #### Supported algorithms
@@ -135,6 +135,28 @@ end
 
 Again, for information how to generate private and public keys, [jwt documentation](https://github.com/jwt/ruby-jwt#algorithms-and-usage) or check out the [spec files](https://github.com/hanamimastery/jay_doubleu_tee/tree/master/spec/jay_doubleu_tee/decoder_spec.rb)
 
+**Authorizing by default**
+
+JayDoubleuTee uses secure by default principle, adding authorization to all endpoints using the middleware. If you don't want to authorize all responses by default, you can override the corresponding setting.
+
+```ruby
+JayDoubleuTee.configure do |config|
+  config.authorize_by_default = false
+end
+```
+
+Then in your action you need to handle authorization failure on your own.
+
+```ruby
+  if auth.success?
+    [200, [{ message: "Hello, World!", auth: auth.value! }]]
+  else
+    [401, [{ error: auth.failure }.to_json]]
+  end
+```
+
+This may be useful if you have only one component in your application using the JWT flow, while the rest use different authorization mechanism.
+
 ## 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.
@@ -145,6 +167,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 It's built on top of several gems to ensure the best user experience.
 
+- [Hanami Mastery screencast](https://hanamimastery.com/episodes/12-authorization-with-jwt)
 - [JWT](https://github.com/jwt/ruby-jwt#algorithms-and-usage)
 - [dry-effects](https://dry-rb.org/gems/dry-effects). Here is the [video tutorial for dry-effects](https://hanamimastery.com/episodes/11-effective-ruby-programming-with-dry-effects)
 - [dry-monads](https://dry-rb.org/gems/dry-monads). Here is a [video tutorial for dry-monads](https://hanamimastery.com/episodes/7-untangle-your-app-with-dry-monads)

data/lib/jay_doubleu_tee/authorization.rb

@@ -7,17 +7,33 @@ module JayDoubleuTee
   class Authorization
     include Dry::Effects::Handler.Reader(:auth)
 
-    attr_reader :decoder
+    attr_reader :decoder, :config
 
     def initialize(app)
       @app = app
       @decoder = Decoder.new
+      @config = JayDoubleuTee.config
     end
 
     def call(env)
-      with_auth(decoder.call(env["HTTP_AUTHORIZATION"])) do
+      auth = decoder.call(env["HTTP_AUTHORIZATION"])
+
+      return authorization_error(auth) if unauthorized?(auth)
+
+      with_auth(auth) do
         @app.call(env)
       end
     end
+
+    private
+
+    def authorization_error(auth)
+      headers = { 'Content-Type' => 'application/json' }
+      [ 401, headers, [{ error: auth.failure }.to_json]]
+    end
+
+    def unauthorized?(auth)
+      config.authorize_by_default && auth.failure?
+    end
   end
 end

data/lib/jay_doubleu_tee/version.rb

@@ -1,3 +1,3 @@
 module JayDoubleuTee
-  VERSION = "0.2.1"
+  VERSION = "0.3.1"
 end

data/lib/jay_doubleu_tee.rb

@@ -14,10 +14,12 @@ module JayDoubleuTee
 
   extend Dry::Configurable
 
-  setting :algorithm, default: 'RS256' do |value|
+  setting :algorithm, default: 'RS256', constructor: ->(value) do
     raise ConfigurationError, "Unsupported algorithm." unless ALGORITHMS.include?(value)
     value
   end
 
   setting :secret, default: ENV['JAY_DOUBLEU_TEE_PUBLIC_KEY']
+
+  setting :authorize_by_default, default: true
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jay_doubleu_tee
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Sebastian Wilgosz
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-12-30 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jwt
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".tool-versions"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -116,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.2.31
 signing_key:
 specification_version: 4
 summary: A JWT authorization solution for any ruby web app.