testdroid-api 1.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.3"
+script: bundle exec rspec spec

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in testdroid-api.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,19 @@
+Copyright © 2013 SoundCloud Ltd., Slawomir Smiechura
+
+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,130 @@
+# Testdroid-api
+
+The testdroid-api gem is a client for the [Testdroid Cloud API](http://docs.testdroid.com/_pages/client.html).
+
+## Installing
+
+In your application's Gemfile, add `gem 'testdroid-api'`. Then, execute the following command:
+
+    $ bundle
+
+Alternatively, you can install it yourself:
+
+    $ gem install testdroid-api
+
+## Using
+
+The testdroid-api gem allows you to create, manage, and delete projects on testdroid Cloud.
+For each project, you can trigger a test run. You can get collective or device-specific test results.
+
+### Authentication
+```ruby
+require 'testdroid-api'
+
+client = TestdroidApi::Client.new('user_email', 'password')
+client.authenticate!
+=> "api_token"
+```
+
+### TestDroid projects
+```ruby
+project = client.projects.first
+
+# create new project
+client.create_project('Name', 'Description')
+=> <TestdroidApi::Client::Project @name=Name, @description=Description>
+
+# list all projects
+client.projects
+=> [
+    <TestdroidApi::Client::Project>,
+    <TestdroidApi::Client::Project>
+   ]
+
+# find projects by name
+client.projects('Name')
+=> [ <TestdroidApi::Client::Project, @name=Name> ]
+
+# delete project
+project.delete!
+
+# upload application
+project.upload_app_file(absolute_path_to_application)
+
+# upload instrumentation
+project.upload_test_file(absolute_path_to_tests)
+```
+
+### TestDroid test runs
+```ruby
+project = client.projects.first
+run     = project.test_runs.first
+
+# list all test runs
+project.test_runs
+=> [
+    <TestdroidApi::Client::Project::TestRun> ,
+    <TestdroidApi::Client::Project::TestRun>
+   ]
+
+# create new test run
+project.create_test_run
+=> <TestdroidApi::Client::Project::TestRun>
+
+# update test run state
+run.update!
+=> <TestdroidApi::Client::Project::TestRun>
+
+# get test run's results as junit xml (zip)
+File.open(path_to_file, 'w') { |file| file.write(run.junit_results_zip) }
+
+# get test run's screenshots (zip)
+File.open(path_to_file, 'w') { |file| file.write(run.screenshots_zip) }
+
+# get test run's logs (zip)
+File.open(path_to_file, 'w') { |file| file.write(run.logs_zip) }
+
+# get test run results
+run.results
+=> NotImplemented
+```
+
+### TestDroid device runs
+```ruby
+project    = client.projects.first
+run   	   = project.test_runs.first
+device_run = run.device_runs.first
+
+# get device runs
+run.device_runs
+=> [
+    <TestdroidApi::Client::Project::TestRun::DeviceRun>,
+    <TestdroidApi::Client::Project::TestRun::DeviceRun>
+   ]
+
+# get device's results as junit xml
+File.open(path_to_file, 'w') { |file| file.write(device_run.junit_results) }
+
+# get device's logs
+device_run.logs
+
+# list device's screenshots
+device_run.screenshots
+=> [ { "id": 108144 }, { "id": 108145 } ]
+
+# get a specific screenshot
+File.open(path_to_file, 'w') { |file| file.write(device_run.screenshot(108144)) }
+
+# get device run results
+device_run.results
+=> NotImplemented
+```
+
+## Contributing
+
+1. Fork it.
+2. Create a feature branch (`git checkout -b <my-feature-branch>`).
+3. Commit your changes (`git commit -am 'Add new feature'`).
+4. Run tests (`rspec`).
+5. Push your changes to the feature branch (`git push origin <my-feature-branch>`).
+6. Create a new pull request.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/testdroid-api.rb

@@ -0,0 +1,8 @@
+require 'json'
+require 'rest-client'
+require 'testdroid-api/version'
+require 'testdroid-api/client'
+require 'testdroid-api/client/device_group'
+require 'testdroid-api/client/project'
+require 'testdroid-api/client/project/test_run'
+require 'testdroid-api/client/project/test_run/device_run'

data/lib/testdroid-api/client.rb

@@ -0,0 +1,127 @@
+module TestdroidApi
+  class Client
+    USERS_URL = "http://users.testdroid.com/api/v1/authorize"
+    CLOUD_URL = "https://cloud.testdroid.com"
+
+    # Initialize a Client object with TestDroid credentials
+    #
+    # @param username [String] Username
+    # @param password [String] Password
+    def initialize(username, password)
+      @username = username
+      @password = password
+      @api_key  = ""
+    end
+
+    # Authenticate client and retrieve apiKey
+    # @return [String] token
+    def authenticate!
+      response = post(USERS_URL, { "email" => @username, "password" => @password})
+      raise 'Could not authenticate, are you sure you have the right credentials?' if !response['secretApiKey']
+
+      @api_key = response['secretApiKey']
+    end
+
+    # List all projects
+    # @param name [String] project name to match
+    # @return [Array<TestdroidApi::Client::Project>]
+    def projects(name = nil)
+      configs = get_api_request('projects')
+
+      name ? find_projects_by(name, configs) : create_projects_from(configs)
+    end
+
+    # Create new project
+    # @param name [String] name of the project
+    # @param description [String] project's description
+    # @return [TestdroidApi::Client::Project]
+    def create_project(name, description)
+      config  = post_api_request('projects', { :name => name, :description => description })
+
+      Project.new(self, config)
+    end
+
+    # Get user’s clusters
+    # @param name [String] if given only matching device clusters will be returned
+    # @return [Array<TestdroidApi::Client::DeviceGroup>]
+    def device_groups(name = nil)
+      devices = get_api_request('clusters')
+
+      name ? find_device_groups_by(name, devices) : create_device_groups_from(devices)
+    end
+
+    # @api private
+    def post_api_request(endpoint, params = nil, resource_name = endpoint, extra_headers = {})
+      check_api_key
+      post(get_endpoint(endpoint), params, get_auth_header(resource_name).merge(extra_headers))
+    end
+
+    # @api private
+    def get_api_request(endpoint, resource_name = endpoint)
+      check_api_key
+      get(get_endpoint(endpoint), get_auth_header(resource_name) )
+    end
+
+    # @api private
+    def get_file(endpoint, resource_name = endpoint)
+      check_api_key
+      RestClient.get(get_endpoint(endpoint), get_auth_header(resource_name))
+    end
+
+
+    private
+      def post(url, params, headers = nil)
+          JSON.parse(RestClient.post(url, params, headers))
+        end
+
+      def get(url, params=nil)
+        JSON.parse(RestClient.get(url, params))
+      end
+
+      def get_auth_header(resourceName)
+          nonce = get_nonce
+          digestdata = @api_key + ":" + nonce + ":" + resourceName
+          digest = Digest::SHA256.hexdigest(digestdata)
+          {'X-Testdroid-Authentication' => @username + " " + nonce + " " + digest}
+      end
+
+      def get_nonce
+          chars = 'abcdefghjkmnpqrstuvwxyzABCDEFGHJKLMNPQRSTUVWXYZ23456789'
+          password = ''
+          6.times do password << chars[rand(chars.size)] end
+          password
+      end
+
+      def create_projects_from(configs)
+        configs.map{|project_config|
+          Project.new(self, project_config)
+        }
+      end
+
+      def find_projects_by(name, configs)
+        create_projects_from(configs).delete_if{|project|
+          project.name != name
+        }
+      end
+
+      def find_device_groups_by(name, devices)
+        create_device_groups_from(devices).delete_if{|group|
+          group.display_name != name
+        }
+      end
+
+      def create_device_groups_from(devices)
+        devices.map{|group|
+          DeviceGroup.new(self, group)
+        }
+      end
+
+      def check_api_key
+        raise("Are you sure you've authenticated?") if @api_key.empty?
+      end
+
+      def get_endpoint(name)
+        "#{CLOUD_URL}/api/v1/#{name}"
+      end
+  end
+end

data/lib/testdroid-api/client/device_group.rb

@@ -0,0 +1,18 @@
+module TestdroidApi
+  class Client
+    class DeviceGroup
+
+      attr_reader :id, :name, :display_name, :count, :price, :coverage
+      def initialize(client, config)
+        @client       = client
+        @id           = config['id']
+        @name         = config['name']
+        @display_name = config['displayName']
+        @count        = config['deviceCount']
+        @price        = config['creditsPrice']
+        @coverage     = config['coverage']
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,107 @@
+module TestdroidApi
+  class Client
+    class Project
+
+      attr_reader :id, :name, :description, :app_file, :test_file
+      def initialize(client, config)
+        @client      = client
+        @id          = config['id']
+        @name        = config['name']
+        @description = config['description']
+
+        #TODO: Add uploadTimeslate
+        @app_file    = config['appFile'] && config['appFile']['originalName']
+
+        #TODO: Add uploadTime
+        @test_file   = config['testFile'] && config['testFile']['originalName']
+      end
+
+      # Upload application binary
+      # @param path path to application file
+      def upload_app_file(path)
+        endpoint = "projects/#{id}/apks/application"
+
+        file     = File.new(path)
+        digest   = mh5digest(file)
+        params   = { :file => file, :multipart => true }
+
+        res_name = "upload#{id}application#{digest}"
+        extra_headers = {'X-Testdroid-MD5' => digest}
+
+        @client.post_api_request(endpoint, params, res_name, extra_headers )
+      end
+
+      # Upload test binary
+      # @param path path to test file
+      def upload_test_file(path)
+        endpoint = "projects/#{id}/apks/instrumentation"
+
+        file     = File.new(path)
+        digest   = mh5digest(file)
+        params   = { :file => file, :multipart => true }
+
+        res_name = "upload#{id}instrumentation#{digest}"
+        extra_headers = {'X-Testdroid-MD5' => digest}
+
+        @client.post_api_request(endpoint, params, res_name, extra_headers )
+      end
+
+      # Delete project
+      def delete!
+        res_name = "project/#{id}"
+        endpoint = "projects/#{id}/delete"
+
+        @client.post_api_request(endpoint, nil, res_name)
+      end
+
+      # Start new test run
+      # @return [TestdroidApi::Client::Project::TestRun]
+      #
+      # @param device_group [TestdroidApi::Client::DeviceGroup] devices to be tested
+      # @param instatest    [Boolean]                           run project in instatest mode
+      # @param screenshots  [Boolean]                           take screenshots automatically
+      def create_test_run(device_group = 'all devices', instatest = false, screenshots = false)
+        res_name = "project/run/#{id}"
+        endpoint = "projects/#{id}/run"
+        params   = {
+          :instatestMode   => instatest,
+          :autoScreenshots => screenshots,
+          :usedClusterId   => get_group_id(device_group)
+        }
+        test_run = @client.post_api_request(endpoint, params, res_name)
+
+        TestdroidApi::Client::Project::TestRun.new(@client, self, test_run)
+      end
+
+      # Returns project runs from project
+      # @return [Array<Project>]
+      def test_runs
+        res_name = "runs"
+        endpoint = "projects/#{id}/runs"
+
+        configs = @client.get_api_request(endpoint, res_name)
+
+        configs.map{|config|
+          TestdroidApi::Client::Project::TestRun.new(@client, self, config)
+        }
+      end
+
+      def config
+        raise NotImplementedError
+      end
+
+      def update_config(new_config)
+        raise NotImplementedError
+      end
+      private
+        def mh5digest(file)
+          Digest::MD5.hexdigest(file.read)
+        end
+
+      def get_group_id(object)
+        (object.respond_to? :id) ? object.id : object
+      end
+
+    end
+  end
+end