appium_lib_core 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb8a3502ee734114622e3474545af77b125ec43d
-  data.tar.gz: fe71c68a3d9006e06381d5d04219bbbaa777d35b
+  metadata.gz: f293c0d7c354e724d630c6bf05615648826eae78
+  data.tar.gz: 1b46da98cf8d8865e81774035bd0a186f25dcf4a
 SHA512:
-  metadata.gz: 29224ca9a8bde5e159eb7e9bb0d37c73a73ed595aeb21849a4da3b47bf2f09c50bd2f0906d419b824e32f57c15a43e9bb6ea4a1b0d17799b307987a00f0b816d
-  data.tar.gz: 58fc2392b7963aff9b934d746196438889af995f2a902327ded1b79c9e4abf23088fea5ddca7eeb0628ab1a538b6b9b4931686defabe172f6ecf64fc97187e1c
+  metadata.gz: 58c4837373409a8f1d64551b737e75cfac7d552774dee51bf46fc64fd900c8e3eaa6f30137e201c73a6ef8f1bc2c8814d0b41068ddc7041518083941c360fa21
+  data.tar.gz: e76ae72453b6e21fd96dabb9c2525652be2319883dd326a56143ef687597670cc60efcd387b34345c00bb964d32420d1c5a12a7437237dc20d0bc98a73871f03

data/.rubocop.yml

@@ -16,11 +16,13 @@ Metrics/PerceivedComplexity:
   Max: 8
 Style/Documentation:
   Enabled: false
-Style/AccessorMethodName:
-  Enabled: false
 Style/CommentedKeyword:
   Enabled: false
 Style/PercentLiteralDelimiters:
   Enabled: false
+Style/BracesAroundHashParameters:
+  Enabled: false
 Lint/NestedMethodDefinition:
   Enabled: false
+Naming/AccessorMethodName:
+  Enabled: false

data/CHANGELOG.md

@@ -3,6 +3,25 @@ All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
 ### Enhancements
+
+### Bug fixes
+
+### Deprecations
+
+## [1.2.0] - 2017-12-23
+### Enhancements
+- Append `appium:` prefix for capabilities automatically due to W3C format.
+- add take element screenshot for oss module [#33](https://github.com/appium/ruby_lib_core/pull/33)
+- add w3c touch action tests and some supports for w3c [#35](https://github.com/appium/ruby_lib_core/pull/35)
+    - IME related
+    - Touch actions based on W3C spec
+
+### Bug fixes
+
+### Deprecations
+
+## [1.1.0] - 2017-12-16
+### Enhancements
 - Add guidelines in `.github`
 - session/:session_id/appium/device/keyevent [#21](https://github.com/appium/ruby_lib_core/issues/21)
 

data/appium_lib_core.gemspec

@@ -22,12 +22,12 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'selenium-webdriver', '~> 3.4', '>= 3.4.1'
+  spec.add_runtime_dependency 'selenium-webdriver', '~> 3.5'
   spec.add_runtime_dependency 'json', '>= 1.8'
 
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'yard', '~> 0.9'
+  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.1.0'

data/lib/appium_lib_core/common/base.rb

@@ -1,6 +1,8 @@
 # The following files have selenium-webdriver related stuff.
 require_relative 'base/driver'
 require_relative 'base/bridge'
+require_relative 'base/msjsonwp_bridge'
+require_relative 'base/w3c_bridge'
 require_relative 'base/capabilities'
 require_relative 'base/http_default'
 require_relative 'base/search_context'

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

@@ -2,6 +2,16 @@ module Appium
   module Core
     class Base
       class Bridge < ::Selenium::WebDriver::Remote::Bridge
+        # Almost same as self.handshake in ::Selenium::WebDriver::Remote::Bridge
+        #
+        # Implements protocol handshake which:
+        #
+        #   1. Creates session with driver.
+        #   2. Sniffs response.
+        #   3. Based on the response, understands which dialect we should use.
+        #
+        # @return [CoreBridgeMJSONWP, CoreBridgeW3C]
+        #
         def self.handshake(**opts)
           desired_capabilities = opts.delete(:desired_capabilities)
 
@@ -25,36 +35,54 @@ module Appium
           end
         end
 
+        # Append `appium:` prefix for Appium following W3C spec
+        # https://www.w3.org/TR/webdriver/#dfn-validate-capabilities
+        #
+        # @param [::Selenium::WebDriver::Remote::W3C::Capabilities, Hash] capabilities A capability
+        # @return [::Selenium::WebDriver::Remote::W3C::Capabilities]
+        def add_appium_prefix(capabilities)
+          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.new
+
+          capabilities = capabilities.__send__(:capabilities) unless capabilities.is_a?(Hash)
+          capabilities.each do |name, value|
+            next if value.nil?
+            next if value.is_a?(String) && value.empty?
+
+            capability_name = name.to_s
+            w3c_name = appium_prefix?(capability_name, w3c_capabilities) ? name : "appium:#{capability_name}"
+
+            w3c_capabilities[w3c_name] = value
+          end
+
+          w3c_capabilities
+        end
+
         private
 
+        APPIUM_PREFIX = 'appium:'.freeze
+        def appium_prefix?(capability_name, w3c_capabilities)
+          snake_cased_capability_names = ::Selenium::WebDriver::Remote::W3C::Capabilities::KNOWN.map(&:to_s)
+          camel_cased_capability_names = snake_cased_capability_names.map(&w3c_capabilities.method(:camel_case))
+
+          snake_cased_capability_names.include?(capability_name) ||
+            camel_cased_capability_names.include?(capability_name) ||
+            capability_name.start_with?(APPIUM_PREFIX)
+        end
+
         # Use capabilities directory because Appium's capability is based on W3C one.
-        # Called in bridge.create_session(desired_capabilities)
+        # Called in bridge.create_session(desired_capabilities) from Parent class
         def merged_capabilities(desired_capabilities)
+          new_caps = add_appium_prefix(desired_capabilities)
+          w3c_capabilities = ::Selenium::WebDriver::Remote::W3C::Capabilities.from_oss(new_caps)
+
           {
             desiredCapabilities: desired_capabilities,
             capabilities: {
-              firstMatch: [desired_capabilities]
+              firstMatch: [w3c_capabilities]
             }
           }
         end
       end # class Bridge
-
-      class CoreBridgeMJSONWP < ::Selenium::WebDriver::Remote::OSS::Bridge
-        def commands(command)
-          ::Appium::Core::Commands::COMMANDS_EXTEND_MJSONWP[command]
-        end
-      end # class CoreBridgeMJSONWP
-
-      class CoreBridgeW3C < ::Selenium::WebDriver::Remote::W3C::Bridge
-        def commands(command)
-          case command
-          when :status, :is_element_displayed
-            ::Appium::Core::Commands::COMMANDS_EXTEND_MJSONWP[command]
-          else
-            ::Appium::Core::Commands::COMMANDS_EXTEND_W3C[command]
-          end
-        end
-      end # class CoreBridgeW3C
     end # class Base
   end # module Core
 end # module Appium

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

@@ -20,10 +20,21 @@ module Appium
             extend ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
             extend ::Selenium::WebDriver::DriverExtensions::HasLocation
             extend ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
+          elsif @bridge.dialect == :w3c
+            # TODO: Only for Appium. Ideally, we'd like to remove the below like selenium-webdriver
+            extend ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
+            extend ::Selenium::WebDriver::DriverExtensions::HasLocation
+            extend ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection
           end
           super(@bridge, listener: listener)
         end
 
+        # Get the dialect value
+        # @return [:oss|:w3c]
+        def dialect
+          @bridge.dialect
+        end
+
         # Get the device window's size.
         # @return [Selenium::WebDriver::Dimension]
         #

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

@@ -0,0 +1,11 @@
+module Appium
+  module Core
+    class Base
+      class CoreBridgeMJSONWP < ::Selenium::WebDriver::Remote::OSS::Bridge
+        def commands(command)
+          ::Appium::Core::Commands::COMMANDS_EXTEND_MJSONWP[command]
+        end
+      end # class CoreBridgeMJSONWP
+    end # class Base
+  end # module Core
+end # module Appium

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

@@ -0,0 +1,65 @@
+module Appium
+  module Core
+    class Base
+      class CoreBridgeW3C < ::Selenium::WebDriver::Remote::W3C::Bridge
+        def commands(command)
+          ::Appium::Core::Commands::COMMANDS_EXTEND_W3C[command]
+        end
+
+        def action(async = false)
+          ::Selenium::WebDriver::W3CActionBuilder.new self,
+                                                      ::Selenium::WebDriver::Interactions.pointer(:touch, name: 'touch'),
+                                                      ::Selenium::WebDriver::Interactions.key('keyboard'),
+                                                      async
+        end
+        alias actions action
+
+        # override
+        def find_element_by(how, what, parent = nil)
+          how, what = convert_locators(how, what)
+
+          id = if parent
+                 execute :find_child_element, { id: parent }, { using: how, value: what }
+               else
+                 execute :find_element, {}, { using: how, value: what }
+               end
+          ::Selenium::WebDriver::Element.new self, element_id_from(id)
+        end
+
+        # override
+        def find_elements_by(how, what, parent = nil)
+          how, what = convert_locators(how, what)
+
+          ids = if parent
+                  execute :find_child_elements, { id: parent }, { using: how, value: what }
+                else
+                  execute :find_elements, {}, { using: how, value: what }
+                end
+
+          ids.map { |id| ::Selenium::WebDriver::Element.new self, element_id_from(id) }
+        end
+
+        private
+
+        # Don't convert locators for Appium Client
+        # TODO: Only for Appium. Ideally, we'd like to keep the selenium-webdriver
+        def convert_locators(how, what)
+          # case how
+          # when 'class name'
+          #   how = 'css selector'
+          #   what = ".#{escape_css(what)}"
+          # when 'id'
+          #   how = 'css selector'
+          #   what = "##{escape_css(what)}"
+          # when 'name'
+          #   how = 'css selector'
+          #   what = "*[name='#{escape_css(what)}']"
+          # when 'tag name'
+          #   how = 'css selector'
+          # end
+          [how, what]
+        end
+      end # class CoreBridgeW3C
+    end # class Base
+  end # module Core
+end # module Appium

data/lib/appium_lib_core/common/command.rb

@@ -72,8 +72,27 @@ module Appium
       COMMANDS = {}.merge(COMMAND).merge(COMMAND_ANDROID).merge(COMMAND_IOS)
                    .merge(COMMAND_NO_ARG).freeze
 
-      COMMANDS_EXTEND_MJSONWP = COMMANDS.merge(::Appium::Core::Base::Commands::OSS).freeze
-      COMMANDS_EXTEND_W3C = COMMANDS.merge(::Appium::Core::Base::Commands::W3C).freeze
+      COMMANDS_EXTEND_MJSONWP = COMMANDS.merge(
+        {
+          # W3C already has.
+          take_element_screenshot:    [:get, 'session/:session_id/element/:id/screenshot'.freeze]
+        }
+      ).merge(::Appium::Core::Base::Commands::OSS).freeze
+      COMMANDS_EXTEND_W3C = COMMANDS.merge(
+        {
+          # ::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],
+
+          # For IME
+          ime_get_available_engines: [:get,  'session/:session_id/ime/available_engines'.freeze],
+          ime_get_active_engine:     [:get,  'session/:session_id/ime/active_engine'.freeze],
+          ime_is_activated:          [:get,  'session/:session_id/ime/activated'.freeze],
+          ime_deactivate:            [:post, 'session/:session_id/ime/deactivate'.freeze],
+          ime_activate_engine:       [:post, 'session/:session_id/ime/activate'.freeze]
+        }
+      ).merge(::Appium::Core::Base::Commands::W3C).freeze
     end
   end
 end

data/lib/appium_lib_core/common/device.rb

@@ -375,6 +375,16 @@ module Appium
       #   @driver.switch_to_default_context
       #
 
+      # @!method take_element_screenshot(element, png_path)
+      # @param [Selenium::WebDriver::Element] element A element you'd like to take screenshot.
+      # @param [String] png_path A path to save the screenshot
+      # @return [File] Path to the screenshot.
+      #
+      # @example
+      #
+      #   @driver.take_element_screenshot(element, "fine_name.png")
+      #
+
       ####
       ## class << self
       ####
@@ -454,6 +464,19 @@ module Appium
             end
           end
 
+          add_endpoint_method(:take_element_screenshot) do
+            def take_element_screenshot(element, png_path)
+              result = execute :take_element_screenshot, id: element.ref
+
+              extension = File.extname(png_path).downcase
+              if extension != '.png'
+                WebDriver.logger.warn 'name used for saved screenshot does not match file type. '\
+                                'It should end with .png extension'
+              end
+              File.open(png_path, 'wb') { |f| f << result.unpack('m')[0] }
+            end
+          end
+
           add_endpoint_method(:set_immediate_value) do
             def set_immediate_value(element, *value)
               keys = ::Selenium::WebDriver::Keys.encode(value)

data/lib/appium_lib_core/driver.rb

@@ -194,6 +194,15 @@ module Appium
           raise e.message, ::Appium::Core::Error::ServerError
         end
 
+        Appium::Logger.debug(e.message)
+        {}
+      rescue Selenium::WebDriver::Error::WebDriverError => e
+        # FIXME: Temporary rescue until Appium support W3C's implicit wait
+        # https://github.com/jlipps/simple-wd-spec#set-timeouts
+        unless e.message.include?('Parameters were incorrect. We wanted {"required":["type","ms"]} and you sent ["implicit"]')
+          raise e.message, ::Appium::Core::Error::ServerError
+        end
+
         Appium::Logger.debug(e.message)
         {}
       end

data/lib/appium_lib_core/version.rb

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

data/release_notes.md

@@ -1,3 +1,13 @@
+#### v1.2.0 2017-12-23
+
+- [28f937b](https://github.com/appium/ruby_lib_core/commit/28f937bbaf15a7d99b8870b5b1ec1f063414ea3b) Release 1.2.0
+- [27c1475](https://github.com/appium/ruby_lib_core/commit/27c1475d4cce8271ddc8409c14fb7bdfa1ff6834) update changelog
+- [82e2526](https://github.com/appium/ruby_lib_core/commit/82e2526de95b05e8a49872e0b69835e99acc66e5) add w3c touch action tests and some supports for w3c (#35)
+- [415b908](https://github.com/appium/ruby_lib_core/commit/415b90827105e84234e52f5faedde02357083b66) add take element screenshot for oss (#33)
+- [9dd9c83](https://github.com/appium/ruby_lib_core/commit/9dd9c83271483727e4429e7e6602480da214e118) add adding appium-prefix for W3C format (#34)
+- [cb94184](https://github.com/appium/ruby_lib_core/commit/cb94184854a9977a08f15a44843778314470a73a) update changelog
+
+
 #### v1.1.0 2017-12-16
 
 - [29b36af](https://github.com/appium/ruby_lib_core/commit/29b36af7af280308f7cfc2ee7ffa1738085e0306) Release 1.1.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-16 00:00:00.000000000 Z
+date: 2017-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.1
+        version: '3.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.4'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.4.1
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -214,7 +208,9 @@ files:
 - lib/appium_lib_core/common/base/command.rb
 - lib/appium_lib_core/common/base/driver.rb
 - lib/appium_lib_core/common/base/http_default.rb
+- lib/appium_lib_core/common/base/msjsonwp_bridge.rb
 - lib/appium_lib_core/common/base/search_context.rb
+- lib/appium_lib_core/common/base/w3c_bridge.rb
 - lib/appium_lib_core/common/base/wait.rb
 - lib/appium_lib_core/common/command.rb
 - lib/appium_lib_core/common/device.rb