coursemology-evaluator 0.1.1 → 0.1.3

data/lib/coursemology/evaluator/docker_container.rb

@@ -1,59 +1,59 @@
-# frozen_string_literal: true
-class Coursemology::Evaluator::DockerContainer < Docker::Container
-  class << self
-    def create(image, argv: nil)
-      pull_image(image)
-
-      ActiveSupport::Notifications.instrument('create.docker.evaluator.coursemology',
-                                              image: image) do |payload|
-        options = { 'Image' => image }
-        options['Cmd'] = argv if argv && !argv.empty?
-
-        payload[:container] = super(options)
-      end
-    end
-
-    private
-
-    def pull_image(image)
-      ActiveSupport::Notifications.instrument('pull.docker.evaluator.coursemology',
-                                              image: image) do
-        Docker::Image.create('fromImage' => image)
-      end
-    end
-  end
-
-  # Waits for the container to exit the Running state.
-  #
-  # This will time out for long running operations, so keep retrying until we return.
-  #
-  # @param [Fixnum|nil] time The amount of time to wait.
-  # @return [Fixnum] The exit code of the container.
-  def wait(time = nil)
-    container_state = info
-    while container_state.fetch('State', {}).fetch('Running', true)
-      super
-      refresh!
-      container_state = info
-    end
-
-    container_state['State']['ExitCode']
-  rescue Docker::Error::TimeoutError
-    retry
-  end
-
-  # Gets the exit code of the container.
-  #
-  # @return [Fixnum] The exit code of the container, if +wait+ was called before.
-  # @return [nil] If the container is still running, or +wait+ was not called.
-  def exit_code
-    info.fetch('State', {})['ExitCode']
-  end
-
-  def delete
-    ActiveSupport::Notifications.instrument('destroy.docker.evaluator.coursemology',
-                                            container: id) do
-      super
-    end
-  end
-end
+# frozen_string_literal: true
+class Coursemology::Evaluator::DockerContainer < Docker::Container
+  class << self
+    def create(image, argv: nil)
+      pull_image(image)
+
+      ActiveSupport::Notifications.instrument('create.docker.evaluator.coursemology',
+                                              image: image) do |payload|
+        options = { 'Image' => image }
+        options['Cmd'] = argv if argv && !argv.empty?
+
+        payload[:container] = super(options)
+      end
+    end
+
+    private
+
+    def pull_image(image)
+      ActiveSupport::Notifications.instrument('pull.docker.evaluator.coursemology',
+                                              image: image) do
+        Docker::Image.create('fromImage' => image)
+      end
+    end
+  end
+
+  # Waits for the container to exit the Running state.
+  #
+  # This will time out for long running operations, so keep retrying until we return.
+  #
+  # @param [Fixnum|nil] time The amount of time to wait.
+  # @return [Fixnum] The exit code of the container.
+  def wait(time = nil)
+    container_state = info
+    while container_state.fetch('State', {}).fetch('Running', true)
+      super
+      refresh!
+      container_state = info
+    end
+
+    container_state['State']['ExitCode']
+  rescue Docker::Error::TimeoutError
+    retry
+  end
+
+  # Gets the exit code of the container.
+  #
+  # @return [Fixnum] The exit code of the container, if +wait+ was called before.
+  # @return [nil] If the container is still running, or +wait+ was not called.
+  def exit_code
+    info.fetch('State', {})['ExitCode']
+  end
+
+  def delete
+    ActiveSupport::Notifications.instrument('destroy.docker.evaluator.coursemology',
+                                            container: id) do
+      super
+    end
+  end
+end

data/lib/coursemology/evaluator/logging.rb

@@ -1,12 +1,12 @@
-# frozen_string_literal: true
-module Coursemology::Evaluator::Logging
-  extend ActiveSupport::Autoload
-
-  eager_autoload do
-    autoload :ClientLogSubscriber
-    autoload :DockerLogSubscriber
-  end
-end
-
-# Define +Rails+ to trick ActiveSupport into logging to our logger.
-Rails = Coursemology::Evaluator
+# frozen_string_literal: true
+module Coursemology::Evaluator::Logging
+  extend ActiveSupport::Autoload
+
+  eager_autoload do
+    autoload :ClientLogSubscriber
+    autoload :DockerLogSubscriber
+  end
+end
+
+# Define +Rails+ to trick ActiveSupport into logging to our logger.
+Rails = Coursemology::Evaluator

data/lib/coursemology/evaluator/logging/client_log_subscriber.rb

@@ -1,25 +1,25 @@
-# frozen_string_literal: true
-class Coursemology::Evaluator::Logging::ClientLogSubscriber < ActiveSupport::LogSubscriber
-  def publish(name, *args)
-    send(name.split('.').first, *args)
-  end
-
-  def allocate(event)
-    info color("Client: Allocate (#{event.duration.round(1)}ms)", MAGENTA)
-  end
-
-  def allocate_fail(e:)
-    error color("Client: Allocate failed: #{e.message}", RED)
-  end
-
-  def evaluate(event)
-    info "#{color("Client: Evaluate (#{event.duration.round(1)}ms)", CYAN)} "\
-      "#{event.payload[:evaluation].language.class.display_name}"
-  end
-
-  def save(event)
-    info color("Client: Save (#{event.duration.round(1)}ms)", GREEN)
-  end
-end
-
-Coursemology::Evaluator::Logging::ClientLogSubscriber.attach_to(:'client.evaluator.coursemology')
+# frozen_string_literal: true
+class Coursemology::Evaluator::Logging::ClientLogSubscriber < ActiveSupport::LogSubscriber
+  def publish(name, *args)
+    send(name.split('.').first, *args)
+  end
+
+  def allocate(event)
+    info color("Client: Allocate (#{event.duration.round(1)}ms)", MAGENTA)
+  end
+
+  def allocate_fail(e:)
+    error color("Client: Allocate failed: #{e.message}", RED)
+  end
+
+  def evaluate(event)
+    info "#{color("Client: Evaluate (#{event.duration.round(1)}ms)", CYAN)} "\
+      "#{event.payload[:evaluation].language.class.display_name}"
+  end
+
+  def save(event)
+    info color("Client: Save (#{event.duration.round(1)}ms)", GREEN)
+  end
+end
+
+Coursemology::Evaluator::Logging::ClientLogSubscriber.attach_to(:'client.evaluator.coursemology')

data/lib/coursemology/evaluator/logging/docker_log_subscriber.rb

@@ -1,18 +1,18 @@
-# frozen_string_literal: true
-class Coursemology::Evaluator::Logging::DockerLogSubscriber < ActiveSupport::LogSubscriber
-  def pull(event)
-    info "#{color("Docker Pull (#{event.duration.round(1)}ms)", GREEN)} #{event.payload[:image]}"
-  end
-
-  def create(event)
-    info "#{color("Docker Create (#{event.duration.round(1)}ms)", MAGENTA)} "\
-      "#{event.payload[:image]} => #{event.payload[:container].id}"
-  end
-
-  def destroy(event)
-    info "#{color("Docker Destroy (#{event.duration.round(1)}ms)", CYAN)} "\
-      "#{event.payload[:container]}"
-  end
-end
-
-Coursemology::Evaluator::Logging::DockerLogSubscriber.attach_to(:'docker.evaluator.coursemology')
+# frozen_string_literal: true
+class Coursemology::Evaluator::Logging::DockerLogSubscriber < ActiveSupport::LogSubscriber
+  def pull(event)
+    info "#{color("Docker Pull (#{event.duration.round(1)}ms)", GREEN)} #{event.payload[:image]}"
+  end
+
+  def create(event)
+    info "#{color("Docker Create (#{event.duration.round(1)}ms)", MAGENTA)} "\
+      "#{event.payload[:image]} => #{event.payload[:container].id}"
+  end
+
+  def destroy(event)
+    info "#{color("Docker Destroy (#{event.duration.round(1)}ms)", CYAN)} "\
+      "#{event.payload[:container]}"
+  end
+end
+
+Coursemology::Evaluator::Logging::DockerLogSubscriber.attach_to(:'docker.evaluator.coursemology')

data/lib/coursemology/evaluator/models.rb

@@ -1,7 +1,7 @@
-# frozen_string_literal: true
-module Coursemology::Evaluator::Models
-  extend ActiveSupport::Autoload
-
-  autoload :Base
-  autoload :ProgrammingEvaluation
-end
+# frozen_string_literal: true
+module Coursemology::Evaluator::Models
+  extend ActiveSupport::Autoload
+
+  autoload :Base
+  autoload :ProgrammingEvaluation
+end

data/lib/coursemology/evaluator/models/base.rb

@@ -1,50 +1,50 @@
-# frozen_string_literal: true
-class Coursemology::Evaluator::Models::Base < Flexirest::Base
-  class << self
-    attr_accessor :api_user_email
-    attr_accessor :api_token
-
-    def initialize
-      Flexirest::Base.perform_caching = false
-      default_config = Flexirest::Base.faraday_config
-      Flexirest::Base.faraday_config do |faraday|
-        # +follow_redirects+ must be added before declaring the adapter. See faraday_middleware#32,
-        # last comment.
-        faraday.response :follow_redirects
-
-        default_config.call(faraday)
-      end
-    end
-  end
-
-  verbose!
-  before_request :add_authentication
-
-  # Sets the key of the model. This is the key that all attributes are nested under, the same as
-  # the +require+ directive in the controller of the web application.
-  #
-  # @param [String] key The key to prefix all attributes with.
-  def self.model_key(key)
-    before_request do |name, param|
-      fix_put_parameters(key, name, param) if [:post, :patch, :put].include?(param.method[:method])
-    end
-  end
-  private_class_method :model_key
-
-  # Fixes the request parameters when executing a POST, PATCH or PUT.
-  #
-  # @param [String] key The key to prefix all attributes with.
-  # @param [Request] param The request parameter to prepend the key with.
-  def self.fix_put_parameters(key, _, param)
-    param.post_params = { key => param.post_params } unless param.post_params.empty?
-  end
-  private_class_method :fix_put_parameters
-
-  private
-
-  # Adds the authentication email and token to the request.
-  def add_authentication(_, request)
-    request.headers['X-User-Email'] = self.class.api_user_email
-    request.headers['X-User-Token'] = self.class.api_token
-  end
-end
+# frozen_string_literal: true
+class Coursemology::Evaluator::Models::Base < Flexirest::Base
+  class << self
+    attr_accessor :api_user_email
+    attr_accessor :api_token
+
+    def initialize
+      Flexirest::Base.perform_caching = false
+      default_config = Flexirest::Base.faraday_config
+      Flexirest::Base.faraday_config do |faraday|
+        # +follow_redirects+ must be added before declaring the adapter. See faraday_middleware#32,
+        # last comment.
+        faraday.response :follow_redirects
+
+        default_config.call(faraday)
+      end
+    end
+  end
+
+  verbose!
+  before_request :add_authentication
+
+  # Sets the key of the model. This is the key that all attributes are nested under, the same as
+  # the +require+ directive in the controller of the web application.
+  #
+  # @param [String] key The key to prefix all attributes with.
+  def self.model_key(key)
+    before_request do |name, param|
+      fix_put_parameters(key, name, param) if [:post, :patch, :put].include?(param.method[:method])
+    end
+  end
+  private_class_method :model_key
+
+  # Fixes the request parameters when executing a POST, PATCH or PUT.
+  #
+  # @param [String] key The key to prefix all attributes with.
+  # @param [Request] param The request parameter to prepend the key with.
+  def self.fix_put_parameters(key, _, param)
+    param.post_params = { key => param.post_params } unless param.post_params.empty?
+  end
+  private_class_method :fix_put_parameters
+
+  private
+
+  # Adds the authentication email and token to the request.
+  def add_authentication(_, request)
+    request.headers['X-User-Email'] = self.class.api_user_email
+    request.headers['X-User-Token'] = self.class.api_token
+  end
+end

data/lib/coursemology/evaluator/models/programming_evaluation.rb

@@ -1,67 +1,55 @@
-# frozen_string_literal: true
-class Coursemology::Evaluator::Models::ProgrammingEvaluation < Coursemology::Evaluator::Models::Base
-  extend ActiveSupport::Autoload
-  autoload :Package
-
-  request_body_type :json
-  model_key :programming_evaluation
-
-  get :find, 'courses/assessment/programming_evaluations/:id'.freeze
-  post :allocate, 'courses/assessment/programming_evaluations/allocate'.freeze
-  put :save, 'courses/assessment/programming_evaluations/:id/result'.freeze
-
-  # Gets the language for the programming evaluation.
-  #
-  # @return [nil] If the language does not exist.
-  # @return [Coursemology::Polyglot::Language] The language that the evaluation uses.
-  def language
-    Coursemology::Polyglot::Language.find_by(type: super)
-  end
-
-  # Sets the language for the programming evaluation.
-  #
-  # @param [String|nil|Coursemology::Polyglot::Language] language The language to set. If this is
-  #   a string, it is assumed to be the class name of the language.
-  def language=(language)
-    return super(language) if language.nil? || language.is_a?(String)
-
-    fail ArgumentError unless language.is_a?(Coursemology::Polyglot::Language)
-    super(language.class.name)
-  end
-
-  # Obtains the package.
-  #
-  # @return [Coursemology::Evaluator::Models::ProgrammingEvaluation::Package]
-  def package
-    @package ||= begin
-      body = plain_request('courses/assessment/programming_evaluations/:id/package', id: id)
-      Package.new(Coursemology::Evaluator::StringIO.new(body))
-    end
-  end
-
-  # Evaluates the package, and stores the result in this record.
-  #
-  # Call {Coursemology::Evaluator::Models::ProgrammingEvaluation#save} to save the record to the
-  # server.
-  def evaluate
-    result = Coursemology::Evaluator::Services::EvaluateProgrammingPackageService.
-             execute(self)
-    self.stdout = result.stdout
-    self.stderr = result.stderr
-    self.test_report = result.test_report
-    self.exit_code = result.exit_code
-  end
-
-  private
-
-  # Performs a plain request.
-  #
-  # @param [String] url The URL to request.
-  # @param [Hash] params The parameter to be part of the request.
-  # @return [String] The response body.
-  def plain_request(url, params = {})
-    request = Flexirest::Request.new({ url: url, method: :get, options: { plain: true } },
-                                     self.class)
-    request.call(params)
-  end
-end
+# frozen_string_literal: true
+class Coursemology::Evaluator::Models::ProgrammingEvaluation < Coursemology::Evaluator::Models::Base
+  extend ActiveSupport::Autoload
+  autoload :Package
+
+  request_body_type :json
+  model_key :programming_evaluation
+
+  get :find, 'courses/assessment/programming_evaluations/:id'.freeze
+  post :allocate, 'courses/assessment/programming_evaluations/allocate'.freeze
+  put :save, 'courses/assessment/programming_evaluations/:id/result'.freeze
+
+  # Gets the language for the programming evaluation.
+  #
+  # @return [nil] If the language does not exist.
+  # @return [Coursemology::Polyglot::Language] The language that the evaluation uses.
+  def language
+    Coursemology::Polyglot::Language.find_by(type: super)
+  end
+
+  # Sets the language for the programming evaluation.
+  #
+  # @param [String|nil|Coursemology::Polyglot::Language] language The language to set. If this is
+  #   a string, it is assumed to be the class name of the language.
+  def language=(language)
+    return super(language) if language.nil? || language.is_a?(String)
+
+    fail ArgumentError unless language.is_a?(Coursemology::Polyglot::Language)
+    super(language.class.name)
+  end
+
+  # Obtains the package.
+  #
+  # @return [Coursemology::Evaluator::Models::ProgrammingEvaluation::Package]
+  def package
+    @package ||= begin
+      body = self.class._plain_request('courses/assessment/programming_evaluations/:id/package',
+                                       :get, id: id)
+      Package.new(Coursemology::Evaluator::StringIO.new(body))
+    end
+  end
+
+  # Evaluates the package, and stores the result in this record.
+  #
+  # Call {Coursemology::Evaluator::Models::ProgrammingEvaluation#save} to save the record to the
+  # server.
+  def evaluate
+    result = Coursemology::Evaluator::Services::EvaluateProgrammingPackageService.
+             execute(self)
+    self.stdout = result.stdout
+    self.stderr = result.stderr
+    self.test_report = result.test_report
+    self.exit_code = result.exit_code
+  end
+end