cachewarp 0.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cachewarp.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 codeweft
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+# CacheWarp
+
+Gem targeted towards providing a solution to verify cache headers for content delivery services like Akamai
+
+## Usage
+
+    require 'cachewarp'                                 #Require CacheWarp in your file
+    request = CacheWarp.new('http://www.akamai.com/')   #Initialize Request Object
+    request.fetch                                       #Fetch Request
+    request.response_headers                            #Get Response Headers
+    request.is_cached?                                  #Verify 'TCP HIT' i.e if Akamai is caching the request
+
+## Installation
+
+Using Bundler
+
+    gem 'cachewarp' #Add to Gemfile
+    $ bundle        #Install Gem
+
+Using gem command
+
+    $ gem install cachewarp
+
+#Change Log:
+
+0.0.1
+    Provision to verify TCP HIT in Akamai cache
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/cachewarp'
+  t.test_files = FileList['test/lib/cachewarp/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/cachewarp.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cachewarp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cachewarp"
+  spec.version       = GEM_VERSION
+  spec.authors       = ["codeweft", "bitweft", "juteroot"]
+  spec.email         = ["juteroot@gmail.com"]
+  spec.description   = %q{Gem to verify cache and content delivery headers}
+  spec.summary       = %q{Gem to verify cache and content delivery headers}
+  spec.homepage      = "http://www.juteroot.com"
+  spec.license       = "To be decided"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/cachewarp.rb

@@ -0,0 +1,40 @@
+require_relative 'cachewarp/version'
+require_relative 'cachewarp/web_service'
+
+class CacheWarp < WebService
+  attr_reader :uri, :response_headers, :headers, :failures
+
+  def initialize uri=nil
+    @uri = uri
+    @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'
+        }
+    @expected_response_headers =
+        {
+            'x-cache' => /TCP(.*)HIT(.*)from(.*)AkamaiGHost(.*)/
+        }
+    @failures = {}
+    @response_headers = {}
+  end
+
+  def set_response_headers headers
+    headers.each_header do |attr, value|
+      @response_headers[attr] = value
+    end
+  end
+
+  def fetch uri=@uri, headers=@headers
+    @url = uri
+    @headers= headers
+    set_response_headers(get_uri(uri, headers).header)
+    self
+  end
+
+  def is_cached?
+    @response_headers.each do |attr, value|
+      @failures[attr] = "Expected= #{@expected_response_headers[attr]}, Actual= #{value}" unless  @expected_response_headers[attr].nil? || value.match(@expected_response_headers[attr])
+    end
+    return ((@failures.empty?) ? true : false)
+  end
+end

data/lib/cachewarp/version.rb

@@ -0,0 +1 @@
+GEM_VERSION = '0.0.1'

data/lib/cachewarp/web_service.rb

@@ -0,0 +1,29 @@
+require 'net/http'
+
+class WebService
+  attr_accessor :headers,:uri
+
+  def service_request(host, port, request, use_ssl=false)
+    begin
+      http = Net::HTTP.new(host, port)
+      if use_ssl
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.use_ssl = true
+      end
+      http.start { |htttp| htttp.request(request) }
+    rescue Exception => ex
+      raise "Unable to fetch #{@uri.request_uri}. Check if site is up and running"
+    end
+  end
+
+  def get(host, port, endpoint, headers)
+    request = Net::HTTP::Get.new(endpoint, headers)
+    response = service_request(host, port, request)
+    response
+  end
+
+  def get_uri uri, headers
+    @uri = URI.parse(uri)
+    get(@uri.host, @uri.port, @uri.path, headers)
+  end
+end

data/test/lib/cachewarp/akamai_test.rb

@@ -0,0 +1,10 @@
+require_relative '../../test_helper'
+
+describe CacheWarp do
+  it "is akamai caching" do
+    request = CacheWarp.new('http://www.akamai.com/')
+    request.fetch
+    pp request.response_headers
+    request.is_cached?.must_equal true
+  end
+end

data/test/lib/cachewarp/version_test.rb

@@ -0,0 +1,7 @@
+require_relative '../../test_helper'
+
+describe CacheWarp do
+  it "must be defined" do
+    GEM_VERSION.wont_be_nil
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require File.expand_path('../../lib/cachewarp.rb', __FILE__)
+require 'pp'

data/thanks.txt

@@ -0,0 +1,5 @@
+Many Thanks:
+    Gem Creation Help: http://net.tutsplus.com/tutorials/ruby/gem-creation-with-bundler/
+    Akamai
+        Samples: http://esi-examples.akamai.com/
+        Pragma Headers: http://mesmor.com/2012/03/18/akamai-pragma-debug-headers/

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: cachewarp
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- codeweft
+- bitweft
+- juteroot
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem to verify cache and content delivery headers
+email:
+- juteroot@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cachewarp.gemspec
+- lib/cachewarp.rb
+- lib/cachewarp/version.rb
+- lib/cachewarp/web_service.rb
+- test/lib/cachewarp/akamai_test.rb
+- test/lib/cachewarp/version_test.rb
+- test/test_helper.rb
+- thanks.txt
+homepage: http://www.juteroot.com
+licenses:
+- To be decided
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 138774292347802239
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 138774292347802239
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Gem to verify cache and content delivery headers
+test_files:
+- test/lib/cachewarp/akamai_test.rb
+- test/lib/cachewarp/version_test.rb
+- test/test_helper.rb