id

title

sidebar_label

description

keywords

url

site_name

slug

appium-ruby

Ruby With Appium

Ruby

Complete guide to running your first Ruby Appium automated test script on LambdaTest Real Device Cloud Platform. Test on 3000+ Real Devices.

ruby appium

ruby appium tutorial

real devices

lambdatest cloud platform

app automation

real time testing

appium automation

https://www.lambdatest.com/support/docs/appium-ruby/

LambdaTest

appium-ruby/

import CodeBlock from '@theme/CodeBlock'; import {YOUR_LAMBDATEST_USERNAME, YOUR_LAMBDATEST_ACCESS_KEY} from "@site/src/component/keys";

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem';

Tutorial To Run Your First Test On LambdaTest

In this topic, you will learn how to configure and run your Ruby automation testing scripts with Appium on LambdaTest Real Device Cloud platform.

Objective

By the end of this topic, you will be able to:

Set up an environment for testing your Apps using Ruby with Appium.
Understand and configure the core capabilities required for your Appium test suite.
Explore the advanced features of LambdaTest.

:::tip Sample repo

All the code samples in this documentation can be found on LambdaTest's Github Repository. You can either download or clone the repository to quickly run your tests. <img loading="lazy" src={require('../assets/images/icons/github.png').default} alt="Image" className="doc_img"/> View on GitHub

:::

Pre-requisites

Before you can start performing Ruby automation testing with Appium, you would need to:

You have access to LambdaTest username and accessKey. If you have not registered yet, you can do the same by visiting our website. You will be able to access the credentials in the LambdaTest Profile
Install Ruby on your local system. Follow these instructions to install on different operating systems.

For macOS, you can run a Homebrew command like this:

brew install ruby

For Linux or Ubuntu, you can run a simple apt command like below:

sudo apt-get install ruby-full

For Windows, you can download from the official website.

Run your first test

1. Upload your application

Upload your iOS application (.ipa file) or android application (.apk file) to the LambdaTest servers using our REST API. You need to provide your Username and AccessKey in the format Username:AccessKey in the cURL command for authentication. Make sure to add the path of the appFile in the cURL request. Here is an example cURL request to upload your app using our REST API:

Using App File from System:

{`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "appFile=@"/Users/macuser/Downloads/proverbial_android.apk"" -F "name="proverbial_app"" `}

Using App URL:

{`curl -u "${ YOUR_LAMBDATEST_USERNAME()}:${ YOUR_LAMBDATEST_ACCESS_KEY()}" -X POST "https://manual-api.lambdatest.com/app/upload/realDevice" -F "url=:https://prod-mobile-artefacts.lambdatest.com/assets/docs/proverbial_android.apk" -F "name=Proverbial_App" `}

:::tip

If you do not have any .apk or .ipa file, you can run your sample tests on LambdaTest by using our sample 🔗 Android app or sample 🔗 iOS app.
Response of above cURL will be a JSON object containing the APP_URL of the format - lt://APP123456789123456789 and will be used in the next step.

:::

2. Clone the sample project

Clone the LambdaTest’s LT-appium-ruby and navigate to the code directory as shown below:

git clone https://github.com/LambdaTest/LT-appium-ruby
cd LT-appium-ruby

3. Set up your authentication

Make sure you have your LambdaTest credentials with you to run test automation scripts on LambdaTest. To obtain your access credentials, purchase a plan or access the Automation Dashboard. Then, set LambdaTest Username and Access Key in environment variables with following commands.

{`export LT_USERNAME=${ YOUR_LAMBDATEST_USERNAME()} \\ export LT_ACCESS_KEY=${ YOUR_LAMBDATEST_ACCESS_KEY()}`}

{`set LT_USERNAME=${ YOUR_LAMBDATEST_USERNAME()} \` set LT_ACCESS_KEY=${ YOUR_LAMBDATEST_ACCESS_KEY()}`}

4. Write your automation script

An automation script for the sample application available above has been provided here. Ensure to update the APP_URL, username and accesKey in the code scripts before running the tests.

require 'rubygems'
require 'appium_lib'

        #highlight-next-line
        username= "username" #Add username here
        #highlight-next-line
        accessToken= "accesKey" #Add accessKey here

        caps = {
          "LT:Options" => {      
                :deviceName => "iPhone 13 Pro",  
                :platformName => "iOS",
                :platformVersion => "15",
                :build => "Ruby Vanilla - iOS",
                :name => "Ruby iOS Test",
                :isRealMobile => true,
                #highlight-next-line
                :app => "YOUR_APP_URL", #Enter the App URL here
                :w3c => true,
        } }

        appium_driver = Appium::Driver.new({
            'caps' => caps,
            'appium_lib' => {
                :server_url => "http://"+username+":"+accessToken+"@mobile-hub.lambdatest.com/wd/hub"
            }}, true)

            driver = appium_driver.start_driver

            wait = Selenium::WebDriver::Wait.new(:timeout => 30)

            el1 = driver.find_element(:id, "color")
            el1.click
            el2 = driver.find_element(:id, "geoLocation")
            el2.click
            sleep(5)
            driver.back
            el3 = driver.find_element(:id, "Text")
            el3.click
            el4 = driver.find_element(:id, "notification")
            el4.click
            el5 = driver.find_element(:id, "Toast")
            el5.click
            el6 = driver.find_element(:id, "speedTest")
            el6.click
            sleep(10)
            driver.back

            puts "Found results - Test Passed"


            driver.quit

require 'rubygems'
require 'appium_lib'

        #highlight-next-line
        username= "username" #Add username here
        #highlight-next-line
        accessToken= "accesKey" #Add accessKey here

        caps = {
           "LT:Options" => {      
            :deviceName => "OnePlus 7",  
            :platformName => "Android",
            :platformVersion => "9",
            :build => "Ruby Vanilla - Android",
            :name => "Ruby Android Test",
            :isRealMobile => true,
            #highlight-next-line
            :app => "YOUR_APP_URL", #Enter the App URL here
            :w3c => true,
        } }

        appium_driver = Appium::Driver.new({
            'caps' => caps,
            'appium_lib' => {
               :server_url => "http://"+username+":"+accessToken+"@mobile-hub.lambdatest.com/wd/hub"
            }}, true)

            driver = appium_driver.start_driver

            wait = Selenium::WebDriver::Wait.new(:timeout => 30)
            el1 = driver.find_element(:id, "com.lambdatest.proverbial:id/color")
            el1.click
            el2 = driver.find_element(:id, "com.lambdatest.proverbial:id/geoLocation")
            el2.click
            sleep(5)
            driver.back
            el3 = driver.find_element(:id, "com.lambdatest.proverbial:id/Text")
            el3.click
            el4 = driver.find_element(:id, "com.lambdatest.proverbial:id/notification")
            el4.click
            el5 = driver.find_element(:id, "com.lambdatest.proverbial:id/toast")
            el5.click
            el6 = driver.find_element(:id, "com.lambdatest.proverbial:id/speedTest")
            el6.click
            sleep(10)
            driver.back
            puts "Found results - Test Passed"

            driver.quit

Configure the test capabilities

You can update your custom capabilities in test scripts. In this sample project, we are passing platform name, platform version, device name and app url (generated earlier) along with other capabilities like build name and test name via capabilities object. The capabilities object in the sample code are defined as:

:::info Note In case you're using capabilities generated using the JSON Wire Protocol, then it's recommended to use appium_lib version 10.6.0. Run gem install appium_lib -v 10.6.0 command to install it. :::

 caps = {
            "LT:Options" => {
                :deviceName => "iPhone 13 Pro",  
                :platformName => "iOS",
                :platformVersion => "15",
                :build => "Ruby Vanilla - iOS",
                :name => "Ruby iOS Test",
                :isRealMobile => true,
                #highlight-next-line
                :app => "YOUR_APP_URL", #Enter the App (.ipa) URL here
                :w3c => true,
        } }

caps = {
            "LT:Options" => {
            :deviceName => "OnePlus 7",  
                :platformName => "Android",
                :platformVersion => "9",
                :build => "Ruby Vanilla - Android",
                :name => "Ruby Android Test",
                :isRealMobile => true,
                #highlight-next-line
                :app => "YOUR_APP_URL", #Enter the App (.apk) URL here
                :w3c => true,
        } }

:::info Note

You must add the generated APP_URL to the "app" capability in the config file.
You can generate capabilities for your test requirements with the help of our inbuilt Capabilities Generator tool.For more details, please refer to our guide on Desired Capabilities in Appium.

:::

5. Execute your test case

If you are using an iOS app, the cURL command will generate an app URL for the corresponding iOS app and install the same for running the tests. You can either use our sample 🔗 iOS app or upload your own app as discussed earlier.

Navigate to the corresponding directory based on your app.

cd ios

Execute the following command to run your test on LambdaTest platform:

ruby ios-sample.rb

If you are using an android app, the cURL command will generate an app URL for the corresponding Android app and install the same for running the tests. You can either use our sample 🔗 Android app or upload your own app as discussed earlier.

Navigate to the corresponding directory based on your app.

cd android

Execute the following command to run your test on LambdaTest platform:

ruby android-sample.rb

Info for Windows Users

In case of Windows, if you get any error message. Please try this method:

Navigate to the corresponding directory based on your app.

cd android

Refresh the gem bundles through given command

gem uninstall -aIx

Re-install the gems required

gem install appium_lib -v 10.6.0
gem install ffi

Now try running the corresponding automation script for your app.

ruby android-sample.rb

:::info Your test results would be displayed on the test console (or command-line interface if you are using terminal/cmd) and on the 🔗 LambdaTest App Automation Dashboard. :::

Additional Links

Advanced Configuration for Capabilities
How to test locally hosted apps
How to integrate LambdaTest with CI/CD

Home
Support
Ruby With Appium

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

appium-ruby.md

appium-ruby.md

Tutorial To Run Your First Test On LambdaTest

Objective

Pre-requisites

Run your first test

1. Upload your application

2. Clone the sample project

3. Set up your authentication

4. Write your automation script

Configure the test capabilities

5. Execute your test case

Additional Links

Files

appium-ruby.md

Latest commit

History

appium-ruby.md

File metadata and controls

Tutorial To Run Your First Test On LambdaTest

Objective

Pre-requisites

Run your first test

1. Upload your application

2. Clone the sample project

3. Set up your authentication

4. Write your automation script

Configure the test capabilities

5. Execute your test case

Additional Links