opensaz 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbc175174d131d8b538a15e4f92252233897af72
-  data.tar.gz: 62dff9ccc64e2be22e98c55b2eaf83c48ef91e00
+  metadata.gz: 4979ad8cc2481fa517bd078df7ae0a3aa78e26a6
+  data.tar.gz: 7de2ec6e3fe35b069a7d8a3a782502a5c26f89a9
 SHA512:
-  metadata.gz: 4a9cbe05c2d8256aa1b0183485979b736dbd93fd968cd26a8e447b33bd59e11b8169537cf671cc1eb3d016169427752ea92858276cc70623ebead17f2ca91d3a
-  data.tar.gz: c8819d81bcdaed910e030e276727e92d34d0f6286c7cc068727dd018aec0b1683f69ae10c00455d8c416ce2dbd9fcf1d37afe00830a1e600ec4e5b65f5ebabda
+  metadata.gz: 08a5a655f189056594ff71045f95a575b1f04d163b8c718249a1985ca5a7d4a6b8f3bcaffc089a0788add37210410d76bce574997752586297448e97b8639fa5
+  data.tar.gz: 6a5838266ee4714aa24c1ef05a7be369f0ca0ed72cb1af34e711fff34692bfe4d617ddb067c70817ddf459898d67bad84616532c56b9c707da6b1e2e64bfee76

data/README.md

@@ -24,7 +24,84 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+#### Read .saz file
+
+A .saz file is simply a compressed file. You can extract it with 7zip. The folder structure and content after extraction are very clear.
+
+When you read a .saz file, Opensaz will immediately extract it to the location where the execution happens.
+
+```ruby
+# will create folder like https_e5125274177355d294051e92098a2e58
+a = Opensaz.read("/Users/keegoo/workspace/https.saz")
+``` 
+
+#### Packages
+
+A `package` is an HTTP interaction(request and response) between client and server.
+
+Typically a `package` consist of `id`, `comment`, `request` and `response`.
+
+    id: is the number in the first column of packages-list in Fiddler UI.
+    comment: in Fiddler UI, you can add comment for each package.
+    request: a HTTP request.
+    response: a HTTP response.
+
+```ruby
+require 'opensaz'
+
+a = Opensaz.read("/Users/keegoo/workspace/entity.saz")
+
+a.packages.each do |x|
+  puts x.id
+  puts x.comment
+  puts x.request.headers[:path]
+  puts x.request.headers[:method]
+  puts x.request.headers[:content_type]
+  puts x.request.body
+
+  puts x.response.headers
+  puts x.response.body
+end
+```
+
+As a `package` is either HTTP or HTTPS protocol, you could pass :http or :https to filter it.
+
+It support :http, :https and :all(default value).
+
+```ruby
+a.packages(:http).each do |x|
+  # do anything
+end
+``` 
+
+You could use Ruby build-in methods `select` to do some filtering.
+
+```ruby
+a.packages.select{|x|x.comment =~ /some import message/}
+
+a.packages.select{|x|x.request.headers[:content_type] == "text/xml"}
+
+a.packages.select{|x|x.request.headers[:path].end_with?("api/batch")}
+
+# list goes on ...
+```
+
+#### headers key name
+
+Headers of both request and response have many [fields](https://en.wikipedia.org/wiki/List_of_HTTP_header_fields#Request_fields). 
+
+`package.request.headers` is a hash. The keys is simply fields name of request header, but with a bit modification. 
+
+e.g.:
+
+    Accept          => :accept
+    Accept-Charset  => :accept_charset
+    Cookie          => :cookie
+    ...
+
+Same with response headers.
+
+If a key(field) doesn't exist, it will be `x.request.headers[:weird] = nil` which is how hash works in Ruby. 
 
 ## Development
 

data/lib/opensaz/builder.rb

@@ -1,7 +1,7 @@
 module Opensaz
   class Builder
 
-    attr_reader :raw_files, :packages
+    attr_reader :raw_files
 
     def initialize(saz_path)
       @saz_path = saz_path
@@ -11,15 +11,27 @@ module Opensaz
       @packages = get_packages
     end
 
+    def packages(type = :all)
+      case type
+      when :http
+        @packages.select{|x| not x.request.headers[:host].end_with?("443")}
+      when :https
+        @packages.select{|x| x.request.headers[:host].end_with?("443")}
+      else
+        @packages
+      end
+    end
+
     private
 
     # ============================
     # return a list of hash, e.g.:
     # [{
-    #   :id=>"2", 
-    #   :c=>"raw/1_c.txt", 
-    #   :s=>"raw/1_s.txt", 
-    #   :m=>"raw/1_m.xml"
+    #   id: "2", 
+    #   c: "raw/1_c.txt", 
+    #   s: "raw/1_s.txt", 
+    #   m: "raw/1_m.xml",
+    #   comment: "user login"
     # }, ...]
     def get_raw_files
       @dest ||= Extractor.new(@saz_path).unzip
@@ -35,7 +47,8 @@ module Opensaz
           dest: @dest,
           c: x[:c],
           s: x[:s],
-          m: x[:m]
+          m: x[:m],
+          comment: x[:comment]
         }
         pkgs.push(Package.new(x[:id], ahash))
       end

data/lib/opensaz/general_info.rb

@@ -7,7 +7,7 @@ module Opensaz
     end
 
     def to_a
-      keys = [:id, :c, :s, :m]
+      keys = [:id, :c, :s, :m, :comment]
       ary = []
       @page.css('tbody tr').each do |x|
         values = get_tbody_tr(x)
@@ -19,15 +19,50 @@ module Opensaz
 
     private
 
+    # ============================
+    # note, the output order should 
+    # be inline with 
+    # [:id, :c, :s, :m, :comment]
     def get_tbody_tr(tr_node)
       tds = tr_node.css('td')
-      [tds[1].text] + seperate_c_s_m(tds[0])
+
+      i = comment_column
+      if i == 0
+        # no comment found
+        [tds[1].text] + seperate_c_s_m(tds[0]) + [nil]
+      else
+        comment = text_or_nil(tds[i-1].text)
+        [tds[1].text] + seperate_c_s_m(tds[0]) + [comment]
+      end
     end
 
     def seperate_c_s_m(a_node)
       a_node.css('a').map{|a| folder_platform_compatible(a["href"]) }
     end
 
+    # ============================
+    # get comment column
+    # return a number, indicating which
+    #   "th" is the comment.
+    # return 0 if could not find it
+    def comment_column
+      res = 0
+      @page.css('thead tr th').each do |x|
+        res += 1
+        if x.text == "Comments"
+          break
+        end
+      end
+      return res
+    end
+
+    # ============================
+    # return nil if empty. 
+    # return itself if not empty.
+    def text_or_nil(comment)
+      comment.length == 0 ? nil : comment
+    end
+
     # ============================
     # "raw\\1_c.txt" is too windows specific
     # from 

data/lib/opensaz/http_request.rb

@@ -16,7 +16,8 @@ module Opensaz
     end
 
     def body
-      @content.split(CRLF * 2)[1]
+      str = @content.split(CRLF * 2)[1..-1].join(CRLF * 2)
+      str == "" ? nil : str
     end
 
     private

data/lib/opensaz/package.rb

@@ -1,8 +1,9 @@
 module Opensaz
   class Package
-    attr_reader :id, :request, :response, :miscel
+    attr_reader :id, :request, :response, :comment
     def initialize(id, ahash)
       @id = id
+      @comment = ahash[:comment]
 
       requestf = File.join(ahash[:dest], ahash[:c])
       responsef = File.join(ahash[:dest], ahash[:s])
@@ -11,7 +12,6 @@ module Opensaz
 
       @request = HTTPRequest.new(str_in_file(requestf))
       @response = HTTPResponse.new(str_in_file(responsef))
-      # @miscel = HTTPMiscel.new(File.read(files[2]))
     end
 
     private

data/lib/opensaz/version.rb

@@ -1,3 +1,3 @@
 module Opensaz
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: opensaz
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Cong Yang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-09 00:00:00.000000000 Z
+date: 2017-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,7 +98,7 @@ files:
 - lib/opensaz/http_response.rb
 - lib/opensaz/package.rb
 - lib/opensaz/version.rb
-homepage: ''
+homepage: https://github.com/keegoo/opensaz
 licenses:
 - MIT
 metadata: {}
@@ -118,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.7
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: a handy tool to read from .saz file.