Bump localhost from 1.2.0 to 1.3.1 #620
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?s=60&v=4){kind=small}
Bumps [localhost](https://github.com/socketry/localhost) from 1.2.0 to 1.3.1. - [Release notes](https://github.com/socketry/localhost/releases) - [Changelog](https://github.com/socketry/localhost/blob/main/release.cert) - [Commits](socketry/localhost@v1.2.0...v1.3.1) --- updated-dependencies: - dependency-name: localhost dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]>
gem compare localhost 1.2.0 1.3.1Compared versions: ["1.2.0", "1.3.1"]
DIFFERENT authors:
1.2.0: ["Samuel Williams", "Olle Jonsson", "Ye Lin Aung", "Akshay Birajdar", "Antonio Terceiro", "Gabriel Sobrinho", "Juri Hahn", "Richard S. Leung", "Yuuji Yaginuma"]
1.3.1: ["Samuel Williams", "Olle Jonsson", "Ye Lin Aung", "Akshay Birajdar", "Antonio Terceiro", "Colin Shea", "Gabriel Sobrinho", "Juri Hahn", "Richard S. Leung", "Yuuji Yaginuma"]
DIFFERENT date:
1.2.0: 2024-02-01 00:00:00 UTC
1.3.1: 2024-04-16 00:00:00 UTC
DIFFERENT metadata:
1.2.0: {}
1.3.1: {"documentation_uri"=>"https://socketry.github.io/localhost/", "source_code_uri"=>"https://github.com/socketry/localhost.git"}
DIFFERENT required_ruby_version:
1.2.0: >= 3.0
1.3.1: >= 3.1
DIFFERENT version:
1.2.0: 1.2.0
1.3.1: 1.3.1
DIFFERENT files:
1.2.0->1.3.1:
* Changed:
lib/localhost/authority.rb +42/-29
lib/localhost/version.rb +2/-2
license.md +1/-0
readme.md +7/-1 |
gem compare --diff localhost 1.2.0 1.3.1Compared versions: ["1.2.0", "1.3.1"]
DIFFERENT files:
1.2.0->1.3.1:
* Changed:
lib/localhost/authority.rb
--- /tmp/d20240417-1812-73lo4w/localhost-1.2.0/lib/localhost/authority.rb 2024-04-17 02:11:51.914988147 +0000
+++ /tmp/d20240417-1812-73lo4w/localhost-1.3.1/lib/localhost/authority.rb 2024-04-17 02:11:51.914988147 +0000
@@ -4 +4 @@
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
@@ -9,0 +10 @@
+# Copyright, 2024, by Colin Shea.
@@ -10,0 +12 @@
+require 'fileutils'
@@ -16,2 +18,23 @@
- def self.path
- File.expand_path("~/.localhost")
+ # Where to store the key pair on the filesystem. This is a subdirectory
+ # of $XDG_STATE_HOME, or ~/.local/state/ when that's not defined.
+ #
+ # Ensures that the directory to store the certificate exists. If the legacy
+ # directory (~/.localhost/) exists, it is moved into the new XDG Basedir
+ # compliant directory.
+ #
+ # After May 2025, the old_root option may be removed.
+ def self.path(env = ENV, old_root: nil)
+ path = File.expand_path("localhost.rb", env.fetch("XDG_STATE_HOME", "~/.local/state"))
+
+ unless File.directory?(path)
+ FileUtils.mkdir_p(path, mode: 0700)
+ end
+
+ # Migrates the legacy dir ~/.localhost/ to the XDG compliant directory
+ old_root ||= File.expand_path("~/.localhost")
+ if File.directory?(old_root)
+ FileUtils.mv(Dir.glob(File.join(old_root, "*")), path, force: true)
+ FileUtils.rmdir(old_root)
+ end
+
+ return path
@@ -22 +45 @@
- return to_enum(:list) unless block_given?
+ return to_enum(:list, root) unless block_given?
@@ -65,4 +87,0 @@
- def ecdh_key
- @ecdh_key ||= OpenSSL::PKey::EC.new "prime256v1"
- end
-
@@ -156,2 +174,0 @@
- elsif context.respond_to? :tmp_ecdh_callback=
- context.tmp_ecdh_callback = proc {self.ecdh_key}
@@ -179,17 +196,15 @@
- if File.directory?(path)
- certificate_path = File.join(path, "#{@hostname}.crt")
- key_path = File.join(path, "#{@hostname}.key")
-
- return false unless File.exist?(certificate_path) and File.exist?(key_path)
-
- certificate = OpenSSL::X509::Certificate.new(File.read(certificate_path))
- key = OpenSSL::PKey::RSA.new(File.read(key_path))
-
- # Certificates with old version need to be regenerated.
- return false if certificate.version < 2
-
- @certificate = certificate
- @key = key
-
- return true
- end
+ certificate_path = File.join(path, "#{@hostname}.crt")
+ key_path = File.join(path, "#{@hostname}.key")
+
+ return false unless File.exist?(certificate_path) and File.exist?(key_path)
+
+ certificate = OpenSSL::X509::Certificate.new(File.read(certificate_path))
+ key = OpenSSL::PKey::RSA.new(File.read(key_path))
+
+ # Certificates with old version need to be regenerated.
+ return false if certificate.version < 2
+
+ @certificate = certificate
+ @key = key
+
+ return true
@@ -199,2 +213,0 @@
- Dir.mkdir(path, 0700) unless File.directory?(path)
-
lib/localhost/version.rb
--- /tmp/d20240417-1812-73lo4w/localhost-1.2.0/lib/localhost/version.rb 2024-04-17 02:11:51.914988147 +0000
+++ /tmp/d20240417-1812-73lo4w/localhost-1.3.1/lib/localhost/version.rb 2024-04-17 02:11:51.914988147 +0000
@@ -4 +4 @@
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
@@ -7 +7 @@
- VERSION = "1.2.0"
+ VERSION = "1.3.1"
license.md
--- /tmp/d20240417-1812-73lo4w/localhost-1.2.0/license.md 2024-04-17 02:11:51.914988147 +0000
+++ /tmp/d20240417-1812-73lo4w/localhost-1.3.1/license.md 2024-04-17 02:11:51.914988147 +0000
@@ -11,0 +12 @@
+Copyright, 2024, by Colin Shea.
readme.md
--- /tmp/d20240417-1812-73lo4w/localhost-1.2.0/readme.md 2024-04-17 02:11:51.914988147 +0000
+++ /tmp/d20240417-1812-73lo4w/localhost-1.3.1/readme.md 2024-04-17 02:11:51.914988147 +0000
@@ -15 +15,7 @@
-Please see the [project documentation](https://socketry.github.io/localhost/).
+Please see the [project documentation](https://socketry.github.io/localhost/) for more details.
+
+ - [Getting Started](https://socketry.github.io/localhost/guides/getting-started/index) - This guide explains how to use `localhost` for provisioning local TLS certificates for development.
+
+ - [Browser Configuration](https://socketry.github.io/localhost/guides/browser-configuration/index) - This guide explains how to configure your local browser in order to avoid warnings about insecure self-signed certificates.
+
+ - [Example Server](https://socketry.github.io/localhost/guides/example-server/index) - This guide demonstrates how to use <code class="language-ruby">Localhost::Authority</code> to implement a simple HTTPS client & server. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bumps localhost from 1.2.0 to 1.3.1.
Release notes
Sourced from localhost's releases.
Commits
f559472Bump patch version.02fade4100% code coverage. (#31)ccc9330Improve handling of old~/.localhostdirectory. (#30)7159819Fix "No such file or directory @ rb_file_s_rename" on migrating to '~/.local/...10790d5Note about removal of legacy directory support.18820b9Prefermktmpdirfor testing.ac2f604Improve HTTPS tests.2e7ec47Update documentation.7acdd15Set Ruby v3.1 as the required minimum Ruby version.a91072fBump minor version.Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting
@dependabot rebase.Dependabot commands and options
You can trigger Dependabot actions by commenting on this PR:
@dependabot rebasewill rebase this PR@dependabot recreatewill recreate this PR, overwriting any edits that have been made to it@dependabot mergewill merge this PR after your CI passes on it@dependabot squash and mergewill squash and merge this PR after your CI passes on it@dependabot cancel mergewill cancel a previously requested merge and block automerging@dependabot reopenwill reopen this PR if it is closed@dependabot closewill close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually@dependabot show <dependency name> ignore conditionswill show all of the ignore conditions of the specified dependency@dependabot ignore this major versionwill close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this minor versionwill close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)@dependabot ignore this dependencywill close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)