0.01
No commit activity in last 3 years
No release in over 3 years
Ngrok-rspec gem provides ability to run capybara specs with ngrok tunnel
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

~> 1.7
~> 0.10
~> 10.0

Runtime

>= 2.4
>= 2.99
 Project Readme

Ngrok::Rspec

Ngrok-rspec gem provides ability to run capybara specs through ngrok.

Gem Version Code Climate

Installation

Note: You must have ngrok v2+ installed available in your PATH.

Add this line to your application's Gemfile:

group :test do
  gem 'ngrok-rspec'
end

And then execute:

$ bundle

Or install it yourself as:

$ gem install ngrok-rspec

Usage

Configure rspec

RSpec.configure do |config|
  # any port can be used
  Capybara.server_port = 3001
  Ngrok::Rspec.tunnel = { port: Capybara.server_port }
  
  config.include Ngrok::Rspec
end

Write specs using filter ngrok: true

context "Using ngrok", ngrok: true do
  it "should use ngrok tunnel" do
    # your test code
  end
end

Custom tunnel options available:

# custom tunnel options
Ngrok::Rspec.tunnel = { 
  port: Capybara.server_port, 
  subdomain: 'MY_SUBDOMAIN', 
  authtoken: 'MY_TOKEN', 
  log: 'ngrok.log', 
  config: '~/.ngrok' 
}

Contributing

  1. Fork it ( https://github.com/bogdanovich/ngrok-rspec/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request