glogin 0.14.0 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 276e84fbfff7c015118724369f25d3d5da61fae762762cf96c5bd53fc1bbf7b0
-  data.tar.gz: 445af8bffcb5359e4e8170b7b9abe0596d28b538b0f07bde510245a0e03b4196
+  metadata.gz: 56ba569dbb60a5e6e480c86cf2b5e103c6bd42d695e57d16bfc9b94a9b819526
+  data.tar.gz: 4cd694c79226b6a7946caf4adac29ea10326f7944f89facb7b578c2ea1bc9034
 SHA512:
-  metadata.gz: 466d1bdf480926b5b25d088560df94937adfa0c16a4156aaed125a5c37283d0ae3c2f4bcef8c0a3fc56d55802a198f43885557d528c941c1b257dec7ce7df02b
-  data.tar.gz: f9ffc87fc989b4969e4dcc96d10398ff7702f947f910048d56545bb6db0fb69b15f0752ad08549036e4ad8933c0fdd2c4ae6a835383d0f60edd052ba45c27cbe
+  metadata.gz: 37236f4de0ef6c6984c450cf03c0c6a79f51564911d3cf8a35408158d57153bfbda6c966cb0f5aa678e96c4482f89142d189f1d5054efd5b4c10227a01aa75d3
+  data.tar.gz: 0f3a77248cd9c7ec6c925693ee125b8a34b86fd1def5d3f7e4bf45265d4a7ae46bf36b628444ce669e8da164116d57c88af6fb953e803520f6209bb3f066b954

data/Gemfile

@@ -24,11 +24,11 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'minitest', '5.20.0', require: false
+gem 'minitest', '5.21.2', require: false
 gem 'rake', '13.1.0', require: false
 gem 'rdoc', '6.6.1', require: false
 gem 'rspec-rails', '6.1.0', require: false
-gem 'rubocop', '1.60.1', require: false
+gem 'rubocop', '1.60.2', require: false
 gem 'rubocop-rspec', '2.26.1', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'webmock', '3.19.1', require: false

data/lib/glogin/auth.rb

@@ -56,9 +56,9 @@ module GLogin
       if @secret.empty?
         return {
           'id' => 526_301,
-          'type' => 'User',
           'login' => 'yegor256',
-          'avatar_url' => 'https://github.com/yegor256.png'
+          'avatar_url' => 'https://github.com/yegor256.png',
+          'bearer' => ''
         }
       end
       raise 'Code can\'t be nil' if code.nil?

data/lib/glogin/cookie.rb

@@ -39,19 +39,29 @@ module GLogin
   #
   class Cookie
     # Closed cookie.
+    #
+    # An instance of this class is created when a cookie arrives
+    # to the application. The cookie text is provided to the class
+    # as the first parameter. Then, when an instance of the class
+    # is created, the value encypted inside the cookie text may
+    # be retrieved through the +to_user+ method.
     class Closed
       def initialize(text, secret, context = '')
         raise 'Text can\'t be nil' if text.nil?
         @text = text
         raise 'Secret can\'t be nil' if secret.nil?
         @secret = secret
+        raise 'Context can\'t be nil' if context.nil?
         @context = context.to_s
       end
 
-      # Returns a hash with two elements: login and avatar.
-      # If the secret is empty, the text will be returned, without
-      # any decryption. If the data is not valid, an exception
-      # GLogin::Codec::DecodingError will be raised, which you have
+      # Returns a hash with four elements: `id`, `login`, `avatar`, and `bearer`.
+      #
+      # If the `secret` is empty, the text will not be decrypted, but used
+      # "as is". This may be helpful during testing.
+      #
+      # If the data is not valid, an exception
+      # `GLogin::Codec::DecodingError` will be raised, which you have
       # to catch in your applicaiton and ignore the login attempt.
       def to_user
         plain = Codec.new(@secret).decrypt(@text)
@@ -68,38 +78,37 @@ module GLogin
 
     # Open
     class Open
-      # Here comes the JSON you receive from Auth.user()
+      attr_reader :id, :login, :avatar_url, :bearer
+
+      # Here comes the JSON you receive from Auth.user().
+      #
+      # The JSON is a Hash where every key is a string. When the class is instantiated,
+      # its methods `id`, `login`, and `avatar_url` may be used to retrieve
+      # the data inside the JSON, but this is not what this class is mainly about.
+      #
+      # The method +to_s+ returns an encrypted cookie string, that may be
+      # sent to the user as a +Set-Cookie+ HTTP header.
       def initialize(json, secret, context = '')
         raise 'JSON can\'t be nil' if json.nil?
-        @json = json
+        raise 'JSON must contain "id" key' if json['id'].nil?
+        @id = json['id']
+        @login = json['login'] || ''
+        @avatar_url = json['avatar_url'] || ''
+        @bearer = json['bearer'] || ''
         raise 'Secret can\'t be nil' if secret.nil?
         @secret = secret
+        raise 'Context can\'t be nil' if context.nil?
         @context = context.to_s
       end
 
-      # GitHub id of the authenticated user
-      def id
-        @json['id']
-      end
-
-      # GitHub login name of the authenticated user
-      def login
-        @json['login']
-      end
-
-      # GitHub avatar URL of the authenticated user
-      def avatar_url
-        @json['avatar_url']
-      end
-
       # Returns the text you should drop back to the user as a cookie.
       def to_s
         Codec.new(@secret).encrypt(
           [
-            id,
-            login,
-            avatar_url,
-            @json['bearer'],
+            @id,
+            @login,
+            @avatar_url,
+            @bearer,
             @context
           ].join(GLogin::SPLIT)
         )

data/lib/glogin/version.rb

@@ -26,5 +26,5 @@
 # Copyright:: Copyright (c) 2017-2024 Yegor Bugayenko
 # License:: MIT
 module GLogin
-  VERSION = '0.14.0'
+  VERSION = '0.14.2'
 end

data/test/glogin/test_cookie.rb

@@ -31,7 +31,7 @@ class TestCookie < Minitest::Test
       GLogin::Cookie::Open.new(
         JSON.parse(
           "{\"id\":\"123\",
-          \"login\":\"yegor256\",
+          \"login\":\"yegor256\",\"bearer\":\"\",
           \"avatar_url\":\"https://avatars1.githubusercontent.com/u/526301\"}"
         ),
         secret
@@ -47,7 +47,7 @@ class TestCookie < Minitest::Test
     context = '127.0.0.1'
     user = GLogin::Cookie::Closed.new(
       GLogin::Cookie::Open.new(
-        JSON.parse('{"id":"123","login":"jeffrey","avatar_url":"#"}'),
+        JSON.parse('{"id":"123","login":"jeffrey","avatar_url":"#","bearer":""}'),
         secret,
         context
       ).to_s,
@@ -81,7 +81,7 @@ class TestCookie < Minitest::Test
     assert_raises GLogin::Codec::DecodingError do
       GLogin::Cookie::Closed.new(
         GLogin::Cookie::Open.new(
-          JSON.parse('{"login":"x","avatar_url":"x"}'),
+          JSON.parse('{"login":"x","avatar_url":"x","id":"1","bearer":""}'),
           'secret-1'
         ).to_s,
         'secret-2'
@@ -94,7 +94,7 @@ class TestCookie < Minitest::Test
     assert_raises GLogin::Codec::DecodingError do
       GLogin::Cookie::Closed.new(
         GLogin::Cookie::Open.new(
-          JSON.parse('{"login":"x","avatar_url":"x"}'),
+          JSON.parse('{"login":"x","avatar_url":"x","id":"","bearer":""}'),
           secret,
           'context-1'
         ).to_s,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glogin
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.14.2
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-01-19 00:00:00.000000000 Z
+date: 2024-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base58