rundeck 0.0.1.pre

data/lib/rundeck/configuration.rb

@@ -0,0 +1,42 @@
+module Rundeck
+  # Defines constants and methods related to configuration.
+  module Configuration
+    # An array of valid keys in the options hash when configuring a Rundeck::API.
+    VALID_OPTIONS_KEYS = [:endpoint, :api_token, :user_agent].freeze
+
+    # The user agent that will be sent to the API endpoint if none is set.
+    DEFAULT_USER_AGENT = "Rundeck Ruby Gem #{Rundeck::VERSION}".freeze
+
+    # @private
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    # Sets all configuration options to their default values
+    # when this module is extended.
+    def self.extended(base)
+      base.reset
+    end
+
+    # Convenience method to allow configuration options to be set in a block.
+    def configure
+      yield self
+    end
+
+    # Creates a hash of options and their values.
+    def options
+      VALID_OPTIONS_KEYS.reduce({}) do |option, key|
+        option.merge!(key => send(key))
+      end
+    end
+
+    def endpoint=(endpoint)
+      @endpoint = "#{endpoint}/api/12"
+    end
+
+    # Resets all configuration options to the defaults.
+    def reset
+      self.endpoint       = ENV['RUNDECK_API_ENDPOINT']
+      self.api_token      = ENV['RUNDECK_API_TOKEN']
+      self.user_agent     = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/rundeck/error.rb

@@ -0,0 +1,45 @@
+module Rundeck
+  module Error
+    # Custom error class for rescuing from all Rundeck errors.
+    class Error < StandardError; end
+
+    # Raise when attributes are missing.
+    class MissingAttributes < Error; end
+
+    # Raise when attributes are invalid.
+    class InvalidAttributes < Error; end
+
+    # Raised when API endpoint credentials not configured.
+    class MissingCredentials < Error; end
+
+    # Raised when impossible to parse response body.
+    class Parsing < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 400.
+    class BadRequest < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 401.
+    class Unauthorized < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 403.
+    class Forbidden < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 404.
+    class NotFound < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 405.
+    class MethodNotAllowed < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 409.
+    class Conflict < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 500.
+    class InternalServerError < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 502.
+    class BadGateway < Error; end
+
+    # Raised when API endpoint returns the HTTP status code 503.
+    class ServiceUnavailable < Error; end
+  end
+end

data/lib/rundeck/objectified_hash.rb

@@ -0,0 +1,24 @@
+module Rundeck
+  # Converts hashes to the objects.
+  class ObjectifiedHash
+    # Creates a new ObjectifiedHash object.
+    def initialize(hash)
+      @hash = hash
+      @data = hash.each_with_object({}) do |(key, value), data|
+        value = ObjectifiedHash.new(value) if value.is_a? Hash
+        data[key.to_s.downcase] = value
+        data
+      end
+    end
+
+    def to_hash
+      @hash
+    end
+    alias_method :to_h, :to_hash
+
+    # Delegate to ObjectifiedHash.
+    def method_missing(key)
+      @data.key?(key.to_s) ? @data[key.to_s] : nil
+    end
+  end
+end

data/lib/rundeck/request.rb

@@ -0,0 +1,93 @@
+require 'httparty'
+require 'libxml'
+
+module Rundeck
+  # @private
+  class Request
+    include HTTParty
+
+    format :xml
+    attr_accessor :api_token
+
+    def get(path, options = {})
+      request_settings(options)
+      validate self.class.get(path, options)
+    end
+
+    def post(path, options = {})
+      request_settings(options, path)
+      validate self.class.post(path, options)
+    end
+
+    def put(path, options = {})
+      request_settings(options)
+      validate self.class.put(path, options)
+    end
+
+    def delete(path, options = {})
+      request_settings(options)
+      validate self.class.delete(path, options)
+    end
+
+    # Checks the response code for common errors.
+    # Returns parsed response for successful requests.
+    def validate(response)
+      case response.code
+      when 400 then fail Error::BadRequest, error_message(response)
+      when 401 then fail Error::Unauthorized, error_message(response)
+      when 403 then fail Error::Forbidden, error_message(response)
+      when 404 then fail Error::NotFound, error_message(response)
+      when 405 then fail Error::MethodNotAllowed, error_message(response)
+      when 409 then fail Error::Conflict, error_message(response)
+      when 500 then fail Error::InternalServerError, error_message(response)
+      when 502 then fail Error::BadGateway, error_message(response)
+      when 503 then fail Error::ServiceUnavailable, error_message(response)
+      end
+
+      response.parsed_response
+    end
+
+    # Sets a base_uri and default_params for requests.
+    # @raise [Error::MissingCredentials] if endpoint not set.
+    def set_request_defaults(endpoint, api_token)
+      unless endpoint
+        fail Error::MissingCredentials, 'Please set an endpoint to API'
+      end
+      @api_token = api_token
+
+      self.class.base_uri endpoint
+    end
+
+    private
+
+    def request_settings(options, path = nil)
+      api_token_header(options, path)
+      accept_header(options)
+    end
+
+    # Sets a PRIVATE-TOKEN header for requests.
+    # @raise [Error::MissingCredentials] if api_token not set.
+    def api_token_header(options, path = nil)
+      return nil if path == '/j_security_check'
+      unless @api_token
+        fail Error::MissingCredentials, 'Please set a api_token for user'
+      end
+      options[:headers] = {} if options[:headers].nil?
+      options[:headers].merge!('X-Rundeck-Auth-Token' => @api_token)
+    end
+
+    def accept_header(options)
+      return nil if options[:headers].nil?
+
+      unless options[:headers].include?('Accept')
+        options[:headers].merge!('Accept' => 'application/xml')
+      end
+    end
+
+    def error_message(response)
+      "Server responded with code #{response.code}, " \
+      "message: #{response.parsed_response['result']['error'][1]['message']}. " \
+      "Request URI: #{response.request.base_uri}#{response.request.path}"
+    end
+  end
+end

data/lib/rundeck/version.rb

@@ -0,0 +1,3 @@
+module Rundeck
+  VERSION = '0.0.1.pre'
+end

data/rundeck.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rundeck/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'rundeck'
+  spec.version       = Rundeck::VERSION
+  spec.authors       = ['Drew A. Blessing']
+  spec.email         = ['drew.blessing@mac.com']
+  spec.description   = 'Ruby client for Rundeck API'
+  spec.summary       = 'A ruby wrapper for the Rundeck API'
+  spec.homepage      = 'https://github.com/dblessing/rundeck'
+  spec.license       = 'BSD-2-Clause'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'libxml-ruby'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.1.0'
+  spec.add_development_dependency 'rspec-core', '~> 3.1.2'
+  spec.add_development_dependency 'rspec-its', '~> 1.0.0'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'guard-rspec', '~> 4.3.0'
+  spec.add_development_dependency 'guard-rubocop'
+end

data/spec/fixtures/job.xml

@@ -0,0 +1,17 @@
+<joblist>
+  <job>
+    <id>c07518ef-b697-4792-9a59-5b4f08855b67</id>
+    <loglevel>INFO</loglevel>
+    <sequence keepgoing='false' strategy='node-first'>
+      <command>
+        <exec>echo 'Hello world!'</exec>
+      </command>
+    </sequence>
+    <description>Well, Hello World</description>
+    <name>Hello World</name>
+    <context>
+      <project>My_Project</project>
+    </context>
+    <uuid>c07518ef-b697-4792-9a59-5b4f08855b67</uuid>
+  </job>
+</joblist>

data/spec/fixtures/job_executions.xml

@@ -0,0 +1,31 @@
+<result success='true' apiversion='12'>
+  <executions count='2'>
+    <execution id='2' href='http://localhost:4440/execution/follow/2' status='aborted' project='My_Project'>
+      <user>admin</user>
+      <date-started unixtime='1409608790308'>2014-09-01T21:59:50Z</date-started>
+      <date-ended unixtime='1409608832192'>2014-09-01T22:00:32Z</date-ended>
+      <abortedby>admin</abortedby>
+      <job id='c07518ef-b697-4792-9a59-5b4f08855b67'>
+        <name>Job 1</name>
+        <group></group>
+        <project>My_Project</project>
+        <description>test</description>
+      </job>
+      <description>echo 'Hello world'</description>
+      <argstring />
+    </execution>
+    <execution id='1' href='http://dc-mb-am-009.bucklehq.com:4440/execution/follow/1' status='success' project='My_Project'>
+      <user>admin</user>
+      <date-started unixtime='1409608610264'>2014-09-01T21:56:50Z</date-started>
+      <date-ended unixtime='1409608781159'>2014-09-01T21:59:41Z</date-ended>
+      <job id='c07518ef-b697-4792-9a59-5b4f08855b67'>
+        <name>Job 1</name>
+        <group></group>
+        <project>My_Project</project>
+        <description>Awesome job 1</description>
+      </job>
+      <description>echo 'Hello world'</description>
+      <argstring />
+    </execution>
+  </executions>
+</result>

data/spec/fixtures/job_run.xml

@@ -0,0 +1,16 @@
+<result success='true' apiversion='12'>
+  <executions count='1'>
+    <execution id='4' href='http://localhost:4440/execution/follow/4' status='running' project='My_Project'>
+      <user>admin</user>
+      <date-started unixtime='1411238010218'>2014-09-20T18:33:30Z</date-started>
+      <job id='2fe8bfbb-d12e-49b5-859b-7472cf1ed3a0' averageDuration='1003'>
+        <name>My_Job</name>
+        <group></group>
+        <project>My_Project</project>
+        <description>This is an awesome job</description>
+      </job>
+      <description>echo "foo"</description>
+      <argstring />
+    </execution>
+  </executions>
+</result>

data/spec/fixtures/jobs_import.xml

@@ -0,0 +1,23 @@
+<result>
+  <succeeded count="1">
+    <job>
+      <id>c07518ef-b697-4792-9a59-5b4f08855b67</id>
+      <loglevel>INFO</loglevel>
+      <sequence keepgoing='false' strategy='node-first'>
+        <command>
+          <exec>echo 'Hello world!'</exec>
+        </command>
+      </sequence>
+      <description>Well, Hello World</description>
+      <name>Hello World</name>
+      <context>
+        <project>My_Project</project>
+      </context>
+      <uuid>c07518ef-b697-4792-9a59-5b4f08855b67</uuid>
+    </job>
+  </succeeded>
+  <failed count="0">
+  </failed>
+  <skipped count="0">
+  </skipped>
+</result>

data/spec/fixtures/jobs_my_project.xml

@@ -0,0 +1,14 @@
+<jobs count='2'>
+  <job id='c07518ef-b697-4792-9a59-5b4f08855b67'>
+    <name>Job 1</name>
+    <group />
+    <project>My_Project</project>
+    <description>My first super awesome project</description>
+  </job>
+  <job id='9c922902-faa6-49cf-aa8d-4de3f5e1d3e1'>
+    <name>Job 2</name>
+    <group>My_Group</group>
+    <project>My_Project</project>
+    <description>My second project</description>
+  </job>
+</jobs>

data/spec/fixtures/jobs_xml.xml

@@ -0,0 +1,32 @@
+<joblist>
+  <job>
+    <id>c07518ef-b697-4792-9a59-5b4f08855b67</id>
+    <loglevel>INFO</loglevel>
+    <sequence keepgoing='false' strategy='node-first'>
+      <command>
+        <exec>echo 'hello world'</exec>
+      </command>
+    </sequence>
+    <description>Hello World</description>
+    <name>hello</name>
+    <context>
+      <project>my_project</project>
+    </context>
+    <uuid>c07518ef-b697-4792-9a59-5b4f08855b67</uuid>
+  </job>
+  <job>
+    <id>9c922902-faa6-49cf-aa8d-4de3f5e1d3e1</id>
+    <loglevel>INFO</loglevel>
+    <sequence keepgoing='false' strategy='node-first'>
+      <command>
+        <exec>echo 'foo'</exec>
+      </command>
+    </sequence>
+    <description>Foo Bar</description>
+    <name>foo</name>
+    <context>
+      <project>my_project</project>
+    </context>
+    <uuid>9c922902-faa6-49cf-aa8d-4de3f5e1d3e1</uuid>
+  </job>
+</joblist>

data/spec/fixtures/jobs_yaml.xml

@@ -0,0 +1,22 @@
+- id: c07518ef-b697-4792-9a59-5b4f08855b67
+  project: Endeca
+  loglevel: INFO
+  sequence:
+    keepgoing: false
+    strategy: node-first
+    commands:
+    - exec: echo 'boom'
+  description: test
+  name: test
+  uuid: c07518ef-b697-4792-9a59-5b4f08855b67
+- id: 9c922902-faa6-49cf-aa8d-4de3f5e1d3e1
+  project: Endeca
+  loglevel: INFO
+  sequence:
+    keepgoing: false
+    strategy: node-first
+    commands:
+    - exec: echo 'boom'
+  description: test
+  name: test
+  uuid: 9c922902-faa6-49cf-aa8d-4de3f5e1d3e1

data/spec/fixtures/key_contents_public.xml

@@ -0,0 +1 @@
+ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDaNirADvOztppFoWeH+fc+5u8zQwRNeiamCXbrcWEK+/fB+Jqf/k1CLlikvp0dt1TKFmQXYJc58ZHv2RRxfe1lMdnv04VDVTE6DoB1jShnv0VL/KN0J+bNm4WLCyJ1NEdhnlZN5nt9U0RkYSG8hcuvREJ5R/5miCCRMSeH4hDmT22v7mV+qZQArRprs1EOE3o25lItefa/c5h85uJMYgnMIMQjT4hhr1JhWg2NdpN08fwS0Bif3JKk3C1YOa3RgW+Wrd0hFQ5iPSBTgmAxWjdgMp1xT4Nw8V8kujiH1jBLfJTXwDgm7csS/Z0H+gORpz6qnkbWKcWVzX3izFLZlxUH user@example.com

data/spec/fixtures/key_private.xml

@@ -0,0 +1,8 @@
+<resource path='keys/path/to/my_key' type='file' url='http://localhost:4440/api/12/storage/keys/path/to/my_key' name='path/to/my_key'>
+  <resource-meta>
+    <Rundeck-content-type>application/octet-stream</Rundeck-content-type>
+    <Rundeck-content-size>1765</Rundeck-content-size>
+    <Rundeck-content-mask>content</Rundeck-content-mask>
+    <Rundeck-key-type>private</Rundeck-key-type>
+  </resource-meta>
+</resource>

data/spec/fixtures/key_public.xml

@@ -0,0 +1,7 @@
+<resource path='keys/key1' type='file' url='http://localhost:4440/api/12/storage/keys/key1' name='key1'>
+  <resource-meta>
+    <Rundeck-content-type>application/pgp-keys</Rundeck-content-type>
+    <Rundeck-content-size>406</Rundeck-content-size>
+    <Rundeck-key-type>public</Rundeck-key-type>
+  </resource-meta>
+</resource>

data/spec/fixtures/keys.xml

@@ -0,0 +1,27 @@
+<resource path='keys' type='directory' url='http://localhost:4440/api/12/storage/keys'>
+  <contents count='4'>
+    <resource path='keys/key1' type='file' url='http://localhost:4440/api/12/storage/keys/key1' name='key1'>
+      <resource-meta>
+        <Rundeck-content-type>application/pgp-keys</Rundeck-content-type>
+        <Rundeck-content-size>406</Rundeck-content-size>
+        <Rundeck-key-type>public</Rundeck-key-type>
+      </resource-meta>
+    </resource>
+    <resource path='keys/key2' type='file' url='http://localhost:4440/api/12/storage/keys/key2' name='key2'>
+      <resource-meta>
+        <Rundeck-content-type>application/octet-stream</Rundeck-content-type>
+        <Rundeck-content-size>1765</Rundeck-content-size>
+        <Rundeck-content-mask>content</Rundeck-content-mask>
+        <Rundeck-key-type>private</Rundeck-key-type>
+      </resource-meta>
+    </resource>
+    <resource path='keys/key3' type='file' url='http://localhost:4440/api/12/storage/keys/key3' name='key3'>
+      <resource-meta>
+        <Rundeck-content-type>application/octet-stream</Rundeck-content-type>
+        <Rundeck-content-size>1765</Rundeck-content-size>
+        <Rundeck-content-mask>content</Rundeck-content-mask>
+        <Rundeck-key-type>private</Rundeck-key-type>
+      </resource-meta>
+    </resource>
+  </contents>
+</resource>