travis-saucelabs-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9a020d8e584148b881c96d7060206d23d527886c
+  data.tar.gz: e8280c6e4bbdd885ed75f91ba220bd4ea784e605
+SHA512:
+  metadata.gz: ec8900ed99b31da6d0a1d4f9708f74aeaca8b2e8032d86e78a7c2ab5f02c1dd774345a8c7cde179978dce23008a73d78e8177656375f89dafb79128819459182
+  data.tar.gz: 158a5a18df2bed7ef52197ad75b6b49400537e0ed0c031e82d62a0701080adc4cf072d4509015eec6a7edc2e0e7ad668057dc5eeacc2e548f7480bbe615d3d3b

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--order random

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+gem 'rake'
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+end
+
+# Specify your gem's dependencies in travis-saucelabs-api.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Henrik Hodne
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Travis::SaucelabsAPI
+
+This is an API wrapper to the Travis<->Saucelabs API for Mac VMs
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'travis-saucelabs-api'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install travis-saucelabs-api
+
+## Usage
+
+``` ruby
+require 'travis-saucelabs-api'
+
+api = Travis::SaucelabsAPI.new('http://user:password@api.example.com:1234')
+
+# The available capacity for the cloud
+#
+# ichef is the VM type
+api.capacity # => { 'ichef' => 10 }
+
+# Start up a VM instance
+api.start_instance # => { 'instance_id' => '38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1' }
+
+# Get a list of the running instances
+api.list_instances # => { 'instances' => [ '38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1' ]}
+
+# Get information about an instance
+api.instance_info('38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1') # => {
+#   'public_ip' => '10.10.10.10',
+#   'vnc_port' => '5900',
+#   'FQDN' => 'vm1.example.com',
+#   'time_created' => 1355294100.609689,
+#   'instance_id' => '38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1',
+#   'image_id' => 'ichef-osx8-10.8-working',
+#   'State' => 'Running',
+#   'private_ip' => '10.10.20.10',
+#   'real_image_id' => 'ichef-osx8-10.8-working',
+# }
+
+# Stop a VM instance (like unplugging its power)
+api.kill_instance('38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1')
+
+# Open the firewall for a given VM instance to allow outgoing connections
+# (firewalled off by default, watch out.)
+api.open_outgoing('38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1')
+
+# Save a disk image from a running VM. Use this sparingly.
+api.save_image('38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1')
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec
+

data/bin/travis-saucelabs

@@ -0,0 +1,85 @@
+#!/usr/bin/env ruby
+require 'thor'
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'travis-saucelabs-api'
+
+class TravisSaucelabs < Thor
+  desc 'list', 'Print a list of the currently running instances'
+  def list
+    instances = api.list_instances['instances']
+    instances.each do |instance_id|
+      info = api.instance_info(instance_id)
+      puts "Instance ID: #{info['instance_id']}"
+      info.each do |key, value|
+        puts "  #{key}: #{value}"
+      end
+      puts
+    end
+  end
+
+  desc 'start', 'Starts a new VM instance'
+  option :hostname
+  option :password
+  def start
+    instance_id = api.start_instance(startup_info)['instance_id']
+    puts "Started instance with ID #{instance_id}"
+    print "Allowing outgoing connections..."
+    api.allow_outgoing(instance_id)
+    puts "done"
+  end
+
+  desc 'kill INSTANCE_ID', 'Kills the instance with the given instance ID'
+  def kill(instance_id)
+    puts api.kill_instance(instance_id)['message']
+  end
+
+  desc 'kill_pid PID', 'Kills all instances belonging to a PID'
+  def kill_pid(pid)
+    instances = api.list_instances['instances'].select do |instance_id|
+      info = api.instance_info(instance_id)
+      info['extra_info'] &&
+        info['extra_info']['hostname'] &&
+        info['extra_info']['hostname'] =~ /^testing-saucelabs-mac-#{pid}/
+    end
+
+    instances.each do |instance_id|
+      kill(instance_id)
+    end
+  end
+
+  desc 'save_image INSTANCE_ID NAME', 'Saves an image of instance with name'
+  def save_image(instance_id, name)
+    puts api.save_image(instance_id, name)['message']
+  end
+
+  desc 'allow_incoming INSTANCE_ID CIDR PORT', 'Opens an incoming port in the firewall'
+  def allow_incoming(instance_id, cidr, port)
+    puts api.allow_incoming(instance_id, cidr, port)['message']
+  end
+
+  private
+
+  def api
+    @api ||= begin
+      unless ENV['TRAVIS_SAUCE_API_URI']
+        puts 'You need to set the TRAVIS_SAUCE_API_URI environment variable'
+        puts '  export TRAVIS_SAUCE_API_URI="http://user:password@api-endpoint:port"'
+        exit 1
+      end
+      Travis::SaucelabsAPI.new(ENV['TRAVIS_SAUCE_API_URI'])
+    end
+  end
+
+  def startup_info
+    if options[:hostname] || options[:password]
+      startup_info = {}
+      startup_info[:hostname] = options[:hostname] if options[:hostname]
+      startup_info[:password] = options[:password] if options[:password]
+      startup_info
+    else
+      nil
+    end
+  end
+end
+
+TravisSaucelabs.start

data/lib/travis-saucelabs-api.rb

@@ -0,0 +1,83 @@
+require 'travis-saucelabs-api/version'
+require 'faraday'
+require 'faraday_middleware'
+
+module Travis
+  class SaucelabsAPI
+    class NotFoundError < StandardError; end
+
+    DEFAULT_IMAGE = 'ichef-osx8-10.8-travis'
+
+    # Public: Initialize a new API client instance
+    #
+    # uri - The URI or String endpoint for the API. This should include the
+    #       username and password used for authentication.
+    def initialize(uri)
+      @connection = Faraday.new(uri) do |connection|
+        connection.use FaradayMiddleware::EncodeJson
+        connection.use FaradayMiddleware::ParseJson, content_type: /\bjson$/
+        connection.adapter Faraday.default_adapter
+      end
+    end
+
+    def capacity
+      handle_response(@connection.get('/capacity'))
+    end
+
+    def start_instance(startup_info=nil, image=DEFAULT_IMAGE)
+      response = @connection.post('/instances', startup_info) do |request|
+        request.params.update(image: image)
+      end
+
+      handle_response(response)
+    end
+
+    def list_instances
+      handle_response(@connection.get('/instances'))
+    end
+
+    def instance_info(instance_id)
+      handle_response(@connection.get("/instances/#{uri_escape(instance_id)}"))
+    end
+
+    def kill_instance(instance_id)
+      instance_id = uri_escape(instance_id)
+      handle_response(@connection.delete("/instances/#{instance_id}"))
+    end
+
+    def allow_outgoing(instance_id)
+      instance_id = uri_escape(instance_id)
+      handle_response(@connection.post("/instances/#{instance_id}/allow_outgoing"))
+    end
+
+    def allow_incoming(instance_id, cidr, port)
+      instance_id = uri_escape(instance_id)
+      response = @connection.post("/instances/#{instance_id}/allow_incoming") do |request|
+        request.params.update(cidr: cidr, port: port)
+      end
+
+      handle_response(response)
+    end
+
+    def save_image(instance_id, name)
+      instance_id = uri_escape(instance_id)
+      response = @connection.post("/instances/#{instance_id}/save_image") do |request|
+        request.params.update(name: name)
+      end
+
+      handle_response(response)
+    end
+
+    private
+
+    def handle_response(response)
+      raise NotFoundError if response.status == 404
+
+      response.body
+    end
+
+    def uri_escape(str)
+      Faraday::Utils.escape(str)
+    end
+  end
+end

data/lib/travis-saucelabs-api/version.rb

@@ -0,0 +1,5 @@
+module Travis
+  class SaucelabsAPI
+    VERSION = "0.0.2"
+  end
+end

data/spec/fixtures/allow_outgoing.json

@@ -0,0 +1 @@
+{"message": "outgoing connections allowed"}

data/spec/fixtures/capacity.json

@@ -0,0 +1 @@
+{"ichef": 3}

data/spec/fixtures/instance_info.json

@@ -0,0 +1 @@
+{"public_ip": "10.10.10.10", "vnc_port": "5900", "FQDN": "vm1.example.com", "time_created": 1355294100.609689, "instance_id": "38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1", "image_id": "ichef-osx8-10.8-working", "State": "Running", "private_ip": "10.10.20.10", "real_image_id": "ichef-osx8-10.8-working"}

data/spec/fixtures/instances.json

@@ -0,0 +1 @@
+{"instances": ["38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1"]}

data/spec/fixtures/kill_instance.json

@@ -0,0 +1 @@
+{"message": "stopped '38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1'"}

data/spec/fixtures/save_image.json

@@ -0,0 +1 @@
+{"message": "in progress"}

data/spec/fixtures/start_instance.json

@@ -0,0 +1 @@
+{"instance_id": "38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1"}

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+require 'travis-saucelabs-api'
+require 'rspec'
+require 'webmock/rspec'
+
+RSpec.configure do |rspec|
+  rspec.expect_with(:rspec) do |config|
+    config.syntax = :expect
+  end
+end
+
+def a_delete(endpoint, path)
+  a_request(:delete, endpoint + path)
+end
+
+def a_get(endpoint, path)
+  a_request(:get, endpoint + path)
+end
+
+def a_post(endpoint, path)
+  a_request(:post, endpoint + path)
+end
+
+def a_put(endpoint, path)
+  a_request(:put, endpoint + path)
+end
+
+def stub_delete(endpoint, path)
+  stub_request(:delete, endpoint + path)
+end
+
+def stub_get(endpoint, path)
+  stub_request(:get, endpoint + path)
+end
+
+def stub_post(endpoint, path)
+  stub_request(:post, endpoint + path)
+end
+
+def stub_put(endpoint, path)
+  stub_request(:put, endpoint + path)
+end
+
+def fixture_path
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+

data/spec/travis-saucelabs-api_spec.rb

@@ -0,0 +1,135 @@
+require 'spec_helper'
+
+describe Travis::SaucelabsAPI do
+  let(:endpoint) { 'http://user:password@travis-saucelabs.dev:1234' }
+  let(:api) { Travis::SaucelabsAPI.new(endpoint) }
+
+  describe '#capacity' do
+    before do
+      stub_get(endpoint, '/capacity').to_return(body: fixture('capacity.json'), headers: { content_type: 'text/html' })
+    end
+
+    it 'requests the correct resource' do
+      api.capacity
+      expect(a_get(endpoint, '/capacity')).to have_been_made
+    end
+
+    it 'returns the number of available VMs' do
+      expect(api.capacity).to eq({ 'ichef' => 3 })
+    end
+  end
+
+  describe '#start_instance' do
+    context 'with no parameters' do
+      before do
+        stub_post(endpoint, '/instances').with(query: { image: Travis::SaucelabsAPI::DEFAULT_IMAGE }).to_return(body: fixture('start_instance.json'), headers: { content_type: 'text/html' })
+      end
+
+      it 'requests the correct resource' do
+        api.start_instance
+        expect(a_post(endpoint, '/instances').with(query: { image: Travis::SaucelabsAPI::DEFAULT_IMAGE })).to have_been_made
+      end
+
+      it 'returns the instance ID' do
+        expect(api.start_instance).to eq({ 'instance_id' => '38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1' })
+      end
+    end
+
+    context 'with a different image' do
+      before do
+        stub_post(endpoint, '/instances').with(query: { image: 'custom-image' }).to_return(body: fixture('start_instance.json'), headers: { content_type: 'text/html' })
+      end
+
+      it 'requests the correct resource' do
+        api.start_instance(nil, 'custom-image')
+        expect(a_post(endpoint, '/instances').with(query: { image: 'custom-image' })).to have_been_made
+      end
+    end
+
+    context 'with startup info' do
+      before do
+        stub_post(endpoint, '/instances').with(query: { image: Travis::SaucelabsAPI::DEFAULT_IMAGE }, body: { foo: 'bar' }).to_return(body: fixture('start_instance.json'), headers: { content_type: 'text/html' })
+      end
+
+      it 'requests the correct resource' do
+        api.start_instance({ foo: 'bar' }, Travis::SaucelabsAPI::DEFAULT_IMAGE)
+        expect(a_post(endpoint, '/instances').with(query: { image: Travis::SaucelabsAPI::DEFAULT_IMAGE }, body: { foo: 'bar' })).to have_been_made
+      end
+    end
+  end
+
+  describe '#list_instances' do
+    before do
+      stub_get(endpoint, '/instances').to_return(body: fixture('instances.json'), content_type: 'text/html')
+    end
+
+    it 'requests the correct resource' do
+      api.list_instances
+      expect(a_get(endpoint, '/instances')).to have_been_made
+    end
+
+    it 'returns the running instances' do
+      expect(api.list_instances).to eq({ 'instances' => ['38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1'] })
+    end
+  end
+
+  describe '#instance_info' do
+    before do
+      stub_get(endpoint, '/instances/38257917-4fac-68fc-11f4-1575d2ec6847@travis1%23itako13252').to_return(body: fixture('instance_info.json'), content_type: 'text/html')
+    end
+
+    it 'requests the correct resource' do
+      api.instance_info('38257917-4fac-68fc-11f4-1575d2ec6847@travis1#itako13252')
+      expect(a_get(endpoint, '/instances/38257917-4fac-68fc-11f4-1575d2ec6847@travis1%23itako13252')).to have_been_made
+    end
+
+    it 'returns information about the instance' do
+      expect(api.instance_info('38257917-4fac-68fc-11f4-1575d2ec6847@travis1#itako13252')).to eq({
+        'public_ip' => '10.10.10.10',
+        'vnc_port' => '5900',
+        'FQDN' => 'vm1.example.com',
+        'time_created' => 1355294100.609689,
+        'instance_id' => '38257917-4fac-68fc-11f4-1575d2ec6847@api#vm1',
+        'image_id' => 'ichef-osx8-10.8-working',
+        'State' => 'Running',
+        'private_ip' => '10.10.20.10',
+        'real_image_id' => 'ichef-osx8-10.8-working',
+      })
+    end
+  end
+
+  describe '#kill_instance' do
+    before do
+      stub_delete(endpoint, '/instances/38257917-4fac-68fc-11f4-1575d2ec6847@travis1%23itako13252').to_return(body: fixture('kill_instance.json'), content_type: 'text/html')
+    end
+
+    it 'requests the correct resource' do
+      api.kill_instance('38257917-4fac-68fc-11f4-1575d2ec6847@travis1#itako13252')
+      expect(a_delete(endpoint, '/instances/38257917-4fac-68fc-11f4-1575d2ec6847@travis1%23itako13252')).to have_been_made
+    end
+  end
+
+  describe '#allow_outgoing' do
+    before do
+      stub_post(endpoint, '/instances/38257917-4fac-68fc-11f4-1575d2ec6847@travis1%23itako13252/allow_outgoing').to_return(body: fixture('allow_outgoing.json'), content_type: 'text/html')
+    end
+
+    it 'requests the correct resource' do
+      api.allow_outgoing('38257917-4fac-68fc-11f4-1575d2ec6847@travis1#itako13252')
+      expect(a_post(endpoint, '/instances/38257917-4fac-68fc-11f4-1575d2ec6847@travis1%23itako13252/allow_outgoing')).to have_been_made
+    end
+  end
+
+  describe '#save_image' do
+    before do
+      stub_post(endpoint, '/instances/38257917-4fac-68fc-11f4-1575d2ec6847@travis1%23itako13252/save_image?name=foo').to_return(body: fixture('save_image.json'), content_type: 'text/html')
+    end
+
+    it 'requests the correct resource' do
+      api.save_image('38257917-4fac-68fc-11f4-1575d2ec6847@travis1#itako13252', 'foo')
+      expect(a_post(endpoint, '/instances/38257917-4fac-68fc-11f4-1575d2ec6847@travis1%23itako13252/save_image?name=foo')).to have_been_made
+    end
+  end
+
+
+end

data/travis-saucelabs-api.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'travis-saucelabs-api/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "travis-saucelabs-api"
+  gem.version       = Travis::SaucelabsAPI::VERSION
+  gem.authors       = ["Henrik Hodne"]
+  gem.email         = ["me@henrikhodne.com"]
+  gem.description   = %q{Ruby client library for the API Travis uses to spin up OS X VMs}
+  gem.summary       = %q{Travis/Sauce Labs API client}
+  gem.homepage      = 'https://github.com/henrikhodne/travis-saucelabs-api'
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency('faraday', '~> 0.7')
+  gem.add_runtime_dependency('faraday_middleware', '~> 0.9')
+  gem.add_runtime_dependency('thor', '~> 0.14')
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: travis-saucelabs-api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Henrik Hodne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: Ruby client library for the API Travis uses to spin up OS X VMs
+email:
+- me@henrikhodne.com
+executables:
+- travis-saucelabs
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/travis-saucelabs
+- lib/travis-saucelabs-api.rb
+- lib/travis-saucelabs-api/version.rb
+- spec/fixtures/allow_outgoing.json
+- spec/fixtures/capacity.json
+- spec/fixtures/instance_info.json
+- spec/fixtures/instances.json
+- spec/fixtures/kill_instance.json
+- spec/fixtures/save_image.json
+- spec/fixtures/start_instance.json
+- spec/spec_helper.rb
+- spec/travis-saucelabs-api_spec.rb
+- travis-saucelabs-api.gemspec
+homepage: https://github.com/henrikhodne/travis-saucelabs-api
+licenses: []
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Travis/Sauce Labs API client
+test_files:
+- spec/fixtures/allow_outgoing.json
+- spec/fixtures/capacity.json
+- spec/fixtures/instance_info.json
+- spec/fixtures/instances.json
+- spec/fixtures/kill_instance.json
+- spec/fixtures/save_image.json
+- spec/fixtures/start_instance.json
+- spec/spec_helper.rb
+- spec/travis-saucelabs-api_spec.rb