#### appium_lib [![Dependency Status](https://gemnasium.com/appium/ruby_lib.png)](https://gemnasium.com/appium/ruby_lib)

- [appium_lib on RubyGems](https://rubygems.org/gems/appium_lib)
- [Documentation for appium_lib](http://www.rubydoc.info/github/appium/ruby_lib/master/frames)
- [Appium Ruby Console](https://github.com/appium/ruby_console)

Helper methods for writing cross platform (iPad, iPhone, Android) tests in Ruby using Appium.

Make sure you're using Ruby 1.9.3+ with upgraded rubygems and bundler.

#### Start appium server

`node server.js -V --fast-reset --without-delay`

#### Install / Upgrade

Update rubygems and bundler.

```ruby
gem update --system ;\
gem update bundler
```

Install the latest gem release.

```ruby
gem uninstall -aIx appium_lib ;\
gem install --no-rdoc --no-ri appium_lib
```

#### Simple Usage

```ruby
require 'rubygems'
require 'appium_lib'

# Start iOS driver
app = { app_path: '/path/to/MyiOS.app'}
Appium::Driver.new(app).start_driver

# Start Android driver
apk = { app_path: '/path/to/the.apk',
        app_package: 'com.example.pkg',
        app_activity: 'act.Start',
        app_wait_activity: 'act.Start'
      }
Appium::Driver.new(apk).start_driver
```

#### iOS env vars

- `APP_PATH` Path to the .app folder

#### Android env vars

- `APP_PATH` Path to the apk
- `APP_PACKAGE` The APK's package
- `APP_ACTIVITY` Activity to start
- `APP_WAIT_ACTIVITY` Optional. Activity to wait for.

#### Sauce Labs env vars

- `APP_NAME` Name of the test run
- `SAUCE_USERNAME` Sauce username
- `SAUCE_ACCESS_KEY` Sauce API key

#### Troubleshooting

1. Does `adb kill-server; adb devices` list an active Android device?
2. Have you defined the proper env vars? `APP_PATH, APP_PACKAGE, APP_ACTIVITY, APP_WAIT_ACTIVITY`
3. Are you running appium from source? `node server.js -V --fast-reset`

#### Documentation

- [Overview ](https://github.com/appium/ruby_lib/blob/master/docs/docs.md) 
- [Android methods](https://github.com/appium/ruby_lib/blob/master/docs/android_docs.md)
- [iOS methods](https://github.com/appium/ruby_lib/blob/master/docs/ios_docs.md)