gr1d99_auth 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78c4d7a3f5feff68c29429d036c4cf3e78946eca54ce2701a145666ab055f00d
-  data.tar.gz: fe4208c0d009be7c859ffd3dbb8f89b64038e6ffaf5daff7d04bdebf0a6417ec
+  metadata.gz: 8f6da760779a1c0c0805df4f978ceed97504dd0c3c48924be8f4979843fba109
+  data.tar.gz: 6bf45d76781f8e2c6abea48f6cf0c00254057ca2dda91dda2c1b31d182021b9f
 SHA512:
-  metadata.gz: 7cbe9217f2287e2f1e5e2e66d064d1713b9469fc88c67d247dc7b8e31a6b538bfb9373118811fa33ae40590aaa3cdf41dd8d076c226fa2f9f6000c4c065d83ae
-  data.tar.gz: a2b7f68212fe05f06fafd3066ff29b5d4074b01821dff0474c7da121c3aaa9809723ce4ce047c15ee2fff951f930ad3a82ce516e079e68ffc9887f51dbf2b4a4
+  metadata.gz: 261b67b6bd0a56190c35f4c2cc1843b17d0c03871ba26ef10b3e67154a6f1606153a8e77ff57d9b1c0a23d10edaf129831e2475dfcbeeda1244cb75fe6081c73
+  data.tar.gz: 2ed232416cfe8a598cab8df8ef2318f9677cfe3c000ff8ffc0b48ae63a1f0d3ee2f339e673ba2bb7e19a4609325e180e3d6689f8846459edd640dd87fe32a13f

data/README.md

@@ -22,7 +22,46 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### Rails
+1. Add `gem 'gr1d99_auth'` to your gemfile
+2. Create a file named `gr1d99_auth.rb` in **config/initializers** directory and add required configurations.
+
+   It is worth noting that `gr1d99_auth` gem offers minimal configurations to enable the gem to work correctly.
+   
+   These configurations are:
+   1. **jwt_key** - this is just a random string that will be used to encode/decode jwt
+   2. **jwt_verify** - value can either be **true** or **false**, this specifies whether the jwt should be verified during decoding.
+   3. **jwt_algorithm** - specify the algorithm that should be used, currently the tested algorithms and verified that they work correctly is `HS512` and `HS256`, you are highly recommended to use any of them.
+   4. **jwt_exp** - specify the time in seconds that the token should be valid
+   5. **time_zone** - this ensures that the `jwt_exp` is set appropriately.
+   
+   example:
+   in **config/initializers/gr1d99_auth.rb** you would typically have this setup.
+   
+   ```ruby
+   Gr1d99Auth.configure do |config|
+     config.jwt_key = "my-jwt-key"
+     config.jwt_verify = true
+     config.jwt_algorithm = 'HS512'
+     config.jwt_exp = 3600
+     config.time_zone = "Africa/Nairobi"
+   end
+   ```
+3. In your controller, typically `authentication_controller.rb`, you would encode your payload by
+   ```ruby
+   payload = { id: user.id, email: user.email, roles: user.roles.pluck(:name) }
+   Gr1d99Auth::JWT.encode(payload)
+   ```
+4. To decode token
+   ```ruby
+   token = response.headers["HTTP_X_ACCESS_TOKEN"]
+   Gr1d99Auth::JWT.decode(token)
+   ```
+   
+5. You should also handle errors raised during decoding, these errors are.
+   1. `JWT::DecodeError`
+   2. `JWT::VerificationError`
+   3. `JWT::IncorrectAlgorithm`
 
 ## Development
 

data/lib/gr1d99_auth/version.rb

@@ -1,3 +1,3 @@
 module Gr1d99Auth
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gr1d99_auth
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Gideon Kimutai
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-08 00:00:00.000000000 Z
+date: 2019-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -98,6 +98,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gr1d99_auth-0.1.0.gem
 - gr1d99_auth.gemspec
 - lib/gr1d99_auth.rb
 - lib/gr1d99_auth/configuration.rb