testdroid-api-client 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d5c7a42a956383ae541715024734d6b399371345
-  data.tar.gz: ea7415755cc3ac14aef3974529b65978a0a8cd2f
+SHA256:
+  metadata.gz: 59a3631deeb2d0ef505009b5987c7e5af5b0c8d2f7056c1fde16e24bbccae782
+  data.tar.gz: 02b39bb056e015a3ff4bbec687ffaa12ed3f1e9f8b5340754b54c80c2b54cb56
 SHA512:
-  metadata.gz: b9bd34e6151d413790e579c28223c5de4529c0c734cbf2908bb5b205576bcbaf202ce15416fb4ffeb9039f7ed99b06a0d521fe920dbf4b0203db5cd99d2749f9
-  data.tar.gz: b0b7417c78b9676670be5cb3c5193a4b994bc134f826c44161f0688a7ce39febad8bf2b9ab201fdbd340e4a128648ff6680be76439408e453c6e845d39e3f735
+  metadata.gz: 5bc54840d45cd25008a0621119bf2f9fb567358ffb3b4a15811c341c526e133a126f09a54299c644672da94250830cff90de141306079d1b4eb092f21dc5a195
+  data.tar.gz: d5a7af777b03581c96b5b24626b912e2d6a89241000d0a5a1a2bef4b46e1efe031796b6f0b01da33243e5f7b54c5329f5cdde2529735386efd5e755528cd1c11

data/.gitignore

@@ -11,8 +11,8 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-sample/*.apk
-sample/test.rb
+
+sample/results
 
 # YARD artifacts
 .yardoc

data/.travis.yml

@@ -0,0 +1,8 @@
+deploy:
+  provider: rubygems
+  api_key:
+    secure: ZFKOZzwgB1s4/vD9BDb7lFWCO7xXP3ikG2DBZSdASii5iHM46X9ox2wt8h2XZd9RFKe9pyenJP9RsXmRVGanFgZ0wGu+oveWfA7oIKp6Eb6pNOBPs8MG0ZifAGUc7Ih1JUMuvNuOPRJ+QGc5FwPsu0EoxZn3gQCZNqdMNBRe17o=
+  on:
+    tags: true
+  gem: testdroid-api-client
+script: bundle exec rspec

data/Gemfile.lock

@@ -1,47 +1,49 @@
 PATH
   remote: .
   specs:
-    testdroid-api-client (0.3.0)
-      deep_merge (~> 1.1, >= 1.1.1)
-      faraday (~> 0.8.8, >= 0.8.8)
-      oauth2 (~> 0.9)
-      rest-client (~> 2.0, >= 2.0.0)
+    testdroid-api-client (0.4.0)
+      deep_merge (~> 1.2)
+      faraday (~> 0.17, >= 0.17)
+      oauth2 (~> 1.4)
+      rest-client (~> 2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.0)
-      public_suffix (~> 2.0, >= 2.0.2)
-    bump (0.5.3)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    bump (0.8.0)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    deep_merge (1.1.1)
+    deep_merge (1.2.1)
     diff-lcs (1.2.5)
-    domain_name (0.5.20161021)
+    domain_name (0.5.20190701)
       unf (>= 0.0.5, < 1.0.0)
-    faraday (0.8.11)
-      multipart-post (~> 1.2.0)
-    hashdiff (0.3.0)
+    faraday (0.17.0)
+      multipart-post (>= 1.2, < 3)
+    hashdiff (1.0.0)
+    http-accept (1.7.0)
     http-cookie (1.0.3)
       domain_name (~> 0.5)
-    jwt (1.5.6)
-    mime-types (3.1)
+    jwt (2.2.1)
+    mime-types (3.3)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2016.0521)
-    multi_json (1.12.1)
-    multi_xml (0.5.5)
-    multipart-post (1.2.0)
+    mime-types-data (3.2019.1009)
+    multi_json (1.14.1)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
     netrc (0.11.0)
-    oauth2 (0.9.4)
-      faraday (>= 0.8, < 0.10)
-      jwt (~> 1.0)
+    oauth2 (1.4.2)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
       multi_json (~> 1.3)
       multi_xml (~> 0.5)
-      rack (~> 1.2)
-    public_suffix (2.0.4)
-    rack (1.6.5)
+      rack (>= 1.2, < 3)
+    public_suffix (4.0.1)
+    rack (2.0.7)
     rake (11.3.0)
-    rest-client (2.0.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
       http-cookie (>= 1.0.2, < 2.0)
       mime-types (>= 1.16, < 4.0)
       netrc (~> 0.8)
@@ -60,29 +62,29 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    safe_yaml (1.0.4)
+    safe_yaml (1.0.5)
     unf (0.1.4)
       unf_ext
-    unf_ext (0.0.7.2)
-    vcr (2.9.3)
-    webmock (1.24.6)
+    unf_ext (0.0.7.6)
+    vcr (5.0.0)
+    webmock (3.7.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
-      hashdiff
-    yard (0.9.5)
+      hashdiff (>= 0.4.0, < 2.0.0)
+    yard (0.9.20)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bump (~> 0.5)
+  bump (~> 0.8)
   rake
   rspec
   rspec-collection_matchers
   testdroid-api-client!
-  vcr (~> 2.9)
-  webmock (~> 1.9)
-  yard (~> 0.8)
+  vcr (~> 5.0)
+  webmock (~> 3.7)
+  yard (~> 0.9.20)
 
 BUNDLED WITH
-   1.11.2
+   1.17.3

data/README.md

@@ -1,6 +1,5 @@
 Testdroid API Client for Ruby
-=========================
-
+=============================
 
 ## Installation
 
@@ -12,17 +11,20 @@ gem "testdroid-api-client"
 ```bash
 > bundle install
 ```
+
 ## Sample client usage - Authenticate
 ```ruby
 require 'testdroid-api-client'
 
 client = TestdroidAPI::Client.new('admin@localhost', 'admin')
 ```
+
 ## Sample usage - get projects
 ```ruby
  @user = client.authorize
  projects = @user.projects.list
 ```
+
 ## Get project by id
 ```ruby
 project_id = 123
@@ -33,61 +35,44 @@ p "Project name #{project123.name}"
 
 ## Get project by name
 ```ruby
-android_project = @user.projects.list.detect {|project| project.name.casecmp("Android Project") == 0 }
+project = @user.projects.list({:filter => "s_name_eq_MyProject"})[0]
 ```
 
-
-## Start project
+## Get available frameworks
 ```ruby
-test_run = project123.run
+frameworks = @user.available_frameworks.list
 ```
 
-## Check test run status
-```ruby
-p "Project state #{test_run.state}"
-
-```
-## Download all logs from test run
+## Find specific framework
 ```ruby
-test_run.device_runs.list({:params => {:limit => 100}}).each { |drun| drun.download_logs("#{drun.id}_log") }
+framework = @user.available_frameworks.list({:filter => "s_osType_eq_ANDROID;s_name_like_%Instrumentation"})[0]
 ```
 
-## Using device labels
+## Upload files
 ```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 }
-
-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"}
-       
+file_app = @user.files.upload(File.join(File.dirname(__FILE__), "BitbarSampleApp.apk"))
+file_test = @user.files.upload(File.join(File.dirname(__FILE__), "BitbarSampleAppTest.apk"))
 ```
 
-
-Device Sessions
-----
+## Start test run
 ```ruby
-#create a new device session: 
-device_session = @user.device_sessions.create({:params =>  {'deviceModelId' => '1'}})
-
-#release device session: 
-device_session.release()
+test_run = @user.runs.create("{\"osType\": \"ANDROID\", \"projectId\": #{project.id}, \"frameworkId\":#{framework_id},
+  \"deviceIds\": #{id_list}, \"files\": [{\"id\": #{file_app.id}, \"action\": \"INSTALL\" },
+  {\"id\": #{file_test.id}, \"action\": \"RUN_TEST\" }]}")
 
+#See full list of params: https://docs.bitbar.com/testing/api/tests/index.html#details-about-the-configuration-fields
 ```
 
-
-Project configuration
-----
+## Download all files from test run
 ```ruby
-#get project and update project configuration
-android_project = @user.projects.list.detect {|project| project.name.casecmp("Android Project") == 0 }
-android_project.config.update({:params => {'instrumentationRunner' => 'abc'}})
-#See full list of params: http://docs.testdroid.com/_pages/client.html#update-project-config
-
+test_run.device_sessions.list({:limit => 0}).each { |ds| ds.download_all_files("YOUR_PATH") }
 ```
 
+## Get all input files
+```ruby
+files = @user.files
+files.list({:limit => 40,:filter => "s_direction_eq_INPUT"}).each { 
+    |f| puts "File id: #{f.id} name: #{f.name}" }
+```
 
-See https://cloud.testdroid.com/swagger/index.html for more details about API V2
+See https://cloud.bitbar.com/cloud/swagger-ui.html for more details about API V2

data/lib/testdroid-api-client.rb

@@ -12,19 +12,16 @@ require 'testdroid_api/cloud_resource'
 require 'testdroid_api/cloud_list_resource'
 
 require 'testdroid_api/user'
+require 'testdroid_api/frameworks'
 require 'testdroid_api/projects'
 require 'testdroid_api/runs'
 require 'testdroid_api/devices'
 require 'testdroid_api/device_groups'
-require 'testdroid_api/device_runs'
 require 'testdroid_api/device_sessions'
 require 'testdroid_api/device_session_connections'
 require 'testdroid_api/labels'
 require 'testdroid_api/label_groups'
 require 'testdroid_api/files'
-require 'testdroid_api/file_sets'
-require 'testdroid_api/config'
-require 'testdroid_api/parameters'
 require 'testdroid_api/properties'
 require 'testdroid_api/services'
 

data/lib/testdroid-api-filter-builder.rb

@@ -49,7 +49,7 @@ module TestdroidAPI
         end
       end
 
-      # check nil existance
+      # check nil existence
       if check_nil
         is_nil = false
         value.each do |val|

data/lib/testdroid_api/admin.rb

@@ -1,24 +1,24 @@
 module TestdroidAPI
   class Admin < CloudResource
-    def initialize(uri, client, params= {})
+    def initialize(uri, client, params = {})
       super uri, client, "admin", params
       @uri, @client = uri, client
     end
 
     def device_statuses
-      AdminDeviceStatuses.new(@uri+"/device/statuses", @client)
+      AdminDeviceStatuses.new(@uri + "/device/statuses", @client)
     end
 
     def device_problems
-      AdminDeviceProblems.new(@uri+"/device-problems", @client)
+      AdminDeviceProblems.new(@uri + "/device-problems", @client)
     end
 
     def device_models
-      AdminDeviceModels.new(@uri+"/device-models", @client)
+      AdminDeviceModels.new(@uri + "/device-models", @client)
     end
 
     def devices
-      AdminDevices.new(@uri+"/devices", @client)
+      AdminDevices.new(@uri + "/devices", @client)
     end
 
   end

data/lib/testdroid_api/admin_device_models.rb

@@ -2,7 +2,7 @@ module TestdroidAPI
   class AdminDeviceModels < CloudListResource
   end
   class AdminDeviceModel < CloudResource
-    def initialize(uri, client, params= {})
+    def initialize(uri, client, params = {})
       super uri, client, "adminDeviceModel", params
       @uri, @client = uri, client
     end

data/lib/testdroid_api/admin_device_problems.rb

@@ -2,7 +2,7 @@ module TestdroidAPI
   class AdminDeviceProblems < CloudListResource
   end
   class AdminDeviceProblem < CloudResource
-    def initialize(uri, client, params= {})
+    def initialize(uri, client, params = {})
       super uri, client, "adminDeviceProblem", params
     end
   end

data/lib/testdroid_api/admin_device_statuses.rb

@@ -5,7 +5,7 @@ module TestdroidAPI
     end
   end
   class AdminDeviceStatus < CloudResource
-    def initialize(uri, client, params= {})
+    def initialize(uri, client, params = {})
       super uri, client, "adminDeviceStatus", params
     end
   end

data/lib/testdroid_api/admin_devices.rb

@@ -2,7 +2,7 @@ module TestdroidAPI
   class AdminDevices < CloudListResource
   end
   class AdminDevice < CloudResource
-    def initialize(uri, client, params= {})
+    def initialize(uri, client, params = {})
       super uri, client, "adminDevice", params
       @uri, @client = uri, client
     end

data/lib/testdroid_api/apikey_client.rb

@@ -5,8 +5,7 @@ module TestdroidAPI
     attr_accessor :logger
 
     API_VERSION = 'api/v2'
-    CLOUD_ENDPOINT = 'https://cloud.testdroid.com'
-    ACCEPT_HEADERS = {'Accept' => 'application/json'}
+    CLOUD_ENDPOINT = 'https://cloud.bitbar.com'
 
     def initialize(api_key, cloud_url = CLOUD_ENDPOINT, logger = nil)
       # Instance variables
@@ -21,33 +20,34 @@ module TestdroidAPI
     end
 
     def authorize
-     
-      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
+
+      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
+
     # Basic methods
 
-    def request_factory(method, uri, http_params = {})
+    def request_factory(method, uri, http_params = {}, headers = {})
       default_http_params = {
-        :method => method,
-        :url => uri,
-        :user => @api_key,
-        :password => "",
-        :headers => ACCEPT_HEADERS
+          :method => method,
+          :url => uri,
+          :user => @api_key,
+          :password => "",
+          :headers => headers
       }
       request_http_params = default_http_params.deep_merge!(http_params)
 
       RestClient::Request.new(request_http_params)
     end
 
-    def get(uri, params={}, http_params={})
-      uri = @cloud_url+uri
+    def get(uri, params = {}, http_params = {})
+      uri = @cloud_url + uri
       begin
-        http_params = http_params.deep_merge({ :headers => {:params => params} })
+        http_params = http_params.deep_merge({:headers => {:params => params}})
         request = self.request_factory(:get, uri, http_params)
         resp = request.execute
       rescue => e
@@ -57,11 +57,13 @@ module TestdroidAPI
       JSON.parse(resp.body)
     end
 
-    def post(uri, params={}, http_params={})
-      uri = @cloud_url+uri
+    def post(uri, params = {}, http_params = {})
+      uri = @cloud_url + uri
       begin
-        http_params = http_params.deep_merge({ :payload => params })
-        request = self.request_factory(:post, uri, http_params)
+        payload = params.fetch(:body, params)
+        headers = params.fetch(:headers, {})
+        http_params = http_params.deep_merge({:payload => payload})
+        request = self.request_factory(:post, uri, http_params, headers)
         resp = request.execute
       rescue => e
         @logger.error "Failed to post resource #{uri} #{e}"
@@ -76,7 +78,7 @@ module TestdroidAPI
     end
 
     def delete(uri)
-      uri = @cloud_url+uri
+      uri = @cloud_url + uri
       begin
         request = self.request_factory(:delete, uri)
         resp = request.execute
@@ -85,26 +87,26 @@ module TestdroidAPI
         return nil
       end
 
-      if (resp.status != 204)
+      if resp.code != 204
         @logger.error "Failed to delete resource #{uri} #{e}"
-        return nil
       else
-        @logger.info "response: #{resp.status}"
+        @logger.info "response: #{resp.code}"
       end
     end
 
     def upload(uri, file_name)
       self.post(uri, {
-                  :multipart => true,
-                  :file => File.new(file_name, 'rb')
+          :multipart => true,
+          :file => ::File.new(file_name, 'rb')
       })
     end
 
-    def download(uri, file_name, params={}, http_params={})
+    def download(uri, file_name, params = {}, http_params = {})
       begin
-        File.open(file_name, "w+b") do |file|
-          http_params = http_params.deep_merge({ :headers => {:params => params} })
-          request = self.request_factory(:get, @cloud_url+"#{uri}", http_params)
+        ::File.open(file_name, "w+b") do |file|
+          full_uri = uri.start_with?(@cloud_url) ? uri : @cloud_url + uri
+          http_params = http_params.deep_merge({:headers => {:params => params}})
+          request = self.request_factory(:get, full_uri, http_params)
           resp = request.execute
           file.write(resp.body)
         end
@@ -114,7 +116,5 @@ module TestdroidAPI
       end
     end
 
-
-
   end
 end