appium_lib_core 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e078b7ab6ce69ac4202cb8bfbf1669a621a1f7c3
-  data.tar.gz: 9f9ad00010a0ae6204d5aa92c5838ff5abc2b9a3
+  metadata.gz: fb8a3502ee734114622e3474545af77b125ec43d
+  data.tar.gz: fe71c68a3d9006e06381d5d04219bbbaa777d35b
 SHA512:
-  metadata.gz: e128a4e5e56dd1456eee1d3fbc74b2a966254a7cc9bf420b64a70a71122a22913dfb87b843dd6f5c3b88a701ebec8d07e357cd20c5403b026c3dab1e163cbcc9
-  data.tar.gz: da0230b20ef8544d892f87f1caf2f1c2dd5c959bacf2ee5b99f2a673c7269d1d957608e5912204d476491271c8a480137594793775b9438c5c47d611167f02dd
+  metadata.gz: 29224ca9a8bde5e159eb7e9bb0d37c73a73ed595aeb21849a4da3b47bf2f09c50bd2f0906d419b824e32f57c15a43e9bb6ea4a1b0d17799b307987a00f0b816d
+  data.tar.gz: 58fc2392b7963aff9b934d746196438889af995f2a902327ded1b79c9e4abf23088fea5ddca7eeb0628ab1a538b6b9b4931686defabe172f6ecf64fc97187e1c

data/.github/contributing.md

@@ -0,0 +1,23 @@
+# Contributing
+
+For features or bug fixes, please submit a pull request. Ideally there would be a test as well. The remainder of this doc details how to run the tests.
+
+## Tests
+### Unit Tests
+- `rake test:unit` run on Travis automatically
+
+### Functional Tests
+- iOS
+    - `rake test:func:ios`
+- Android
+    - `rake test:func:android`
+
+## 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)
+> $ curl -u username https://rubygems.org/api/v1/api_key.yaml >
+~/.gem/credentials; chmod 0600 ~/.gem/credentials
+
+1. Bump the version number `thor bump`
+2. Generate release note, build and publish gem with `thor release`
+3. Update `changelog.md`

data/.github/issue_template.md

@@ -0,0 +1,20 @@
+## This is a
+* [ ] Bug report
+* [ ] Question
+* [ ] Feature Request
+
+## Summary
+
+## Environment
+* `ruby_lib_core` version:
+* Mobile platform/version/device under test:
+
+## Actual behaviour and steps to reproduce
+
+## Expected behaviour
+
+## Link to Appium/Ruby logs
+
+Create a [GIST](https://gist.github.com) which is a paste of your _full_ Appium logs, and link them here. 
+
+## Any additional comments

data/CHANGELOG.md

@@ -3,8 +3,11 @@ 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
+- fix creating sessions [#31](https://github.com/appium/ruby_lib_core/pull/31) for W3C creating sessions
 
 ### Deprecations
 

data/Rakefile

@@ -63,11 +63,19 @@ end
 
 desc("print commands which haven't implemented yet.")
 namespace :commands do
+  require './script/commands'
+
   task :mjsonwp do |_t, _args|
-    require './script/commands'
     c = Script::CommandsChecker.new
     c.get_mjsonwp_routes
     c.get_all_command_path './mjsonwp_routes.js'
     c.all_diff_commands_mjsonwp.each { |key, value| puts("command: #{key}, method: #{value}") }
   end
+
+  task :w3c do |_t, _args|
+    c = Script::CommandsChecker.new
+    c.get_mjsonwp_routes
+    c.get_all_command_path './mjsonwp_routes.js'
+    c.all_diff_commands_w3c.each { |key, value| puts("command: #{key}, method: #{value}") }
+  end
 end

data/lib/appium_lib_core/android/touch.rb

@@ -4,6 +4,8 @@ module Appium
       module Touch
         def self.extend_touch_actions
           ::Appium::Core::TouchAction.class_eval do
+            # Visible for testing
+            # @private
             def swipe_coordinates(start_x: 0, start_y: 0, offset_x: 0, offset_y: 0)
               Appium::Logger.info "extended Appium::Core::Android::Touch, start_x: #{start_x},"\
                 " start_y: #{start_y}, offset_x: #{offset_x}, offset_y: #{offset_y}"

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

@@ -24,6 +24,19 @@ module Appium
             raise CoreError, 'cannot understand dialect'
           end
         end
+
+        private
+
+        # Use capabilities directory because Appium's capability is based on W3C one.
+        # Called in bridge.create_session(desired_capabilities)
+        def merged_capabilities(desired_capabilities)
+          {
+            desiredCapabilities: desired_capabilities,
+            capabilities: {
+              firstMatch: [desired_capabilities]
+            }
+          }
+        end
       end # class Bridge
 
       class CoreBridgeMJSONWP < ::Selenium::WebDriver::Remote::OSS::Bridge

data/lib/appium_lib_core/common/command.rb

@@ -43,6 +43,8 @@ module Appium
         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],

data/lib/appium_lib_core/common/device.rb

@@ -61,6 +61,14 @@ module Appium
       #   @driver.launch_app
       #
 
+      # @!method close_app
+      # Close an app on device
+      #
+      # @example
+      #
+      #   @driver.close_app
+      #
+
       # @!method reset
       # Reset the device, relaunching the application.
       #
@@ -85,6 +93,14 @@ module Appium
       #   @driver.toggle_flight_mode
       #
 
+      # @!method unlock
+      # Unlock the device
+      #
+      # @example
+      #
+      #   @driver.unlock
+      #
+
       # @!method device_locked?
       # Check current device status is weather locked or not
       #
@@ -97,10 +113,52 @@ module Appium
       #   Get the device network connection current status
       #   See set_network_connection method for return value
 
+      # @!method open_notifications
+      #   Open Android notifications
+      #
+      # @example
+      #
+      #   @driver.open_notifications
+      #
+
+      # @!method device_time
+      #   Get the time on the device
+      # @return [String]
+      #
+      # @example
+      #
+      #   @driver.device_time
+      #
+
       ####
       ## With arguments
       ####
 
+      # @!method install_app(path)
+      # Install the given app onto the device
+      #
+      # @example
+      #
+      #   @driver.install_app("/path/to/test.apk")
+      #
+
+      # @!method remove_app(app_id)
+      # Install the given app onto the device
+      #
+      # @example
+      #
+      #   @driver.remove_app("io.appium.bundle")
+      #
+
+      # @!method app_installed?(app_id)
+      # Check whether the specified app is installed on the device
+      # @return [bool]
+      #
+      # @example
+      #
+      #   @driver.app_installed?("io.appium.bundle")
+      #
+
       # @!method app_strings(language = nil)
       # Return the hash of all localization strings.
       # @return [Hash]
@@ -138,6 +196,17 @@ module Appium
       #   @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
@@ -167,7 +236,7 @@ module Appium
       #
       # @example
       #
-      #   @driver.push_file "/file/to/path", data
+      #   @driver.push_file "/file/to/path", "data"
       #
 
       # @!method pull_file(path)
@@ -318,13 +387,6 @@ module Appium
             add_endpoint_method method
           end
 
-          # call http://www.rubydoc.info/gems/selenium-webdriver/Selenium/WebDriver/DriverExtensions/HasRemoteStatus#remote_status-instance_method
-          add_endpoint_method(:remote_status) do
-            def remote_status
-              execute(:status, {}) || []
-            end
-          end
-
           # Don't define selenium-side methods. We pick up from them.
           # ::Appium::Core::Base::Commands::MJSONWP.each_key do |method|
           #   add_endpoint_method method
@@ -345,8 +407,9 @@ module Appium
           end
 
           add_endpoint_method(:lock) do
-            def lock(duration)
-              execute :lock, {}, seconds: duration
+            def lock(duration = nil)
+              opts = duration ? { seconds: duration } : {}
+              execute :lock, {}, opts
             end
           end
 
@@ -391,22 +454,6 @@ module Appium
             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 +501,7 @@ module Appium
             end
           end
 
+          add_keyevent
           add_touch_actions
           add_ime_actions
           add_handling_context
@@ -498,6 +546,33 @@ module Appium
           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)

data/lib/appium_lib_core/ios/touch.rb

@@ -4,6 +4,8 @@ module Appium
       module Touch
         def self.extend_touch_actions
           ::Appium::Core::TouchAction.class_eval do
+            # Visible for testing
+            # @private
             def swipe_coordinates(start_x: 0, start_y: 0, offset_x: 0, offset_y: 0)
               Appium::Logger.info "extended Appium::Core::Ios::Touch, start_x: #{start_x},"\
                 " start_y: #{start_y}, offset_x: #{offset_x}, offset_y: #{offset_y}"

data/lib/appium_lib_core/version.rb

@@ -1,6 +1,6 @@
 module Appium
   module Core
-    VERSION = '1.0.0'.freeze unless defined? ::Appium::Core::VERSION
-    DATE    = '2017-11-12'.freeze unless defined? ::Appium::Core::DATE
+    VERSION = '1.1.0'.freeze unless defined? ::Appium::Core::VERSION
+    DATE    = '2017-12-16'.freeze unless defined? ::Appium::Core::DATE
   end
 end

data/release_notes.md

@@ -1,3 +1,17 @@
+#### v1.1.0 2017-12-16
+
+- [29b36af](https://github.com/appium/ruby_lib_core/commit/29b36af7af280308f7cfc2ee7ffa1738085e0306) Release 1.1.0
+- [f7eefc3](https://github.com/appium/ruby_lib_core/commit/f7eefc376f0d00fb9bc3e8324c652544cb363a9b) fix creating sessions (#31)
+- [08c826f](https://github.com/appium/ruby_lib_core/commit/08c826f78ce861e8bd35b7bced54c9bd91d2fabc) for test code: add taking screens if tests failed (#30)
+- [f14c924](https://github.com/appium/ruby_lib_core/commit/f14c92435388e16598921685963cc7879eb7ba3a) insert @private
+- [5eb125a](https://github.com/appium/ruby_lib_core/commit/5eb125a06e3bc5dfd59a749183d6ff46fd9c5a28) make setting tests robust
+- [8bc97ce](https://github.com/appium/ruby_lib_core/commit/8bc97ce1258da79975fc347dc02dfdb14d06a8df) update comments for some commands (#29)
+- [7de2e89](https://github.com/appium/ruby_lib_core/commit/7de2e89349c5dce775e91c15e0c8a5486b8cbc5e) Remove duplicated remote status (#28)
+- [fcb64b7](https://github.com/appium/ruby_lib_core/commit/fcb64b7992c17d21b82b34cfd714d5dc150ae9a5) add keyevent (#27)
+- [a54b315](https://github.com/appium/ruby_lib_core/commit/a54b315155ee68b79d6051046b7f7899d7d0dda9) add some guidelines
+- [65d00cb](https://github.com/appium/ruby_lib_core/commit/65d00cb14bfbf6a3bdc3eded05d69037a3c06645) add a rake task for w3c
+
+
 #### v1.0.0 2017-11-12
 
 - [de176fe](https://github.com/appium/ruby_lib_core/commit/de176fe2fbcfaa341392e7f37ee537158ed2e23e) Release 1.0.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-12 00:00:00.000000000 Z
+date: 2017-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -183,6 +183,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/contributing.md"
+- ".github/issue_template.md"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"