http_archive 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MTFmYzE0ZGM5ZGNjNzdhZmU2ZjJiMWY2OTdkZGYwN2UzNzg4YWE3ZA==
+  data.tar.gz: !binary |-
+    N2E1NTIyOWQ2MWY0NmZlZmFhNGI0MDBhNGU0YmMxMjRkNzMxOWQ4Yw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NjY0YjU3NDg2NThhYzFmNDYyYmMyOTg3Yzc4YjgyOGMyMDQ1NWQ0YmQ5YjU0
+    MWRiMGY3MDExMTEzZjU5ZjRjMWRmNjhjZjFjNTNjYjA1ZGM0OWZhNWM3MzE0
+    NGVkYjJiOWEyZTZlZGVkMmUxYjc0YzRiZmFiNTk2NWM4OGFiYjc=
+  data.tar.gz: !binary |-
+    ZTcwNmRhYTcxYzEyMDRhZjdiMDQ2YjMyZDdhODY0NjljMjg2Y2FhNGY0MTk0
+    ODllMzAwM2JlOWMyN2Y4ZTgxNjUyZDA1YmE1NzZhNTY4Njc5OTU4ZDUxMjhi
+    NTVjOTRhZjU5ODhkMWFiYjZhMmU0NmU3ZjQ2ODA2N2E1ZDk3Yjk=

data/lib/http_archive.rb

@@ -0,0 +1,7 @@
+require 'json'
+require 'http_archive/version'
+require 'http_archive/archive'
+require 'http_archive/classes'
+
+module HttpArchive
+end

data/lib/http_archive/archive.rb

@@ -0,0 +1,178 @@
+# Module that holds all other classes.
+# Nothing to see here...
+module HttpArchive
+  ##
+  # The main object to interact with.
+  # All accessible objects (see below) hold further information about the archive.
+  #
+  class Archive
+
+    # Returns the 'Creator' object with data of the creator of the archive (Firebug etc.)
+    # @return [Creator]
+    attr_reader :creator
+    # Returns the 'Browser' object with data of the browser
+    # @return [Browser]
+    attr_reader :browser
+    # Returns general information about the page interaction as an array of 'Page' objects, normally just one entry
+    # @return [Array<Page>]
+    attr_reader :pages
+    # Returns all browser interactions with the page as an array of 'Entry' objects
+    # @return [Array<Entry>]
+    attr_reader :entries
+    # For internal use, holds the parsed JSON-data
+    # @return [Hash]
+    attr_writer :content
+
+    # Creates a new Archive object with given input.
+    # @param src [String,File] must be object type String or File
+    # @raise [ArgumentError, JSON::ParserError]
+    def initialize(src)
+      unless src.is_a?(File) || src.is_a?(String)
+        puts 'Argument must be String or File!'
+        raise ArgumentError
+      end
+      src = src.read if src.is_a?(File)
+      begin
+        @content = JSON.parse(src)
+      rescue
+        puts "The input could not be parsed."
+        raise JSON::ParserError
+      end
+      extract_creator
+      extract_browser
+      extract_pages
+      extract_entries
+    end
+
+
+    # Prints a table representation of the Http Archive to STDOUT.
+    # An example is given on the README-file.
+    # Columns are like the "Network"-view of Firebug or Chrome Dev tools.
+    #
+    # @return [String] A string table representation of the archive data
+    def print_table
+      puts
+      size = calc_total_size.to_s
+      load_time = (@pages.first.on_load / 1000.0).to_s
+
+      puts("Metrics for: " +"'" + @pages.first.title + "', " + @entries.size.to_s + " Requests, " + size + "MB downloaded. "  + "Load time: " + load_time + "s")
+      puts
+
+      @entries.each do |entry|
+        print_row(entry)
+      end
+      puts
+    end
+
+
+    private
+      def print_row(entry)
+        method = entry.request.http_method
+        url = entry.request.url
+        if url.end_with?("/")
+          ressource = entry.request.url
+        else
+          r = url.rindex("/")
+          ressource = url[r..-1]
+        end
+        ressource = ressource[0, 30]
+        status = entry.response.status.to_s
+        code = entry.response.status_text
+        size = (entry.response.content['size'] / 1000.0).round(2).to_s
+        duration = (entry.time / 1000.0).to_s
+
+        puts "%s %-32s %s %-20s %-10s %s" % [method, ressource, status, code, size + " KB", duration +"s"]
+      end
+
+      def calc_total_size
+        total = 0
+        @entries.each do |entry|
+          total = total + entry.response.content['size']
+        end
+        total = total / (1024.0 * 1024)
+        total.round(2)
+      end
+
+      def extract_creator
+        creator = HttpArchive::Creator.new
+        creator.name = @content['log']['creator']['name']
+        creator.version = @content['log']['creator']['version']
+        @creator = creator
+      end
+
+      def extract_browser
+        browser = HttpArchive::Browser.new
+        browser.name = @content['log']['browser']['name']
+        browser.version = @content['log']['browser']['version']
+        @browser = browser
+      end
+
+      def extract_pages
+        pages = []
+        hash_pages = @content['log']['pages']
+        hash_pages.each do |page|
+          new_page = Page.new
+          new_page.started_datetime = page['startedDateTime']
+          new_page.id               = page['id']
+          new_page.title            = page['title']
+          new_page.on_content_load  = page['pageTimings']['onContentLoad']
+          new_page.on_load          = page['pageTimings']['onLoad']
+          pages << new_page
+        end
+        @pages = pages
+      end
+
+      def extract_entries
+        entries = []
+        entries_hash = @content['log']['entries']
+        entries_hash.each do |entry|
+          new_entry = Entry.new
+          new_entry.pageref = entry['pageref']
+          new_entry.started_datetime = entry['startedDateTime']
+          new_entry.time = entry['time']
+          new_entry.cache = entry['cache']
+          new_entry.timings = entry['timings']
+          new_entry.server_ip_address = entry['serverIPAddress']
+          new_entry.connection = entry['connection']
+
+          new_request = Request.new
+          new_request.http_method = entry['request']['method']
+          new_request.url = entry['request']['url']
+          new_request.http_version = entry['request']['httpVersion']
+          new_request.cookies = entry['request']['cookies']
+          new_request.query_string = entry['request']['queryString']
+          new_request.headers_size = entry['request']['headersSize']
+          new_request.body_size = entry['request']['bodySize']
+          header_hash = {}
+          entry['request']['headers'].each do |info|
+            header_hash[info['name']] = info['value']
+          end
+          new_request.headers = header_hash
+
+
+          new_response = Response.new
+          new_response.status = entry['response']['status']
+          new_response.status_text = entry['response']['statusText']
+          new_response.http_version = entry['response']['httpVersion']
+          new_response.cookies = entry['response']['cookies']
+          new_response.content = entry['response']['content']
+          new_response.redirect_url = entry['response']['redirectURL']
+          new_response.headers_size = entry['response']['headersSize']
+          new_response.body_size = entry['response']['bodySize']
+          header_hash = {}
+          entry['response']['headers'].each do |info|
+            header_hash[info['name']] = info['value']
+          end
+          new_response.headers = header_hash
+
+
+          new_entry.request = new_request
+          new_entry.response = new_response
+          entries << new_entry
+        end
+        @entries = entries
+      end
+
+
+  end
+end

data/lib/http_archive/classes.rb

@@ -0,0 +1,141 @@
+module HttpArchive
+
+  # Container for information about the HTTP Archive creator.
+  class Creator
+    # Returns the name of the creator of the HTTP Archive
+    # @return [String] String with creator name, e.g. "Firebug"
+    attr_accessor :name
+    # Returns the version of the creator of the HTTP Archive
+    # @return [String] String with creator version, e.g. "1.11"
+    attr_accessor :version
+  end
+
+  # Container for browser-related information.
+  class Browser
+    # Returns the name of the browser the page was loaded
+    # @return [String] String with browser name, e.g. "Firefox"
+    attr_accessor :name
+    # Returns the version of the browser the page was loaded
+    # @return [String] String with browser version, e.g. "21.0"
+    attr_accessor :version
+  end
+
+  # Holds general data of the page and its loading process
+  class Page
+    # Returns the datetime as string when loading of the page started
+    # @return [String] datetime-string, e.g. "2013-05-28T22:16:19.883+02:00"
+    attr_accessor :started_datetime
+    # Returns the id of the page
+    # @return [String] page id as string, e.g. "page_50735"
+    attr_accessor :id
+    # Returns the title of the page
+    # @return [String] page title as string, e.g. "Software is hard"
+    attr_accessor :title
+    # Returns the amount of milliseconds sice the page load started and the content is loaded
+    # @return [Fixnum] milliseconds content is loaded, e.g. 4994
+    attr_accessor :on_content_load
+    # Returns the amount of milliseconds sice the page load started and the page itself is loaded
+    # @return [Fixnum] milliseconds page is loaded, e.g. 6745
+    attr_accessor :on_load
+  end
+
+  # Holds information for every single interaction of the browser with the page.
+  # Entry objects hold the request and response data in seperate objects.
+  class Entry
+    # Returns the reference to the parent page
+    # @return [String] ref to parent page as string, e.g. "page_50735"
+    attr_accessor :pageref
+    # Returns the datetime as string when loading of this element started
+    # @return [String] datetime-string, e.g. "2013-05-28T22:16:19.883+02:00"
+    attr_accessor :started_datetime
+    # Duration of the load time of this interaction
+    # @return [Fixnum] elapsed time of this request in milliseconds
+    attr_accessor :time
+    # Request data for this interaction
+    # @return [Request] 'Request' object with request-related data
+    attr_accessor :request
+    # Response data for this interaction
+    # @return [Response] 'Response' object with response-related data
+    attr_accessor :response
+    # Info about cache usage for this interaction
+    # @return [Hash] data about cache usage as a hash
+    attr_accessor :cache
+    # Info about Request/Response round trip
+    # @return [Hash] timings data as a hash
+    # @example
+    #   {"blocked"=>15, "dns"=>0, "connect"=>0, "send"=>0, "wait"=>39, "receive"=>0}
+    attr_accessor :timings
+    # IP address of the server
+    # @return [String] ip address as string, e.g. "91.239.200.165"
+    attr_accessor :server_ip_address
+    # Client or server port number
+    # @return [String] port number as string, e.g. "80"
+    attr_accessor :connection
+  end
+
+  # Holds information about the performed request in an interaction
+  class Request
+    # The method of this request
+    # @return [String] request method as string, e.g. "GET"
+    attr_accessor :http_method
+    # The absolute url of the request
+    # @return [String] url as string, e.g. "http://www.spiegel.de/layout/css/style-V3-23.css"
+    attr_accessor :url
+    # The HTTP version of this request
+    # @return [String] HTTP version as string, e.g. "HTTP/1.1"
+    attr_accessor :http_version
+    # A list of cookie objects for this request
+    # @return [Array] list of cookie objects as an array
+    attr_accessor :cookies
+    # A list of query parameters for this request
+    # @return [Array] list of query parameters as an array
+    attr_accessor :query_string
+    # The headers of this request
+    # @return [Hash] header objects (strings) as a hash
+    # @example
+    #   {"Host"=>"...", "User-Agent"=>"...", "Accept"=>"...", "Accept-Language"=>"...", "Accept-Encoding"=>"...", "Connection"=>"..."}
+    attr_accessor :headers
+    # Size of the request header
+    # @return [Fixnum] header size of this request in bytes, -1 if not available
+    attr_accessor :headers_size
+    # Size of the request body (POST data payload)
+    # @return [Fixnum] body size of this request in bytes, -1 if not available
+    attr_accessor :body_size
+  end
+
+  # Holds information about the response for an interaction
+  class Response
+    # The status of this request
+    # @return [Fixnum] response status as number, e.g. 200
+    attr_accessor :status
+    # The status of this request as text description
+    # @return [String] response status as string, e.g. "OK"
+    attr_accessor :status_text
+    # The HTTP version of this response
+    # @return [String] HTTP version as string, e.g. "HTTP/1.1"
+    attr_accessor :http_version
+    # A list of cookie objects for this response
+    # @return [Array] list of cookie objects as an array
+    attr_accessor :cookies
+    # The headers of this response
+    # @return [Hash] header objects (strings) as a hash
+    # @example
+    #   {"Date"=>"...", "Server"=>"...", "Location"=>"...", "Cache-Control"=>"...", "Expires"=>"...", "Content-Length"=>"...", "Keep-Alive"=>"...", "Connection"=>"...", "Content-Type"=>"..."}
+    attr_accessor :headers
+    # Size of the response header
+    # @return [Fixnum] header size of this response in bytes, -1 if not available
+    attr_accessor :headers_size
+    # Size of the response body
+    # @return [Fixnum] body size of this request in bytes, -1 if not available, 0 if from cache
+    attr_accessor :body_size
+    # Content of the response body
+    # @return [Hash] response body objects (strings) as a hash
+    # @example
+    #   {"mimeType"=>"text/html", "size"=>0}
+    attr_accessor :content
+    # Redirection target URL from location response header.
+    # @return [String] redirect URL as string, e.g. "blog/index.php"
+    attr_accessor :redirect_url
+  end
+
+end

data/lib/http_archive/version.rb

@@ -0,0 +1,3 @@
+module HttpArchive
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: http_archive
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Alexander Huber
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A library to interact with HTTP Archives (.har files)
+email:
+- alih83@gmx.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/http_archive.rb
+- lib/http_archive/archive.rb
+- lib/http_archive/classes.rb
+- lib/http_archive/version.rb
+homepage: http://github.com/alihuber/http_archive
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Interact with HTTP Archives, loosely following the interface of the Archive::HAR
+  Perl module
+test_files: []
+has_rdoc: