glogin 0.13.0 → 0.14.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 676ad5d1a6bca2ec2d76ab9939299b3a561d86151d5fda5cf256db88e0710b61
-  data.tar.gz: d43e3c48a754d4a1be1d2e22e6665d10fd311afb45b2bc7bdab800b0d65c631f
+  metadata.gz: 43ce4ccebe57a06bb860c407b9e96dc939932f952aa2a6c4951a64f79a5f34c7
+  data.tar.gz: 65854ae4920a4ff27bd67bcf7cf34d8222be36398639bd82b013fa73b94700a5
 SHA512:
-  metadata.gz: 827cee7b4b9e198cd05c46fd91a02db8df3a76121d1f94a5892f4c83fd93c8689366a7e9c36146c7efd7db1bec9321d697893a6cd6497ee386bcfc1c514a9e4c
-  data.tar.gz: df68d65779e90da7a79dac9f97d101f9d7a1a37c5e3711b1170c94021334c09f873bec55fd3c438e525cfdd575a877d8bbfcf91ffbc12d2bad14c96162e82e6a
+  metadata.gz: c36870984ff3f36eb946b5bbb5273bc4f3633332651bd180196d1b172c7782248583285a0e3c9ae499205d45b6a45bb6e19910b7fb6ca8a455b0b2af8934c457
+  data.tar.gz: 456ef6a6e5329d490d2195c58d3c8c007e23f6326f4535d362b04898451009926a5226baa384342b8dd889f6e00c17b8ef595d85e7a0e0fd5fa4a06c69324642

data/.github/workflows/codecov.yml

@@ -8,13 +8,14 @@ jobs:
   codecov:
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: 2.7
       - run: bundle update
       - run: bundle exec rake
-      - uses: codecov/codecov-action@v3
+      - uses: codecov/codecov-action@v4.0.0-beta.3
         with:
+          token: ${{ secrets.CODECOV_TOKEN }}
           file: coverage/.resultset.json
           fail_ci_if_error: true

data/.github/workflows/pdd.yml

@@ -2,10 +2,14 @@
 name: pdd
 on:
   push:
+    branches:
+      - master
   pull_request:
+    branches:
+      - master
 jobs:
   pdd:
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
-      - uses: g4s8/pdd-action@master
+      - uses: actions/checkout@v4
+      - uses: volodya-lombrozo/pdd-action@master

data/.github/workflows/rake.yml

@@ -16,7 +16,7 @@ jobs:
         ruby: [2.7, 3.2]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
       - uses: ruby/setup-ruby@v1
         with:
           ruby-version: ${{ matrix.ruby }}

data/.github/workflows/xcop.yml

@@ -7,5 +7,5 @@ jobs:
   xcop:
     runs-on: ubuntu-22.04
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
       - uses: g4s8/xcop-action@master

data/.rultor.yml

@@ -1,11 +1,10 @@
 docker:
-  image: yegor256/rultor-image:1.19.0
+  image: yegor256/rultor-image:1.22.0
 assets:
   rubygems.yml: yegor256/home#assets/rubygems.yml
 install: |
-  sudo gem install openssl -- --with-openssl-dir=/usr/local/rvm/rubies/ruby-3.0.1/lib/ruby/3.0.0/openssl
   pdd -f /dev/null
-  sudo bundle install --no-color "--gemfile=$(pwd)/Gemfile"
+  bundle install --no-color
 release:
   pre: false
   script: |-

data/.simplecov

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/Gemfile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -24,11 +24,11 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'minitest', '5.19.0', require: false
-gem 'rake', '13.0.6', require: false
-gem 'rdoc', '6.5.0', require: false
-gem 'rspec-rails', '6.0.3', require: false
-gem 'rubocop', '1.56.0', require: false
-gem 'rubocop-rspec', '2.23.2', 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-rspec', '2.26.1', require: false
 gem 'simplecov', '0.22.0', require: false
-gem 'webmock', '3.18.1', require: false
+gem 'webmock', '3.19.1', require: false

data/LICENSE.txt

@@ -1,6 +1,6 @@
 (The MIT License)
 
-Copyright (c) 2017-2023 Yegor Bugayenko
+Copyright (c) 2017-2024 Yegor Bugayenko
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the 'Software'), to deal

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/glogin.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/lib/glogin/auth.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -28,7 +28,7 @@ require 'cgi'
 
 # GLogin main module.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2017-2024 Yegor Bugayenko
 # License:: MIT
 module GLogin
   #
@@ -48,7 +48,19 @@ module GLogin
       "https://github.com/login/oauth/authorize?client_id=#{CGI.escape(@id)}&redirect_uri=#{CGI.escape(@redirect)}"
     end
 
+    # Returns a hash with information about Github user,
+    # who just logged in with the authentication code.
+    #
+    # API: https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28#get-the-authenticated-user
     def user(code)
+      if @secret.empty?
+        return {
+          'id' => 526_301,
+          'login' => 'yegor256',
+          'avatar_url' => 'https://github.com/yegor256.png',
+          'bearer' => ''
+        }
+      end
       raise 'Code can\'t be nil' if code.nil?
       uri = URI.parse('https://api.github.com/user')
       http = Net::HTTP.new(uri.host, uri.port)

data/lib/glogin/codec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -29,7 +29,7 @@ require 'base64'
 
 # Codec.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2017-2024 Yegor Bugayenko
 # License:: MIT
 module GLogin
   # The codec

data/lib/glogin/cookie.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -28,7 +28,7 @@ require_relative 'codec'
 
 # GLogin main module.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2017-2024 Yegor Bugayenko
 # License:: MIT
 module GLogin
   # Split symbol inside the cookie text
@@ -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,12 +78,24 @@ module GLogin
 
     # Open
     class Open
-      # Here comes the JSON you receive from Auth.user()
+      # 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?
+        raise 'JSON must contain "id" key' if json['id'].nil?
+        raise 'JSON must contain "login" key' if json['login'].nil?
+        raise 'JSON must contain "avatar_url" key' if json['avatar_url'].nil?
+        raise 'JSON must contain "bearer" key' if json['bearer'].nil?
         @json = json
         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
 

data/lib/glogin/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -23,8 +23,8 @@
 
 # GLogin main module.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2017-2024 Yegor Bugayenko
 # License:: MIT
 module GLogin
-  VERSION = '0.13.0'
+  VERSION = '0.14.1'
 end

data/lib/glogin.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -28,7 +28,7 @@ require_relative 'glogin/cookie'
 
 # GLogin main module.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2017-2024 Yegor Bugayenko
 # License:: MIT
 module GLogin
 end

data/test/glogin/test_auth.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -53,4 +53,9 @@ class TestAuth < Minitest::Test
       )
     )
   end
+
+  def test_get_fake_user
+    auth = GLogin::Auth.new('99999', '', 'http://www.example.com/github-oauth')
+    assert_equal('yegor256', auth.user('1234567890')['login'])
+  end
 end

data/test/glogin/test_codec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/test/glogin/test_cookie.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -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":"999","bearer":""}'),
           secret,
           'context-1'
         ).to_s,

data/test/test__helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal

data/test/test_glogin.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 #
-# Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright (c) 2017-2024 Yegor Bugayenko
 #
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the 'Software'), to deal
@@ -26,7 +26,7 @@ require_relative '../lib/glogin'
 
 # GLogin main module test.
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2017-2023 Yegor Bugayenko
+# Copyright:: Copyright (c) 2017-2024 Yegor Bugayenko
 # License:: MIT
 class TestGLogin < Minitest::Test
   def test_basic

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glogin
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.1
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-08-25 00:00:00.000000000 Z
+date: 2024-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base58
@@ -95,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
 summary: Login/logout via GitHub OAuth for your web app