browserup_mitmproxy_client 1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +68 -0
- data/README.md +119 -0
- data/Rakefile +10 -0
- data/browserup_mitmproxy_client.gemspec +38 -0
- data/docs/BrowserUpProxyApi.md +657 -0
- data/docs/Counter.md +20 -0
- data/docs/Entry.md +38 -0
- data/docs/EntryRequest.md +36 -0
- data/docs/EntryRequestCookies.md +32 -0
- data/docs/EntryRequestQueryString.md +22 -0
- data/docs/EntryResponse.md +36 -0
- data/docs/EntryResponseContent.md +28 -0
- data/docs/EntryTimings.md +32 -0
- data/docs/Error.md +20 -0
- data/docs/Har.md +18 -0
- data/docs/HarLog.md +28 -0
- data/docs/HarLogCreator.md +22 -0
- data/docs/Header.md +22 -0
- data/docs/MatchCriteria.md +44 -0
- data/docs/NameValuePair.md +20 -0
- data/docs/Page.md +32 -0
- data/docs/PagePageTimings.md +22 -0
- data/docs/VerifyResult.md +22 -0
- data/docs/WebSocketMessage.md +24 -0
- data/git_push.sh +58 -0
- data/lib/browserup_mitmproxy_client/api/browser_up_proxy_api.rb +689 -0
- data/lib/browserup_mitmproxy_client/api_client.rb +389 -0
- data/lib/browserup_mitmproxy_client/api_error.rb +57 -0
- data/lib/browserup_mitmproxy_client/configuration.rb +279 -0
- data/lib/browserup_mitmproxy_client/models/counter.rb +239 -0
- data/lib/browserup_mitmproxy_client/models/entry.rb +359 -0
- data/lib/browserup_mitmproxy_client/models/entry_request.rb +346 -0
- data/lib/browserup_mitmproxy_client/models/entry_request_cookies.rb +291 -0
- data/lib/browserup_mitmproxy_client/models/entry_request_query_string.rb +246 -0
- data/lib/browserup_mitmproxy_client/models/entry_response.rb +348 -0
- data/lib/browserup_mitmproxy_client/models/entry_response_content.rb +273 -0
- data/lib/browserup_mitmproxy_client/models/entry_timings.rb +463 -0
- data/lib/browserup_mitmproxy_client/models/error.rb +229 -0
- data/lib/browserup_mitmproxy_client/models/har.rb +223 -0
- data/lib/browserup_mitmproxy_client/models/har_log.rb +287 -0
- data/lib/browserup_mitmproxy_client/models/har_log_creator.rb +246 -0
- data/lib/browserup_mitmproxy_client/models/header.rb +246 -0
- data/lib/browserup_mitmproxy_client/models/match_criteria.rb +346 -0
- data/lib/browserup_mitmproxy_client/models/name_value_pair.rb +229 -0
- data/lib/browserup_mitmproxy_client/models/page.rb +312 -0
- data/lib/browserup_mitmproxy_client/models/page_page_timings.rb +288 -0
- data/lib/browserup_mitmproxy_client/models/verify_result.rb +254 -0
- data/lib/browserup_mitmproxy_client/models/web_socket_message.rb +265 -0
- data/lib/browserup_mitmproxy_client/version.rb +15 -0
- data/lib/browserup_mitmproxy_client.rb +59 -0
- data/spec/api/browser_up_proxy_api_spec.rb +148 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/counter_spec.rb +40 -0
- data/spec/models/entry_request_cookies_spec.rb +76 -0
- data/spec/models/entry_request_query_string_spec.rb +46 -0
- data/spec/models/entry_request_spec.rb +88 -0
- data/spec/models/entry_response_content_spec.rb +64 -0
- data/spec/models/entry_response_spec.rb +88 -0
- data/spec/models/entry_spec.rb +94 -0
- data/spec/models/entry_timings_spec.rb +76 -0
- data/spec/models/error_spec.rb +40 -0
- data/spec/models/har_log_creator_spec.rb +46 -0
- data/spec/models/har_log_spec.rb +64 -0
- data/spec/models/har_spec.rb +34 -0
- data/spec/models/header_spec.rb +46 -0
- data/spec/models/match_criteria_spec.rb +112 -0
- data/spec/models/name_value_pair_spec.rb +40 -0
- data/spec/models/page_page_timings_spec.rb +46 -0
- data/spec/models/page_spec.rb +76 -0
- data/spec/models/verify_result_spec.rb +46 -0
- data/spec/models/web_socket_message_spec.rb +52 -0
- data/spec/spec_helper.rb +111 -0
- metadata +181 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 80def9862289b6d21cd1f57ae99e03651a983e7a
|
4
|
+
data.tar.gz: dcdeb508df45b86369c12186dd77ece20d1e8e7f
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 9e24c0066f60befc72b2e3e14b24682797b03df034bcfc98d2e2543f9de17b2d9ad7e884fef45d8aedc6ad13875068dbe621e9e41cdefb7cfc2912a343324311
|
7
|
+
data.tar.gz: baf5dcec4977f93bf0ef7005ce59c4c7a0f772415b35bf5f0f7a84a02527e9f64ae4ff0a89464b0f6290e6c849bd84c1b76a14106886921f6ab568a5643d6f58
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
@@ -0,0 +1,68 @@
|
|
1
|
+
PATH
|
2
|
+
remote: .
|
3
|
+
specs:
|
4
|
+
browserup_mitmproxy_client (1.1)
|
5
|
+
typhoeus (~> 1.0, >= 1.0.1)
|
6
|
+
|
7
|
+
GEM
|
8
|
+
remote: https://rubygems.org/
|
9
|
+
specs:
|
10
|
+
ast (2.4.2)
|
11
|
+
byebug (11.0.1)
|
12
|
+
coderay (1.1.3)
|
13
|
+
diff-lcs (1.4.4)
|
14
|
+
ethon (0.14.0)
|
15
|
+
ffi (>= 1.15.0)
|
16
|
+
ffi (1.15.4)
|
17
|
+
jaro_winkler (1.5.4)
|
18
|
+
method_source (1.0.0)
|
19
|
+
parallel (1.19.2)
|
20
|
+
parser (3.0.2.0)
|
21
|
+
ast (~> 2.4.1)
|
22
|
+
pry (0.14.1)
|
23
|
+
coderay (~> 1.1)
|
24
|
+
method_source (~> 1.0)
|
25
|
+
pry-byebug (3.7.0)
|
26
|
+
byebug (~> 11.0)
|
27
|
+
pry (~> 0.10)
|
28
|
+
psych (3.1.0)
|
29
|
+
rainbow (3.0.0)
|
30
|
+
rake (13.0.6)
|
31
|
+
rspec (3.10.0)
|
32
|
+
rspec-core (~> 3.10.0)
|
33
|
+
rspec-expectations (~> 3.10.0)
|
34
|
+
rspec-mocks (~> 3.10.0)
|
35
|
+
rspec-core (3.10.1)
|
36
|
+
rspec-support (~> 3.10.0)
|
37
|
+
rspec-expectations (3.10.1)
|
38
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
39
|
+
rspec-support (~> 3.10.0)
|
40
|
+
rspec-mocks (3.10.2)
|
41
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
42
|
+
rspec-support (~> 3.10.0)
|
43
|
+
rspec-support (3.10.2)
|
44
|
+
rubocop (0.66.0)
|
45
|
+
jaro_winkler (~> 1.5.1)
|
46
|
+
parallel (~> 1.10)
|
47
|
+
parser (>= 2.5, != 2.5.1.1)
|
48
|
+
psych (>= 3.1.0)
|
49
|
+
rainbow (>= 2.2.2, < 4.0)
|
50
|
+
ruby-progressbar (~> 1.7)
|
51
|
+
unicode-display_width (>= 1.4.0, < 1.6)
|
52
|
+
ruby-progressbar (1.11.0)
|
53
|
+
typhoeus (1.4.0)
|
54
|
+
ethon (>= 0.9.0)
|
55
|
+
unicode-display_width (1.5.0)
|
56
|
+
|
57
|
+
PLATFORMS
|
58
|
+
ruby
|
59
|
+
|
60
|
+
DEPENDENCIES
|
61
|
+
browserup_mitmproxy_client!
|
62
|
+
pry-byebug
|
63
|
+
rake (~> 13.0.1)
|
64
|
+
rspec (~> 3.6, >= 3.6.0)
|
65
|
+
rubocop (~> 0.66.0)
|
66
|
+
|
67
|
+
BUNDLED WITH
|
68
|
+
1.17.3
|
data/README.md
ADDED
@@ -0,0 +1,119 @@
|
|
1
|
+
# browserup_mitmproxy_client
|
2
|
+
|
3
|
+
BrowserupMitmProxy - the Ruby gem for the BrowserUp MitmProxy
|
4
|
+
|
5
|
+
___
|
6
|
+
This is the REST API for controlling the BrowserUp MitmProxy.
|
7
|
+
The BrowserUp MitmProxy is a swiss army knife for automated testing that
|
8
|
+
captures HTTP traffic in HAR files. It is also useful for Selenium/Cypress tests.
|
9
|
+
___
|
10
|
+
|
11
|
+
|
12
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
13
|
+
|
14
|
+
- API version: 1.0.0
|
15
|
+
- Package version: 1.1
|
16
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
17
|
+
|
18
|
+
## Installation
|
19
|
+
|
20
|
+
### Build a gem
|
21
|
+
|
22
|
+
To build the Ruby code into a gem:
|
23
|
+
|
24
|
+
```shell
|
25
|
+
gem build browserup_mitmproxy_client.gemspec
|
26
|
+
```
|
27
|
+
|
28
|
+
Then either install the gem locally:
|
29
|
+
|
30
|
+
```shell
|
31
|
+
gem install ./browserup_mitmproxy_client-1.1.gem
|
32
|
+
```
|
33
|
+
|
34
|
+
(for development, run `gem install --dev ./browserup_mitmproxy_client-1.1.gem` to install the development dependencies)
|
35
|
+
|
36
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
37
|
+
|
38
|
+
Finally add this to the Gemfile:
|
39
|
+
|
40
|
+
gem 'browserup_mitmproxy_client', '~> 1.1'
|
41
|
+
|
42
|
+
### Install from Git
|
43
|
+
|
44
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
45
|
+
|
46
|
+
gem 'browserup_mitmproxy_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
47
|
+
|
48
|
+
### Include the Ruby code directly
|
49
|
+
|
50
|
+
Include the Ruby code directly using `-I` as follows:
|
51
|
+
|
52
|
+
```shell
|
53
|
+
ruby -Ilib script.rb
|
54
|
+
```
|
55
|
+
|
56
|
+
## Getting Started
|
57
|
+
|
58
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
59
|
+
|
60
|
+
```ruby
|
61
|
+
# Load the gem
|
62
|
+
require 'browserup_mitmproxy_client'
|
63
|
+
|
64
|
+
api_instance = BrowserupMitmProxy::BrowserUpProxyApi.new
|
65
|
+
counter = BrowserupMitmProxy::Counter.new({value: 3.56, name: 'name_example'}) # Counter | Receives a new counter to add. The counter is stored, under the hood, in an array in the har under the _counters key
|
66
|
+
|
67
|
+
begin
|
68
|
+
api_instance.add_counter(counter)
|
69
|
+
rescue BrowserupMitmProxy::ApiError => e
|
70
|
+
puts "Exception when calling BrowserUpProxyApi->add_counter: #{e}"
|
71
|
+
end
|
72
|
+
|
73
|
+
```
|
74
|
+
|
75
|
+
## Documentation for API Endpoints
|
76
|
+
|
77
|
+
All URIs are relative to *http://localhost:8088*
|
78
|
+
|
79
|
+
Class | Method | HTTP request | Description
|
80
|
+
------------ | ------------- | ------------- | -------------
|
81
|
+
*BrowserupMitmProxy::BrowserUpProxyApi* | [**add_counter**](docs/BrowserUpProxyApi.md#add_counter) | **POST** /har/counters |
|
82
|
+
*BrowserupMitmProxy::BrowserUpProxyApi* | [**add_error**](docs/BrowserUpProxyApi.md#add_error) | **POST** /har/errors |
|
83
|
+
*BrowserupMitmProxy::BrowserUpProxyApi* | [**get_har_log**](docs/BrowserUpProxyApi.md#get_har_log) | **GET** /har |
|
84
|
+
*BrowserupMitmProxy::BrowserUpProxyApi* | [**healthcheck**](docs/BrowserUpProxyApi.md#healthcheck) | **GET** /healthcheck |
|
85
|
+
*BrowserupMitmProxy::BrowserUpProxyApi* | [**new_page**](docs/BrowserUpProxyApi.md#new_page) | **POST** /har/page |
|
86
|
+
*BrowserupMitmProxy::BrowserUpProxyApi* | [**reset_har_log**](docs/BrowserUpProxyApi.md#reset_har_log) | **PUT** /har |
|
87
|
+
*BrowserupMitmProxy::BrowserUpProxyApi* | [**verify_not_present**](docs/BrowserUpProxyApi.md#verify_not_present) | **POST** /verify/not_present/{name} |
|
88
|
+
*BrowserupMitmProxy::BrowserUpProxyApi* | [**verify_present**](docs/BrowserUpProxyApi.md#verify_present) | **POST** /verify/present/{name} |
|
89
|
+
*BrowserupMitmProxy::BrowserUpProxyApi* | [**verify_size**](docs/BrowserUpProxyApi.md#verify_size) | **POST** /verify/size/{size}/{name} |
|
90
|
+
*BrowserupMitmProxy::BrowserUpProxyApi* | [**verify_sla**](docs/BrowserUpProxyApi.md#verify_sla) | **POST** /verify/sla/{time}/{name} |
|
91
|
+
|
92
|
+
|
93
|
+
## Documentation for Models
|
94
|
+
|
95
|
+
- [BrowserupMitmProxy::Counter](docs/Counter.md)
|
96
|
+
- [BrowserupMitmProxy::Entry](docs/Entry.md)
|
97
|
+
- [BrowserupMitmProxy::EntryRequest](docs/EntryRequest.md)
|
98
|
+
- [BrowserupMitmProxy::EntryRequestCookies](docs/EntryRequestCookies.md)
|
99
|
+
- [BrowserupMitmProxy::EntryRequestQueryString](docs/EntryRequestQueryString.md)
|
100
|
+
- [BrowserupMitmProxy::EntryResponse](docs/EntryResponse.md)
|
101
|
+
- [BrowserupMitmProxy::EntryResponseContent](docs/EntryResponseContent.md)
|
102
|
+
- [BrowserupMitmProxy::EntryTimings](docs/EntryTimings.md)
|
103
|
+
- [BrowserupMitmProxy::Error](docs/Error.md)
|
104
|
+
- [BrowserupMitmProxy::Har](docs/Har.md)
|
105
|
+
- [BrowserupMitmProxy::HarLog](docs/HarLog.md)
|
106
|
+
- [BrowserupMitmProxy::HarLogCreator](docs/HarLogCreator.md)
|
107
|
+
- [BrowserupMitmProxy::Header](docs/Header.md)
|
108
|
+
- [BrowserupMitmProxy::MatchCriteria](docs/MatchCriteria.md)
|
109
|
+
- [BrowserupMitmProxy::NameValuePair](docs/NameValuePair.md)
|
110
|
+
- [BrowserupMitmProxy::Page](docs/Page.md)
|
111
|
+
- [BrowserupMitmProxy::PagePageTimings](docs/PagePageTimings.md)
|
112
|
+
- [BrowserupMitmProxy::VerifyResult](docs/VerifyResult.md)
|
113
|
+
- [BrowserupMitmProxy::WebSocketMessage](docs/WebSocketMessage.md)
|
114
|
+
|
115
|
+
|
116
|
+
## Documentation for Authorization
|
117
|
+
|
118
|
+
All endpoints do not require authorization.
|
119
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
|
3
|
+
=begin
|
4
|
+
#BrowserUp MitmProxy
|
5
|
+
|
6
|
+
#___ This is the REST API for controlling the BrowserUp MitmProxy. The BrowserUp MitmProxy is a swiss army knife for automated testing that captures HTTP traffic in HAR files. It is also useful for Selenium/Cypress tests. ___
|
7
|
+
|
8
|
+
The version of the OpenAPI document: 1.0.0
|
9
|
+
|
10
|
+
Generated by: https://openapi-generator.tech
|
11
|
+
OpenAPI Generator version: 5.2.0
|
12
|
+
|
13
|
+
=end
|
14
|
+
|
15
|
+
$:.push File.expand_path("../lib", __FILE__)
|
16
|
+
require "browserup_mitmproxy_client/version"
|
17
|
+
|
18
|
+
Gem::Specification.new do |s|
|
19
|
+
s.name = "browserup_mitmproxy_client"
|
20
|
+
s.version = BrowserupMitmProxy::VERSION
|
21
|
+
s.platform = Gem::Platform::RUBY
|
22
|
+
s.authors = ["BrowserUp"]
|
23
|
+
s.email = ["hello@browserup.com"]
|
24
|
+
s.homepage = "https://browserup.com"
|
25
|
+
s.summary = "Client for the BrowserUp MitmProxy, an automated testing swiss army knife"
|
26
|
+
s.description = "A REST client for the browserup-mitmproxy"
|
27
|
+
s.license = "Unlicense"
|
28
|
+
s.required_ruby_version = ">= 2.3"
|
29
|
+
|
30
|
+
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
|
31
|
+
|
32
|
+
s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
|
33
|
+
|
34
|
+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
|
35
|
+
s.test_files = `find spec/*`.split("\n")
|
36
|
+
s.executables = []
|
37
|
+
s.require_paths = ["lib"]
|
38
|
+
end
|