rundeck-ruby 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: c0b2b8b341f0873b0ca2a5f5d38f75dc2ba99d4e
-  data.tar.gz: c03843110188e81e43939b5fe4b737c17c98b095
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTI0YWU4MTIwODllNDgwN2ZkZDgxY2E1NDcwNDk4OWZlMWZmNmM0OQ==
+  data.tar.gz: !binary |-
+    NTJiOGRlMWRhNTNiM2JiNGExOGU2YTYwZTAzMDk3NzdmZTBhMTE0Yg==
 SHA512:
-  metadata.gz: 92f5845c06eb9fde084af309ce89ca4a7aee5386c2f09848e86afa72df74e7ca7a26505c77a5651b9b3a107281bfe6bc9a91713e6da809fccd2fa758f39efaa9
-  data.tar.gz: 789262397ce473570fca1f4821bbcfe581a83295d403771ec3bc432e9573a5bcdb2d00b69c7c0d6a8a3bec879f2962cbd98f16597998912a0a1dfdb900762a81
+  metadata.gz: !binary |-
+    OTUzNmUyY2ExYjlhMTI5ZmRkZWQzNTY3ZTY3NmRlYTdiMGNkOTYzMjExNzM0
+    MDAyZGIzODY2ZWE2NjFjYWI4M2Q2ZDAwZmFhMDYyMGY1MzkyMzIzMDA4MGVh
+    M2M4Yjg1YzQ5MDE5ZWMwNDcxNTAwNDA4YjcxZmJhYmMxNjcwNGQ=
+  data.tar.gz: !binary |-
+    MmI1MTRjZTM1ODQwMjZhZDIzYjczNWExZTc1ZWM2ZTZkYmE3Yjk3NTk5ODVk
+    NDY5N2IwMTI1Y2RhMDQ3MmI0OWEwNWUzMGI2MmIzNTFjOTQ5MTQ5MjE5NjYz
+    MGMyNmY4ZDk4OWQ2YzZkNzFhMzBhOGI4OTExZmMyNGVkMTc2YWQ=

data/README.md

@@ -1,3 +1,5 @@
+[![Gem Version](https://badge.fury.io/rb/rundeck-ruby.svg)](http://badge.fury.io/rb/rundeck-ruby)
+
 # Rundeck-ruby
 
 Like the name says, these are ruby bindings for the rundeck API
@@ -154,6 +156,8 @@ hostnames to log entries, which will be self-explanatory
 
 ## Contributing
 
+[![Code Climate](https://codeclimate.com/github/jonp/rundeck-ruby.png)](https://codeclimate.com/github/jonp/rundeck-ruby)
+
 The usual boilerplate:
 
 1. Fork it
@@ -180,4 +184,6 @@ rundeck exec -tail ...the other parameters...
 ```
 
 * Running ad-hoc commands, both in irb and with the binstub
-
+* Unit tests. While normally more of a TDDer than most, I find writing
+  tests for API wrappers tedious at best. It should probably be done,
+though.

data/lib/rundeck-ruby/execution.rb

@@ -1,4 +1,22 @@
 module Rundeck
+  class ExecutionTimeout < StandardError
+    def initialize(execution)
+      super("Timed out while waiting for execution #{execution.url} to complete")
+    end
+  end
+
+  class ExecutionFailure < StandardError
+    def initialize(execution)
+      super("Execution #{execution.url} failed")
+    end
+  end
+
+  class APIFailure < StandardError
+    def initialize(call, status)
+      super("The call to #{call} failed with result #{result}")
+    end
+  end
+
   class Execution
     def self.from_hash(session, hash)
       job = Job.from_hash(session, hash['job'])
@@ -30,7 +48,7 @@ module Rundeck
     end
 
     def self.where(project)
-      qb = QueryBuilder.new
+      qb = SearchQueryBuilder.new
       yield qb if block_given?
 
       endpoint = "api/5/executions?project=#{project.name}#{qb.query}"
@@ -41,9 +59,10 @@ module Rundeck
     end
 
     def output
-      ret = session.get("api/9/execution/#{id}/output")
+      path = "api/9/execution/#{id}/output"
+      ret = session.get(path)
       result = ret['result']
-      raise "API call not successful" unless result && result['success']=='true'
+      raise APIFailure.new(path, result) unless result && result['success']=='true'
 
       #sort the output by node
       ret = result['output'].slice(*%w(id completed hasFailedNodes))
@@ -51,17 +70,36 @@ module Rundeck
       ret
     end
 
-    class QueryBuilder
+    def wait_for_complete(poll_interval, timeout)
+      Timeout.timeout(timeout) do
+        while (cur = self.class.find(session, id)).status != :succeeded
+          raise ExecutionFailure.new(self) if cur.status == :failed
+          sleep(poll_interval)
+        end
+      end
+    rescue Timeout::Error
+      raise ExecutionTimeout.new(self)
+    end
+
+    class SearchQueryBuilder
       attr_accessor :status, :max, :offset
 
+      class ValidationError < StandardError
+        def initialize(field, value, message=nil)
+          msg = "Invalid #{field}: #{value}"
+          msg += message unless message==nil
+          super(msg)
+        end
+      end
+
       def self.valid_statuses
         %w(succeeded failed aborted running) << nil
       end
 
       def validate
-        raise "Invalid requested status: #{status}" unless status.nil? || elf.class.valid_statuses.include?(status.to_s)
-        raise "Invalid offset: #{offset}" unless offset.nil? || offset.to_i >= 0
-        raise "Invalid max: #{max}" unless max.nil? || max.to_i >= 0
+        raise ValidationError.new("requested status", status) unless status.nil? || self.class.valid_statuses.include?(status.to_s)
+        raise ValidationError.new("offset", offset) unless offset.nil? || offset.to_i >= 0
+        raise ValidationError.new("max", max) unless max.nil? || max.to_i >= 0
       end
 
       def query

data/lib/rundeck-ruby/job.rb

@@ -46,10 +46,18 @@ module Rundeck
         Execution::QueryBuilder.valid_statuses
       end
 
+      class ValidationError < StandardError
+        def initialize(field, value, message=nil)
+          msg = "Invalid #{field}: #{value}"
+          msg += message unless message==nil
+          super(msg)
+        end
+      end
+
       def validate
-        raise "Invalid requested status: #{status}" unless status.nil? || self.class.valid_statuses.include?(status.to_s)
-        raise "Invalid offset" unless offset.nil? || offset.to_i >= 0
-        raise "Invalid max" unless max.nil? || max.to_i >= 0
+        raise ValidationError.new("status", status) unless status.nil? || self.class.valid_statuses.include?(status.to_s)
+        raise ValidationError.new("offset", offset) unless offset.nil? || offset.to_i >= 0
+        raise ValidationError.new("max", max) unless max.nil? || max.to_i >= 0
       end
 
       def query

data/lib/rundeck-ruby/project.rb

@@ -26,5 +26,55 @@ module Rundeck
     def job(id)
       jobs.first{|j| j.id == id}
     end
+
+    def resources
+      qb = ResourceQueryBuilder.new
+
+      yield qb if block_given?
+
+      endpoint = "api/3/resources?project=#{name}&#{qb.query}"
+      pp endpoint
+
+      session.get(endpoint, 'project', 'node')
+    end
+
+    def resource(resource_name)
+      session.get("api/1/resource/#{resource_name}?project=#{name}", 'project', 'node')
+    end
+
+    class ResourceQueryBuilder
+      def self.fields
+        [:name, :hostname, :tags, :os_arch, :os_family, :os_name, :os_version]
+      end
+
+      def self.exclude_name(f)
+        "exclude_#{f}".to_sym
+      end
+
+      attr_accessor :precedence
+
+      fields.each do |f|
+        attr_accessor f, exclude_name(f)
+      end
+
+      def clause(field)
+        val = send(field)
+        return nil unless val
+        name = field.to_s.gsub('_', '-')
+        "#{name}=#{val}"
+      end
+
+      def query
+        clauses = self.class.fields.map do |f|
+          [
+            clause(f),
+            clause(self.class.exclude_name(f))
+          ]
+        end
+
+        clauses << "exclude-precedence=#{precedence==:exclude ? true : false}" if precedence
+        clauses.flatten.compact.join('&')
+      end
+    end
   end
 end

data/lib/rundeck-ruby/version.rb

@@ -1,3 +1,3 @@
 module Rundeck
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/rundeck-ruby.gemspec

@@ -27,4 +27,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "pry"
 end

metadata

@@ -1,113 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: rundeck-ruby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Jon Phillips
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2014-04-26 00:00:00.000000000 Z
+date: 2015-08-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.6'
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: json
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: activesupport
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '3.0'
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: i18n
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.6'
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: naught
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: bundler
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '1.3'
-  prerelease: false
-  type: :development
 - !ruby/object:Gem::Dependency
   name: rake
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
-  requirement: !ruby/object:Gem::Requirement
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '10.0'
-  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
 description: Ruby client for Rundeck API
 email:
 - jphillips@biaprotect.com
@@ -134,24 +148,24 @@ homepage: https://github.com/jonp/rundeck-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+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:
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
 specification_version: 4
 summary: For talking to Rundeck
 test_files: []