Commit 02c620c

mo <mo.khan@gmail.com>
2017-12-23 18:44:55
embed examples in doc and remove spec_helper references.
1 parent beecc8f
lib/saml/kit/certificate.rb
@@ -1,5 +1,6 @@
 module Saml
   module Kit
+    # {include:file:spec/saml/certificate_spec.rb}
     class Certificate
       BEGIN_CERT=/-----BEGIN CERTIFICATE-----/
       END_CERT=/-----END CERTIFICATE-----/
lib/saml/kit/default_registry.rb
@@ -26,7 +26,8 @@ module Saml
     #     configuration.registry = OnDemandRegistry.new(configuration.registry)
     #     configuration.logger = Rails.logger
     #   end
-
+    #
+    # {include:file:spec/saml/default_registry.rb}
     class DefaultRegistry
       def initialize(items = {})
         @items = items
lib/saml/kit/fingerprint.rb
@@ -6,6 +6,8 @@ module Saml
     #
     #   puts Saml::Kit::Fingerprint.new(certificate).to_s
     #   # B7:AB:DC:BD:4D:23:58:65:FD:1A:99:0C:5F:89:EA:87:AD:F1:D7:83:34:7A:E9:E4:88:12:DD:46:1F:38:05:93
+    #
+    # {include:file:spec/saml/fingerprint_spec.rb}
     class Fingerprint
       # The OpenSSL::X509::Certificate
       attr_reader :x509
lib/saml/kit/invalid_document.rb
@@ -1,5 +1,6 @@
 module Saml
   module Kit
+    # {include:file:spec/saml/invalid_document_spec.rb}
     class InvalidDocument < Document
       validate do |model|
         model.errors[:base] << model.error_message(:invalid)
lib/saml/kit/logout_request.rb
@@ -20,6 +20,8 @@ module Saml
     #   url, saml_params = document.response_for(binding: :http_post)
     #
     # See {#response_for} for more information.
+    #
+    # {include:file:spec/examples/logout_request_spec.rb}
     class LogoutRequest < Document
       include Requestable
       validates_presence_of :single_logout_service, if: :expected_type?
lib/saml/kit/logout_response.rb
@@ -3,6 +3,8 @@ module Saml
     # This class is used to parse a LogoutResponse SAML document.
     #
     #   document = Saml::Kit::LogoutResponse.new(raw_xml)
+    #
+    # {include:file:spec/examples/logout_response_spec.rb}
     class LogoutResponse < Document
       include Respondable
 
lib/saml/kit/xml.rb
@@ -1,5 +1,6 @@
 module Saml
   module Kit
+    # {include:file:spec/saml/xml_spec.rb}
     class Xml # :nodoc:
       include ActiveModel::Validations
       NAMESPACES = {
lib/saml/kit/xml_decryption.rb
@@ -1,5 +1,6 @@
 module Saml
   module Kit
+    # {include:file:spec/saml/xml_decryption_spec.rb}
     class XmlDecryption
       # The list of private keys to use to attempt to decrypt the document.
       attr_reader :private_keys
spec/examples/logout_request_spec.rb
@@ -3,7 +3,7 @@ require_relative './user'
 RSpec.describe "Logout Request" do
   let(:user) { User.new(id: SecureRandom.uuid, email: "hello@example.com") }
 
-  it 'produces a logout request' do
+  it 'produces a SAMLRequest' do
     xml = Saml::Kit::Metadata.build_xml do |builder|
       builder.contact_email = 'hi@example.com'
       builder.organization_name = "Acme, Inc"
spec/saml/bindings/binding_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Bindings::Binding do
   let(:location) { FFaker::Internet.http_url }
   subject { described_class.new(binding: Saml::Kit::Bindings::HTTP_ARTIFACT, location: location) }
spec/saml/bindings/http_post_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Bindings::HttpPost do
   let(:location) { FFaker::Internet.uri("https") }
   subject { described_class.new(location: location) }
spec/saml/bindings/http_redirect_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Bindings::HttpRedirect do
   let(:location) { FFaker::Internet.http_url }
   subject { described_class.new(location: location) }
spec/saml/bindings/url_builder_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Bindings::UrlBuilder do
   describe "#build" do
     let(:xml) { "<xml></xml>" }
spec/saml/builders/authentication_request_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Builders::AuthenticationRequest do
   subject { described_class.new(configuration: configuration) }
   let(:configuration) do
spec/saml/builders/identity_provider_metadata_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Builders::IdentityProviderMetadata do
   subject { described_class.new(configuration: configuration) }
   let(:configuration) do
spec/saml/builders/logout_request_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Builders::LogoutRequest do
   subject { described_class.new(user, configuration: configuration) }
   let(:user) { double(:user, name_id_for: name_id) }
spec/saml/builders/logout_response_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Builders::LogoutResponse do
   subject { described_class.new(request) }
   let(:user) { double(:user, name_id_for: SecureRandom.uuid) }
spec/saml/builders/response_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Builders::Response do
   subject { described_class.new(user, request, configuration: configuration) }
   let(:configuration) do
spec/saml/builders/service_provider_metadata_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Builders::ServiceProviderMetadata do
   subject { described_class.new(configuration: configuration) }
   let(:configuration) do
spec/saml/authentication_request_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::AuthenticationRequest do
   subject { described_class.new(raw_xml, configuration: configuration) }
   let(:id) { Saml::Kit::Id.generate }
spec/saml/bindings_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Bindings do
   describe ".to_symbol" do
     subject { described_class }
spec/saml/certificate_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Certificate do
   subject { described_class.new(certificate, use: :signing) }
   let(:certificate) do
spec/saml/composite_metadata_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::CompositeMetadata do
   subject { described_class.new(xml) }
   let(:post_binding) { Saml::Kit::Bindings::HTTP_POST  }
spec/saml/default_registry_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::DefaultRegistry do
   subject { described_class.new }
   let(:entity_id) { FFaker::Internet.http_url }
spec/saml/fingerprint_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Fingerprint do
   describe "#sha" do
     it 'returns the SHA256' do
spec/saml/identity_provider_metadata_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::IdentityProviderMetadata do
   subject { described_class.new(raw_metadata) }
 
spec/saml/invalid_document_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::InvalidDocument do
   subject { described_class.new(xml) }
   let(:xml) { "<xml></xml>" }
spec/saml/kit_spec.rb
@@ -1,5 +1,3 @@
-require "spec_helper"
-
 RSpec.describe Saml::Kit do
   it "has a version number" do
     expect(Saml::Kit::VERSION).not_to be nil
spec/saml/logout_request_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::LogoutRequest do
   subject { described_class.build(user, configuration: configuration) }
   let(:user) { double(:user, name_id_for: name_id) }
spec/saml/logout_response_spec.rb
@@ -1,4 +1,2 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::LogoutResponse do
 end
spec/saml/metadata_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Metadata do
   describe ".from" do
     subject { described_class }
spec/saml/response_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Response do
   describe "#valid?" do
     let(:request) { instance_double(Saml::Kit::AuthenticationRequest, id: Saml::Kit::Id.generate, issuer: FFaker::Internet.http_url, assertion_consumer_service_url: FFaker::Internet.http_url, name_id_format: Saml::Kit::Namespaces::PERSISTENT, provider: nil, signed?: true, trusted?: true) }
spec/saml/service_provider_metadata_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::ServiceProviderMetadata do
   let(:entity_id) { FFaker::Internet.uri("https") }
   let(:acs_post_url) { FFaker::Internet.uri("https") }
spec/saml/signatures_spec.rb
@@ -1,5 +1,3 @@
-require "spec_helper"
-
 RSpec.describe Saml::Kit::Signatures do
   let(:configuration) do
     config = Saml::Kit::Configuration.new
spec/saml/xml_decryption_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::XmlDecryption do
   describe "#decrypt" do
     let(:secret) { FFaker::Movie.title }
spec/saml/xml_spec.rb
@@ -1,5 +1,3 @@
-require 'spec_helper'
-
 RSpec.describe Saml::Kit::Xml do
   describe "#valid_signature?" do
     let(:login_url) { "https://#{FFaker::Internet.domain_name}/login" }