webmention-verification 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2132738467e12670eb219ec7c13dd036ecf6f66c1ac9d140dbc2ae5c923bab8e
-  data.tar.gz: 6c7ae3453d6d6f49d636232da018296b79653742e006fae38759d25ab97ff7d8
+  metadata.gz: 66b22219ff7225b01af23a17fea1b9e1eaa7a0030f277aaab6eae432431d2985
+  data.tar.gz: 9a07439c13437f0abe28e6a39476c62f8e4404626e16562a75e7b072e712b988
 SHA512:
-  metadata.gz: 1c179c019d4ef0f934c80971f8c025389cab04f3e4bd1f53989e596e82b426049ed02e63f7a98cd643c55be76ba31d8c29e3170f26783c308048c27332a07429
-  data.tar.gz: bd29c4d92f5906acbca29055c1aa68f4e122dc7766046acbe31b457932baf2aa8e4d8a47cf6dd58207ed7d508224e42f464c3ef2da541be104a113aa0dcc1e29
+  metadata.gz: 93120d7e665aca4d13616f94edbee5f7953edb8a0abb7e4a3f0c900c07da5597cf2f89da39b001132bf6daf17dbee7f70342a669d29390a0dc94b64c22db7abd
+  data.tar.gz: e741360306cbdbace9ab13d6bc17d5b2437b031a0b453b142024707b656aee7807d60122d7d3ff89ce3be2a562b691106e424de95530d42d26d0dc141009674e

data/.rubocop.yml

@@ -4,6 +4,7 @@ require:
 
 Layout/AlignHash:
   EnforcedColonStyle: table
+  EnforcedHashRocketStyle: table
 
 Metrics/BlockLength:
   Exclude:

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
   - 2.4.6
   - 2.5.5
-  - 2.6.2
+  - 2.6.3
 cache:
   - bundler
 before_install:

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.1.0 / 2019-05-01
+
+- Add `Webmention::Verification.client` method.
+- Rename base `Error` class to `WebmentionVerificationError` ([0eb3a9a](https://github.com/jgarber623/webmention-verification-ruby/commit/0eb3a9a)).
+- Add `HttpRequest` class ([c7602c9](https://github.com/jgarber623/webmention-verification-ruby/commit/c7602c9)).
+
 ## 1.0.0 / 2019-04-25
 
 - Use pre-release HTTP gem (see @httprb/http#489) ([bdcfdad](https://github.com/jgarber623/webmention-verification-ruby/commit/bdcfdad)).

data/CONTRIBUTING.md

@@ -8,7 +8,7 @@ There are a couple ways you can help improve webmention-verification-ruby:
 
 ## Getting Started
 
-webmention-verification-ruby is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.2 using [Travis CI](https://travis-ci.com/jgarber623/webmention-verification-ruby).
+webmention-verification-ruby is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.3 using [Travis CI](https://travis-ci.com/jgarber623/webmention-verification-ruby).
 
 Before making changes to webmention-verification-ruby, you'll want to install Ruby 2.4.6. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm). Once you've installed Ruby 2.4.6 using your method of choice, install the project's gems by running:
 

data/README.md

@@ -18,7 +18,7 @@
 
 Before installing and using webmention-verification-ruby, you'll want to have [Ruby](https://www.ruby-lang.org) 2.4 (or newer) installed. It's recommended that you use a Ruby version managment tool like [rbenv](https://github.com/rbenv/rbenv), [chruby](https://github.com/postmodern/chruby), or [rvm](https://github.com/rvm/rvm).
 
-webmention-verification-ruby is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.2 using [Travis CI](https://travis-ci.com/jgarber623/webmention-verification-ruby).
+webmention-verification-ruby is developed using Ruby 2.4.6 and is additionally tested against Ruby 2.5.5 and 2.6.3 using [Travis CI](https://travis-ci.com/jgarber623/webmention-verification-ruby).
 
 ## Installation
 
@@ -50,14 +50,14 @@ target = 'https://target.example.com/post/100'
 
 verified = Webmention::Verification.verified?(source, target)
 
-puts verified # returns Boolean
+puts verified # => Boolean true or false
 ```
 
 This example assumes that you've received a webmention from `https://source.example.com/post/100` (the "source") to your URL, `https://target.example.com/post/100` (the "target"). The above code will return `true` if the source URL links to your target URL and `false` if it doesn't.
 
 ### Advanced Usage
 
-Should the need arise, you may work directly with the `Webmention::Verification::Client` class:
+Should the need arise, you may work with the `Webmention::Verification::Client` class:
 
 ```ruby
 require 'webmention/verification'
@@ -65,17 +65,17 @@ require 'webmention/verification'
 source = 'https://source.example.com/post/100'
 target = 'https://target.example.com/post/100'
 
-client = Webmention::Verification::Client.new(source, target)
+client = Webmention::Verification.client(source, target)
 
-puts client.source     # returns String: 'https://source.example.com/post/100'
-puts client.target     # returns String: 'https://target.example.com/post/100'
+puts client.source     # => 'https://source.example.com/post/100'
+puts client.target     # => 'https://target.example.com/post/100'
 
-puts client.source_uri # returns Addressable::URI
-puts client.target_uri # returns Addressable::URI
+puts client.source_uri # => #<Addressable::URI>
+puts client.target_uri # => #<Addressable::URI>
 
-puts client.response   # returns HTTP::Response
+puts client.response   # => #<HTTP::Response>
 
-puts client.verified?  # returns Boolean
+puts client.verified?  # => Boolean true or false
 ```
 
 **By default, webmention-verification-ruby will strictly match URLs.** You may disable strict matching which allows webmention-verification-ruby to match both `http://` and `https://` URLs. This is useful for matching webmentions your website may have received before it was available exclusively via HTTPS.
@@ -88,9 +88,9 @@ require 'webmention/verification'
 source = 'https://source.example.com/post/100'
 target = 'https://target.example.com/post/100'
 
-client = Webmention::Verification::Client.new(source, target, strict: false)
+client = Webmention::Verification.client(source, target, strict: false)
 
-puts client.verified?  # returns Boolean
+puts client.verified?  # => Boolean true or false
 ```
 
 The above example will match either `https://source.example.com/post/100` _or_ `http://source.example.com/post/100` in the target URL.
@@ -131,15 +131,15 @@ target = 'https://target.example.com/post/100'
 
 verifier = Webmention::Verification::Verifiers::HtmlVerifier.new(response, target)
 
-verifier.verified? # returns Boolean
-verifier.results   # returns Array
+verifier.verified? # => Boolean true or false
+verifier.results   # => Array
 ```
 
 In the example above, `verifier.results` will return an array of HTML elements that link to the provided target URL. An empty array will be returned if no elements linking to the target URL are found in the source URL.
 
 ### Exception Handling
 
-There are several exceptions that may be raised by webmention-verification-ruby's underlying dependencies. These errors are raised as subclasses of `Webmention::Verification::Error` (which itself is a subclass of `StandardError`).
+There are several exceptions that may be raised by webmention-verification-ruby's underlying dependencies. These errors are raised as subclasses of `WebmentionVerificationError` (which itself is a subclass of `StandardError`).
 
 From [sporkmonger/addressable](https://github.com/sporkmonger/addressable):
 

data/Rakefile

@@ -4,8 +4,14 @@ require 'reek/rake/task'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'
 
-Reek::Rake::Task.new
+Reek::Rake::Task.new do |task|
+  task.fail_on_error = false
+end
+
 RSpec::Core::RakeTask.new
-RuboCop::RakeTask.new
+
+RuboCop::RakeTask.new do |task|
+  task.fail_on_error = false
+end
 
 task default: [:rubocop, :reek, :spec]

data/lib/webmention/verification.rb

@@ -1,12 +1,14 @@
+require 'json'
+
 require 'addressable/uri'
 require 'http'
-require 'json'
 require 'nokogiri'
 
 require 'webmention/verification/version'
 require 'webmention/verification/exceptions'
 
 require 'webmention/verification/client'
+require 'webmention/verification/http_request'
 require 'webmention/verification/registerable'
 
 require 'webmention/verification/verifiers'
@@ -16,8 +18,14 @@ require 'webmention/verification/verifiers/plaintext_verifier'
 
 module Webmention
   module Verification
-    def self.verified?(source, target)
-      Client.new(source, target).verified?
+    class << self
+      def client(*args)
+        Client.new(*args)
+      end
+
+      def verified?(*args)
+        client(*args).verified?
+      end
     end
   end
 end

data/lib/webmention/verification/client.rb

@@ -1,11 +1,6 @@
 module Webmention
   module Verification
     class Client
-      HTTP_HEADERS_OPTS = {
-        accept:     '*/*',
-        user_agent: 'Webmention Verification Client (https://rubygems.org/gems/webmention-verification)'
-      }.freeze
-
       attr_reader :source, :target
 
       def initialize(source, target, **options)
@@ -21,11 +16,7 @@ module Webmention
       end
 
       def response
-        @response ||= HTTP.follow.headers(HTTP_HEADERS_OPTS).timeout(connect: 10, read: 10).get(source_uri)
-      rescue HTTP::ConnectionError,
-             HTTP::TimeoutError,
-             HTTP::Redirector::TooManyRedirectsError => exception
-        raise Webmention::Verification.const_get(exception.class.name.split('::').last), exception
+        @response ||= HttpRequest.get(source_uri)
       end
 
       def source_uri

data/lib/webmention/verification/exceptions.rb

@@ -1,17 +1,17 @@
 module Webmention
   module Verification
-    class Error < StandardError; end
+    class WebmentionVerificationError < StandardError; end
 
-    class ArgumentError < Error; end
+    class ArgumentError < WebmentionVerificationError; end
 
-    class ConnectionError < Error; end
+    class ConnectionError < WebmentionVerificationError; end
 
-    class InvalidURIError < Error; end
+    class InvalidURIError < WebmentionVerificationError; end
 
-    class TimeoutError < Error; end
+    class TimeoutError < WebmentionVerificationError; end
 
-    class TooManyRedirectsError < Error; end
+    class TooManyRedirectsError < WebmentionVerificationError; end
 
-    class UnsupportedMimeTypeError < Error; end
+    class UnsupportedMimeTypeError < WebmentionVerificationError; end
   end
 end

data/lib/webmention/verification/http_request.rb

@@ -0,0 +1,18 @@
+module Webmention
+  module Verification
+    class HttpRequest
+      HTTP_HEADERS_OPTS = {
+        accept:     '*/*',
+        user_agent: 'Webmention Verification Client (https://rubygems.org/gems/webmention-verification)'
+      }.freeze
+
+      def self.get(uri)
+        HTTP.follow.headers(HTTP_HEADERS_OPTS).timeout(connect: 10, read: 10).get(uri)
+      rescue HTTP::ConnectionError,
+             HTTP::TimeoutError,
+             HTTP::Redirector::TooManyRedirectsError => exception
+        raise Webmention::Verification.const_get(exception.class.name.split('::').last), exception
+      end
+    end
+  end
+end

data/lib/webmention/verification/version.rb

@@ -1,5 +1,5 @@
 module Webmention
   module Verification
-    VERSION = '1.0.0'.freeze
+    VERSION = '1.1.0'.freeze
   end
 end

data/webmention-verification.gemspec

@@ -3,6 +3,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'webmention/verification/version'
 
+# rubocop:disable Metrics/BlockLength
 Gem::Specification.new do |spec|
   spec.required_ruby_version = ['>= 2.4', '< 2.7']
 
@@ -20,10 +21,15 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ['lib']
 
+  spec.metadata = {
+    'bug_tracker_uri' => "#{spec.homepage}/issues",
+    'changelog_uri'   => "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
+  }
+
   spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'reek', '~> 5.4'
   spec.add_development_dependency 'rspec', '~> 3.8'
-  spec.add_development_dependency 'rubocop', '~> 0.67.2'
+  spec.add_development_dependency 'rubocop', '~> 0.68.1'
   spec.add_development_dependency 'rubocop-performance', '~> 1.1'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.32'
   spec.add_development_dependency 'simplecov', '~> 0.16.1'
@@ -34,3 +40,4 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'http', '~> 5.0.0.pre'
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
 end
+# rubocop:enable Metrics/BlockLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webmention-verification
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-26 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: 0.68.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.67.2
+        version: 0.68.1
 - !ruby/object:Gem::Dependency
   name: rubocop-performance
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +203,7 @@ files:
 - lib/webmention/verification.rb
 - lib/webmention/verification/client.rb
 - lib/webmention/verification/exceptions.rb
+- lib/webmention/verification/http_request.rb
 - lib/webmention/verification/registerable.rb
 - lib/webmention/verification/verifiers.rb
 - lib/webmention/verification/verifiers/html_verifier.rb
@@ -213,7 +214,9 @@ files:
 homepage: https://github.com/jgarber623/webmention-verification-ruby
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/jgarber623/webmention-verification-ruby/issues
+  changelog_uri: https://github.com/jgarber623/webmention-verification-ruby/blob/v1.1.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths: