appium_lib_core 2.1.0 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 839d870bf455e8e1f835888ab0c780ed8a5acac7
-  data.tar.gz: b5efadecea9570d191885893167d7a7c0cf4442e
+  metadata.gz: a02e68202c9a9657245c1fbcd79a7542159e387a
+  data.tar.gz: 30bbcd68a1f774ebce2622625991b019c904a1b9
 SHA512:
-  metadata.gz: 56815ca165aebf552d3172b11cc669be750bf57ca391a33d78f2b4ca8676e1be73b025981b0c2a6c530a9be27d43d8294f988f49ed1ed592ecf7630537105a7d
-  data.tar.gz: 8ce5dcdcbed3f802bac42274335d0b85d632df8efb9f2abad1dab7a779110c458e8e8ff3fcbacfa1581cd822a685d58c29fc2725ec111b224aa3e3256b019964
+  metadata.gz: ec058b2ed3e35946d41835e336859b0fa4d28db2eb08286cc85f5f0b0703928f41b2ddb8f6c417385125f6cd5973dd53d4d6c38e708afa1932621ad296051af9
+  data.tar.gz: 07aa605217f51dfaf94bc189cd953c2db7a1c41f67ad8cc239ee0b43b4e7c48adbfd38d0ffcd256f23e8fec9bca5ffc68e92537b8d0ff5ba514e4e41705ea10f

data/CHANGELOG.md

@@ -9,6 +9,25 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [2.1.1] - 2018-11-23
+### Enhancements
+- `desired_capabilities:` is available in addition to `caps:` as a capability
+    ```ruby
+    # case 1
+    opts = { caps: { }, appium_lib: { } }
+    @driver = Appium::Core.for(opts).start_driver
+
+    # case 2
+    opts = { desired_capabilities: { }, appium_lib: { } }
+    @driver = Appium::Core.for(opts).start_driver
+    ```
+- Update `start_recording_screen` for iOS, Appium 1.10.0
+    - Add `:video_scale` and update `:video_type`
+
+### Bug fixes
+
+### Deprecations
+
 ## [2.1.0] - 2018-11-14
 ### Enhancements
 - Support below style _1_, has _url_ parameter, in addition to style _2_ 
@@ -19,7 +38,7 @@ Read `release_notes.md` for commit level details.
     # 2
     Appium::Core.for caps: {...}, appium_lib: {...}
     ```
-- Add `videoFps` param for screen recording in iOS(XCUITest) to sync with Appium 1.9.2
+- Add `:video_fps` param for screen recording in iOS(XCUITest) to sync with Appium 1.10.0
 
 ### Bug fixes
 

data/README.md

@@ -5,6 +5,11 @@
 
 [![Build Status](https://travis-ci.org/appium/ruby_lib_core.svg?branch=master)](https://travis-ci.org/appium/ruby_lib_core)
 
+
+This library is a Ruby client for Appium.  The gem is available via [appium_lib_core](https://rubygems.org/gems/appium_lib_core).
+
+This library wraps [selenium-webdriver](https://github.com/SeleniumHQ/selenium/wiki/Ruby-Bindings) and adapts WebDriver APIs for Appium. [ruby_lib](https://github.com/appium/ruby_lib) calls all of Appium/Selenium related APIs via this core library. It works instance based driver.
+
 # Documentation
 
 - http://www.rubydoc.info/github/appium/ruby_lib_core
@@ -67,7 +72,7 @@ require 'rubygems'
 require 'appium_lib_core'
 
 opts = {
-  caps: {
+  desired_capabilities: { # or { caps: {....} }
     platformName: :ios,
     platformVersion: '11.0',
     deviceName: 'iPhone Simulator',

data/Rakefile

@@ -66,12 +66,11 @@ namespace :android do
     `adb uninstall io.appium.espressoserver.test`
   end
 
-
   desc('Generate and launch android emulators')
   task :gen_device do |_t, _args|
-    SWARMER_VERSION = '0.2.4'
-    CPU_ARCHITECTURE = 'x86'
-    IMAGE = 'google_apis'
+    SWARMER_VERSION = '0.2.4'.freeze
+    CPU_ARCHITECTURE = 'x86'.freeze
+    IMAGE = 'google_apis'.freeze
     ANDROID_API = 27
     system %W(
       curl
@@ -89,13 +88,13 @@ namespace :android do
       ).join(' ')
     end
 
-    system %W(java -jar /tmp/swarmer.jar start).concat(cmds).flatten.join(' ')
+    system %w(java -jar /tmp/swarmer.jar start).concat(cmds).flatten.join(' ')
   end
 end
 
 desc('Generate yardoc')
 YARD::Rake::YardocTask.new do |t|
-  t.files   = %w(lib/**/*.rb)
+  t.files = %w(lib/**/*.rb)
 end
 
 desc('Execute RuboCop static code analysis')
@@ -105,7 +104,7 @@ RuboCop::RakeTask.new(:rubocop) do |t|
   t.fail_on_error = true
 end
 
-desc("print commands which Ruby client has not implemented them yet.")
+desc('print commands which Ruby client has not implemented them yet')
 namespace :commands do
   require './script/commands'
 

data/lib/appium_lib_core/android/uiautomator2/device.rb

@@ -7,7 +7,7 @@ module Appium
         module Device
           extend Forwardable
 
-          # @since 1.6.0
+          # @since Appium 1.6.0
           # @!method battery_info
           #
           # Get battery information.

data/lib/appium_lib_core/common/base/driver.rb

@@ -583,6 +583,12 @@ module Appium
         #
         # @example
         #
+        #    # iOS
+        #    @driver.start_recording_screen video_type: 'libx264'
+        #    @driver.stop_and_save_recording_screen 'example.mp4' # Video type `libx264` can be play as `.mp4` video
+        #
+        #    # Android
+        #    @driver.start_recording_screen
         #    @driver.stop_and_save_recording_screen 'example.mp4'
         #
         def stop_and_save_recording_screen(file_path)
@@ -807,8 +813,6 @@ module Appium
           @bridge.session_capabilities
         end
 
-        DEFAULT_MATCH_THRESHOLD = 0.5
-
         # Image Comparison
         def match_images_features(first_image:,
                                   second_image:,

data/lib/appium_lib_core/common/base/screenshot.rb

@@ -78,7 +78,7 @@ module Appium
           end
         end
 
-        # @since 1.3.4
+        # @since Appium 1.3.4
         # @!method save_viewport_screenshot
         # Save screenshot except for status bar while `@driver.save_screenshot` save entire screen.
         #

data/lib/appium_lib_core/common/command/w3c.rb

@@ -7,12 +7,12 @@ module Appium
           {
             # ::Appium::Core::Base::Commands::OSS has the following commands and Appium also use them.
             # Delegated to ::Appium::Core::Base::Commands::OSS commands
-            status:                    [:get, 'status'.freeze],
-            is_element_displayed:      [:get, 'session/:session_id/element/:id/displayed'.freeze],
+            status:                    [:get, 'status'.freeze], # https://w3c.github.io/webdriver/#dfn-status
+            is_element_displayed:      [:get, 'session/:session_id/element/:id/displayed'.freeze], # hint: https://w3c.github.io/webdriver/#element-displayedness
 
-            get_timeouts:              [:get, 'session/:session_id/timeouts'.freeze],
+            get_timeouts:              [:get, 'session/:session_id/timeouts'.freeze], # https://w3c.github.io/webdriver/#get-timeouts
 
-            ## Add OSS commands to W3C commands. We can remove them if we would like to remove them from W3C module.
+            # Add OSS commands to W3C commands. We can remove them if we would like to remove them from W3C module.
             ### Session capability
             get_capabilities:          [:get, 'session/:session_id'.freeze],
 

data/lib/appium_lib_core/driver.rb

@@ -84,8 +84,10 @@ module Appium
       #
       #     # format 1
       #     @core = Appium::Core.for caps: {...}, appium_lib: {...}
-      #     # format 2
-      #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", caps: {...}, appium_lib: {...}
+      #     # format 2. `desired_capabilities:` is also available instead of `caps:`. Either is fine.
+      #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", desired_capabilities: {...}, appium_lib: {...}
+      #     # format 3. `appium_lib: {...}` can be blank
+      #     @core = Appium::Core.for url: "http://127.0.0.1:8080/wd/hub", desired_capabilities: {...}
       #
       #
       #     require 'rubygems'
@@ -113,8 +115,9 @@ module Appium
       #     @core.start_driver # Connect to `http://127.0.0.1:8080/wd/hub` because of `port: 8080`
       #
       #     # Start iOS driver with .zip file over HTTP
+      #     #  `desired_capabilities:` is also available instead of `caps:`. Either is fine.
       #     opts = {
-      #              caps: {
+      #              desired_capabilities: {
       #                platformName: :ios,
       #                platformVersion: '11.0',
       #                deviceName: 'iPhone Simulator',
@@ -136,7 +139,7 @@ module Appium
       #     # Start iOS driver as another format. `url` is available like below
       #     opts = {
       #              url: "http://custom-host:8080/wd/hub.com",
-      #              caps: {
+      #              desired_capabilities: {
       #                platformName: :ios,
       #                platformVersion: '11.0',
       #                deviceName: 'iPhone Simulator',
@@ -392,7 +395,8 @@ module Appium
       def validate_keys(opts)
         flatten_ops = flatten_hash_keys(opts)
 
-        raise Error::NoCapabilityError unless opts.member?(:caps)
+        raise Error::NoCapabilityError unless opts.member?(:caps) || opts.member?(:desired_capabilities)
+
         if !opts.member?(:appium_lib) && flatten_ops.member?(:appium_lib)
           raise Error::CapabilityStructureError, 'Please check the value of appium_lib in the capability'
         end
@@ -412,7 +416,7 @@ module Appium
 
       # @private
       def get_caps(opts)
-        Core::Base::Capabilities.create_capabilities(opts[:caps] || {})
+        Core::Base::Capabilities.create_capabilities(opts[:caps] || opts[:desired_capabilities] || {})
       end
 
       # @private

data/lib/appium_lib_core/ios/xcuitest/device.rb

@@ -36,7 +36,13 @@ module Appium
           #   @driver.background_app(-1) #=> the app never come back. https://github.com/appium/appium/issues/7741
           #
 
-          # @!method start_recording_screen(remote_path: nil, user: nil, pass: nil, method: nil, force_restart: nil, video_type: 'mp4', time_limit: '180', video_quality: 'medium')
+          # @since Appium 1.9.1
+          # @!method start_recording_screen(remote_path: nil, user: nil, pass: nil, method: nil, force_restart: nil, video_type: 'mjpeg', time_limit: '180', video_quality: 'medium', video_scale: '320:240')
+          #
+          # Record the display of devices running iOS Simulator since Xcode 9 or real devices since iOS 11
+          # (ffmpeg utility is required: 'brew install ffmpeg').
+          # We would recommend to play the video by VLC or Mplayer if you can not play the video with other video players.
+          #
           # @param [String] remote_path: The path to the remote location, where the resulting video should be uploaded.
           #                             The following protocols are supported: http/https, ftp.
           #                             Null or empty string value (the default setting) means the content of resulting
@@ -51,25 +57,28 @@ module Appium
           # @param [Boolean] force_restart: Whether to try to catch and upload/return the currently running screen recording
           #                                 (`false`, the default setting on server) or ignore the result of it
           #                                 and start a new recording immediately (`true`).
-          # @param [String] video_type: The format of the screen capture to be recorded.
-          #                            Available formats: "h264", "mp4" or "fmp4". Default is "mp4".
-          #                            Only works for Simulator.
+          # @param [String] video_type: The video codec type used for encoding of the be recorded screen capture.
+          #                             Execute `ffmpeg -codecs` in the terminal to see the list of supported video codecs.
+          #                             'mjpeg' by default.
           # @param [String] time_limit: Recording time. 180 seconds is by default.
           # @param [String] video_quality: The video encoding quality (low, medium, high, photo - defaults to medium).
-          #                               Only works for real devices.
           # @param [String] video_fps: The Frames Per Second rate of the recorded video. Change this value if the resulting video
-          #                            is too slow or too fast. Defaults to 10.
+          #                            is too slow or too fast. Defaults to 10. This can decrease the resulting file size.
+          # @param [String] video_scale: The scaling value to apply. Read https://trac.ffmpeg.org/wiki/Scaling for possible values.
+          #                              No scale is applied by default.
           #
           # @example
           #
           #    @driver.start_recording_screen
-          #    @driver.start_recording_screen video_type: 'h264', time_limit: '260'
+          #    @driver.start_recording_screen video_type: 'mjpeg', time_limit: '260'
+          #    @driver.start_recording_screen video_type: 'libx264', time_limit: '260' # Can get `.mp4` video
           #
 
-          # @since 1.3.4
+          # @since Appium 1.3.4
           # @!method start_performance_record(timeout: 300000, profile_name: 'Activity Monitor')
           #
-          # This is a blocking application.
+          # This is a blocking application. Read https://help.apple.com/instruments/mac/current/ to understand the profiler.
+          #
           # @param [Integer|String] timeout: The maximum count of milliseconds to record the profiling information.
           # @param [String] profile_name: The name of existing performance profile to apply.
           #                               Execute `instruments -s` to show the list of available profiles.
@@ -89,7 +98,7 @@ module Appium
           #   @driver.start_performance_record(timeout: 300000, profile_name: 'Activity Monitor')
           #
 
-          # @since 1.3.4
+          # @since Appium 1.3.4
           # @!method get_performance_record(save_file_path: './performance', profile_name: 'Activity Monitor', remote_path: nil, user: nil, pass: nil, method: 'PUT')
           #
           # This is a blocking application.
@@ -116,7 +125,7 @@ module Appium
           #   @driver.get_performance_record
           #   @driver.get_performance_record(save_file_path: './performance', profile_name: 'Activity Monitor')
 
-          # @since 1.6.0
+          # @since Appium 1.6.0
           # @!method battery_info
           #
           # Get battery information.

data/lib/appium_lib_core/ios/xcuitest/device/screen.rb

@@ -8,7 +8,8 @@ module Appium
               ::Appium::Core::Device.add_endpoint_method(:start_recording_screen) do
                 # rubocop:disable Metrics/ParameterLists
                 def start_recording_screen(remote_path: nil, user: nil, pass: nil, method: nil, force_restart: nil,
-                                           video_type: 'mp4', time_limit: '180', video_quality: 'medium', video_fps: nil)
+                                           video_type: 'mjpeg', time_limit: '180', video_quality: 'medium',
+                                           video_fps: nil, video_scale: nil)
                   option = ::Appium::Core::Base::Device::ScreenRecord.new(
                     remote_path: remote_path, user: user, pass: pass, method: method, force_restart: force_restart
                   ).upload_option
@@ -16,7 +17,9 @@ module Appium
                   option[:videoType] = video_type
                   option[:timeLimit] = time_limit
                   option[:videoQuality] = video_quality
+
                   option[:videoFps] = video_fps unless video_fps.nil?
+                  option[:videoScale] = video_scale unless video_scale.nil?
 
                   execute(:start_recording_screen, {}, { options: option })
                 end

data/lib/appium_lib_core/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Core
-    VERSION = '2.1.0'.freeze unless defined? ::Appium::Core::VERSION
-    DATE    = '2018-11-14'.freeze unless defined? ::Appium::Core::DATE
+    VERSION = '2.1.1'.freeze unless defined? ::Appium::Core::VERSION
+    DATE    = '2018-11-23'.freeze unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,21 @@
+#### v2.1.1 2018-11-23
+
+- [56e3904](https://github.com/appium/ruby_lib_core/commit/56e39043a9cd65205dd75632863d5911fac80d96) Release 2.1.1
+- [64bea89](https://github.com/appium/ruby_lib_core/commit/64bea89301606d984de1a6d0b926ebe3c4f81e99) update screenshot test for ios (#166)
+- [4790685](https://github.com/appium/ruby_lib_core/commit/4790685b6ee8b3a34539da5ed2612b3171ecb2cf) append https://help.apple.com/instruments/mac/current/#
+- [0600769](https://github.com/appium/ruby_lib_core/commit/0600769e945349c9bb598a3a4af4381c53313699) update test_start_performance_record_and_stop
+- [69080b1](https://github.com/appium/ruby_lib_core/commit/69080b16e1c02a729b8edf56efabf4dde9e76e23) Add screenshot quality tests (#165)
+- [e1d6b11](https://github.com/appium/ruby_lib_core/commit/e1d6b11da52b2472240307b063f171c23b98c78c) Add tests for mjpeg and recording screen (#164)
+- [8042627](https://github.com/appium/ruby_lib_core/commit/804262784ba9e444a6c28952d99d5c9dfdf6e9a1) tweak rubocop in Rakefile
+- [eff797d](https://github.com/appium/ruby_lib_core/commit/eff797df68b318b3895d2ee5249540070f3365ba) make desired_capabilities name available in the capability (#163)
+- [de80883](https://github.com/appium/ruby_lib_core/commit/de808835203efc9e52a9efbc3121a10a1cb4c3d5) remove unused const
+- [2a398c5](https://github.com/appium/ruby_lib_core/commit/2a398c54d680851f8b2dc3b6bea8fe3a1e052fdb) remove pry
+- [d07be96](https://github.com/appium/ruby_lib_core/commit/d07be96e1c25a6262703d778a4246c989fd03de6) add a --chromedriver_version in _web
+- [fd46ae8](https://github.com/appium/ruby_lib_core/commit/fd46ae870efd21467ff2c6228fc2012d71b2e307) add a description for this
+- [6e4dbe7](https://github.com/appium/ruby_lib_core/commit/6e4dbe72adb1b788daa639853fa1b8cbfb304a91) add one note for start_recording_screen
+- [6b74a67](https://github.com/appium/ruby_lib_core/commit/6b74a67b9cbadadaf8e721866f5a4a539ea20b31) remove unneeded line in doc
+
+
 #### v2.1.0 2018-11-14
 
 - [6dafbd6](https://github.com/appium/ruby_lib_core/commit/6dafbd6cbc270f94a5e8b2ea5a779b644fdc3cdf) Release 2.1.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.1.1
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-11-14 00:00:00.000000000 Z
+date: 2018-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver