testdroid-api-client 0.2.3 → 0.3.0

data/lib/testdroid_api/client.rb

@@ -1,126 +1,169 @@
 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
-				@token = @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 = @token.refresh!(:headers => ACCEPT_HEADERS) 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
-			
-			if resp.body.nil? || resp.body.length == 0
-				return nil
-			end
-			
-			JSON.parse(resp.body)
-		end
-		def get(uri, params={})
-
-			@token = @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)
-
-			@token = @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
-				@token = @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)
-				end
-			rescue => e
-				@logger.error "Failed to get resource #{uri} #{e}"
-				return nil
-			end
-		end
-	end
+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 mime_for(path)
+        mime = MIME::Types.type_for path
+        mime.empty? ? 'text/plain' : mime[0].content_type
+    end
+
+    def upload(uri, filename)
+      begin
+        @token = @token.refresh!(:headers => ACCEPT_HEADERS) if @token.expired?
+        connection = @token.client.connection
+        payload = {:file  => Faraday::UploadIO.new(filename, mime_for(filename)) }
+        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 = @token.refresh!(:headers => ACCEPT_HEADERS) 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
+      
+      if resp.body.nil? || resp.body.length == 0
+        return nil
+      end
+      
+      JSON.parse(resp.body)
+    end
+    def get(uri, params={})
+
+      @token = @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)
+
+      @token = @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
+        @token = @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)
+        end
+      rescue => e
+        @logger.error "Failed to get resource #{uri} #{e}"
+        return nil
+      end
+    end
+
+# Resources
+
+    # public read-only
+
+    def info
+      TestdroidAPI::CloudResource.new("/#{API_VERSION}/info", self, "info")
+    end
+
+    def devices
+      TestdroidAPI::Devices.new("/#{API_VERSION}/devices", self)
+    end
+
+    def label_groups
+      TestdroidAPI::LabelGroups.new("/#{API_VERSION}/label-groups", self)
+    end
+
+    # user read-write
+
+    def me
+      TestdroidAPI::User.new("/#{API_VERSION}/me", self).load
+    end
+
+    def properties
+      TestdroidAPI::Properties.new("/#{API_VERSION}/properties", self)
+    end
+
+    def device_session_connections
+      TestdroidAPI::DeviceSessionConnections.new("/#{API_VERSION}/device-session-connections", self)
+    end
+
+    # admin only
+
+    def admin
+      TestdroidAPI::Admin.new("/#{API_VERSION}/admin", self)
+    end
+
+  end
 end

data/lib/testdroid_api/cloud_list_resource.rb

@@ -1,83 +1,86 @@
-
 module TestdroidAPI
-	class CloudListResource
+  class CloudListResource
+
+    def initialize(uri, client, instance_class=nil)
+      @uri, @client = uri, client
+      resource_name = self.class.name.split('::')[-1]
+      @instance_class = TestdroidAPI.const_get( instance_class.nil? ? resource_name.chop : instance_class )
+      @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 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
+    def create(params={}, http_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
 
-			@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
+    def list_all()
+      raise "Can't get a resource list without a REST Client" unless @client
 
-			response = @client.get("#{@uri}?limit=355043550", {})
+      response = @client.get(@uri, {:limit => 0})
 
-			if response['data'].is_a?(Array)
-				client = @client
-				class_list = []
-				list_class = self.class
-				instance_uri =  @uri
-				response['data'].each do |val|
+      if response['data'].is_a?(Array)
+        class_list = []
+        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
 
-					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
+    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)
+      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|
+      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
+          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']
+          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['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
+              list_class.new(response['previous'], client).list({}, true)
+            else
+              []
+            end
+          }
+        end
+      end
+      class_list
+    end
+  end
 end

data/lib/testdroid_api/cloud_resource.rb

@@ -1,77 +1,89 @@
-
 module TestdroidAPI
-	class CloudResource
-		def initialize(uri, client,  resource_name=nil, params= {})
+  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 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
+
+        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
+
+    alias_method :load, :refresh
 
-			@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 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)
+    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
 
-			eigenclass = class << self; self; end
-			hash.each do |p,v|
-				property = snake_case_it p
+    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
 
-				unless ['uri', 'client', 'updated'].include? property
-					eigenclass.send :define_method, property.to_sym, &lambda {v}
-				end
-			end
-			@updated = !hash.keys.empty?
-		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 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
+    def delete
+      raise "Can't delete a resource without a REST Client" unless @client
+      @client.delete(@uri)
+    end
+  end
 end