mdqt 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46e40432be4833725b33540baa11fe2e1743510d95be216619948b8fd2d7b3f2
-  data.tar.gz: e8fa83e312ed1b8d3a309e017afd058b5bb3c586d9523b5a4ea29f62364942ec
+  metadata.gz: eddc289f85b0a56a6bc01ad77a3a59ae1473a493b50efe5d7e28e69d26e387a7
+  data.tar.gz: 7ad454f0ee1488e96e00a60b303494d2800a1fcec3fb4c64925eb0fae07c94f9
 SHA512:
-  metadata.gz: 6d8e4a2ca25ccbccbceedac4ed4f2f33010ed37acefb36d00818392640432478ed7244415c6885e763c0c6afba872f6d440c9b3fa179ddca58a2e518aeb50059
-  data.tar.gz: '0862c373965072f7a470e9d27559c30556a51b3e769aca8366cd63746923891f49ca978c6abbc73d9470e183abbdd0bda509cf53386288a6afc1f1946fe06849'
+  metadata.gz: a0c2f6828d47d9e6ec21964e523a5b7a9e8d5f1bd4a39174528a20a8a0af98f0d4b20a75b16af3891619603db94240ec177c87fe918ea6df9e9490aa960b002b
+  data.tar.gz: 816544153bdcbfc3c47f29640c7538cbe199ab6d7323288ec10aa358e7764e93695a17166d91768defafcb12e0577f403d0cae9149cfdc21d4f733f3b941a51d

data/.github/workflows/ruby.yml

@@ -7,11 +7,17 @@
 
 name: Ruby
 
+env:
+  LANG: "en_GB.UTF-8"
+
 on:
   push:
-    branches: [ master ]
+    branches: [ "master" ]
   pull_request:
-    branches: [ master ]
+    branches: [ "master" ]
+
+permissions:
+  contents: read
 
 jobs:
   test:
@@ -19,17 +25,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby-version: ['2.6', '2.7', '3.0']
+        ruby-version: ['3.0']
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v3
     - name: Set up Ruby
     # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
     # change this to (see https://github.com/ruby/setup-ruby#versioning):
     # uses: ruby/setup-ruby@v1
-      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      uses: ruby/setup-ruby@55283cc23133118229fd3f97f9336ee23a179fcf # v1.146.0
       with:
         ruby-version: ${{ matrix.ruby-version }}
         bundler-cache: true # runs 'bundle install' and caches installed gems automatically
     - name: Run tests
-      run: bundle exec rake
+      run: bundle exec rake features

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.8.0
+
+## Breaking Changes
+
+- MDQT now requires Ruby 3.0 or later, due to updated dependencies and their requirements
+- MDQT now installs XML handling gems automatically - Nokogiri and XMLDSig are no longer optional. Nokogiri seems to be
+  less troublesome to install now and is needed by some useful current and planned features. Please let me know if this
+  causes you any problems.
+
+## Improvements
+
+- New HTTP library means caching should be slightly faster and HTTP2 is now supported
+- MDQ base URLs should end with a slash, so slashless URLs are now normalised to include one.
+
+## Fixes
+
+- URLs for MDQ entity records now properly support paths - previously only MDQ services at the root path would work
+
 ## 0.7.0
 
 ### Improvements

data/Gemfile

@@ -6,5 +6,4 @@ gemspec
 gem 'simplecov', require: false, group: :test
 
 gem 'pry'
-gem 'nokogiri', '~> 1.12', '>= 1.12.5'
-gem 'xmldsig', '>= 0.6.6'
+gem 'rake'

data/README.md

@@ -33,7 +33,7 @@ The UK Access Management Federation has a
 ## Installation
 
 MDQT is tested on recent MacOS and Linux, and should work with
- Ruby 2.2.0 or later and recent JRuby releases.
+ Ruby 3.0.0 or later and recent JRuby releases.
 
 ### As a gem for general use
 
@@ -62,7 +62,7 @@ and then execute:
 (Experimental)
 See the instructions at [MDQT-Container](https://github.com/Digital-Identity-Labs/mdqt-container)
 
-### Extra steps for verifying signed metadata
+### Verifying signed metadata, installing Nokogiri
 
 MDQT can check that metadata has not been tampered with by verifying its
 signature. Some MDQ services use unencrypted HTTP connections and rely
@@ -71,17 +71,9 @@ signature. Some MDQ services use unencrypted HTTP connections and rely
 MDQT supports signature verification but requires a Ruby library called
 Nokogiri to do the hard work. Nokogiri is fast and useful but can sometimes
 be awkward to install for non-developers (it can sometimes require a C development
-environment and various XML libraries). To make it easier to install a basic MDQT we've made
-XML signature verification an optional feature.
-
-To enable signature verification you must also install the `xmdsig` gem:
-
-    $ sudo gem install xmldsig
-
-The `xmldsig` gem will install Nokogiri, and Nokogiri will try to build itself.
-If you encounter any problems installing Nokogiri the
-[Installing Nokogiri](http://www.nokogiri.org/tutorials/installing_nokogiri.html)
-documentation is very helpful.
+environment and various XML libraries). In most cases Nokogiri will install 
+automatically, without problems, when you install MDQT, but if you encounter any 
+problems installing Nokogiri the [Installing Nokogiri](http://www.nokogiri.org/tutorials/installing_nokogiri.html) documentation is very helpful.
 
 ## Commandline Usage as an MDQ client
 
@@ -255,8 +247,10 @@ by Tom Scavo of Internet2. Some of the scripts provide similar functionality to
 
 ## Library Usage
 
-Please don't! This gem is early in development and the API is not stable. Later
-releases of this gem will provide a simple library to use in other Ruby applications.
+Please don't! We originally had plans to include a usable generic library was part of MDQT but unless there's new demand
+for it that's now unlikely to happen. However, we do now have a set of libraries for the Elixir language, based around
+[Smee](https://github.com/Digital-Identity-Labs/smee) - not very helpful for Ruby projects but possibly of use for new
+projects.
 
 ## Development
 

data/lib/mdqt/cli/base.rb

@@ -85,7 +85,7 @@ module MDQT
         choice = options.service.to_s.strip
 
         if choice.downcase.start_with? "http"
-          choice
+          normalize_base_url(choice)
         else
           Defaults.lookup_service_alias(choice)
         end
@@ -172,6 +172,15 @@ module MDQT
 
       private
 
+      ## Base URLs should end with a "/", it might be easier to just add one rather than raise an error
+      def self.normalize_base_url(url)
+        if url.end_with?('/')
+          url
+        else
+          "#{url}/"
+        end
+      end
+
     end
 
   end

data/lib/mdqt/cli/defaults.rb

@@ -57,7 +57,7 @@ module MDQT
             },
             { alias: "dfn",
               locale: "de_utf8",
-              url: "https://mdq.aai.dfn.de"
+              url: "https://mdq.aai.dfn.de/"
             },
           ]
         end

data/lib/mdqt/cli/url.rb

@@ -27,7 +27,7 @@ module MDQT
 
       def build_url(mds, entity_id)
 
-        URI.join(service_url(options), "/entities/#{mds.prepare_id(entity_id)}")
+        URI.join(service_url(options), "entities/#{mds.prepare_id(entity_id)}")
       end
 
     end

data/lib/mdqt/client/metadata_service.rb

@@ -3,22 +3,26 @@ module MDQT
 
     class MetadataService
 
-      require 'faraday'
-      require 'typhoeus'
-      require 'typhoeus/adapters/faraday'
       require 'cgi'
 
-      require 'faraday_middleware'
+      require 'faraday'
       require 'faraday-http-cache'
+      require 'faraday/follow_redirects'
 
+      require 'active_support'
+      require 'active_support/core_ext'
       require 'active_support/cache'
       require 'active_support/cache/file_store'
       require 'active_support/cache/mem_cache_store'
       require 'active_support/logger'
       require 'active_support/notifications'
+      require "httpx/adapters/faraday"
 
       require_relative './metadata_response'
 
+      #Rails.application.config.active_support.cache_format_version = 7.0
+      ActiveSupport::Deprecation.behavior = :silence
+
       def initialize(base_url, options = {})
         @base_url = base_url
         @cache_type = options[:cache_type] ? options[:cache_type].to_sym : :none
@@ -142,8 +146,7 @@ module MDQT
       def connection
         Faraday.new(:url => base_url) do |faraday|
           faraday.request :url_encoded
-          faraday.use FaradayMiddleware::Gzip
-          faraday.use FaradayMiddleware::FollowRedirects
+          faraday.response :follow_redirects
           if cache?
             faraday.use :http_cache,
                         store: cache_store,
@@ -156,7 +159,7 @@ module MDQT
           faraday.headers['Accept-Charset'] = 'utf-8'
           faraday.headers['User-Agent'] = "MDQT v#{MDQT::VERSION}"
           #faraday.response :logger
-          faraday.adapter :typhoeus
+          faraday.adapter :httpx
         end
       end
 

data/lib/mdqt/version.rb

@@ -1,3 +1,3 @@
 module MDQT
-  VERSION = "0.7.0"
+  VERSION = "0.8.0"
 end

data/mdqt.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = "https://github.com/Digital-Identity-Labs/mdqt"
   spec.license       = "MIT"
 
-  spec.required_ruby_version = '>= 2.1.0'
+  spec.required_ruby_version = '>= 3.0.0'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -24,21 +24,19 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency 'commander', "~>4.6"
-  spec.add_dependency 'faraday', "~>1.8"
-  spec.add_dependency 'faraday_middleware', "~>1.2"
-  spec.add_dependency 'faraday-http-cache', "~>2.2"
-  spec.add_dependency 'typhoeus', "~>1.4"
-  spec.add_dependency 'activesupport', "~>6.1"
-  spec.add_dependency 'dalli', "~>3.0"
+  spec.add_dependency 'faraday', "~>2.9.0"
+  spec.add_dependency 'faraday-http-cache', "~>2.5.0"
+  spec.add_dependency 'faraday-follow_redirects', "~>0.3.0"
+  spec.add_dependency 'httpx', "~>1.2.0"
+  spec.add_dependency 'activesupport', "~>7.1.2"
+  spec.add_dependency 'dalli', "~>3.2"
   spec.add_dependency 'pastel', "~>0.8"
   spec.add_dependency 'terminal-table', "~>3.0"
-  spec.add_dependency 'concurrent-ruby-ext', "1.1.9"
+  spec.add_dependency 'concurrent-ruby-ext', "~>1.2.2"
+  spec.add_dependency 'xmldsig', "~>0.7.0"
 
-
-  #spec.add_dependency 'xmldsig'
-
-  spec.add_development_dependency "bundler", "~> 2"
-  spec.add_development_dependency "rake", ">= 12.3.3"
+  #  spec.add_development_dependency "bundler", "~>2"
+  # spec.add_development_dependency "rake", ">= 13.1.0"
   spec.add_development_dependency "rspec", "~> 3.10"
   spec.add_development_dependency "cucumber", "~> 7.1"
   spec.add_development_dependency "aruba", "~> 2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mdqt
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Pete Birkinshaw
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-01-16 00:00:00.000000000 Z
+date: 2024-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -30,84 +30,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 2.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 2.9.0
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: 2.5.0
 - !ruby/object:Gem::Dependency
-  name: faraday-http-cache
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
-  name: typhoeus
+  name: httpx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 7.1.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: 7.1.2
 - !ruby/object:Gem::Dependency
   name: dalli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: pastel
   requirement: !ruby/object:Gem::Requirement
@@ -140,44 +140,30 @@ dependencies:
   name: concurrent-ruby-ext
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.9
+        version: 1.2.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.9
+        version: 1.2.2
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: xmldsig
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
+        version: 0.7.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.3.3
+        version: 0.7.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -332,14 +318,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.5.4
 signing_key:
 specification_version: 4
 summary: Library and commandline utility for accessing MDQ services