browserstack 0.0.1

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
+--format progress

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@browserstack --create

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in browserstack.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Rahul Nawani
+
+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,107 @@
+# Browserstack
+
+A ruby gem for working with [BrowserStack](http://browserstack.com) through its [API](https://github.com/browserstack/api).(V2 API only)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'browserstack'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install browserstack
+
+## Example of Use
+
+First, you're probably gonna want to require it:
+
+``` ruby
+require 'browserstack'
+```
+
+### Creating Client
+Creates a new client instance.
+
+* `settings`: A hash of settings that apply to all requests for the new client.
+  * `username`: The username for the BrowserStack account.
+  * `password`: The password for the BrowserStack account.
+
+``` ruby
+settings = {username: "foo", password: "foobar"}
+client = Browserstack::Client.new(settings)
+```
+
+###API
+
+####Getting available browsers
+Fetches all available browsers.
+
+``` ruby
+client.get_browsers #returns a hash
+```
+
+or for a specific OS
+
+``` ruby
+client.get_browsers("mac")
+```
+
+####Getting list of supported OS
+
+``` ruby
+client.get_supported_os_list 
+```
+
+####Creating a worker
+A worker is simply a new browser instance.
+
+``` ruby
+enc_url = URI.escape("http://example.com/?a=\111\\115")
+settings = {os: "win", browser: "ie7", version: "4.0", url: enc_url}
+worker_id = client.create_worker(settings)
+```
+A worker id is returned after worker gets created.
+
+* `settings`: A hash of settings for the worker
+  * `os`: Which OS to use for the new worker.
+  * `browser`/`device`: Which browser/device to use in the new worker. Which property to use depends on the OS.
+  * `version`: Which version of the specified browser to use.
+  * `url` : Which URL to navigate to upon creation.
+  * `timeout` (optional): defaults to 300 seconds. Use 0 for "forever" (BrowserStack will kill the worker after 1,800 seconds).
+
+####Terminating a worker
+Use this method to terminate an active worker. A hash with indicating how long the worker was alive is returned.
+
+``` ruby
+data = client.terminate_worker(worker_id)
+```
+
+####Getting worker status
+Determines whether the worker is in queue, running or terminated.
+
+``` ruby
+status = client.worker_status(worker_id)
+```
+
+* `status`: A string representing the current status of the worker.
+  * Possible statuses: `"running"`, `"queue"`, `"terminated"`.
+
+####Getting all workers of a client
+
+``` ruby
+workers = client.get_workers
+```
+Returns an array of all workers with all their properties
+
+## 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 @@
+require "bundler/gem_tasks"

data/browserstack.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'browserstack/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "browserstack"
+  gem.version       = Browserstack::VERSION
+  gem.authors       = ["Rahul Nawani"]
+  gem.email         = ["rahulnwn@gmail.com"]
+  gem.description   = %q{Ruby gem for interacting with the Browserstack API}
+  gem.summary       = %q{Ruby gem for interacting with the Browserstack API}
+  gem.homepage      = ""
+
+  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_development_dependency("rake")
+  gem.add_development_dependency("rspec", "2.11.0")
+  gem.add_development_dependency("webmock", "1.8.11")
+  gem.add_dependency("yajl-ruby", "1.1.0")
+end

data/lib/browserstack.rb

@@ -0,0 +1,5 @@
+require "base64"
+require "net/http"
+require "yajl"
+require "browserstack/client"
+require "browserstack/version"

data/lib/browserstack/client.rb

@@ -0,0 +1,106 @@
+module Browserstack
+  HOSTNAME = "api.browserstack.com"
+  class Client
+    attr_reader :browsers, :version
+
+    def initialize(params)
+      params ||= {}
+
+      raise ArgumentError, "Username is required" unless params[:username]
+      raise ArgumentError, "Password is required" unless params[:password]
+
+      @authentication = "Basic " + Base64.encode64("#{params[:username]}:#{params[:password]}").strip
+
+      @version = 2
+    end
+
+    def get_browsers(os = nil)
+      if update_cache?
+        connection = create_new_connection
+        call = Net::HTTP::Get.new("/#{self.version}/browsers")
+        add_authentication(call)
+        res = make_request(connection, call)
+        @latest_update = Time.now
+        parser = Yajl::Parser.new(:symbolize_keys => true)
+        @browsers = parser.parse(res.body)
+      end
+      return_with_os(os)
+    end
+
+    def create_worker(settings)
+      settings ||= {}
+      connection = create_new_connection
+      call = Net::HTTP::Post.new("/#{self.version}/worker")
+      call.set_form_data(settings)
+      add_authentication(call)
+      res = make_request(connection, call)
+      Yajl::Parser.parse(res.body)['id']
+    end
+
+    def terminate_worker(worker_id)
+      connection = create_new_connection
+      call = Net::HTTP::Delete.new("/#{self.version}/worker/#{worker_id}")
+      add_authentication(call)
+      res = make_request(connection, call)
+      parser = Yajl::Parser.new(:symbolize_keys => true)
+      parser.parse(res.body)
+    end
+
+    def get_worker_status(worker_id)
+      connection = create_new_connection
+      call = Net::HTTP::Get.new("/#{self.version}/worker/#{worker_id}")
+      add_authentication(call)
+      res = make_request(connection, call)
+      parser = Yajl::Parser.new(:symbolize_keys => true)
+      parser.parse(res.body)
+    end
+
+    def get_workers
+      connection = create_new_connection
+      call = Net::HTTP::Get.new("/#{self.version}/workers")
+      add_authentication(call)
+      res = make_request(connection, call)
+      parser = Yajl::Parser.new(:symbolize_keys => true)
+      parser.parse(res.body)
+    end
+
+    def get_supported_os_list
+      get_browsers.keys.map { |os| os.to_s }
+    end
+
+    private
+    def create_new_connection
+      Net::HTTP.new(HOSTNAME, 80)
+    end
+
+    def add_authentication(call)
+      call["Authorization"] = @authentication
+    end
+    
+    def make_request(connection, call)
+      res = connection.request(call)
+      case res.code.to_i
+      when 200
+        res
+      when 401
+        raise "Unauthorized User".inspect
+      when 422
+        raise_validation_error
+      else
+        raise res.body.inspect
+      end
+    end
+
+    def raise_validation_error
+      raise res.body.inspect
+    end
+
+    def update_cache?
+      @latest_update.nil? || (Time.now - @latest_update > 86400) #cache for one day
+    end
+
+    def return_with_os(os)
+      os ? @browsers[os.to_sym] : @browsers
+    end
+  end
+end

data/lib/browserstack/version.rb

@@ -0,0 +1,3 @@
+module Browserstack
+  VERSION = "0.0.1"
+end

data/spec/browserstack/client_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe Browserstack::Client do
+  before do
+    @params = {username: "foobar", password: "1234"}
+    @client = Browserstack::Client.new(@params)
+  end
+
+  describe "#initialize" do
+    it "should create a new client object" do
+      @client.should be_an_instance_of(Browserstack::Client)
+    end
+
+    it "should raise an error without username params" do
+      @params.delete(:username)
+      expect { Browserstack::Client.new(@params) }.to raise_error("Username is required")
+    end
+
+    it "should raise an error without password params" do
+      @params.delete(:password)
+      expect { Browserstack::Client.new(@params) }.to raise_error("Password is required")
+    end
+
+    it "should set API version as 2" do
+      @client.version.should == 2
+    end
+
+  end
+
+  describe "get_broswers" do
+    before do
+      @browsers = "{\"ios\":[{\"device\":\"iPhone 3GS\",\"version\":\"3.0\"}],\"android\":[{\"device\":\"Samsung Galaxy S\",\"version\":\"2.1\"}],\"mac\":[{\"version\":\"4.0\",\"browser\":\"safari\"}],\"win\":[{\"version\":\"4.0\",\"browser\":\"safari\"}]}"
+      stub_request(:get, "http://#{@params[:username]}:#{@params[:password]}@api.browserstack.com/#{@client.version}/browsers").
+      with(:headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+      to_return(:status => 200, :body => @browsers, :headers => {})
+      parser = Yajl::Parser.new(:symbolize_keys => true)
+      @parsed_data = parser.parse(@browsers)
+    end
+
+    context "when no os argument passed" do
+      it "should return a hash of all os browsers" do
+        browsers = @client.get_browsers
+        browsers.should == @parsed_data
+      end
+
+      it "should update cache depending on last updated" do
+        browsers = @client.get_browsers
+        @client.stub("update_cache?").and_return(true)
+        @browsers = "{\"ios\":[{\"device\":\"iPhone 3GS\",\"version\":\"3.0\"}],\"android\":[{\"device\":\"Samsung Galaxy S\",\"version\":\"2.1\"}],\"mac\":[{\"version\":\"4.0\",\"browser\":\"safari\"}]}"
+        stub_request(:get, "http://#{@params[:username]}:#{@params[:password]}@api.browserstack.com/#{@client.version}/browsers").
+        with(:headers => {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+        to_return(:status => 200, :body => @browsers, :headers => {})
+        updated_browsers = @client.get_browsers
+        updated_browsers[:win].should be_nil
+      end
+    end
+
+    context "when os argument passed" do
+      it "should return a hash of browsers of that os" do
+        browsers = @client.get_browsers(:win)
+        browsers.should == @parsed_data[:win]
+      end
+
+      it "should return nil if invalid argument passed" do
+        browsers = @client.get_browsers("windows7")
+        browsers.should be_nil
+      end
+    end
+  end
+
+  describe "create_worker" do
+
+  end
+
+  describe "terminate_worker" do
+
+  end
+
+  describe "get_worker_status" do
+
+  end
+
+  describe "get_workers" do
+
+  end
+
+  describe "get_supported_os_list" do
+
+  end
+end

data/spec/browserstack_spec.rb

@@ -0,0 +1,10 @@
+require 'spec_helper'
+
+describe Browserstack do
+  describe "create_client" do
+    it "should create a new client object" do
+      @client = Browserstack.create_client(username: "foo", password: "testing")
+      @client.should be_an_instance_of(Browserstack::Client)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require File.expand_path("../../lib/browserstack", __FILE__)
+require 'webmock/rspec'
+RSpec.configure do |config|
+  #config.mock_with :rspec
+end
+
+WebMock.disable_net_connect!(:allow_localhost => true)

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: browserstack
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rahul Nawani
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.11.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.11
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.11
+- !ruby/object:Gem::Dependency
+  name: yajl-ruby
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+description: Ruby gem for interacting with the Browserstack API
+email:
+- rahulnwn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- !binary |-
+  LmdpdGlnbm9yZQ==
+- !binary |-
+  LnJzcGVj
+- !binary |-
+  LnJ2bXJj
+- !binary |-
+  R2VtZmlsZQ==
+- !binary |-
+  TElDRU5TRS50eHQ=
+- !binary |-
+  UkVBRE1FLm1k
+- !binary |-
+  UmFrZWZpbGU=
+- !binary |-
+  YnJvd3NlcnN0YWNrLmdlbXNwZWM=
+- !binary |-
+  bGliL2Jyb3dzZXJzdGFjay5yYg==
+- !binary |-
+  bGliL2Jyb3dzZXJzdGFjay9jbGllbnQucmI=
+- !binary |-
+  bGliL2Jyb3dzZXJzdGFjay92ZXJzaW9uLnJi
+- !binary |-
+  c3BlYy9icm93c2Vyc3RhY2svY2xpZW50X3NwZWMucmI=
+- !binary |-
+  c3BlYy9icm93c2Vyc3RhY2tfc3BlYy5yYg==
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3393997254230974074
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3393997254230974074
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby gem for interacting with the Browserstack API
+test_files:
+- !binary |-
+  c3BlYy9icm93c2Vyc3RhY2svY2xpZW50X3NwZWMucmI=
+- !binary |-
+  c3BlYy9icm93c2Vyc3RhY2tfc3BlYy5yYg==
+- !binary |-
+  c3BlYy9zcGVjX2hlbHBlci5yYg==