appium_lib_core 0.1.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c8ece47da94c268805eb431b20d411099c072b16
-  data.tar.gz: 7cbd93d666002cf928739f0a2c3355fe1b9d4943
+  metadata.gz: e078b7ab6ce69ac4202cb8bfbf1669a621a1f7c3
+  data.tar.gz: 9f9ad00010a0ae6204d5aa92c5838ff5abc2b9a3
 SHA512:
-  metadata.gz: '08569855bfec486d334afdd76354a70bceab9a28c5c074b3ea677eff3e4ba4d8cfc2eb7d139a6b13b22792f4395dc45ded3f2cad4141b5dd093c52fd20379322'
-  data.tar.gz: 5eb6a35ae0c90ff6ae6a3f850c5e94f4215629a80737afa2e66f956035803cef499b71ab98b6387751db63788f90c8a596e3d3a6fd97533e40121d312afc98eb
+  metadata.gz: e128a4e5e56dd1456eee1d3fbc74b2a966254a7cc9bf420b64a70a71122a22913dfb87b843dd6f5c3b88a701ebec8d07e357cd20c5403b026c3dab1e163cbcc9
+  data.tar.gz: da0230b20ef8544d892f87f1caf2f1c2dd5c959bacf2ee5b99f2a673c7269d1d957608e5912204d476491271c8a480137594793775b9438c5c47d611167f02dd

data/.rubocop.yml

@@ -1,3 +1,5 @@
+AllCops:
+  TargetRubyVersion: 2.2
 Metrics/LineLength:
   Max: 128
 Metrics/MethodLength:
@@ -16,5 +18,9 @@ Style/Documentation:
   Enabled: false
 Style/AccessorMethodName:
   Enabled: false
+Style/CommentedKeyword:
+  Enabled: false
+Style/PercentLiteralDelimiters:
+  Enabled: false
 Lint/NestedMethodDefinition:
   Enabled: false

data/.travis.yml

@@ -8,7 +8,7 @@ rvm:
 
 script:
   - bundle exec rake rubocop
-  - rake test:unit
+  - bundle exec rake test:unit
 
 notifications:
   email:

data/CHANGELOG.md

@@ -2,10 +2,12 @@
 All notable changes to this project will be documented in this file.
 
 ## [Unreleased]
-
-## [0.0.0] - 2017-10-20
 ### Enhancements
 
 ### Bug fixes
 
 ### Deprecations
+
+## [1.0.0] - 2017-11-12
+
+Initial release

data/README.md

@@ -2,35 +2,93 @@
 
 [![Gem Version](https://badge.fury.io/rb/appium_lib_core.svg)](https://badge.fury.io/rb/appium_lib_core)
 
+
+[![Build Status](https://travis-ci.org/appium/ruby_lib_core.svg?branch=master)](https://travis-ci.org/appium/ruby_lib_core)
+
 # Documentation
 
 - http://www.rubydoc.info/github/appium/ruby_lib_core
 
-# base library
+# Related library
 - https://github.com/appium/ruby_lib
 
 # How to start
-## Start Appium server
+## Run tests
+### Unit Tests
+Run unit tests which check each method and commands, URL, using the webmock.
 
 ```bash
+$ bundle install
+$ rake test:unit
+```
+
+### Functional Tests
+Run functional tests which require the Appium server and real device, Simulator/Emulator.
+
+- Start Appium server
+ ```bash
 $ npm install -g appium
 $ appium
 ```
 
-## Run tests
-
-```bash
+- Conduct tests
+ ```bash
 $ bundle install
-$ rake test:func:android # Andorid
+$ rake test:func:android # Andorid 
 $ rake test:func:ios     # iOS
 ```
 
+## Run a test case
+1. Launch the Appium server locally.
+2. Run the following script.
+
+- `test.rb`
+ ```ruby
+require 'rubygems'
+require 'appium_lib_core'
+
+opts = {
+  caps: {
+    platformName: :ios,
+    platformVersion: '11.0',
+    deviceName: 'iPhone Simulator',
+    automationName: 'XCUITest',
+    app: '/path/to/MyiOS.app'
+  },
+  appium_lib: {
+    wait: 30
+  }
+}
+@core = Appium::Core.for(self, opts) # create a core driver with `opts` and extend methods into `self`
+@driver = @core.start_driver
+
+# Launch iPhone Simulator and `MyiOS.app`
+@driver.find_element(:accessibility_id, 'some accessibility') # find an element
+```
+
+- Run the script
+```bash
+# shell 1
+$ appium
+
+# shell 2
+$ ruby test.rb
+```
+
 # Release
+Use [appium_thor](https://github.com/appium/appium_thor) to release this gem.
 
 ```bash
-$ bundle exec thor bump # bumpy, bumpz
-$ bundle exec thor release
+$ thor bump # bumpy,
+$ thor release
 ```
 
+# Contribution
+1. Fork it ( https://github.com/appium/ruby_lib_core/fork )
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Add some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request
+
 # License
 Apache License v2

data/Rakefile

@@ -54,9 +54,20 @@ YARD::Rake::YardocTask.new do |t|
   t.files   = ['lib/**/*.rb']
 end
 
-desc 'Execute RuboCop static code analysis'
+desc('Execute RuboCop static code analysis')
 RuboCop::RakeTask.new(:rubocop) do |t|
-  t.patterns = %w(lib test)
+  t.patterns = %w(lib test script)
   t.options = %w(-D)
   t.fail_on_error = true
 end
+
+desc("print commands which haven't implemented yet.")
+namespace :commands do
+  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
+end

data/appium_lib_core.gemspec

@@ -32,6 +32,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest-reporters', '~> 1.1'
   spec.add_development_dependency 'webmock', '~> 3.1.0'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop', '0.51.0'
   spec.add_development_dependency 'appium_thor', '~> 0.0', '>= 0.0.7'
 end

data/lib/appium_lib_core/android/device.rb

@@ -118,7 +118,7 @@ module Appium
               app_wait_package  = opts.fetch(:app_wait_package, '')
               app_wait_activity = opts.fetch(:app_wait_activity, '')
 
-              unknown_opts = opts.keys - [:app_package, :app_activity, :app_wait_package, :app_wait_activity]
+              unknown_opts = opts.keys - %i(app_package app_activity app_wait_package app_wait_activity)
               raise "Unknown options #{unknown_opts}" unless unknown_opts.empty?
 
               execute :start_activity, {}, appPackage: app_package,

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

@@ -16,8 +16,8 @@ module Appium
           capabilities = bridge.create_session(desired_capabilities)
 
           case bridge.dialect
-          when :oss
-            CoreBridgeOSS.new(capabilities, bridge.session_id, opts)
+          when :oss # for MJSONWP
+            CoreBridgeMJSONWP.new(capabilities, bridge.session_id, opts)
           when :w3c
             CoreBridgeW3C.new(capabilities, bridge.session_id, opts)
           else
@@ -26,17 +26,17 @@ module Appium
         end
       end # class Bridge
 
-      class CoreBridgeOSS < ::Selenium::WebDriver::Remote::OSS::Bridge
+      class CoreBridgeMJSONWP < ::Selenium::WebDriver::Remote::OSS::Bridge
         def commands(command)
-          ::Appium::Core::Commands::COMMANDS_EXTEND_OSS[command]
+          ::Appium::Core::Commands::COMMANDS_EXTEND_MJSONWP[command]
         end
-      end # class CoreBridgeOSS
+      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_OSS[command]
+            ::Appium::Core::Commands::COMMANDS_EXTEND_MJSONWP[command]
           else
             ::Appium::Core::Commands::COMMANDS_EXTEND_W3C[command]
           end

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

@@ -16,7 +16,7 @@ module Appium
         def initialize(opts = {})
           listener = opts.delete(:listener)
           @bridge = ::Appium::Core::Base::Bridge.handshake(opts)
-          if @bridge.dialect == :oss
+          if @bridge.dialect == :oss # MJSONWP
             extend ::Selenium::WebDriver::DriverExtensions::HasTouchScreen
             extend ::Selenium::WebDriver::DriverExtensions::HasLocation
             extend ::Selenium::WebDriver::DriverExtensions::HasNetworkConnection

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

@@ -6,9 +6,9 @@ module Appium
         require 'timeout' # for wait
 
         def initialize(opts = {})
-          valid_keys = [:timeout, :interval, :message, :ignore, :return_if_true]
+          valid_keys = %i(timeout interval message ignore return_if_true)
           invalid_keys = []
-          opts.keys.each { |key| invalid_keys << key unless valid_keys.include?(key) }
+          opts.each_key { |key| invalid_keys << key unless valid_keys.include?(key) }
           # [:one, :two] => :one, :two
           unless invalid_keys.empty?
             raise "Invalid keys #{invalid_keys.to_s[1..-2]}. Valid keys are #{valid_keys.to_s[1..-2]}"

data/lib/appium_lib_core/common/command.rb

@@ -70,7 +70,7 @@ module Appium
       COMMANDS = {}.merge(COMMAND).merge(COMMAND_ANDROID).merge(COMMAND_IOS)
                    .merge(COMMAND_NO_ARG).freeze
 
-      COMMANDS_EXTEND_OSS = COMMANDS.merge(::Appium::Core::Base::Commands::OSS).freeze
+      COMMANDS_EXTEND_MJSONWP = COMMANDS.merge(::Appium::Core::Base::Commands::OSS).freeze
       COMMANDS_EXTEND_W3C = COMMANDS.merge(::Appium::Core::Base::Commands::W3C).freeze
     end
   end

data/lib/appium_lib_core/common/device.rb

@@ -264,6 +264,48 @@ module Appium
       #   ime_deactivate #=> Deactivate current IME engine
       #
 
+      # @!method set_context(context)
+      # Change the context to the given context.
+      # @param [String] context The context to change to
+      #
+      # @example
+      #
+      #   @driver.set_context "NATIVE_APP"
+      #
+
+      # @!method current_context
+      # @return [String] The context currently being used.
+      #
+      # @example
+      #
+      #   @driver.current_context
+      #
+
+      # @!method available_contexts
+      # @return [Array<String>] All usable contexts, as an array of strings.
+      #
+      # @example
+      #
+      #   @driver.available_contexts
+      #
+
+      # Perform a block within the given context, then switch back to the starting context.
+      # @param [String] context The context to switch to for the duration of the block.
+      #
+      # @example
+      #
+      #   result = @driver.within_context('NATIVE_APP') do
+      #     @driver.find_element :tag, "button"
+      #   end # The result of `find_element :tag, "button"`
+      #
+
+      # Change to the default context. This is equivalent to `set_context nil`.
+      #
+      # @example
+      #
+      #   @driver.switch_to_default_context
+      #
+
       ####
       ## class << self
       ####
@@ -283,8 +325,8 @@ module Appium
             end
           end
 
-          # TODO: Don't define selenium-side methods. We pick up from them.
-          # ::Appium::Core::Base::Commands::OSS.each_key do |method|
+          # Don't define selenium-side methods. We pick up from them.
+          # ::Appium::Core::Base::Commands::MJSONWP.each_key do |method|
           #   add_endpoint_method method
           # end
 
@@ -414,6 +456,7 @@ module Appium
 
           add_touch_actions
           add_ime_actions
+          add_handling_context
         end
 
         # def extended
@@ -447,7 +490,7 @@ module Appium
 
         # @private
         def create_bridge_command(method)
-          ::Appium::Core::Base::CoreBridgeOSS.class_eval do
+          ::Appium::Core::Base::CoreBridgeMJSONWP.class_eval do
             block_given? ? class_eval(&Proc.new) : define_method(method) { execute method }
           end
           ::Appium::Core::Base::CoreBridgeW3C.class_eval do
@@ -505,63 +548,29 @@ module Appium
             end
           end
         end
-      end # class << self
-
-      # @!method set_context(context)
-      # Change the context to the given context.
-      # @param [String] context The context to change to
-      #
-      # @example
-      #
-      #   @driver.set_context "NATIVE_APP"
-      #
-
-      # @!method current_context
-      # @return [String] The context currently being used.
-      #
-      # @example
-      #
-      #   @driver.current_context
-      #
 
-      # @!method available_contexts
-      # @return [Array<String>] All usable contexts, as an array of strings.
-      #
-      # @example
-      #
-      #   @driver.available_contexts
-      #
+        def add_handling_context
+          add_endpoint_method(:within_context) do
+            def within_context(context)
+              existing_context = current_context
+              set_context context
+              if block_given?
+                result = yield
+                set_context existing_context
+                result
+              else
+                set_context existing_context
+              end
+            end
+          end
 
-      # Perform a block within the given context, then switch back to the starting context.
-      # @param [String] context The context to switch to for the duration of the block.
-      #
-      # @example
-      #
-      #   result = @driver.within_context('NATIVE_APP') do
-      #     @driver.find_element :tag, "button"
-      #   end # The result of `find_element :tag, "button"`
-      #
-      def within_context(context)
-        existing_context = current_context
-        set_context context
-        if block_given?
-          result = yield
-          set_context existing_context
-          result
-        else
-          set_context existing_context
+          add_endpoint_method(:switch_to_default_context) do
+            def switch_to_default_context
+              set_context nil
+            end
+          end
         end
-      end
-
-      # Change to the default context. This is equivalent to `set_context nil`.
-      #
-      # @example
-      #
-      #   @driver.switch_to_default_context
-      #
-      def switch_to_default_context
-        set_context nil
-      end
+      end # class << self
     end # module Device
   end # module Core
 end # module Appium

data/lib/appium_lib_core/device/multi_touch.rb

@@ -9,17 +9,11 @@ module Appium
     #
     # @example
     #
-    #   action_1 = TouchAction.new.press(x: 45, y: 100).wait(5).release
-    #   action_2 = TouchAction.new.tap(element: el, x: 50, y:5, count: 3)
+    #   @driver = Appium::Core.for(self, opts).start_driver
+    #   action_1 = TouchAction.new(@driver).press(x: 45, y: 100).wait(5).release
+    #   action_2 = TouchAction.new(@driver).tap(element: el, x: 50, y:5, count: 3)
     #
-    #   multi_touch_action = MultiTouch.new
-    #   multi_touch_action.add action_1
-    #   multi_touch_action.add action_2
-    #   multi_touch_action.perform
-    #
-    #   # with an arbitrary driver
-    #   driver = Appium::Driver.new(opts, false).start_driver
-    #   multi_touch_action = MultiTouch.new(driver)
+    #   multi_touch_action = MultiTouch.new(@driver)
     #   multi_touch_action.add action_1
     #   multi_touch_action.add action_2
     #   multi_touch_action.perform

data/lib/appium_lib_core/device/touch_actions.rb

@@ -4,16 +4,18 @@ module Appium
   #
   # Each method returns the object itself, so calls can be chained.
   #
-  # ```ruby
-  # action = TouchAction(@driver).new.press(x: 45, y: 100).wait(5).release
-  # action.perform
-  # action = TouchAction.new.swipe(....)
-  # action.perform
-  # ```
+  # @example
+  #
+  #   @driver = Appium::Core.for(self, opts).start_driver
+  #   action = TouchAction.new(@driver).press(x: 45, y: 100).wait(5).release
+  #   action.perform
+  #   action = TouchAction.new(@driver).swipe(....)
+  #   action.perform
+  #
   module Core
     class TouchAction
-      ACTIONS         = [:move_to, :long_press, :double_tap, :two_finger_tap, :press, :release, :tap, :wait, :perform].freeze
-      COMPLEX_ACTIONS = [:swipe].freeze
+      ACTIONS = %i(move_to long_press double_tap two_finger_tap press release tap wait perform).freeze
+      COMPLEX_ACTIONS = %i(swipe).freeze
 
       attr_reader :actions, :driver
 
@@ -44,7 +46,7 @@ module Appium
       # @option y [integer] y co-ordinate to press on.
       # @option duration [integer] Number of milliseconds to press.
       def long_press(opts)
-        args = opts.select { |k, _v| [:element, :x, :y, :duration].include? k }
+        args = opts.select { |k, _v| %i(element x y duration).include? k }
         args = args_with_ele_ref(args)
         chain_method(:longPress, args) # longPress is what the appium server expects
       end
@@ -56,7 +58,7 @@ module Appium
       # @option opts [integer] :x x co-ordinate to press on
       # @option opts [integer] :y y co-ordinate to press on
       def press(opts)
-        args = opts.select { |k, _v| [:element, :x, :y].include? k }
+        args = opts.select { |k, _v| %i(element x y).include? k }
         args = args_with_ele_ref(args)
         chain_method(:press, args)
       end
@@ -92,7 +94,7 @@ module Appium
       # @option opts [integer] :y y co-ordinate to tap
 
       def double_tap(opts)
-        args = opts.select { |k, _v| [:element, :x, :y].include? k }
+        args = opts.select { |k, _v| %i(element x y).include? k }
         args = args_with_ele_ref(args)
         chain_method(:doubleTap, args) # doubleTap is what the appium server expects
       end
@@ -103,7 +105,7 @@ module Appium
       # @option opts [integer] :x x co-ordinate to tap
       # @option opts [integer] :y y co-ordinate to tap
       def two_finger_tap(opts)
-        args = opts.select { |k, _v| [:element, :x, :y].include? k }
+        args = opts.select { |k, _v| %i(element x y).include? k }
         args = args_with_ele_ref(args)
         chain_method(:twoFingerTap, args) # twoFingerTap is what the appium server expects
       end

data/lib/appium_lib_core/driver.rb

@@ -18,41 +18,42 @@ module Appium
       # @return [Hash]
       attr_reader :automation_name
 
-      # Custom URL for the selenium server. If set this attribute, ruby_lib try to handshake to the custom url.
+      # Custom URL for the selenium server. If set this attribute, ruby_lib_core try to handshake to the custom url.
+      # False is by default and then "http://127.0.0.1:#{@port}/wd/hub" is used.
       # @return [String]
       attr_reader :custom_url
 
-      # Export session id to textfile in /tmp for 3rd party tools
+      # Export session id to textfile in /tmp for 3rd party tools. False bu default.
       # @return [Boolean]
       attr_reader :export_session
       # @return [String] By default, session id is exported in '/tmp/appium_lib_session'
       attr_reader :export_session_path
 
       # Default wait time for elements to appear
-      # Returns the default client side wait.
-      # This value is independent of what the server is using
-      # Provide Appium::Drive like { appium_lib: { wait: 20 } }
+      # Returns the default client side wait. 20 second is by default.
+      # Provide Appium::Drive like { appium_lib: { wait: 30 } }
       # @return [Integer]
       attr_reader :default_wait
 
-      # Appium's server port
+      # Appium's server port. 4723 is by default.
       # Provide Appium::Drive like { appium_lib: { port: 8080 } }
       # @return [Integer]
       attr_reader :port
 
-      # Return a time wait timeout
+      # Return a time wait timeout. 30 second is by default.
       # Wait time for ::Appium::Core::Base::Wait, wait and wait_true
       # Provide Appium::Drive like { appium_lib: { wait_timeout: 20 } }
       # @return [Integer]
       attr_reader :wait_timeout
 
-      # Return a time wait timeout
+      # Return a time to wait interval. 0.5 second is by default.
       # Wait interval time for ::Appium::Core::Base::Wait, wait and wait_true
-      # Provide Appium::Drive like { appium_lib: { wait_interval: 20 } }
+      # Provide Appium::Drive like { appium_lib: { wait_interval: 0.1 } }
       # @return [Integer]
       attr_reader :wait_interval
 
       # instance of AbstractEventListener for logging support
+      # Nil by default
       attr_reader :listener
 
       # @return [Appium::Core::Base::Driver]
@@ -66,12 +67,15 @@ module Appium
       # @example
       #
       #     require 'rubygems'
-      #     require 'appium_lib'
+      #     require 'appium_lib_core'
       #
       #     # Start iOS driver
       #     opts = {
       #              caps: {
       #                platformName: :ios,
+      #                platformVersion: '11.0',
+      #                deviceName: 'iPhone Simulator',
+      #                automationName: 'XCUITest',
       #                app: '/path/to/MyiOS.app'
       #              },
       #              appium_lib: {
@@ -84,8 +88,8 @@ module Appium
       #                listener: nil,
       #              }
       #            }
-      #     @core_driver = Appium::Core.for(self, opts) # create a core driver with `opts` and extend methods into `self`
-      #     @core_driver.start_driver(server_url: server_url, http_client_ops: http_client_ops) # start driver
+      #     @core = Appium::Core.for(self, opts) # create a core driver with `opts` and extend methods into `self`
+      #     @core.start_driver(server_url: server_url) # start driver
       #
       def self.for(target, opts = {})
         new(target, opts)
@@ -105,7 +109,7 @@ module Appium
 
         extend_for(device: @device, automation_name: @automation_name, target: target)
 
-        self
+        self # rubocop:disable Lint/Void
       end
 
       # Creates a new global driver and quits the old one if it exists.
@@ -120,7 +124,7 @@ module Appium
       # @example
       #
       #     require 'rubygems'
-      #     require 'appium_lib'
+      #     require 'appium_lib_core'
       #
       #     # platformName takes a string or a symbol.
       #
@@ -128,24 +132,25 @@ module Appium
       #     opts = {
       #              caps: {
       #                platformName: :ios,
+      #                platformVersion: '11.0',
+      #                deviceName: 'iPhone Simulator',
+      #                automationName: 'XCUITest',
       #                app: '/path/to/MyiOS.app'
       #              },
       #              appium_lib: {
-      #                server_url: "http://custom-host:8080/wd/hub.com",
-      #                export_session: false,
-      #                port: 8080,
-      #                wait: 0,
+      #                wait: 20,
       #                wait_timeout: 20,
       #                wait_interval: 0.3,
-      #                listener: nil,
       #              }
       #            }
-      #     @core = Appium::Driver.new(opts)
+      #
+      #     @core = Appium::Core.for(self, opts) # create a core driver with `opts` and extend methods into `self`
       #     @driver = @core.start_driver
       #
+
       def start_driver(server_url: nil,
                        http_client_ops: { http_client: nil, open_timeout: 999_999, read_timeout: 999_999 })
-        server_url = server_url ? server_url : "http://127.0.0.1:#{@port}/wd/hub"
+        server_url ||= "http://127.0.0.1:#{@port}/wd/hub"
 
         # open_timeout and read_timeout are explicit wait.
         open_timeout = http_client_ops.delete(:open_timeout)
@@ -204,7 +209,7 @@ module Appium
       #
       def quit_driver
         @driver.quit
-      rescue
+      rescue # rubocop:disable Lint/RescueWithoutErrorClass
         nil
       end
 
@@ -407,7 +412,7 @@ module Appium
       # @private
       def set_appium_lib_specific_values(appium_lib_opts)
         @custom_url = appium_lib_opts.fetch :server_url, false
-        @default_wait = appium_lib_opts.fetch :wait, 0
+        @default_wait = appium_lib_opts.fetch :wait, 20
 
         # bump current session id into a particular file
         @export_session = appium_lib_opts.fetch :export_session, false

data/lib/appium_lib_core/version.rb

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

data/release_notes.md

@@ -1,3 +1,21 @@
+#### v1.0.0 2017-11-12
+
+- [de176fe](https://github.com/appium/ruby_lib_core/commit/de176fe2fbcfaa341392e7f37ee537158ed2e23e) Release 1.0.0
+- [00fb812](https://github.com/appium/ruby_lib_core/commit/00fb812c71696cc2d265fc3921fb9fbffb4b0d62) update changelog
+- [30a60ef](https://github.com/appium/ruby_lib_core/commit/30a60ef932e04dbb4e2c0d3619b8f0f36e0b3e26) add script to get diff commands (#9)
+- [445cf6a](https://github.com/appium/ruby_lib_core/commit/445cf6ab4c3b5fc7cbdec72a1c4f9ba064c2b08a) update comments for touch actions
+- [1629f3a](https://github.com/appium/ruby_lib_core/commit/1629f3af6d6873171babc0d7231ba36a6b5a94fd) define MJSONWP instead of OSS (#8)
+- [7b698ca](https://github.com/appium/ruby_lib_core/commit/7b698ca592d96289a8e6ae511e6533ab05ced59c) update readme (#7)
+- [feb7f00](https://github.com/appium/ruby_lib_core/commit/feb7f009dad5d70e55f773f5b41467587720e6e3) add context related tests
+- [2716285](https://github.com/appium/ruby_lib_core/commit/27162850c13a67a98a51fee432e21d1cb6df449b) add bundle exec for test
+- [838c984](https://github.com/appium/ruby_lib_core/commit/838c9843b7342e1b530cbd6bbc92abc6c0ca7fb8) fix rubocop and set the version
+- [a633825](https://github.com/appium/ruby_lib_core/commit/a633825fc9171407cde3d65c396a98a8cd961f02) set 2.2
+- [4fee2c9](https://github.com/appium/ruby_lib_core/commit/4fee2c97377c4041cad4bfe583c044b42e6dc8d6) update documentation
+- [a8b94c0](https://github.com/appium/ruby_lib_core/commit/a8b94c0159943edad0df901813c4a134b027f196) update documentation and comments
+- [17bf48a](https://github.com/appium/ruby_lib_core/commit/17bf48af1f4bd33202d12c784fa2a78e63c30813) update driver test
+- [7885baf](https://github.com/appium/ruby_lib_core/commit/7885baf4768abeb0d70ebc47174e3f97096a525e) add unit tests for w3c
+
+
 #### v0.1.1 2017-11-04
 
 - [e5adc6d](https://github.com/appium/ruby_lib_core/commit/e5adc6d8d4a5db312dc7c11c73445d78c6239ec5) Release 0.1.1

data/script/commands.rb

@@ -0,0 +1,184 @@
+require 'net/http'
+require './lib/appium_lib_core'
+
+module Script
+  class CommandsChecker
+    attr_reader :spec_commands
+    attr_reader :implemented_mjsonwp_commands, :implemented_w3c_commands, :implemented_core_commands
+    attr_reader :webdriver_oss_commands, :webdriver_w3c_commands
+
+    # Set commands implemented in this core library.
+    #
+    # - implemented_mjsonwp_commands:  All commands include ::Selenium::WebDriver::Remote::OSS::Bridge::COMMANDS
+    # - implemented_w3c_commands:  All commands include ::Selenium::WebDriver::Remote::W3C::Bridge::COMMANDS
+    # - implemented_core_commands:  All commands except for selenium-webdriver's commands
+    # - webdriver_oss_commands: ::Selenium::WebDriver::Remote::OSS::Bridge::COMMANDS
+    # - webdriver_w3c_commands: ::Selenium::WebDriver::Remote::W3C::Bridge::COMMANDS
+    #
+    def initialize
+      @implemented_mjsonwp_commands = convert_driver_commands Appium::Core::Commands::COMMANDS_EXTEND_MJSONWP
+      @implemented_w3c_commands = convert_driver_commands Appium::Core::Commands::COMMANDS_EXTEND_W3C
+      @implemented_core_commands = convert_driver_commands Appium::Core::Commands::COMMANDS
+
+      @webdriver_oss_commands = convert_driver_commands Appium::Core::Base::Commands::OSS
+      @webdriver_w3c_commands = convert_driver_commands Appium::Core::Base::Commands::W3C
+    end
+
+    # Get the bellow url's file.
+    # https://raw.githubusercontent.com/appium/appium-base-driver/master/lib/mjsonwp/routes.js?raw=1
+    #
+    # @param [String] to_path: A file path to routes.js
+    # @return [String] The file path in which has saved `routes.js`.
+    #
+    def get_mjsonwp_routes(to_path = './mjsonwp_routes.js')
+      uri = URI 'https://raw.githubusercontent.com/appium/appium-base-driver/master/lib/mjsonwp/routes.js?raw=1'
+      result = Net::HTTP.get uri
+
+      File.delete to_path
+      File.write to_path, result
+      to_path
+    end
+
+    # @private
+    HTTP_METHOD_MATCH = /GET:|POST:|DELETE:|PUT:|PATCH:/
+    # @private
+    WD_HUB_PREFIX_MATCH = "'/wd/hub/".freeze
+
+    # Read routes.js and set the values in @spec_commands
+    #
+    # @param [String] path: A file path to routes.js
+    # @return [Hash] @spec_commands
+    #
+    def get_all_command_path(path = './mjsonwp_routes.js')
+      raise "No file in #{path}" unless File.exist? path
+
+      current_command = ''
+      @spec_commands = File.read(path).lines.each_with_object({}) do |line, memo|
+        if line =~ /#{WD_HUB_PREFIX_MATCH}.+'/
+          current_command = gsub_set(line.slice(/#{WD_HUB_PREFIX_MATCH}.+'/))
+          memo[current_command] = []
+        elsif line =~ HTTP_METHOD_MATCH
+          memo[current_command] << line.slice(HTTP_METHOD_MATCH).chop.downcase.to_sym
+        end
+        memo
+      end
+    end
+
+    # All commands which haven't been implemented in ruby core library yet.
+    # @return [Hash]
+    #
+    def all_diff_commands_mjsonwp
+      result = compare_commands(@spec_commands, @implemented_mjsonwp_commands)
+
+      white_list.each { |v| result.delete v }
+      w3c_spec.each { |v| result.delete v }
+
+      result
+    end
+
+    # All commands which haven't been implemented in ruby core library yet.
+    # @return [Hash]
+    #
+    def all_diff_commands_w3c
+      result = compare_commands(@spec_commands, @implemented_w3c_commands)
+      white_list.each { |v| result.delete v }
+      mjsonwp_spec.each { |v| result.delete v }
+      result
+    end
+
+    # Commands, only this core library, which haven't been implemented in ruby core library yet.
+    # @return [Hash]
+    #
+    def diff_except_for_webdriver
+      result = compare_commands(@spec_commands, @implemented_core_commands)
+      white_list.each { |v| result.delete v }
+      result
+    end
+
+    def diff_webdriver_oss
+      result = compare_commands(@spec_commands, @webdriver_oss_commands)
+      white_list.each { |v| result.delete v }
+      w3c_spec.each { |v| result.delete v }
+      result
+    end
+
+    def diff_webdriver_w3c
+      result = compare_commands(@spec_commands, @webdriver_w3c_commands)
+      white_list.each { |v| result.delete v }
+      mjsonwp_spec.each { |v| result.delete v }
+      result
+    end
+
+    def compare_commands(command1, with_command2)
+      return {} if command1.nil?
+      return command1 if with_command2.nil?
+
+      result = {}
+      command1.each_key do |key|
+        if with_command2.key? key
+          diff = command1[key] - with_command2[key]
+          result[key] = diff unless diff.empty?
+        else
+          result[key] = command1[key]
+        end
+      end
+      result
+    end
+
+    private
+
+    # rubocop:disable Lint/PercentStringArray
+    def white_list
+      %w(
+        '/wd/hub/session'
+        '/wd/hub/sessions'
+      ).map { |v| gsub_set(v) }
+    end
+
+    # https://raw.githubusercontent.com/appium/appium-base-driver/master/lib/mjsonwp/routes.js
+    def mjsonwp_spec
+      %w(
+        '/wd/hub/session/:sessionId/alert_text'
+        '/wd/hub/session/:sessionId/accept_alert'
+        '/wd/hub/session/:sessionId/dismiss_alert'
+      ).map { |v| gsub_set(v) }
+    end
+
+    def w3c_spec
+      %w(
+        '/wd/hub/session/:sessionId/alert/text'
+        '/wd/hub/session/:sessionId/alert/accept'
+        '/wd/hub/session/:sessionId/alert/dismiss'
+        '/wd/hub/session/:sessionId/element/:elementId/rect'
+      ).map { |v| gsub_set(v) }
+    end
+    # rubocop:enable Lint/PercentStringArray
+
+    def gsub_set(line)
+      return nil if line.gsub(/(\A#{WD_HUB_PREFIX_MATCH}|'\z)/, '').nil?
+
+      line.gsub(/(\A#{WD_HUB_PREFIX_MATCH}|'\z)/, '')
+          .sub(':sessionId', ':session_id')
+          .sub('element/:elementId', 'element/:id')
+          .sub(':windowhandle', ':window_handle')
+          .sub('equals/:otherId', 'equals/:other')
+          .sub('css/:propertyName', 'css/:property_name')
+          .sub('element/:id/pageIndex', 'element/:id/page_index')
+    end
+
+    def convert_driver_commands(from)
+      from.each_with_object({}) do |command, memo|
+        method = command[1][0]
+        key = command[1][1]
+
+        if memo[key]
+          memo[key] << method
+        else
+          memo[key] = [method]
+        end
+
+        memo
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: appium_lib_core
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Kazuaki MATSUO
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-04 00:00:00.000000000 Z
+date: 2017-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -146,16 +146,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.51.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.51.0
 - !ruby/object:Gem::Dependency
   name: appium_thor
   requirement: !ruby/object:Gem::Requirement
@@ -235,6 +235,7 @@ files:
 - lib/appium_lib_core/patch.rb
 - lib/appium_lib_core/version.rb
 - release_notes.md
+- script/commands.rb
 homepage: https://github.com/appium/ruby_lib_core/
 licenses:
 - Apache-2.0