add keyevent (#27)

* add keyevent

* fix rubocop

* update changelog

Author: KazuCocoa

CHANGELOG.md

@@ -4,6 +4,7 @@ All notable changes to this project will be documented in this file.
 ## [Unreleased]
 ### Enhancements
 - Add guidelines in `.github`
+- session/:session_id/appium/device/keyevent [#21](https://github.com/appium/ruby_lib_core/issues/21)
 
 ### Bug fixes
 

lib/appium_lib_core/common/command.rb

@@ -43,6 +43,8 @@ module Commands
         hide_keyboard:              [:post, 'session/:session_id/appium/device/hide_keyboard'.freeze],
         press_keycode:              [:post, 'session/:session_id/appium/device/press_keycode'.freeze],
         long_press_keycode:         [:post, 'session/:session_id/appium/device/long_press_keycode'.freeze],
+        # keyevent is only for Selendroid
+        keyevent:                   [:post, 'session/:session_id/appium/device/keyevent'.freeze],
         set_immediate_value:        [:post, 'session/:session_id/appium/element/:id/value'.freeze],
         replace_value:              [:post, 'session/:session_id/appium/element/:id/replace_value'.freeze],
         push_file:                  [:post, 'session/:session_id/appium/device/push_file'.freeze],

lib/appium_lib_core/common/device.rb

@@ -138,6 +138,17 @@ module Device
       #   @driver.hide_keyboard(nil, :tapOutside) # Close a keyboard with tapping out side of keyboard
       #
 
+      # @!method keyevent(key, metastate = nil)
+      # Send keyevent on the device.(Only for Selendroid)
+      # http://developer.android.com/reference/android/view/KeyEvent.html
+      # @param [integer] key The key to press.
+      # @param [String] metastate The state the metakeys should be in when pressing the key.
+      #
+      # @example
+      #
+      #   @driver.keyevent 82
+      #
+
       # @!method press_keycode(key, metastate = nil)
       # Press keycode on the device.
       # http://developer.android.com/reference/android/view/KeyEvent.html
@@ -391,22 +402,6 @@ def hide_keyboard(close_key = nil, strategy = nil)
             end
           end
 
-          add_endpoint_method(:press_keycode) do
-            def press_keycode(key, metastate = nil)
-              args             = { keycode: key }
-              args[:metastate] = metastate if metastate
-              execute :press_keycode, {}, args
-            end
-          end
-
-          add_endpoint_method(:long_press_keycode) do
-            def long_press_keycode(key, metastate = nil)
-              args             = { keycode: key }
-              args[:metastate] = metastate if metastate
-              execute :long_press_keycode, {}, args
-            end
-          end
-
           add_endpoint_method(:set_immediate_value) do
             def set_immediate_value(element, *value)
               keys = ::Selenium::WebDriver::Keys.encode(value)
@@ -454,6 +449,7 @@ def update_settings(settings)
             end
           end
 
+          add_keyevent
           add_touch_actions
           add_ime_actions
           add_handling_context
@@ -498,6 +494,33 @@ def create_bridge_command(method)
           end
         end
 
+        def add_keyevent
+          # Only for Selendroid
+          add_endpoint_method(:keyevent) do
+            def keyevent(key, metastate = nil)
+              args             = { keycode: key }
+              args[:metastate] = metastate if metastate
+              execute :keyevent, {}, args
+            end
+          end
+
+          add_endpoint_method(:press_keycode) do
+            def press_keycode(key, metastate = nil)
+              args             = { keycode: key }
+              args[:metastate] = metastate if metastate
+              execute :press_keycode, {}, args
+            end
+          end
+
+          add_endpoint_method(:long_press_keycode) do
+            def long_press_keycode(key, metastate = nil)
+              args             = { keycode: key }
+              args[:metastate] = metastate if metastate
+              execute :long_press_keycode, {}, args
+            end
+          end
+        end
+
         def add_touch_actions
           add_endpoint_method(:touch_actions) do
             def touch_actions(actions)

test/functional/android/android/device_test.rb

@@ -206,6 +206,12 @@ def test_get_display_density
         assert(@@driver.get_display_density > 0)
       end
 
+      def test_keyevent
+        skip('Because only for Selendroid')
+        # http://developer.android.com/reference/android/view/KeyEvent.html
+        assert @@driver.keyevent(176)
+      end
+
       def test_press_keycode
         # http://developer.android.com/reference/android/view/KeyEvent.html
         assert @@driver.press_keycode(176)

test/unit/android/device_test.rb

@@ -48,6 +48,7 @@ def test_with_arg_definitions
                                             :app_installed?,
                                             :background_app,
                                             :hide_keyboard,
+                                            :keyevent,
                                             :press_keycode,
                                             :long_press_keycode,
                                             :set_immediate_value,
@@ -321,6 +322,17 @@ def test_hide_keyboard
         assert_requested(:post, "#{SESSION}/appium/device/hide_keyboard", times: 1)
       end
 
+      def test_keyevent
+        skip('Because only for Selendroid')
+
+        stub_request(:post, "#{SESSION}/appium/device/keyevent")
+          .to_return(headers: HEADER, status: 200, body: { value: '' }.to_json)
+
+        @driver.keyevent 86
+
+        assert_requested(:post, "#{SESSION}/appium/device/keyevent", times: 1)
+      end
+
       def test_press_keycode
         stub_request(:post, "#{SESSION}/appium/device/press_keycode")
           .to_return(headers: HEADER, status: 200, body: { value: '' }.to_json)

test/unit/ios/device_test.rb

@@ -39,6 +39,7 @@ def test_with_arg_definitions
                                             :app_installed?,
                                             :background_app,
                                             :hide_keyboard,
+                                            :keyevent,
                                             :press_keycode,
                                             :long_press_keycode,
                                             :set_immediate_value,

test/unit/script/commands_test.rb

@@ -21,25 +21,43 @@ def test_get_all_command_path
     end
 
     # depends on webdriver-version... (number of commands)
-    def test_appium_commands
-      assert_equal 127, @c.implemented_mjsonwp_commands.length
+    def test_implemented_mjsonwp_commands
+      assert_equal 128, @c.implemented_mjsonwp_commands.length
       assert_equal ['session/:session_id/contexts', [:get]], @c.implemented_mjsonwp_commands.first
+
+      # pick up an arbitrary command
       assert_equal %i(get post), @c.implemented_mjsonwp_commands['session/:session_id/alert_text']
+    end
 
-      assert_equal 88, @c.implemented_w3c_commands.length
+    def test_implemented_w3c_commands
+      assert_equal 89, @c.implemented_w3c_commands.length
       assert_equal ['session/:session_id/contexts', [:get]], @c.implemented_w3c_commands.first
+
+      # pick up an arbitrary command
       assert_equal %i(get post), @c.implemented_w3c_commands['session/:session_id/alert/text']
+    end
 
-      assert_equal 42, @c.implemented_core_commands.length
+    def test_implemented_core_commands
+      assert_equal 43, @c.implemented_core_commands.length
       assert_equal ['session/:session_id/contexts', [:get]], @c.implemented_core_commands.first
+
+      # pick up an arbitrary command
       assert_equal [:post], @c.implemented_core_commands['session/:session_id/appium/device/pull_folder']
+    end
 
+    def test_webdriver_oss_commands
       assert_equal 86, @c.webdriver_oss_commands.length
       assert_equal ['session/:session_id', %i(get delete)], @c.webdriver_oss_commands.first
+
+      # pick up an arbitrary command
       assert_equal %i(get post), @c.webdriver_oss_commands['session/:session_id/alert_text']
+    end
 
+    def test_webdriver_w3c_commands
       assert_equal 46, @c.webdriver_w3c_commands.length
       assert_equal ['session', [:post]], @c.webdriver_w3c_commands.first
+
+      # pick up an arbitrary command
       assert_equal %i(get post), @c.webdriver_w3c_commands['session/:session_id/alert/text']
     end