pkce_challenge 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b139d60991d43e02cd1502c943418860e68aad024b228652f305545e167adde
-  data.tar.gz: 7f5beb4d144d09fda3192574d8643bee4daf9d3c712daa8bc7dee90d5e5b9aaf
+  metadata.gz: b24f70ed4dc880603fc1bb11a17a5c2c576d8810ec0abb9b1b7ae36fbeef46e2
+  data.tar.gz: 75b4d4b4e347b0ead4b2acfc4190b90f5767cafcd16c87186170758764749a74
 SHA512:
-  metadata.gz: b848fa5d3448e85a3a44cde27023545b1b410935be18280224e8c46a1d61c35f3fa2e4f1ae7dde352aff53b0542c3cdcb95e6d28e05713784a8a20d9d2f35e66
-  data.tar.gz: e27581d2507751d73866e13851f9558597eec9cfe779ddac7361c520664191e0d6556c47aa9d99f10d5fd9eebd04e8771258d9f74344120fba8777606a9a52b9
+  metadata.gz: ee179537017917cc647efb5f683200d66319e783ad73a3575ff3071cf6278ee3286641f6f7896d4eedd0615bda64b0d370c672bc86e0e35f3f162966027049f9
+  data.tar.gz: 663f440155dede9a1a406b6cd96ed7f4de900413b94c5008f759a8c3ddbbe1016e8f621884bd0e55f6aeae52dcf32765dba07f3d5a95c6d465e533ea674f24fb

data/README.md

@@ -22,7 +22,28 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+2.6.0 :001 > require "pkce_challenge"
+```
+
+```ruby
+2.6.0 :001 > PkceChallenge.challenge
+```
+
+Output:
+```ruby
+=> #<PkceChallenge::Challenge:0x00007f894f810378 @char_length=48, @code_verifier="QbS08cDO9pce~HVCKe9-UDiJoBMG8xwql4FI.Y3CIdpyJtPU", @code_challenge="HT90mmypkXgneRUVK-Ja009VvnoL-flydbEgRcTp5Yw">
+```
+
+Generating a code challenge with the `char_length` option:
+```ruby
+# Accepts valid length between 43 and 128
+
+2.6.0 :003 > PkceChallenge.challenge(char_length: 50)
+
+ => #<PkceChallenge::Challenge:0x00007f894f20b9a0 @char_length=50, @code_verifier="0St0oCRzGDFj_iIxB8PCwaMPvGLk8vQxDfJIoC_zU56XwwQM21", @code_challenge="01g9RYPZOjpVFB-BBQhd6OC70jlgPFzJ6ie5YkSC7rI">
+```
+
 
 ## Development
 

data/lib/pkce_challenge.rb

@@ -6,6 +6,20 @@ require "pkce_challenge/challenge"
 module PkceChallenge
   class LengthOutOfRangeError < StandardError; end
 
+  # Generate code challenge and verfiier
+  #
+  # Example:
+  #   >> PkceChallenge.challenge
+  #   => #<PkceChallenge::Challenge:0x00007f894f810378 @char_length=48, @code_verifier="QbS08cDO9pce~HVCKe9-UDiJoBMG8xwql4FI.Y3CIdpyJtPU", @code_challenge="HT90mmypkXgneRUVK-Ja009VvnoL-flydbEgRcTp5Yw">
+  #
+  # == Parameters:
+  # options::
+  #   A Hash containing optional arguments. Supported options
+  #   can include `:char_length`
+  #
+  # == Returns:
+  # An instance of PkceChallenge::Challenge
+  #
   def self.challenge(options = {})
     PkceChallenge::Challenge.new(options)
   end

data/lib/pkce_challenge/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PkceChallenge
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pkce_challenge
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Ralak
@@ -85,6 +85,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- gemfiles/pkce_challenge-0.1.0.gem
 - lib/pkce_challenge.rb
 - lib/pkce_challenge/challenge.rb
 - lib/pkce_challenge/version.rb