jay_doubleu_tee 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e0f1808e15a6fb71cc47526d3de8484372e5c9f5f32da231fec7219e799e99e
-  data.tar.gz: 7ca92e01391c1eccae6ae8b682ccf8b36e6a0c064f64360659affed49d3922a0
+  metadata.gz: 466bf244fedd2cc739d50c571486552fd5ba396b4dabef84f67cd048ae6b6907
+  data.tar.gz: 9ff43ce6564a8aa048c30309b0a9c36bf1b41a9635046ae72a21ae668161fe47
 SHA512:
-  metadata.gz: 9bbe5175ffd3190eb9846b3f660c5a912fda3c22eaaa086d39715b2cabd1336fb2b9e14ece3cc301284e425e995b5c34fcf090f10be0ab256f67034c6c05db1c
-  data.tar.gz: 64b240f9370f3f3489703465ae4ed2c92927234d18be7313cf1b7d5d75ce0bf7dd90996d69f5aa6dc68f80b9fdf339b4dad5d10879b6fd7031894fc640a49256
+  metadata.gz: 58971ff4a53581205acdfcb211131e3ff2daf9a09ddb4fa5da1bcfe828eb3a34baffcc9fdeee23cffe403e8ec0b9de8db074b33f6999f1943531c39bef1b7ea1
+  data.tar.gz: 3ca090115afdb48737b4e6352d377b6b268be6fa3b0f86f95a70540b046b3acedf83fc66417b8716b2808d3e24155a1c52b90150c94883ed12eb9b61e8f5dfc0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jay_doubleu_tee (0.1.0)
+    jay_doubleu_tee (0.2.0)
       dry-configurable
       dry-effects
       dry-monads

data/README.md

@@ -24,6 +24,22 @@ Or install it yourself as:
 
 ## Usage
 
+`jay_double_uti` uses RS256 algorithm by default, so youl'll need a private/public key pair and the access token for testing it out.
+
+In your console run
+
+```ruby
+require 'jwt'
+payload = {
+  data: { user_id: "de804507-5d03-4493-a038-d62f499b8a96" }, scopes: ""
+}
+private_key = OpenSSL::PKey::RSA.generate 2048
+secret = private_key.public_key.to_s
+token = JWT.encode payload, private_key, 'RS256'
+```
+
+Then save the `ENV` variable `JAY_DOUBLEU_TEE_PUBLIC_KEY` by setting the as a value your secret.
+
 ### Plain ruby Rack application
 
 ```ruby
@@ -35,7 +51,7 @@ class App
   def call(env)
     status, body =
       if auth.success?
-        [200, ["Hello, World!\n#{auth.value!}"]]
+        [200, [{ message: "Hello, World!", auth: auth.value! }]]
       else
         [401, [{ error: auth.failure }.to_json]]
       end
@@ -55,6 +71,27 @@ use JayDoubleuTee::Authentication
 run App.new
 ```
 
+```shell
+curl --location --request GET 'http://localhost:9292' \
+--header 'Authorization: Bearer <<YOUR_TOKEN>>'
+
+# => 200:
+  # {
+  #   message: 'Hello, World!,
+  #   auth: {
+  #     data: { user_id: "de804507-5d03-4493-a038-d62f499b8a96" },
+  #     scopes: ""
+  #   }
+  # }
+```
+
+```shell
+curl --location --request GET 'http://localhost:9292' \
+--header 'Authorization: Bearer invalid'
+
+# => 401: { error: Unauthorized. Token invalid }
+```
+
 ### Hanami 2.0
 
 ```ruby
@@ -75,7 +112,7 @@ use JayDoubleuTee::Authentication
 
 #### Supported algorithms
 
-JayDoubleuTee does not use any encryption algoritym by default. 'none' is set.
+JayDoubleuTee users RS256 encryption algoritym by default, but you can completely disable the token signature validation by setting up algorithm to 'none'. Check out the Configuration section.
 
 Below are listed all supported algoritms at the moment.
 
@@ -87,7 +124,7 @@ For more info about each of them refer to [jwt documentation](https://github.com
 
 ### Configuration
 
-To set encryption algorithm, you can configure
+To set encryption algorithm, you can configure several fields
 
 ```ruby
 JayDoubleuTee.configure do |config|
@@ -104,11 +141,19 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
+### Resources
+
+It's built on top of several gems to ensure the best user experience.
+
+- [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)
+- [dry-configurable](https://dry-rb.org/gems/dry-configurable). Here is the [video tutorial for dry-configurable](https://hanamimastery.com/episodes/5-configure-anything-with-dry-configurable)
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/hanamimastery/jay_doubleu_tee. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/hanamimastery/jay_doubleu_tee/blob/master/CODE_OF_CONDUCT.md).
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/jay_doubleu_tee/version.rb

@@ -1,3 +1,3 @@
 module JayDoubleuTee
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/jay_doubleu_tee.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jay_doubleu_tee
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sebastian Wilgosz