Project

appium_capybara

0.08
A long-lived project that still receives updates
appium_capybaraappium/appium_capybaraHomepageDocumentationSource CodeBug TrackerWiki
Enables appium support in Capybara.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
1,136,255
Stars
40
Forks
34
Watchers
23
 Releases
Current version
3.1.2
Total releases
33
First release
2014-07-31
Latest release
2024-07-23
 Issues
Open Issues
3
Closed Issues
31
Total Issues
34
Issue Closure Rate
91%
 Pull Requests
Open Pull Requests
1
Closed Pull Requests
4
Merged Pull Requests
39
Pull Request Acceptance Rate
88%
 Development
Primary Language
Ruby
Licenses
http://www.apache.org/licenses/LICENSE-2.0.txt
Average date of last 50 commits
2022-04-15
Reverse Dependencies
0

 Dependencies

Development

appium_thor
~> 2.0

Runtime

appium_lib
>= 13.0.0
capybara
~> 3.36
 Project Readme

appium_capybara Gem Version

Documentation

Gem enabling appium support in capybara

Please use v1.4.1 for Capybara 2.x users. v1.5.0 requires Capybara 3.x.

Driver Setup

Set up the appium_capybara driver by running this before starting your test.

require 'appium_capybara'

desired_caps_ios = {
  platform:        "Mac",
  deviceName:      "iPhone Simulator",
  platformName:    "iOS",
  platformVersion: "12.4",
  app:             "full/path/to/app.zip"
}

url = "http://localhost:4723/wd/hub" # or a sauce labs url

Capybara.register_driver(:appium) do |app|
    appium_lib_options = {
      server_url: url
    }
    all_options = {
      appium_lib: appium_lib_options,
      caps: desired_caps_ios
    }
    Appium::Capybara::Driver.new app, all_options
end

Capybara.default_driver = :appium

Capybara server

appium_capybara driver automatically starts a Rails server in test environment.

By default Capybara starts this web server listening to localhost only and on a random port. It is advised to force Capybara to listen to all interface and listen to a specific port, and set this server address in your mobile application.

Capybara.server_host = '0.0.0.0' # Listen to all interfaces
Capybara.server_port = 56844     # Open port TCP 56844, change at your convenience

Call methods

appium_capybara provides both Capybara methods and appium_lib methods.

capy_driver = Capybara.current_session.driver

# Calls methods defined in Appium::Capybara::Driver and Capybara::Selenium::Driver
capy_driver.find_custom :name, '<enter text>'

# Calls methods defined in only appium_lib (Appium::Driver)
capy_driver.appium_driver.find_element(:name, 'TextFields').click
capy_driver.appium_driver.hide_keyboard

Publishing to rubygems

Make sure to run thor bump or manually modify version.rb before publishing. RubyGems will not allow the same version to be published twice. After the version is bumped, run thor publish

major changelogs

  • v3.0.0

    • Support Ruby 3+ only

  • v2.0.0

    • Bump base appium_lib version to v12
    • Bump base capybara version to over 3.36
    • Support Ruby 2.6+