scirocco 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f9cc98e4a3aeb938c3d8452b8bac3c4f89a22446
-  data.tar.gz: abae65d087d094393a21d710abf5f8e724c301bc
+  metadata.gz: 1ac916cebd9a0b2dba447ecc7528dae8ad4030a3
+  data.tar.gz: 8240b153e6dda045aff848468f8aec009c24c44f
 SHA512:
-  metadata.gz: 0a799920fd15a9be2dc2353fb463f763850850fe2f1f4efd343805f22f3543e93492edfd686999d1b7af820ac6661d3e6a533306fc4907efe9e902c235568a44
-  data.tar.gz: 4b788bd345aae6d6c8be85b13f4e182038ad610caf8ee274710a7b530c290d3b2d34e140c001f4737bdf056c7feeb7a1ca76cbcef505298f1366dafde0b37f5c
+  metadata.gz: 6a6b034d27053cf54c108a6d9913a5af95d6a10ca7a5bb5c18cbcea47ba0e0eeff425966292e3568709c6607d12b0d1e8006705a8de281142b862c1bf467dd0b
+  data.tar.gz: 8c192aff712a4038f9b6da6ea3d652ad3e6df54db102cb74702d7d51bef10a4195ff1ebd8e7576dc621be9fcc759d36db62064b0baf0053009d66304cf178f89

data/README.md

@@ -11,7 +11,7 @@ The official Ruby client for the [SciroccoCloud](http://www.scirocco-cloud.com/)
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'scirocco'
+gem 'scirocco', '0.1.3'
 ```
 
 And then execute:
@@ -20,17 +20,60 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install scirocco
+    $ gem install scirocco -v 0.1.3
 
-## Running Tests
+## Upload app
 
-    $ scirocco run_test $TEST_CLASS_ID $DEVICE_ID --api-key $API_KEY --poll
+    $ scirocco upload_app --project-id=$PROJECT_ID --app-path=$APP_PATH --api-key=$API_KEY
+
+
+## Search device
+
+    $ scirocco devices --project-id=$PROJECT_ID --status=available --api-key=$API_KEY
+
+## Running tests
+
+    $ scirocco run_test --test-class-id=$TEST_CLASS_ID --device-id=$DEVICE_ID --api-key=$API_KEY --poll
+
+## Abort the all booked test jobs
+
+    $ scirocco abort_all --api-key=$API_KEY --poll
 
 ## Jenkins Integration
 
-In Jenkins create a new Execute Shell build step as pictured below.
+* In Jenkins, set up a new task.
+* In the "Execute shell" section, add the following:
+
+~~~
+# Configuration
+API_KEY=XXXXX
+PROJECT_ID=XXX
+APP_PATH=./MainActivity.apk
+TEST_CLASS_ID=XXX
+
+# Set available device id
+DEVICE_ID=`scirocco get_device_id --project-id=$PROJECT_ID --status=available --api-key=$API_KEY`
+if [ -n "$DEVICE_ID" ]; then
+  # When available device is not found, set not available device id
+  DEVICE_ID=`scirocco get_device_id --project-id=$PROJECT_ID --api-key=$API_KEY`
+fi
+
+# Upload apk
+scirocco upload_app --project-id=$PROJECT_ID --app-path=$APP_PATH --api-key=$API_KEY
+
+# Get device_id
+scirocco get_device_id --project-id=$PROJECT_ID --status=available --api-key=$API_KEY
+
+# Do the test
+scirocco run_test --test-class-id=$TEST_CLASS_ID --device-id=$DEVICE_ID --poll --api-key=$API_KEY
+~~~
+
+Here's what that code looks like in Jenkins:
+
+![Jenkins Integration](https://raw.githubusercontent.com/sonixlabs/scirocco-rb/master/jenkins.png)
 
-![Jenkins Integration](https://raw.github.com/sonixlabs/scirocco-rb/master/assets/jenkins.png)
+* Save the task.
+* Execute the task and check for the console output.
 
 ## Development
 

data/examples/search_devices.rb

@@ -0,0 +1,8 @@
+require 'scirocco'
+
+API_KEY = ENV['SCIROCCO_API_KEY']
+PROJECT_ID = ENV['SCIROCCO_PROJECT_ID']
+
+client = Scirocco::Client.new(API_KEY)
+devices = client.devices(PROJECT_ID, {:status => "available"})["devices"]
+pp devices

data/lib/scirocco/cli.rb

@@ -14,17 +14,20 @@ module Scirocco
       pp client.projects()
     end
 
-    desc "tests <PROJECT_ID>", "Print list of tests associated with the given project_id"
-    def tests(project_id)
+    desc "tests", "Print list of tests associated with the given project_id"
+    option :project_id, :required => true
+    def tests
       client = Scirocco::Client.new(options[:api_key], options)
-      pp client.tests(project_id)
+      pp client.tests(options[:project_id])
     end
 
+    desc "run_test", "Runs the test on the device"
+    option :test_class_id, :required => true
+    option :device_id, :required => true
     option :poll, :type => :boolean
-    desc "run_test <TEST_CLASS_ID> <DEVICE_ID>", "Runs the test on the device"
-    def run_test(test_class_id, device_id)
+    def run_test
       client = Scirocco::Client.new(options[:api_key], options)
-      test_job = client.run_test(test_class_id, device_id)["test_job"]
+      test_job = client.run_test(options[:test_class_id], options[:device_id])["test_job"]
       puts "* test_job:"
       pp test_job
       if options[:poll]
@@ -40,28 +43,70 @@ module Scirocco
       end
     end
 
-    desc "check_test <TEST_JOB_ID>", "Check the test result"
-    def check_test(test_job_id)
+    desc "check_test", "Check the test result"
+    option :test_job_id, :required => true
+    def check_test
       client = Scirocco::Client.new(options[:api_key], options)
-      pp client.check_test(test_job_id)
+      pp client.check_test(options[:test_job_id])
     end
 
-    desc "devices <PROJECT_ID>", "Print list of devices"
-    def devices(project_id)
+    desc "abort_test", "Abort the booked test job"
+    option :test_job_id, :required => true
+    def abort_test
       client = Scirocco::Client.new(options[:api_key], options)
-      pp client.devices(project_id)
+      pp client.abort_test(options[:test_job_id])
     end
 
-    desc "apps <PROJECT_ID>", "Print list of apps"
-    def apps(project_id)
+    desc "abort_all", "Abort the all booked test jobs"
+    def abort_all
       client = Scirocco::Client.new(options[:api_key], options)
-      pp client.apps(project_id)
+      pp client.abort_all
     end
 
-    desc "upload_app <PROJECT_ID> <APP_PATH>", "Upload app"
-    def upload_app(project_id, app_path)
+    desc "devices", "Print list of devices"
+    option :project_id, :required => true
+    option :os
+    option :os_version
+    option :carrier
+    option :model
+    option :country
+    option :status
+    def devices
       client = Scirocco::Client.new(options[:api_key], options)
-      pp client.upload_app(project_id, app_path)
+      pp client.devices(options[:project_id], options)
+    end
+
+    desc "get_device_id", "Get device id"
+    option :project_id, :required => true
+    option :os
+    option :os_version
+    option :carrier
+    option :model
+    option :country
+    option :status
+    def get_device_id
+      client = Scirocco::Client.new(options[:api_key], options)
+      devices = client.devices(options[:project_id], options)["devices"]
+      if devices.length > 0
+        p devices[0]["device_id"]
+      else
+        p ""
+      end
+    end
+
+    desc "apps", "Print list of apps"
+    option :project_id, :required => true
+    def apps
+      client = Scirocco::Client.new(options[:api_key], options)
+      pp client.apps(options[:project_id])
+    end
+
+    desc "upload_app", "Upload app"
+    option :project_id, :required => true
+    option :app_path, :required => true
+    def upload_app
+      client = Scirocco::Client.new(options[:api_key], options)
+      pp client.upload_app(options[:project_id], options[:app_path])
     end
 
   end

data/lib/scirocco/client.rb

@@ -28,9 +28,9 @@ module Scirocco
     ## Device API
     ##############
 
-    def devices(project_id)
+    def devices(project_id, params={})
       url = build_url("devices")
-      get(url, {:project_id => project_id})
+      get(url, {:project_id => project_id}.merge(params))
     end
 
 
@@ -57,7 +57,6 @@ module Scirocco
     # Checks for when test completes
     def poll_test_result(test_job_id)
       status = nil
-      runtime = 0
       while !['passed', 'failed'].include?(status)
         sleep(API_POLL_SEC)
         test_status = check_test(test_job_id)["test_status"]
@@ -77,6 +76,24 @@ module Scirocco
       get(url, params)
     end
 
+    def abort_test(test_job_id)
+      url = build_url("tests", "abort")
+      data = {
+        :api_key => @api_key,
+        :test_job_id => test_job_id
+      }
+      post(url, data)
+    end
+
+    def abort_all
+      url = build_url("tests", "abort_all")
+      data = {
+        :api_key => @api_key,
+      }
+      post(url, data)
+    end
+
+
     ############
     ## App API
     ############
@@ -97,8 +114,6 @@ module Scirocco
       post(url, data)
     end
 
-    private
-
     def build_url(type, resource=nil)
       @scheme + "://" + [@host + ":" + @port.to_s, "api", @version, type, resource].compact.join("/") + "/"
     end

data/lib/scirocco/version.rb

@@ -1,3 +1,3 @@
 module Scirocco
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scirocco
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - k-yamada
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-26 00:00:00.000000000 Z
+date: 2015-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -126,7 +126,9 @@ files:
 - assets/jenkins.png
 - bin/console
 - bin/setup
+- examples/search_devices.rb
 - exe/scirocco
+- jenkins.png
 - lib/scirocco.rb
 - lib/scirocco/cli.rb
 - lib/scirocco/client.rb
@@ -154,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: API client for SciroccoCloud