testdroid-api-client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1bd3bc1947d038a2a89a0104bfe1d25d8676c28c
+  data.tar.gz: 798caa22a155acb707f6296ac98da4bb4ba9d2a1
+SHA512:
+  metadata.gz: 5a168025882c4a54ddcd9afbfd48ca3e57842c014285e5cc6d6979a6a6efd9a835f7ef2b5fafdc3c7988a2d56891867d9c5f50087eec42920d20584f4cf0b2fc
+  data.tar.gz: 909681de08be878362a338ddb2f6acc53706c525ffba9d413a446f39578729d7564b3aafa54288525b112a77c83080f28d3e2f3ee57acec2e9209c8d9f83b01f

data/.gitignore

@@ -0,0 +1,19 @@
+
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,23 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    jwt (0.1.11)
+      multi_json (>= 1.5)
+    multi_json (1.9.2)
+    multi_xml (0.5.5)
+    multipart-post (2.0.0)
+    oauth2 (0.9.3)
+      faraday (>= 0.8, < 0.10)
+      jwt (~> 0.1.8)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  oauth2

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Sakari Rautiainen
+
+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,39 @@
+testdroid-api-client-ruby
+=========================
+
+```
+require 'testdroid-api-client'
+#Authenticate
+ client = TestdroidAPI::Client.new('admin@localhost', 'admin')
+ @user = client.authorize
+#get Projects
+ projects = @user.projects.list
+
+#get project by id
+project_id = 123
+project123 = @user.projects.get(project_id)
+#output project name
+p "Project name #{project123.name}"
+
+#run project
+test_run = project123.run
+
+#check test run status
+p "Project state #{test_run.state}"
+
+#download all logs from test run
+test_run.device_runs.list({:params => {:limit => 100}}).each { |drun| drun.download_logs("#{drun.id}_log") }
+
+#Get label for android os version 2.1
+lg_android_version_2_1 = client.label_groups.list.detect {|lg| lg.display_name.casecmp("android version") == 0 }
+
+os_v2_1 =  client.label_groups.get(lg_android_versions.id).labels.list.detect {|l| l.display_name.casecmp("2.1") == 0 }
+        
+ #get all devices with android os level 2.1
+ devices = client.label_groups.get(lg_android_versions.id).labels.get(os_v2_1.id).devices
+#get spefici device from devices list        
+lenovo_a820 = devices.list.detect {|d| d.display_name == "Lenovo A820"}
+       
+
+```
+See https://cloud.testdroid.com/swagger/index.html for more details about API V2

data/lib/testdroid-api-client.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby
+require 'json'
+require 'testdroid_api/client'
+require 'testdroid_api/cloud_resource'
+require 'testdroid_api/cloud_list_resource'
+require 'testdroid_api/user'
+require 'testdroid_api/device_groups'
+require 'testdroid_api/projects'
+require 'testdroid_api/runs'
+require 'testdroid_api/device_runs'
+require 'testdroid_api/label_groups'
+require 'testdroid_api/labels'
+require 'testdroid_api/files'
+require 'testdroid_api/devices'
+require 'testdroid_api/device_sessions'
+
+
+require 'oauth2'
+require 'logger'

data/lib/testdroid_api/client.rb

@@ -0,0 +1,124 @@
+module TestdroidAPI
+
+	class Client
+		attr_reader :config
+		attr_accessor :logger
+		attr_reader :token
+
+		API_VERSION = 'api/v2'
+		CLOUD_ENDPOINT='https://cloud.testdroid.com'
+		ACCEPT_HEADERS={'Accept' => 'application/json'}
+
+		def initialize(username, password, cloud_url = CLOUD_ENDPOINT, logger = nil)
+			# Instance variables  
+			@username = username  
+			@password = password  
+			@cloud_url = cloud_url
+			@logger = logger
+
+			if @logger.nil?
+				@logger = Logger.new(STDOUT)
+				@logger.info("Logger is not defined => output to STDOUT")
+			end
+		end 
+		def label_groups
+			 label_groups = TestdroidAPI::LabelGroups.new( "/#{API_VERSION}/label-groups", self )
+			 label_groups.list
+			 label_groups
+		end
+		def devices
+			 devices = TestdroidAPI::Devices.new( "/#{API_VERSION}/devices", self )
+			 devices.list
+			 devices
+		end  
+		def authorize
+
+			@client = OAuth2::Client.new('testdroid-cloud-api', nil, :site => @cloud_url, :authorize_url    => 'oauth/authorize',
+                  :token_url        => 'oauth/token',  :headers => ACCEPT_HEADERS)  do |faraday|
+  				faraday.request  :multipart
+  				faraday.request  :url_encoded
+  				faraday.response :logger, @logger
+  				faraday.adapter  Faraday.default_adapter
+  			end
+		
+			@token = @client.password.get_token(@username, @password, :headers => ACCEPT_HEADERS)
+			
+			if (@cloud_user.nil?)
+					@cloud_user = TestdroidAPI::User.new( "/#{API_VERSION}/me", self ).refresh
+					@cloud_user = TestdroidAPI::User.new( "/#{API_VERSION}/users/#{@cloud_user.id}", self ).refresh
+
+				end
+			@cloud_user
+		end
+		def upload(uri, filename, file_type) 
+				begin 
+
+					connection = @token.client.connection
+					payload = {:file  => Faraday::UploadIO.new(filename, file_type) }
+					headers = ACCEPT_HEADERS.merge(@token.headers)
+					response = connection.post(@cloud_url+"#{uri}",payload, headers)
+				 rescue => e
+				  	@logger.error e
+				  	return nil
+				end
+				JSON.parse(response.body)
+		end
+		def post(uri, params) 
+		
+			@token = @client.password.get_token(@username, @password) if  @token.expired?
+
+			begin
+				resp = @token.post("#{@cloud_url}#{uri}", params.merge(:headers => ACCEPT_HEADERS))
+			rescue => e
+				@logger.error "Failed to post resource #{uri} #{e}"
+				return nil
+			end
+			 JSON.parse(resp.body)
+		end		  
+		def get(uri, params={})  
+				
+				@logger.error "token expired" if @token.expired?
+				
+				@token = @client.password.get_token(@username, @password) if  @token.expired?
+				
+				begin 
+					resp = @token.get(@cloud_url+"#{uri}", params.merge(:headers => ACCEPT_HEADERS))
+				rescue => e
+					@logger.error "Failed to get resource #{uri} #{e}"
+					return nil
+				end
+				 JSON.parse(resp.body)
+		end
+		def delete(uri) 
+				
+				@logger.error "token expired" if @token.expired?
+				
+				@token = @client.password.get_token(@username, @password) if  @token.expired?
+				
+				begin 
+					resp = @token.delete(@cloud_url+"#{uri}",  :headers => ACCEPT_HEADERS )
+				rescue => e
+					@logger.error "Failed to delete resource #{uri} #{e}"
+					return nil
+				end
+
+				if (resp.status != 204)
+					@logger.error "Failed to delete resource #{uri} #{e}"
+					return nil
+				else
+					@logger.info "response: #{resp.status}"
+				end
+		end
+		def download(uri, file_name)
+			begin 
+				File.open(file_name, "w+b") do |file|
+					resp = @token.get("#{@cloud_url}/#{uri}", :headers => ACCEPT_HEADERS)
+					file.write(resp.body)
+				end
+			rescue => e
+				@logger.error "Failed to get resource #{uri} #{e}"
+				return nil
+			end
+		end		  
+	end
+end  

data/lib/testdroid_api/cloud_list_resource.rb

@@ -0,0 +1,83 @@
+
+module TestdroidAPI
+		class CloudListResource
+		
+			def initialize(uri, client)
+				@uri, @client = uri, client
+				resource_name = self.class.name.split('::')[-1]
+				@instance_class = TestdroidAPI.const_get resource_name.chop
+				@list_key, @instance_id_key = resource_name.gsub!(/\b\w/) { $&.downcase } , 'id'
+			end
+			def get(resource_id)
+				@instance_class.new( "#{@uri}/#{resource_id}", @client)
+			end
+			def total
+        		
+        		@client.get(@uri)['total']
+      		end
+      		def create(params={})
+        		raise "Can't create a resource without a REST Client" unless @client
+		        response = @client.post @uri, params
+		        @instance_class.new "#{@uri}/#{response[@instance_id_key]}", @client,
+          		response
+      		end
+      		def list_all()
+      			raise "Can't get a resource list without a REST Client" unless @client
+		
+				response = @client.get("#{@uri}?limit=355043550", {})
+				
+				if response['data'].is_a?(Array) 
+					client = @client
+					class_list = []
+					list_class = self.class
+					instance_uri =  @uri
+					response['data'].each do |val|
+						
+						class_list << @instance_class.new( "#{instance_uri}/#{val[@instance_id_key]}", @client, val)
+					end
+				end
+				class_list	
+      		end
+			def list(params={}, full_uri=false)
+				raise "Can't get a resource list without a REST Client" unless @client
+				@uri = full_uri ? @uri.split(@client.instance_variable_get(:@cloud_url))[1] : @uri
+
+				response = @client.get(@uri, params)
+				
+				if response['data'].is_a?(Array) 
+					client = @client
+					class_list = []
+					list_class = self.class
+					instance_uri = full_uri ? @uri.split('?')[0] : @uri
+					response['data'].each do |val|
+						
+						class_list << @instance_class.new( "#{instance_uri}/#{val[@instance_id_key]}", @client, val)
+					end
+					class_list.instance_eval do
+						eigenclass = class << self; self; end
+						
+						eigenclass.send :define_method, :offset, &lambda {response['offset']}
+						eigenclass.send :define_method, :limit, &lambda {response['limit']}
+						eigenclass.send :define_method, :total, &lambda {response['total']}
+	          			eigenclass.send :define_method, :next_page, &lambda {
+		            			if response['next']
+		            				
+			              			list_class.new(response['next'], client).list({}, true)
+			            		else
+			              			[]
+		            			end
+		          		}
+	          			eigenclass.send :define_method, :previous_page, &lambda {
+	            			if response['previous']
+	            				
+	              				list_class.new(response['previous'], client).list({}, true)
+	            			else
+	              				[]
+	            			end
+	          			}
+	          		end
+				end
+				class_list
+			end
+	end
+end

data/lib/testdroid_api/cloud_resource.rb

@@ -0,0 +1,72 @@
+
+module TestdroidAPI
+		class CloudResource
+			def initialize(uri, client,  resource_name=nil, params= {})
+			
+			 @uri, @client, @resource_name = uri, client, resource_name
+			 set_up_properties_from( params )
+			end
+			def inspect # :nodoc:
+				"<#{self.class} @uri=#{@uri}>"
+			end 
+			def sub_items(*items)
+				items.each do |item|
+				  resource = camel_case_it item
+				  uri = "#{@uri}/#{item.to_s.gsub('_', '-') }"
+				  	resource_class = TestdroidAPI.const_get resource
+				  new_class = resource_class.new(uri, @client)
+				  instance_variable_set( "@#{item}", new_class )
+				end
+				self.class.instance_eval {attr_reader *items}
+			end
+			def method_missing(method, *args)
+				super if @updated
+				set_up_properties_from(@client.get(@uri))
+				self.send method, *args
+			end
+			def set_up_properties_from(hash)
+
+				eigenclass = class << self; self; end
+				hash.each do |p,v|
+				  property = snake_case_it p
+				  
+				  unless ['uri', 'client', 'updated'].include? property
+					eigenclass.send :define_method, property.to_sym, &lambda {v}
+				  end
+				end
+				@updated = !hash.keys.empty?
+			  end
+			
+			def refresh
+				raise "Can't refresh a resource without a REST Client" unless @client
+				@updated = false
+				set_up_properties_from(@client.get(@uri))
+				self
+			end
+			def download_file(file_resource_name, target_file_name=nil) 
+				raise "Can't refresh a resource without a REST Client" unless @client
+				target_file_name = file_resource_name unless target_file_name
+				@client.download("#{@uri}/#{file_resource_name}", target_file_name)
+			end
+			 def camel_case_it(something)
+				if something.is_a? Hash
+				  Hash[*something.to_a.map {|a| [camel_case_it(a[0]).to_sym, a[1]]}.flatten]
+				else
+				  something.to_s.split('_').map do |s|
+					[s[0,1].capitalize, s[1..-1]].join
+				  end.join
+				end
+			  end
+			 def snake_case_it(something)
+				if something.is_a? Hash
+					Hash[*something.to_a.map {|pair| [snake_case_it(pair[0]).to_sym, pair[1]]}.flatten]
+				else
+					something.to_s.gsub(/[A-Z][a-z]*/) {|s| "_#{s.downcase}"}.gsub(/^_/, '')
+				end
+			end
+			def delete
+				raise "Can't delete a resource without a REST Client" unless @client
+				client.delete(@uri)	
+			end
+		end
+end

data/lib/testdroid_api/device_groups.rb

@@ -0,0 +1,12 @@
+
+module TestdroidAPI
+		class DeviceGroups < CloudListResource
+		end
+		class DeviceGroup < CloudResource
+			def	initialize(uri, client, params= {})
+				super uri, client,"deviceGroup", params
+				@uri, @client = uri, client
+			end
+      
+		end
+end

data/lib/testdroid_api/device_runs.rb

@@ -0,0 +1,20 @@
+
+module TestdroidAPI
+		class DeviceRuns < CloudListResource
+		end
+		class DeviceRun < CloudResource
+			def	initialize(uri, client, params= {})
+				super uri, client,"deviceRun", params
+				@uri, @client = uri, client
+			end
+      def download_performance(file_name="performance_data.txt")
+        @client.download("#{@uri}/performance", file_name)
+      end
+      def download_junit(file_name="junit.xml")
+        @client.download("#{@uri}/junit.xml", file_name)
+      end
+      def download_logs(file_name="log.txt")
+        @client.download("#{@uri}/logs", file_name)
+      end
+		end
+end