testdroid-api-client 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e0ff2bf024b09f9f3422d8a394b7b7c498c2719
-  data.tar.gz: 916e80c7b3a90104088ffc51ce9d7c364e27801b
+  metadata.gz: d02abbd4ba89be9aba2b1c88c23d148b8fc1b892
+  data.tar.gz: 60e430d6b84cfbb80301e349aa26113b43953f22
 SHA512:
-  metadata.gz: de1810b4face007df131918f1903906355f725b8089b81ac001680b948e1da04ec820f64538a357c8cc82318f71300423f88dc5f2eeab4a81d647af05543d841
-  data.tar.gz: bbeca5dbc98e184894baf73d18ff8d168f2a873273f3534cd525fda31cbedf3a1c2e2ab2080103eb231ad48cb9256c840a30d2d682c53c611d0b85a8baca84c2
+  metadata.gz: 556edc82403e13452d74aed3f0950aaa27aabb4e8a2cc5b23c469c38d297f2eea865cc22c531907a641ec02034e8bb2091528d99ff9e962de6a2dc25b943f5aa
+  data.tar.gz: 21693e39ae96d8f405858acc27034fd24ed88fdb3c547699fd2cf50302dfe08d524c55711f6025da4ba11655d92d8f246c1cc11502d4cd73dc734611d1d76b07

data/README.md

@@ -1,29 +1,53 @@
-testdroid-api-client-ruby
+Testdroid API Client for Ruby
 =========================
 
+
+## Installation
+
+```ruby
+# Gemfile
+gem "testdroid-api-client"
 ```
+
+```bash
+> bundle install
+```
+## Sample client usage - Authenticate
+```ruby
 require 'testdroid-api-client'
-#Authenticate
- client = TestdroidAPI::Client.new('admin@localhost', 'admin')
+
+client = TestdroidAPI::Client.new('admin@localhost', 'admin')
+```
+## Sample usage - get projects
+```ruby
  @user = client.authorize
-#get Projects
  projects = @user.projects.list
-
-#get project by id
+```
+## Get project by id
+```ruby
 project_id = 123
 project123 = @user.projects.get(project_id)
 #output project name
 p "Project name #{project123.name}"
+```
 
-#run project
+## Start project
+```ruby
 test_run = project123.run
+```
 
-#check test run status
+## Check test run status
+```ruby
 p "Project state #{test_run.state}"
 
-#download all logs from test run
+```
+## Download all logs from test run
+```ruby
 test_run.device_runs.list({:params => {:limit => 100}}).each { |drun| drun.download_logs("#{drun.id}_log") }
+```
 
+## Using device labels
+```ruby
 #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 }
 
@@ -34,6 +58,17 @@ os_v2_1 =  client.label_groups.get(lg_android_versions.id).labels.list.detect {|
 #get spefici device from devices list        
 lenovo_a820 = devices.list.detect {|d| d.display_name == "Lenovo A820"}
        
+       
+```
+Device Sessions
+----
+```
+To create a new device session: 
+device_session = user.device_sessions.create({:params =>  {'deviceModelId' => '1'}})
+
+To release device session: 
+device_session.release()
 
 ```
+
 See https://cloud.testdroid.com/swagger/index.html for more details about API V2

data/lib/testdroid-api-client.rb

@@ -13,7 +13,7 @@ require 'testdroid_api/labels'
 require 'testdroid_api/files'
 require 'testdroid_api/devices'
 require 'testdroid_api/device_sessions'
-
+require 'testdroid_api/file_sets'
 
 require 'oauth2'
 require 'logger'

data/lib/testdroid_api/client.rb

@@ -10,9 +10,9 @@ module TestdroidAPI
 		ACCEPT_HEADERS={'Accept' => 'application/json'}
 
 		def initialize(username, password, cloud_url = CLOUD_ENDPOINT, logger = nil)
-			# Instance variables  
-			@username = username  
-			@password = password  
+			# Instance variables
+			@username = username
+			@password = password
 			@cloud_url = cloud_url
 			@logger = logger
 
@@ -20,52 +20,52 @@ module TestdroidAPI
 				@logger = Logger.new(STDOUT)
 				@logger.info("Logger is not defined => output to STDOUT")
 			end
-		end 
+		end
 		def label_groups
-			 label_groups = TestdroidAPI::LabelGroups.new( "/#{API_VERSION}/label-groups", self )
-			 label_groups.list
-			 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  
+			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_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
+				@cloud_user = TestdroidAPI::User.new( "/#{API_VERSION}/me", self ).refresh
+				@cloud_user = TestdroidAPI::User.new( "/#{API_VERSION}/users/#{@cloud_user.id}", self ).refresh
 
-				end
+			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)
+		def upload(uri, filename, file_type)
+			begin
+				@token.refresh!(:headers => ACCEPT_HEADERS) if @token.expired?
+				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?
+		def post(uri, params)
+
+			@token.refresh!(:headers => ACCEPT_HEADERS) if  @token.expired?
 
 			begin
 				resp = @token.post("#{@cloud_url}#{uri}", params.merge(:headers => ACCEPT_HEADERS))
@@ -73,44 +73,45 @@ module TestdroidAPI
 				@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)
+			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
+		def get(uri, params={})
 
-				if (resp.status != 204)
-					@logger.error "Failed to delete resource #{uri} #{e}"
-					return nil
-				else
-					@logger.info "response: #{resp.status}"
-				end
+			@logger.error "token expired" if @token.expired?
+
+			@token.refresh!(:headers => ACCEPT_HEADERS) 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.refresh!(:headers => ACCEPT_HEADERS) 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 
+			begin
+				@token.refresh!(:headers => ACCEPT_HEADERS) if  @token.expired?
 				File.open(file_name, "w+b") do |file|
 					resp = @token.get("#{@cloud_url}/#{uri}", :headers => ACCEPT_HEADERS)
 					file.write(resp.body)
@@ -119,6 +120,6 @@ module TestdroidAPI
 				@logger.error "Failed to get resource #{uri} #{e}"
 				return nil
 			end
-		end		  
+		end
 	end
-end  
+end

data/lib/testdroid_api/cloud_list_resource.rb

@@ -1,83 +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)
+	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
-			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
+			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	
-      		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
+				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']
 
-				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
+							list_class.new(response['previous'], client).list({}, true)
+						else
+							[]
+						end
+					}
 				end
-				class_list
 			end
+			class_list
+		end
 	end
 end

data/lib/testdroid_api/cloud_resource.rb

@@ -1,72 +1,77 @@
 
 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
+	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
-			def set_up_properties_from(hash)
+			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 update(params = {})
+        	raise "Can't update a resource without a REST Client" unless @client
+        	set_up_properties_from(@client.post(@uri, params))
+        	self
+      	end
+		def set_up_properties_from(hash)
+
+			eigenclass = class << self; self; end
+			hash.each do |p,v|
+				property = snake_case_it p
 
-				eigenclass = class << self; self; end
-				hash.each do |p,v|
-				  property = snake_case_it p
-				  
-				  unless ['uri', 'client', 'updated'].include? property
+				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|
+			@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.join
 			end
-			def delete
-				raise "Can't delete a resource without a REST Client" unless @client
-				client.delete(@uri)	
+		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

@@ -1,12 +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
-      
+	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

@@ -1,20 +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
+  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

data/lib/testdroid_api/device_sessions.rb

@@ -1,15 +1,15 @@
 
 module TestdroidAPI
-		class DeviceSessions < CloudListResource
+	class DeviceSessions < CloudListResource
+	end
+	class DeviceSession < CloudResource
+		def	initialize(uri, client, params= {})
+			super uri, client,"deviceSession", params
+			@uri, @client = uri, client
 		end
-		class DeviceSession < CloudResource
-			def	initialize(uri, client, params= {})
-				super uri, client,"deviceSession", params
-				@uri, @client = uri, client
-			end
-      def release
-          resp = @client.post("#{@uri}/release", params= {})
-          DeviceSession.new("#{@uri}", @client, resp)
-      end  
+		def release
+			resp = @client.post("#{@uri}/release", params= {})
+			DeviceSession.new("#{@uri}", @client, resp)
 		end
+	end
 end