hive-messages 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb04c19fd8b4f3cea97673db617aca170060be64
+  data.tar.gz: 90c9b2c9d5498fe5332ac27b8118e0d83c4acd52
+SHA512:
+  metadata.gz: bbdf1f7d54486cf1248bfa065e63a180500a0f25bc27987ff8e1c8c33954db4702f44c0d38658e87552134e6fe11a2e9fcca7bc4ed7fdb3315313df47d25f5cc
+  data.tar.gz: 1a36c08c3f9bf278d250e6db514e3067ebd3275823667260c4d5062374b1b72d394b74e24eaad373cec16971cfe2c45717a7c530cb6ecdc615949d4ba3591c23

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.idea
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 BBC
+
+MIT License
+
+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,35 @@
+# Hive::Messages
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'hive-messages'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hive-messages
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/hive-messages/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## License
+
+Simple Stats Store is available to everyone under the terms of the MIT open source licence. Take a look at the LICENSE file in the code.
+
+Copyright (c) 2015 BBC

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require 'rake/version_task'
+
+Rake::VersionTask.new do |task|
+  task.with_git_tag = true
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r hive/messages.rb"
+end

data/hive-messages.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "hive-messages"
+  spec.version       = '1.0.1'
+  spec.authors       = ["David Buckhurst", "Paul Carey"]
+  spec.email         = ["david.buckhurst@bbc.co.uk"]
+  spec.summary       = %q{Hive communication library.}
+  spec.description   = %q{Hive Messages, communications between hive components.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "virtus", "~> 1.0"
+  spec.add_dependency "roar", "~> 1.0"
+  spec.add_dependency "activemodel", "~> 4.2"
+  spec.add_dependency "activesupport", "~> 4.2"
+  spec.add_dependency "multipart-post", "~> 2.0"
+  spec.add_dependency "mimemagic", "~> 0.3"
+  spec.add_dependency "multi_json", "~> 1.11"
+
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.4"
+  spec.add_development_dependency "shoulda-matchers", "~> 2.8"
+  spec.add_development_dependency "webmock", "~> 1.21"
+end

data/lib/hive/messages.rb

@@ -0,0 +1,46 @@
+require "virtus"
+require "roar/json"
+require "openssl"
+require "active_model"
+
+require "active_support/version"
+
+if ActiveSupport.version >= Gem::Version.new("4.1")
+  require "active_support/core_ext/object/json"
+else
+  require "active_support/core_ext/object/to_json"
+end
+
+require "roar/transport/net_http/request_patch"
+
+require "hive/paths"
+require "hive/messages/configuration"
+
+require "hive/representers/job_representer"
+require "hive/representers/artifact_representer"
+
+
+require "hive/messages/base"
+require "hive/messages/execution_variables_base"
+require "hive/messages/job"
+require "hive/messages/artifact"
+
+module Hive
+  module Messages
+
+    class << self
+      attr_accessor :configuration
+
+      def root
+        File.expand_path '../../..', __FILE__
+      end
+
+      def configure
+
+        self.configuration = Configuration.new
+        yield(configuration)
+        Hive::Paths.base = self.configuration.base_path
+      end
+    end
+  end
+end

data/lib/hive/messages/artifact.rb

@@ -0,0 +1,17 @@
+
+module Hive
+  module Messages
+    class Artifact < Hive::Messages::Base
+      include Hive::Representers::ArtifactRepresenter
+
+
+      attribute :artifact_id, Integer
+      attribute :job_id, Integer
+      attribute :asset_file_name, String
+      attribute :asset_content_type, String
+      attribute :asset_file_size, Integer
+
+      validates :artifact_id, :job_id, :asset_file_name, :asset_content_type, :asset_file_size, presence: true
+    end
+  end
+end

data/lib/hive/messages/base.rb

@@ -0,0 +1,18 @@
+require 'virtus/attribute/execution_variables'
+require 'roar/json'
+require 'roar/client'
+require 'net/http/post/multipart'
+require 'mimemagic'
+require 'pathname'
+
+module Hive
+  module Messages
+    class Base
+      include Virtus.model
+      include ::ActiveModel::Validations
+      include Roar::JSON
+      include Roar::Client
+
+    end
+  end
+end

data/lib/hive/messages/configuration.rb

@@ -0,0 +1,12 @@
+module Hive
+  module Messages
+
+    class Configuration
+      include Virtus.model
+
+      attribute :base_path, String
+      attribute :pem_file, String
+      attribute :ssl_verify_mode, Integer, default: OpenSSL::SSL::VERIFY_PEER
+    end
+  end
+end

data/lib/hive/messages/execution_variables_base.rb

@@ -0,0 +1,27 @@
+
+module Hive
+  module Messages
+    class ExecutionVariablesBase
+      include Virtus.model
+      include ActiveModel::Validations
+
+      attribute :job_id, Integer
+      attribute :version, String
+      attribute :queue_name, String
+
+      validates :job_id, :version, :queue_name, presence: true
+
+      def self.model_name
+        ActiveModel::Name.new(self, nil, "ExecutionVariables")
+      end
+
+#       def to_s
+# require "pry"; binding.pry
+#       end
+
+#       def to_json(*args)
+# require "pry"; binding.pry
+#       end
+    end
+  end
+end

data/lib/hive/messages/job.rb

@@ -0,0 +1,100 @@
+require 'hive/messages/nil_job'
+
+module Hive
+  module Messages
+    class Job < Hive::Messages::Base
+      include Hive::Representers::JobRepresenter
+
+      attribute :command, String
+      attribute :job_id, Integer
+      attribute :repository, String
+      attribute :execution_directory, String
+      attribute :target, Hash
+      attribute :execution_variables, ExecutionVariables
+      attribute :reservation_details, Hash
+      attribute :device_id, Integer
+      attribute :running_count, Integer
+      attribute :failed_count, Integer
+      attribute :errored_count, Integer
+      attribute :passed_count, Integer
+      attribute :state, String
+      attribute :result, String
+      attribute :exit_value, Integer
+      attribute :message, String
+      attribute :result_details, String
+
+      validates :command, :job_id, presence: true
+
+      class << self
+
+        def reserve(queues, reservation_details)
+          job = self.new
+          job.reservation_details = reservation_details
+          begin
+            job.patch(uri: Hive::Paths::Queues.job_reservation_url(queues), as: "application/json")
+          rescue => e
+            Hive::Messages::NilJob.new(e)
+          end
+        end
+      end
+
+      def prepare(device_id)
+        self.device_id = device_id
+        self.patch(uri: Hive::Paths::Jobs.prepare_url(self.job_id), as: "application/json")
+      end
+
+      def start
+        self.patch(uri: Hive::Paths::Jobs.start_url(self.job_id), as: "application/json")
+      end
+
+      def end(exit_value)
+        self.exit_value = exit_value
+        self.patch(uri: Hive::Paths::Jobs.end_url(self.job_id), as: "application/json")
+      end
+
+      def update_results(details)
+        self.result_details = details[:result_details]
+        counts = details.slice(:running_count, :failed_count, :errored_count, :passed_count)
+        counts.each_pair do |count_key, count_value|
+          self.send("#{count_key}=", count_value)
+        end
+        self.patch(uri: Hive::Paths::Jobs.update_results_url(self.job_id), as: "application/json")
+      end
+
+      def report_artifact(artifact_path)
+        url = URI.parse(Hive::Paths::Artifacts.create_url(self.job_id))
+
+        basename = Pathname.new(artifact_path).basename.to_s
+
+        mime =  MimeMagic.by_path(artifact_path)
+        mime_type = mime ? mime.type : 'text/plain'
+
+        net_http_args = {:use_ssl => url.instance_of?(URI::HTTPS)}
+
+        if Hive::Messages.configuration.pem_file
+          pem = File.read(Hive::Messages.configuration.pem_file)
+          net_http_args[:cert] = OpenSSL::X509::Certificate.new(pem)
+          net_http_args[:key] = OpenSSL::PKey::RSA.new(pem)
+          net_http_args[:verify_mode] = Hive::Messages.configuration.ssl_verify_mode
+        end
+
+        File.open(artifact_path) do |artifact|
+          req = Net::HTTP::Post::Multipart.new url.path, "data" => UploadIO.new(artifact, mime_type, basename)
+          res = Net::HTTP.start(url.host, url.port, net_http_args) do |http|
+            http.request(req)
+          end
+          Hive::Messages::Artifact.new.from_json(res.body)
+        end
+      end
+
+      def complete
+        self.patch(uri: Hive::Paths::Jobs.complete_url(self.job_id), as: "application/json")
+      end
+
+      def error(message)
+        self.message = message
+        self.patch(uri: Hive::Paths::Jobs.error_url(self.job_id), as: "application/json")
+      end
+    end
+  end
+end

data/lib/hive/messages/nil_job.rb

@@ -0,0 +1,15 @@
+module Hive
+  module Messages
+    class NilJob
+      attr_accessor :exception
+
+      def initialize(exception)
+        @message = exception
+      end
+
+      def nil?
+        true
+      end
+    end
+  end
+end

data/lib/hive/paths.rb

@@ -0,0 +1,12 @@
+require "hive/paths/queues"
+require "hive/paths/jobs"
+require "hive/paths/artifacts"
+
+module Hive
+  module Paths
+
+    class << self
+      attr_accessor :base
+    end
+  end
+end

data/lib/hive/paths/artifacts.rb

@@ -0,0 +1,20 @@
+module Hive
+  module Paths
+
+    class Artifacts
+
+      class << self
+
+        def create_url(job_id)
+          "#{Hive::Paths::Jobs.job_base(job_id)}/artifacts"
+        end
+
+        private
+
+        def queues_base
+          "#{Hive::Paths.base}/api/queues"
+        end
+      end
+    end
+  end
+end

data/lib/hive/paths/jobs.rb

@@ -0,0 +1,48 @@
+module Hive
+  module Paths
+
+    class Jobs
+
+      class << self
+
+        def prepare_url(job_id)
+          "#{job_base(job_id)}/prepare"
+        end
+
+        def start_url(job_id)
+          "#{job_base(job_id)}/start"
+        end
+
+        def end_url(job_id)
+          "#{job_base(job_id)}/end"
+        end
+       
+        def update_results_url(job_id)
+          "#{job_base(job_id)}/update_results"
+        end
+
+        def report_artifacts_url(job_id)
+          "#{job_base(job_id)}/report_artifacts"
+        end
+        
+        def complete_url(job_id)
+          "#{job_base(job_id)}/complete"
+        end
+
+        def error_url(job_id)
+          "#{job_base(job_id)}/error"
+        end
+
+        def job_base(job_id)
+          "#{jobs_base}/#{job_id.to_s}"
+        end
+
+        private
+
+        def jobs_base
+          "#{Hive::Paths.base}/api/jobs"
+        end
+      end
+    end
+  end
+end