akamai_rspec 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d43da91b99bffdb375af2895ae8c06ee21ef5c2b
-  data.tar.gz: 0e2550fbd977588675e38cdeafd3c2c2d98b3fea
+  metadata.gz: 26b9891b50b16db2cb6b518794ee939ab864f9e4
+  data.tar.gz: 4c46663b9c2ba79788fc98a846c519585483f66e
 SHA512:
-  metadata.gz: 8e830785e239ca8a42dbbd2fbbad8c3f265a2de8a8c720a04dd16ad4c03fbcc2e164583aaaa80ab01d376b5f1e483cd1f0c967b211a81b8d7a39e3ab7c6f0d0f
-  data.tar.gz: 158112f7fd65328f5804e93340412f321103045bb67f3ac4772a55591318b3a3e3ddf8e82e4cc74d00ce87e63d87b9cab2c02e2824b63c84529cf09bf9876657
+  metadata.gz: 34b3ec6371e11c316c90346745ef568192a5ef18f1ca7c5b09510f7add7cbd2fddd8699e82db4114fcc50c16878b7c8cbcaeb1a6d69c8b2704aa5b9dac96a772
+  data.tar.gz: 898b11a2d6c01868cfffd6594c6aa14521da6563711a9e223201ddc7d460dca904f233bff5a2bf039e0d562b7216cb981d5216ecb7dc9fb4926861eab4ab630d

data/lib/akamai_rspec/akamai_headers.rb

@@ -1,5 +1,5 @@
 module AkamaiHeaders
-  def akamai_debug_headers
+  def self.akamai_debug_headers
     {
       pragma: 'akamai-x-cache-on, akamai-x-cache-remote-on, akamai-x-check-cacheable, akamai-x-get-cache-key, akamai-x-get-extracted-values, akamai-x-get-nonces, akamai-x-get-ssl-client-session-id, akamai-x-get-true-cache-key, akamai-x-serial-no'
     }

data/lib/akamai_rspec/matchers/caching.rb

@@ -3,7 +3,7 @@ require 'securerandom'
 
 RSpec::Matchers.define :be_cacheable do
   match do |url|
-    response = RestClient::Request.responsify url
+    response = AkamaiRSpec::Request.get url
     x_check_cacheable(response, 'YES')
     response.code == 200
   end
@@ -15,7 +15,7 @@ end
 
 RSpec::Matchers.define :have_no_cache_set do
   match do |url|
-    response = RestClient::Request.responsify url
+    response = AkamaiRSpec::Request.get url
     cache_control = response.headers[:cache_control]
     fail('Cache-Control has been set') unless cache_control == 'no-cache'
     true
@@ -24,21 +24,22 @@ end
 
 RSpec::Matchers.define :not_be_cached do
   match do |url|
-    response = RestClient::Request.responsify url
+    response = AkamaiRSpec::Request.get url
     x_check_cacheable(response, 'NO')
-    response = RestClient::Request.responsify response.args[:url]  # again to prevent spurious cache miss
+    response = AkamaiRSpec::Request.get url  # again to prevent spurious cache miss
 
     not_cached = response.headers[:x_cache] =~ /TCP(\w+)?_MISS/
-    unless not_cached
+    if not_cached
+      true
+    else
       fail("x_cache header does not indicate an origin hit: '#{response.headers[:x_cache]}'")
     end
-    response.code == 200 && not_cached
   end
 end
 
 RSpec::Matchers.define :be_tier_distributed do
   match do |url|
-    response = RestClient::Request.request_cache_miss(url)
+    response = AkamaiRSpec::Request.get_cache_miss(url)
     tiered = !response.headers[:x_cache_remote].nil?
     fail('No X-Cache-Remote header in response') unless tiered
     response.code == 200 && tiered

data/lib/akamai_rspec/matchers/honour_origin_headers.rb

@@ -9,7 +9,7 @@ RSpec::Matchers.define :honour_origin_cache_headers do |origin, headers|
   fail("Headers must be one of: #{header_options}") unless header_options.include? headers
 
   match do |url|
-    akamai_response = RestClient::Request.responsify url
+    akamai_response = AkamaiRSpec::Request.get url
     origin_response = origin_response(origin)
     check_cache_control(origin_response, akamai_response, headers)
     check_expires(origin_response, akamai_response, headers)
@@ -18,7 +18,7 @@ RSpec::Matchers.define :honour_origin_cache_headers do |origin, headers|
 end
 
 def fix_date_header(origin_response)
-  origin_response.headers[:date] = Time.now.httpdate unless origin_response.headers[:date]
+  origin_response.headers[:date] ||= Time.now.httpdate
   origin_response
 end
 

data/lib/akamai_rspec/matchers/matchers.rb

@@ -4,60 +4,9 @@ require_relative 'redirects'
 require_relative 'caching'
 require_relative 'non_akamai'
 require_relative 'honour_origin_headers'
+require_relative 'x_cache_headers'
 include AkamaiHeaders
 
-X_CACHE_HEADERS = [:x_true_cache_key, :x_cache_key]
-
-RSpec::Matchers.define :be_served_from_origin do |contents|
-  match do |url|
-    response = RestClient::Request.responsify url
-    return true if x_cache_headers_from_origin(response, contents)
-    missing_x_cache_error(response, contents)
-    expect(response).to be_successful
-    has_x_cache_headers(response)
-  end
-end
-
-RSpec::Matchers.define :have_cp_code do |contents|
-  match do |url|
-    response = RestClient::Request.responsify url
-    has_x_cache_headers(response)
-    return true if x_cache_headers_contain(response, contents)
-    missing_x_cache_error(response, contents)
-    expect(response).to be_successful
-  end
-end
-
-def has_x_cache_headers(response)
-  unless X_CACHE_HEADERS.inject(false) { |bool, header| bool || response.headers.include?(header) }
-    fail "Response does not contain the debug headers"
-  end
-end
-
-def x_cache_headers_contain(response, contents)
-  X_CACHE_HEADERS.each do |key|
-    return true if response.headers[key] && response.headers[key].include?(contents)
-  end
-  false
-end
-
-
-def x_cache_headers_from_origin(response, contents)
-  X_CACHE_HEADERS.each do |key|
-    header = response.headers[key]
-    return true if (header && header =~ /\/#{contents}\//)
-  end
-  return false
-end
-
-def missing_x_cache_error(response, contents)
-  X_CACHE_HEADERS.each do |key|
-    if (response.headers[key])
-      fail("#{key} has value '#{response.headers[key]}' which doesn't match '#{contents}'")
-    end
-  end
-end
-
 RSpec::Matchers.define :be_forwarded_to_index do |channel|
   match do |url|
     response = RestClient.get(url, akamai_debug_headers)

data/lib/akamai_rspec/matchers/non_akamai.rb

@@ -32,7 +32,7 @@ end
 
 RSpec::Matchers.define :be_successful do
   match do |url|
-    response = RestClient::Request.responsify url
+    response = AkamaiRSpec::Request.get url
     fail('Response was not successful') unless response.code == 200
     true
   end
@@ -51,17 +51,25 @@ end
 
 RSpec::Matchers.define :be_gzipped do
   match do |response_or_url|
-    response = RestClient::Request.responsify response_or_url
+    response = AkamaiRSpec::Request.get_decode response_or_url
     response.headers[:content_encoding] == 'gzip'
   end
 end
 
 RSpec::Matchers.define :have_cookie do |cookie|
   match do |response_or_url|
-    response = RestClient::Request.responsify response_or_url
+    response = AkamaiRSpec::Request.get response_or_url
     unless response.cookies[cookie]
       fail("Cookie #{cookie} not in #{response.cookies}")
     end
     response.cookies[cookie]
   end
 end
+
+RSpec::Matchers.define :be_forbidden do
+  match do |url|
+    response = AkamaiRSpec::Request.get url
+    fail('Response was not forbidden') unless response.code == 403
+    true
+  end
+end

data/lib/akamai_rspec/matchers/x_cache_headers.rb

@@ -0,0 +1,29 @@
+require 'rspec'
+
+module AkamaiRSpec
+  module Helpers
+    X_CACHE_HEADERS = [:x_true_cache_key, :x_cache_key]
+
+    def x_cache_headers
+      X_CACHE_HEADERS
+    end
+  end
+end
+
+RSpec::Matchers.define :be_served_from_origin do |contents|
+  include AkamaiRSpec::Helpers
+  match do |url|
+    response = AkamaiRSpec::Request.get url
+    response.headers.any? { |key, value| x_cache_headers.include?(key) && value =~ /\/#{contents}\// } && \
+      response.code == 200
+  end
+end
+
+RSpec::Matchers.define :have_cp_code do |contents|
+  include AkamaiRSpec::Helpers
+  match do |url|
+    response = AkamaiRSpec::Request.get url
+    response.headers.any? { |key, value| x_cache_headers.include?(key) && value == contents } && \
+      response.code == 200
+  end
+end

data/lib/akamai_rspec/request.rb

@@ -1,89 +1,99 @@
 require 'rest-client'
-require 'akamai_rspec'
+require 'forwardable'
 
-module RestClient
+module AkamaiRSpec
   class Request
-    @@akamai_network = 'prod'
-    @@akamai_stg_domain = 'overwrite me'
-    @@akamai_prod_domain = 'overwrite me'
-
-    def self.domain
-      env = @@akamai_network
-      case env.downcase
-      when 'staging'
-        @@akamai_stg_domain
-      else
-        @@akamai_prod_domain
-      end
-    end
+    extend Forwardable
 
-    def self.akamai_network(env)
-      @@akamai_network = env
-    end
+    @@akamai_stg_domain = nil
+    @@akamai_prod_domain = nil
 
-    def self.stg_domain(domain)
+    def self.stg_domain=(domain)
       @@akamai_stg_domain = domain
     end
 
-    def self.prod_domain(domain)
+    def self.prod_domain=(domain)
       @@akamai_prod_domain = domain
     end
 
-    def self.http_url(url)
-      url = "/#{url}" unless url.start_with?('/')
-      "http://#{domain}#{url}"
+    def self.network=(env)
+      @@env = env
     end
 
-    def self.https_url(url)
-      url = "/#{url}" unless url.start_with?('/')
-      "https://#{domain}#{url}"
+    def self.get(url)
+      new.get(url)
     end
 
-    # Define the Host header and join the Akamai headers
-    def self.options
-      akamai_debug_headers
+    def self.get_with_debug_headers(url)
+      new.get(url, AkamaiHeaders.akamai_debug_headers)
     end
 
-    # Make requests to the right network
-    def self.http_get(url, options, cookies = {})
-      do_get(url, options, cookies, false)
+    def self.get_cache_miss(url)
+      url += url.include?('?') ? '&' : '?'
+      url += SecureRandom.hex
+      new.get(url, AkamaiHeaders.akamai_debug_headers)
     end
 
-    def self.https_get(url, options, cookies = {})
-      do_get(url, options, cookies, true)
+    def self.get_decode(url)
+      response = new.get(url, AkamaiHeaders.akamai_debug_headers)
+      RestClient::Request.decode(response.headers[:content_encoding], response.body)
+      response
     end
 
-    def self.do_get(url, options, cookies = {}, is_secure)
-      if is_secure
-        base_url = https_url(url)
-      else
-        base_url = http_url(url)
-      end
-      headers = options.merge(akamai_debug_headers).merge(cookies)
-      do_get_no_ssl(base_url, headers) { |response, _, _| response }
-    end
+    def initialize
+      @@env ||= 'prod'
+
+      @domain = case @@env.downcase
+                when 'staging'
+                  if @@akamai_stg_domain.nil?
+                    raise ArgumentError.new(
+                      "You must set the prod domain: AkamaiRSpec::Request.stg_domain = 'www.example.com.edgesuite.net'"
+                    )
+                  end
+
+                  @@akamai_stg_domain
+                else
+                  if @@akamai_prod_domain.nil?
+                    raise ArgumentError.new(
+                      "You must set the prod domain: AkamaiRSpec::Request.prod_domain = 'www.example.com.edgesuite.net'"
+                    )
+                  end
+
+                  @@akamai_prod_domain
+                end
 
-    def self.do_get_no_ssl(url, additional_headers = {}, &block)
-      headers = (options[:headers] || {}).merge(additional_headers)
-      RestClient::Request.execute(options.merge(
-        method: :get,
-        url: url,
-        verify_ssl: false,
-        headers: headers), &(block || @block))
+      @rest_client = RestClient::Request.new(method: :get,
+                                              url: 'fakeurl.com',
+                                              verify_ssl: false)
     end
 
-    def self.responsify(maybe_a_url)
-      if maybe_a_url.is_a? RestClient::Response
-        maybe_a_url
-      else
-        RestClient.get(maybe_a_url, akamai_debug_headers)
+    delegate [:parse_url_with_auth, :stringify_headers] => :@rest_client
+
+    def get(url, headers = {})
+      if url.is_a? RestClient::Response
+        warn 'This functionality is deprecated and will be removed in the next release'
+        return AkamaiRSpec::Response.new(url)
+      end
+
+      uri = parse_url_with_auth(url)
+
+      req = build_request(uri, stringify_headers(headers))
+
+      req['Host'] = uri.hostname
+      uri.hostname = @domain
+
+      response = Net::HTTP.start(uri.hostname, uri.port) do |http|
+        http.request(req, nil) { |http_response| http_response }
       end
+
+      AkamaiRSpec::Response.new(response)
     end
 
-    def self.request_cache_miss(url)
-      url += url.include?('?') ? '&' : '?'
-      url += SecureRandom.hex
-      RestClient.get(url, akamai_debug_headers)
+    def build_request(uri, headers)
+      req = Net::HTTP::Get.new(uri)
+      headers.each { |key, value| req.send(:[]=, key, value) }
+
+      req
     end
   end
 end

data/lib/akamai_rspec/response.rb

@@ -0,0 +1,45 @@
+module AkamaiRSpec
+  class Response
+    def initialize(response)
+      @response = response
+    end
+
+    def headers
+      headers = Hash[@response.to_hash.map{ |k, v| [k.gsub(/-/,'_').downcase.to_sym, v] }]
+      headers.each do |k, v|
+        if v.is_a?(Array) && v.size == 1
+          headers[k] = v.first
+        end
+      end
+
+      headers
+    end
+
+    def code
+      @response.code.to_i
+    end
+
+    def cookies
+      cookie_header = headers.to_hash[:set_cookie]
+      if cookie_header
+        if cookie_header.is_a?(Array)
+          cookies_string = cookie_header.collect do |header_value|
+            header_value.split('; ')
+          end
+          cookies_string.flatten!
+          cookies_array = cookies_string.collect { |c| c.split('=') }
+        else
+          cookies_array = [cookie_header.split('=')]
+        end
+
+        Hash[cookies_array]
+      else
+        {}
+      end
+    end
+
+    def method_missing(method, *args)
+      @response.send(method, *args)
+    end
+  end
+end

data/lib/akamai_rspec.rb

@@ -1,3 +1,4 @@
 require 'akamai_rspec/akamai_headers'
 require 'akamai_rspec/matchers/matchers'
 require 'akamai_rspec/request'
+require 'akamai_rspec/response'

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: akamai_rspec
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Bianca Gibson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-27 00:00:00.000000000 Z
+date: 2016-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.2'
 description: Test your akamai configuration with rspec
@@ -65,7 +65,9 @@ files:
 - lib/akamai_rspec/matchers/matchers.rb
 - lib/akamai_rspec/matchers/non_akamai.rb
 - lib/akamai_rspec/matchers/redirects.rb
+- lib/akamai_rspec/matchers/x_cache_headers.rb
 - lib/akamai_rspec/request.rb
+- lib/akamai_rspec/response.rb
 homepage: https://github.com/realestate-com-au/akamai-rspec
 licenses:
 - MIT
@@ -76,17 +78,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Test your akamai configuration with rspec