Set up linting

* Autofixed issues
* Excluded Akami::WSSE::Signature

Author: rubiii

.standard.yml

@@ -0,0 +1,9 @@
+# The WS-Security algorithm/type URIs are public constants named in CamelCase
+# since akami 1.1.0 (2012). They are part of Akami::WSSE::Signature's public
+# surface and are referenced elsewhere as e.g.
+# Akami::WSSE::Signature::ExclusiveXMLCanonicalizationAlgorithm. Renaming them to
+# SCREAMING_SNAKE_CASE would break any caller that references them, so the naming
+# cop is disabled for this one file rather than changing the API.
+ignore:
+  - "lib/akami/wsse/signature.rb":
+      - Naming/ConstantName

Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 gemspec
 
-
+gem "standard", require: false

Rakefile

@@ -1,11 +1,11 @@
-require 'bundler'
+require "bundler"
 Bundler::GemHelper.install_tasks
 
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new do |t|
-  t.rspec_opts = %w(-c)
+  t.rspec_opts = %w[-c]
 end
 
-task :default => :spec
-task :test => :spec
+task default: :spec
+task test: :spec

akami.gemspec

@@ -1,28 +1,27 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "akami/version"
 
 Gem::Specification.new do |s|
-  s.name        = "akami"
-  s.version     = Akami::VERSION
-  s.authors     = ["Daniel Harrington"]
-  s.email       = ["me@rubiii.com"]
-  s.homepage    = "https://github.com/savonrb/#{s.name}"
-  s.summary     = "Web Service Security"
+  s.name = "akami"
+  s.version = Akami::VERSION
+  s.authors = ["Daniel Harrington"]
+  s.email = ["me@rubiii.com"]
+  s.homepage = "https://github.com/savonrb/#{s.name}"
+  s.summary = "Web Service Security"
   s.description = "Building Web Service Security"
-  s.required_ruby_version = '>= 3.0.0'
+  s.required_ruby_version = ">= 3.0.0"
 
   s.license = "MIT"
 
   s.add_dependency "gyoku", ">= 0.4.0"
   s.add_dependency "nokogiri"
   s.add_dependency "base64"
 
-  s.add_development_dependency "rake",    "~> 13.0"
-  s.add_development_dependency "rspec",   "~> 3.12"
+  s.add_development_dependency "rake", "~> 13.0"
+  s.add_development_dependency "rspec", "~> 3.12"
   s.add_development_dependency "timecop", "~> 0.5"
 
-  s.metadata = { "rubygems_mfa_required" => "true" }
+  s.metadata = {"rubygems_mfa_required" => "true"}
 
   s.files = Dir["lib/**/*"] + %w[CHANGELOG.md LICENSE README.md]
   s.require_paths = ["lib"]

lib/akami.rb

@@ -2,10 +2,8 @@
 require "akami/wsse"
 
 module Akami
-
   # Returns a new <tt>Akami::WSSE</tt>.
   def self.wsse
     WSSE.new
   end
-
 end

lib/akami/hash_helper.rb

@@ -3,9 +3,9 @@ module HashHelper
     # Returns a new Hash with +hash+ and +other_hash+ merged recursively.
     # Modifies +hash+ in place.
     def self.deep_merge!(hash, other_hash)
-      other_hash.each_pair do |k,v|
+      other_hash.each_pair do |k, v|
         tv = hash[k]
-        hash[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? deep_merge!(tv.dup, v) : v
+        hash[k] = (tv.is_a?(Hash) && v.is_a?(Hash)) ? deep_merge!(tv.dup, v) : v
       end
       hash
     end

lib/akami/version.rb

@@ -1,5 +1,3 @@
 module Akami
-
-  VERSION = '1.3.3'
-
+  VERSION = "1.3.3"
 end

lib/akami/wsse.rb

@@ -9,12 +9,10 @@
 require "akami/wsse/signature"
 
 module Akami
-
   # = Akami::WSSE
   #
   # Building Web Service Security.
   class WSSE
-
     # Namespace for WS Security Secext.
     WSE_NAMESPACE = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
 
@@ -94,11 +92,11 @@ def to_xml
       h = merge_hashes_with_keys(h, wsu_timestamp) if timestamp?
       h = merge_hashes_with_keys(h, wsse_username_token) if username_token?
 
-      return '' unless h
+      return "" unless h
       Gyoku.xml h
     end
 
-  private
+    private
 
     def merge_hashes_with_keys(hash_one, hash_two)
       return hash_two unless hash_one
@@ -116,14 +114,14 @@ def wsse_username_token
           "wsse:Nonce" => Base64.encode64(nonce).chomp,
           "wsu:Created" => timestamp,
           "wsse:Password" => digest_password,
-          :attributes! => { "wsse:Password" => { "Type" => PASSWORD_DIGEST_URI },  "wsse:Nonce" => { "EncodingType" => BASE64_URI } }
+          :attributes! => {"wsse:Password" => {"Type" => PASSWORD_DIGEST_URI}, "wsse:Nonce" => {"EncodingType" => BASE64_URI}}
         # clear the nonce after each use
         @nonce = nil
       else
         token = security_hash :wsse, "UsernameToken",
           "wsse:Username" => username,
           "wsse:Password" => password,
-          :attributes! => { "wsse:Password" => { "Type" => PASSWORD_TEXT_URI } }
+          :attributes! => {"wsse:Password" => {"Type" => PASSWORD_TEXT_URI}}
       end
       token
     end
@@ -146,23 +144,23 @@ def wsu_timestamp
 
     # Returns a Hash containing wsse/wsu Security details for a given
     # +namespace+, +tag+ and +hash+.
-    def security_hash(namespace, tag, hash, extra_info = {}, signature_request=false)
+    def security_hash(namespace, tag, hash, extra_info = {}, signature_request = false)
       key = [namespace, tag].compact.join(":")
 
       sec_hash = {
         "wsse:Security" => {
           key => hash,
           :order! => [key]
         },
-        :attributes! => { "wsse:Security" => { "xmlns:wsse" => WSE_NAMESPACE } }
+        :attributes! => {"wsse:Security" => {"xmlns:wsse" => WSE_NAMESPACE}}
       }
 
       sec_hash["wsse:Security"].merge!(extra_info) unless extra_info.empty?
 
       if signature_request
-        sec_hash[:attributes!].merge!("soapenv:mustUnderstand" => "1")
+        sec_hash[:attributes!]["soapenv:mustUnderstand"] = "1"
       else
-        sec_hash["wsse:Security"].merge!(:attributes! => { key => { "wsu:Id" => "#{tag}-#{count}", "xmlns:wsu" => WSU_NAMESPACE } })
+        sec_hash["wsse:Security"][:attributes!] = {key => {"wsu:Id" => "#{tag}-#{count}", "xmlns:wsu" => WSU_NAMESPACE}}
       end
 
       sec_hash

lib/akami/wsse/certs.rb

@@ -2,10 +2,9 @@ module Akami
   class WSSE
     # Contains certs for WSSE::Signature
     class Certs
-
       def initialize(certs = {})
         certs.each do |key, value|
-          self.send :"#{key}=", value
+          send :"#{key}=", value
         end
       end
 

lib/akami/wsse/signature.rb

@@ -23,14 +23,14 @@ def document=(document)
         @document = Nokogiri::XML(document)
       end
 
-      ExclusiveXMLCanonicalizationAlgorithm = 'http://www.w3.org/2001/10/xml-exc-c14n#'.freeze
-      RSASHA1SignatureAlgorithm = 'http://www.w3.org/2000/09/xmldsig#rsa-sha1'.freeze
-      SHA1DigestAlgorithm = 'http://www.w3.org/2000/09/xmldsig#sha1'.freeze
+      ExclusiveXMLCanonicalizationAlgorithm = "http://www.w3.org/2001/10/xml-exc-c14n#".freeze
+      RSASHA1SignatureAlgorithm = "http://www.w3.org/2000/09/xmldsig#rsa-sha1".freeze
+      SHA1DigestAlgorithm = "http://www.w3.org/2000/09/xmldsig#sha1".freeze
 
-      X509v3ValueType = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3'.freeze
-      Base64EncodingType = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary'.freeze
+      X509v3ValueType = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-x509-token-profile-1.0#X509v3".freeze
+      Base64EncodingType = "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-soap-message-security-1.0#Base64Binary".freeze
 
-      SignatureNamespace = 'http://www.w3.org/2000/09/xmldsig#'.freeze
+      SignatureNamespace = "http://www.w3.org/2000/09/xmldsig#".freeze
 
       def initialize(certs = Certs.new)
         @certs = certs
@@ -57,28 +57,28 @@ def security_token_id
       def body_attributes
         {
           "xmlns:wsu" => Akami::WSSE::WSU_NAMESPACE,
-          "wsu:Id" => body_id,
+          "wsu:Id" => body_id
         }
       end
 
       def to_token
         return {} unless have_document?
 
         sig = signed_info.merge(key_info).merge(signature_value)
-        sig.merge! :order! => []
-        [ "SignedInfo", "SignatureValue", "KeyInfo" ].each do |key|
+        sig[:order!] = []
+        ["SignedInfo", "SignatureValue", "KeyInfo"].each do |key|
           sig[:order!] << key if sig[key]
         end
 
         token = {
           "Signature" => sig,
-          :attributes! => { "Signature" => { "xmlns" => SignatureNamespace } },
+          :attributes! => {"Signature" => {"xmlns" => SignatureNamespace}}
         }
 
         Akami::HashHelper.deep_merge!(token, binary_security_token) if certs.cert
 
-        token.merge! :order! => []
-        [ "wsse:BinarySecurityToken", "Signature" ].each do |key|
+        token[:order!] = []
+        ["wsse:BinarySecurityToken", "Signature"].each do |key|
           token[:order!] << key if token[key]
         end
 
@@ -89,13 +89,13 @@ def to_token
 
       def binary_security_token
         {
-          "wsse:BinarySecurityToken" => Base64.encode64(certs.cert.to_der).gsub("\n", ''),
-          :attributes! => { "wsse:BinarySecurityToken" => {
+          "wsse:BinarySecurityToken" => Base64.encode64(certs.cert.to_der).delete("\n"),
+          :attributes! => {"wsse:BinarySecurityToken" => {
             "wsu:Id" => security_token_id,
-            'EncodingType' => Base64EncodingType,
-            'ValueType' => X509v3ValueType,
-            "xmlns:wsu" => Akami::WSSE::WSU_NAMESPACE,
-          } }
+            "EncodingType" => Base64EncodingType,
+            "ValueType" => X509v3ValueType,
+            "xmlns:wsu" => Akami::WSSE::WSU_NAMESPACE
+          }}
         }
       end
 
@@ -104,18 +104,18 @@ def key_info
           "KeyInfo" => {
             "wsse:SecurityTokenReference" => {
               "wsse:Reference/" => nil,
-              :attributes! => { "wsse:Reference/" => {
+              :attributes! => {"wsse:Reference/" => {
                 "ValueType" => X509v3ValueType,
-                "URI" => "##{security_token_id}",
-              } }
+                "URI" => "##{security_token_id}"
+              }}
             },
-            :attributes! => { "wsse:SecurityTokenReference" => { "xmlns:wsu" => "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd" } },
-          },
+            :attributes! => {"wsse:SecurityTokenReference" => {"xmlns:wsu" => "http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"}}
+          }
         }
       end
 
       def signature_value
-        { "SignatureValue" => the_signature }
+        {"SignatureValue" => the_signature}
       rescue MissingCertificate
         {}
       end
@@ -126,25 +126,25 @@ def signed_info
             "CanonicalizationMethod/" => nil,
             "SignatureMethod/" => nil,
             "Reference" => [
-              #signed_info_transforms.merge(signed_info_digest_method).merge({ "DigestValue" => timestamp_digest }),
-              signed_info_transforms.merge(signed_info_digest_method).merge({ "DigestValue" => body_digest }),
+              # signed_info_transforms.merge(signed_info_digest_method).merge({ "DigestValue" => timestamp_digest }),
+              signed_info_transforms.merge(signed_info_digest_method).merge({"DigestValue" => body_digest})
             ],
             :attributes! => {
-              "CanonicalizationMethod/" => { "Algorithm" => ExclusiveXMLCanonicalizationAlgorithm },
-              "SignatureMethod/" => { "Algorithm" => RSASHA1SignatureAlgorithm },
-              "Reference" => { "URI" => ["##{body_id}"] },
+              "CanonicalizationMethod/" => {"Algorithm" => ExclusiveXMLCanonicalizationAlgorithm},
+              "SignatureMethod/" => {"Algorithm" => RSASHA1SignatureAlgorithm},
+              "Reference" => {"URI" => ["##{body_id}"]}
             },
-            :order! => [ "CanonicalizationMethod/", "SignatureMethod/", "Reference" ],
-          },
+            :order! => ["CanonicalizationMethod/", "SignatureMethod/", "Reference"]
+          }
         }
       end
 
       def the_signature
         raise MissingCertificate, "Expected a private_key for signing" unless certs.private_key
         signed_info = at_xpath(@document, "//Envelope/Header/Security/Signature/SignedInfo")
         signed_info = signed_info ? canonicalize(signed_info) : ""
-        signature = certs.private_key.sign(OpenSSL::Digest::SHA1.new, signed_info)
-        Base64.encode64(signature).gsub("\n", '') # TODO: DRY calls to Base64.encode64(...).gsub("\n", '')
+        signature = certs.private_key.sign(OpenSSL::Digest.new("SHA1"), signed_info)
+        Base64.encode64(signature).delete("\n") # TODO: DRY calls to Base64.encode64(...).gsub("\n", '')
       end
 
       def body_digest
@@ -153,15 +153,15 @@ def body_digest
       end
 
       def signed_info_digest_method
-        { "DigestMethod/" => nil, :attributes! => { "DigestMethod/" => { "Algorithm" => SHA1DigestAlgorithm } } }
+        {"DigestMethod/" => nil, :attributes! => {"DigestMethod/" => {"Algorithm" => SHA1DigestAlgorithm}}}
       end
 
       def signed_info_transforms
-        { "Transforms" => { "Transform/" => nil, :attributes! => { "Transform/" => { "Algorithm" => ExclusiveXMLCanonicalizationAlgorithm } } } }
+        {"Transforms" => {"Transform/" => nil, :attributes! => {"Transform/" => {"Algorithm" => ExclusiveXMLCanonicalizationAlgorithm}}}}
       end
 
       def uid
-        OpenSSL::Digest::SHA1.hexdigest([Time.now, rand].collect(&:to_s).join('/'))
+        OpenSSL::Digest::SHA1.hexdigest([Time.now, rand].join("/"))
       end
     end
   end