g5-jobbing 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55652a2298d944b826ddea6b131b8f274361764a
+  data.tar.gz: 2282b5b732157ec4c93e7eebaecc501ee2b0ba81
+SHA512:
+  metadata.gz: cac1729f614604cd32927778b448d1b838f4b48363209a29d0a0d69f488675be5436eaae5185ef113ee6766c43035e77ff53cd3fa7232cad142ab0ba193c40ed
+  data.tar.gz: dadda9985bea16ea44eee5888ec31c81cf72cc19e9e5a92bde10b638ba6e62404fc1114a0855f110091d56784c6d170a039f571fe5dab82b44ead37703e32fb0

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.ruby-version

@@ -0,0 +1 @@
+2.1.4

data/.travis.yml

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Perry Hertler
+
+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,31 @@
+# G5::Jobbing
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'g5-jobbing'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install g5-jobbing
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/g5-jobbing/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

data/Rakefile

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

data/g5-jobbing.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'g5/jobbing/version'
+
+Gem::Specification.new do |spec|
+  spec.name        = "g5-jobbing"
+  spec.version     = G5::Jobbing::VERSION
+  spec.authors     = ["Perry Hertler"]
+  spec.email       = ["perry@hertler.org"]
+  spec.summary     = %q{Uses the g5-jobs service to manage and organize jobs.}
+  spec.description = %q{Uses the g5-jobs service to manage and organize jobs.}
+  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_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", ">= 3.1"
+  spec.add_development_dependency "rspec-its"
+  spec.add_development_dependency "pry-nav"
+
+  spec.add_dependency "activesupport"
+  spec.add_dependency "httparty"
+  spec.add_dependency "virtus"
+  spec.add_dependency "g5_authentication_client", ">= 0.2"
+end
+

data/lib/g5/jobbing/access_token.rb

@@ -0,0 +1,5 @@
+module G5::Jobbing::AccessToken
+  def get_access_token
+    @access_token ||= G5AuthenticationClient::Client.new.get_access_token
+  end
+end

data/lib/g5/jobbing/job.rb

@@ -0,0 +1,20 @@
+class G5::Jobbing::Job
+  include Virtus.model
+
+  attribute :uid, String
+  attribute :urn, String
+  attribute :state, String
+  attribute :created_at, DateTime
+  attribute :updated_at, DateTime
+  attribute :integration_setting_uid, String
+  attribute :message, String
+
+  def logs_url
+    return 'ENV[LOGS_BY_JOB_URL] not set!' if logs_by_job_url.blank?
+    logs_by_job_url.gsub('{{JOB_ID}}', "#{self.urn}")
+  end
+
+  def logs_by_job_url
+    ENV['LOGS_BY_JOB_URL']
+  end
+end

data/lib/g5/jobbing/job_retriever.rb

@@ -0,0 +1,24 @@
+class G5::Jobbing::JobRetriever
+  include G5::Jobbing::AccessToken
+  attr_accessor :locations_integration_setting_uids
+
+  def initialize(params={})
+    self.locations_integration_setting_uids = params[:locations_integration_setting_uids]
+  end
+
+  def perform
+    response = HTTParty.get(jobs_url_for_locations,
+                            {query:   {access_token: get_access_token},
+                             headers: {'Content-Type' => 'application/json', 'Accept' => 'application/json'}}
+    )
+    JSON.parse(response.body)['jobs'].collect { |job_hash| G5::Jobbing::Job.new(job_hash) }
+  end
+
+  def jobs_url_for_locations
+    "#{ENV['JOBS_URL']}/api/v1/jobs?current=true&integration_setting_uid=#{CGI.escape(locations_as_parameter)}"
+  end
+
+  def locations_as_parameter
+    "[#{self.locations_integration_setting_uids.join(',')}]"
+  end
+end

data/lib/g5/jobbing/job_starter.rb

@@ -0,0 +1,20 @@
+class G5::Jobbing::JobStarter
+  include G5::Jobbing::AccessToken
+  attr_accessor :locations_integration_setting_uid
+
+  def initialize(params={})
+    self.locations_integration_setting_uid = params[:locations_integration_setting_uid]
+  end
+
+  def perform
+    response = HTTParty.post(start_job_url,
+                             {query:   {access_token: get_access_token},
+                              headers: {'Content-Type' => 'application/json', 'Accept' => 'application/json'}}
+    )
+    201 == response.code
+  end
+
+  def start_job_url
+    "#{ENV['JOBS_URL']}/api/v1/job_runners?integration_setting_uid=#{CGI.escape(self.locations_integration_setting_uid)}"
+  end
+end

data/lib/g5/jobbing/version.rb

@@ -0,0 +1,5 @@
+module G5
+  module Jobbing
+    VERSION = "0.0.1"
+  end
+end

data/lib/g5/jobbing.rb

@@ -0,0 +1,16 @@
+require 'active_support/core_ext/object/blank'
+require 'g5/jobbing/version'
+require 'g5_authentication_client'
+require 'httparty'
+require 'virtus'
+
+module G5
+  module Jobbing
+
+  end
+end
+
+require 'g5/jobbing/access_token'
+require 'g5/jobbing/job'
+require 'g5/jobbing/job_retriever'
+require 'g5/jobbing/job_starter'

data/spec/fixtures/jobs.json

@@ -0,0 +1,20 @@
+{"jobs": [
+    {
+        "uid": "http://localhost:5778/api/v1/jobs/g5-job-6i4h4jo",
+        "urn": "g5-job-6i4h4jo",
+        "state": "started",
+        "created_at": "2014-11-10T14:57:49.216-08:00",
+        "updated_at": "2014-11-10T15:12:23.111-08:00",
+        "integration_setting_uid": "http://localhost/clients/g5-c-6i4h3un-ethan-bode/locations/g5-cl-6i4h3uo-zoe-krajcik/locations_integration_settings/g5-lis-6i4h3uo",
+        "message": null
+    },
+    {
+        "uid": "http://localhost:5778/api/v1/jobs/g5-job-6i4h4bb",
+        "urn": "g5-job-6i4h4bb",
+        "state": "started",
+        "created_at": "2014-11-10T14:57:19.546-08:00",
+        "updated_at": "2014-11-10T15:12:23.103-08:00",
+        "integration_setting_uid": "http://localhost/clients/g5-c-6i4h3un-ethan-bode/locations/g5-cl-6i4h3un-retha-hane/locations_integration_settings/g5-lis-6i4h3un",
+        "message": null
+    }
+]}

data/spec/lib/g5/jobbing/job_retriever_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+describe G5::Jobbing::JobRetriever do
+  let!(:locations_integration_setting_uid_1) { 'uid1' }
+  let!(:locations_integration_setting_uid_2) { 'uid2' }
+
+  subject { G5::Jobbing::JobRetriever.new(locations_integration_setting_uids: [locations_integration_setting_uid_1, locations_integration_setting_uid_2]) }
+
+  describe :perform do
+    let(:body) { fixture('jobs.json') }
+    let(:body_hash) { JSON.parse(body)[:jobs] }
+    let(:token) { 'the toke' }
+    before do
+      expect(G5AuthenticationClient::Client).to receive(:new).and_return(double(:token, get_access_token: token))
+      expect(HTTParty).to receive(:get).with(subject.jobs_url_for_locations,
+                                             {query:   {access_token: token},
+                                              headers: {'Content-Type' => 'application/json', 'Accept' => 'application/json'}}).
+                              and_return(double(:response, body: body))
+    end
+    it 'returns array of jobs' do
+      result = subject.perform
+      expect(result.length).to eq(2)
+      expect(result.all? { |job| G5::Jobbing::Job == job.class }).to be_truthy
+      expect(result.collect(&:integration_setting_uid)).to eq(%w(http://localhost/clients/g5-c-6i4h3un-ethan-bode/locations/g5-cl-6i4h3uo-zoe-krajcik/locations_integration_settings/g5-lis-6i4h3uo http://localhost/clients/g5-c-6i4h3un-ethan-bode/locations/g5-cl-6i4h3un-retha-hane/locations_integration_settings/g5-lis-6i4h3un))
+    end
+  end
+
+  its (:locations_as_parameter) { is_expected.to eq("[#{locations_integration_setting_uid_1},#{locations_integration_setting_uid_2}]") }
+
+  describe :jobs_url_for_locations do
+    it 'filters by current and locations_integration_setting UIDs' do
+      expect(subject).to receive(:locations_as_parameter).and_return('loc_param')
+      expect(subject.jobs_url_for_locations).to match(/\/api\/v1\/jobs\?current=true&integration_setting_uid=loc_param/)
+    end
+  end
+end

data/spec/lib/g5/jobbing/job_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe G5::Jobbing::Job do
+  let(:uid) { 'uid' }
+  let(:urn) { 'urn' }
+  let(:state) { 'state' }
+  let(:integration_setting_uid) { 'isuid' }
+  let(:message) { 'message' }
+  let(:created_at) { DateTime.new(2012, 11, 11) }
+  let(:updated_at) { DateTime.new(2013, 10, 10) }
+
+  subject { G5::Jobbing::Job.new(uid:                     uid, urn: urn, state: state,
+                                 integration_setting_uid: integration_setting_uid,
+                                 message:                 message, created_at: created_at, updated_at: updated_at) }
+
+  its(:uid) { is_expected.to eq(uid) }
+  its(:urn) { is_expected.to eq(urn) }
+  its(:state) { is_expected.to eq(state) }
+  its(:integration_setting_uid) { is_expected.to eq(integration_setting_uid) }
+  its(:message) { is_expected.to eq(message) }
+  its(:created_at) { is_expected.to eq(created_at) }
+  its(:updated_at) { is_expected.to eq(updated_at) }
+
+  describe 'logs_url' do
+    subject { G5::Jobbing::Job.new(urn: 3) }
+
+    context 'LOGS_BY_JOB_URL set' do
+      it 'generates proper url' do
+        expect(subject).to receive(:logs_by_job_url).at_least(:once).and_return('http://splunk.com?external_id={{JOB_ID}}')
+        expect(subject.logs_url).to eq('http://splunk.com?external_id=3')
+      end
+    end
+
+    context 'LOGS_BY_JOB_URL NOT set' do
+      it 'generates proper url' do
+        expect(subject).to receive(:logs_by_job_url).and_return(nil)
+        expect(subject.logs_url).to eq('ENV[LOGS_BY_JOB_URL] not set!')
+      end
+    end
+  end
+end

data/spec/lib/g5/jobbing/job_starter_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe G5::Jobbing::JobStarter do
+  let(:locations_integration_setting_uid) { 'a-uid' }
+  let(:token) { 'the toke' }
+  subject { G5::Jobbing::JobStarter.new(locations_integration_setting_uid: locations_integration_setting_uid) }
+
+  describe :perform do
+    before do
+      expect(G5AuthenticationClient::Client).to receive(:new).and_return(double(:token, get_access_token: token))
+      expect(HTTParty).to receive(:post).with(subject.start_job_url,
+                                              {query:   {access_token: token},
+                                               headers: {'Content-Type' => 'application/json', 'Accept' => 'application/json'}}).
+                              and_return(double(:response, code: code))
+    end
+    describe 'success' do
+      let(:code) { 201 }
+      its(:perform) { is_expected.to be_truthy }
+    end
+
+    describe 'failure' do
+      let(:code) { 404 }
+      its(:perform) { is_expected.to be_falsey }
+    end
+  end
+
+  its(:start_job_url) { is_expected.to match(/\/api\/v1\/job_runners\?integration_setting_uid=/) }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'g5/jobbing'
+require 'pry'
+require 'rspec/its'
+
+module FixturesHelper
+  def fixture(fixture_path)
+    open(File.join("spec", "fixtures", fixture_path)).read
+  end
+end
+
+RSpec.configure do |config|
+  config.include FixturesHelper
+end

metadata

@@ -0,0 +1,194 @@
+--- !ruby/object:Gem::Specification
+name: g5-jobbing
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Perry Hertler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: g5_authentication_client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Uses the g5-jobs service to manage and organize jobs.
+email:
+- perry@hertler.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- g5-jobbing.gemspec
+- lib/g5/jobbing.rb
+- lib/g5/jobbing/access_token.rb
+- lib/g5/jobbing/job.rb
+- lib/g5/jobbing/job_retriever.rb
+- lib/g5/jobbing/job_starter.rb
+- lib/g5/jobbing/version.rb
+- spec/fixtures/jobs.json
+- spec/lib/g5/jobbing/job_retriever_spec.rb
+- spec/lib/g5/jobbing/job_spec.rb
+- spec/lib/g5/jobbing/job_starter_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.2
+signing_key: 
+specification_version: 4
+summary: Uses the g5-jobs service to manage and organize jobs.
+test_files:
+- spec/fixtures/jobs.json
+- spec/lib/g5/jobbing/job_retriever_spec.rb
+- spec/lib/g5/jobbing/job_spec.rb
+- spec/lib/g5/jobbing/job_starter_spec.rb
+- spec/spec_helper.rb