webmention-verification 2.0.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '09e77592a6a96292e3b0b0ab4453112c681b96cf44512a419ddf5a70dc426637'
-  data.tar.gz: d7db1a6e009564e05f64d50ce824a5f95ed89fb80b48ad3b93c71d04aa7648dd
+  metadata.gz: 68a408b3f4b87517a6e11e188bc99c63d6eebbb40578a590a199550fe7014b87
+  data.tar.gz: 73abb9d6dda65e8d7dbda04a984fd9374db2334b9d45a653453553c7f121f978
 SHA512:
-  metadata.gz: e976b1ce78d916a84009b17809b3e5590041f3148a1b20d24334186f0a04a2366327d3340f3cf240d9d40dfc47e069ec9e08346b6083297dc6bc29a84a6a0bd9
-  data.tar.gz: be97ac43a36458b96ab290f4a9954dc9b1989511c1cc89fc829eb27e7ca7e8001ba8cfa65d758fa05f554aa85941f0b2527d353ab50cd880a11583b4dad9b537
+  metadata.gz: 43a6a1b80371c4cc2cdf9430e335733694f3e9ad9e93f1856a19048988b55c77b175786ad7a43c26fb5c497d367dd561fbf5d1f73ab696b065b1711258ff40c4
+  data.tar.gz: 4fe2a26b715e7cf50692e77a1c8319af395bcacbbeaddf26476c05badb8b135f6356972f38c07752c4f46b834b30fb8e0f57585855d4f2b15803e527f9981479

data/.reek.yml

@@ -3,9 +3,6 @@ detectors:
     max_calls: 3
   IrresponsibleModule:
     enabled: false
-  UtilityFunction:
-    exclude:
-      - FixtureHelpers#read_fixture
 
 exclude_paths:
   - vendor/

data/.rubocop.yml

@@ -2,16 +2,17 @@ require:
   - rubocop-performance
   - rubocop-rspec
 
+AllCops:
+  NewCops: enable
+
 Layout/HashAlignment:
   EnforcedColonStyle: table
-  EnforcedHashRocketStyle: table
 
 Layout/LineLength:
   Enabled: false
 
 Metrics/BlockLength:
   Exclude:
-    - webmention-verification.gemspec
     - spec/**/*.rb
 
 Naming/RescuedExceptionsVariableName:

data/.ruby-version

@@ -1 +1 @@
-2.4.9
+2.4.10

data/.simplecov

@@ -2,9 +2,11 @@ require 'simplecov-console'
 
 formatters = [SimpleCov::Formatter::HTMLFormatter]
 
+# rubocop:disable Style/IfUnlessModifier
 if RSpec.configuration.files_to_run.length > 1
   formatters << SimpleCov::Formatter::Console
 end
+# rubocop:enable Style/IfUnlessModifier
 
 SimpleCov.start do
   formatter SimpleCov::Formatter::MultiFormatter.new(formatters)

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## 3.0.0 / unreleased
+
+- **Breaking Change:** Remove `Webmention::Verification.client` convenience method (af575d7)
+- **Breaking Change:** Remove `HttpRequest` class (112f9d3)
+- Move development dependencies to `Gemfile` (81cdfdf)
+- Update development Ruby version to 2.4.10 (a13bca0)
+
 ## 2.0.0 / 2020-01-25
 
 - Downgrade [HTTP](https://github.com/httprb/http) gem constraint to ~> 4.3 (090f590)

data/CONTRIBUTING.md

@@ -8,9 +8,9 @@ There are a couple ways you can help improve webmention-verification-ruby:
 
 ## Getting Started
 
-webmention-verification-ruby is developed using Ruby 2.4.9 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.com/jgarber623/webmention-verification-ruby).
+webmention-verification-ruby is developed using Ruby 2.4.10 and is additionally tested against Ruby 2.5, 2.6, and 2.7 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.9. 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.9 using your method of choice, install the project's gems by running:
+Before making changes to webmention-verification-ruby, you'll want to install Ruby 2.4.10. 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.10 using your method of choice, install the project's gems by running:
 
 ```sh
 bundle install

data/Gemfile

@@ -2,3 +2,14 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in webmention-verification.gemspec
 gemspec
+
+gem 'pry-byebug', '~> 3.9'
+gem 'rake', '~> 13.0'
+gem 'reek', '~> 6.0'
+gem 'rspec', '~> 3.9'
+gem 'rubocop', '~> 0.83.0'
+gem 'rubocop-performance', '~> 1.5'
+gem 'rubocop-rspec', '~> 1.39'
+gem 'simplecov', '~> 0.18.5'
+gem 'simplecov-console', '~> 0.7.2'
+gem 'webmock', '~> 3.8'

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.9 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.com/jgarber623/webmention-verification-ruby).
+webmention-verification-ruby is developed using Ruby 2.4.10 and is additionally tested against Ruby 2.5, 2.6, and 2.7 using [Travis CI](https://travis-ci.com/jgarber623/webmention-verification-ruby).
 
 ## Installation
 
@@ -65,7 +65,7 @@ require 'webmention/verification'
 source = 'https://source.example.com/post/100'
 target = 'https://target.example.com/post/100'
 
-client = Webmention::Verification.client(source, target)
+client = Webmention::Verification::Client.new(source, target)
 
 puts client.source     # => 'https://source.example.com/post/100'
 puts client.target     # => 'https://target.example.com/post/100'
@@ -88,7 +88,7 @@ require 'webmention/verification'
 source = 'https://source.example.com/post/100'
 target = 'https://target.example.com/post/100'
 
-client = Webmention::Verification.client(source, target, strict: false)
+client = Webmention::Verification::Client.new(source, target, strict: false)
 
 puts client.verified?  # => Boolean true or false
 ```

data/lib/webmention/verification.rb

@@ -8,24 +8,30 @@ 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'
+require 'webmention/verification/verifiers/base_verifier'
 require 'webmention/verification/verifiers/html_verifier'
 require 'webmention/verification/verifiers/json_verifier'
 require 'webmention/verification/verifiers/plaintext_verifier'
 
 module Webmention
   module Verification
-    class << self
-      def client(*args)
-        Client.new(*args)
-      end
-
-      def verified?(*args)
-        client(*args).verified?
-      end
+    # Determine whether or not source URI links to target URI.
+    #
+    # @example
+    #   source = 'https://source.example.com/post/100'
+    #   target = 'https://target.example.com/post/100'
+    #
+    #   puts Webmention::Verification.verified?(source, target)
+    #   #=> TrueClass or FalseClass
+    #
+    # @param source [String]
+    # @param target [String]
+    # @param options [Hash]
+    # @option options [Boolean] :strict (true)
+    # @return [Boolean]
+    def self.verified?(source, target, **options)
+      Client.new(source, target, **options).verified?
     end
   end
 end

data/lib/webmention/verification/client.rb

@@ -1,8 +1,28 @@
 module Webmention
   module Verification
     class Client
+      HTTP_CLIENT_HEADERS = {
+        accept:     '*/*',
+        user_agent: 'Webmention Verification Client (https://rubygems.org/gems/webmention-verification)'
+      }.freeze
+
       attr_reader :source, :target
 
+      # Create a client used to determine whether or not source URI links to target URI.
+      #
+      # @example
+      #   source = 'https://source.example.com/post/100'
+      #   target = 'https://target.example.com/post/100'
+      #
+      #   client = Webmention::Verification::Client.new(source, target)
+      #
+      #   puts client.verified?
+      #   #=> TrueClass or FalseClass
+      #
+      # @param source [String]
+      # @param target [String]
+      # @param options [Hash]
+      # @option options [Boolean] :strict (true)
       def initialize(source, target, **options)
         raise ArgumentError, "source must be a String (given #{source.class.name})" unless source.is_a?(String)
         raise ArgumentError, "target must be a String (given #{target.class.name})" unless target.is_a?(String)
@@ -15,22 +35,34 @@ module Webmention
         raise ArgumentError, 'target must be an absolute URI (e.g. https://example.com/post/100)' unless target_uri.absolute?
       end
 
+      # @return [HTTP::Response]
+      # @raise [Webmention::Verification::ConnectionError, Webmention::Verification::TimeoutError, Webmention::Verification::TooManyRedirectsError]
       def response
-        @response ||= HttpRequest.get(source_uri)
+        @response ||= HTTP.follow.headers(HTTP_CLIENT_HEADERS).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
       end
 
+      # @return [Addressable::URI]
+      # @raise [Webmention::Verification::InvalidURIError]
       def source_uri
         @source_uri ||= Addressable::URI.parse(source)
       rescue Addressable::URI::InvalidURIError => exception
         raise InvalidURIError, exception
       end
 
+      # @return [Addressable::URI]
+      # @raise [Webmention::Verification::InvalidURIError]
       def target_uri
         @target_uri ||= Addressable::URI.parse(target)
       rescue Addressable::URI::InvalidURIError => exception
         raise InvalidURIError, exception
       end
 
+      # @return [Boolean]
+      # @raise [Webmention::Verification::UnsupportedMimeTypeError]
       def verified?
         raise UnsupportedMimeTypeError, "Unsupported MIME Type: #{response.mime_type}" unless verifier_for_mime_type
 

data/lib/webmention/verification/verifiers.rb

@@ -1,43 +1,12 @@
 module Webmention
   module Verification
     module Verifiers
-      extend Registerable
-
-      class BaseVerifier
-        def initialize(response, target, **options)
-          raise ArgumentError, "response must be an HTTP::Response (given #{response.class.name})" unless response.is_a?(HTTP::Response)
-          raise ArgumentError, "target must be a String (given #{target.class.name})" unless target.is_a?(String)
-
-          @response = response
-          @target = target
-          @options = options
-
-          raise UnsupportedMimeTypeError, "Unsupported MIME Type: #{response.mime_type}" unless self.class.mime_types.include?(response.mime_type)
-        end
-
-        def results
-          @results ||= parse_response_body
-        end
-
-        def verified?
-          results.any?
-        end
-
-        private
-
-        def response_body
-          @response_body ||= @response.body.to_s
-        end
-
-        def target_regexp
-          @target_regexp ||= /^#{target_regexp_str}$/
-        end
-
-        def target_regexp_str
-          return @target if @options.fetch(:strict, true)
+      def self.register(klass)
+        klass.mime_types.each { |mime_type| registered[mime_type] = klass }
+      end
 
-          @target.sub(%r{https?://}, 'https?://')
-        end
+      def self.registered
+        @registered ||= {}
       end
     end
   end

data/lib/webmention/verification/verifiers/base_verifier.rb

@@ -0,0 +1,44 @@
+module Webmention
+  module Verification
+    class BaseVerifier
+      class << self
+        attr_reader :mime_types
+      end
+
+      def initialize(response, target, **options)
+        raise ArgumentError, "response must be an HTTP::Response (given #{response.class.name})" unless response.is_a?(HTTP::Response)
+        raise ArgumentError, "target must be a String (given #{target.class.name})" unless target.is_a?(String)
+
+        @response = response
+        @target = target
+        @options = options
+
+        raise UnsupportedMimeTypeError, "Unsupported MIME Type: #{response.mime_type}" unless self.class.mime_types.include?(response.mime_type)
+      end
+
+      def results
+        @results ||= parse_response_body
+      end
+
+      def verified?
+        results.any?
+      end
+
+      private
+
+      def response_body
+        @response_body ||= @response.body.to_s
+      end
+
+      def target_regexp
+        @target_regexp ||= /^#{target_regexp_str}$/
+      end
+
+      def target_regexp_str
+        return @target if @options.fetch(:strict, true)
+
+        @target.sub(%r{https?://}, 'https?://')
+      end
+    end
+  end
+end

data/lib/webmention/verification/verifiers/html_verifier.rb

@@ -2,9 +2,7 @@ module Webmention
   module Verification
     module Verifiers
       class HtmlVerifier < BaseVerifier
-        def self.mime_types
-          ['text/html']
-        end
+        @mime_types = ['text/html']
 
         Verifiers.register(self)
 

data/lib/webmention/verification/verifiers/json_verifier.rb

@@ -2,9 +2,7 @@ module Webmention
   module Verification
     module Verifiers
       class JsonVerifier < BaseVerifier
-        def self.mime_types
-          ['application/json']
-        end
+        @mime_types = ['application/json']
 
         Verifiers.register(self)
 

data/lib/webmention/verification/verifiers/plaintext_verifier.rb

@@ -2,9 +2,7 @@ module Webmention
   module Verification
     module Verifiers
       class PlaintextVerifier < BaseVerifier
-        def self.mime_types
-          ['text/plain']
-        end
+        @mime_types = ['text/plain']
 
         Verifiers.register(self)
 

data/lib/webmention/verification/version.rb

@@ -1,5 +1,5 @@
 module Webmention
   module Verification
-    VERSION = '2.0.0'.freeze
+    VERSION = '3.0.0'.freeze
   end
 end

data/webmention-verification.gemspec

@@ -1,10 +1,7 @@
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'webmention/verification/version'
+require_relative 'lib/webmention/verification/version'
 
 Gem::Specification.new do |spec|
-  spec.required_ruby_version = ['>= 2.4', '< 2.8']
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.4', '< 2.8')
 
   spec.name          = 'webmention-verification'
   spec.version       = Webmention::Verification::VERSION
@@ -16,26 +13,16 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/jgarber623/webmention-verification-ruby'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec)/}) }
+  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|spec)/}) }
+  end
 
   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', '~> 13.0'
-  spec.add_development_dependency 'reek', '~> 5.6'
-  spec.add_development_dependency 'rspec', '~> 3.9'
-  spec.add_development_dependency 'rubocop', '~> 0.79.0'
-  spec.add_development_dependency 'rubocop-performance', '~> 1.5'
-  spec.add_development_dependency 'rubocop-rspec', '~> 1.37'
-  spec.add_development_dependency 'simplecov', '~> 0.17.1'
-  spec.add_development_dependency 'simplecov-console', '~> 0.6.0'
-  spec.add_development_dependency 'webmock', '~> 3.8'
+  spec.metadata['bug_tracker_uri'] = "#{spec.homepage}/issues"
+  spec.metadata['changelog_uri']   = "#{spec.homepage}/blob/v#{spec.version}/CHANGELOG.md"
 
   spec.add_runtime_dependency 'addressable', '~> 2.7'
-  spec.add_runtime_dependency 'http', '~> 4.3'
+  spec.add_runtime_dependency 'http', '~> 4.4'
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
 end

metadata

@@ -1,141 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: webmention-verification
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Jason Garber
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-01-25 00:00:00.000000000 Z
+date: 2020-05-14 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: reek
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.6'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.79.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.79.0
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.5'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.37'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.17.1
-- !ruby/object:Gem::Dependency
-  name: simplecov-console
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.6.0
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -156,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.3'
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -203,9 +77,8 @@ 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/base_verifier.rb
 - lib/webmention/verification/verifiers/html_verifier.rb
 - lib/webmention/verification/verifiers/json_verifier.rb
 - lib/webmention/verification/verifiers/plaintext_verifier.rb
@@ -216,7 +89,7 @@ licenses:
 - MIT
 metadata:
   bug_tracker_uri: https://github.com/jgarber623/webmention-verification-ruby/issues
-  changelog_uri: https://github.com/jgarber623/webmention-verification-ruby/blob/v2.0.0/CHANGELOG.md
+  changelog_uri: https://github.com/jgarber623/webmention-verification-ruby/blob/v3.0.0/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -235,7 +108,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Verify a received webmention.

data/lib/webmention/verification/http_request.rb

@@ -1,18 +0,0 @@
-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/registerable.rb

@@ -1,13 +0,0 @@
-module Webmention
-  module Verification
-    module Registerable
-      def register(klass)
-        klass.mime_types.each { |mime_type| registered[mime_type] = klass }
-      end
-
-      def registered
-        @registered ||= {}
-      end
-    end
-  end
-end