har 0.0.1.dev

data/.gitignore

@@ -0,0 +1,4 @@
+pkg/*
+*.gem
+.bundle
+Gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2010 Jari Bakken
+
+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.
+
+harviewer by Jan Odvarko is covered by the New BSD License
+http://www.opensource.org/licenses/bsd-license.php
+http://code.google.com/p/harviewer/

data/README.mdown

@@ -0,0 +1,36 @@
+HAR
+===
+
+Ruby library to work with and view HTTP archives.
+This includes [harviewer](http://code.google.com/p/harviewer/), which can be launched through the "har" command.
+
+Usage
+=============
+
+    HAR::Archive.from_string(json) #=> #<Har::Archive:0x5e7cac>
+    HAR::Archive.from_file(path)   #=> #<Har::Archive:0x5e7cac>
+
+Or from command the command line:
+
+    har /path/to/some.har
+
+Links
+=====
+
+* [harviewer](http://code.google.com/p/harviewer/)
+
+Note on Patches/Pull Requests
+=============================
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+Copyright
+=========
+
+Copyright (c) 2010 Jari Bakken. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+desc 'Regenerate the schema files'
+task :schema do
+  require "json"
+  
+  out    = File.expand_path("../lib/har/schemas", __FILE__)
+  schema = JSON.parse(File.read("schema.json"))
+  
+  # cleanup
+  Dir[File.join(out, "*.json")].each { |f| 
+    rm f
+  }
+  
+  # generate
+  schema.each do |type, schema|
+    path = File.join(out, type)
+    puts path
+    
+    File.open(path, "w") { |file|
+      file << JSON.pretty_generate(schema)
+    }
+  end
+end

data/bin/har

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "har"
+HAR::Viewer.new(ARGV).show

data/har.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "har/version"
+
+Gem::Specification.new do |s|
+  s.name        = "har"
+  s.version     = HAR::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jari Bakken"]
+  s.email       = ["jari.bakken@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Ruby library to work with HTTP archives}
+  s.description = %q{Ruby library to work with HTTP archives}
+
+  s.rubyforge_project = "har"
+
+  s.add_dependency "json"
+  s.add_dependency "json-schema"
+  s.add_dependency "launchy"
+
+  s.add_development_dependency "rspec", "~> 2.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/har.rb

@@ -0,0 +1,32 @@
+require 'json'
+require 'json-schema'
+require 'time'
+
+module HAR
+  class Error < StandardError; end
+  class ValidationError < StandardError; end
+end
+
+require 'har/serializable'
+require 'har/schema_type'
+require 'har/page'
+require 'har/archive'
+require 'har/viewer'
+
+module Enumerable
+  def group_by
+    assoc = {}
+
+    each do |element|
+      key = yield(element)
+
+      if assoc.has_key?(key)
+        assoc[key] << element
+      else
+        assoc[key] = [element]
+      end
+    end
+
+    assoc
+  end unless [].respond_to?(:group_by)
+end

data/lib/har/archive.rb

@@ -0,0 +1,135 @@
+module HAR
+  class Archive
+    include Serializable
+
+    def self.from_string(str, uri = nil)
+      new JSON.parse(str), uri
+    end
+
+    def self.from_file(path)
+      from_string File.read(path), path
+    end
+
+    attr_reader :uri
+
+    def initialize(input, uri = nil)
+      @data = input
+      @uri   = uri
+    end
+
+    def pages
+      @pages ||= raw_log.fetch('pages').map { |page|
+        Page.new page, entries_for(page['id'])
+      }
+    end
+
+    def entries
+      @entries ||= raw_entries.map { |e| Entry.new(e) }
+    end
+
+    # create a new archive by merging this and another archive
+
+    def merge(other)
+      assert_archive other
+
+      data = deep_clone(@data)
+      merge_data data, other.as_json, other.uri
+
+      self.class.new data
+    end
+
+    # destructively merge this with the given archive
+
+    def merge!(other)
+      assert_archive other
+      clear_caches
+
+      merge_data @data, other.as_json, other.uri
+      nil
+    end
+
+    def save_to(path)
+      File.open(path, "w") { |io| io << @data.to_json }
+    end
+
+    def valid?
+      JSON::Validator.validate schema_file, @data
+    end
+
+    def validate!
+      JSON::Validator.validate2 schema_file, @data
+    rescue JSON::ValidationError => ex
+      # add archive uri to the message
+      if @uri
+        raise ValidationError, "#{@uri}: #{ex.message}"
+      else
+        raise ValidationError, ex.message
+      end
+    end
+
+    protected
+
+    private
+
+    def schema_file
+      @schema_file ||= File.expand_path("../schemas/logType", __FILE__)
+    end
+
+    def merge_data(left, right, uri)
+      log       = left.fetch('log')
+      other_log = right.fetch('log')
+
+      pages   = log.fetch('pages')
+      entries = log.fetch('entries')
+
+      other_pages = other_log.fetch("pages")
+      other_entries = other_log.fetch("entries")
+
+      if uri
+        deep_clone(other_pages).each do |page|
+          c = page['comment'] ||= ''
+          c << "(merged from #{File.basename uri})"
+
+          pages << page
+        end
+      else
+        pages.concat other_pages
+      end
+
+      entries.concat other_entries
+    end
+
+    def assert_archive(other)
+      unless other.kind_of?(self.class)
+        raise TypeError, "expected #{self.class}"
+      end
+    end
+
+    def clear_caches
+      @raw_entries = @entries_map = @pages = @entries = @log = nil
+    end
+
+    def entries_for(page_id)
+      entries = entries_map[page_id] || []
+      entries.map { |e| Entry.new(e) }
+    end
+
+    def raw_entries
+      @raw_entries ||= raw_log.fetch('entries')
+    end
+
+    def raw_log
+      @raw_log ||= @data.fetch 'log'
+    end
+
+    def entries_map
+      @entries_map ||= raw_entries.group_by { |e| e['pageref'] }
+    end
+
+    def deep_clone(obj)
+      Marshal.load Marshal.dump(obj)
+    end
+
+  end # Archive
+end # HAR
+

data/lib/har/page.rb

@@ -0,0 +1,19 @@
+module HAR
+  class Page < SchemaType
+
+    attr_reader :entries
+
+    def initialize(input, entries)
+      super(input)
+      @entries = entries
+    end
+
+    def title
+      @data.fetch 'title'
+    end
+
+    # a little sugar
+    alias_method :timings, :page_timings
+
+  end
+end

data/lib/har/schema_type.rb

@@ -0,0 +1,78 @@
+require "pp"
+
+module HAR
+  class SchemaType
+    include Serializable
+
+    class << self
+      private
+
+      def load_from(file)
+        schema = JSON.parse(File.read(file))
+
+        klass = Class.new(self) do
+          schema['properties'].each do |name, definition|
+            define_property name, definition
+          end
+        end
+
+        HAR.const_set type_name_from(schema['id']), klass
+      end
+
+      def define_property(name, definition)
+        required = definition['required']
+        type     = definition['type']
+
+        wrapper = extract_wrapper(name, definition)
+
+        fetch_code = required ? "@data.fetch(#{name.inspect})" : "@data[#{name.inspect}]"
+        fetch_code = "#{wrapper} #{fetch_code}" if wrapper
+
+        class_eval "
+          def #{snake_case name}
+            @#{name} ||= #{fetch_code}
+          end
+        "
+      end
+
+      def extract_wrapper(name, definition)
+        type = definition['type']
+
+        case type
+        when 'object'
+          return "#{name.capitalize}.new"
+        when 'string'
+          if definition['format'] == 'date-time'
+            return 'Time.parse'
+          end
+        when Hash
+          ref = type['$ref']
+        when nil
+          ref = definition['$ref']
+        end
+
+        "#{type_name_from(ref)}.new" if ref
+      end
+
+      def type_name_from(str)
+        t = str[/^(.+)Type/, 1] or raise Error, "could not extract type name from #{str.inspect}"
+        t[0] = t[0].chr.upcase
+
+        t
+      end
+
+      def snake_case(str)
+        str.gsub(/\B[A-Z][^A-Z]/, '_\&').downcase.gsub(' ', '_')
+      end
+    end
+
+    def initialize(data)
+      @data = data
+    end
+
+    # load in schemas
+    Dir[File.expand_path("../schemas/*", __FILE__)].each do |file|
+      load_from file
+    end
+  end # SchemaType
+end # HAR

data/lib/har/schemas/browserType

@@ -0,0 +1,19 @@
+{
+  "id": "browserType",
+  "description": "Name and version info of used browser.",
+  "type": "object",
+  "optional": true,
+  "properties": {
+    "name": {
+      "type": "string",
+      "required": true
+    },
+    "version": {
+      "type": "string",
+      "required": true
+    },
+    "comment": {
+      "type": "string"
+    }
+  }
+}

data/lib/har/schemas/cacheEntryType

@@ -0,0 +1,25 @@
+{
+  "id": "cacheEntryType",
+  "optional": true,
+  "description": "Info about cache entry.",
+  "properties": {
+    "expires": {
+      "type": "string"
+    },
+    "lastAccess": {
+      "type": "string",
+      "required": true
+    },
+    "eTag": {
+      "type": "string",
+      "required": true
+    },
+    "hitCount": {
+      "type": "integer",
+      "required": true
+    },
+    "comment": {
+      "type": "string"
+    }
+  }
+}