appium_lib_core 1.3.4 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aaa0d993203afcfa428e6e478416365588854f88
-  data.tar.gz: f087a75d818f5b888d09d606d1f60660caee5ca4
+  metadata.gz: b31ad437c19f4d1e46c7b4eeea5b1a3e673b7848
+  data.tar.gz: 06b07c12e1c7e23beacd7a8527516dfa3b798d47
 SHA512:
-  metadata.gz: 59d58196a9e24a24d51636f1c744ca75317b9101971602efc8f5a5d21dcd9111d5f20a85da93e9c04c0edb514217888b532709a0445e7fb5e6d1e2313626c892
-  data.tar.gz: 5f3d0e30943a11ea5df3258a8b68680f9571717c89f9d595a6ea82bd4b2555057112afaf372ff81785892558c7b29373c501049b5564600b4b55bd4af1991004
+  metadata.gz: 98002924f583609a1f9c5ea6b5e886b4d8e08d58a882c82ddbbbdc370736f1f0e0d11fe3155260f4cd29051fd7efabf4c47cfed32feb6faa63d1a955c213e048
+  data.tar.gz: e2b316d400db5ac4b3e0169798cd18408a87cf51ac0793a52f127b3f6cc2a4589c8a832600598621083132bbd6e29921d15b210ac60541006cf0fe33870e0b2e

data/CHANGELOG.md

@@ -8,6 +8,15 @@ All notable changes to this project will be documented in this file.
 
 ### Deprecations
 
+## [1.3.5] - 2018-03-30
+### Enhancements
+- Add a `bug_report` option in `start_recording_screen`, Android
+- Add clipboard apis [#69](https://github.com/appium/ruby_lib_core/pull/69)
+
+### Bug fixes
+
+### Deprecations
+
 ## [1.3.4] - 2018-03-21
 ### Enhancements
 - Add `save_viewport_screenshot` which get screenshot except for status bar. 

data/lib/appium_lib_core.rb

@@ -10,6 +10,7 @@ require_relative 'appium_lib_core/device/touch_actions'
 require_relative 'appium_lib_core/device/multi_touch'
 require_relative 'appium_lib_core/device/screen_record'
 require_relative 'appium_lib_core/device/app_state'
+require_relative 'appium_lib_core/device/clipboard_content_type'
 
 require_relative 'appium_lib_core/android'
 require_relative 'appium_lib_core/android_uiautomator2'

data/lib/appium_lib_core/android/device.rb

@@ -1,4 +1,5 @@
 require_relative 'device/emulator'
+require 'base64'
 
 module Appium
   module Android
@@ -105,7 +106,11 @@ module Appium
       #                             use a size supported by your device's Advanced Video Coding (AVC) encoder.
       #                             For example, "1280x720"
       # @param [String] time_limit: Recording time. 180 seconds is by default.
-      # @param [String] bit_rate: The video bit rate for the video, in megabits per second. 4 Mbps(4000000) is by default.
+      # @param [String] bit_rate: The video bit rate for the video, in megabits per second.
+      #                           4 Mbp/s(4000000) is by default for Android API level below 27. 20 Mb/s(20000000) for API level 27 and above.
+      # @param [Boolean] bug_report: Set it to `true` in order to display additional information on the video overlay,
+      #                              such as a timestamp, that is helpful in videos captured to illustrate bugs.
+      #                              This option is only supported since API level 27 (Android P).
       #
       # @example
       #
@@ -113,6 +118,27 @@ module Appium
       #    @driver.start_recording_screen video_size: '1280x720', time_limit: '180', bit_rate: '5000000'
       #
 
+      # @!method get_clipboard(content_type: :plaintext)
+      #   Set the content of device's clipboard.
+      # @param [String] content_type: one of supported content types.
+      # @return [String]
+      #
+      # @example
+      #
+      #   @driver.get_clipboard #=> "happy testing"
+      #
+
+      # @!method set_clipboard(content:, content_type: :plaintext, label: nil)
+      #   Set the content of device's clipboard.
+      # @param [String] label: clipboard data label.
+      # @param [String] content_type: one of supported content types.
+      # @param [String] content: Contents to be set. (Will encode with base64-encoded inside this method)
+      #
+      # @example
+      #
+      #   @driver.set_clipboard(content: 'happy testing') #=> {"protocol"=>"W3C"}
+      #
+
       ####
       ## class << self
       ####
@@ -177,6 +203,7 @@ module Appium
           end
 
           add_screen_recording
+          add_clipboard
           Emulator.emulator_commands
         end
 
@@ -186,20 +213,56 @@ 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: 'PUT', force_restart: nil,
-                                       video_size: nil, time_limit: '180', bit_rate: '4000000')
+                                       video_size: nil, time_limit: '180', bit_rate: nil, bug_report: nil)
               option = ::Appium::Core::Device::ScreenRecord.new(
                 remote_path: remote_path, user: user, pass: pass, method: method, force_restart: force_restart
               ).upload_option
 
               option[:videoSize] = video_size unless video_size.nil?
               option[:timeLimit] = time_limit
-              option[:bitRate] = bit_rate
+              option[:bitRate] = bit_rate unless bit_rate.nil?
+
+              unless bug_report.nil?
+                raise 'bug_report should be true or false' unless [true, false].member?(bug_report)
+                option[:bugReport] = bug_report
+              end
 
               execute(:start_recording_screen, {}, { options: option })
             end
             # rubocop:enable Metrics/ParameterLists
           end
         end
+
+        def add_clipboard
+          ::Appium::Core::Device.add_endpoint_method(:get_clipboard) do
+            def get_clipboard(content_type: :plaintext)
+              unless ::Appium::Core::Device::Clipboard::CONTENT_TYPE.member?(content_type)
+                raise "content_type should be #{::Appium::Core::Device::Clipboard::CONTENT_TYPE}"
+              end
+
+              params = { contentType: content_type }
+
+              data = execute(:get_clipboard, {}, params)
+              Base64.decode64 data
+            end
+          end
+
+          ::Appium::Core::Device.add_endpoint_method(:set_clipboard) do
+            def set_clipboard(content:, content_type: :plaintext, label: nil)
+              unless ::Appium::Core::Device::Clipboard::CONTENT_TYPE.member?(content_type)
+                raise "content_type should be #{::Appium::Core::Device::Clipboard::CONTENT_TYPE}"
+              end
+
+              params = {
+                contentType: content_type,
+                content: Base64.encode64(content)
+              }
+              params[:label] = label unless label.nil?
+
+              execute(:set_clipboard, {}, params)
+            end
+          end
+        end
       end
     end # module Device
   end # module Android

data/lib/appium_lib_core/common/command.rb

@@ -56,6 +56,8 @@ module Appium
         push_file:                  [:post, 'session/:session_id/appium/device/push_file'.freeze],
         pull_file:                  [:post, 'session/:session_id/appium/device/pull_file'.freeze],
         pull_folder:                [:post, 'session/:session_id/appium/device/pull_folder'.freeze],
+        get_clipboard:              [:post, 'session/:session_id/appium/device/get_clipboard'.freeze],
+        set_clipboard:              [:post, 'session/:session_id/appium/device/set_clipboard'.freeze],
         get_settings:               [:get,  'session/:session_id/appium/settings'.freeze],
         update_settings:            [:post, 'session/:session_id/appium/settings'.freeze],
         touch_actions:              [:post, 'session/:session_id/touch/perform'.freeze],

data/lib/appium_lib_core/device/clipboard_content_type.rb

@@ -0,0 +1,9 @@
+module Appium
+  module Core
+    module Device
+      module Clipboard
+        CONTENT_TYPE = [:plaintext, :image, :url].freeze
+      end
+    end
+  end
+end

data/lib/appium_lib_core/ios/device.rb

@@ -1,3 +1,5 @@
+require 'base64'
+
 module Appium
   module Ios
     module Device
@@ -28,6 +30,26 @@ module Appium
       #   @driver.toggle_touch_id_enrollment false #=> Disable toggle enrolled
       #
 
+      # @!method get_clipboard(content_type: :plaintext)
+      #   Set the content of device's clipboard.
+      # @param [String] content_type: one of supported content types.
+      # @return [String]
+      #
+      # @example
+      #
+      #   @driver.get_clipboard #=> "happy testing"
+      #
+
+      # @!method set_clipboard(content:, content_type: :plaintext)
+      #   Set the content of device's clipboard.
+      # @param [String] content_type: one of supported content types.
+      # @param [String] content: Contents to be set. (Will encode with base64-encoded inside this method)
+      #
+      # @example
+      #
+      #   @driver.set_clipboard(content: 'happy testing') #=> {"protocol"=>"W3C"}
+      #
+
       ####
       ## class << self
       ####
@@ -47,6 +69,41 @@ module Appium
               execute :toggle_touch_id_enrollment, {}, enabled: enabled
             end
           end
+
+          add_clipboard
+        end
+
+        private
+
+        def add_clipboard
+          ::Appium::Core::Device.add_endpoint_method(:get_clipboard) do
+            def get_clipboard(content_type: :plaintext)
+              unless ::Appium::Core::Device::Clipboard::CONTENT_TYPE.member?(content_type)
+                raise "content_type should be #{::Appium::Core::Device::Clipboard::CONTENT_TYPE}"
+              end
+
+              params = {}
+              params[:contentType] = content_type
+
+              data = execute(:get_clipboard, {}, params)
+              Base64.decode64 data
+            end
+          end
+
+          ::Appium::Core::Device.add_endpoint_method(:set_clipboard) do
+            def set_clipboard(content:, content_type: :plaintext)
+              unless ::Appium::Core::Device::Clipboard::CONTENT_TYPE.member?(content_type)
+                raise "content_type should be #{::Appium::Core::Device::Clipboard::CONTENT_TYPE}"
+              end
+
+              params = {
+                contentType: content_type,
+                content: Base64.encode64(content)
+              }
+
+              execute(:set_clipboard, {}, params)
+            end
+          end
         end
       end
     end # module Device

data/lib/appium_lib_core/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Core
-    VERSION = '1.3.4'.freeze unless defined? ::Appium::Core::VERSION
-    DATE    = '2018-03-21'.freeze unless defined? ::Appium::Core::DATE
+    VERSION = '1.3.5'.freeze unless defined? ::Appium::Core::VERSION
+    DATE    = '2018-03-30'.freeze unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,10 @@
+#### v1.3.5 2018-03-30
+
+- [1f10dcb](https://github.com/appium/ruby_lib_core/commit/1f10dcb1448d44fd336317a7d16dd53ee03355f8) Release 1.3.5
+- [993840a](https://github.com/appium/ruby_lib_core/commit/993840a698fe302434ef895213998f6b55d0497c) add clipboard api (#69)
+- [8ce848c](https://github.com/appium/ruby_lib_core/commit/8ce848c848e3e312fd8af3c4a2733fdc9fc093bc) Add bug report option (#68)
+
+
 #### v1.3.4 2018-03-21
 
 - [053458e](https://github.com/appium/ruby_lib_core/commit/053458e8c766c2f83c7025251e1aeebb1a2da4d5) Release 1.3.4

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 1.3.4
+  version: 1.3.5
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-21 00:00:00.000000000 Z
+date: 2018-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -233,6 +233,7 @@ files:
 - lib/appium_lib_core/common/log.rb
 - lib/appium_lib_core/common/logger.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
 - lib/appium_lib_core/device/screen_record.rb
 - lib/appium_lib_core/device/touch_actions.rb