testdroid-api 1.0.1

data/lib/testdroid-api/client/project/test_run.rb

@@ -0,0 +1,79 @@
+module TestdroidApi
+  class Client
+    class Project
+      class TestRun
+
+        attr_reader :project_id, :id, :name, :state
+        def initialize(client, project, config)
+          @client     = client
+          @project_id = project.id
+
+          update(config)
+        end
+
+        # Updates test_run information
+        def update!
+          res_name = "run"
+          endpoint = "projects/#{@project_id}/runs/#{id}"
+
+          config   = @client.get_api_request(endpoint, res_name)
+
+          update(config)
+        end
+
+        def results
+          raise NotImplementedError
+        end
+
+        # Returns devices that the run was executed on.
+        # @return [Array<TestdroidApi::Client::TestRun::DeviceRun>]
+        def device_runs
+          res_name = "deviceRuns"
+          endpoint = "projects/#{@project_id}/runs/#{id}/device-runs"
+
+          results  = @client.get_api_request(endpoint, res_name)
+          results.map{|device_run|
+            TestdroidApi::Client::Project::TestRun::DeviceRun.new(@client, self, device_run)
+          }
+        end
+
+        # Get test run's screenshots as a zip file.
+        def screenshots_zip
+          res_name = 'screenshots.zip'
+          endpoint = "projects/#{@project_id}/runs/#{id}/screenshots.zip"
+
+          @client.get_file(endpoint, res_name)
+        end
+
+        # Get test run's junit results as a zip file
+        def junit_results_zip
+          res_name = 'junits.zip'
+          endpoint = "projects/#{@project_id}/runs/#{id}/junits.zip"
+
+          @client.get_file(endpoint, res_name)
+        end
+
+        # Get test run's logs as a zip file.
+        def logs_zip
+          res_name = 'logs.zip'
+          endpoint = "projects/#{@project_id}/runs/#{id}/logs.zip"
+
+          @client.get_file(endpoint, res_name)
+        end
+
+        # Did test run finish
+        # @return [Boolean]
+        def finished?
+          state == 'FINISHED'
+        end
+
+        private
+          def update(config)
+            @id    = config['id']
+            @name  = config['displayName']
+            @state = config['groupState']
+          end
+      end
+    end
+  end
+end

data/lib/testdroid-api/client/project/test_run/device_run.rb

@@ -0,0 +1,94 @@
+module TestdroidApi
+  class Client
+    class Project
+      class TestRun
+        class DeviceRun
+
+          attr_reader :id, :device_id, :fail_message, :name, :state, :finished
+          attr_reader :screenshots_url, :junit_url, :logs_url
+
+          def initialize(client, run, config)
+            @client     = client
+            @project_id = run.project_id
+            @run_id     = run.id
+
+            update(config)
+          end
+
+          # Updates device run information
+          def update!
+            res_name = 'deviceRun'
+            endpoint = "projects/#{@project_id}/runs/#{@run_id}/device-runs/#{id}"
+
+            config   = @client.get_api_request(endpoint, res_name)
+
+            update(config)
+          end
+
+          # Get device run's test results as JUnit XML
+          def junit_results
+            res_name = 'junit XML'
+            endpoint = "projects/#{@project_id}/runs/#{@run_id}/device-runs/#{id}_junit.xml"
+
+            @client.get_file(endpoint, res_name)
+          end
+
+          #Get device run's logs
+          def logs
+            res_name = 'log'
+            endpoint = "projects/#{@project_id}/runs/#{@run_id}/device-runs/#{id}_log.txt"
+
+            @client.get_file(endpoint, res_name)
+          end
+
+          # Get device run's screenshots as a zip file.
+          def screenshots_zip
+            res_name = 'screenshots.zip'
+            endpoint = "projects/#{@project_id}/runs/#{@run_id}/device-runs/#{id}/screenshots.zip"
+
+            @client.get_file(endpoint, res_name)
+          end
+
+          # Returns screenshots' ids for device run.
+          def screenshots
+            res_name = 'deviceRunScreenshots'
+            endpoint = "projects/#{@project_id}/runs/#{@run_id}/device-runs/#{id}/screenshots"
+
+            @client.get_api_request(endpoint, res_name)
+          end
+
+          # Get device's run screenshot.
+          # @param screenshot_id [Integer] screenshot id
+          def screenshot(screenshot_id)
+            res_name = 'screenshot'
+            endpoint = "projects/#{@project_id}/runs/#{@run_id}/device-runs/#{id}/screenshots/#{screenshot_id}"
+
+            @client.get_file(endpoint, res_name)
+          end
+
+          # Did test run finish
+          def finished?
+            finished
+          end
+
+          def results
+            raise NotImplementedError
+          end
+
+          private
+          def update(config)
+            @id              = config['id']
+            @device_id       = config['deviceId']
+            @fail_message    = config['customerFailureMessage']
+            @name            = config['deviceName']
+            @state           = config['groupState']
+            @finished        = config['finished']
+            @screenshots_url = config['screenshotsURI']
+            @junit_url       = config['junitURI']
+            @logs_url        = config['logURI']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/testdroid-api/version.rb

@@ -0,0 +1,3 @@
+module TestdroidApi
+  VERSION = "1.0.1"
+end

data/spec/client_spec.rb

@@ -0,0 +1,134 @@
+require 'spec_helper'
+
+describe TestdroidApi::Client do
+  let(:client_class) { described_class }
+  let(:client) {client_class.new("user", "password")}
+
+  let(:auth_url) {"http://users.testdroid.com/api/v1/authorize"}
+  before do
+    stub_request(:post, auth_url).
+      to_return(:status => 200, :body => {"secretApiKey" => "1"}.to_json, :headers => {})
+  end
+
+  describe '#authenticate' do
+    it 'sends the right request' do
+      client.authenticate!
+
+      a_request(:post, auth_url).
+        with(:body => {:email => "user", :password => "password" }).
+        should have_been_made
+    end
+
+    context 'when successful' do
+      it 'stores apiKey' do
+        client.authenticate!
+
+        client.instance_variable_get('@api_key').should == '1'
+      end
+    end
+
+    context 'when fails' do
+      it 'throws exception' do
+        stub_request(:post, "http://users.testdroid.com/api/v1/authorize").
+          to_return(:status => 200, :body => {}.to_json, :headers => {})
+
+        expect { client.authenticate! }.
+          to raise_error(RuntimeError, "Could not authenticate, are you sure you have the right credentials?")
+      end
+    end
+  end
+
+  context 'when authenticated' do
+    before do
+      client.authenticate!
+    end
+
+    describe '#projects' do
+      let(:url) {"https://cloud.testdroid.com/api/v1/projects"}
+      let(:response_body) {File.new(File.dirname(__FILE__) + "/fixtures/projects.json").read}
+
+      before do
+        stub_request(:get, url).
+          to_return(:body => JSON.parse(response_body).to_json)
+      end
+
+      it 'sends the right request' do
+        client.projects
+
+        a_request(:get, url).should have_been_made
+      end
+
+      context 'without any params' do
+        it 'should return array of projects' do
+          TestdroidApi::Client::Project.stub(:new).with(any_args).and_return(true)
+
+           client.projects.should == [true, true]
+        end
+      end
+
+      context 'with project names' do
+        it 'finds the matching projects' do
+          client.projects('Project 1').first.name.should == "Project 1"
+        end
+        it 'removes unmatched projects' do
+          client.projects('Project 1').count.should == 1
+        end
+      end
+    end
+
+    describe '#create_project' do
+      let(:url) {"https://cloud.testdroid.com/api/v1/projects"}
+      let(:response_body) {File.new(File.dirname(__FILE__) + "/fixtures/new_project.json").read}
+      before do
+        stub_request(:post, url).
+          to_return(:status => 200, :body => JSON.parse(response_body).to_json, :headers => {})
+      end
+
+      it 'sends the right request' do
+        client.create_project("Name", "Description" )
+
+        a_request(:post, url).
+          with(:body => {:name => "Name", :description => "Description"}  ).
+          should have_been_made
+      end
+
+      it 'returns new project' do
+        client.create_project(nil, nil).name.should == "New project name"
+      end
+    end
+
+    describe '#device groups' do
+      let(:url) {url = "https://cloud.testdroid.com/api/v1/clusters"}
+      let(:response_body) {File.new(File.dirname(__FILE__) + "/fixtures/devices.json").read}
+      before do
+        stub_request(:get, url).
+         to_return(:status => 200, :body => JSON.parse(response_body).to_json, :headers => {})
+      end
+
+      it 'sends the right request' do
+        client.device_groups
+
+        a_request(:get, url).
+          should have_been_made
+      end
+
+      context 'without params' do
+        it 'returns all device groups' do
+          client.device_groups("Test devices").first.display_name.should == "Test devices"
+        end
+
+        it 'removes unmatched projects' do
+          client.device_groups("Test devices").count.should == 1
+        end
+      end
+
+    end
+  end
+
+  context 'when not authenticated' do
+    it 'does not allow to fetch projects' do
+      expect{client.projects}.
+        to raise_error(RuntimeError, "Are you sure you've authenticated?")
+    end
+  end
+end

data/spec/device_run_spec.rb

@@ -0,0 +1,108 @@
+require 'spec_helper'
+
+describe TestdroidApi::Client::Project::TestRun::DeviceRun  do
+
+  let(:auth_url) { "http://users.testdroid.com/api/v1/authorize" }
+  let(:client)   { TestdroidApi::Client.new('username', 'password') }
+  let(:run)      { double(TestdroidApi::Client::Project::TestRun) }
+  let(:config)   { JSON.parse(File.new(File.dirname(__FILE__) + "/fixtures/device_run.json").read)}
+  before do
+    stub_request(:post, auth_url).
+      to_return(:status => 200, :body => {"secretApiKey" => "1"}.to_json, :headers => {})
+    client.authenticate!
+
+    run.stub(:project_id).and_return(1)
+    run.stub(:id).and_return(100)
+  end
+
+  context 'when authenticated' do
+    let(:device_run) { described_class.new(client, run, config) }
+
+    describe '#update!' do
+      let(:url) { "https://cloud.testdroid.com/api/v1/projects/1/runs/100/device-runs/1000" }
+      let(:response_body) {File.new(File.dirname(__FILE__) + "/fixtures/waiting_device_run.json").read}
+      before do
+        stub_request(:get, url).
+          to_return(:status => 200, :body => JSON.parse(response_body).to_json, :headers => {})
+      end
+
+      it 'sends the right request' do
+        device_run.update!
+
+        a_request(:get, url).
+          should have_been_made
+      end
+
+      it 'updates run state' do
+        device_run.update!
+        device_run.state.should == "WAITING"
+      end
+    end
+
+
+    describe '#finished' do
+      let(:url) { "https://cloud.testdroid.com/api/v1/projects/1/runs/100/device-runs/1000" }
+      let(:response_body) {File.new(File.dirname(__FILE__) + "/fixtures/waiting_device_run.json").read}
+      before do
+        stub_request(:get, url).
+          to_return(:status => 200, :body => JSON.parse(response_body).to_json, :headers => {})
+      end
+
+      it 'returns true when run is finished' do
+        device_run.should be_finished
+      end
+
+      it 'returns false when run it not finished' do
+        device_run.update!
+        device_run.should_not be_finished
+      end
+    end
+
+    describe '#logs_zip' do
+      let(:url) { "https://cloud.testdroid.com/api/v1/projects/1/runs/100/device-runs/1000_log.txt" }
+      let(:response_body) {File.new(File.dirname(__FILE__) + "/fixtures/logs.txt")}
+      before do
+        stub_request(:get, url).
+          to_return(:status => 200, :body => response_body, :headers => {})
+      end
+
+      it 'sends the right request' do
+        device_run.logs
+
+        a_request(:get, url).should have_been_made
+      end
+
+    end
+
+    describe '#screenshots_zip' do
+      let(:url) { "https://cloud.testdroid.com/api/v1/projects/1/runs/100/device-runs/1000/screenshots/1000" }
+
+      before do
+        stub_request(:get, url).
+          to_return(:status => 200, :body => "", :headers => {})
+      end
+
+      it 'sends the right request' do
+        device_run.screenshot(1000)
+
+        a_request(:get, url).should have_been_made
+      end
+
+    end
+
+    describe '#junit_results' do
+      let(:url) { "https://cloud.testdroid.com/api/v1/projects/1/runs/100/device-runs/1000_junit.xml" }
+      let(:response_body) {File.new(File.dirname(__FILE__) + "/fixtures/junit.xml")}
+      before do
+        stub_request(:get, url).
+          to_return(:status => 200, :body => response_body, :headers => {})
+      end
+
+      it 'sends the right request' do
+        device_run.junit_results
+
+        a_request(:get, url).should have_been_made
+      end
+    end
+  end
+end

data/spec/fixtures/apiUsers.json

@@ -0,0 +1,96 @@
+{
+  "address": "",
+  "name": "User Surname",
+  "id": 1333333,
+  "state": "",
+  "country": "DE",
+  "displayCountry": "Germany",
+  "timeZone": "GMT",
+  "username": "132254",
+  "displayname": "User user",
+  "enabled": true,
+  "active": true,
+  "code": "",
+  "email": "user@soundcloud.com",
+  "googleId": null,
+  "billing": false,
+  "organization": {
+    "name": "",
+    "id": 1
+  },
+  "countryDisplayname": "Germany",
+  "city": "",
+  "phone": "",
+  "secretApiKey": "xxxxxxxxxxxxxxxxx",
+  "Organization role": "Other",
+  "vatID": "",
+  "accessible": true,
+  "activeRoles": [
+    {
+      "name": "TEST_RUN_SCREENSHOTS",
+      "active": true,
+      "timeLimitUsed": false,
+      "useLimit": 100,
+      "useLimited": true
+    },
+    {
+      "name": "FREE_RUN",
+      "active": true,
+      "timeLimitUsed": false,
+      "useLimit": 115,
+      "useLimited": true
+    },
+    {
+      "name": "PRIORITY_GOLD",
+      "active": true,
+      "timeLimitUsed": true,
+      "useLimit": 0,
+      "useLimited": false
+    },
+    {
+      "name": "PAID_RUN",
+      "active": true,
+      "timeLimitUsed": true,
+      "useLimit": 0,
+      "useLimited": false
+    },
+    {
+      "name": "API_CLIENT",
+      "active": true,
+      "timeLimitUsed": true,
+      "useLimit": 0,
+      "useLimited": false
+    }
+  ],
+  "lastLoginTime": 1380651077429,
+  "registrationIP": null,
+  "purchasedUserServices": [
+
+  ],
+  "creditsLeft": "10000",
+  "Heard from": "Other",
+  "availableHearFromValues": [
+    "COWORKER",
+    "EMAIL_CAMPAIGN",
+    "EVENT",
+    "ONLINE_COMMUNITY",
+    "SOCIAL_NETWORK",
+    "WEB_SEARCH",
+    "OTHER"
+  ],
+  "availableOrganizationRoleValues": [
+    "CEO_OR_OWNER",
+    "VP",
+    "MANAGER",
+    "INDIVIDUAL",
+    "QUALITY_ASSURANCE",
+    "DEVELOPER",
+    "MARKETING",
+    "CONSULTANT",
+    "OTHER"
+  ],
+  "admin": false,
+  "accountNonExpired": true,
+  "accountNonLocked": true,
+  "credentialsNonExpired": true
+}