mdqt 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a4e1124b801ccc638cf0ffc2f8ce7f70321933f1a050506ce0ce3b39870b56b
-  data.tar.gz: 7bebdb49dd714cf0f49c74dd31ec0505dd4957b408f781bf523c272262750496
+  metadata.gz: 1b4c3d3af10864847c7660c245d2ff0459ce87282011a7562ffa39c51c18f2f5
+  data.tar.gz: a1b470e3d206b7f5ed83f78afa970e13e7b1847ae96c5a1727b931c4a19846ec
 SHA512:
-  metadata.gz: 9216f2cb673d91ca41ce2c029203527e5daa4aafa968d9a0645b62d28a000d52030417b02966b933986b6dd085c7a06217461d3b199cd310f53be1d9d6cbf930
-  data.tar.gz: b594e5dba5098dfd0b5d6eb682a1d3196987888a5b48da2efe8707362439a34cf712f595afd949fe18816c46ff8d187e0144e3e340161c604030098c20e478cd
+  metadata.gz: 02fca67549a99277832129e8bf27344c9764c76519b464e57b8f28ddc5838f75d9cbd3e0adff603e9b2a57b985e7d93b61282a3b5d01e311f68f988cbdb64586
+  data.tar.gz: eed5827d3d9954211debb6bf52182777a01da7a8df266272bf338374c1bdd9f9ab54149d7cd5d86cf909ed645617d35791b0807814ed5c6823143d5cdb4a0554

data/.gitignore

@@ -8,3 +8,6 @@
 /spec/reports/
 /tmp/
 /out.xml
+/out.txt
+/mdqt_cache.log
+*.gem

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,296 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2018-05-03 07:42:59 +0100 using RuboCop version 0.55.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Include, TreatCommentsAsGroupSeparators.
+# Include: **/*.gemspec
+Gemspec/OrderedDependencies:
+  Exclude:
+    - 'mdqt.gemspec'
+
+# Offense count: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'mdqt.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/CommentIndentation:
+  Exclude:
+    - 'lib/mdqt/cli/base.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowBorderComment, AllowMarginComment.
+Layout/EmptyComment:
+  Exclude:
+    - 'lib/mdqt/cli/base.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/EmptyLineAfterMagicComment:
+  Exclude:
+    - 'mdqt.gemspec'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Layout/EmptyLines:
+  Exclude:
+    - 'lib/mdqt/cli.rb'
+    - 'mdqt.gemspec'
+    - 'spec/client/client_spec.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, no_empty_lines
+Layout/EmptyLinesAroundBlockBody:
+  Exclude:
+    - 'exe/mdqt'
+    - 'spec/client/client_spec.rb'
+
+# Offense count: 22
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines, beginning_only, ending_only
+Layout/EmptyLinesAroundClassBody:
+  Exclude:
+    - 'lib/mdqt/cli.rb'
+    - 'lib/mdqt/cli/base.rb'
+    - 'lib/mdqt/cli/defaults.rb'
+    - 'lib/mdqt/cli/get.rb'
+    - 'lib/mdqt/client.rb'
+    - 'lib/mdqt/client/metadata_service.rb'
+
+# Offense count: 11
+# Cop supports --auto-correct.
+Layout/EmptyLinesAroundMethodBody:
+  Exclude:
+    - 'lib/mdqt/cli/base.rb'
+    - 'lib/mdqt/cli/get.rb'
+    - 'lib/mdqt/client.rb'
+    - 'lib/mdqt/client/metadata_service.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
+Layout/EmptyLinesAroundModuleBody:
+  Exclude:
+    - 'lib/mdqt.rb'
+    - 'lib/mdqt/cli.rb'
+    - 'lib/mdqt/cli/base.rb'
+    - 'lib/mdqt/cli/get.rb'
+    - 'lib/mdqt/client.rb'
+    - 'lib/mdqt/client/metadata_service.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment, ForceEqualSignAlignment.
+Layout/ExtraSpacing:
+  Exclude:
+    - 'mdqt.gemspec'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+Layout/LeadingCommentSpace:
+  Exclude:
+    - 'exe/mdqt'
+    - 'lib/mdqt/client/metadata_service.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Layout/SpaceAfterComma:
+  Exclude:
+    - 'lib/mdqt/client/metadata_service.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: .
+# SupportedStyles: space, no_space
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'mdqt.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Layout/SpaceBeforeFirstArg:
+  Exclude:
+    - 'lib/mdqt/client/metadata_service.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, EnforcedStyleForEmptyBraces, SpaceBeforeBlockParameters.
+# SupportedStyles: space, no_space
+# SupportedStylesForEmptyBraces: space, no_space
+Layout/SpaceInsideBlockBraces:
+  Exclude:
+    - 'lib/mdqt/cli/get.rb'
+
+# Offense count: 7
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: final_newline, final_blank_line
+Layout/TrailingBlankLines:
+  Exclude:
+    - 'exe/mdqt'
+    - 'lib/mdqt/cli.rb'
+    - 'lib/mdqt/cli/base.rb'
+    - 'lib/mdqt/cli/defaults.rb'
+    - 'lib/mdqt/client.rb'
+    - 'lib/mdqt/client/metadata_service.rb'
+    - 'spec/client/client_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
+Lint/UnusedBlockArgument:
+  Exclude:
+    - 'exe/mdqt'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: AllowUnusedKeywordArguments, IgnoreEmptyMethods.
+Lint/UnusedMethodArgument:
+  Exclude:
+    - 'lib/mdqt/cli/base.rb'
+
+# Offense count: 1
+Lint/UselessAssignment:
+  Exclude:
+    - 'lib/mdqt/client.rb'
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 13
+
+# Offense count: 8
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/mdqt.rb'
+    - 'lib/mdqt/cli.rb'
+    - 'lib/mdqt/cli/base.rb'
+    - 'lib/mdqt/cli/defaults.rb'
+    - 'lib/mdqt/cli/get.rb'
+    - 'lib/mdqt/client.rb'
+    - 'lib/mdqt/client/metadata_service.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/Encoding:
+  Exclude:
+    - 'mdqt.gemspec'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'mdqt.gemspec'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 16
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: when_needed, always, never
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, UseHashRocketsWithSymbolValues, PreferHashRocketsForNonAlnumEndingSymbols.
+# SupportedStyles: ruby19, hash_rockets, no_mixed_keys, ruby19_no_mixed_keys
+Style/HashSyntax:
+  Exclude:
+    - 'Rakefile'
+    - 'lib/mdqt/client/metadata_service.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/MutableConstant:
+  Exclude:
+    - 'lib/mdqt/version.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: Whitelist.
+# Whitelist: be, be_a, be_an, be_between, be_falsey, be_kind_of, be_instance_of, be_truthy, be_within, eq, eql, end_with, include, match, raise_error, respond_to, start_with
+Style/NestedParenthesizedCalls:
+  Exclude:
+    - 'lib/mdqt/client/metadata_service.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: PreferredDelimiters.
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - 'mdqt.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantSelf:
+  Exclude:
+    - 'lib/mdqt/cli/base.rb'
+
+# Offense count: 37
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
+# SupportedStyles: single_quotes, double_quotes
+Style/StringLiterals:
+  Exclude:
+    - 'Rakefile'
+    - 'bin/console'
+    - 'lib/mdqt.rb'
+    - 'lib/mdqt/cli/base.rb'
+    - 'lib/mdqt/cli/get.rb'
+    - 'lib/mdqt/client/metadata_service.rb'
+    - 'lib/mdqt/version.rb'
+    - 'mdqt.gemspec'
+    - 'spec/mdqt_spec.rb'
+    - 'spec/spec_helper.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyleForMultiline.
+# SupportedStylesForMultiline: comma, consistent_comma, no_comma
+Style/TrailingCommaInHashLiteral:
+  Exclude:
+    - 'lib/mdqt/cli/defaults.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
+# Whitelist: to_ary, to_a, to_c, to_enum, to_h, to_hash, to_i, to_int, to_io, to_open, to_path, to_proc, to_r, to_regexp, to_str, to_s, to_sym
+Style/TrivialAccessors:
+  Exclude:
+    - 'lib/mdqt/client.rb'
+    - 'lib/mdqt/client/metadata_service.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+Style/UnneededPercentQ:
+  Exclude:
+    - 'mdqt.gemspec'
+
+# Offense count: 7
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 130

data/.travis.yml

@@ -1,5 +1,7 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.1.2
-before_install: gem install bundler -v 1.13.5
+  - 2.2.2
+  - 2.5.0
+  - jruby
+before_install: gem install bundler -v 1.16.1

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+## 0.2.0
+
+### Improvements
+- Option to cache HTTP requests to the MDQ service
+- Supports Gzip compression by default
+- Supports redirect responses
+- Helpful error messages and status messages
+- Verbose mode will show successful connection information
+- Warnings about unspecified MDQ service
+- Default MDQ service selection (rather crude, maybe not a good idea at all)
+- Catch bad URLs for the MDQ service and fail with a better error message
+
+### Fixes
+- Aggregates are now requested with /entities not /entities/, as per spec
+
+### Other
+- First few Cucumber features to define and test the executable
+- Beginning of an RSpec suit to define the API
+- Minimum version of Ruby is now 2.1, but only 2.2+ is tested using CI
+
+## 0.1.1
+
+### Fixes
+- Bug that prevented the mdqt executable from running outside a Bundler environment
+
+## 0.1.0
+
+- Initial release

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mdq.gemspec
 gemspec
+
+gem 'simplecov', require: false, group: :test

data/README.md

@@ -1,23 +1,31 @@
 # MDQT - A Metadata Query Tool
 
+[![Gem Version](https://badge.fury.io/rb/mdqt.svg)](https://badge.fury.io/rb/mdqt) [![Maintainability](https://api.codeclimate.com/v1/badges/111c46aaebfe25e4a4a9/maintainability)](https://codeclimate.com/github/Digital-Identity-Labs/mdqt/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/111c46aaebfe25e4a4a9/test_coverage)](https://codeclimate.com/github/Digital-Identity-Labs/mdqt/test_coverage) [![Build Status](https://travis-ci.org/Digital-Identity-Labs/mdqt.svg?branch=master)](https://travis-ci.org/Digital-Identity-Labs/mdqt)
+
 MDQT is small library and commandline tool to query MDQ services for SAML metadata.
-You can do this with `curl` but it's a little more convenient to use `mdqt` instead.
+You could do this with `curl` but it's a little more convenient to use `mdqt` instead.
 
 At present `mdqt` does *not* verify signed metadata, so an extra step is required to use it
-securely. It is also not yet fully compliant with the MDQ client specification.
+securely.
+
+MDQ currently supports:
+
+  - Downloading single entities, lists or aggregates
+  - Caching entity metadata on disk
+  - Gzip compression
 
 ## MDQ?
 
 MDQ is a simple HTTP-based standard for looking up individual SAML entity metadata. Rather than regularly
 downloading large metadata aggregates containing thousands of entity descriptions,
-an IdP or SP can download the metadata for individual entities using MDQ when they are needed.
+an IdP or SP can download the metadata for an individual entity whenever it is needed.
 
 The UK Access Management Federation has a
 [useful page explaining MDQ](https://www.ukfederation.org.uk/content/Documents/MDQ)
 
 ## Installation
 
-To add mdqt to a project, add this line to your application's Gemfile
+To add MDQT to a project, include this line in your application's Gemfile
 
 ```ruby
 gem 'mdqt'
@@ -35,33 +43,47 @@ If using a per-user Ruby such via `rbenv` or similar, you'll just need
 
     $ gem install mdqt
 
+MDQT should work with Ruby 2.1.0 or later.
+
 ## Commandline Usage as an MDQ client
 
-You can see a list of commandline options by typing
+You can see a list of commandline options by typing:
 
     $ mdqt --help
 
-Specifying the MDQ service with a commandline option
+To see more information about a command, use the `--help` option after the command:
+
+    $ mdqt get --help
+
+Specifying the MDQ service with a commandline option:
 
     $ mdqt get --service https://mdq.example.com/mdq  http://entity.ac.uk/shibboleth
 
 It's more convenient to set an environment variable to specify a default MDQ
-service. Set MDQT_SERVICE or MDQ_BASE_URL to the base URL of your MDQ service.
+service. Set `MDQT_SERVICE` or `MDQ_BASE_URL` to the base URL of your MDQ service.
 
-Downloading entity metadata to STDOUT
+Downloading entity metadata to STDOUT:
 
     $ mdqt get https://test-idp.ukfederation.org.uk/idp/shibboleth
 
-Using sha1 hashed version of entity IDs requires quotes or escaping
+Using the sha1 hashed version of entity IDs requires quotes or escaping:
 
     $ mdqt get "{sha1}52e2065fc0d53744e8d4ee2c2f30696ebfc5def9"
 
     $ mdqt get \{sha1\}52e2065fc0d53744e8d4ee2c2f30696ebfc5def9
 
-Requesting all metadata from an MDQ endpoint is done by specifying `--all`
+Requesting all metadata from an MDQ endpoint is done by specifying `--all`:
 
     $ mdqt get --all
 
+Caching can be enabled using `--cache`. At the moment the `mdqt` executable
+only supports caching to disk. It will create a cache directory in your temporary
+directory.
+
+    $ mdqt get --cache --service https://mdq.example.com/mdq  http://entity.ac.uk/shibboleth
+
+If you don't specify an MDQ service with `--service' or `MDQT_SERVICE` then `mdqt` *might* be
+able to guess your local NREN's MDQ service. Do not do this in production.
 
 ## Library Usage
 

data/Rakefile

@@ -1,6 +1,5 @@
 require "bundler/gem_tasks"
-require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
+Dir.glob('lib/tasks/*.rake').each { |r| load r}
 
-task :default => :spec
+task :default => :tests

data/exe/mdqt

@@ -23,14 +23,16 @@ Commander.configure do
   end
 
   command :get do |c|
-    c.syntax = 'mdqt get [options] [entity id] [entity id] '
+    c.syntax = 'mdqt get [options] entityidentifier '
     c.description = 'Download one entity record or an aggregate of entity records'
     c.option '--service URL', String, 'MDQ service to search for entities. Defaults to MDQT_SERVICE or MDQ_BASE_URL env variables'
+    c.option '--cache', "Cache downloads and try to fetch from cache where appropriate"
     #c.option '--verify-with PATH', String, 'Validate downloads using specified certificate'
     #c.option '--stdin', 'accept one or more entity ids from STDIN'
     c.option '--all', 'Request all entity records'
     c.action do |args, options|
       options.default MDQT::CLI::Defaults.cli_defaults
+      options.default({service: MDQT::CLI::Defaults.base_url }) if options.service.nil?
       MDQT::CLI::Get.run(args, options)
     end
   end

data/lib/mdqt/cli/base.rb

@@ -5,12 +5,75 @@ module MDQT
     class Base
 
       def self.run(args, options)
-        self.new.run(args, options)
+
+        #args = options.stdin ? absorb_piped_args(args) : args
+
+        check_requirements(args, options)
+        introduce(args, options)
+
+        self.new(args, options).run
+      end
+
+      def self.check_requirements(args, options)
+        abort "Error: No MDQ service URL has been specified." unless options.service
+      end
+
+      def self.introduce(args, options)
+        if options.verbose
+          STDERR.puts "Using #{options.service}"
+          STDERR.puts "Caching is #{options.service ? 'on' : 'off'}"
+          STDERR.puts
+        end
+      end
+
+      def self.absorb_piped_args(args)
+        piped = piped? ? parse_stdin : []
+        args + piped
+      end
+
+      def self.piped?
+        !STDIN.tty? && !STDIN.closed?
+      end
+
+      def self.parse_stdin
+        STDIN.gsub("\s", "\n").each_line.collect {|l| l.strip }
+      end
+
+      def initialize(args, options)
+        @args = args
+        @options = options
+      end
+
+      def args=(new_args)
+        @args = new_args
+      end
+
+      def args
+        @args
+      end
+
+      def options=(new_options)
+        @options = new_options
+      end
+
+      def options
+        @options
+      end
+
+      def output(response)
+        if response.ok?
+          STDERR.puts response.message if options.verbose
+          trailer = response.data[-1] == "\n" ? "" : "\n"
+          response.data + trailer
+        else
+          STDERR.puts response.message
+        end
+
       end
 
-      def run(args, options)
+      def run
 
-        puts "No action has been defined for this command!"
+        abort "No action has been defined for this command!"
 
       end
 

data/lib/mdqt/cli/defaults.rb

@@ -6,7 +6,7 @@ module MDQT
       class << self
 
         def base_url
-          ENV['MDQT_SERVICE'] || ENV['MDQ_BASE_URL'] || 'http://mdq.ukfederation.org.uk/'
+          ENV['MDQT_SERVICE'] || ENV['MDQ_BASE_URL'] || guess_service
         end
 
         def force_hash?
@@ -15,11 +15,32 @@ module MDQT
 
         def cli_defaults
           {
-            service: base_url,
             hash: force_hash?,
+            cache: false
           }
         end
 
+        def guess_service
+
+          locale = ENV['LANG']
+
+          #STDERR.puts("Detected locale #{locale}")
+
+          service = case locale
+                    when 'en_GB.UTF-8'
+                      'http://mdq.ukfederation.org.uk/'
+                    when 'en_US.UTF-8'
+                      'http://mdq-beta.incommon.org/global'
+                    else
+                      abort "Please specify an MDQ service using --service, MDQT_SERVICE or MDQ_BASE_URL"
+                    end
+
+          STDERR.puts "MDQT is assuming that you want to use #{service}\nPlease configure this using --service, MDQT_SERVICE or MDQ_BASE_URL\n\n"
+
+          service
+
+        end
+
       end
 
     end

data/lib/mdqt/cli/get.rb

@@ -6,26 +6,58 @@ module MDQT
 
     class Get < Base
 
-      def run(args, options)
+      def run
 
-        client = MDQT::Client.new(base_url: options.service)
+        abort("Please specify --all if you wish to request all entities from #{options.service}") if args.empty? && !options.all
 
-        if args.empty?
+        results = get_results(args, options)
 
-          if options.all
-            results = [client.get_metadata("")]
-          else
-            abort("Please specify --all if you wish to request all entities from #{options.service}")
-          end
+        #results = MetadataValidator.validate_responses(results) if options.validate
 
+        #results = MetadataAggregator.aggregate_responses(results) if options.aggregate
+
+        output_metadata(results, options)
+
+      end
+
+      def get_results(args, options)
+
+        client = MDQT::Client.new(
+            options.service,
+            verbose: options.verbose,
+            cache_type: options.cache ? :file : :none
+        )
+
+        args.empty? ? [client.get_metadata("")] : args.collect {|entity_id| client.get_metadata(entity_id)}
+
+      end
+
+      def output_metadata(results, options)
+        case action(results, options)
+        when :save_files
+          output_files(results, options)
+        when :print_to_stdout
+          output_to_stdout(results, options)
         else
-          results = args.collect {|entity_id| client.get_metadata(entity_id)}
+          abort "Error - can't determine output type"
         end
+      end
 
-        results.each do |result|
-          puts result.body
+      def action(results, options)
+        case
+        when options.save
+          :save_files
+        else
+          :print_to_stdout
         end
+      end
+
+      def output_to_stdout(results, options)
+        results.each {|r| puts output(r)}
+      end
 
+      def output_files(results, options)
+        abort "Unimplemented feature"
       end
 
     end

data/lib/mdqt/client.rb

@@ -3,27 +3,40 @@ module MDQT
 
     require 'mdqt/client/metadata_service'
 
-    def initialize(options={})
+    def initialize(base_url, options={})
 
-      @base_url = options[:base_url]
-      @md_service = MetadataService.new(@base_url)
+      @base_url   = base_url
+      @verbose    = options[:verbose] || false
+      @cache_type = options[:cache_type] || :none
+
+      @md_service = MetadataService.new(@base_url, verbose: @verbose, cache_type: @cache_type)
 
     end
 
     def get_metadata(entity_id)
 
-      result = md_service.get(entity_id)
+      md_service.get(entity_id)
 
     end
 
-    def md_service
-      @md_service
-    end
-
     def base_url
       @base_url
     end
 
+    def verbose?
+      @verbose
+    end
+
+    def cache_type
+      @cache_type
+    end
+
+    private
+
+    def md_service
+      @md_service
+    end
+
   end
 
 end

data/lib/mdqt/client/metadata_response.rb

@@ -0,0 +1,101 @@
+module MDQT
+  class Client
+
+    class MetadataResponse
+
+      require 'digest'
+
+      def initialize(identifier, service, http_response)
+
+        @requested_identitier = identifier
+        @identifier = URI.decode(identifier)
+        @service = service
+        @code = http_response.status || 500
+        @data = http_response.body || ""
+        @type = http_response.headers['Content-Type']
+        @expires = http_response.headers['Expires']
+        @etag = http_response.headers['ETag']
+        @last_modified = http_response.headers['Last-Modified']
+        @ok = http_response.success?
+      end
+
+      def identifier
+        @identifier
+      end
+
+      def requested_identifier
+        @identifier
+      end
+
+      def service
+        @service
+      end
+
+      def code
+        @code
+      end
+
+      def data
+        @data || ""
+      end
+
+      def type
+        @type
+      end
+
+      def expires
+        @expires
+      end
+
+      def etag
+        @etag
+      end
+
+      def last_modified
+        @last_modified
+      end
+
+      def ok?
+        @ok
+      end
+
+      def signed?
+        @data.include? "<Signature" # This is... not great
+      end
+
+      def filename
+        "#{Digest::SHA1.hexdigest(@identifier)}.xml"
+      end
+
+      def message
+        case code
+        when 200
+          "[200] OK! Data for '#{identifier}' has been downloaded from #{service}"
+        when 304
+          "[200] OK! Data for '#{identifier}' is already available in a local cache"
+        when 400
+          "[400] The identifier '#{identifier}' ('#{requested_identifier}') is malformed or service URL #{service} is incorrect"
+        when 401
+          "[401] Credentials are incorrect or missing for '#{identifier}'"
+        when 403
+          identifier.empty? ? "[403] The MDQ service at #{service} does not support aggregate downloads" :
+              "[403] You do not have access rights to '#{identifier}' at #{service}"
+        when 404
+          identifier.empty? ? "[404] The MDQ service at #{service} is not responding with aggregated metadata or the correct status" :
+          "[404] Entity metadata for '#{identifier}' was not found at #{service}"
+        when 405
+          "[405] The service at #{service} believes the wrong HTTP method was used. We should have used HTTP GET..."
+        when 406
+          "[406] The requested content type is not available at #{service}"
+        when 505
+          "[505] The service at #{service} claims our request was using pre-1999 web protocols, not HTTP 1.1 or later"
+        else
+          "[#{code}] Sorry - an unknown error has occured requesting '#{identifier}' from #{service}.\nPlease report this bug!"
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/mdqt/client/metadata_service.rb

@@ -8,10 +8,21 @@ module MDQT
       require 'typhoeus/adapters/faraday'
       require 'cgi'
 
-      def initialize(base_url)
+      require 'faraday_middleware'
+      require 'faraday-http-cache'
 
-        @base_url = base_url
+      require 'active_support/cache'
+      require 'active_support/cache/file_store'
+      require 'active_support/cache/mem_cache_store'
+      require 'active_support/logger'
+
+      require_relative './metadata_response'
 
+      def initialize(base_url, options = {})
+        @base_url = base_url
+        @cache_type = options[:cache_type] ? options[:cache_type].to_sym : :none
+        @store_config = options[:cache_store]
+        @verbose = options[:verbose] ? true : false
       end
 
       def base_url
@@ -22,13 +33,18 @@ module MDQT
 
         entity_id = prepare_id(entity_id)
 
-        connection.get do |req|
-          req.url ['entities/', entity_id].join
-          req.options.timeout = 100
-          req.options.open_timeout = 5
-          req.headers['Content-Type'] = 'application/samlmetadata+xml'
-          req.headers['User-Agent'] = "MDQT v#{MDQT::VERSION}"
+        begin
+          http_response = connection.get do |req|
+            req.url request_path(entity_id)
+            req.options.timeout = 100
+            req.options.open_timeout = 5
+          end
+        rescue Faraday::ConnectionFailed => oops
+          abort "Error - can't connect to MDQ service at URL #{base_url}"
         end
+
+        MetadataResponse.new(entity_id, base_url, http_response)
+
       end
 
       def prepare_id(id)
@@ -38,17 +54,83 @@ module MDQT
         when /^{sha1}/i
           CGI.escape(id.downcase.strip)
         when /^\[sha1\]/i
-          CGI.escape(id.downcase.strip.gsub"[sha1]","{sha1}")
+          CGI.escape(id.downcase.strip.gsub "[sha1]", "{sha1}")
         else
           CGI.escape(id.strip)
         end
       end
 
+      def verbose?
+        @verbose
+      end
+
+      def cache?
+        cache_type == :none ? false : true
+      end
+
+      def cache_type
+        @cache_type || :none
+      end
+
+      def store_config
+        @store_config || default_store_config
+      end
+
+      private
+
+      def request_path(entity_id)
+        case entity_id
+        when nil, ""
+          'entities'
+        else
+          ['entities', entity_id].join('/')
+        end
+      end
+
       def connection
         Faraday.new(:url => base_url) do |faraday|
           faraday.request :url_encoded
-          #faraday.response :logger                  # log requests to STDOUT
+          faraday.use FaradayMiddleware::Gzip
+          faraday.use FaradayMiddleware::FollowRedirects
+          faraday.use :http_cache, faraday_cache_config if cache?
+          faraday.headers['Content-Type'] = 'application/samlmetadata+xml'
+          faraday.headers['User-Agent'] = "MDQT v#{MDQT::VERSION}"
           faraday.adapter :typhoeus
+          #faraday.response :logger
+        end
+      end
+
+      def default_store_config
+        case cache_type
+        when :none, nil
+          nil
+        when :file, :files
+          File.absolute_path(File.join(Dir.tmpdir, 'mdqt_cache'))
+        when :memcached, :memcache
+          'localhost:11211'
+        end
+      end
+
+      def faraday_cache_config
+        {
+            store: cache_store,
+            shared_cache: false,
+            serializer: Marshal,
+            #logger: cache_logger,
+            instrumenter: ActiveSupport::Notifications
+        }
+      end
+
+      def cache_logger
+        verbose? ? Logger.new('mdqt_cache.log') : nil
+      end
+
+      def cache_store
+        case cache_type
+        when :file, :files, nil
+          @cache_store = ActiveSupport::Cache.lookup_store(:file_store, store_config)
+        when :memcache, :memcached
+          @cache_store = ActiveSupport::Cache.lookup_store(:mem_cache_store, [store_config])
         end
       end
 

data/lib/mdqt/client/metadata_validator.rb

@@ -0,0 +1,23 @@
+module MDQT
+  class Client
+
+    class MetadataValidator
+
+      def initialize(response)
+
+        puts response.inspect
+
+      end
+
+
+      def ok?
+        true
+      end
+
+
+
+    end
+
+  end
+
+end

data/lib/mdqt/version.rb

@@ -1,3 +1,3 @@
 module MDQT
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 end

data/lib/tasks/cucumber.rake

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'cucumber'
+require 'cucumber/rake/task'
+
+desc "Run Cucumber tests"
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "features --format pretty"
+end

data/lib/tasks/spec.rake

@@ -0,0 +1,5 @@
+require "rspec/core/rake_task"
+
+
+
+RSpec::Core::RakeTask.new(:spec)

data/lib/tasks/tests.rake

@@ -0,0 +1,6 @@
+
+desc "Run all tests and gather coverage information"
+task :tests => [:spec, :features] do
+
+
+end

data/lib/tasks/yard.rake

@@ -0,0 +1,6 @@
+require 'yard'
+
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['features/*.feature', 'features/*.rb']
+  t.options = ['--any', '--extra', '--opts'] # optional
+end

data/mdqt.gemspec

@@ -9,11 +9,13 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Pete Birkinshaw"]
   spec.email         = ["pete@digitalidentitylabs.com"]
 
-  spec.summary       = %q{Library and utility for accessing MDQ services}
-  spec.description   = %q{Library and utility for accessing MDQ service}
+  spec.summary       = %q{Library and commandline utility for accessing MDQ services}
+  spec.description   = %q{Library and commandline utility for downloading SAML metadata from MDQ services}
   spec.homepage      = "https://github.com/Digital-Identity-Labs/mdqt"
   spec.license       = "MIT"
 
+  spec.required_ruby_version = '>= 2.1.0'
+
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   # if spec.respond_to?(:metadata)
@@ -30,13 +32,22 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday", "~>0.15"
+  spec.add_dependency 'commander', "~>4.4"
+  spec.add_dependency 'faraday', "~>0.15"
+  spec.add_dependency 'faraday_middleware', "~>0.12"
   spec.add_dependency 'faraday-http-cache', "~>2.0"
-  spec.add_dependency "typhoeus", "~>1.3"
-  spec.add_dependency "commander", "~>4.4"
+  spec.add_dependency 'typhoeus', "~>1.3"
+  spec.add_dependency 'activesupport', "~>5.2"
+  spec.add_dependency 'dalli', "~>2.7"
 
+  #spec.add_dependency 'xmldsig'
 
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "cucumber", "~> 3.1"
+  spec.add_development_dependency "aruba", "~> 0.14"
+  spec.add_development_dependency "vcr", "~>  4.0"
+  spec.add_development_dependency "yard", "~> 0.9"
+  spec.add_development_dependency "yard-cucumber", "~> 4.0"
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: mdqt
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Pete Birkinshaw
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-05-02 00:00:00.000000000 Z
+date: 2018-05-06 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.4'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -24,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: faraday-http-cache
   requirement: !ruby/object:Gem::Requirement
@@ -53,19 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: commander
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: '5.2'
+- !ruby/object:Gem::Dependency
+  name: dalli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,7 +150,78 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Library and utility for accessing MDQ service
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: yard-cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: Library and commandline utility for downloading SAML metadata from MDQ
+  services
 email:
 - pete@digitalidentitylabs.com
 executables:
@@ -118,8 +231,11 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -131,11 +247,20 @@ files:
 - lib/mdqt.rb
 - lib/mdqt/cli.rb
 - lib/mdqt/cli/base.rb
+- lib/mdqt/cli/clean.rb
+- lib/mdqt/cli/compliance.rb
 - lib/mdqt/cli/defaults.rb
 - lib/mdqt/cli/get.rb
+- lib/mdqt/cli/stream.rb
 - lib/mdqt/client.rb
+- lib/mdqt/client/metadata_response.rb
 - lib/mdqt/client/metadata_service.rb
+- lib/mdqt/client/metadata_validator.rb
 - lib/mdqt/version.rb
+- lib/tasks/cucumber.rake
+- lib/tasks/spec.rake
+- lib/tasks/tests.rake
+- lib/tasks/yard.rake
 - mdqt.gemspec
 homepage: https://github.com/Digital-Identity-Labs/mdqt
 licenses:
@@ -149,7 +274,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -160,5 +285,5 @@ rubyforge_project:
 rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: Library and utility for accessing MDQ services
+summary: Library and commandline utility for accessing MDQ services
 test_files: []