appium_lib_core 3.5.0 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4b62c59d17450d1d9c3f8ebed9ca3b3aacaa1deaf3cfe9e114699a8e8bf82460
-  data.tar.gz: d212637f293f9545044a77acf07b4ba2209bda5a76d049ed27a354fb7514ab00
+  metadata.gz: f19bd603ecc28d38a5ea210d846167130279bd12e0e59b8355af66877921f212
+  data.tar.gz: 509fa209cc410bcf9160e70905ad3b4ea439fda7f280128e210b20b1dca9b9b6
 SHA512:
-  metadata.gz: 12a1336c1600c555c9c02030bd4a090d2a59569160ef6a14973077f336662a06d1d078cedcd1971f9688533d36b076b422bd92fed6d060880c6da7fdc200c50d
-  data.tar.gz: 93072d58a034a15cf78d3e95b4f524eb0a91708529af9cfde5e4cc3bffa51c8333d3f0a38080cb96d6dfe8e39fb5af4355b33c8a73fe78f248b6e7ee1358ecb2
+  metadata.gz: d955248f477098d7127d61a9319195bf7a5ac361780bce4f475621d160f067789de1ca5280b4330285623e893f04542cc51c767fd12655579322ed6354b0dfa3
+  data.tar.gz: a7c26d5b16b2bf9b8166aee1b87185b27a0b8d889307c10674239f70da64ce96ce99140c75032a16a8d631e7076884ecbce522e549c098c93aa3aa0c72e57b3c

data/.rubocop.yml

@@ -42,5 +42,7 @@ Naming/MemoizedInstanceVariableName:
   Enabled: true
   Exclude:
     - test/**/*
+Naming/RescuedExceptionsVariableName:
+  Enabled: false
 Layout/RescueEnsureAlignment:
   Enabled: false

data/CHANGELOG.md

@@ -10,6 +10,16 @@ Read `release_notes.md` for commit level details.
 
 ### Deprecations
 
+## [3.6.0] - 2020-03-15
+
+### Enhancements
+- Add screen record feature for Windows driver (https://github.com/appium/appium-windows-driver/pull/66)
+    - `#start_recording_screen`, `#stop_recording_screen`
+
+### Bug fixes
+
+### Deprecations
+
 ## [3.5.0] - 2020-01-11
 
 ### Enhancements

data/Rakefile

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

data/appium_lib_core.gemspec

@@ -26,12 +26,12 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'faye-websocket', '~> 0.10.0'
 
   spec.add_development_dependency 'bundler', '>= 1.14'
-  spec.add_development_dependency 'rake', '~> 12.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'yard', '~> 0.9.11'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
-  spec.add_development_dependency 'webmock', '~> 3.4.0'
-  spec.add_development_dependency 'rubocop', '0.61.0'
+  spec.add_development_dependency 'webmock', '~> 3.8.0'
+  spec.add_development_dependency 'rubocop', '0.68.1'
   spec.add_development_dependency 'appium_thor', '~> 1.0'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'

data/ci-jobs/functional_test.yml

@@ -1,7 +1,7 @@
 # jobs for functional test
 parameters:
-  vmImage: 'macOS-10.14'
-  vmImageForIOS: 'macOS-10.14' # Not sure the reason, but macOS 10.14 instance raises no info.plist error
+  vmImage: 'macOS-10.15'
+  vmImageForIOS: 'macOS-10.15' # Not sure the reason, but macOS 10.14 instance raises no info.plist error
   xcodeForIOS: 11.3
   xcodeForTVOS: 11.3
   androidSDK: 29

data/lib/appium_lib_core/driver.rb

@@ -27,6 +27,8 @@ module Appium
       autoload :Xcuitest, 'appium_lib_core/ios_xcuitest'
     end
 
+    autoload :Windows, 'appium_lib_core/windows'
+
     # This options affects only client side as <code>:appium_lib</code> key.<br>
     # Read {::Appium::Core::Driver} about each attribute
     class Options
@@ -475,25 +477,24 @@ module Appium
         when :android
           case automation_name
           when :espresso
-            ::Appium::Core::Android::Espresso::Bridge.for(self)
+            ::Appium::Core::Android::Espresso::Bridge.for self
           when :uiautomator2
-            ::Appium::Core::Android::Uiautomator2::Bridge.for(self)
+            ::Appium::Core::Android::Uiautomator2::Bridge.for self
           else # default and UiAutomator
-            ::Appium::Core::Android::Uiautomator1::Bridge.for(self)
+            ::Appium::Core::Android::Uiautomator1::Bridge.for self
           end
         when :ios, :tvos
           case automation_name
           when :xcuitest
-            ::Appium::Core::Ios::Xcuitest::Bridge.for(self)
+            ::Appium::Core::Ios::Xcuitest::Bridge.for self
           else # default and UIAutomation
-            ::Appium::Core::Ios::Uiautomation::Bridge.for(self)
+            ::Appium::Core::Ios::Uiautomation::Bridge.for self
           end
         when :mac
           # no Mac specific extentions
           ::Appium::Logger.debug('mac')
         when :windows
-          # no windows specific extentions
-          ::Appium::Logger.debug('windows')
+          ::Appium::Core::Windows::Bridge.for self
         when :tizen
           # https://github.com/Samsung/appium-tizen-driver
           ::Appium::Logger.debug('tizen')

data/lib/appium_lib_core/version.rb

@@ -14,7 +14,7 @@
 
 module Appium
   module Core
-    VERSION = '3.5.0' unless defined? ::Appium::Core::VERSION
-    DATE    = '2020-01-11' unless defined? ::Appium::Core::DATE
+    VERSION = '3.6.0' unless defined? ::Appium::Core::VERSION
+    DATE    = '2020-03-15' unless defined? ::Appium::Core::DATE
   end
 end

data/lib/appium_lib_core/windows.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative 'windows/device'
+require_relative 'windows/bridge'

data/lib/appium_lib_core/windows/bridge.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Appium
+  module Core
+    module Windows
+      module Bridge
+        def self.for(target)
+          target.extend Appium::Core::Windows::Device
+        end
+      end
+    end
+  end
+end

data/lib/appium_lib_core/windows/device.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative 'device/screen'
+
+module Appium
+  module Core
+    module Windows
+      module Device
+        extend Forwardable
+
+        # rubocop:disable Metrics/LineLength
+
+        # @since Appium 1.18.0
+        # @!method start_recording_screen(remote_path: nil, user: nil, pass: nil, method: 'PUT', force_restart: nil, time_limit: nil, fps: nil, preset: nil, video_filter: nil, capture_clicks: nil, capture_cursor: nil, audio_input: nil)
+        #
+        # Record the display in background while the automated test is running.
+        # This method requires FFMPEG (https://www.ffmpeg.org/download.html) to be installed and present in PATH.
+        # The resulting video uses H264 codec and is ready to be played by media players built-in into web browsers.
+        #
+        # @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
+        #                             file should be encoded as Base64 and passed as the endpount response value.
+        #                             An exception will be thrown if the generated media file is too big to
+        #                             fit into the available process memory.
+        #                             This option only has an effect if there is screen recording process in progreess
+        #                             and +forceRestart+ parameter is not set to +true+.
+        # @param [String] user The name of the user for the remote authentication.
+        # @param [String] pass The password for the remote authentication.
+        # @param [String] method The http multipart upload method name. The 'PUT' one is used by default.
+        # @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] time_limit Recording time. 180 seconds is by default.
+        # @param [Number|String] fps The count of frames per second in the resulting video.
+        #                            Increasing fps value also increases the size of the resulting
+        #                            video file and the CPU usage. Defaults to 15.
+        # @param [String] preset A preset is a collection of options that will provide a certain encoding speed to compression ratio.
+        #                        A slower preset will provide better compression (compression is quality per filesize).
+        #                        This means that, for example, if you target a certain file size or constant bit rate, you will
+        #                        achieve better quality with a slower preset. Read https://trac.ffmpeg.org/wiki/Encode/H.264
+        #                        for more details.
+        #                        One of the supported encoding presets. Possible values are:
+        #                          - ultrafast
+        #                          - superfast
+        #                          - veryfast (default)
+        #                          - faster
+        #                          - fast
+        #                          - medium
+        #                          - slow
+        #                          - slower
+        #                          - veryslow
+        # @param [String] video_filter The video filter spec to apply for ffmpeg.
+        #                              See https://trac.ffmpeg.org/wiki/FilteringGuide for more details on the possible values.
+        #                              Example: Set it to +scale=ifnot(gte(iw\,1024)\,iw\,1024):-2+ in order to limit the video width
+        #                              to 1024px. The height will be adjusted automatically to match the actual screen aspect ratio.
+        # @param [Bool] capture_cursor Whether to capture the mouse cursor while recording the screen.
+        #                              Disabled by default.
+        # @param [Bool] capture_clicks Whether to capture the click gestures while recording the screen.
+        #                              Disabled by default.
+        # @param [String] audio_input If provided then the given audio input will be used to record the computer audio
+        #                             along with the desktop video. The list of available devices could be retrieved using
+        #                             +ffmpeg -list_devices true -f dshow -i dummy+ command.
+        #
+        # @example
+        #
+        #    @driver.start_recording_screen
+        #    @driver.start_recording_screen video_filter: 'scale=ifnot(gte(iw\,1024)\,iw\,1024):-2'
+        #    @driver.start_recording_screen capture_cursor: true, capture_clicks: true, time_limit: '260'
+        #
+
+        # rubocop:enable Metrics/LineLength
+
+        ####
+        ## class << self
+        ####
+
+        class << self
+          def extended(_mod)
+            Screen.add_methods
+          end
+        end # class << self
+      end # module Device
+    end # module Windows
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/windows/device/screen.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Appium
+  module Core
+    module Windows
+      module Device
+        module Screen
+          def self.add_methods
+            ::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: 'PUT',
+                                         force_restart: nil, time_limit: nil,
+                                         fps: nil, preset: nil, video_filter: nil,
+                                         capture_clicks: nil, capture_cursor: nil, audio_input: nil)
+                option = ::Appium::Core::Base::Device::ScreenRecord.new(
+                  remote_path: remote_path, user: user, pass: pass, method: method, force_restart: force_restart
+                ).upload_option
+
+                option[:timeLimit] = time_limit unless time_limit.nil?
+                option[:fps] = fps unless fps.nil?
+                option[:preset] = preset unless preset.nil?
+                option[:videoFilter] = video_filter unless video_filter.nil?
+                option[:captureClicks] = capture_clicks unless capture_clicks.nil?
+                option[:captureCursor] = capture_cursor unless capture_cursor.nil?
+                option[:audioInput] = audio_input unless audio_input.nil?
+
+                execute(:start_recording_screen, {}, { options: option })
+              end
+              # rubocop:enable Metrics/ParameterLists
+            end
+          end
+        end # module Screen
+      end # module Device
+    end # module Windows
+  end # module Core
+end # module Appium

data/release_notes.md

@@ -1,3 +1,14 @@
+#### v3.6.0 2020-03-15
+
+- [260d45e](https://github.com/appium/ruby_lib_core/commit/260d45e28a36e99e3dedbe8d41e2703c4d3fbdc8) Release 3.6.0
+- [e67abd5](https://github.com/appium/ruby_lib_core/commit/e67abd53d188f0a77adb15882dd2151b1c0132e8) feat: add Windows screen record (#255)
+- [164fd72](https://github.com/appium/ruby_lib_core/commit/164fd7205944a06055427000b7371311f9dc20a3) ci: Bump ci macOS version (#254)
+- [7200f25](https://github.com/appium/ruby_lib_core/commit/7200f255bc5eb74a8fe8b3667db1c004a55092cf) update rubocop yml
+- [2fe8c0a](https://github.com/appium/ruby_lib_core/commit/2fe8c0ae01fa3fd2653cd83415f512931adac655) Update webmock requirement from ~> 3.4.0 to ~> 3.8.0 (#253)
+- [32dc172](https://github.com/appium/ruby_lib_core/commit/32dc17289f5c130b7f949bfca415e10fa4fe87d7) Update rubocop requirement from = 0.61.0 to = 0.68.1 (#251)
+- [7b4402e](https://github.com/appium/ruby_lib_core/commit/7b4402e3c59d3cfee600c6375494eecb2c7c6ddf) Update rake requirement from ~> 12.0 to ~> 13.0 (#252)
+
+
 #### v3.5.0 2020-01-11
 
 - [79174fd](https://github.com/appium/ruby_lib_core/commit/79174fd6821398eacc32a897c1161140087b11e6) Release 3.5.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.6.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-10 00:00:00.000000000 Z
+date: 2020-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -64,14 +64,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '12.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -120,28 +120,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.61.0
+        version: 0.68.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.61.0
+        version: 0.68.1
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -314,6 +314,10 @@ files:
 - lib/appium_lib_core/ios_xcuitest.rb
 - lib/appium_lib_core/patch.rb
 - lib/appium_lib_core/version.rb
+- lib/appium_lib_core/windows.rb
+- lib/appium_lib_core/windows/bridge.rb
+- lib/appium_lib_core/windows/device.rb
+- lib/appium_lib_core/windows/device/screen.rb
 - release_notes.md
 - script/commands.rb
 homepage: https://github.com/appium/ruby_lib_core/