webmention-cli 3.0.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d32df008c4cf21c2a8619fc87adde6c3e4b6ddf3736fe068e1bc4dc4a210186
-  data.tar.gz: 17cc6821e96edc355994e53bdeebf6bada24ebe9beabe64d4e04f6e0847bd192
+  metadata.gz: '09c76cc99dd47cc9118e6ee945273f78e34aac9a57b8fc869056c7e0f980107b'
+  data.tar.gz: 2d7a8f4d9268329e3a6166775a3e0853c38701a360b92b5d228d80682d4b14f7
 SHA512:
-  metadata.gz: '09db3b6414f2d6d5cb3d778607c507f62fe9a8d5f96193468aabf6d269ed38999dcd89581e8d14e9bc1659e37da9d2e00173df923b582fee462871bdc3a42826'
-  data.tar.gz: cc65fa707c098086413235cc374ce99b8ae5a00adcb1d34720dbf966088164fe16773bf0e273eb337043f19fcaf0464f7ff74c1ad320c71eb409603f12029399
+  metadata.gz: 7409e32b1b3ac4f8e9ef5edf4932d4d61d945260e504dc67c08549c194e0e252912ad91e895390ee8afc638e8fe08f5edca54b51ecff6b2ac14eacdfa4373912
+  data.tar.gz: f23d442031b48defe2a18a121bd31dc93c7b0ccb7c1c57fb883cc010d14da5b8d890deb79f4d4939c7f2972ef06e8df7fc415e8bc39f9841c75e73980adc4027

data/README.md

@@ -1,6 +1,6 @@
 # webmention-cli
 
-**A command-line interface for Webmention written in Ruby.**
+A command-line interface for Webmention written in Ruby.
 
 [![Gem](https://img.shields.io/gem/v/webmention-cli.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/webmention-cli)
 [![Downloads](https://img.shields.io/gem/dt/webmention-cli.svg?logo=rubygems&style=for-the-badge)](https://rubygems.org/gems/webmention-cli)
@@ -22,29 +22,39 @@ $ gem install webmention-cli
 
 webmention-cli makes available the following commands:
 
-### `webmention endpoint <target>`
+### `webmention endpoint URL`
 
-Discover the Webmention endpoint for a `<target>` URL.
+Discover the Webmention endpoint for a URL.
 
 ```sh
 $ webmention endpoint https://sixtwothree.org
 https://sixtwothree.org/webmentions
 ```
 
-The command returns a non-zero exit code if the `<target>` URL does not advertise a Webmention endpoint (or if an HTTP error was encountered).
+The command returns a non-zero exit code if the given URL does not advertise a Webmention endpoint (or if an HTTP error was encountered).
 
-### `webmention send <source> <target>`
+### `webmention mentions URL`
 
-Send a webmention from a `<source>` URL to a `<target>` URL.
+Discover the unique URLs mentioned by the given URL.
+
+```sh
+$ webmention mentions https://sixtwothree.org/posts/now-accepting-webmentions
+http://aaronparecki.com/
+http://indiewebcamp.com/
+http://indiewebcamp.com/2014
+# etc. etc. etc.
+```
+
+### `webmention send SOURCE TARGET`
+
+Send a webmention from a `SOURCE` URL to a `TARGET` URL.
 
 ```sh
 $ webmention send https://sixtwothree.org/posts/an-engineer-walks-into-a-design-sprint https://adactio.com/journal/6246
 202 Accepted
 ```
 
-The command will return either an HTTP status _or_ the value of the response's `Location` header (if provided _and_ the response's HTTP status is `201 Created`).
-
-A non-zero exit code is returned if the HTTP status is _not_ within the 200 range (or if an HTTP error was encountered).
+The command returns either an HTTP status _or_ the value of the response's `Location` header (if provided _and_ the response's HTTP status is `201 Created`). A non-zero exit code is returned if the HTTP status is _not_ within the 200 range (or if an HTTP error was encountered).
 
 #### Send a webmention with a vouch URL
 
@@ -55,15 +65,15 @@ $ webmention send https://sixtwothree.org/posts/now-accepting-webmentions https:
 
 The command with a vouch URL included responds in the same fashion as noted above.
 
-### `webmention verify <source> <target>`
+### `webmention verify SOURCE TARGET`
 
-Confirm whether or not a `<source>` URL links to a `<target>` URL.
+Confirm whether or not a `SOURCE` URL links to a `TARGET` URL.
 
 ```sh
 $ webmention verify https://kartikprabhu.com/notes/re-launching-franciscms https://sixtwothree.org/posts/launching-franciscms-onto-the-indieweb
 ```
 
-The command will return a zero exit code if `<source>` links to `<target>` and a non-zero exit code in all other cases.
+The command returns a zero exit code if `SOURCE` links to `TARGET` and a non-zero exit code in all other cases.
 
 #### Verify a webmention with a vouch URL
 
@@ -71,7 +81,7 @@ The command will return a zero exit code if `<source>` links to `<target>` and a
 $ webmention verify https://kartikprabhu.com/notes/re-launching-franciscms https://sixtwothree.org/posts/launching-franciscms-onto-the-indieweb --vouch https://adactio.com/links/9229
 ```
 
-The command will return a zero exit code if `<source>` links to `<target>` _and_ the provided vouch URL links to the `<source>`'s domain. A non-zero exist code is returned in all other cases.
+The command returns a zero exit code if `SOURCE` links to `TARGET` _and_ the provided vouch URL links to the `SOURCE`'s domain. A non-zero exist code is returned in all other cases.
 
 ## Acknowledgments
 
@@ -81,4 +91,4 @@ webmention-cli is written and maintained by [Jason Garber](https://sixtwothree.o
 
 ## License
 
-webmention-cli is freely available under the [MIT License](https://opensource.org/licenses/MIT).
+This project is freely available under the [MIT License](https://opensource.org/licenses/MIT).

data/exe/webmention

@@ -6,4 +6,4 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require "webmention/cli"
 
-Webmention::CLI::Runner.start
+Webmention::CLI.start

data/lib/webmention/cli.rb

@@ -3,6 +3,79 @@
 require "thor"
 require "webmention"
 
-require_relative "cli/version"
+module Webmention
+  # A command-line interface for Webmention.
+  #
+  # @api private
+  #
+  # @see https://www.w3.org/TR/webmention/
+  # @see https://indieweb.org/Webmention
+  class CLI < Thor
+    include Thor::Actions
 
-require_relative "cli/runner"
+    package_name "Webmention"
+
+    map ["-v", "--version"] => :version
+
+    # simplecov:disable
+    def self.exit_on_failure?
+      true
+    end
+    # simplecov:enable
+
+    desc "endpoint URL", "Discover a URL's Webmention endpoint"
+    def endpoint(url)
+      webmention_endpoint = Webmention::Url.new(url).webmention_endpoint
+
+      exit 1 if webmention_endpoint.nil?
+
+      say webmention_endpoint
+    end
+
+    desc "mentions URL", "Discover unique URLs mentioned by a URL"
+    def mentions(url)
+      urls = Webmention.mentioned_urls(url)
+
+      exit 1 if urls.none?
+
+      say urls.join("\n")
+    rescue Burly::UnsupportedMimeType
+      exit 1
+    end
+
+    desc "send SOURCE TARGET", "Send a webmention from a source URL to a target URL"
+    method_option :vouch,
+                  desc: "Submit a vouch URL (https://indieweb.org/Vouch)",
+                  type: :string
+    def send(source, target)
+      response = Webmention.send_webmention(source, target, vouch: options[:vouch])
+
+      exit 1 unless response.ok?
+
+      code = response.code
+      location = response.headers["Location"]
+
+      say(code == 201 && location ? location : "#{code} #{response.reason}")
+
+      exit 1 unless code.between?(200, 299)
+    end
+
+    desc "verify SOURCE TARGET", "Verify a source URL links to a target URL"
+    method_option :vouch,
+                  desc: "Verify a vouch URL mentions a source URL's domain (https://indieweb.org/Vouch)",
+                  type: :string
+    def verify(source, target)
+      verification = Webmention.verify_webmention(source, target, vouch: options[:vouch])
+
+      exit 1 unless verification.verified?
+    end
+
+    desc "version", "Print version information"
+    def version
+      webmention_version = Gem::Specification.find_by_name("webmention").version
+      webmention_cli_version = Gem::Specification.find_by_name("webmention-cli").version
+
+      say "webmention-cli v#{webmention_cli_version} (webmention-client-ruby v#{webmention_version})"
+    end
+  end
+end

data/webmention-cli.gemspec

@@ -1,12 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "lib/webmention/cli/version"
-
 Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 2.7"
 
   spec.name          = "webmention-cli"
-  spec.version       = Webmention::CLI::VERSION
+  spec.version       = "4.0.0"
   spec.authors       = ["Jason Garber"]
   spec.email         = ["jason@sixtwothree.org"]
 
@@ -32,6 +30,6 @@ Gem::Specification.new do |spec|
     "source_code_uri" => "#{spec.homepage}/src/tag/v#{spec.version}",
   }
 
-  spec.add_dependency "thor", "~> 1.3"
-  spec.add_dependency "webmention", "~> 7.0"
+  spec.add_dependency "thor", "~> 1.5"
+  spec.add_dependency "webmention", "~> 10.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: webmention-cli
 version: !ruby/object:Gem::Version
-  version: 3.0.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Jason Garber
@@ -15,28 +15,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: webmention
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '10.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '10.1'
 description: A command-line interface for Webmention.
 email:
 - jason@sixtwothree.org
@@ -50,19 +50,17 @@ files:
 - README.md
 - exe/webmention
 - lib/webmention/cli.rb
-- lib/webmention/cli/runner.rb
-- lib/webmention/cli/version.rb
 - webmention-cli.gemspec
 homepage: https://codeberg.org/jgarber/webmention-cli
 licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://codeberg.org/jgarber/webmention-cli/issues
-  changelog_uri: https://codeberg.org/jgarber/webmention-cli/releases/tag/v3.0.2
-  documentation_uri: https://rubydoc.info/gems/webmention-cli/3.0.2
+  changelog_uri: https://codeberg.org/jgarber/webmention-cli/releases/tag/v4.0.0
+  documentation_uri: https://rubydoc.info/gems/webmention-cli/4.0.0
   homepage_uri: https://codeberg.org/jgarber/webmention-cli
   rubygems_mfa_required: 'true'
-  source_code_uri: https://codeberg.org/jgarber/webmention-cli/src/tag/v3.0.2
+  source_code_uri: https://codeberg.org/jgarber/webmention-cli/src/tag/v4.0.0
 rdoc_options: []
 require_paths:
 - lib
@@ -77,7 +75,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 4.0.20
 specification_version: 4
 summary: A command-line interface for Webmention.
 test_files: []

data/lib/webmention/cli/runner.rb

@@ -1,56 +0,0 @@
-# frozen_string_literal: true
-
-module Webmention
-  module CLI
-    class Runner < Thor
-      include Thor::Actions
-
-      package_name "Webmention"
-
-      map ["-v", "--version"] => :version
-
-      # :nocov:
-      def self.exit_on_failure?
-        true
-      end
-      # :nocov:
-
-      desc "endpoint <target>", "Discover the Webmention endpoint for <target> URL"
-      def endpoint(target)
-        url = Webmention::Url.new(target)
-
-        exit 1 unless url.webmention_endpoint?
-
-        say url.webmention_endpoint
-      end
-
-      desc "send <source> <target>", "Send a webmention from <source> URL to <target> URL"
-      option :vouch, desc: "Submit a <vouch> URL"
-      def send(source, target)
-        response = Webmention.send_webmention(source, target, vouch: options[:vouch])
-
-        exit 1 unless response.ok?
-
-        code = response.code
-        location = response.headers["Location"]
-
-        say(code == 201 && location ? location : "#{code} #{response.reason}")
-
-        exit 1 unless code.between?(200, 299)
-      end
-
-      desc "verify <source> <target>", "Verify that <source> URL links to <target> URL"
-      option :vouch, desc: "Verify that <vouch> URL mentions the <source> URL domain"
-      def verify(source, target)
-        verification = Webmention.verify_webmention(source, target, vouch: options[:vouch])
-
-        exit 1 unless verification.verified?
-      end
-
-      desc "version", "Print version information"
-      def version
-        say "webmention-cli version #{Webmention::CLI::VERSION}"
-      end
-    end
-  end
-end

data/lib/webmention/cli/version.rb

@@ -1,7 +0,0 @@
-# frozen_string_literal: true
-
-module Webmention
-  module CLI
-    VERSION = "3.0.2"
-  end
-end