rox-client-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    Mzg1YWZlOWM0MGUyZDA2MGJlZDM2MzdmODBiZWJmM2U0OTFmZTE2Nw==
+  data.tar.gz: !binary |-
+    NjMxZDRmYmU3NGY2Yjc3M2Q1OTk5Yjk1NmJhY2U4ZGIwYzhhZmJhMA==
+SHA512:
+  metadata.gz: !binary |-
+    NGExMDQ3MmJhMTdmMDI3NzQ5NDhjMjcwNzkxNTMxNjE2ZjhhNmNlYzI4Yjdm
+    NDFmNTY0NzZmM2IyMzE5NzNmOWYzYzdjZDVkODE2OTFhNDMwNjJkMzkzMGI5
+    OTU2MTUwZDE1YjNkMDRhMThkMTVmOGVhNjMzNmI0YmEyMmRiMzM=
+  data.tar.gz: !binary |-
+    NjViNDZmM2E2Y2Y3Y2RjNGJiZDUxZTc3ZWIwOGJiNmI5YzgxYTAxZDYwYjEw
+    YmY1MTFmZTI1Njc4OTYxYmQ2MzNmNGZhZjNlZGVlMjM0ODRmOWJkZDQxMDA1
+    NTVkZDFkMDkxODdhZTc4OGIyM2ViMjg4MTAwZGU3OWExNDQ4ZTQ=

data/Gemfile

@@ -0,0 +1,20 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem 'oj', '~> 2.1'
+gem 'httparty', '~> 0.13'
+gem 'paint', '~> 0.8'
+gem 'rake', '~> 10.1'
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem 'rspec', '~> 2.14'
+  gem 'bundler', '~> 1.0'
+  gem 'jeweler', '~> 2.0'
+  gem 'rake-version', '~> 0.4'
+  gem 'simplecov', '~> 0.8'
+  gem 'fakefs', '~> 0.5', require: 'fakefs/safe'
+end

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Lotaris SA
+
+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,104 @@
+# Ruby ROX Client
+
+**Utilities for [ROX Center](https://github.com/lotaris/rox-center) ruby clients.**
+
+[![Gem Version](https://badge.fury.io/rb/rox-client-ruby.png)](http://badge.fury.io/rb/rox-client-ruby)
+
+## Requirements
+
+* Ruby 1.9.3 or higher
+
+## Installation
+
+In your Gemfile:
+
+```rb
+gem 'rox-client-ruby', '~> 0.1.0'
+```
+
+## Usage
+
+This project is a library for ROX Center clients in Ruby.
+It must be integrated into a testing framework, e.g. [rox-client-rspec](https://github.com/lotaris/rox-client-rspec) for [RSpec](https://relishapp.com/rspec).
+
+The [Setup](#setup) procedure is common to all clients and describes how to use ROX configuration files.
+
+## Setup
+
+ROX clients use [YAML](http://yaml.org) files for configuration.
+To use a ROX Client, you need two configuration files.
+
+In your home folder, you must create the `~/.rox/config.yml` configuration file.
+
+```yml
+# List of ROX Center servers you can submit test results to.
+servers:
+  rox.example.com:                        # A custom name for your ROX Center server.
+                                          # You will use this in the client configuration file.
+                                          # We recommend using the domain name where you deployed it.
+
+    apiUrl: https://rox.example.com/api   # The URL of your ROX Center server's API.
+                                          # This is the domain where you deployed it with /api.
+
+    apiKeyId: 39fuc7x85lsoy9c0ek2d        # Your user credentials on this server.
+    apiKeySecret: mwpqvvmagzoegxnqptxdaxkxonjmvrlctwcrfmowibqcpnsdqd
+
+# If true, test results will be uploaded to ROX Center.
+# Set to false to temporarily disable publishing.
+# You can change this at runtime from the command line by setting the
+# ROX_PUBLISH environment variable to 0 (false) or 1 (true).
+publish: true
+```
+
+In the project directory where you run your tests, you must add the `rox.yml` client configuration file:
+
+```yml
+# Configuration specific to your project.
+project:
+  apiId: 154sic93pxs0   # The API key of your project in the ROX Center server.
+  version: 1.2.3
+
+# Where the client should store its temporary files.
+# The client will work without it but it is required for some advanced features.
+workspace: tmp/rox
+
+# Client advanced features.
+payload:
+  
+  # Saves a copy of the test payload sent to the ROX Center server for debugging.
+  # The file will be saved in rspec/servers/<SERVER_NAME>/payload.json.
+  save: false
+
+  # If you track a large number of tests (more than a thousand), enabling this
+  # will reduce the size of the test payloads sent to ROX Center server by caching
+  # test information that doesn't change often such as the name.
+  cache: false
+
+  # Prints a copy of the test payload sent to the ROX Center server for debugging.
+  # Temporarily enable at runtime by setting the ROX_PRINT_PAYLOAD environment variable to 1.
+  print: false
+
+# The name of the ROX Center server to upload test results to.
+# This name must be one of the server names in the ~/.rox/config.yml file.
+# You can change this at runtime from the command line by setting the
+# ROX_SERVER environment variable.
+server: rox.example.com
+```
+
+Finally, if using a standalone ROX client like [rox-client-rspec](https://github.com/lotaris/rox-client-rspec),
+you must plug ROX into the testing framework.
+This procedure is documented by each client.
+
+## Contributing
+
+* [Fork](https://help.github.com/articles/fork-a-repo)
+* Create a topic branch - `git checkout -b my_feature`
+* Push to your branch - `git push origin my_feature`
+* Create a [pull request](http://help.github.com/pull-requests/) from your branch
+
+Please add a [changelog](CHANGELOG.md) entry with your name for new features and bug fixes.
+
+## License
+
+The Ruby ROX Client is licensed under the [MIT License](http://opensource.org/licenses/MIT).
+See [LICENSE.txt](LICENSE.txt) for the full license.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/rox-client-ruby.rb

@@ -0,0 +1,8 @@
+module RoxClient
+  VERSION = '0.1.0'
+
+  class Error < StandardError; end
+  class PayloadError < Error; end
+end
+
+Dir[File.join File.dirname(__FILE__), File.basename(__FILE__, '.*'), '*.rb'].each{ |lib| require lib }

data/lib/rox-client-ruby/cache.rb

@@ -0,0 +1,61 @@
+module RoxClient
+
+  class Cache
+
+    class Error < RoxClient::Error; end
+
+    def initialize options = {}
+      @tests = {}
+      @workspace, @server_name, @project_api_id = options[:workspace], options[:server_name], options[:project_api_id]
+      @client_name = options[:client_name]
+    end
+
+    def save test_run
+      validate!
+
+      @tests = { @project_api_id => @tests[@project_api_id] || {} }
+      test_run.results.each{ |r| @tests[@project_api_id][r.key] = test_result_hash(r) }
+
+      FileUtils.mkdir_p File.dirname(cache_file)
+      File.open(cache_file, 'w'){ |f| f.write Oj.dump(@tests, mode: :strict) }
+
+      self
+    end
+
+    def load
+      validate!
+
+      @tests = if File.exists? cache_file
+        Oj.load(File.read(cache_file), mode: :strict) rescue {}
+      else
+        {}
+      end
+
+      self
+    end
+
+    def known? test_result
+      @tests[@project_api_id] && !!@tests[@project_api_id][test_result.key]
+    end
+
+    def stale? test_result
+      @tests[@project_api_id] && test_result_hash(test_result) != @tests[@project_api_id][test_result.key]
+    end
+
+    private
+
+    def validate!
+      required = { "workspace" => @workspace, "client name" => @client_name, "server name" => @server_name, "project API identifier" => @project_api_id }
+      missing = required.keys.select{ |k| !required[k] }
+      raise Error.new("Missing cache options: #{missing.join ', '}") if missing.any?
+    end
+
+    def test_result_hash r
+      Digest::SHA2.hexdigest "#{r.name} || #{r.category} || #{r.tags.collect(&:to_s).sort.join(' ')} || #{r.tickets.collect(&:to_s).sort.join(' ')}"
+    end
+
+    def cache_file
+      @cache_file ||= File.join(@workspace, @client_name, 'servers', @server_name, 'cache.json')
+    end
+  end
+end

data/lib/rox-client-ruby/client.rb

@@ -0,0 +1,123 @@
+require 'paint'
+
+module RoxClient
+
+  class Client
+
+    def initialize server, options = {}
+
+      @server = server
+      @publish, @local_mode, @workspace = options[:publish], options[:local_mode], options[:workspace]
+      @cache_payload, @print_payload, @save_payload = options[:cache_payload], options[:print_payload], options[:save_payload]
+      @client_name = options[:client_name]
+      
+      cache_options = { workspace: @workspace }
+      cache_options.merge! server_name: @server.name, project_api_id: @server.project_api_id if @server
+      cache_options.merge! client_name: @client_name if @client_name
+      @cache = Cache.new cache_options
+
+      @uid = UID.new workspace: @workspace
+    end
+
+    def process test_run
+
+      puts
+      return fail "No server to publish results to" unless @server
+      return fail "Client name must be specified" unless @client_name
+
+      test_run.uid = @uid.load_uid
+
+      payload_options = @server.payload_options
+
+      cache_enabled = @cache_payload && load_cache
+      payload_options[:cache] = @cache if cache_enabled
+
+      return false unless payload = build_payload(test_run, payload_options)
+
+      published = if !@publish
+        puts Paint["ROX - Publishing disabled", :yellow]
+        false
+      elsif publish_payload payload
+        @cache.save test_run if cache_enabled
+        true
+      else
+        false
+      end
+
+      save_payload payload if @save_payload
+      print_payload payload if @print_payload
+
+      published
+    end
+
+    private
+
+    def build_payload test_run, options = {}
+      begin
+        TestPayload.new(test_run).to_h options
+      rescue PayloadError => e
+        fail e.message
+      end
+    end
+
+    def fail msg, type = :error
+      styles = { warning: [ :yellow ], error: [ :bold, :red ] }
+      warn Paint["ROX - #{msg}", *styles[type]]
+      false
+    end
+
+    def load_cache
+      begin
+        @cache.load
+      rescue Cache::Error => e
+        warn Paint["ROX - #{e.message}", :yellow]
+        false
+      end
+    end
+
+    def print_payload payload
+      puts Paint['ROX - Printing payload...', :yellow]
+      begin
+        puts JSON.pretty_generate(payload)
+      rescue
+        puts payload.inspect
+      end
+    end
+
+    def save_payload payload
+
+      missing = { "workspace" => @workspace, "server" => @server }.inject([]){ |memo,(k,v)| !v ? memo << k : memo }
+      return fail "Cannot save payload without a #{missing.join ' and '}" if missing.any?
+
+      FileUtils.mkdir_p File.dirname(payload_file)
+      File.open(payload_file, 'w'){ |f| f.write Oj.dump(payload, mode: :strict) }
+    end
+
+    def payload_file
+      @payload_file ||= File.join(@workspace, @client_name, 'servers', @server.name, 'payload.json')
+    end
+
+    def publish_payload payload
+
+      puts Paint["ROX - Sending payload to #{@server.api_url}...", :magenta]
+
+      begin
+        if @local_mode
+          puts Paint['ROX - LOCAL MODE: not actually sending payload.', :yellow]
+        else
+          @server.upload payload
+        end
+        puts Paint["ROX - Done!", :green]
+        true
+      rescue Server::Error => e
+        warn Paint["ROX - Upload failed!", :red, :bold]
+        warn Paint["ROX - #{e.message}", :red, :bold]
+        if e.response
+          warn Paint["ROX - Dumping response body...", :red, :bold]
+          warn e.response.body
+        end
+        false
+      end
+    end
+  end
+end

data/lib/rox-client-ruby/config.rb

@@ -0,0 +1,174 @@
+require 'yaml'
+require 'paint'
+
+module RoxClient
+
+  def self.config
+    @config ||= Config.new.tap(&:load)
+  end
+
+  def self.configure options = {}
+    yield config if block_given?
+    @integration.each{ |block| block.call config }
+    config.load_warnings.each{ |w| warn Paint["ROX - #{w}", :yellow] }
+    config
+  end
+
+  @integration = []
+
+  def self.integrate &block
+    @integration << block
+  end
+
+  class Config
+    # TODO: add silent/verbose option(s)
+    class Error < RoxClient::Error; end
+    attr_writer :publish, :local_mode, :cache_payload, :print_payload, :save_payload, :client_name
+    attr_reader :project, :server, :workspace, :load_warnings
+
+    def initialize
+      @servers = []
+      @project = Project.new
+      @publish, @local_mode, @cache_payload, @print_payload, @save_payload = false, false, false, false, false
+      @load_warnings = []
+    end
+
+    def workspace= dir
+      @workspace = dir ? File.expand_path(dir) : nil
+    end
+
+    def servers
+      @servers.dup
+    end
+
+    %w(publish local_mode cache_payload print_payload save_payload).each do |name|
+      define_method("#{name}?"){ instance_variable_get("@#{name}") }
+    end
+
+    def client_options
+      {
+        publish: @publish,
+        local_mode: @local_mode,
+        workspace: @workspace,
+        cache_payload: @cache_payload,
+        print_payload: @print_payload,
+        save_payload: @save_payload,
+        client_name: @client_name
+      }.select{ |k,v| !v.nil? }
+    end
+
+    def load
+
+      @load_warnings = []
+      return unless config = load_config_files
+
+      @publish = parse_env_flag :publish, !!config[:publish]
+      @server_name = parse_env_option(:server) || config[:server]
+      @local_mode = parse_env_flag(:local) || !!config[:local]
+
+      self.workspace = parse_env_option(:workspace) || config[:workspace]
+      @cache_payload = parse_env_flag :cache_payload, !!config[:payload][:cache]
+      @print_payload = parse_env_flag :print_payload, !!config[:payload][:print]
+      @save_payload = parse_env_flag :save_payload, !!config[:payload][:save]
+
+      @servers, @server = build_servers config
+
+      if @servers.empty?
+        @load_warnings << "No server defined"
+      elsif !@server_name
+        @load_warnings << "No server name given"
+      elsif !@server
+        @load_warnings << "Unknown server '#{@server_name}'"
+      end
+
+      project_options = config[:project]
+      project_options.merge! api_id: @server.project_api_id if @server and @server.project_api_id
+      @project.update project_options
+
+      self
+    end
+
+    private
+
+    def build_servers config
+
+      default_server_options = { project_api_id: config[:project][:api_id] }
+      servers = config[:servers].inject({}) do |memo,(name, options)|
+        memo[name] = Server.new default_server_options.merge(options).merge(name: name)
+        memo
+      end
+
+      [ servers.values, servers[@server_name.to_s.strip] ]
+    end
+
+    def load_config_files
+
+      configs = [ home_config_file, working_config_file ]
+      actual_configs = configs.select{ |f| File.exists? f }
+
+      if actual_configs.empty?
+        @load_warnings << %|no config file found, looking for:\n     #{configs.join "\n     "}|
+        return false
+      end
+
+      actual_configs.collect!{ |f| YAML.load_file f }
+
+      actual_configs.inject({ servers: {} }) do |memo,yml|
+        memo.merge! parse_general_options(yml)
+
+        if yml['servers'].kind_of? Hash
+          yml['servers'].each_pair do |k,v|
+            if v.kind_of? Hash
+              memo[:servers][k] = (memo[:servers][k] || {}).merge(parse_server_options(v))
+            end
+          end
+        end
+
+        memo[:payload] = (memo[:payload] || {}).merge parse_payload_options(yml['payload'])
+        memo[:project] = (memo[:project] || {}).merge parse_project_options(yml['project'])
+
+        memo
+      end
+    end
+
+    def home_config_file
+      File.join File.expand_path('~'), '.rox', 'config.yml'
+    end
+
+    def working_config_file
+      File.expand_path ENV['ROX_CONFIG'] || 'rox.yml', Dir.pwd
+    end
+
+    def parse_env_flag name, default = false
+      val = parse_env_option name
+      val ? !!val.to_s.strip.match(/\A(1|t|true)\Z/i) : default
+    end
+
+    def parse_env_option name
+      var = "ROX_#{name.upcase}"
+      ENV.key?(var) ? ENV[var] : nil
+    end
+
+    def parse_general_options h
+      parse_options h, %w(publish server local workspace)
+    end
+
+    def parse_server_options h
+      parse_options h, %w(name apiUrl apiKeyId apiKeySecret apiVersion projectApiId)
+    end
+
+    def parse_payload_options h
+      parse_options h, %w(save cache print)
+    end
+
+    def parse_project_options h
+      # TODO: remove project name once API v0 is dead
+      parse_options h, %w(name version apiId category tags tickets)
+    end
+
+    def parse_options h, keys
+      return {} unless h.kind_of? Hash
+      keys.inject({}){ |memo,k| memo[k.gsub(/(.)([A-Z])/, '\1_\2').downcase.to_sym] = h[k] if h.key?(k); memo }
+    end
+  end
+end

data/lib/rox-client-ruby/project.rb

@@ -0,0 +1,31 @@
+module RoxClient
+
+  class Project
+    # TODO: remove project name once API v0 is dead
+    attr_accessor :name, :version, :api_id, :category, :tags, :tickets
+
+    def initialize options = {}
+      update options
+    end
+
+    def update options = {}
+      %w(name version api_id category).each do |k|
+        instance_variable_set "@#{k}", options[k.to_sym] ? options[k.to_sym].to_s : nil if options.key? k.to_sym
+      end
+      @tags = wrap(options[:tags]).compact if options.key? :tags
+      @tickets = wrap(options[:tickets]).compact if options.key? :tickets
+    end
+
+    def validate!
+      required = { "version" => @version, "API identifier" => @api_id }
+      missing = required.inject([]){ |memo,(k,v)| v.to_s.strip.length <= 0 ? memo << k : memo }
+      raise PayloadError.new("Missing project options: #{missing.join ', '}") if missing.any?
+    end
+
+    private
+
+    def wrap a
+      a.kind_of?(Array) ? a : [ a ]
+    end
+  end
+end

data/lib/rox-client-ruby/server.rb

@@ -0,0 +1,97 @@
+require 'oj'
+require 'httparty'
+
+module RoxClient
+
+  class Server
+    attr_reader :name, :api_url, :api_key_id, :api_key_secret, :api_version, :project_api_id
+
+    class Error < RoxClient::Error
+      attr_reader :response
+    
+      def initialize msg, response = nil
+        super msg
+        @response = response
+      end
+    end
+
+    def initialize options = {}
+      @name = options[:name].to_s.strip
+      @api_url = options[:api_url].to_s if options[:api_url]
+      @api_key_id = options[:api_key_id].to_s if options[:api_key_id]
+      @api_key_secret = options[:api_key_secret].to_s if options[:api_key_secret]
+      @api_version = options[:api_version] || 1
+      @project_api_id = options[:project_api_id].to_s if options[:project_api_id]
+    end
+
+    def payload_options
+      { version: @api_version }
+    end
+
+    def upload payload
+      validate!
+
+      uri = payload_uri
+      body = Oj.dump payload, mode: :strict
+
+      res = case @api_version
+      when 0
+        HTTParty.post uri, body: body
+      else
+        HTTParty.post uri, body: body, headers: payload_headers.merge(authentication_headers)
+      end
+
+      if res.code != 202
+        raise Error.new("Expected HTTP 202 Accepted when submitting payload, got #{res.code}", res)
+      end
+    end
+
+    private
+
+    def validate!
+      
+      raise Error.new("Server #{@name} requires $ROX_RUNNER_KEY to be set (API v0)") if @api_version == 0 and !ENV['ROX_RUNNER_KEY']
+
+      required = { "apiUrl" => @api_url }
+      required.merge!({ "apiKeyId" => @api_key_id, "apiKeySecret" => @api_key_secret, "projectApiId" => @project_api_id }) if @api_version >= 1
+      missing = required.inject([]){ |memo,(k,v)| v.to_s.strip.length <= 0 ? memo << k : memo }
+      raise Error.new("Server #{@name} is missing the following options: #{missing.join ', '}") if missing.any?
+    end
+
+    def payload_headers
+      { 'Content-Type' => 'application/vnd.lotaris.rox.payload.v1+json' }
+    end
+
+    def payload_uri
+      case @api_version
+
+      when 0
+        "#{@api_url}/v1/payload"
+
+      else
+      
+        # get api root
+        res = HTTParty.get @api_url, headers: authentication_headers
+        if res.code != 200
+          raise Error.new("Expected HTTP 200 OK status code for API root, got #{res.code}", res)
+        elsif res.content_type != 'application/hal+json'
+          raise Error.new("Expected API root in the application/hal+json content type, got #{res.content_type}", res)
+        end
+
+        body = Oj.load res.body, mode: :strict
+
+        links = body['_links'] || {}
+        if !links.key?('v1:test-payloads')
+          raise Error.new("Expected API root to have a v1:test-payloads link", res)
+        end
+
+        # extract payload uri
+        links['v1:test-payloads']['href']
+      end
+    end
+
+    def authentication_headers
+      { 'Authorization' => %|RoxApiKey id="#{@api_key_id}" secret="#{@api_key_secret}"| }
+    end
+  end
+end

data/lib/rox-client-ruby/tasks.rb

@@ -0,0 +1,63 @@
+require 'fileutils'
+require 'rake/tasklib'
+require 'paint'
+
+module RoxClient
+
+  class Tasks < ::Rake::TaskLib
+
+    def initialize
+
+      namespace :spec do
+
+        namespace :rox do
+
+          desc "Generate a test run UID to group test results in ROX Center (stored in an environment variable)"
+          task :uid do
+            trace do
+              uid = uid_manager.generate_uid_to_env
+              puts Paint["ROX - Generated UID for test run: #{uid}", :cyan]
+            end
+          end
+
+          namespace :uid do
+
+            desc "Generate a test run UID to group test results in ROX Center (stored in a file)"
+            task :file do
+              trace do
+                uid = uid_manager.generate_uid_to_file
+                puts Paint["ROX - Generated UID for test run: #{uid}", :cyan]
+              end
+            end
+
+            desc "Clean the test run UID (file and environment variable)"
+            task :clean do
+              trace do
+                uid_manager.clean_uid
+                puts Paint["ROX - Cleaned test run UID", :cyan]
+              end
+            end
+          end
+        end
+      end
+    end
+
+    private
+
+    def trace &block
+      if Rake.application.options.trace
+        block.call
+      else
+        begin
+          block.call
+        rescue UID::Error => e
+          warn Paint["ROX - #{e.message}", :red]
+        end
+      end
+    end
+
+    def uid_manager
+      UID.new RoxClient.config.client_options
+    end
+  end
+end

data/lib/rox-client-ruby/test_payload.rb

@@ -0,0 +1,19 @@
+require 'fileutils'
+require 'digest/sha2'
+
+module RoxClient
+
+  class TestPayload
+
+    class Error < RoxClient::Error; end
+
+    def initialize run
+      @run = run
+    end
+
+    def to_h options = {}
+      # version 1 payload consists of one test run
+      @run.to_h options
+    end
+  end
+end

data/lib/rox-client-ruby/test_result.rb

@@ -0,0 +1,61 @@
+module RoxClient
+
+  class TestResult
+    attr_reader :key, :name, :category, :tags, :tickets, :duration, :message
+
+    def initialize project, options = {}
+
+      @key = options[:key]
+      @name = options[:name]
+
+      @category = project.category || options[:category]
+      @tags = (wrap(project.tags) + wrap(options[:tags])).compact.collect(&:to_s).uniq
+      @tickets = (wrap(project.tickets) + wrap(options[:tickets])).compact.collect(&:to_s).uniq
+
+      @grouped = !!options[:grouped]
+
+      @passed = !!options[:passed]
+      @duration = options[:duration]
+      @message = options[:message]
+    end
+
+    def passed?
+      @passed
+    end
+
+    def grouped?
+      @grouped
+    end
+
+    def update options = {}
+      @passed &&= !!options[:passed]
+      @duration += options[:duration]
+      @message = [ @message, options[:message] ].select{ |m| m }.join("\n\n") if options[:message]
+    end
+
+    def to_h options = {}
+      {
+        'k' => @key,
+        'p' => @passed,
+        'd' => @duration
+      }.tap do |h|
+
+        h['m'] = @message if @message
+
+        cache = options[:cache]
+        first = !cache || !cache.known?(self)
+        stale = !first && cache.stale?(self)
+        h['n'] = @name if stale or first
+        h['c'] = @category if stale or (first and @category)
+        h['g'] = @tags if stale or (first and !@tags.empty?)
+        h['t'] = @tickets if stale or (first and !@tickets.empty?)
+      end
+    end
+
+    private
+
+    def wrap a
+      a.kind_of?(Array) ? a : [ a ]
+    end
+  end
+end

data/lib/rox-client-ruby/test_run.rb

@@ -0,0 +1,88 @@
+module RoxClient
+
+  class TestRun
+    attr_reader :results, :project
+    attr_accessor :duration, :uid
+
+    def initialize project
+      @results = []
+      @project = project
+    end
+
+    def add_result options = {}
+
+      if options[:grouped] && existing_result = @results.find{ |r| r.grouped? && r.key == options[:key] }
+        existing_result.update options
+      else
+        @results << TestResult.new(@project, options)
+      end
+    end
+
+    def results_without_key
+      @results.select{ |r| !r.key or r.key.to_s.strip.empty? }
+    end
+
+    def results_by_key
+      @results.inject({}) do |memo,r|
+        (memo[r.key] ||= []) << r unless !r.key or r.key.to_s.strip.empty?
+        memo
+      end
+    end
+
+    def to_h options = {}
+      validate!
+
+      {
+        'd' => @duration,
+        'r' => [
+          {
+            'j' => @project.api_id,
+            'v' => @project.version,
+            't' => @results.collect{ |r| r.to_h options }
+          }
+        ]
+      }.tap do |h|
+        h['u'] = @uid if @uid
+      end
+    end
+
+    private
+
+    def validate!
+      # TODO: validate duration
+
+      raise PayloadError.new("Missing project") if !@project
+      @project.validate!
+
+      validate_no_results_without_key
+      validate_no_duplicate_keys
+    end
+
+    def validate_no_duplicate_keys
+
+      results_with_duplicate_key = results_by_key.select{ |k,r| r.length >= 2 }
+      return if results_with_duplicate_key.none?
+
+      msg = "the following keys are used by multiple test results".tap do |s|
+        results_with_duplicate_key.each_pair do |key,results|
+          s << "\n     - #{key}"
+          results.each{ |r| s << "\n       - #{r.name}" }
+        end
+      end
+
+      raise PayloadError.new(msg)
+    end
+
+    def validate_no_results_without_key
+
+      keyless = results_without_key
+      return if keyless.empty?
+
+      msg = "the following test results are missing a key".tap do |s|
+        keyless.each{ |r| s << "\n     - #{r.name}" }
+      end
+
+      raise PayloadError.new(msg)
+    end
+  end
+end

data/lib/rox-client-ruby/uid.rb

@@ -0,0 +1,60 @@
+require 'securerandom'
+
+module RoxClient
+
+  class UID
+    ENVIRONMENT_VARIABLE = 'ROX_TEST_RUN_UID'
+
+    class Error < RoxClient::Error; end
+
+    def initialize options = {}
+      @workspace = options[:workspace]
+    end
+
+    def load_uid
+      if env_var
+        return env_var
+      elsif @workspace
+        current_uid
+      end
+    end
+
+    def generate_uid_to_file
+      raise Error.new("No workspace specified; cannot save test run UID") if !@workspace
+      generate_uid.tap{ |uid| save_uid uid }
+    end
+
+    def generate_uid_to_env
+      raise Error.new("$ROX_TEST_RUN_UID is already defined") if env_var
+      ENV[ENVIRONMENT_VARIABLE] = generate_uid
+    end
+
+    def clean_uid
+      ENV.delete ENVIRONMENT_VARIABLE
+      FileUtils.remove_entry_secure uid_file if @workspace and File.exists?(uid_file)
+    end
+
+    private
+
+    def save_uid uid
+      FileUtils.mkdir_p File.dirname(uid_file)
+      File.open(uid_file, 'w'){ |f| f.write uid }
+    end
+
+    def env_var
+      ENV[ENVIRONMENT_VARIABLE]
+    end
+
+    def current_uid
+      File.file?(uid_file) ? File.read(uid_file) : nil
+    end
+
+    def uid_file
+      @uid_file ||= File.join(@workspace, 'uid')
+    end
+
+    def generate_uid
+      "#{Time.now.utc.strftime '%Y%m%d%H%M%S'}-#{SecureRandom.uuid}"
+    end
+  end
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: rox-client-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Oulevay
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake-version
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: Collects test results and uploads them to a ROX Center server.
+email: simon.oulevay@lotaris.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- VERSION
+- lib/rox-client-ruby.rb
+- lib/rox-client-ruby/cache.rb
+- lib/rox-client-ruby/client.rb
+- lib/rox-client-ruby/config.rb
+- lib/rox-client-ruby/project.rb
+- lib/rox-client-ruby/server.rb
+- lib/rox-client-ruby/tasks.rb
+- lib/rox-client-ruby/test_payload.rb
+- lib/rox-client-ruby/test_result.rb
+- lib/rox-client-ruby/test_run.rb
+- lib/rox-client-ruby/uid.rb
+homepage: https://github.com/lotaris/rox-client-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Ruby utilities to send results to ROX Center.
+test_files: []