shibkit-meta_meta 0.2.2

data/lib/shibkit/meta_meta/sp.rb

@@ -0,0 +1,79 @@
+## @author    Pete Birkinshaw (<pete@digitalidentitylabs.com>)
+## Copyright: Copyright (c) 2011 Digital Identity Ltd.
+## License:   Apache License, Version 2.0
+
+## Licensed under the Apache License, Version 2.0 (the "License");
+## you may not use this file except in compliance with the License.
+## You may obtain a copy of the License at
+## 
+##     http://www.apache.org/licenses/LICENSE-2.0
+## 
+## Unless required by applicable law or agreed to in writing, software
+## distributed under the License is distributed on an "AS IS" BASIS,
+## WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+## See the License for the specific language governing permissions and
+## limitations under the License.
+##
+
+module Shibkit
+  class MetaMeta
+    
+    require 'shibkit/meta_meta/provider'
+  
+    ## Class to represent an SP
+    class SP < Provider
+      
+      
+      require 'shibkit/meta_meta/service'
+      require 'shibkit/meta_meta/requested_attribute'
+      
+      ## Element and attribute used to select XML for new objects
+      ROOT_ELEMENT = 'EntityDescriptor'
+      TARGET_ATTR  = 'entityID'
+      REQUIRED_QUACKS = [:entity_uri, :valid?]
+      
+      MDUI_ROOT = 'SPSSODescriptor'
+      
+ 
+      attr_accessor :services
+      
+      attr_accessor :default_service
+      
+      attr_accessor :protocols
+      
+      private
+      
+      def parse_xml
+        
+        super
+        
+        @valid = @noko.xpath('xmlns:SPSSODescriptor[1]').empty?  ? false : true
+
+        proto_set = @noko.xpath('xmlns:SPSSODescriptor/@protocolSupportEnumeration')[0]
+        @protocols = proto_set.value.split(' ') if proto_set 
+        
+        ## Include services objects
+        @services ||= Array.new
+        @noko.xpath("xmlns:SPSSODescriptor/xmlns:AttributeConsumingService").each do |sx|
+          
+          service = Shibkit::MetaMeta::Service.new(sx).filter
+
+          next unless service
+          
+          @services << service
+          @default_service = service if service.default?
+          
+        end
+        
+        @services.sort! { |a,b| a.index <=> b.index }
+        @default_service = @services[0] unless @default_service
+        
+        log.debug "  Derived SP from XML" if filter
+        
+      end
+    
+    end
+
+
+  end
+end

data/shibkit-meta_meta.gemspec

@@ -0,0 +1,154 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{shibkit-meta_meta}
+  s.version = "0.2.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Pete Birkinshaw}]
+  s.date = %q{2011-11-07}
+  s.description = %q{Utilities for friendly handling of Shibboleth/SAML2 metadata. Easily download and parse metadata XML into Ruby objects.}
+  s.email = %q{gems@digitalidentitylabs.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    ".rspec",
+    "Gemfile",
+    "Gemfile.lock",
+    "Icon.png",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "examples/biggest_entity_id.rb",
+    "lib/shibkit/meta_meta.rb",
+    "lib/shibkit/meta_meta/attribute.rb",
+    "lib/shibkit/meta_meta/config.rb",
+    "lib/shibkit/meta_meta/contact.rb",
+    "lib/shibkit/meta_meta/data/default_metadata/example_federation_metadata.xml",
+    "lib/shibkit/meta_meta/data/default_metadata/local_metadata.xml",
+    "lib/shibkit/meta_meta/data/default_metadata/uncommon_federation_metadata.xml",
+    "lib/shibkit/meta_meta/data/default_metadata_cache.yml",
+    "lib/shibkit/meta_meta/data/dev_sources.yml",
+    "lib/shibkit/meta_meta/data/real_sources.yml",
+    "lib/shibkit/meta_meta/entity.rb",
+    "lib/shibkit/meta_meta/federation.rb",
+    "lib/shibkit/meta_meta/idp.rb",
+    "lib/shibkit/meta_meta/logo.rb",
+    "lib/shibkit/meta_meta/metadata_item.rb",
+    "lib/shibkit/meta_meta/mixin/cached_downloads.rb",
+    "lib/shibkit/meta_meta/mixin/xpath_chores.rb",
+    "lib/shibkit/meta_meta/organisation.rb",
+    "lib/shibkit/meta_meta/provider.rb",
+    "lib/shibkit/meta_meta/provisioning/base.rb",
+    "lib/shibkit/meta_meta/requested_attribute.rb",
+    "lib/shibkit/meta_meta/service.rb",
+    "lib/shibkit/meta_meta/source.rb",
+    "lib/shibkit/meta_meta/sp.rb",
+    "shibkit-meta_meta.gemspec",
+    "spec/meta_meta/attribute/token",
+    "spec/meta_meta/config/autoloading_and_refreshing_spec.rb",
+    "spec/meta_meta/config/code_nspec.rb",
+    "spec/meta_meta/config/configuration_spec.rb",
+    "spec/meta_meta/config/creation_spec.rb",
+    "spec/meta_meta/config/downloading_and_caching_settings_spec.rb",
+    "spec/meta_meta/config/env_platform_settings.rb",
+    "spec/meta_meta/config/filtering_settings_spec.rb",
+    "spec/meta_meta/config/init.rb",
+    "spec/meta_meta/config/logger_settings_spec.rb",
+    "spec/meta_meta/config/smartcache_settings_spec.rb",
+    "spec/meta_meta/config/source_file_settings_spec.rb",
+    "spec/meta_meta/config/tagging_settings_spec.rb",
+    "spec/meta_meta/config/working_directory_settings_spec.rb",
+    "spec/meta_meta/config/xml_processing_settings_spec.rb",
+    "spec/meta_meta/contact/contact_oldspec.rb",
+    "spec/meta_meta/entity/entity_oldspec.rb",
+    "spec/meta_meta/federation/federation_oldspec.rb",
+    "spec/meta_meta/idp/token",
+    "spec/meta_meta/logo/token",
+    "spec/meta_meta/meta_meta/cache_example.yaml",
+    "spec/meta_meta/meta_meta/meta_meta_spec.rb",
+    "spec/meta_meta/meta_meta/saved_sources.yaml",
+    "spec/meta_meta/metadata_item/token",
+    "spec/meta_meta/organisation/organisation_oldspec.rb",
+    "spec/meta_meta/provider/token",
+    "spec/meta_meta/requested_attribute/token",
+    "spec/meta_meta/service/token",
+    "spec/meta_meta/source/application_extras_spec.rb",
+    "spec/meta_meta/source/conversion_spec.rb",
+    "spec/meta_meta/source/creation_spec.rb",
+    "spec/meta_meta/source/downloads_and_caching_spec.rb",
+    "spec/meta_meta/source/federation_information_spec.rb",
+    "spec/meta_meta/source/fixtures.rb",
+    "spec/meta_meta/source/init.rb",
+    "spec/meta_meta/source/loading_and_saving_spec.rb",
+    "spec/meta_meta/source/metadata_details_spec.rb",
+    "spec/meta_meta/source/metadata_integrity_spec.rb",
+    "spec/meta_meta/source/selection_spec.rb",
+    "spec/meta_meta/source/source_oldspec.rb",
+    "spec/meta_meta/source/xml_parsing_spec.rb",
+    "spec/meta_meta/sp/token",
+    "spec/meta_meta/template",
+    "spec/moi/config_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/support/supply_xml.rb"
+  ]
+  s.homepage = %q{https://github.com/Digital-Identity-Labs/shibkit-meta_meta}
+  s.licenses = [%q{Apache 2.0}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.8}
+  s.summary = %q{Downloads and parses Shibboleth (SAML2) metadata.}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rake>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client>, [">= 0"])
+      s.add_runtime_dependency(%q<rest-client-components>, [">= 0"])
+      s.add_runtime_dependency(%q<rack-cache>, [">= 0"])
+      s.add_runtime_dependency(%q<addressable>, [">= 0"])
+      s.add_runtime_dependency(%q<chunky_png>, [">= 0"])
+      s.add_runtime_dependency(%q<dimensions>, [">= 0"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.7.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.2"])
+    else
+      s.add_dependency(%q<rake>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
+      s.add_dependency(%q<rest-client>, [">= 0"])
+      s.add_dependency(%q<rest-client-components>, [">= 0"])
+      s.add_dependency(%q<rack-cache>, [">= 0"])
+      s.add_dependency(%q<addressable>, [">= 0"])
+      s.add_dependency(%q<chunky_png>, [">= 0"])
+      s.add_dependency(%q<dimensions>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.7.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+    end
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
+    s.add_dependency(%q<rest-client>, [">= 0"])
+    s.add_dependency(%q<rest-client-components>, [">= 0"])
+    s.add_dependency(%q<rack-cache>, [">= 0"])
+    s.add_dependency(%q<addressable>, [">= 0"])
+    s.add_dependency(%q<chunky_png>, [">= 0"])
+    s.add_dependency(%q<dimensions>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.7.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.2"])
+  end
+end
+

data/spec/meta_meta/config/autoloading_and_refreshing_spec.rb

@@ -0,0 +1,72 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+
+describe Shibkit::MetaMeta::Config, "automatic download and refresh settings" do
+  
+  ## Testing a singleton is tricky! Make a copy of the class each time
+  before(:each) do
+    @config_class = Shibkit::MetaMeta::Config.clone                                                             
+    @config = @config_class.instance                                
+  end
+  
+  subject { @config }
+  
+  it { should respond_to :autoload=  }
+  it { should respond_to :autoload? }
+  it { should respond_to :auto_refresh= }
+  it { should respond_to :auto_refresh? }
+  
+  context "When using default settings" do
+    
+    it "should have autoload set to be active" do
+      
+      @config.autoload?.should == true
+      
+    end
+    
+    it "should have auto_refresh set to active" do
+      
+      @config.auto_refresh?.should == true
+      
+    end
+    
+  end
+  
+  context "When changing settings" do
+    
+    it "should allow autoload setting to be enable or disabled" do
+      
+      @config.autoload=true
+      @config.autoload?.should == true
+      @config.autoload=false
+      @config.autoload?.should == false
+    
+    end
+    
+    it "should allow auto_refresh setting to be enabled or disabled" do
+      
+      @config.auto_refresh=true
+      @config.auto_refresh?.should == true
+      @config.auto_refresh=false
+      @config.auto_refresh?.should == false
+      
+    end
+    
+    it "should only return true or false for #autoload?" do
+      
+      @config.autoload="yup" # Potentially misleading
+      @config.autoload?.should == true
+      @config.autoload=nil
+      @config.autoload?.should == false
+      
+    end
+    
+    it "should only return true or false for #auto_refresh?" do
+      @config.auto_refresh="yup" # Potentially misleading
+      @config.auto_refresh?.should == true
+      @config.auto_refresh=nil
+      @config.auto_refresh?.should == false
+    end
+    
+  end
+  
+end

data/spec/meta_meta/config/code_nspec.rb

@@ -0,0 +1,13 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+
+describe Shibkit::MetaMeta::Config, "class source code quality" do
+
+  it 'contains no code smells' do
+    
+    source_code = File.expand_path(File.dirname(__FILE__) + '../../../../lib/shibkit/meta_meta/config.rb')
+    
+    source_code.should_not reek
+  
+  end
+  
+end

data/spec/meta_meta/config/configuration_spec.rb

@@ -0,0 +1,30 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+
+describe Shibkit::MetaMeta::Config, "configuration blocks" do
+  
+  ## Testing a singleton is tricky! Make a copy of the class each time
+  before(:each) do                                                            
+    @config_class = Shibkit::MetaMeta::Config.clone
+    @config = @config_class.instance                                
+  end
+  
+  subject { @config }
+  
+  it { should respond_to :configure }
+  
+  it "Should allow a configuration block to be used at object creation" do
+    
+    my_config = @config_class.instance { |c| c.smartcache_expiry = 12345 }
+    my_config.smartcache_expiry.should == 12345
+        
+  end
+  
+  it "Should allow a configuration block to be used at any time" do
+    
+    my_config = @config_class.instance
+    my_config.configure { |c| c.smartcache_expiry = 3333 }
+    my_config.smartcache_expiry.should == 3333
+    
+  end
+    
+end

data/spec/meta_meta/config/creation_spec.rb

@@ -0,0 +1,43 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+
+describe Shibkit::MetaMeta::Config, "creation and singleton behaviour" do
+  
+  ## Testing a singleton is tricky! Make a copy of the class each time
+  before(:each) do                                                            
+    @config_class = Shibkit::MetaMeta::Config.clone                                
+  end
+  
+  subject { @config_class }
+  
+  it { should respond_to :instance }
+  
+  
+  it "Should raise an exception if #new is called" do
+    
+    expect {  @config_class.new }.should raise_error
+    
+  end
+  
+  context "When first instance is created" do
+    
+    it "should return a Config object" do
+      
+      Shibkit::MetaMeta::Config.instance.class.should == Shibkit::MetaMeta::Config
+      
+    end
+    
+  end
+  
+  context "When an instance is created again" do
+  
+    it "should also be the same object, effectively a singleton" do
+      
+      first  = @config_class.instance
+      second = @config_class.instance
+      first.should == second
+      
+    end
+  
+  end
+  
+end

data/spec/meta_meta/config/downloading_and_caching_settings_spec.rb

@@ -0,0 +1,216 @@
+require File.expand_path(File.dirname(__FILE__) + '../../../spec_helper')
+require 'rack/cache'
+
+describe Shibkit::MetaMeta::Config, "download and file caching settings" do
+  
+  ## Testing a singleton is tricky! Make a copy of the class each time
+  before(:each) do
+    @config_class = Shibkit::MetaMeta::Config.clone                                                             
+    @config = @config_class.instance                                
+  end
+  
+  subject { @config }
+  
+  it { should respond_to :download_cache_options=  }
+  it { should respond_to :download_cache_options }
+  it { should respond_to :verbose_downloads= }
+  it { should respond_to :verbose_downloads? }
+  it { should respond_to :cache_fallback_ttl= }
+  it { should respond_to :cache_fallback_ttl }
+  it { should respond_to :cache_root= }
+  it { should respond_to :cache_root }
+  
+  it "should return a hash of cache options" do
+    
+    @config.download_cache_options.should be_a_kind_of Hash
+    
+  end
+  
+  it "cache options should be compatible with Rack::Cache" do
+    
+    options = @config.download_cache_options
+    expect {RestClient.enable Rack::Cache, options}.should_not raise_error
+    
+  end
+  
+  it "should represent download cache data and metadata locations as URLs" do
+    options = @config.download_cache_options
+    options[:metastore].should   match URL_REGEX
+    options[:entitystore].should match URL_REGEX
+  end
+  
+  context "When using default settings" do
+    
+    describe "the cache options hash" do
+
+      before(:each) do                                                         
+        @cache_options = @config.download_cache_options                                
+      end
+      
+      it "should have a two hour default TTL for cached files" do
+        @cache_options[:default_ttl].should == 7200
+      end
+      
+      it "should store cached metadata inside the cache root in a folder called meta" do
+        location =  @cache_options[:metastore]
+        location.should include @config.cache_root
+        location.should include 'meta'
+      end
+      
+      it "should store cached data inside the cache root in a folder called body" do
+        location =  @cache_options[:entitystore]
+        location.should include @config.cache_root
+        location.should include 'body'
+      end
+      
+      it "should have verbose output set to false" do
+        @cache_options[:verbose].should be_false
+      end
+      
+    end
+    
+    it "should have a fallback ttl of two hours" do
+      @config.cache_fallback_ttl.should == 7200
+    end
+    
+    it "should have the verbose download setting return false" do
+      @config.verbose_downloads?.should be_false
+    end
+    
+    context "on Windows" do
+      
+      it "should store cache files in the default TEMP directory" do
+        
+        @config_class.any_instance.stub(:sensible_os?).and_return(false)
+        tempbase = 'c:\Temp'
+        ENV['TEMP'] = tempbase
+        
+        @config.download_cache_options[:entitystore].should include tempbase.gsub('\\','/')
+        
+      end
+    
+    end
+    
+    context "on sensible operating systems" do
+      
+      it "should store cache files in /tmp/" do
+        
+        @config_class.any_instance.stub(:sensible_os?).and_return(true)
+        tempbase = '/tmp'
+        
+        @config.download_cache_options[:entitystore].should include tempbase
+        
+      end
+      
+    end
+    
+  end
+  
+  context "When changing settings" do
+    
+    it "should allow the cache directory to be changed" do
+      
+      @config.cache_root = "/tmp/bananas"
+      @config.cache_root.should == "/tmp/bananas"
+      
+    end
+    
+    it "should change the configuration hash when verbose downloads setting is changed" do
+      
+      @config.verbose_downloads?.should be_false
+      @config.download_cache_options[:verbose].should be_false
+           
+      @config.verbose_downloads = true
+      @config.download_cache_options[:verbose].should be_true
+      
+    end
+    
+    it "should change the default configuration hash when cache root is changed" do
+        
+      @config.cache_root = "/tmp/work"
+      @config.download_cache_options[:entitystore].should include "/tmp/work" 
+      @config.download_cache_options[:metastore].should   include "/tmp/work"      
+    
+    end
+    
+    context "if an equivalent Rack::Cache setting is configured directing using #download_cache_options" do 
+    
+      it "should not change the cache storage settings when #cache_root is changed " do
+      
+        @config.download_cache_options = { :entitystore => 'heap:/' }
+        @config.download_cache_options = { :metastore   => 'heap:/' }
+      
+        @config.cache_root = "/tmp/scratch"
+      
+        @config.download_cache_options[:entitystore].should == 'heap:/'
+        @config.download_cache_options[:metastore ].should  == 'heap:/'      
+      
+      end
+      
+      it "should always change the configuration hash when #default_ttl is changed" do
+
+        @config.cache_fallback_ttl = 808
+        @config.download_cache_options[:default_ttl].should == 808
+
+      end
+      
+      it "changing the configuration hash does not change #default_ttl" do
+
+        @config.download_cache_options = { :default_ttl => 909 }
+        @config.cache_fallback_ttl.should_not == 909
+
+      end
+      
+      it "should always change the configuration hash when #verbose_downloads is changed" do
+        
+        @config.download_cache_options = { :verbose => false }
+        @config.verbose_downloads = true
+        @config.download_cache_options[:verbose].should == true
+      
+      end
+      
+      it "changing the configuration hash does not change #verbose_downloads" do
+        
+        @config.verbose_downloads = true
+        @config.download_cache_options = { :verbose => false }
+        @config.verbose_downloads?.should == true
+      
+      end
+      
+    end
+    
+    it "should not allow direct manipulation of the returned config hash" do
+      
+      expect { @config.download_cache_options[:verbose] = true }.should raise_error
+        
+    end
+    
+    it "should allow new options to be merged into the default config hash, overloading those controlled by other methods" do
+      
+      @config.verbose_downloads?.should be_false
+      @config.download_cache_options[:verbose].should be_false
+           
+      @config.download_cache_options = { :verbose => true }
+      @config.download_cache_options[:verbose].should be_true
+      @config.download_cache_options[:default_ttl].should == 7200
+        
+    end
+    
+    it "should allow other, more obscure Rack::Cache options to be set" do
+
+      @config.download_cache_options[:allow_reload].should be_nil
+      @config.download_cache_options[:allow_revalidate].should be_nil
+           
+      @config.download_cache_options = { :allow_reload => true }
+      @config.download_cache_options = { :allow_revalidate => true }
+      
+      @config.download_cache_options[:allow_reload].should     be_true
+      @config.download_cache_options[:allow_revalidate].should be_true
+           
+    end
+    
+  end
+  
+end
+
+