wda_client 0.1.0
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/.gitignore +12 -0
- data/.travis.yml +6 -0
- data/CODE_OF_CONDUCT.md +49 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +21 -0
- data/README.md +66 -0
- data/Rakefile +10 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/wda_client/homescreen.rb +15 -0
- data/lib/wda_client/screenshot.rb +20 -0
- data/lib/wda_client/sessions.rb +19 -0
- data/lib/wda_client/source.rb +14 -0
- data/lib/wda_client/status.rb +14 -0
- data/lib/wda_client/version.rb +3 -0
- data/lib/wda_client.rb +57 -0
- data/wda_client.gemspec +26 -0
- metadata +118 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: d4abac08512d83a44f16c7934a55524eec72f11c
|
4
|
+
data.tar.gz: 8c047fd2801d429f47d153fc4dca8b4c407ffd9a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 8bc2ae1693e6421236edbcbefbecc82e3ee0fc69e95df77dbec6b2eb14d2f857420a3772ea97ae878a494645cbd4dc1a515c13308534570e3a72061dc3409bb9
|
7
|
+
data.tar.gz: 3013553a9cd9b2c74d7c1355705fdde3e2cdb087c26899693fa970ec3c4d2b19e7ec03cf93fd199c43828092732c61bbdfc872c9756c7c4fe4851fc061cc5b0a
|
data/.gitignore
ADDED
data/.travis.yml
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,49 @@
|
|
1
|
+
# Contributor Code of Conduct
|
2
|
+
|
3
|
+
As contributors and maintainers of this project, and in the interest of
|
4
|
+
fostering an open and welcoming community, we pledge to respect all people who
|
5
|
+
contribute through reporting issues, posting feature requests, updating
|
6
|
+
documentation, submitting pull requests or patches, and other activities.
|
7
|
+
|
8
|
+
We are committed to making participation in this project a harassment-free
|
9
|
+
experience for everyone, regardless of level of experience, gender, gender
|
10
|
+
identity and expression, sexual orientation, disability, personal appearance,
|
11
|
+
body size, race, ethnicity, age, religion, or nationality.
|
12
|
+
|
13
|
+
Examples of unacceptable behavior by participants include:
|
14
|
+
|
15
|
+
* The use of sexualized language or imagery
|
16
|
+
* Personal attacks
|
17
|
+
* Trolling or insulting/derogatory comments
|
18
|
+
* Public or private harassment
|
19
|
+
* Publishing other's private information, such as physical or electronic
|
20
|
+
addresses, without explicit permission
|
21
|
+
* Other unethical or unprofessional conduct
|
22
|
+
|
23
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
24
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
25
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
26
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
27
|
+
threatening, offensive, or harmful.
|
28
|
+
|
29
|
+
By adopting this Code of Conduct, project maintainers commit themselves to
|
30
|
+
fairly and consistently applying these principles to every aspect of managing
|
31
|
+
this project. Project maintainers who do not follow or enforce the Code of
|
32
|
+
Conduct may be permanently removed from the project team.
|
33
|
+
|
34
|
+
This code of conduct applies both within project spaces and in public spaces
|
35
|
+
when an individual is representing the project or its community.
|
36
|
+
|
37
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
38
|
+
reported by contacting a project maintainer at fly.49.89.over@gmail.com. All
|
39
|
+
complaints will be reviewed and investigated and will result in a response that
|
40
|
+
is deemed necessary and appropriate to the circumstances. Maintainers are
|
41
|
+
obligated to maintain confidentiality with regard to the reporter of an
|
42
|
+
incident.
|
43
|
+
|
44
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
45
|
+
version 1.3.0, available at
|
46
|
+
[http://contributor-covenant.org/version/1/3/0/][version]
|
47
|
+
|
48
|
+
[homepage]: http://contributor-covenant.org
|
49
|
+
[version]: http://contributor-covenant.org/version/1/3/0/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2016 Kazuaki MATSUO
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,66 @@
|
|
1
|
+
# WdaClient
|
2
|
+
|
3
|
+
WdaClient is my minimal client for WebDriverAgent to help some operations.
|
4
|
+
|
5
|
+
[](https://travis-ci.org/KazuCocoa/wda_client)
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'wda_client'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install wda_client
|
22
|
+
|
23
|
+
### Requirement
|
24
|
+
- Should use WebDriverAgent over the below commit hash because `/source` supported from it.
|
25
|
+
- https://github.com/facebook/WebDriverAgent/commit/9648eb1747ef7c64630d78256f82e675742f8431
|
26
|
+
|
27
|
+
## Usage
|
28
|
+
|
29
|
+
1. Launch WebDriverAgent
|
30
|
+
- Read [official document](https://github.com/facebook/WebDriverAgent)
|
31
|
+
2. load this module and create instance
|
32
|
+
```
|
33
|
+
$ pry
|
34
|
+
> require 'wda_client'
|
35
|
+
> client = WdaClient.new desired_capabilities: "{\"desiredCapabilities\":{\"bundleId\": \"com.my.app\"}}"
|
36
|
+
> client.get_status # get https://github.com/facebook/WebDriverAgent/wiki/Queries#checking-service-status
|
37
|
+
> client.take_screenshot # https://github.com/facebook/WebDriverAgent/wiki/Queries#get-a-screenshot
|
38
|
+
> client.get_source # https://github.com/facebook/WebDriverAgent/wiki/Queries#source-aka-tree
|
39
|
+
```
|
40
|
+
|
41
|
+
## Advanced
|
42
|
+
1. Launch WebDriverAgent with particular port number
|
43
|
+
1. launch with `fbsimctl` with particular port number
|
44
|
+
- https://github.com/facebook/WebDriverAgent/wiki/Starting-WebDriverAgent
|
45
|
+
2. change source code directly
|
46
|
+
- [code](https://github.com/facebook/WebDriverAgent/blob/4addbcd4a3d9e5ec6241ac4ad3830227f2f4ccd4/WebDriverAgentLib/Utilities/FBConfiguration.m#L16)
|
47
|
+
3. provide port number via environment of `USE_PORT`
|
48
|
+
- [code](https://github.com/facebook/WebDriverAgent/blob/4addbcd4a3d9e5ec6241ac4ad3830227f2f4ccd4/WebDriverAgentLib/Utilities/FBConfiguration.m#L36)
|
49
|
+
2. Generate instance of `WdaClient` with `base_url`.
|
50
|
+
- Set port `4100`, for insrance.
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
client = WdaClient.new desired_capabilities: "{\"desiredCapabilities\":{\"bundleId\": \"com.my.app\"}}", base_url: 'http://localhost:4100'
|
54
|
+
```
|
55
|
+
|
56
|
+
## Current Status
|
57
|
+
|
58
|
+
- Get Status / Get source / go to homescreen / Take Screenshot / install app and get session id
|
59
|
+
|
60
|
+
## Contributing
|
61
|
+
|
62
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wda_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
63
|
+
|
64
|
+
## License
|
65
|
+
|
66
|
+
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "wda_client"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
require 'json'
|
2
|
+
|
3
|
+
class WdaClient
|
4
|
+
module Homescreen
|
5
|
+
def homescreen
|
6
|
+
uri = generate_uri(url_path: '/homescreen')
|
7
|
+
req = generate_base_req(method: 'post', url_path: '/homescreen')
|
8
|
+
req.body = ""
|
9
|
+
|
10
|
+
res = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
|
11
|
+
|
12
|
+
JSON.parse(res.body)
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
require 'json'
|
2
|
+
require 'base64'
|
3
|
+
|
4
|
+
class WdaClient
|
5
|
+
module Screenshot
|
6
|
+
def take_screenshot(to_file: './snapshot.png')
|
7
|
+
uri = generate_uri(url_path: '/screenshot')
|
8
|
+
req = generate_base_req(method: 'get', url_path: '/screenshot')
|
9
|
+
|
10
|
+
res = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
|
11
|
+
|
12
|
+
parsed_result = JSON.parse res.body
|
13
|
+
|
14
|
+
File.write to_file, Base64.decode64(parsed_result['value'])
|
15
|
+
|
16
|
+
parsed_result['output'] = to_file
|
17
|
+
parsed_result
|
18
|
+
end
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,19 @@
|
|
1
|
+
require 'json'
|
2
|
+
|
3
|
+
class WdaClient
|
4
|
+
module Sessions
|
5
|
+
def install
|
6
|
+
uri = generate_uri(url_path: '/session')
|
7
|
+
req = generate_base_req(method: 'post', url_path: '/session')
|
8
|
+
req.body = @desired_capabilities
|
9
|
+
|
10
|
+
res = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
|
11
|
+
|
12
|
+
result = JSON.parse(res.body)
|
13
|
+
@session_id = result['sessionId'] || result['value']['sessionId']
|
14
|
+
@capabilities = result['value']['capabilities']
|
15
|
+
|
16
|
+
result
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
require 'json'
|
2
|
+
|
3
|
+
class WdaClient
|
4
|
+
module Source
|
5
|
+
def get_source
|
6
|
+
uri = generate_uri(url_path: '/source')
|
7
|
+
req = generate_base_req(method: 'get', url_path: '/source')
|
8
|
+
|
9
|
+
res = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
|
10
|
+
|
11
|
+
JSON.parse res.body
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
@@ -0,0 +1,14 @@
|
|
1
|
+
require 'json'
|
2
|
+
|
3
|
+
class WdaClient
|
4
|
+
module Status
|
5
|
+
def get_status
|
6
|
+
uri = generate_uri(url_path: '/status')
|
7
|
+
req = generate_base_req(method: 'get', url_path: '/status')
|
8
|
+
|
9
|
+
res = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
|
10
|
+
|
11
|
+
JSON.parse res.body
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
data/lib/wda_client.rb
ADDED
@@ -0,0 +1,57 @@
|
|
1
|
+
require 'uri'
|
2
|
+
require 'net/http'
|
3
|
+
|
4
|
+
require_relative 'wda_client/version'
|
5
|
+
require_relative 'wda_client/status'
|
6
|
+
require_relative 'wda_client/sessions'
|
7
|
+
require_relative 'wda_client/screenshot'
|
8
|
+
require_relative 'wda_client/source'
|
9
|
+
require_relative 'wda_client/homescreen'
|
10
|
+
|
11
|
+
class WdaClient
|
12
|
+
include ::WdaClient::Status
|
13
|
+
include ::WdaClient::Sessions
|
14
|
+
include ::WdaClient::Screenshot
|
15
|
+
include ::WdaClient::Source
|
16
|
+
include ::WdaClient::Homescreen
|
17
|
+
|
18
|
+
attr_accessor :session_id, :capabilities, :desired_capabilities
|
19
|
+
attr_reader :base_url
|
20
|
+
|
21
|
+
BASE_URL = 'http://localhost:8100'
|
22
|
+
|
23
|
+
def initialize(desired_capabilities:, base_url: BASE_URL)
|
24
|
+
@desired_capabilities = parse(desired_capabilities)
|
25
|
+
@base_url = base_url
|
26
|
+
@capabilities = nil
|
27
|
+
@session_id = nil
|
28
|
+
end
|
29
|
+
|
30
|
+
def generate_uri(url_path:)
|
31
|
+
URI.parse(@base_url + url_path)
|
32
|
+
end
|
33
|
+
|
34
|
+
def generate_base_req(method:, url_path:)
|
35
|
+
req = case method
|
36
|
+
when 'get'
|
37
|
+
Net::HTTP::Get.new(url_path)
|
38
|
+
when 'post'
|
39
|
+
Net::HTTP::Post.new(url_path)
|
40
|
+
else
|
41
|
+
# no method
|
42
|
+
end
|
43
|
+
req['Content-Type'] = 'application/json'
|
44
|
+
|
45
|
+
req
|
46
|
+
end
|
47
|
+
|
48
|
+
private
|
49
|
+
|
50
|
+
def parse(caps)
|
51
|
+
parsed_caps = JSON.parse(caps)
|
52
|
+
raise ArgumentError, 'should caps has desiredCapabilities' if parsed_caps['desiredCapabilities'].nil?
|
53
|
+
raise ArgumentError, 'should caps has bundleId' if parsed_caps['desiredCapabilities']['bundleId'].nil?
|
54
|
+
|
55
|
+
parsed_caps
|
56
|
+
end
|
57
|
+
end
|
data/wda_client.gemspec
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'wda_client/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "wda_client"
|
8
|
+
spec.version = WdaClient::VERSION
|
9
|
+
spec.authors = ["Kazuaki MATSUO"]
|
10
|
+
spec.email = ["fly.49.89.over@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = %q{minimal client for WebDriverAgent to help some operations}
|
13
|
+
spec.description = %q{minimal client for WebDriverAgent to help some operations}
|
14
|
+
spec.homepage = "https://github.com/KazuCocoa/wda_client"
|
15
|
+
spec.license = "MIT"
|
16
|
+
|
17
|
+
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
18
|
+
spec.bindir = "exe"
|
19
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
20
|
+
spec.require_paths = ["lib"]
|
21
|
+
|
22
|
+
spec.add_development_dependency "bundler", "~> 1.12"
|
23
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
24
|
+
spec.add_development_dependency "minitest", "~> 5.0"
|
25
|
+
spec.add_development_dependency "webmock", "~> 2.1"
|
26
|
+
end
|
metadata
ADDED
@@ -0,0 +1,118 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: wda_client
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Kazuaki MATSUO
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2016-07-24 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.12'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.12'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '10.0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '10.0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: minitest
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '5.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '5.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: webmock
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '2.1'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '2.1'
|
69
|
+
description: minimal client for WebDriverAgent to help some operations
|
70
|
+
email:
|
71
|
+
- fly.49.89.over@gmail.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- ".travis.yml"
|
78
|
+
- CODE_OF_CONDUCT.md
|
79
|
+
- Gemfile
|
80
|
+
- LICENSE.txt
|
81
|
+
- README.md
|
82
|
+
- Rakefile
|
83
|
+
- bin/console
|
84
|
+
- bin/setup
|
85
|
+
- lib/wda_client.rb
|
86
|
+
- lib/wda_client/homescreen.rb
|
87
|
+
- lib/wda_client/screenshot.rb
|
88
|
+
- lib/wda_client/sessions.rb
|
89
|
+
- lib/wda_client/source.rb
|
90
|
+
- lib/wda_client/status.rb
|
91
|
+
- lib/wda_client/version.rb
|
92
|
+
- wda_client.gemspec
|
93
|
+
homepage: https://github.com/KazuCocoa/wda_client
|
94
|
+
licenses:
|
95
|
+
- MIT
|
96
|
+
metadata: {}
|
97
|
+
post_install_message:
|
98
|
+
rdoc_options: []
|
99
|
+
require_paths:
|
100
|
+
- lib
|
101
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
102
|
+
requirements:
|
103
|
+
- - ">="
|
104
|
+
- !ruby/object:Gem::Version
|
105
|
+
version: '0'
|
106
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
requirements: []
|
112
|
+
rubyforge_project:
|
113
|
+
rubygems_version: 2.6.6
|
114
|
+
signing_key:
|
115
|
+
specification_version: 4
|
116
|
+
summary: minimal client for WebDriverAgent to help some operations
|
117
|
+
test_files: []
|
118
|
+
has_rdoc:
|