wda_client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4abac08512d83a44f16c7934a55524eec72f11c
+  data.tar.gz: 8c047fd2801d429f47d153fc4dca8b4c407ffd9a
+SHA512:
+  metadata.gz: 8bc2ae1693e6421236edbcbefbecc82e3ee0fc69e95df77dbec6b2eb14d2f857420a3772ea97ae878a494645cbd4dc1a515c13308534570e3a72061dc3409bb9
+  data.tar.gz: 3013553a9cd9b2c74d7c1355705fdde3e2cdb087c26899693fa970ec3c4d2b19e7ec03cf93fd199c43828092732c61bbdfc872c9756c7c4fe4851fc061cc5b0a

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+.DS_Store
+

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.2.0
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at fly.49.89.over@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wda_client.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Kazuaki MATSUO
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# WdaClient
+
+WdaClient is my minimal client for WebDriverAgent to help some operations.
+
+[![Build Status](https://travis-ci.org/KazuCocoa/wda_client.svg?branch=master)](https://travis-ci.org/KazuCocoa/wda_client)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wda_client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wda_client
+
+### Requirement
+- Should use WebDriverAgent over the below commit hash because `/source` supported from it.
+    - https://github.com/facebook/WebDriverAgent/commit/9648eb1747ef7c64630d78256f82e675742f8431
+
+## Usage
+
+1. Launch WebDriverAgent
+    - Read [official document](https://github.com/facebook/WebDriverAgent)
+2. load this module and create instance
+```
+$ pry
+> require 'wda_client'
+> client = WdaClient.new desired_capabilities: "{\"desiredCapabilities\":{\"bundleId\": \"com.my.app\"}}"
+> client.get_status # get https://github.com/facebook/WebDriverAgent/wiki/Queries#checking-service-status
+> client.take_screenshot # https://github.com/facebook/WebDriverAgent/wiki/Queries#get-a-screenshot
+> client.get_source # https://github.com/facebook/WebDriverAgent/wiki/Queries#source-aka-tree
+```
+
+## Advanced
+1. Launch WebDriverAgent with particular port number
+    1. launch with `fbsimctl` with particular port number
+        - https://github.com/facebook/WebDriverAgent/wiki/Starting-WebDriverAgent
+    2. change source code directly
+        - [code](https://github.com/facebook/WebDriverAgent/blob/4addbcd4a3d9e5ec6241ac4ad3830227f2f4ccd4/WebDriverAgentLib/Utilities/FBConfiguration.m#L16)
+    3. provide port number via environment of `USE_PORT`
+        - [code](https://github.com/facebook/WebDriverAgent/blob/4addbcd4a3d9e5ec6241ac4ad3830227f2f4ccd4/WebDriverAgentLib/Utilities/FBConfiguration.m#L36)
+2. Generate instance of `WdaClient` with `base_url`.
+- Set port `4100`, for insrance.
+
+```ruby
+client = WdaClient.new desired_capabilities: "{\"desiredCapabilities\":{\"bundleId\": \"com.my.app\"}}", base_url: 'http://localhost:4100'
+```
+
+## Current Status
+
+- Get Status / Get source / go to homescreen / Take Screenshot / install app and get session id
+
+## Contributing
+
+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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wda_client"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wda_client/homescreen.rb

@@ -0,0 +1,15 @@
+require 'json'
+
+class WdaClient
+  module Homescreen
+    def homescreen
+      uri = generate_uri(url_path: '/homescreen')
+      req = generate_base_req(method: 'post', url_path: '/homescreen')
+      req.body = ""
+
+      res = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
+
+      JSON.parse(res.body)
+    end
+  end
+end

data/lib/wda_client/screenshot.rb

@@ -0,0 +1,20 @@
+require 'json'
+require 'base64'
+
+class WdaClient
+  module Screenshot
+    def take_screenshot(to_file: './snapshot.png')
+      uri = generate_uri(url_path: '/screenshot')
+      req = generate_base_req(method: 'get', url_path: '/screenshot')
+
+      res = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
+
+      parsed_result = JSON.parse res.body
+
+      File.write to_file, Base64.decode64(parsed_result['value'])
+
+      parsed_result['output'] = to_file
+      parsed_result
+    end
+  end
+end

data/lib/wda_client/sessions.rb

@@ -0,0 +1,19 @@
+require 'json'
+
+class WdaClient
+  module Sessions
+    def install
+      uri = generate_uri(url_path: '/session')
+      req = generate_base_req(method: 'post', url_path: '/session')
+      req.body = @desired_capabilities
+
+      res = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
+
+      result = JSON.parse(res.body)
+      @session_id = result['sessionId'] || result['value']['sessionId']
+      @capabilities = result['value']['capabilities']
+
+      result
+    end
+  end
+end

data/lib/wda_client/source.rb

@@ -0,0 +1,14 @@
+require 'json'
+
+class WdaClient
+  module Source
+    def get_source
+      uri = generate_uri(url_path: '/source')
+      req = generate_base_req(method: 'get', url_path: '/source')
+
+      res = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
+
+      JSON.parse res.body
+    end
+  end
+end

data/lib/wda_client/status.rb

@@ -0,0 +1,14 @@
+require 'json'
+
+class WdaClient
+  module Status
+    def get_status
+      uri = generate_uri(url_path: '/status')
+      req = generate_base_req(method: 'get', url_path: '/status')
+
+      res = Net::HTTP.start(uri.host, uri.port) { |http| http.request(req) }
+
+      JSON.parse res.body
+    end
+  end
+end

data/lib/wda_client/version.rb

@@ -0,0 +1,3 @@
+class WdaClient
+  VERSION = '0.1.0'
+end

data/lib/wda_client.rb

@@ -0,0 +1,57 @@
+require 'uri'
+require 'net/http'
+
+require_relative 'wda_client/version'
+require_relative 'wda_client/status'
+require_relative 'wda_client/sessions'
+require_relative 'wda_client/screenshot'
+require_relative 'wda_client/source'
+require_relative 'wda_client/homescreen'
+
+class WdaClient
+  include ::WdaClient::Status
+  include ::WdaClient::Sessions
+  include ::WdaClient::Screenshot
+  include ::WdaClient::Source
+  include ::WdaClient::Homescreen
+
+  attr_accessor :session_id, :capabilities, :desired_capabilities
+  attr_reader :base_url
+
+  BASE_URL = 'http://localhost:8100'
+
+  def initialize(desired_capabilities:, base_url: BASE_URL)
+    @desired_capabilities = parse(desired_capabilities)
+    @base_url = base_url
+    @capabilities = nil
+    @session_id = nil
+  end
+
+  def generate_uri(url_path:)
+    URI.parse(@base_url + url_path)
+  end
+
+  def generate_base_req(method:, url_path:)
+    req = case method
+          when 'get'
+            Net::HTTP::Get.new(url_path)
+          when 'post'
+            Net::HTTP::Post.new(url_path)
+          else
+            # no method
+          end
+    req['Content-Type'] = 'application/json'
+
+    req
+  end
+
+  private
+
+  def parse(caps)
+    parsed_caps = JSON.parse(caps)
+    raise ArgumentError, 'should caps has desiredCapabilities' if parsed_caps['desiredCapabilities'].nil?
+    raise ArgumentError, 'should caps has bundleId' if parsed_caps['desiredCapabilities']['bundleId'].nil?
+
+    parsed_caps
+  end
+end

data/wda_client.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wda_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wda_client"
+  spec.version       = WdaClient::VERSION
+  spec.authors       = ["Kazuaki MATSUO"]
+  spec.email         = ["fly.49.89.over@gmail.com"]
+
+  spec.summary       = %q{minimal client for WebDriverAgent to help some operations}
+  spec.description   = %q{minimal client for WebDriverAgent to help some operations}
+  spec.homepage      = "https://github.com/KazuCocoa/wda_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "webmock", "~> 2.1"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: wda_client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kazuaki MATSUO
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-24 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+description: minimal client for WebDriverAgent to help some operations
+email:
+- fly.49.89.over@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wda_client.rb
+- lib/wda_client/homescreen.rb
+- lib/wda_client/screenshot.rb
+- lib/wda_client/sessions.rb
+- lib/wda_client/source.rb
+- lib/wda_client/status.rb
+- lib/wda_client/version.rb
+- wda_client.gemspec
+homepage: https://github.com/KazuCocoa/wda_client
+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.6.6
+signing_key: 
+specification_version: 4
+summary: minimal client for WebDriverAgent to help some operations
+test_files: []
+has_rdoc: