appium_rspec_setup 0.1.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 615f4c195724ce179d82e3d97dc7e8bb16200d82
+  data.tar.gz: 357b34328722935d312e0769e4cdae51cdb82259
+SHA512:
+  metadata.gz: d7b4483c6adbac9bb2382adae0bbe16e3d69f9f5cef83a3cfb23c7900147e7461a8af622a4028d36b1a1cc5a87fdd1c851dd8a2a0b08abae5e96e18f46430050
+  data.tar.gz: f294559a698671c06c700a4e31449701dea9c2053b5a2001278138ca698ad123559418c0a1a03a703ea744aefee8dab6a7094b813ab277897b9e199604f99b0c

data/README.md

@@ -0,0 +1,80 @@
+# Appium RSpec Setup
+
+Appium Rspec Setup provides a quick way to include both Rspec as a framework to define your tests against and an Appium-compatible library to let it reach through and drive the virtual device of your choice.
+
+## Setup and Installation
+This gem only sets up Rspec for use with Appium on your app. In addition to this gem, you will need to have installed and set up the Appium application available here: http://appium.io/
+
+Create a GemFile in your app's main directory and add the following line:
+```ruby
+gem 'appium_rspec_setup'
+```
+Run ```bundle```.
+
+### Android
+From the command-line, navigate to the main directory for your app and run the following command:
+```sh
+setup_android
+```
+When prompted, enter your app's name and the platform (Android).
+
+### iOS
+From the command-line, navigate to the main directory for your app and run the following command:
+```sh
+setup_ios
+```
+When prompted, enter your app's name.
+
+---
+The setup process should complete within a few seconds, adding the following files to your app's main directory:
+* app_config.yml
+* spec/spec_helper.rb
+
+Do NOT delete these files.
+
+## Usage
+Add test files within your spec/ folder
+
+Run tests from the command-line with the ```rspec``` command.
+
+Below is a sample file login_spec.rb for an Android app:
+```ruby
+describe 'App Login' do
+  before(:all) do
+    Appium::Driver.new(desired_caps).start_driver
+    Appium.promote_appium_methods RSpec::Core::ExampleGroup
+  end
+
+  after(:all) do
+    driver_quit
+  end
+
+  describe 'user login' do
+    it 'should have two text fields' do
+      expect(id('login_email_address').nil?).to eq false
+      expect(id('login_password').nil?).to eq false
+    end
+
+    it 'should have a button' do
+      expect(id('login_button').nil?).to eq false
+    end
+
+    it 'should go to splash screen' do
+        id('login_email_address').send_keys('email')
+        id('login_password').send_keys('password')
+        id('login_button').click
+        expect(id('splash_layout').nil?).to eq false
+    end
+  end
+end
+```
+
+### Recommended Reading
+* [Appium Ruby Library](http://www.rubydoc.info/github/appium/ruby_lib/)
+* [RSpec documentation](https://www.relishapp.com/rspec)
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "appium_rspec_setup"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/setup_android

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'appium_rspec_setup'
+
+AppiumRspecSetup::SetupAndroid.setup_android!

data/bin/setup_ios

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'appium_rspec_setup'
+
+AppiumRspecSetup::SetupIos.setup_ios!

data/lib/appium_rspec_setup.rb

@@ -0,0 +1,9 @@
+require "appium_rspec_setup/version"
+require 'appium_rspec_setup/gemfile'
+require 'appium_rspec_setup/rspec'
+require 'appium_rspec_setup/setup_android'
+require 'appium_rspec_setup/setup_ios'
+
+module AppiumRspecSetup
+  # Your code goes here...
+end

data/lib/appium_rspec_setup/gemfile.rb

@@ -0,0 +1,27 @@
+module AppiumRspecSetup
+  class Gemfile
+    def self.configure_gemfile_and_bundle!
+      file_array = File.readlines('GemFile')
+
+      insert_hash = {
+          'appium_lib' => "gem 'appium_lib'",
+          'rspec' => "gem 'rspec', require: 'spec'",
+          'pry' => "gem 'pry'"
+      }
+
+      offset = -1
+
+      insert_hash.each do |substring_key, line_for_file_value|
+        file_array.insert(offset, line_for_file_value) unless file_array.any? do |line|
+          line.include? substring_key
+        end
+      end
+
+      File.open('GemFile', 'w') do |file|
+        file.puts file_array
+      end
+
+      %x{bundle}
+    end
+  end
+end

data/lib/appium_rspec_setup/rspec.rb

@@ -0,0 +1,7 @@
+module AppiumRspecSetup
+  class Rspec
+    def self.initialize_rspec
+      %x{rspec --init}
+    end
+  end
+end

data/lib/appium_rspec_setup/setup_android.rb

@@ -0,0 +1,72 @@
+module AppiumRspecSetup
+  class SetupAndroid
+    def self.setup_android!
+      AppiumRspecSetup::Gemfile.configure_gemfile_and_bundle!
+      AppiumRspecSetup::Rspec.initialize_rspec
+
+      puts 'What is the name of the app?'
+      app_name = gets.chomp
+
+      puts 'What is the name of the platform?'
+      platform_name = gets.chomp
+
+      File.open('app_config.yml', 'w') do |file|
+        file.write %Q{
+rspec:
+  app_name: #{app_name}
+  platform_name: #{platform_name}
+               }
+      end
+
+      spec_helper = File.readlines('spec/spec_helper.rb')
+
+      require_hash = {
+        'appium_lib' => "require 'appium_lib'",
+        'pry' => "require 'pry'",
+        'yaml' => "require 'yaml'"
+      }
+
+      require_hash.each do |substring_key, line_for_spec_helper|
+        spec_helper.insert(-1, line_for_spec_helper) unless spec_helper.any? do |line|
+          line.include? substring_key
+        end
+      end
+
+      yaml_definitions_hash = {
+        'APP_CONFIG' => "::APP_CONFIG = YAML.load(File.read('./app_config.yml'))",
+        'APP_NAME' => "::APP_NAME = APP_CONFIG['rspec']['app_name']",
+        'PLATFORM_NAME' => "::PLATFORM_NAME = APP_CONFIG['rspec']['platform_name']",
+        'APP_PATH' => "::APP_PATH = \"../\#{APP_NAME}/app/build/outputs/apk/app-debug.apk\""
+      }
+
+      yaml_definitions_hash.each do |substring_key, line_for_spec_helper|
+        spec_helper.insert(-2, line_for_spec_helper) unless spec_helper.any? do |line|
+          line.include? substring_key
+        end
+      end
+
+      unless spec_helper.any? { |line| line.include? 'def desired_caps' }
+        spec_helper.insert(-2, %Q{
+    def desired_caps
+      {
+        caps: {
+          :'appium-version' => '1.0',
+          platformName: PLATFORM_NAME,
+          deviceName: 'DJVis',
+          app: APP_PATH,
+          name: APP_NAME
+        },
+        appium_lib: {
+        wait: 60
+        }
+      }
+    end
+    } )
+      end
+
+      File.open('spec/spec_helper.rb', 'w') do |file|
+        file.puts spec_helper
+      end
+    end
+  end
+end

data/lib/appium_rspec_setup/setup_ios.rb

@@ -0,0 +1,73 @@
+module AppiumRspecSetup
+  class SetupIos
+    def self.setup_ios!
+      AppiumRspecSetup::Gemfile.configure_gemfile_and_bundle!
+      AppiumRspecSetup::Rspec.initialize_rspec
+
+      puts 'What is the name of the app?'
+      app_name = gets.chomp
+
+      File.open('app_config.yml', 'w') do |file|
+        file.write(%Q{
+rspec:
+  app_name: #{app_name}
+  device_name: 'iPhone 6'
+  version_number: '8.4'
+})
+      end
+
+      file_array = File.readlines('spec/spec_helper.rb')
+
+      insert_hash = {
+          'appium_lib' => "require 'appium_lib'",
+          'pry' => "require 'pry'",
+          'yaml' => "require 'yaml'\n"
+      }
+
+      offset = 0
+
+      insert_hash.each do |substring_key, line_for_file_value|
+        file_array.insert(offset, line_for_file_value) unless file_array.any? do |line|
+          line.include? substring_key
+        end
+      end
+
+      unless file_array.any? {|line| line.include? '::APP_CONFIG' }
+        file_array.insert(-2, %Q{
+  ::APP_CONFIG = YAML.load(File.read("./app_config.yml"))
+  ::APP_NAME = APP_CONFIG['rspec']['app_name']
+  ::BUILD_FOLDER = Dir["\#{ENV['HOME']}/Library/Developer/Xcode/DerivedData/*"].select{|path|path.include? APP_NAME}.first
+  ::APP_PATH =  Dir["\#{BUILD_FOLDER}/**/\#{APP_NAME}.app"].first
+  ::DEVICE_NAME = APP_CONFIG['rspec']['device_name']
+  ::VERSION_NUMBER = APP_CONFIG['rspec']['version_number']
+}
+        )
+      end
+
+      unless file_array.any? {|line| line.include? 'def desired_caps' }
+        file_array.insert(-2, %Q{
+  def desired_caps
+    {
+      caps: {
+        platformName: 'iOS',
+        deviceName:  DEVICE_NAME,
+        versionNumber:  VERSION_NUMBER,
+        app: APP_PATH
+      },
+      appium_lib: {
+        sauce_username: nil, # don't run on sauce
+        sauce_access_key: nil,
+        wait: 10,
+      }
+    }
+  end
+}
+        )
+      end
+
+      File.open('spec/spec_helper.rb', 'w') do |file|
+        file.puts file_array
+      end
+    end
+  end
+end

data/lib/appium_rspec_setup/version.rb

@@ -0,0 +1,3 @@
+module AppiumRspecSetup
+  VERSION = '0.1.5'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: appium_rspec_setup
+version: !ruby/object:Gem::Version
+  version: 0.1.5
+platform: ruby
+authors:
+- Jacob Lee
+- Andrew Neely
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Makes Appium Rspec set up a snap!
+email:
+- jacob.lee@agapered.com
+- andrew.neely@agapered.com
+executables:
+- setup_ios
+- setup_android
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/console
+- bin/setup
+- bin/setup_android
+- bin/setup_ios
+- lib/appium_rspec_setup.rb
+- lib/appium_rspec_setup/gemfile.rb
+- lib/appium_rspec_setup/rspec.rb
+- lib/appium_rspec_setup/setup_android.rb
+- lib/appium_rspec_setup/setup_ios.rb
+- lib/appium_rspec_setup/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Makes Appium Rspec set up a snap!
+test_files: []