url_canonicalize 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 510cbc3c33819c97d28ca20d712d18c2ea25ccf29846b5f6f5c35e3e92b67513
-  data.tar.gz: f9ec2c8be1e3d23d2a0011de38452577b0d4978924b77f409229204df6cea2c0
+  metadata.gz: 9cc361f6fdfb5137149371de473d9188bb56a69b93b1cc1f234a1dc9d9cefd79
+  data.tar.gz: d3074abf07ec9ff566a71b15d261fa2333ad19448788276a81f406942649da68
 SHA512:
-  metadata.gz: f12b8967b5399aea9cd88642d14c1ed570e158ee62beb6642dd8e3534c42435064659a6ed49aea6f6f0adc3dab38455d83f71919fd1e5407239798579986adf5
-  data.tar.gz: d850c233c28d0d5cef5a7abe670278a69f35c9c4d7fee12886ae77b51030d3bb73fdb00e1b19a2a72558d3dffddcc736c7f374de987f6763e1fda24f875c1124
+  metadata.gz: df734b09b21540b1146a105545f6d840c29dca4cb699f290785329b752ea31bee55c014f8defcef725c93254c20586921f1822581242695a278361c90540aa91
+  data.tar.gz: 4f07815fa2f1c140cc272999229e5f1b3c03c2639d0a9050d6f47bb1cfb6821ac73f5bf38bf14b2b497b2e9c8a227126c9e9fb68e9d642e672f4ce04fea5f158

data/.gitignore

@@ -1,4 +1,3 @@
-Gemfile.lock
 *.local
 *.gem
 *.rbc

data/.rubocop.yml

@@ -2,11 +2,8 @@
 AllCops:
   DisplayStyleGuide: true
   DisplayCopNames: true
-  TargetRubyVersion: 2.2
-  Exclude:
-    - '*.gemspec'
-    - spec/**/*
-
+  TargetRubyVersion: 2.6
+  NewCops: enable
 
 Layout/DotPosition:
   Description: 'Checks the position of the dot in multi-line method calls.'
@@ -17,10 +14,19 @@ Layout/ExtraSpacing:
   Description: 'Do not use unnecessary spacing.'
   Enabled: true
 
+Layout/LineLength:
+  Max: 120
+  Exclude:
+    - spec/**/*
+
 Lint/LiteralInInterpolation:
   Description: 'Avoid interpolating literals in strings'
   AutoCorrect: true
 
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+
 Metrics/ClassLength:
   CountComments: false  # count full line comments?
   Max: 200
@@ -28,11 +34,6 @@ Metrics/ClassLength:
 Metrics/MethodLength:
   Max: 12
 
-Metrics/LineLength:
-  Max: 120
-  Exclude:
-    - spec/**/*
-
 Naming/FileName:
   Description: 'Use snake_case for source file names.'
   Enabled: true

data/.travis.yml

@@ -1,10 +1,9 @@
 ---
 language: ruby
 rvm:
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
   - 2.6
+  - 2.7
+  - 3.0
+  - 3.1
 script:
   - rspec

data/CHANGELOG.md

@@ -1,21 +1,39 @@
-# Change Log
+# Changelog
+
+## [Unreleased](https://github.com/dominicsayers/url_canonicalize/tree/HEAD)
+
+[Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.15...HEAD)
+
+**Implemented enhancements:**
+
+- Feature: return a Nokogiri XML document if requested [\#5](https://github.com/dominicsayers/url_canonicalize/issues/5)
+
+**Merged pull requests:**
+
+- Version 0.2 [\#6](https://github.com/dominicsayers/url_canonicalize/pull/6) ([dominicsayers](https://github.com/dominicsayers))
 
 ## [v0.1.15](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.15) (2017-03-14)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.14...v0.1.15)
 
 ## [v0.1.14](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.14) (2017-03-13)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.13...v0.1.14)
 
 ## [v0.1.13](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.13) (2017-03-13)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.12...v0.1.13)
 
 ## [v0.1.12](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.12) (2017-03-13)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.11...v0.1.12)
 
 ## [v0.1.11](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.11) (2017-03-13)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.10...v0.1.11)
 
 ## [v0.1.10](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.10) (2017-03-13)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.9...v0.1.10)
 
 **Closed issues:**
@@ -23,9 +41,11 @@
 - URLCanonicalize doesn't accept host names [\#4](https://github.com/dominicsayers/url_canonicalize/issues/4)
 
 ## [v0.1.9](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.9) (2017-03-06)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.8...v0.1.9)
 
 ## [v0.1.8](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.8) (2017-03-06)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.7...v0.1.8)
 
 **Closed issues:**
@@ -33,6 +53,7 @@
 - Use a later version of Ruby on CircleCI [\#3](https://github.com/dominicsayers/url_canonicalize/issues/3)
 
 ## [v0.1.7](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.7) (2017-03-06)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.6...v0.1.7)
 
 **Closed issues:**
@@ -40,42 +61,57 @@
 - Insecure version of Nokogiri [\#2](https://github.com/dominicsayers/url_canonicalize/issues/2)
 
 ## [v0.1.6](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.6) (2017-03-06)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.5...v0.1.6)
 
 ## [v0.1.5](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.5) (2016-10-26)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.4...v0.1.5)
 
 ## [v0.1.4](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.4) (2016-10-26)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.2...v0.1.4)
 
 ## [v0.1.2](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.2) (2016-10-26)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.1...v0.1.2)
 
 ## [v0.1.1](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.1) (2016-10-26)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.1.0...v0.1.1)
 
 ## [v0.1.0](https://github.com/dominicsayers/url_canonicalize/tree/v0.1.0) (2016-10-20)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.0.7...v0.1.0)
 
 ## [v0.0.7](https://github.com/dominicsayers/url_canonicalize/tree/v0.0.7) (2016-10-20)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.0.6...v0.0.7)
 
 ## [v0.0.6](https://github.com/dominicsayers/url_canonicalize/tree/v0.0.6) (2016-10-20)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.0.5...v0.0.6)
 
 ## [v0.0.5](https://github.com/dominicsayers/url_canonicalize/tree/v0.0.5) (2016-10-20)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.0.4...v0.0.5)
 
 ## [v0.0.4](https://github.com/dominicsayers/url_canonicalize/tree/v0.0.4) (2016-10-20)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.0.3...v0.0.4)
 
 ## [v0.0.3](https://github.com/dominicsayers/url_canonicalize/tree/v0.0.3) (2016-10-20)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.0.2...v0.0.3)
 
 ## [v0.0.2](https://github.com/dominicsayers/url_canonicalize/tree/v0.0.2) (2016-10-20)
+
 [Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/v0.0.1...v0.0.2)
 
 ## [v0.0.1](https://github.com/dominicsayers/url_canonicalize/tree/v0.0.1) (2016-10-20)
 
+[Full Changelog](https://github.com/dominicsayers/url_canonicalize/compare/fec855bec42813304f93c8ef87035f184b054344...v0.0.1)
+
+
 
-\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*
+\* *This Changelog was automatically generated by [github_changelog_generator](https://github.com/github-changelog-generator/github-changelog-generator)*

data/Gemfile

@@ -4,6 +4,11 @@ source 'https://rubygems.org'
 
 gemspec
 
+group :static_code_analysis do
+  gem 'rubocop', require: false
+  gem 'rubocop-rspec', require: false
+end
+
 group :test do
   gem 'coveralls', require: false
   gem 'rspec'
@@ -12,8 +17,6 @@ group :test do
   gem 'webmock'
 end
 
-local_gemfile = 'Gemfile.local'
-
-if File.exist?(local_gemfile)
-  eval(File.read(local_gemfile)) # rubocop:disable Security/Eval
+group :build do
+  gem 'gem-release', require: false
 end

data/Gemfile.lock

@@ -0,0 +1,102 @@
+PATH
+  remote: .
+  specs:
+    url_canonicalize (0.2.1)
+      addressable (~> 2)
+      nokogiri (>= 1.13)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
+    coveralls (0.7.2)
+      multi_json (~> 1.3)
+      rest-client (= 1.6.7)
+      simplecov (>= 0.7)
+      term-ansicolor (= 1.2.2)
+      thor (= 0.18.1)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    gem-release (2.2.2)
+    hashdiff (1.0.1)
+    mime-types (3.4.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2022.0105)
+    multi_json (1.15.0)
+    nokogiri (1.13.1-x86_64-linux)
+      racc (~> 1.4)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    public_suffix (4.0.6)
+    racc (1.6.0)
+    rainbow (3.1.1)
+    regexp_parser (2.2.0)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.2)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.3)
+    rspec_junit_formatter (0.5.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
+    rubocop (1.25.0)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-rspec (2.8.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    simplecov (0.21.2)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thor (0.18.1)
+    tins (0.13.2)
+    unicode-display_width (2.1.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  coveralls
+  gem-release
+  rspec
+  rspec_junit_formatter
+  rubocop
+  rubocop-rspec
+  simplecov (~> 0.13)
+  url_canonicalize!
+  webmock
+
+BUNDLED WITH
+   2.3.6

data/README.md

@@ -3,7 +3,6 @@
 [![Gem downloads](https://img.shields.io/gem/dt/url_canonicalize.svg)](https://rubygems.org/gems/url_canonicalize)
 [![Build status](https://img.shields.io/circleci/project/dominicsayers/url_canonicalize/master.svg)](https://circleci.com/gh/dominicsayers/url_canonicalize)
 [![Maintainability](https://api.codeclimate.com/v1/badges/1f92f784d12741a942ec/maintainability)](https://codeclimate.com/github/dominicsayers/url_canonicalize/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/1f92f784d12741a942ec/test_coverage)](https://codeclimate.com/github/dominicsayers/url_canonicalize/test_coverage)
 [![Coverage Status](https://coveralls.io/repos/github/dominicsayers/url_canonicalize/badge.svg?branch=master)](https://coveralls.io/github/dominicsayers/url_canonicalize?branch=master)
 [![Dependency Status](https://dependencyci.com/github/dominicsayers/url_canonicalize/badge)](https://dependencyci.com/github/dominicsayers/url_canonicalize)
 [![Security](https://hakiri.io/github/dominicsayers/url_canonicalize/master.svg)](https://hakiri.io/github/dominicsayers/url_canonicalize/master)

data/circle.yml

@@ -1,16 +1,29 @@
-machine:
-  ruby:
-    version: 2.4.0
-dependencies:
-  pre:
-    - echo "export rvm_ignore_gemsets_flag=1" >> ~/.rvmrc
-    - gem install bundler
-  override:
-    - bundle check --path=vendor/bundle || bundle install --path=vendor/bundle --jobs=4 --retry=3 --full-index
-test:
-  override:
-    - bundle exec rspec:
-        timeout: 600
-        parallel: true
-        files:
-        - spec/**/*_spec.rb
+version: 2.1
+orbs:
+  ruby: circleci/ruby@1.1
+jobs:
+  check_and_test:
+    parameters:
+      ruby-version:
+        type: string
+    docker:
+      - image: cimg/ruby:<< parameters.ruby-version >>
+    parallelism: 3
+    steps:
+      - checkout
+      - ruby/install-deps
+      - run:
+          name: Run static code analysis
+          command: bundle exec rubocop
+      - run:
+          name: Run tests
+          command: bundle exec rspec
+workflows:
+  version: 2
+  test:
+    jobs:
+      - check_and_test:
+          # cribbed from http://mikebian.co/running-tests-against-multiple-ruby-versions-using-circleci/
+          matrix:
+            parameters:
+              ruby-version: ["2.6", "2.7", "3.0", "3.1"]

data/lib/url_canonicalize/http.rb

@@ -72,6 +72,7 @@ module URLCanonicalize
     def redirect_loop_detected?
       if redirect_list.include?(response_url)
         return true if last_known_good
+
         raise URLCanonicalize::Exception::Redirect, 'Redirect loop detected'
       end
 
@@ -84,6 +85,7 @@ module URLCanonicalize
     def max_redirects_reached?
       return false unless @redirects > options[:max_redirects]
       return true if last_known_good
+
       raise URLCanonicalize::Exception::Redirect, "#{@redirects} redirects is too many"
     end
 
@@ -102,6 +104,7 @@ module URLCanonicalize
     def handle_canonical_found
       self.last_known_good = response.response
       return true if response_url == url || redirect_list.include?(response_url)
+
       set_url_from_response
       false
     end
@@ -112,6 +115,7 @@ module URLCanonicalize
 
     def handle_failure
       return true if last_known_good
+
       raise URLCanonicalize::Exception::Failure, "#{response.failure_class}: #{response.message}"
     end
 
@@ -149,14 +153,18 @@ module URLCanonicalize
       h.open_timeout = options[:open_timeout]
       h.read_timeout = options[:read_timeout]
 
+      ssl!(h)
+
+      h
+    end
+
+    def ssl!(http)
       if uri.scheme == 'https'
-        h.use_ssl = true # Can generate exception
-        h.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.use_ssl = true # Can generate exception
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
       else
-        h.use_ssl = false
+        http.use_ssl = false
       end
-
-      h
     end
 
     def options

data/lib/url_canonicalize/request.rb

@@ -38,7 +38,7 @@ module URLCanonicalize
     end
 
     # We can stub this method in testing then call #response any number of times
-    def do_http_request #:nodoc: internal use only
+    def do_http_request # :nodoc: internal use only
       http.do_request request # Some URLs can throw an exception here
     end
 
@@ -170,6 +170,7 @@ module URLCanonicalize
 
     def relative_to_absolute(partial_url)
       return unless partial_url
+
       partial_uri = ::URI.parse(partial_url)
 
       if partial_uri.host
@@ -183,9 +184,11 @@ module URLCanonicalize
 
     def log_response
       return unless ENV['DEBUG']
+
       puts "#{http_method.upcase} #{url} #{response.code} #{response.message}"
 
       return unless ENV['DEBUG'].casecmp('headers')
+
       response.each { |k, v| puts "  #{k}:\t#{v}" }
     end
 

data/lib/url_canonicalize/uri.rb

@@ -18,16 +18,18 @@ module URLCanonicalize
       def valid?(uri)
         raise URLCanonicalize::Exception::URI, "#{uri} must be http or https" unless VALID_CLASSES.include?(uri.class)
         raise URLCanonicalize::Exception::URI, "Missing host name in #{uri}" unless uri.host
+
         true
       end
 
       def decorate(url)
         return url if url.include? COLON
+
         "http://#{url}" # Add protocol if we just receive a host name
       end
 
       VALID_CLASSES = [::URI::HTTP, ::URI::HTTPS].freeze
-      COLON = ':'.freeze
+      COLON = ':'
     end
   end
 end

data/lib/url_canonicalize/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module URLCanonicalize
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.2.1'
 end

data/url_canonicalize.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'url_canonicalize/version'
 
@@ -15,14 +16,15 @@ Gem::Specification.new do |s|
   s.homepage      = 'https://github.com/dominicsayers/url_canonicalize'
   s.license       = 'MIT'
 
-  s.files = `git ls-files`.split($RS).reject do |file|
-    file =~ /^spec\//
-  end
+  s.required_ruby_version = '>= 2.6.0'
+
+  s.files = `git ls-files`.split($RS).grep_v(%r{^spec/})
 
   s.test_files = []
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_dependency 'addressable', '~> 2' # To normalize URLs
-  s.add_dependency 'nokogiri', '>= 1.8.2' # To look for <link rel="canonical" ...> in HTML
+  s.add_runtime_dependency 'addressable', '~> 2' # To normalize URLs
+  s.add_runtime_dependency 'nokogiri', '>= 1.13' # To look for <link rel="canonical" ...> in HTML
+  s.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: url_canonicalize
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Dominic Sayers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-06-30 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: '1.13'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: '1.13'
 description: 'Rubygem that finds the canonical version of a URL by providing #canonicalize
   methods for the String, URI::HTTP, URI::HTTPS and Addressable::URI classes'
 email:
@@ -55,7 +55,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
-- Gemfile.local.example
+- Gemfile.lock
 - Guardfile
 - LICENSE
 - README.md
@@ -75,8 +75,9 @@ files:
 homepage: https://github.com/dominicsayers/url_canonicalize
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -84,16 +85,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.3.6
+signing_key:
 specification_version: 4
 summary: Finds the canonical version of a URL
 test_files: []

data/Gemfile.local.example

@@ -1,12 +0,0 @@
-# Copy this file to a file named Gemfile.local to add these gems to your dev toolset
-# Feel free to modify Gemfile.local to suit your own preferences
-group :development do
-  gem 'github_changelog_generator'
-  gem 'gem-release'
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'guard-rubocop'
-  gem 'listen', '~> 3.0', '< 3.1' # Dependency of guard, 3.1 requires Ruby 2.2+
-  gem 'rake'
-  gem 'rubocop'
-end