coursemology-evaluator 0.1.1 → 0.1.3

data/Gemfile

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

data/Procfile

@@ -1 +1 @@
-evaluator: evaluator --host=$HOST --api-token=$API_TOKEN --api-user-email=$API_USER_EMAIL
+evaluator: evaluator --host=$HOST --api-token=$API_TOKEN --api-user-email=$API_USER_EMAIL

data/README.md

@@ -1,29 +1,29 @@
-# Coursemology Code Evaluator [![Build Status](https://travis-ci.org/Coursemology/evaluator-slave.svg?branch=master)](https://travis-ci.org/Coursemology/evaluator-slave)
-[![Code Climate](https://codeclimate.com/github/Coursemology/evaluator-slave/badges/gpa.svg)](https://codeclimate.com/github/Coursemology/evaluator-slave) [![Coverage Status](https://coveralls.io/repos/Coursemology/evaluator-slave/badge.svg?branch=master&service=github)](https://coveralls.io/github/Coursemology/evaluator-slave?branch=master) [![Security](https://hakiri.io/github/Coursemology/evaluator-slave/master.svg)](https://hakiri.io/github/Coursemology/evaluator-slave/master) [![Inline docs](http://inch-ci.org/github/coursemology/evaluator-slave.svg?branch=master)](http://inch-ci.org/github/coursemology/evaluator-slave)
-
-This is the evaluator program which will query Coursemology for pending evaluation jobs.
-
-## Setting up the Evaluator Slave
-
-### System Requirements
-
-1. Ruby (>= 2.1.0)
-2. Linux (tested on Ubuntu 14.04)
-3. Docker (the user the evaluator runs as must be able to talk to the Docker Remote API endpoint)
-
-### Getting Started
-
-1. Install the gem
-
-   ```sh
-   $ gem install coursemology-evaluator
-   ```
-
-2. Modify `.env` to suit your environment. Point to the host to your Coursemology instance, and 
-   specify the API email and API key.
-
-   1. You might need to configure a new user on your Coursemology instance, enable token 
-      authentication, and grant the `auto_grader` system/instance permission.
-
-3. Start the evaluator using the Procfile. You can use [foreman](https://github.com/ddollar/foreman)
-   or any similar tool to generate system scripts for boot.
+# Coursemology Code Evaluator [![Build Status](https://travis-ci.org/Coursemology/evaluator-slave.svg?branch=master)](https://travis-ci.org/Coursemology/evaluator-slave)
+[![Code Climate](https://codeclimate.com/github/Coursemology/evaluator-slave/badges/gpa.svg)](https://codeclimate.com/github/Coursemology/evaluator-slave) [![Coverage Status](https://coveralls.io/repos/Coursemology/evaluator-slave/badge.svg?branch=master&service=github)](https://coveralls.io/github/Coursemology/evaluator-slave?branch=master) [![Security](https://hakiri.io/github/Coursemology/evaluator-slave/master.svg)](https://hakiri.io/github/Coursemology/evaluator-slave/master) [![Inline docs](http://inch-ci.org/github/coursemology/evaluator-slave.svg?branch=master)](http://inch-ci.org/github/coursemology/evaluator-slave) [![Gem Version](https://badge.fury.io/rb/coursemology-evaluator.svg)](https://badge.fury.io/rb/coursemology-evaluator)
+
+This is the evaluator program which will query Coursemology for pending evaluation jobs.
+
+## Setting up the Evaluator Slave
+
+### System Requirements
+
+1. Ruby (>= 2.1.0)
+2. Linux (tested on Ubuntu 14.04)
+3. Docker (the user the evaluator runs as must be able to talk to the Docker Remote API endpoint)
+
+### Getting Started
+
+1. Install the gem
+
+   ```sh
+   $ gem install coursemology-evaluator
+   ```
+
+2. Modify `.env` to suit your environment. Point to the host to your Coursemology instance, and 
+   specify the API email and API key.
+
+   1. You might need to configure a new user on your Coursemology instance, enable token 
+      authentication, and grant the `auto_grader` system/instance permission.
+
+3. Start the evaluator using the Procfile. You can use [foreman](https://github.com/ddollar/foreman)
+   or any similar tool to generate system scripts for boot.

data/Rakefile

@@ -1,6 +1,6 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-task default: :spec
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/evaluator

@@ -1,5 +1,5 @@
-#!/usr/bin/env ruby
-require 'coursemology/evaluator'
-
-Coursemology::Evaluator.eager_load!
-Coursemology::Evaluator::CLI.start(ARGV)
+#!/usr/bin/env ruby
+require 'coursemology/evaluator'
+
+Coursemology::Evaluator.eager_load!
+Coursemology::Evaluator::CLI.start(ARGV)

data/coursemology-evaluator.gemspec

@@ -1,37 +1,37 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'coursemology/evaluator/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = 'coursemology-evaluator'
-  spec.version       = Coursemology::Evaluator::VERSION
-  spec.authors       = ['Joel Low']
-  spec.email         = ['joel@joelsplace.sg']
-  spec.license       = 'MIT'
-
-  spec.summary       = 'Coursemology programming package evaluator'
-  spec.description   = 'Sets up a consistent environment for evaluating programming packages.'
-  spec.homepage      = 'http://coursemology.org'
-  spec.files         = `git ls-files -z`.split("\x0").
-                       reject { |f| f.match(/^(test|spec|features)\//) }
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'factory_girl'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'coveralls'
-  spec.add_development_dependency 'codeclimate-test-reporter'
-  spec.add_development_dependency 'vcr'
-
-  spec.add_dependency 'activesupport', '~> 4.2.0'
-  spec.add_dependency 'flexirest', '~> 1.2'
-  spec.add_dependency 'faraday_middleware'
-
-  spec.add_dependency 'coursemology-polyglot', '>= 0.0.3'
-  spec.add_dependency 'docker-api', '>= 1.2.5'
-  spec.add_dependency 'rubyzip'
-end
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'coursemology/evaluator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'coursemology-evaluator'
+  spec.version       = Coursemology::Evaluator::VERSION
+  spec.authors       = ['Joel Low']
+  spec.email         = ['joel@joelsplace.sg']
+  spec.license       = 'MIT'
+
+  spec.summary       = 'Coursemology programming package evaluator'
+  spec.description   = 'Sets up a consistent environment for evaluating programming packages.'
+  spec.homepage      = 'https://github.com/Coursemology/evaluator-slave'
+  spec.files         = `git ls-files -z`.split("\x0").
+                       reject { |f| f.match(/^(test|spec|features)\//) }
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'vcr'
+
+  spec.add_dependency 'activesupport', '~> 4.2.0', '>= 4.2.2'
+  spec.add_dependency 'flexirest', '~> 1.2', '>= 1.2.6'
+  spec.add_dependency 'faraday_middleware'
+
+  spec.add_dependency 'coursemology-polyglot', '>= 0.0.3'
+  spec.add_dependency 'docker-api', '>= 1.2.5'
+  spec.add_dependency 'rubyzip'
+end

data/lib/coursemology/evaluator.rb

@@ -1,36 +1,36 @@
-# frozen_string_literal: true
-require 'active_support/all'
-require 'flexirest'
-require 'faraday_middleware'
-require 'docker'
-require 'zip'
-Docker.validate_version!
-
-require 'coursemology/polyglot'
-require 'coursemology/polyglot/extensions'
-require 'coursemology/evaluator/version'
-
-module Coursemology::Evaluator
-  extend ActiveSupport::Autoload
-
-  autoload :Client
-  autoload :DockerContainer
-  autoload :CLI
-  autoload :Models
-  autoload :Services
-  autoload :StringIO
-  autoload :Utils
-
-  eager_autoload do
-    autoload :Logging
-  end
-
-  # The logger to use for the client.
-  mattr_reader(:logger) { ActiveSupport::Logger.new(STDOUT) }
-
-  def self.eager_load!
-    super
-    Coursemology::Polyglot.eager_load!
-    Logging.eager_load!
-  end
-end
+# frozen_string_literal: true
+require 'active_support/all'
+require 'flexirest'
+require 'faraday_middleware'
+require 'docker'
+require 'zip'
+Docker.validate_version!
+
+require 'coursemology/polyglot'
+require 'coursemology/polyglot/extensions'
+require 'coursemology/evaluator/version'
+
+module Coursemology::Evaluator
+  extend ActiveSupport::Autoload
+
+  autoload :Client
+  autoload :DockerContainer
+  autoload :CLI
+  autoload :Models
+  autoload :Services
+  autoload :StringIO
+  autoload :Utils
+
+  eager_autoload do
+    autoload :Logging
+  end
+
+  # The logger to use for the client.
+  mattr_reader(:logger) { ActiveSupport::Logger.new(STDOUT) }
+
+  def self.eager_load!
+    super
+    Coursemology::Polyglot.eager_load!
+    Logging.eager_load!
+  end
+end

data/lib/coursemology/evaluator/cli.rb

@@ -1,52 +1,52 @@
-# frozen_string_literal: true
-require 'optparse'
-
-class Coursemology::Evaluator::CLI
-  Options = Struct.new(:host, :api_token, :api_user_email, :one_shot)
-
-  def self.start(argv)
-    new.start(argv)
-  end
-
-  def start(argv)
-    run(argv)
-  end
-
-  def run(argv)
-    options = optparse!(argv)
-    Coursemology::Evaluator::Client.initialize(options.host, options.api_user_email,
-                                               options.api_token)
-    Coursemology::Evaluator::Client.new(options.one_shot).run
-  end
-
-  private
-
-  # Parses the options specified on the command line.
-  #
-  # @param [Array<String>] argv The arguments specified on the command line.
-  # @return [Coursemology::Evaluator::CLI::Options]
-  def optparse!(argv) # rubocop:disable Metrics/MethodLength
-    options = Options.new
-    option_parser = OptionParser.new do |parser|
-      parser.banner = "Usage: #{parser.program_name} [options]"
-      parser.on('-hHOST', '--host=HOST', 'Coursemology host to connect to') do |host|
-        options.host = host
-      end
-
-      parser.on('-tTOKEN', '--api-token=TOKEN') do |token|
-        options.api_token = token
-      end
-
-      parser.on('-uUSER', '--api-user-email=USER') do |user|
-        options.api_user_email = user
-      end
-
-      parser.on('-o', '--one-shot') do
-        options.one_shot = true
-      end
-    end
-
-    option_parser.parse!(argv)
-    options
-  end
-end
+# frozen_string_literal: true
+require 'optparse'
+
+class Coursemology::Evaluator::CLI
+  Options = Struct.new(:host, :api_token, :api_user_email, :one_shot)
+
+  def self.start(argv)
+    new.start(argv)
+  end
+
+  def start(argv)
+    run(argv)
+  end
+
+  def run(argv)
+    options = optparse!(argv)
+    Coursemology::Evaluator::Client.initialize(options.host, options.api_user_email,
+                                               options.api_token)
+    Coursemology::Evaluator::Client.new(options.one_shot).run
+  end
+
+  private
+
+  # Parses the options specified on the command line.
+  #
+  # @param [Array<String>] argv The arguments specified on the command line.
+  # @return [Coursemology::Evaluator::CLI::Options]
+  def optparse!(argv) # rubocop:disable Metrics/MethodLength
+    options = Options.new
+    option_parser = OptionParser.new do |parser|
+      parser.banner = "Usage: #{parser.program_name} [options]"
+      parser.on('-hHOST', '--host=HOST', 'Coursemology host to connect to') do |host|
+        options.host = host
+      end
+
+      parser.on('-tTOKEN', '--api-token=TOKEN') do |token|
+        options.api_token = token
+      end
+
+      parser.on('-uUSER', '--api-user-email=USER') do |user|
+        options.api_user_email = user
+      end
+
+      parser.on('-o', '--one-shot') do
+        options.one_shot = true
+      end
+    end
+
+    option_parser.parse!(argv)
+    options
+  end
+end

data/lib/coursemology/evaluator/client.rb

@@ -1,75 +1,81 @@
-# frozen_string_literal: true
-class Coursemology::Evaluator::Client
-  def self.initialize(host, api_user_email, api_token)
-    Coursemology::Evaluator::Models::Base.base_url = host
-    Coursemology::Evaluator::Models::Base.api_user_email = api_user_email
-    Coursemology::Evaluator::Models::Base.api_token = api_token
-
-    Coursemology::Evaluator::Models::Base.initialize
-  end
-
-  # @param [Boolean] one_shot If the client should only fire one request.
-  def initialize(one_shot = false)
-    @terminate = one_shot
-  end
-
-  def run
-    Signal.trap('SIGTERM', method(:on_sig_term))
-
-    loop do
-      allocate_evaluations
-      break if @terminate
-
-      # :nocov:
-      # This sleep might not be triggered in the specs, because interruptions to the thread is
-      # nondeterministically run by the OS scheduler.
-      sleep(1.minute)
-      # :nocov:
-    end
-  end
-
-  private
-
-  # Requests evaluations from the server.
-  def allocate_evaluations
-    evaluations =
-      ActiveSupport::Notifications.instrument('allocate.client.evaluator.coursemology') do
-        languages = Coursemology::Polyglot::Language.concrete_languages.map(&:display_name)
-        Coursemology::Evaluator::Models::ProgrammingEvaluation.allocate(language: languages)
-      end
-
-    on_allocate(evaluations)
-  rescue Flexirest::HTTPUnauthorisedClientException => e
-    ActiveSupport::Notifications.publish('allocate_fail.client.evaluator.coursemology', e: e)
-  end
-
-  # The callback for handling an array of allocated evaluations.
-  #
-  # @param [Array<Coursemology::Evaluator::Models::ProgrammingEvaluation>] evaluations The
-  #   evaluations retrieved from the server.
-  def on_allocate(evaluations)
-    evaluations.each do |evaluation|
-      on_evaluation(evaluation)
-    end
-  end
-
-  # The callback for handling an evaluation.
-  #
-  # @param [Coursemology::Evaluator::Models::ProgrammingEvaluation] evaluation The evaluation
-  #   retrieved from the server.
-  def on_evaluation(evaluation)
-    ActiveSupport::Notifications.instrument('evaluate.client.evaluator.coursemology',
-                                            evaluation: evaluation) do
-      evaluation.evaluate
-    end
-
-    ActiveSupport::Notifications.instrument('save.client.evaluator.coursemology') do
-      evaluation.save
-    end
-  end
-
-  # The callback for handling SIGTERM sent to the process.
-  def on_sig_term
-    @terminate = true
-  end
-end
+# frozen_string_literal: true
+class Coursemology::Evaluator::Client
+  def self.initialize(host, api_user_email, api_token)
+    Coursemology::Evaluator::Models::Base.base_url = host
+    Coursemology::Evaluator::Models::Base.api_user_email = api_user_email
+    Coursemology::Evaluator::Models::Base.api_token = api_token
+
+    Coursemology::Evaluator::Models::Base.initialize
+  end
+
+  # @param [Boolean] one_shot If the client should only fire one request.
+  def initialize(one_shot = false)
+    @terminate = one_shot
+  end
+
+  def run
+    Signal.trap('SIGTERM', method(:on_sig_term))
+
+    loop do
+      evaluations = allocate_evaluations
+
+      if evaluations && !evaluations.empty?
+        on_allocate(evaluations)
+      else
+        # :nocov:
+        # This sleep might not be triggered in the specs, because interruptions to the thread is
+        # nondeterministically run by the OS scheduler.
+        sleep(1.minute)
+        # :nocov:
+      end
+
+      break if @terminate
+    end
+  end
+
+  private
+
+  # Requests evaluations from the server.
+  #
+  # @return [Array<Coursemology::Evaluator::Models::ProgrammingEvaluation>] The evaluations
+  #   retrieved from the server.
+  def allocate_evaluations
+    ActiveSupport::Notifications.instrument('allocate.client.evaluator.coursemology') do
+      languages = Coursemology::Polyglot::Language.concrete_languages.map(&:display_name)
+      Coursemology::Evaluator::Models::ProgrammingEvaluation.allocate(language: languages)
+    end
+  rescue Flexirest::HTTPUnauthorisedClientException => e
+    ActiveSupport::Notifications.publish('allocate_fail.client.evaluator.coursemology', e: e)
+    nil
+  end
+
+  # The callback for handling an array of allocated evaluations.
+  #
+  # @param [Array<Coursemology::Evaluator::Models::ProgrammingEvaluation>] evaluations The
+  #   evaluations retrieved from the server.
+  def on_allocate(evaluations)
+    evaluations.each do |evaluation|
+      on_evaluation(evaluation)
+    end
+  end
+
+  # The callback for handling an evaluation.
+  #
+  # @param [Coursemology::Evaluator::Models::ProgrammingEvaluation] evaluation The evaluation
+  #   retrieved from the server.
+  def on_evaluation(evaluation)
+    ActiveSupport::Notifications.instrument('evaluate.client.evaluator.coursemology',
+                                            evaluation: evaluation) do
+      evaluation.evaluate
+    end
+
+    ActiveSupport::Notifications.instrument('save.client.evaluator.coursemology') do
+      evaluation.save
+    end
+  end
+
+  # The callback for handling SIGTERM sent to the process.
+  def on_sig_term
+    @terminate = true
+  end
+end