browser_stack 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +85 -0
- data/Rakefile +1 -0
- data/browser_stack.gemspec +26 -0
- data/examples/test.rb +15 -0
- data/lib/browser_stack.rb +13 -0
- data/lib/browser_stack/api_request.rb +55 -0
- data/lib/browser_stack/api_status.rb +11 -0
- data/lib/browser_stack/browser.rb +16 -0
- data/lib/browser_stack/configuration.rb +20 -0
- data/lib/browser_stack/version.rb +3 -0
- data/lib/browser_stack/worker.rb +50 -0
- metadata +140 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2013 amardaxini
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,85 @@
|
|
1
|
+
# BrowserStack
|
2
|
+
|
3
|
+
Ruby Wrapper Of [Browser Stack API](https://github.com/browserstack/api)
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'browser_stack'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install browser_stack
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
### Basic Configuration
|
22
|
+
```
|
23
|
+
# http://api.browserstack.com/3
|
24
|
+
BrowserStack.configure do |config|
|
25
|
+
config.api_version="3"
|
26
|
+
config.user_name = "amardaxini@gmail.com"
|
27
|
+
config.password = "thakkar"
|
28
|
+
end
|
29
|
+
|
30
|
+
```
|
31
|
+
### Getting Available Browsers
|
32
|
+
```
|
33
|
+
# /browsers
|
34
|
+
|
35
|
+
client = BrowserStack::Browser.get_browsers
|
36
|
+
client.parse_response
|
37
|
+
|
38
|
+
#/browsers?flat=true
|
39
|
+
|
40
|
+
client = BrowserStack::Browser.get_browsers(true)
|
41
|
+
client.parse_response
|
42
|
+
|
43
|
+
# In General for all request
|
44
|
+
client.response # will be the http response
|
45
|
+
client.response.code # http response code
|
46
|
+
client.api_error?
|
47
|
+
cleint.error_message
|
48
|
+
|
49
|
+
```
|
50
|
+
### Create a New Browser Worker
|
51
|
+
```
|
52
|
+
# /worker
|
53
|
+
worker = BrowserStack::Worker.create_worker({:os=>"Windows",:os_version=>'7',:url=>"url",:browser=>"ie",:browser_version=>"8.0"})
|
54
|
+
worker.parse_response
|
55
|
+
```
|
56
|
+
### Terminating a worker
|
57
|
+
```
|
58
|
+
# /worker/:id
|
59
|
+
delete_worker = BrowserStack::Worker.treminate_worker(worker_id)
|
60
|
+
worker.parse_response
|
61
|
+
```
|
62
|
+
### Getting Worker Status
|
63
|
+
```
|
64
|
+
# /worker/:id
|
65
|
+
worker_status = BrowserStack::Worker.get_worker_status(worker_id)
|
66
|
+
worker.parse_response
|
67
|
+
|
68
|
+
# /workers (Get All worker status)
|
69
|
+
worker_status = BrowserStack::Worker.get_all_worker_status
|
70
|
+
worker.parse_response
|
71
|
+
```
|
72
|
+
|
73
|
+
### Getting API Status
|
74
|
+
```
|
75
|
+
# /status
|
76
|
+
api_status = BrowserStack::ApiStatus.get_status
|
77
|
+
```
|
78
|
+
|
79
|
+
## Contributing
|
80
|
+
|
81
|
+
1. Fork it
|
82
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
83
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
84
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
85
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "bundler/gem_tasks"
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'browser_stack/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "browser_stack"
|
8
|
+
spec.version = BrowserStack::VERSION
|
9
|
+
spec.authors = ["amardaxini"]
|
10
|
+
spec.email = ["amardaxini@gmail.com"]
|
11
|
+
spec.description = %q{ruby wrapper of browser stack api}
|
12
|
+
spec.summary = %q{ruby wrapper of browser stack api}
|
13
|
+
spec.homepage = "https://github.com/amardaxini/browser_stack"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files`.split($/)
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
22
|
+
spec.add_development_dependency "rake"
|
23
|
+
spec.add_development_dependency "net/http"
|
24
|
+
spec.add_development_dependency "json"
|
25
|
+
spec.add_development_dependency "uri"
|
26
|
+
end
|
data/examples/test.rb
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
require "browser_stack"
|
2
|
+
BrowserStack.configure do |config|
|
3
|
+
config.api_version="3"
|
4
|
+
config.user_name = ""
|
5
|
+
config.password = ""
|
6
|
+
end
|
7
|
+
# browsers = BrowserStack::Browser.get_browsers
|
8
|
+
# worker = BrowserStack::Worker.create_worker({:os=>"Windows",:os_version=>'7',:url=>"http://quizit.mypatshala.com",:browser=>"ie",:browser_version=>"8.0"})
|
9
|
+
|
10
|
+
# worker_id = worker.parse_response["id"]
|
11
|
+
|
12
|
+
#delete_worker = BrowserStack::Worker.treminate_worker(worker_id)
|
13
|
+
# worker_status = BrowserStack::Worker.get_worker_status(worker_id)
|
14
|
+
#worker_statuses = BrowserStack::Worker.get_all_worker_status
|
15
|
+
# api_status = BrowserStack::ApiStatus.get_status
|
@@ -0,0 +1,13 @@
|
|
1
|
+
require 'uri'
|
2
|
+
require 'net/http'
|
3
|
+
require 'json'
|
4
|
+
require "browser_stack/version"
|
5
|
+
require "browser_stack/configuration"
|
6
|
+
require "browser_stack/api_request"
|
7
|
+
require "browser_stack/browser"
|
8
|
+
require "browser_stack/worker"
|
9
|
+
require "browser_stack/api_status"
|
10
|
+
|
11
|
+
module BrowserStack
|
12
|
+
# Your code goes here...
|
13
|
+
end
|
@@ -0,0 +1,55 @@
|
|
1
|
+
module BrowserStack
|
2
|
+
class ApiRequest
|
3
|
+
attr_accessor :uri,:response,:http_client,:request,:config,:params
|
4
|
+
|
5
|
+
def commit(url,request_type="get",params={})
|
6
|
+
@config = BrowserStack.configuration
|
7
|
+
@params = params
|
8
|
+
set_uri(url)
|
9
|
+
get_http_client
|
10
|
+
if request_type == "get"
|
11
|
+
@request = Net::HTTP::Get.new(@uri.request_uri)
|
12
|
+
|
13
|
+
elsif request_type=="post"
|
14
|
+
@request = Net::HTTP::Post.new(@uri.request_uri)
|
15
|
+
@request.set_form_data(params)
|
16
|
+
|
17
|
+
elsif request_type == "delete"
|
18
|
+
@request = Net::HTTP::Delete.new(@uri.request_uri)
|
19
|
+
|
20
|
+
end
|
21
|
+
|
22
|
+
authenticate
|
23
|
+
@response = http_client.request(@request)
|
24
|
+
end
|
25
|
+
|
26
|
+
def parse_response
|
27
|
+
if @response.code == "401"
|
28
|
+
@response.body
|
29
|
+
else
|
30
|
+
JSON.parse @response.body
|
31
|
+
end
|
32
|
+
end
|
33
|
+
|
34
|
+
def api_error?
|
35
|
+
@response.code == "422" || @response.code == "403"
|
36
|
+
end
|
37
|
+
|
38
|
+
def error_message
|
39
|
+
parse_response
|
40
|
+
end
|
41
|
+
|
42
|
+
def authenticate
|
43
|
+
@request.basic_auth(@config.user_name,@config.password)
|
44
|
+
end
|
45
|
+
|
46
|
+
def set_uri(url)
|
47
|
+
@uri = URI.parse("http://api.browserstack.com/#{@config.api_version}"+url)
|
48
|
+
end
|
49
|
+
|
50
|
+
def get_http_client
|
51
|
+
@http_client = Net::HTTP.new(@uri.host, @uri.port)
|
52
|
+
end
|
53
|
+
|
54
|
+
end
|
55
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
module BrowserStack
|
2
|
+
class Browser < ApiRequest
|
3
|
+
class << self
|
4
|
+
|
5
|
+
def get_browsers(flat=nil)
|
6
|
+
request = new()
|
7
|
+
if flat.nil?
|
8
|
+
request.commit("/browsers")
|
9
|
+
else
|
10
|
+
request.commit("/browsers?flat=#{flat}")
|
11
|
+
end
|
12
|
+
request
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,20 @@
|
|
1
|
+
module BrowserStack
|
2
|
+
class Configuration
|
3
|
+
|
4
|
+
attr_accessor :api_version,:user_name,:password
|
5
|
+
def initialize(api_version=3,user_name="",password="")
|
6
|
+
@api_version = api_version
|
7
|
+
@user_name = user_name
|
8
|
+
@password = password
|
9
|
+
end
|
10
|
+
end
|
11
|
+
|
12
|
+
class << self
|
13
|
+
attr_accessor :configuration
|
14
|
+
end
|
15
|
+
|
16
|
+
def self.configure
|
17
|
+
self.configuration = Configuration.new
|
18
|
+
yield(configuration) if block_given?
|
19
|
+
end
|
20
|
+
end
|
@@ -0,0 +1,50 @@
|
|
1
|
+
module BrowserStack
|
2
|
+
class Worker < ApiRequest
|
3
|
+
attr_accessor :os,:os_version,:url,:timeout,:browser,:browser_version
|
4
|
+
def initialize(attributes={})
|
5
|
+
attributes.each do |name, value|
|
6
|
+
begin
|
7
|
+
send("#{name}=", value)
|
8
|
+
rescue
|
9
|
+
puts "invalid attribute #{name} in worker"
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
13
|
+
|
14
|
+
def valid?
|
15
|
+
os && os_version && url
|
16
|
+
end
|
17
|
+
|
18
|
+
class << self
|
19
|
+
def create_worker(params={})
|
20
|
+
worker = Worker.new(params)
|
21
|
+
if worker.valid?
|
22
|
+
worker.commit("/worker","post",params)
|
23
|
+
else
|
24
|
+
# raise some error
|
25
|
+
raise "Not Valid should contain os,os_version,url parameter"
|
26
|
+
end
|
27
|
+
worker
|
28
|
+
end
|
29
|
+
|
30
|
+
def treminate_worker(worker_id)
|
31
|
+
worker = Worker.new
|
32
|
+
worker.commit("/worker/#{worker_id}","delete")
|
33
|
+
worker
|
34
|
+
end
|
35
|
+
|
36
|
+
def get_worker_status(worker_id)
|
37
|
+
worker = Worker.new
|
38
|
+
worker.commit("/worker/#{worker_id}")
|
39
|
+
worker
|
40
|
+
end
|
41
|
+
|
42
|
+
def get_all_worker_status
|
43
|
+
worker = Worker.new
|
44
|
+
worker.commit("/workers")
|
45
|
+
worker
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
49
|
+
end
|
50
|
+
end
|
metadata
ADDED
@@ -0,0 +1,140 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: browser_stack
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- amardaxini
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2013-05-01 00:00:00.000000000 Z
|
13
|
+
dependencies:
|
14
|
+
- !ruby/object:Gem::Dependency
|
15
|
+
name: bundler
|
16
|
+
requirement: !ruby/object:Gem::Requirement
|
17
|
+
none: false
|
18
|
+
requirements:
|
19
|
+
- - ~>
|
20
|
+
- !ruby/object:Gem::Version
|
21
|
+
version: '1.3'
|
22
|
+
type: :development
|
23
|
+
prerelease: false
|
24
|
+
version_requirements: !ruby/object:Gem::Requirement
|
25
|
+
none: false
|
26
|
+
requirements:
|
27
|
+
- - ~>
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: '1.3'
|
30
|
+
- !ruby/object:Gem::Dependency
|
31
|
+
name: rake
|
32
|
+
requirement: !ruby/object:Gem::Requirement
|
33
|
+
none: false
|
34
|
+
requirements:
|
35
|
+
- - ! '>='
|
36
|
+
- !ruby/object:Gem::Version
|
37
|
+
version: '0'
|
38
|
+
type: :development
|
39
|
+
prerelease: false
|
40
|
+
version_requirements: !ruby/object:Gem::Requirement
|
41
|
+
none: false
|
42
|
+
requirements:
|
43
|
+
- - ! '>='
|
44
|
+
- !ruby/object:Gem::Version
|
45
|
+
version: '0'
|
46
|
+
- !ruby/object:Gem::Dependency
|
47
|
+
name: net/http
|
48
|
+
requirement: !ruby/object:Gem::Requirement
|
49
|
+
none: false
|
50
|
+
requirements:
|
51
|
+
- - ! '>='
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0'
|
54
|
+
type: :development
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
none: false
|
58
|
+
requirements:
|
59
|
+
- - ! '>='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
- !ruby/object:Gem::Dependency
|
63
|
+
name: json
|
64
|
+
requirement: !ruby/object:Gem::Requirement
|
65
|
+
none: false
|
66
|
+
requirements:
|
67
|
+
- - ! '>='
|
68
|
+
- !ruby/object:Gem::Version
|
69
|
+
version: '0'
|
70
|
+
type: :development
|
71
|
+
prerelease: false
|
72
|
+
version_requirements: !ruby/object:Gem::Requirement
|
73
|
+
none: false
|
74
|
+
requirements:
|
75
|
+
- - ! '>='
|
76
|
+
- !ruby/object:Gem::Version
|
77
|
+
version: '0'
|
78
|
+
- !ruby/object:Gem::Dependency
|
79
|
+
name: uri
|
80
|
+
requirement: !ruby/object:Gem::Requirement
|
81
|
+
none: false
|
82
|
+
requirements:
|
83
|
+
- - ! '>='
|
84
|
+
- !ruby/object:Gem::Version
|
85
|
+
version: '0'
|
86
|
+
type: :development
|
87
|
+
prerelease: false
|
88
|
+
version_requirements: !ruby/object:Gem::Requirement
|
89
|
+
none: false
|
90
|
+
requirements:
|
91
|
+
- - ! '>='
|
92
|
+
- !ruby/object:Gem::Version
|
93
|
+
version: '0'
|
94
|
+
description: ruby wrapper of browser stack api
|
95
|
+
email:
|
96
|
+
- amardaxini@gmail.com
|
97
|
+
executables: []
|
98
|
+
extensions: []
|
99
|
+
extra_rdoc_files: []
|
100
|
+
files:
|
101
|
+
- .gitignore
|
102
|
+
- Gemfile
|
103
|
+
- LICENSE.txt
|
104
|
+
- README.md
|
105
|
+
- Rakefile
|
106
|
+
- browser_stack.gemspec
|
107
|
+
- examples/test.rb
|
108
|
+
- lib/browser_stack.rb
|
109
|
+
- lib/browser_stack/api_request.rb
|
110
|
+
- lib/browser_stack/api_status.rb
|
111
|
+
- lib/browser_stack/browser.rb
|
112
|
+
- lib/browser_stack/configuration.rb
|
113
|
+
- lib/browser_stack/version.rb
|
114
|
+
- lib/browser_stack/worker.rb
|
115
|
+
homepage: https://github.com/amardaxini/browser_stack
|
116
|
+
licenses:
|
117
|
+
- MIT
|
118
|
+
post_install_message:
|
119
|
+
rdoc_options: []
|
120
|
+
require_paths:
|
121
|
+
- lib
|
122
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
123
|
+
none: false
|
124
|
+
requirements:
|
125
|
+
- - ! '>='
|
126
|
+
- !ruby/object:Gem::Version
|
127
|
+
version: '0'
|
128
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
129
|
+
none: false
|
130
|
+
requirements:
|
131
|
+
- - ! '>='
|
132
|
+
- !ruby/object:Gem::Version
|
133
|
+
version: '0'
|
134
|
+
requirements: []
|
135
|
+
rubyforge_project:
|
136
|
+
rubygems_version: 1.8.25
|
137
|
+
signing_key:
|
138
|
+
specification_version: 3
|
139
|
+
summary: ruby wrapper of browser stack api
|
140
|
+
test_files: []
|