sauce_whisk 0.0.8 → 0.0.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZWVmNTYxMjQxNzdjYTRmMWQwNjIxNTFhZjQwYjM1M2IxZWMzNzkzYQ==
+    NTgwOTc5ZTkyZmNiZjU3ZmMwZmI3MDBiZTc2M2ZlZTU1ZGU2NzQ5Yw==
   data.tar.gz: !binary |-
-    ZDVlOTFhNWEwYzM2OWI4MTM2Y2I5YTJhZmYyMTRmNDdhZDljMTIwOQ==
+    NzBiNDA1MmFkNTEzNjJhYzE1NTc1ZDhiMDBjZGI3YzM4NDNhYTdkMg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    ZTdlMzRiMTk1ZTljM2Q3ODhmMGNiZDcwMzE2ZDAwZTkyYTE4Y2ZkYTdmMzdh
-    YTBiNWMzOWIxNzA3NWJmMTk5OWQzMDhlNzJkMGI4NTU5NmRjYzM0Yzc3ODY3
-    ODMxMTc4MjdiMWYyMjM0Mzc2NDEzYjUxYjcyODZjZmUxNWFjMDQ=
+    ZGQ4ODNiZDQ5YTA5ZDI4ZGFlZTk1Y2MxYTRhOWJlNTA3YzM2NDhhNTJjMzg5
+    ODhiYzA1NGI5NTVlZGM5Y2I3ZjY5NTJiOTM2NTExYmI5NDVlOTdhNmVmNGY0
+    ODJjMjZmYjgwZWFkMzQyMTk1YTBlOTZlMjBmOWUzNDc2YTUxYTI=
   data.tar.gz: !binary |-
-    Y2ZmZmM3ZWFlODljZDI0NGI1YTU1NjhkNmQxNmZhMDI2YmMxZmFiOWZjOGJh
-    YjQ4M2Y5OGQ2MzE5NjJmOTQxNmFhYTRhMjU1ZGE1NDAyZTkzYWYzNDIzMTNk
-    MDI4OGYwNGUxYjRjZTU3YmQyMjhlNmU3YjJiMTY3ODA0ZDYxOTg=
+    YWJlYWVhZjc3NzBkMjBiMzk4ZDdjYjAzZWY0MjNhYmM2Yjc2MzEwZDMxMTc5
+    NjQzMWEyYWJjZmFmYzBjY2YyNTZmODVhNjgzMjgyY2Y5ZTI1MmNkZGEyM2U1
+    YzI1YzhiMGQ1OTVjNTc5OWM2YzYyNTQwNDk1OTQwZGE3MmMxMjc=

data/.gitignore

@@ -15,3 +15,4 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
+.idea

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -2,8 +2,8 @@ source 'https://rubygems.org'
 
 gem "pry"
 
-#group :test do
-#  gem 'psych', "2.0.0", :path => "./vendor/psych"
-#end
+group :test do
+  gem 'psych', "2.0.0", :path => "./vendor/psych"
+end
 
 gemspec

data/README.md

@@ -88,6 +88,35 @@ There are three types of asset for Sauce Labs jobs: screenshots, video and logs.
   video = job.video # A single Asset, holding the video
 ```
 
+### Accounts
+
+At the moment, it is only possible to query existing accounts using the API gem.
+
+#### Retrieving a specific account
+```ruby
+my_account = SauceWhisk::Accounts.fetch "account_name" # Returns a SauceWhisk::Account object, with its concurrency limit
+my_account = SauceWhisk::Accounts.fetch("account_name", false) # Returns a SauceWhisk::Account object, does not fetch its concurrency limit
+```
+
+`SauceWhisk::Account` objects don't do anything other then store data about the relevant account:
+
+```ruby
+my_account.username             # Sauce Labs Username
+my_account.access_key           # Sauce Labs Access Key (For automated test authentication... Not your password)
+my_account.minutes              # Total number of minutes available
+my_account.total_concurrency    # Number of concurrent jobs allowed
+my_account.mac_concurrency      # Number of concurrent Mac hosted jobs allowed (includes iPad, iPhone, Mac)
+```
+
+#### Retrieving the concurrency limits for an account
+
+If you exceed your concurrency limits, your tests will be queued waiting for a free VM.  This may cause erroneous failures in your test cases, and no-one wants that.
+```ruby
+concurrencies = SauceWhisk::Accounts.concurrency_for "account_name"    # Hash containing both concurrency limits
+mac_concurrency = SauceWhisk::Accounts.concurrency_for "account_name", :mac    # Fixnum of just the Mac limit
+total_concurrency = SauceWhisk::Accounts.concurrency_for "account_name", :total    # Fixnum of the upper concurrency limit
+```
+
 ### Tunnels
 
 Tunnels give information about currently running [Sauce Connect](https://saucelabs.com/docs/connect) tunnels for a given user.
@@ -118,6 +147,57 @@ tunnel.stop  # Stops the Tunnel
 SauceWhisk::Tunnels.stop tunnel_id   # Stops the tunnel with the given id
 ```
 
+### Generic Sauce Labs Information
+
+The Sauce class returns non-user-specific info about available platforms, the number of jobs run, and the status of Sauce Labs' infrastructure.
+
+These can be used without authentication.
+
+#### Fetch All Available Platforms
+
+You can obtain an Array of all available webdriver platforms using `SauceWhisk::Sauce.platforms`:
+
+```ruby
+platforms = SauceWhisk::Sauce.platforms        # Fetch all platforms or return cached values
+platforms = SauceWhisk::Sauce.platforms(true)  # Force a fetch of all platforms
+
+platforms.first # => A Hash of platform details:
+ 
+ {
+    "long_name"=>"Firefox",             # Full name of the platform's browser
+    "api_name"=>"firefox",              # desired_capabilities name of the platform
+    "long_version"=>"20.0.1.",          # Full version number for the platform's browser
+    "preferred_version"=>"",            # Preferred version of the platform's browser (If none is requested)
+    "automation_backend"=>"webdriver",  # Whether this is a Webdriver or Selenium-rc driven platform
+    "os"=>"Linux",                      # desired_capabilities name of the Platform's Operating System  
+    "short_version"=>"20"               # desired_capabilities name of the Platform's Browsers's version
+ }
+```
+
+The most important values for a platform are the **os**, **api_name**, **short_version** fields.  These are the values to use for desired_capabilites *os*, *browser* and *browser_version* respectively.
+
+The gem does not support retrieval of selenium-rc platforms at the current time
+
+#### Count
+
+```ruby
+all_tests = SauceWhisk::Sauce.total_job_count  # The total number of jobs ever run with Sauce Labs' help
+```
+
+#### Service Status
+
+```ruby
+status = SauceWhisk::Sauce.service_status   # Check the status of Sauce Labs' service
+
+status.inspect # =>
+
+{
+  :wait_time=>0.39880952380952384,                          # Delay between requesting a job and it starting
+  :service_operational=>true,                               # Operational Status -- Boolean
+  :status_message=>"Basic service status checks passed."    # More info when erros occuring
+}
+```
+
 ### Logger
 
 You can set a custom logger object, passing anything that responds to puts:
@@ -130,7 +210,7 @@ SauceWhisk.logger defaults to STDOUT.
 
 ## Contributing
 
-1. Fork it
+1. Fork the [sauce-labs version](https://github.com/sauce-labs/sauce_whisk) of this repository
 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`)

data/lib/sauce_whisk/accounts.rb

@@ -3,7 +3,7 @@ module SauceWhisk
     extend SauceWhisk::RestRequestBuilder
 
     def self.fetch(user_id = ENV["SAUCE_USERNAME"], get_concurrency = true)
-      user_parameters = JSON.parse get "users/#{user_id}"
+      user_parameters = JSON.parse (get "users/#{user_id}"), :symbolize_names => true
       concurrencies = get_concurrency ? concurrency_for(user_id) : {}
 
       account_parameters = user_parameters.merge concurrencies

data/lib/sauce_whisk/rest_request_builder.rb

@@ -28,6 +28,22 @@ module SauceWhisk
       RestClient::Request.execute({:method => :delete, :url => resource_to_delete}.merge auth_details)
     end
 
+    def post(resource_parameters)
+      url = fully_qualified_resource
+      length = resource_parameters.length
+      headers = {"Content-Length" => length}
+      req_params = {
+          :method => :post,
+          :url => url,
+          :payload => resource_parameters,
+          :content_type => "application/json",
+          :headers => headers
+      }
+
+      RestClient::Request.execute(req_params.merge auth_details)
+
+    end
+
     def auth_details
       {:user => SauceWhisk.username, :password => SauceWhisk.password}
     end

data/lib/sauce_whisk/tunnels.rb

@@ -23,6 +23,11 @@ module SauceWhisk
       return tunnels
     end
 
+    def self.open(opts)
+      #opts[:tunnel_identifier] = opts.delete :tunnel_id
+      new_tunnel_parameters = JSON.parse post opts.to_json
+    end
+
     def self.stop tunnel_id
       delete tunnel_id
     end

data/lib/sauce_whisk/version.rb

@@ -1,3 +1,3 @@
 module SauceWhisk
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/spec/fixtures/vcr_cassettes/tunnels.yml

@@ -136,43 +136,7 @@ http_interactions:
       - '36'
     body:
       encoding: US-ASCII
-      string: &1 !ruby/string
-        str: '["5da3256813fd409ba7927004b499a5cf"]'
-        net_http_res: !ruby/object:Net::HTTPOK
-          http_version: '1.0'
-          code: '200'
-          message: OK
-          header:
-            server:
-            - nginx/0.7.62
-            date:
-            - Tue, 11 Jun 2013 06:49:07 GMT
-            content-type:
-            - application/json
-            connection:
-            - keep-alive
-            pragma:
-            - no-cache
-            cache-control:
-            - no-cache
-            x-frame-options:
-            - DENY
-            set-cookie:
-            - csrf_token=90135ac06149df70abf84010839f0d84; expires="Tue, 11-Jun-2013
-              07:06:13 GMT"; Max-Age=600; Path=/
-            - metrics=74fb9ada210b5a86c395fa69c78b7ece36c584aab137e19870e94bcdb0a2e17bbd96f144;
-              Path=/
-            content-length:
-            - '36'
-          body: *1
-          read: true
-          __read_body_previously_called: true
-        args:
-          :method: :get
-          :url: https://saucelabs.com/rest/v1/dylanatsauce/tunnels
-          :user: dylanatsauce
-          :password: 8f5210dd-f0cf-477f-b720-9f721a9679a4
-        code: 200
+      string: '["5da3256813fd409ba7927004b499a5cf"]'
     http_version: 
   recorded_at: Tue, 11 Jun 2013 06:56:16 GMT
 - request:
@@ -226,4 +190,54 @@ http_interactions:
         ["64703"], "ScriptName": "sauce_connect", "Ports": ["80"]}}'
     http_version: 
   recorded_at: Tue, 11 Jun 2013 07:10:26 GMT
+- request:
+    method: post
+    uri: https://<SAUCE_USERNAME>:<SAUCE_ACCESS_KEY>@saucelabs.com/rest/v1/<SAUCE_USERNAME>/tunnels
+    body:
+      encoding: UTF-8
+      string: '{"tunnel_identifier":"KarlMarx"}'
+    headers:
+      Accept:
+      - '*/*; q=0.5, application/xml'
+      Accept-Encoding:
+      - gzip, deflate
+      Content-Length:
+      - '85'
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx/0.7.62
+      Date:
+      - Tue, 30 Jul 2013 08:38:22 GMT
+      Content-Type:
+      - application/json
+      Connection:
+      - keep-alive
+      Pragma:
+      - no-cache
+      Cache-Control:
+      - no-cache
+      X-Frame-Options:
+      - DENY
+      Set-Cookie:
+      - csrf_token=3c66b97477a4dedd1255faf05ce90d66; expires="Tue, 30-Jul-2013 08:56:35
+        GMT"; Max-Age=600; Path=/
+      - metrics=034bd00d05345d3992282b0f28e816878971ff1a86e9ab91ce174a2e89dcab18527fa539;
+        Path=/
+      Content-Length:
+      - '352'
+    body:
+      encoding: US-ASCII
+      string: '{"status": "new", "direct_domains": null, "shutdown_time": null, "ssh_port":
+        9123, "user_shutdown": null, "use_caching_proxy": false, "creation_time":
+        1375173995, "domain_names": null, "shared_tunnel": null, "tunnel_identifier":
+        "KarlMarx", "host": null, "owner": "<SAUCE_USERNAME>", "use_kgp": true, "id":
+        "4824d6b282e04d1184daff5401a52e1e", "metadata": null}'
+    http_version: 
+  recorded_at: Tue, 30 Jul 2013 08:46:35 GMT
 recorded_with: VCR 2.5.0

data/spec/lib/sauce_whisk/accounts_spec.rb

@@ -10,7 +10,12 @@ describe SauceWhisk::Accounts, :vcr => {:cassette_name => "accounts"} do
     end
 
     it "returns an Account object" do
-      SauceWhisk::Accounts.fetch(ENV["SAUCE_USERNAME"]).should be_an_instance_of SauceWhisk::Account
+      username = ENV["SAUCE_USERNAME"]
+      account = SauceWhisk::Accounts.fetch(username)
+      account.should be_an_instance_of SauceWhisk::Account
+
+      account.username.should eq username
+      account.access_key.should_not be_nil
     end
 
     it "includes the concurrency by default" do

data/spec/lib/sauce_whisk/rest_request_builder_spec.rb

@@ -69,6 +69,44 @@ describe SauceWhisk::RestRequestBuilder do
     end
   end
 
+begin
+  describe "#post", :vcr => {:cassette_name => 'tunnels'} do
+    let(:expected_payload) {{:tunnel_identifier => "KarlMarx"}.to_json}
+    it "calls the base URL" do
+      expected_url = "#{SauceWhisk.base_url}/#{dummy_client.resource}"
+      RestClient::Request.should_receive(:execute).with(hash_including({:url => expected_url}))
+
+      dummy_client.post expected_payload
+    end
+
+    it "uses the correct method" do
+      RestClient::Request.should_receive(:execute).with(hash_including({:method => :post}))
+      dummy_client.post expected_payload
+    end
+
+    it "includes the correct payload" do
+      RestClient::Request.should_receive(:execute).with(hash_including({:payload => expected_payload}))
+      dummy_client.post expected_payload
+    end
+
+    it "includes the correct content_type" do
+      RestClient::Request.should_receive(:execute).with(hash_including({:content_type => "application/json"}))
+      dummy_client.post expected_payload
+    end
+
+    it "includes the correct length" do
+      expected_length = expected_payload.length
+      RestClient::Request.should_receive(:execute).with(hash_including({:headers => {"Content-Length" => expected_length}}))
+      dummy_client.post expected_payload
+    end
+
+    it "includes the authentication parameters" do
+      RestClient::Request.should_receive(:execute).with(hash_including(mock_auth))
+      dummy_client.post expected_payload
+    end
+  end
+end
+
   describe "#put", :vcr => {:cassette_name => 'jobs'} do
     let(:expected_url) {"#{SauceWhisk.base_url}/#{dummy_client.resource}/something"}
     it "calls the base URL with the put method" do

data/spec/lib/sauce_whisk/tunnels_spec.rb

@@ -51,4 +51,13 @@ describe SauceWhisk::Tunnels, :vcr => {:cassette_name => "tunnels"} do
       assert_requested :delete, "https://#{auth}@saucelabs.com/rest/v1/dylanatsauce/tunnels/#{tunnel_id}"
     end
   end
+
+  describe "##open" do
+    it "calls the correct API method" do
+      params = {:tunnel_identifier => "bees", :ssh_port => 9123, :use_caching_proxy => false, :use_kgp => true}
+
+      SauceWhisk::Tunnels.open params
+      assert_requested(:post, "https://#{auth}@saucelabs.com/rest/v1/dylanatsauce/tunnels",:body => params.to_json)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sauce_whisk
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Dylan Lacey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-24 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -88,6 +88,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - .ruby-gemset
 - .ruby-version
 - Gemfile