orchestrator_api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c38a1f1dd4cb1d0fd573379098051f4eabfb8590
+  data.tar.gz: 1400ae44d04625a0e6ef680f8edf3cc0b7b76c01
+SHA512:
+  metadata.gz: 70d8f68a0b2801b5cc3cf850874159ec910ba259a9b71af3ac8cd9f7dd3d154ab9573fdbf248a120ad7385eef25f1811ba166bfbd1e8e890b14e92199340bae1
+  data.tar.gz: ab88fb43301ccb59114b8d10441662163115e2127fe7402654f5330c55039875583d3cf29cb911ca72ef74e21cfe0c633fdd5841dd14e16b5ea4c09dbf06ade5

data/CONTRIBUTING.md

@@ -0,0 +1,46 @@
+# How to contribute
+
+* Make sure you have a [GitHub account](https://github.com/signup/free)
+* Fork the repository on GitHub
+
+## Making Changes
+
+* Create a topic branch from where you want to base your work (this is almost
+definitely the master branch).
+  * To quickly create a topic branch based on master; `git branch
+    fix/master/my_contribution master` then checkout the new branch with `git
+    checkout fix/master/my_contribution`.
+  * Please avoid working directly on the
+    `master` branch.
+* Make commits of logical units.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are in the proper format.
+
+````
+    Make the example in CONTRIBUTING imperative and concrete
+
+    Without this patch applied the example commit message in the CONTRIBUTING
+    document is not a concrete example.  This is a problem because the
+    contributor is left to imagine what the commit message should look like
+    based on a description rather than an example.  This patch fixes the
+    problem by making the example concrete and imperative.
+
+    The first line is a real life imperative statement with a ticket number
+    from our issue tracker.  The body describes the behavior without the patch,
+    why this is a problem, and how the patch fixes the problem when applied.
+````
+
+* Make sure you have added the necessary tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+
+## Submitting Changes
+
+* Sign the [Contributor License Agreement](http://links.puppet.com/cla).
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the repository in the puppetlabs organization.
+
+# Additional Resources
+
+* [Contributor License Agreement](http://links.puppet.com/cla)
+* [General GitHub documentation](http://help.github.com/)
+* [GitHub pull request documentation](http://help.github.com/send-pull-requests/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'rspec'
+gem 'webmock'

data/LICENSE

@@ -0,0 +1,17 @@
+orchestrator_api
+
+Copyright (C) 2016 Puppet Labs Inc
+
+Puppet,Inc. can be contacted at: info@puppet.com
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+    Unless required by applicable law or agreed to in writing, software
+    distributed under the License is distributed on an "AS IS" BASIS,
+    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+    See the License for the specific language governing permissions and
+    limitations under the License.

data/README.md

@@ -0,0 +1,75 @@
+# Orchestrator_api
+
+A simple client for interacting with the Orchestration Services API in Puppet Enterprise
+[Puppet orchestration API](https://docs.puppet.com/pe/latest/api_index.html#puppet-orchestrator-api)
+
+## Compatibility
+
+Currently, this client supports the "V1" endpoints shipped as part of Puppet Enterprise 2016.2.
+
+## Installation
+
+```shell
+gem install orchestrator_api
+```
+
+## Usage
+
+Requires a token with 'Orchestration' permissions. By default the token is
+expected to be at `~/.puppetlabs/token` which is the default location used by
+`puppet-access` when creating token.
+
+### initialization Settings
+
+* `service-url` **[required]** - Base URL for the location of the Orchestrator API service
+* `ca_cert` **[required]** - Path to the CA certificate file needed to verify the SSL connection to the API.
+* `token_path`- Path to a file with the RBAC token in it (defaults to `~/.puppetlabs/token`)
+* `token` - Pass directly the RBAC token, if specified the token will be used instead of a token from file.
+
+### Example
+
+```ruby
+require 'orchestrator_api'
+
+# Create a new client
+# Requires at least a server name and path to the CA certificate
+
+client = Orchestrator_api.new({
+                                'service-url' => 'https://orchestrator.example.lan:8143/orchestrator/v1',
+                                'ca_cert'     => '/path/to/cert'
+                              })
+
+## Access endpoints through the client object
+
+# Get details on all known jobs
+result = client.jobs.all
+
+# Get details on Individual jobs (job "5" in this example)
+client.jobs.details(5)
+
+# Perform an orchestrator deployment
+new_job_details = client.command.deploy('production', {'noop' => true })
+```
+
+## Tests
+
+```shell
+bundle install
+bundle exec rspec
+```
+
+## Issues & Contributions
+
+File issues or feature requests using [GitHub
+issues](https://github.com/puppetlabs/orchestrator_api-ruby/issues).
+
+If you are interested in contributing to this project, please see the
+[Contribution Guidelines](CONTRIBUTING.md)
+
+## Authors
+
+Tom Linkin <tom@puppet.com>
+
+## License
+
+See LICENSE.

data/lib/orchestrator_api.rb

@@ -0,0 +1,94 @@
+require 'net/https'
+require 'uri'
+require 'json'
+require 'openssl'
+
+class Orchestrator_api
+  require 'orchestrator_api/error'
+  require 'orchestrator_api/command'
+  require 'orchestrator_api/jobs'
+  require 'orchestrator_api/environments'
+
+  attr_accessor :config, :token
+
+  def initialize(settings = {})
+
+    @config = { 'token_path'  => File.join(Dir.home, '.puppetlabs', 'token'),
+    }.merge(settings)
+
+    if @config['token']
+      @token = @config['token']
+    else
+      @token = File.read(@config['token_path'])
+    end
+
+    if @config['service-url'].nil?
+      raise "Configuration error: 'service-url' must specify the server running the Orchestration services and cannot be empty"
+    end
+    if @config['ca_cert'].nil?
+      raise "Configuration error: 'ca_cert' must specify a path to the CA certificate used for communications with the server and cannot be empty"
+    end
+  end
+
+  def url
+    config['service-url']
+  end
+
+  def create_http(uri)
+    http = Net::HTTP.new(uri.host, uri.port)
+    http.use_ssl = true
+    http.ssl_version = :TLSv1
+    http.ca_file = config['ca_cert']
+    http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+    http
+  end
+
+  def get(location)
+    uri = URI.parse(location)
+    https = create_http(uri)
+
+    req = Net::HTTP::Get.new(uri.request_uri)
+    req['Content-Type'] = "application/json"
+    req.add_field('X-Authentication', token)
+    res = https.request(req)
+
+    if res.code != "200"
+      raise Orchestrator_api::Error.make_error_from_response(res)
+    end
+
+    JSON.parse(res.body)
+  end
+
+  def post(location, body)
+    uri = URI.parse(location)
+    https = create_http(uri)
+
+    req = Net::HTTP::Post.new(uri.request_uri)
+    req['Content-Type'] = "application/json"
+    req.add_field('X-Authentication', token)
+    req.body = body.to_json
+    res = https.request(req)
+
+    if res.code != "202"
+      raise Orchestrator_api::Error.make_error_from_response(res)
+    end
+
+    JSON.parse(res.body)
+  end
+
+  def command
+    @command ||= Orchestrator_api::Command.new(self, url)
+  end
+
+  def environments
+    @environments ||= Orchestrator_api::Environments.new(self, url)
+  end
+
+  def jobs
+    @jobs ||= Orchestrator_api::Jobs.new(self, url)
+  end
+
+  def root
+    get(url)
+  end
+end

data/lib/orchestrator_api/command.rb

@@ -0,0 +1,18 @@
+class Orchestrator_api::Command
+
+  def initialize(https, api_url_base)
+    @https = https
+    @api_url_base = api_url_base
+  end
+
+  def deploy(environment, options = {})
+    raise ArgumentError, 'Must pass options as a hash' unless options.is_a? Hash
+    options['environment'] = environment
+    @https.post("#{@api_url_base}/command/deploy", options)
+  end
+
+  def stop(job_number)
+    data = {"job" => "#{job_number}"}
+    @https.post("#{@api_url_base}/command/stop",data)
+  end
+end

data/lib/orchestrator_api/environments.rb

@@ -0,0 +1,19 @@
+class Orchestrator_api::Environments
+
+  def initialize(https, api_url_base)
+    @https = https
+    @api_url_base = api_url_base
+  end
+
+  def all
+    @https.get("#{api_url_base}/environments")
+  end
+
+  def applications(id)
+    @https.get("#{api_url_base}/environments/#{id}/applications")
+  end
+
+  def instances(id)
+    @https.get("#{api_url_base}/environments/#{id}/instances")
+  end
+end

data/lib/orchestrator_api/error.rb

@@ -0,0 +1,56 @@
+
+class Orchestrator_api::Error < Exception
+
+  def initialize(data,code)
+    @code = code
+    @kind = data['kind']
+    @details = data['details']
+    super(data['msg'])
+  end
+
+  def self.make_error_from_response(res)
+    begin
+      data = JSON.parse(res.body)
+    rescue
+      return EndpointError.new("An unspecified error has occurred with the Orchestrator API")
+    end
+    code = res.code
+
+    case data['kind']
+    when 'puppetlabs.validators/validation-error'
+      ValidationError.new(data, code)
+    when 'puppetlabs.orchestrator/unknown-job'
+      UnknownJob.new(data, code)
+    when 'puppetlabs.orchestrator/unknown-environment'
+      UnknownEnvironment.new(data, code)
+    when 'puppetlabs.orchestrator/empty-environment'
+      EmptyEnvironment.new(data, code)
+    when 'puppetlabs.orchestrator/empty-target'
+      EmptyTarget.new(data, code)
+    when 'puppetlabs.orchestrator/dependency-cycle'
+      DependencyCycle.new(data, code)
+    when 'puppetlabs.orchestrator/puppetdb-error'
+      PuppetdbError.new(data, code)
+    when 'puppetlabs.orchestrator/query-error'
+      QueryError.new(data, code)
+    when 'puppetlabs.orchestrator/unknown-error'
+      UnknownError.new(data, code)
+    when 'puppetlabs.orchestrator/not-permitted'
+      UnauthorizedError.new(data, code)
+    else
+      EndpointError.new("An unspecified error has occurred with the Orchestrator API")
+    end
+  end
+end
+
+class Orchestrator_api::Error::ValidationError < Orchestrator_api::Error; end
+class Orchestrator_api::Error::UnknownJob < Orchestrator_api::Error; end
+class Orchestrator_api::Error::UnknownEnvironment < Orchestrator_api::Error; end
+class Orchestrator_api::Error::EmptyEnvironment < Orchestrator_api::Error; end
+class Orchestrator_api::Error::EmptyTarget < Orchestrator_api::Error; end
+class Orchestrator_api::Error::DependencyCycle < Orchestrator_api::Error; end
+class Orchestrator_api::Error::PuppetdbError < Orchestrator_api::Error; end
+class Orchestrator_api::Error::QueryError < Orchestrator_api::Error; end
+class Orchestrator_api::Error::UnknownError < Orchestrator_api::Error; end
+class Orchestrator_api::Error::UnauthorizedError < Orchestrator_api::Error; end
+class Orchestrator_api::Error::EndpointError < Exception; end

data/lib/orchestrator_api/jobs.rb

@@ -0,0 +1,37 @@
+class Orchestrator_api::Jobs
+
+  def initialize(http, api_url_base)
+    @https = http
+    @api_url_base = api_url_base
+  end
+
+  def all(limit=nil)
+    url = "#{@api_url_base}/jobs"
+    if limit
+      url << "?limit=#{limit}"
+    end
+
+    @https.get(url)
+  end
+
+  def details(id)
+    @https.get("#{@api_url_base}/jobs/#{id}")
+  end
+
+  def nodes(id)
+    @https.get("#{@api_url_base}/jobs/#{id}/nodes")
+  end
+
+  def report(id)
+    @https.get("#{@api_url_base}/jobs/#{id}/report")
+  end
+
+  def events(id, start = nil)
+    url = "#{@api_url_base}/jobs/#{id}/events"
+    if start
+      url << "?start=#{start}"
+    end
+
+    @https.get(url)
+  end
+end

data/orchestrator_api-ruby.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name          = 'orchestrator_api'
+  s.version       = '0.0.2'
+  s.summary       = "Simple Ruby client library for PE Orchestration Services"
+  s.authors       = "Thomas Linkin"
+  s.email         = 'info@puppet.com'
+  s.files         = `git ls-files`.split($/)
+  s.homepage      = 'https://github.com/puppetlabs/orchestrator_api-ruby'
+  s.license       = "apache"
+  s.require_paths = ["lib"]
+end

data/spec/orchestrator_api_spec.rb

@@ -0,0 +1,67 @@
+require 'spec_helper'
+require_relative '../lib/orchestrator_api'
+
+describe Orchestrator_api do
+
+  before(:all) do
+    config = {
+      'service-url' => 'https://orchestrator.example.lan:8143/orchestrator/v1',
+      'ca_cert'     => '/etc/puppetlabs/puppet/ssl/certs/ca.pem',
+      'token'       => 'myfaketoken'
+    }
+
+    @orchestrator_api = Orchestrator_api.new(config)
+  end
+
+  describe "#newobject" do
+    it "takes a configuration hash and returns a Orchestrator_api object" do
+      expect(@orchestrator_api).to be_an_instance_of Orchestrator_api
+    end
+
+
+    it "has methods with objects that are not nil" do
+      expect(@orchestrator_api.command).to be_truthy
+      expect(@orchestrator_api.jobs).to be_truthy
+      expect(@orchestrator_api.environments).to be_truthy
+    end
+
+    it "complains when a configuration value for 'server' is not provided" do
+      config = {
+        'ca_cert' => '/etc/puppetlabs/puppet/ssl/certs/ca.pem',
+        'token'   => 'myfaketoken'
+      }
+
+      expect{ Orchestrator_api.new(config) }.to raise_error("Configuration error: 'service-url' must specify the server running the Orchestration services and cannot be empty")
+    end
+
+    it "complains when a configuration value for 'ca_certificate_path' is not provided" do
+      config = {
+        'service-url' => 'https://orchestrator.example.lan:8143/orchestrator/v1',
+        'token'       => 'myfaketoken'
+      }
+
+      expect{ Orchestrator_api.new(config) }.to raise_error("Configuration error: 'ca_cert' must specify a path to the CA certificate used for communications with the server and cannot be empty")
+    end
+  end
+
+  describe "#get" do
+    it 'takes an endpoint and parses the response as JSON' do
+      stub_request(:get, "https://orchestrator.example.lan:8143/endpoint").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        to_return(:status => 200, :body => "{}", :headers => {})
+
+      expect(@orchestrator_api.get('https://orchestrator.example.lan:8143/endpoint')).to be_an_instance_of Hash
+    end
+  end
+
+  describe "#post" do
+    it 'takes an endpoint, endpoint, and parses the response as JSON' do
+      stub_request(:post, "https://orchestrator.example.lan:8143/endpoint").
+        with( :body => "{\"data\":\"atad\"}",
+              :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        to_return(:status => 202, :body => "{}", :headers => {})
+
+      expect(@orchestrator_api.post('https://orchestrator.example.lan:8143/endpoint',{'data' => 'atad'})).to be_an_instance_of Hash
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'webmock/rspec'
+require 'orchestrator_api'

data/spec/unit/command_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Orchestrator_api::Command do
+
+  before :each do
+    @url_base = "https://master.puppetlabs.vm:8143/orchestrator/v1"
+
+    config = {
+      'service-url' => 'https://orchestrator.example.lan:8143/orchestrator/v1',
+      'ca_cert'     => '/etc/puppetlabs/puppet/ssl/certs/ca.pem',
+      'token'       => 'myfaketoken'
+    }
+
+    @orchestrator = Orchestrator_api.new(config)
+  end
+
+  describe '#newobject' do
+    it 'takes an orchestrator url and Orchestrator_api object and returns a Orchestrator_api::Command object' do
+      expect(@orchestrator.command).to be_an_instance_of Orchestrator_api::Command
+    end
+  end
+
+  describe '#deploy' do
+    it 'takes an environment and issues a deploy command' do
+      response = "{\n  \"job\" : {\n    \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/1\",\n    \"name\" : \"1\"\n  }\n}"
+
+      stub_request(:post, "https://orchestrator.example.lan:8143/orchestrator/v1/command/deploy").
+        with(:body => "{\"environment\":\"production\"}",
+             :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        to_return(:status => 202, :body => response, :headers => {})
+
+      expect(@orchestrator.command.deploy('production')).to be_an_instance_of Hash
+    end
+
+    it 'takes an environment and hash of additional details' do
+      response = "{\n  \"job\" : {\n    \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/1\",\n    \"name\" : \"1\"\n  }\n}"
+
+      stub_request(:post, "https://orchestrator.example.lan:8143/orchestrator/v1/command/deploy").
+        with(:body => "{\"scope\":{\"nodes\":[\"node1.example.lan\",\"node2.example.lan\"]},\"environment\":\"production\"}",
+             :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        to_return(:status => 202, :body => response, :headers => {})
+
+      details = {
+        'scope' => {
+          'nodes' => ['node1.example.lan','node2.example.lan']
+        }
+      }
+      expect(@orchestrator.command.deploy('production',details)).to be_an_instance_of Hash
+    end
+  end
+
+  describe '#stop' do
+    it 'takes a valid job number and stops the job' do
+      response = "{\n  \"job\" : {\n    \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/1\",\n    \"name\" : \"1\",\n    \"nodes\" : {\n      \"finished\" : 3\n    }\n  }\n}"
+
+      stub_request(:post, "https://orchestrator.example.lan:8143/orchestrator/v1/command/stop").
+        with(:body => "{\"job\":\"1\"}",
+             :headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        to_return(:status => 202, :body => response, :headers => {})
+
+      expect(@orchestrator.command.stop(1)).to be_an_instance_of Hash
+    end
+  end
+end

data/spec/unit/environment_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Orchestrator_api::Environments do
+
+  before :each do
+    config = {
+      'service-url' => 'https://orchestrator.example.lan:8143/orchestrator/v1',
+      'ca_cert'     => '/etc/puppetlabs/puppet/ssl/certs/ca.pem',
+      'token'       => 'myfaketoken'
+    }
+
+    @orchestrator = Orchestrator_api.new(config)
+  end
+
+  describe '#newobject' do
+    it 'takes an orchestrator url and Orchestrator_api object and returns a Orchestrator_api::Environment object' do
+      expect(@orchestrator.environments).to be_an_instance_of Orchestrator_api::Environments
+    end
+  end
+
+  describe '#all' do
+  end
+
+  describe '#applications' do
+  end
+
+  describe '#instances' do
+  end
+end

data/spec/unit/error_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Orchestrator_api::Error do
+
+  it 'is an child class of Exception' do
+    expect(Orchestrator_api::Error).to be <= Exception
+  end
+
+  %w(ValidationError UnknownJob UnknownEnvironment EmptyEnvironment EmptyTarget DependencyCycle PuppetdbError QueryError UnknownError UnauthorizedError).each do |name|
+    describe "::#{name}" do
+      klass = Orchestrator_api::Error.const_get(name)
+      it "should be a child class of Orchestrator_api::Error" do
+        expect(klass).to be <= Orchestrator_api::Error
+      end
+    end
+  end
+
+  describe "::make_error_from_response" do
+    before(:all) do
+      class FakeResponse
+        attr_reader :code, :body
+        def initialize(error)
+          @code = '400'
+          @body = "{\"kind\":\"#{error}\"}"
+        end
+      end
+    end
+
+    %w(
+      puppetlabs.validators/validation-error:ValidationError
+      puppetlabs.orchestrator/unknown-job:UnknownJob
+      puppetlabs.orchestrator/unknown-environment:UnknownEnvironment
+      puppetlabs.orchestrator/empty-target:EmptyTarget
+      puppetlabs.orchestrator/dependency-cycle:DependencyCycle
+      puppetlabs.orchestrator/puppetdb-error:PuppetdbError
+      puppetlabs.orchestrator/query-error:QueryError
+      puppetlabs.orchestrator/unknown-error:UnknownError
+      puppetlabs.orchestrator/not-permitted:UnauthorizedError
+    ).each do |item|
+      error = item.split(':')
+      it "creates an exception based on an \"#{error.first}\" error response from the server" do
+        res = FakeResponse.new(error.first)
+        klass = Orchestrator_api::Error.const_get(error[1])
+        expect( Orchestrator_api::Error.make_error_from_response(res) ).to be_an_instance_of klass
+      end
+    end
+
+    it "creates an Orchestrator_api::Error::EndpointError exception when the response from the server isn't parsable JSON" do
+      res = FakeResponse.new("makesforunparsablejson\"")
+      expect( Orchestrator_api::Error.make_error_from_response(res)).to be_an_instance_of Orchestrator_api::Error::EndpointError
+    end
+
+    it "creates an Orchestrator_api::Error::EndpointError exception when it does not understand the error from the service" do
+      res = FakeResponse.new('notarealerror')
+      expect( Orchestrator_api::Error.make_error_from_response(res)).to be_an_instance_of Orchestrator_api::Error::EndpointError
+    end
+  end
+end

data/spec/unit/jobs_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Orchestrator_api::Jobs do
+
+  before :each do
+    config = {
+      'service-url' => 'https://orchestrator.example.lan:8143/orchestrator/v1',
+      'ca_cert'     => '/etc/puppetlabs/puppet/ssl/certs/ca.pem',
+      'token'       => 'myfaketoken'
+    }
+
+    @orchestrator = Orchestrator_api.new(config)
+  end
+
+  describe '#newobject' do
+    it 'takes an orchestrator url and Orchestrator_api object and returns a Orchestrator_api::Jobs object' do
+      expect(@orchestrator.jobs).to be_an_instance_of Orchestrator_api::Jobs
+    end
+  end
+
+  describe '#all' do
+    response =  "{\n  \"items\" : [ {\n    \"report\" : {\n      \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/58/report\"\n    },\n    \"name\" : \"58\",\n    \"events\" : {\n      \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/58/events\"\n    },\n    \"state\" : \"failed\",\n    \"nodes\" : {\n      \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/58/nodes\"\n    },\n    \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/58\",\n    \"environment\" : {\n      \"name\" : \"production\"\n    },\n    \"options\" : {\n      \"concurrency\" : null,\n      \"noop\" : false,\n      \"trace\" : false,\n      \"debug\" : false,\n      \"scope\" : {\n        \"whole_environment\" : true\n      },\n      \"enforce_environment\" : true,\n      \"environment\" : \"production\",\n      \"evaltrace\" : false,\n      \"target\" : \"whole environment\"\n    },\n    \"timestamp\" : \"2016-09-20T19:01:18Z\",\n    \"owner\" : {\n      \"id\" : \"80f8475c-d8b5-4dfd-b567-3cae4ef7a3a7\",\n      \"login\" : \"tom\"\n    },\n    \"node_count\" : 2\n  } ]\n}"
+
+    it 'optionally accepts a number to limit results' do
+      stub_request(:get, "https://orchestrator.example.lan:8143/orchestrator/v1/jobs?limit=1").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        to_return(:status => 200, :body => response, :headers => {})
+
+      expect(@orchestrator.jobs.all(1)).to be_an_instance_of Hash
+    end
+
+    it 'can return results without a limit' do
+      response =  "{\n  \"items\" : [ {\n    \"report\" : {\n      \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/58/report\"\n    },\n    \"name\" : \"58\",\n    \"events\" : {\n      \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/58/events\"\n    },\n    \"state\" : \"failed\",\n    \"nodes\" : {\n      \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/58/nodes\"\n    },\n    \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/58\",\n    \"environment\" : {\n      \"name\" : \"production\"\n    },\n    \"options\" : {\n      \"concurrency\" : null,\n      \"noop\" : false,\n      \"trace\" : false,\n      \"debug\" : false,\n      \"scope\" : {\n        \"whole_environment\" : true\n      },\n      \"enforce_environment\" : true,\n      \"environment\" : \"production\",\n      \"evaltrace\" : false,\n      \"target\" : \"whole environment\"\n    },\n    \"timestamp\" : \"2016-09-20T19:01:18Z\",\n    \"owner\" : {\n      \"id\" : \"80f8475c-d8b5-4dfd-b567-3cae4ef7a3a7\",\n      \"login\" : \"tom\"\n    },\n    \"node_count\" : 2\n  } ]\n}"
+
+      stub_request(:get, "https://orchestrator.example.lan:8143/orchestrator/v1/jobs").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        to_return(:status => 200, :body => response, :headers => {})
+
+      expect(@orchestrator.jobs.all).to be_an_instance_of Hash
+    end
+  end
+
+  describe '#details' do
+  end
+
+  describe '#nodes' do
+  end
+
+  describe '#report' do
+  end
+
+  describe '#events' do
+    response = "{\n  \"next-events\" : {\n    \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/1/events?start=7\"\n  },\n  \"items\" : [ {\n    \"type\" : \"node_finished\",\n    \"timestamp\" : \"2016-08-15T21:35:26Z\",\n    \"details\" : {\n      \"node\" : \"orchestrator.example.lan\",\n      \"detail\" : {\n        \"hash\" : \"c02e060e07da2a0e3ecdbad0e46a265ca22f433d\",\n        \"noop\" : false,\n        \"status\" : \"unchanged\",\n        \"metrics\" : {\n          \"corrective_change\" : 0,\n          \"out_of_sync\" : 3,\n          \"restarted\" : 0,\n          \"skipped\" : 0,\n          \"total\" : 789,\n          \"changed\" : 0,\n          \"scheduled\" : 0,\n          \"failed_to_restart\" : 0,\n          \"failed\" : 0\n        },\n        \"report-url\" : \"https://orchestrator.example.lan/#/cm/report/c02e060e07da2a0e3ecdbad0e46a265ca22f433d\",\n        \"environment\" : \"production\",\n        \"configuration_version\" : \"1471296883\"\n      }\n    },\n    \"message\" : \"Finished puppet run on orchestrator.example.lan - Success! \",\n    \"id\" : \"6\"\n  } ]\n}"
+
+    it 'takes a job number and accespts a start number to retrieve latest results' do
+      stub_request(:get, "https://orchestrator.example.lan:8143/orchestrator/v1/jobs/1/events?start=10").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        to_return(:status => 200, :body => response, :headers => {})
+
+      expect(@orchestrator.jobs.events(1,10)).to be_an_instance_of Hash
+    end
+    it 'takes a job number but does not need a start number' do
+      response = "{\n  \"next-events\" : {\n    \"id\" : \"https://orchestrator.example.lan:8143/orchestrator/v1/jobs/1/events?start=7\"\n  },\n  \"items\" : [ {\n    \"type\" : \"node_running\",\n    \"timestamp\" : \"2016-08-15T21:34:34Z\",\n    \"details\" : {\n      \"node\" : \"orchestrator.example.lan\",\n      \"detail\" : {\n        \"noop\" : false\n      }\n    },\n    \"message\" : \"Started puppet run on orchestrator.example.lan ...\",\n    \"id\" : \"1\"\n  }, {\n    \"type\" : \"node_running\",\n    \"timestamp\" : \"2016-08-15T21:34:34Z\",\n    \"details\" : {\n      \"node\" : \"agent2.puppetlabs.vm\",\n      \"detail\" : {\n        \"noop\" : false\n      }\n    },\n    \"message\" : \"Started puppet run on agent2.puppetlabs.vm ...\",\n    \"id\" : \"2\"\n  }, {\n    \"type\" : \"node_running\",\n    \"timestamp\" : \"2016-08-15T21:34:34Z\",\n    \"details\" : {\n      \"node\" : \"agent1.puppetlabs.vm\",\n      \"detail\" : {\n        \"noop\" : false\n      }\n    },\n    \"message\" : \"Started puppet run on agent1.puppetlabs.vm ...\",\n    \"id\" : \"3\"\n  }, {\n    \"type\" : \"node_finished\",\n    \"timestamp\" : \"2016-08-15T21:34:47Z\",\n    \"details\" : {\n      \"node\" : \"agent1.puppetlabs.vm\",\n      \"detail\" : {\n        \"hash\" : \"20d60265af8bafc0ac1b99c1eb4b8bde411a81a3\",\n        \"noop\" : false,\n        \"status\" : \"unchanged\",\n        \"metrics\" : {\n          \"corrective_change\" : 0,\n          \"out_of_sync\" : 0,\n          \"restarted\" : 0,\n          \"skipped\" : 0,\n          \"total\" : 171,\n          \"changed\" : 0,\n          \"scheduled\" : 0,\n          \"failed_to_restart\" : 0,\n          \"failed\" : 0\n        },\n        \"report-url\" : \"https://orchestrator.example.lan/#/cm/report/20d60265af8bafc0ac1b99c1eb4b8bde411a81a3\",\n        \"environment\" : \"production\",\n        \"configuration_version\" : \"1471296882\"\n      }\n    },\n    \"message\" : \"Finished puppet run on agent1.puppetlabs.vm - Success! \",\n    \"id\" : \"4\"\n  }, {\n    \"type\" : \"node_finished\",\n    \"timestamp\" : \"2016-08-15T21:34:47Z\",\n    \"details\" : {\n      \"node\" : \"agent2.puppetlabs.vm\",\n      \"detail\" : {\n        \"hash\" : \"d460f0a513b1e18d43f19867b269cf105772fc41\",\n        \"noop\" : false,\n        \"status\" : \"unchanged\",\n        \"metrics\" : {\n          \"corrective_change\" : 0,\n          \"out_of_sync\" : 0,\n          \"restarted\" : 0,\n          \"skipped\" : 0,\n          \"total\" : 171,\n          \"changed\" : 0,\n          \"scheduled\" : 0,\n          \"failed_to_restart\" : 0,\n          \"failed\" : 0\n        },\n        \"report-url\" : \"https://orchestrator.example.lan/#/cm/report/d460f0a513b1e18d43f19867b269cf105772fc41\",\n        \"environment\" : \"production\",\n        \"configuration_version\" : \"1471296882\"\n      }\n    },\n    \"message\" : \"Finished puppet run on agent2.puppetlabs.vm - Success! \",\n    \"id\" : \"5\"\n  }, {\n    \"type\" : \"node_finished\",\n    \"timestamp\" : \"2016-08-15T21:35:26Z\",\n    \"details\" : {\n      \"node\" : \"orchestrator.example.lan\",\n      \"detail\" : {\n        \"hash\" : \"c02e060e07da2a0e3ecdbad0e46a265ca22f433d\",\n        \"noop\" : false,\n        \"status\" : \"unchanged\",\n        \"metrics\" : {\n          \"corrective_change\" : 0,\n          \"out_of_sync\" : 3,\n          \"restarted\" : 0,\n          \"skipped\" : 0,\n          \"total\" : 789,\n          \"changed\" : 0,\n          \"scheduled\" : 0,\n          \"failed_to_restart\" : 0,\n          \"failed\" : 0\n        },\n        \"report-url\" : \"https://orchestrator.example.lan/#/cm/report/c02e060e07da2a0e3ecdbad0e46a265ca22f433d\",\n        \"environment\" : \"production\",\n        \"configuration_version\" : \"1471296883\"\n      }\n    },\n    \"message\" : \"Finished puppet run on orchestrator.example.lan - Success! \",\n    \"id\" : \"6\"\n  } ]\n}"
+
+      stub_request(:get, "https://orchestrator.example.lan:8143/orchestrator/v1/jobs/1/events").
+        with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby', 'X-Authentication'=>'myfaketoken'}).
+        to_return(:status => 200, :body => response, :headers => {})
+
+      expect(@orchestrator.jobs.events(1)).to be_an_instance_of Hash
+    end
+  end
+end
+

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: orchestrator_api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Thomas Linkin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-10-04 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: info@puppet.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE
+- README.md
+- lib/orchestrator_api.rb
+- lib/orchestrator_api/command.rb
+- lib/orchestrator_api/environments.rb
+- lib/orchestrator_api/error.rb
+- lib/orchestrator_api/jobs.rb
+- orchestrator_api-ruby.gemspec
+- spec/orchestrator_api_spec.rb
+- spec/spec_helper.rb
+- spec/unit/command_spec.rb
+- spec/unit/environment_spec.rb
+- spec/unit/error_spec.rb
+- spec/unit/jobs_spec.rb
+homepage: https://github.com/puppetlabs/orchestrator_api-ruby
+licenses:
+- apache
+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.3
+signing_key: 
+specification_version: 4
+summary: Simple Ruby client library for PE Orchestration Services
+test_files: []