appium_lib_core 1.3.8 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ac826aa2f98ead54a80272abc7fb36447e3a327b
-  data.tar.gz: a818a3ac3ffd0ed8c398da5c28c5cf65d9efa298
+  metadata.gz: 816965726811ed0e4814ff74f562f821a1d02a96
+  data.tar.gz: 48de6d03d02f08681e80b2f830e415016016b57f
 SHA512:
-  metadata.gz: ab9ce470ee4053c5a22369b943ded09ac5f4b5671ae114736317730ca1a042eab6b87b1df77a8e53efb5328dba8101400a21b34872d3d1140624ad28f46208f1
-  data.tar.gz: abd00234f100e065759513a4b9ac1133f610bb09920e13b2826ee83b3940077d1a9db7a5a64135ea85e8a3c75cd7591bbf1678f5887a737a0633f770cf3022e1
+  metadata.gz: fe453c38eee0cdf8405c19580f48de596338054bd4208e245a81825da5d229c65732c62327047f0da48169e2522dacbd8181ffe70c357abd25f6f2f938a70a80
+  data.tar.gz: da619b8b509db626f9dfbadc38048d9673e632bd505cb343750b3f6153b8871fd59c3d20d426656e3b741e320b498bfa4f94548ced25d145a0fb595df9087f1b

data/.github/contributing.md

@@ -12,6 +12,9 @@ For features or bug fixes, please submit a pull request. Ideally there would be
 - Android
     - `rake test:func:android`
 
+## Merge
+- Squash and merge when we merge PRs to the master
+
 ## Publishing on rubygems
 
 0. Ensure you have `~/.gem/credentials` If not run [the following command](http://guides.rubygems.org/make-your-own-gem/) (replace username with your rubygems user)

data/.travis.yml

@@ -13,7 +13,7 @@ before_install:
 
 script:
   - bundle exec rake rubocop
-  - bundle exec rake test:unit
+  - bundle exec parallel_test test/unit/ -n 4
 
 notifications:
   email:

data/CHANGELOG.md

@@ -8,6 +8,14 @@ All notable changes to this project will be documented in this file.
 
 ### Deprecations
 
+## [1.4.0] - 2018-04-15
+### Enhancements
+- Add a support for WebSocket client based on Faye::WebSocket::Client [#74](https://github.com/appium/ruby_lib_core/pull/74)
+
+### Bug fixes
+
+### Deprecations
+
 ## [1.3.8] - 2018-04-12
 ### Enhancements
 - Make no-argument commands friendly for IDE

data/README.md

@@ -19,7 +19,7 @@ Run unit tests which check each method and commands, URL, using the webmock.
 
 ```bash
 $ bundle install
-$ rake test:unit
+$ bundle exec parallel_test test/unit/
 ```
 
 ### Functional Tests

data/Rakefile

@@ -46,6 +46,13 @@ namespace :test do
       t.libs << 'lib'
       t.test_files = FileList['test/unit/android/**/*_test.rb']
     end
+
+    desc('Run all common related unit tests in test directory')
+    Rake::TestTask.new(:common) do |t|
+      t.libs << 'test'
+      t.libs << 'lib'
+      t.test_files = FileList['test/unit/common/**/*_test.rb']
+    end
   end
 end
 

data/appium_lib_core.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'selenium-webdriver', '~> 3.5'
   spec.add_runtime_dependency 'json', '>= 1.8'
+  spec.add_runtime_dependency 'faye-websocket', '~> 0.10.0'
 
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 12.0'
@@ -35,4 +36,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'appium_thor', '~> 0.0', '>= 0.0.7'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'parallel_tests'
 end

data/lib/appium_lib_core/common.rb

@@ -4,3 +4,4 @@ require_relative 'common/log'
 require_relative 'common/command'
 require_relative 'common/device'
 require_relative 'common/base'
+require_relative 'common/ws/websocket'

data/lib/appium_lib_core/common/ws/websocket.rb

@@ -0,0 +1,151 @@
+require 'faye/websocket'
+require 'eventmachine'
+
+module Appium
+  module Core
+    class WebSocket
+      attr_reader :client, :endpoint
+
+      # A websocket client based on Faye::WebSocket::Client .
+      # Uses eventmachine to wait response from the peer. The eventmachine works on a thread. The thread will exit
+      # with close method.
+      #
+      # @param [String] url: URL to establish web socket connection. If the URL has no port, the client use:
+      #                       `ws`: 80, `wss`: 443 ports.
+      # @param [Array] protocols: An array of strings representing acceptable subprotocols for use over the socket.
+      #                           The driver will negotiate one of these to use via the Sec-WebSocket-Protocol header
+      #                           if supported by the other peer. Default is nil.
+      #                           The protocols is equal to https://github.com/faye/faye-websocket-ruby/ 's one for client.
+      # @param [Hash] options: Initialize options for Faye client. Read https://github.com/faye/faye-websocket-ruby#initialization-options
+      #                        for more details. Default is `{}`.
+      #
+      # @example
+      #     ws = WebSocket.new(url: "ws://#{host}:#{port}/ws/session/#{@session_id}/appium/device/logcat")
+      #     ws.client #=> #<Faye::WebSocket::Client:.....> # An instance of Faye::WebSocket::Client
+      #     ws.message 'some message' #=> nil. Send a message to the peer.
+      #     ws.close #=> Kill the thread which run a eventmachine.
+      #
+      def initialize(url:, protocols: nil, options: {})
+        @endpoint = url
+
+        @ws_thread = Thread.new do
+          EM.run do
+            @client ||= ::Faye::WebSocket::Client.new(url, protocols, options)
+
+            @client.on :open do |_open|
+              handle_open
+            end
+
+            @client.on :message do |message|
+              handle_message_data(message.data)
+            end
+
+            @client.on :error do |_error|
+              handle_error
+            end
+
+            @client.on :close do |close|
+              handle_close(close.code, close.reason)
+            end
+          end
+        end
+      end
+
+      # Client
+
+      #
+      # Sends a ping frame with an optional message and fires the callback when a matching pong is received.
+      #
+      # @params [String] message A message to send ping.
+      # @params [Block] &callback
+      #
+      # @example
+      #     ws = WebSocket.new(url: "ws://#{host}:#{port}/ws/session/#{@session_id}/appium/device/logcat")
+      #     ws.ping 'message'
+      #
+      def ping(message, &callback)
+        @client.ping message, &callback
+      end
+
+      # Accepts either a String or an Array of byte-sized integers and sends a text or binary message over the connection
+      # to the other peer; binary data must be encoded as an Array.
+      #
+      # @params [String|Array] message A message to send a text or binary message over the connection
+      #
+      # @example
+      #     ws = WebSocket.new(url: "ws://#{host}:#{port}/ws/session/#{@session_id}/appium/device/logcat")
+      #     ws.send 'happy testing'
+      #
+      def send(message)
+        @client.send message
+      end
+
+      # Closes the connection, sending the given status code and reason text, both of which are optional.
+      #
+      # @params [Integer] code: A status code to send to the peer with close signal. Default is nil.
+      # @params [String] reason: A reason to send to the peer with close signal. Default is 'close from ruby_lib_core'.
+      #
+      # @example
+      #     ws = WebSocket.new(url: "ws://#{host}:#{port}/ws/session/#{@session_id}/appium/device/logcat")
+      #     ws.close reason: 'a something special reason'
+      #
+      def close(code: nil, reason: 'close from ruby_lib_core')
+        if @client.nil?
+          ::Appium::Logger.warn 'Websocket was closed'
+        else
+          @client.close code, reason
+        end
+        @ws_thread.exit
+      end
+
+      # Response from server
+
+      #
+      # Fires when the socket connection is established. Event has no attributes.
+      #
+      # Default is just put a debug message.
+      #
+      def handle_open
+        ::Appium::Logger.debug %W(#{self.class} :open)
+      end
+
+      # Standard out by default
+      # In general, users should customise only message_data
+
+      #
+      # Fires when the socket receives a message. The message gas one `data` attribute and this method can handle the data.
+      # The data is either a String (for text frames) or an Array of byte-sized integers (for binary frames).
+      #
+      # Default is just put a debug message and puts the result on standard out.
+      # In general, users should override this handler to handle messages from the peer.
+      #
+      def handle_message_data(data)
+        ::Appium::Logger.debug %W(#{self.class} :message #{data})
+        $stdout << "#{data}\n"
+      end
+
+      #
+      # Fires when there is a protocol error due to bad data sent by the other peer.
+      # This event is purely informational, you do not need to implement error recovery.
+      #
+      # Default is just put a error message.
+      #
+      def handle_error
+        ::Appium::Logger.error %W(#{self.class} :error)
+      end
+
+      #
+      # Fires when either the client or the server closes the connection. The method gets `code` and `reason` attributes.
+      # They expose the status code and message sent by the peer that closed the connection.
+      #
+      # Default is just put a error message.
+      # The methods also clear `client` instance and stop the eventmachine which is called in initialising this class.
+      #
+      def handle_close(code, reason)
+        ::Appium::Logger.debug %W(#{self.class} :close #{code} #{reason})
+        @client = nil
+        EM.stop
+      end
+    end # module WebSocket
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/driver.rb

@@ -39,6 +39,7 @@ module Appium
       # Provide Appium::Drive like { appium_lib: { port: 8080 } }
       # @return [Integer]
       attr_reader :port
+      DEFAULT_APPIUM_PORT = 4723
 
       # Return a time wait timeout. 30 seconds is by default.
       # Wait time for ::Appium::Core::Base::Wait, wait and wait_true
@@ -428,7 +429,7 @@ module Appium
         @export_session = appium_lib_opts.fetch :export_session, false
         @export_session_path = appium_lib_opts.fetch :export_session_path, '/tmp/appium_lib_session'
 
-        @port = appium_lib_opts.fetch :port, 4723
+        @port = appium_lib_opts.fetch :port, DEFAULT_APPIUM_PORT
 
         # timeout and interval used in ::Appium::Comm.wait/wait_true
         @wait_timeout  = appium_lib_opts.fetch :wait_timeout, 30

data/lib/appium_lib_core/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Core
-    VERSION = '1.3.8'.freeze unless defined? ::Appium::Core::VERSION
-    DATE    = '2018-04-12'.freeze unless defined? ::Appium::Core::DATE
+    VERSION = '1.4.0'.freeze unless defined? ::Appium::Core::VERSION
+    DATE    = '2018-04-15'.freeze unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,11 @@
+#### v1.4.0 2018-04-15
+
+- [5cc89aa](https://github.com/appium/ruby_lib_core/commit/5cc89aa4a9533e174527db5b805b96cf2b45a9ac) Release 1.4.0
+- [598460c](https://github.com/appium/ruby_lib_core/commit/598460cb9a040ec4d0bd3351bbdb0fb9412428e2) implement websocket client (#74)
+- [56a60c6](https://github.com/appium/ruby_lib_core/commit/56a60c6b49b0a36c2e6af34a9d22d828ba38e721) add squash and merge for ontributing.md
+- [6fc0a30](https://github.com/appium/ruby_lib_core/commit/6fc0a303073c895494c172a0ec4d196fefed694e) add parallel tests (#73)
+
+
 #### v1.3.8 2018-04-13
 
 - [f5e1c39](https://github.com/appium/ruby_lib_core/commit/f5e1c39ed07c191c89a491c407d0fc368459367c) Release 1.3.8

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 1.3.8
+  version: 1.4.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-12 00:00:00.000000000 Z
+date: 2018-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: faye-websocket
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -184,6 +198,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel_tests
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Minimal Ruby library for Appium.
 email:
 - fly.49.89.over@gmail.com
@@ -232,6 +260,7 @@ files:
 - lib/appium_lib_core/common/error.rb
 - lib/appium_lib_core/common/log.rb
 - lib/appium_lib_core/common/logger.rb
+- lib/appium_lib_core/common/ws/websocket.rb
 - lib/appium_lib_core/device/app_state.rb
 - lib/appium_lib_core/device/clipboard_content_type.rb
 - lib/appium_lib_core/device/multi_touch.rb