browsermob-rest 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: ac04266b4f1376dd35f3fbf8526e8fc2d7f21225
-  data.tar.gz: f70d6136d177da530991871ba2d72475f7d66f8b
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzgwN2VkMDhjMzliNjM1M2I0NWMxYjIwOTFhZTZhOWNjZDNiMDFlOA==
+  data.tar.gz: !binary |-
+    YTM0NjBlNTAyY2UyMDU0MzQ0NWQ4NGM0ZjNiNjU3OTliYjQxMWE5Mg==
 SHA512:
-  metadata.gz: 8a2e042ebb5f9f8939e22cd24d064ab937c5314d4649b829f843101aadcfb974097478a4c02024957e387ab6782935c99c217b9e16ceb094228aa4e587693dfc
-  data.tar.gz: 616b983c2bc97f36c0b31418e67d673b88a3d2df1bc4567fd3de5b6b1a73b6c70b209490d739f7089c2666ab042c729a0d240a7c2a1b0b1741a08cd489a8e440
+  metadata.gz: !binary |-
+    ZWU2NDEyMGEwMjE4NDUyMmRjZGZiNmRiNTVjMDU4MWI5M2Y2YjFkN2RmMzkz
+    Mjk0NzRhYzc5MTVjYmY5MjY3YTM5YmNjNzcxZWUyYWRiZTE5OGY5OGVmNmNk
+    OTIwOWRmY2MxM2ZjNDk4MTdhMzc4MjkwZjczMmY4MzM5MTBiYTg=
+  data.tar.gz: !binary |-
+    NDE5NmQyYTA0MDgxZGQwMjA1YjVlZTk4M2NhMTFmYTJjODcxYmQwZjkxMWJi
+    ODg4OWI1YWVlZmQ3MzdlNzU3ZjE4OGRkMTQ4NmYzMDRlMTJjMzRiM2ExNzQ4
+    Yzc2M2M3OTNiYjA5OTU5NDk2ZjM1MzU2YWVhY2E3ZTU4ZDYxZjc=

data/.travis.yml

@@ -1,5 +1,11 @@
 sudo: false
 language: ruby
 rvm:
-  - 2.3.0
+- 2.3.0
 before_install: gem install bundler -v 1.12.4
+deploy:
+  provider: rubygems
+  api_key:
+    secure: 2kqrl2SaKnzMIFpjIjo765mF5eN+2bk2n0D/QKfvB+siFF+99kQth9RnhPYUfsFdIZ9+zJwv07/pfRbGBHZWRcULOirG+JPolV2HdGOPNz0Ns5XFMae3ZZjbHR7tKKaR+cz1UXvVQInRu+Na8PhvzId1gvcfyYwwjUoaJmlbz7WiC8fEn7xBY8A8MpPj5+wG13f4en2c54IHmQ1BtjH5CzjupEOP//vXXwZK5xk8fdMDRMiD2+0xVreSiD8laOaQj6Mu21hDuv8U6BiK3M3pQM3tlb4B2l9BhJL4ggRXOEdU2Dry58RXoU+iJBLo16++CoyELX5F453CWfQyIHU0GDMKGzsz2isnB5iq+zqlLM+7Uog990yTvWBUHNV6MQUKQN8mmcy6c0pIfuX4bB6nBPcP6F+pG4X/jU5BoMrnJhiSlGh6Y/EPKWZpOYv5RYSu/oa/gSskig1uSorJUd54SMKWZxY4obyLXnWcuNZwj++knn1qJs6xB8B5JNvH21PR18JZfdyy9jBGwRE20MFBu69ZWZ0o5KEqU3LkASxlrk83UsRXp39AB7SmXNs9kieYpiXgUAKAiGwKoodpjoqo9EglZCRerBzJ+keMljCuCKZLGEVBB0v9ivTPF8db+UE5FvadGy/st6V8gTPIiO81AIwXg/ZI57x6OCrv9QsULXk=
+  on:
+    branch: master

data/Gemfile

@@ -1,8 +1,8 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in browsermob-rest.gemspec
 gemspec
 
 gem 'rspec'
+gem 'cucumber'
 gem 'simplecov'
 gem "rest-client"

data/README.md

@@ -20,7 +20,151 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Configure the base url of your Browsermob proxy
+
+```ruby
+Browsermob::Rest::Util::Config.configure do |config|
+    config[:endpoints][:base_url] = "example_url"
+end
+```
+
+Create API client
+
+```ruby
+@client = Browsermob::Rest::Api.new
+```
+
+Get a list of ports attached to ProxyServer instances managed by ProxyManager
+
+```ruby
+@client.get_proxies
+```
+
+Creates a new HAR attached to the proxy and returns the HAR content if there was a previous HAR
+
+```ruby
+@client.update_proxy_har(port, data)
+```
+
+Starts a new page on the existing HAR
+
+```ruby
+@client.update_proxy_har_pageref(port, data)
+```
+
+Shuts down the proxy and closes the port
+
+```ruby
+@client.remove_proxy
+```
+
+Returns the JSON/HAR content representing all the HTTP traffic passed through the proxy
+
+```ruby
+@client.get_proxy_har(port)
+```
+
+Displays whitelisted items
+
+```ruby
+@client.get_proxy_whitelist(port)
+```
+
+Sets a list of URL patterns to whitelist
+
+```ruby
+@client.update_proxy_whitelist(port, data)
+```
+
+Clears all URL patterns from the whitelist 
+
+```ruby
+@client.remove_proxy_whitelist(port)
+```
+
+Displays blacklisted items
+
+```ruby 
+@client.get_proxy_blacklist(port)
+```
+
+Set a URL to blacklist
+
+```ruby
+@client.update_proxy_blacklist(port, data)
+```
+
+Clears all URL patterns from the blacklist
+
+```ruby
+@client.remove_proxy_blacklist(port)
+```
+
+Limit the bandwidth through the proxy
+
+```ruby
+@client.update_proxy_limit(port, data)
+```
+
+Displays the amount of data remaining to be uploaded/downloaded until the limit is reached
+
+```ruby
+@client.get_proxy_limit(port)
+```
+
+Set and override HTTP Request headers
+
+```ruby
+@client.add_proxy_headers(port, data)
+```
+
+Overrides normal DNS lookups and remaps the given hosts with the associated IP address
+
+```ruby
+@client.add_proxy_hosts(port, data)
+```
+
+Sets automatic basic authentication for the specified domain
+
+```ruby
+@client.add_proxy_authentication(port, domain, data)
+```
+
+Wait till all request are being made 
+
+```ruby
+@client.update_proxy_wait(port, data)
+```
+
+Handles different proxy timeouts
+
+```ruby
+@client.update_proxy_timeout(port, data)
+```
+
+Redirecting URL's
+
+```ruby
+@client.update_proxy_redirect(port, data)
+```
+
+Removes all URL redirection rules currently in effect
+
+```ruby
+@client.remove_proxy_redirect(port)
+```
+
+Setting the retry count
+
+```ruby
+@client.add_proxy_retry_count(port, data)
+```
+
+Empties the Cache
+
+```ruby
+@client.remove_proxy_dns_cache(port)
+```
 
 ## Development
 

data/lib/browsermob/rest.rb

@@ -1,5 +1,9 @@
+#
+# rest.rb
+#
 require "browsermob/rest/version"
 require "rest-client"
+
 module Browsermob
   module Rest
 

data/lib/browsermob/rest/version.rb

@@ -1,5 +1,8 @@
+#
+# version.rb
+#
 module Browsermob
   module Rest
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: browsermob-rest
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - THamilton2014@gmail.com
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-05-21 00:00:00.000000000 Z
+date: 2016-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.12'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
 description: 
@@ -59,9 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
+- .gitignore
+- .rspec
+- .travis.yml
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -91,17 +91,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.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Browsermob Rest Client