niravi/ruby_lib

:gem: Ruby library for Appium

appium_lib

• appium_lib on RubyGems
• Documentation for appium_lib
  • Documentation for core lib
    • Especially driver method for Appium
• Getting Started
• code examples

Helper methods for writing cross platform (iOS, Android) tests in Ruby using Appium. Note that user waits should not exceed 120 seconds if they're going to run on Sauce Labs.

Ruby_lib_core is the core driver library which provide selenium-webdriver related features and driver methods for Appium. The ruby_lib wrap the driver and serve many helpful methods for users.

Setup

Requirement

• Appium
• Ruby: 2.2+

Start appium server

$ npm install -g appium
$ appium

Install / Upgrade

• Update rubygems and bundler

$ gem update --system
$ gem update bundler

• Install the latest gem release

gem uninstall -aIx appium_lib
gem install --no-rdoc --no-ri appium_lib

Sauce Labs env vars

• SAUCE_USERNAME Sauce username
• SAUCE_ACCESS_KEY Sauce API key
• SAUCE_ENDPOINT Alternative Sauce Appium Server endpoint (only use if directed)

(Note: If these variables are set, all tests will use Sauce Labs unless over-ridden in configuration.)

Documentation

• Getting started
• Overview
• Ruby Android methods
• Ruby iOS methods
  • Tips for XCUITest for iOS
• Appium Server docs

Related libraries

• ruby_lib_core: Bridged commands, WebDriver dependencies
  • We add new endpoints for Appium in the core library, and ruby_lib call the methods.
• ruby_console: Appium Ruby Console
• appium_capybara: Gem enabling appium support in capybara

Load Pry

Pry.config.pager = false is set if you have no .pryrc files and Pry is defined.

Contribute

How to add new commands for driver

• Add the new commands in ruby_lib_core. An example

How to add new helpful methods

• Add the new methods in this library