pkce_challenge 0.1.0 → 0.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7b139d60991d43e02cd1502c943418860e68aad024b228652f305545e167adde
4
- data.tar.gz: 7f5beb4d144d09fda3192574d8643bee4daf9d3c712daa8bc7dee90d5e5b9aaf
3
+ metadata.gz: b24f70ed4dc880603fc1bb11a17a5c2c576d8810ec0abb9b1b7ae36fbeef46e2
4
+ data.tar.gz: 75b4d4b4e347b0ead4b2acfc4190b90f5767cafcd16c87186170758764749a74
5
5
  SHA512:
6
- metadata.gz: b848fa5d3448e85a3a44cde27023545b1b410935be18280224e8c46a1d61c35f3fa2e4f1ae7dde352aff53b0542c3cdcb95e6d28e05713784a8a20d9d2f35e66
7
- data.tar.gz: e27581d2507751d73866e13851f9558597eec9cfe779ddac7361c520664191e0d6556c47aa9d99f10d5fd9eebd04e8771258d9f74344120fba8777606a9a52b9
6
+ metadata.gz: ee179537017917cc647efb5f683200d66319e783ad73a3575ff3071cf6278ee3286641f6f7896d4eedd0615bda64b0d370c672bc86e0e35f3f162966027049f9
7
+ data.tar.gz: 663f440155dede9a1a406b6cd96ed7f4de900413b94c5008f759a8c3ddbbe1016e8f621884bd0e55f6aeae52dcf32765dba07f3d5a95c6d465e533ea674f24fb
data/README.md CHANGED
@@ -22,7 +22,28 @@ Or install it yourself as:
22
22
 
23
23
  ## Usage
24
24
 
25
- TODO: Write usage instructions here
25
+ ```ruby
26
+ 2.6.0 :001 > require "pkce_challenge"
27
+ ```
28
+
29
+ ```ruby
30
+ 2.6.0 :001 > PkceChallenge.challenge
31
+ ```
32
+
33
+ Output:
34
+ ```ruby
35
+ => #<PkceChallenge::Challenge:0x00007f894f810378 @char_length=48, @code_verifier="QbS08cDO9pce~HVCKe9-UDiJoBMG8xwql4FI.Y3CIdpyJtPU", @code_challenge="HT90mmypkXgneRUVK-Ja009VvnoL-flydbEgRcTp5Yw">
36
+ ```
37
+
38
+ Generating a code challenge with the `char_length` option:
39
+ ```ruby
40
+ # Accepts valid length between 43 and 128
41
+
42
+ 2.6.0 :003 > PkceChallenge.challenge(char_length: 50)
43
+
44
+ => #<PkceChallenge::Challenge:0x00007f894f20b9a0 @char_length=50, @code_verifier="0St0oCRzGDFj_iIxB8PCwaMPvGLk8vQxDfJIoC_zU56XwwQM21", @code_challenge="01g9RYPZOjpVFB-BBQhd6OC70jlgPFzJ6ie5YkSC7rI">
45
+ ```
46
+
26
47
 
27
48
  ## Development
28
49
 
@@ -6,6 +6,20 @@ require "pkce_challenge/challenge"
6
6
  module PkceChallenge
7
7
  class LengthOutOfRangeError < StandardError; end
8
8
 
9
+ # Generate code challenge and verfiier
10
+ #
11
+ # Example:
12
+ # >> PkceChallenge.challenge
13
+ # => #<PkceChallenge::Challenge:0x00007f894f810378 @char_length=48, @code_verifier="QbS08cDO9pce~HVCKe9-UDiJoBMG8xwql4FI.Y3CIdpyJtPU", @code_challenge="HT90mmypkXgneRUVK-Ja009VvnoL-flydbEgRcTp5Yw">
14
+ #
15
+ # == Parameters:
16
+ # options::
17
+ # A Hash containing optional arguments. Supported options
18
+ # can include `:char_length`
19
+ #
20
+ # == Returns:
21
+ # An instance of PkceChallenge::Challenge
22
+ #
9
23
  def self.challenge(options = {})
10
24
  PkceChallenge::Challenge.new(options)
11
25
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module PkceChallenge
4
- VERSION = "0.1.0"
4
+ VERSION = "0.2.0"
5
5
  end
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: pkce_challenge
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Samuel Ralak
@@ -85,6 +85,7 @@ files:
85
85
  - Rakefile
86
86
  - bin/console
87
87
  - bin/setup
88
+ - gemfiles/pkce_challenge-0.1.0.gem
88
89
  - lib/pkce_challenge.rb
89
90
  - lib/pkce_challenge/challenge.rb
90
91
  - lib/pkce_challenge/version.rb