Commit d0507a5

mo <mo.khan@gmail.com>
2017-12-16 19:09:07
rename sign= to embed_signature=
1 parent 52dad8c
lib/saml/kit/bindings/http_redirect.rb
@@ -9,7 +9,7 @@ module Saml
         end
 
         def serialize(builder, relay_state: nil)
-          builder.sign = false
+          builder.embed_signature = false
           builder.destination = location
           document = builder.build
           [UrlBuilder.new(configuration: builder.configuration).build(document, relay_state: relay_state), {}]
lib/saml/kit/builders/assertion.rb
@@ -5,7 +5,7 @@ module Saml
         include Templatable
         extend Forwardable
 
-        def_delegators :@response_builder, :encrypt, :sign, :request, :issuer, :reference_id, :now, :configuration, :user, :version, :destination, :encryption_certificate
+        def_delegators :@response_builder, :encrypt, :embed_signature, :request, :issuer, :reference_id, :now, :configuration, :user, :version, :destination, :encryption_certificate
 
         def initialize(response_builder)
           @response_builder = response_builder
lib/saml/kit/builders/response.rb
@@ -18,7 +18,7 @@ module Saml
           @version = "2.0"
           @status_code = Namespaces::SUCCESS
           @issuer = configuration.issuer
-          @sign = want_assertions_signed
+          @embed_signature = want_assertions_signed
           @encrypt = encryption_certificate.present?
           @configuration = configuration
         end
lib/saml/kit/builders/xml_signature.rb
@@ -17,7 +17,7 @@ module Saml
           SHA512: "http://www.w3.org/2001/04/xmlenc#sha512",
         }.freeze
 
-        attr_reader :sign, :configuration
+        attr_reader :embed_signature, :configuration
         attr_reader :reference_id
         attr_reader :x509_certificate
 
lib/saml/kit/authentication_request.rb
@@ -18,7 +18,7 @@ module Saml
       def response_for(user, binding:, relay_state: nil)
         response_binding = provider.assertion_consumer_service_for(binding: binding)
         builder = Saml::Kit::Response.builder(user, self) do |x|
-          x.sign = provider.want_assertions_signed
+          x.embed_signature = provider.want_assertions_signed
           yield x if block_given?
         end
         response_binding.serialize(builder, relay_state: relay_state)
lib/saml/kit/identity_provider_metadata.rb
@@ -31,7 +31,7 @@ module Saml
 
       def login_request_for(binding:, relay_state: nil)
         builder = Saml::Kit::AuthenticationRequest.builder do |x|
-          x.sign = want_authn_requests_signed
+          x.embed_signature = want_authn_requests_signed
           yield x if block_given?
         end
         request_binding = single_sign_on_service_for(binding: binding)
lib/saml/kit/templatable.rb
@@ -1,7 +1,12 @@
 module Saml
   module Kit
     module Templatable
-      attr_accessor :sign
+      attr_accessor :embed_signature
+
+      def sign=(value)
+        Saml::Kit.deprecate("sign= is deprecated. Use embed_signature= instead")
+        self.embed_signature = value
+      end
 
       def to_xml(xml: ::Builder::XmlMarkup.new)
         signatures.complete(render(self, xml: xml))
@@ -13,7 +18,7 @@ module Saml
       end
 
       def sign?
-        sign.nil? ? configuration.sign? : sign && configuration.sign?
+        embed_signature.nil? ? configuration.sign? : embed_signature && configuration.sign?
       end
 
       def signatures
spec/saml/builders/logout_request_spec.rb
@@ -36,7 +36,7 @@ RSpec.describe Saml::Kit::Builders::LogoutRequest do
   end
 
   it 'excludes a signature' do
-    subject.sign = false
+    subject.embed_signature = false
     xml_hash = Hash.from_xml(subject.to_xml)
     expect(xml_hash['LogoutRequest']['Signature']).to be_nil
   end
spec/saml/builders/response_spec.rb
@@ -25,7 +25,7 @@ RSpec.describe Saml::Kit::Builders::Response do
       allow(configuration.registry).to receive(:metadata_for).with(issuer).and_return(provider)
       allow(provider).to receive(:matches?).and_return(true)
 
-      subject.sign = true
+      subject.embed_signature = true
       subject.encrypt = true
       result = subject.build
       expect(result).to be_valid
@@ -111,7 +111,7 @@ RSpec.describe Saml::Kit::Builders::Response do
 
     it 'generates a signed response and encrypted assertion' do
       subject.encrypt = true
-      subject.sign = true
+      subject.embed_signature = true
       result = Hash.from_xml(subject.to_xml)
       expect(result['Response']['Signature']).to be_present
       expect(result['Response']['EncryptedAssertion']).to be_present
@@ -119,7 +119,7 @@ RSpec.describe Saml::Kit::Builders::Response do
 
     it 'generates a signed response and assertion' do
       subject.encrypt = false
-      subject.sign = true
+      subject.embed_signature = true
       result = Hash.from_xml(subject.to_xml)
       expect(result['Response']['Signature']).to be_present
       expect(result['Response']['Assertion']['Signature']).to be_present
@@ -127,7 +127,7 @@ RSpec.describe Saml::Kit::Builders::Response do
 
     it 'generates a signed response and signed and encrypted assertion' do
       subject.encrypt = true
-      subject.sign = true
+      subject.embed_signature = true
 
       result = Saml::Kit::Response.new(subject.to_xml, configuration: configuration)
       expect(result).to be_signed
@@ -137,7 +137,7 @@ RSpec.describe Saml::Kit::Builders::Response do
 
     it 'generates an encrypted assertion' do
       subject.encrypt = true
-      subject.sign = false
+      subject.embed_signature = false
 
       result = Saml::Kit::Response.new(subject.to_xml, configuration: configuration)
       expect(result).to_not be_signed