rundeck 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff00bf23f1fde03b1f603132d506ae0695e02827
-  data.tar.gz: fb4a1f1a7b74dac64e73e03a5c23d2acdd089d99
+  metadata.gz: 31730efc03d57ef39d030de2aaec177f44d26a4e
+  data.tar.gz: 193d25852a20e7a351760d90e4a9a311e1ed3210
 SHA512:
-  metadata.gz: c51e3995a9bb9ac36d5fe7522e9e98ca6d685b65d6b11b9fbf453c32c34883852976651fedf0fbf85b1fbf70d84291629681fca273ad358bdfc8c224ac57c3d9
-  data.tar.gz: 57094ebfae59988afb663fadda7ae78e0244feda93da93dc77e586dad0f20f08787999ede8de7a73014a7ff211b23eaf427fa1809a2b2ec872eb77eb2cfd9018
+  metadata.gz: 7c0324e4bff89cbc319ad93c102c16927bb76928bd5be58f70679d570eb19d8a87f2ba895f6e2c9e2515d5da23193c065cbfce3d18661b18d85adefd952b8ae3
+  data.tar.gz: 564b902d2ed2f4771495809585e32899d088ed7e289c6219cdbb9fab34d04d77e3efffb958668d34d51e414b6a850ca9af95e60311fe2914b5be701368f9dd3c

data/.rubocop.yml

@@ -15,3 +15,6 @@ Metrics/MethodLength:
 # sense to let the line exceed that length, especially in specs.
 Metrics/LineLength:
   Max: 500
+
+Metrics/AbcSize:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+0.0.4 (November 4, 2014)
+  - First version with a CHANGELOG. Changes from here will be documented.

data/lib/rundeck/api.rb

@@ -9,7 +9,7 @@ module Rundeck
     def initialize(options = {})
       options = Rundeck.options.merge(options)
       Configuration::VALID_OPTIONS_KEYS.each do |key|
-        send("#{key}=", options[key])
+        send("#{key}=", options[key]) if options.key?(key)
       end
       set_request_defaults @endpoint, @api_token
     end

data/lib/rundeck/client.rb

@@ -54,6 +54,7 @@ module Rundeck
     include Execution
     include Job
     include Key
+    include Project
 
     # Turn a hash into an object for easy accessibility.
     #
@@ -68,7 +69,7 @@ module Rundeck
       if result.is_a?(Hash)
         ObjectifiedHash.new(result)
       elsif result.is_a?(Array)
-        result.map! { |e| ObjectifiedHash.new(e) }
+        result.map { |e| ObjectifiedHash.new(e) }
       elsif result.nil?
         nil
       else

data/lib/rundeck/client/execution.rb

@@ -2,6 +2,12 @@ module Rundeck
   class Client
     # Defines methods related to executions.
     module Execution
+      def project_options_query(project, options)
+        options[:query] = {} if options[:query].nil?
+        options[:query]['project'] = project
+        options
+      end
+
       # Execute a job
       #
       # @!macro has_optional_params
@@ -19,7 +25,7 @@ module Rundeck
       # @return [Rundeck::ObjectifiedHash]
       # @!macro exceptions
       def execute_job(id, options = {})
-        objectify post("/job/#{id}/executions", options)['result']['executions']['execution']
+        objectify post("/job/#{id}/executions", options)['result']['executions']
       end
       alias_method :run_job, :execute_job
 
@@ -39,7 +45,7 @@ module Rundeck
       # @return [Rundeck::ObjectifiedHash]
       # @!macro exceptions
       def job_executions(id, options = {})
-        r = get("/job/#{id}/executions", options)['result']['executions']['execution']
+        r = get("/job/#{id}/executions", options)['result']['executions']
         objectify r
       end
 
@@ -55,21 +61,12 @@ module Rundeck
       #
       # @param  [String] project List running executions from this project
       # @!macro options
-      # @return [nil] if no running executions
-      # @return [Rundeck::ObjectifiedHash] if a single running job execution
-      # @return [Array<Rundeck::ObjectifiedHash>] if multiple running job executions
+      # @return [Rundeck::ObjectifiedHash]
       # @!macro exceptions
-      # def running_job_executions(project, options = {})
-      #   options[:query] = {} if options[:query].nil?
-      #   options[:query]['project'] = project
-      #   r = get('/executions/running', options)
-      #
-      #   if objectify(r['result']['executions']).count != '0'
-      #     objectify r['result']['executions']['execution']
-      #   else
-      #     nil
-      #   end
-      # end
+      def running_job_executions(project, options = {})
+        options = project_options_query(project, options)
+        objectify get('/executions/running', options)['result']['executions']
+      end
 
       # Delete all executions for a specific job
       #
@@ -175,12 +172,10 @@ module Rundeck
       #
       # @see http://rundeck.org/docs/api/index.html#execution-query
       #   Rundeck API documentation for 'GET /api/12/executions'
-      # def execution_query(project, options = {})
-      #   options[:query] = {} if options[:query].nil?
-      #   options[:query]['project'] = project
-      #
-      #   objectify get('/executions', options)['result']
-      # end
+      def execution_query(project, options = {})
+        options = project_options_query(project, options)
+        objectify get('/executions', options)['result']['executions']
+      end
 
       # def execution_output()
       #

data/lib/rundeck/client/job.rb

@@ -12,12 +12,13 @@ module Rundeck
       # @return [Array<Rundeck::ObjectifiedHash>]
       # @!macro exceptions
       def jobs(project, options = {})
-        objectify get("/project/#{project}/jobs", options)['jobs']['job']
+        objectify get("/project/#{project}/jobs", options)['jobs']
       end
 
       # Gets a single job by id
       #
-      # @example Rundeck.job('c07518ef-b697-4792-9a59-5b4f08855b67')
+      # @example
+      #   Rundeck.job('c07518ef-b697-4792-9a59-5b4f08855b67')
       #
       # @param  [String] id Job id
       # @!macro options

data/lib/rundeck/client/project.rb

@@ -0,0 +1,84 @@
+module Rundeck
+  class Client
+    # Defines methods related to projects.
+    module Project
+      # Get all projects
+      #
+      # @see http://rundeck.org/docs/api/index.html#listing-projects
+      #   Rundeck API documentation for 'GET /api/1/projects' endpoint
+      #
+      # @example
+      #   Rundeck.projects
+      #
+      # @!macro options
+      # @return [Rundeck::ObjectifiedHash]
+      # @!macro exceptions
+      def projects(options = {})
+        objectify get('/projects', options)['projects']
+      end
+
+      # Create a project
+      #
+      # @see http://rundeck.org/docs/api/index.html#project-creation
+      #   Rundeck API documentation for 'POST /api/11/projects' endpoint
+      #
+      # @example
+      #   @TODO: Example
+      #
+      # @param  [String] content The job definition(s) as yaml or xml
+      # @param  [String] format The project creation format. 'json|xml',
+      #   defaults to 'json'
+      # @!macro options
+      # @return [Rundeck::ObjectifiedHash]
+      # @!macro exceptions
+      def create_project(content, format = 'json', options = {})
+        options[:headers] = {} if options[:headers].nil?
+        options[:headers] = if format == 'json'
+                              options[:headers].merge!(
+                                  'Content-Type' => 'application/json')
+                            elsif format == 'xml'
+                              options[:headers].merge!(
+                                  'Content-Type' => 'application/xml')
+                            else
+                              fail Error::InvalidAttributes,
+                                   'format must be json or xml'
+                            end
+        options[:body] = content
+
+        objectify post('/projects', options)['project']
+      end
+
+      # Get a project by name
+      #
+      # @see http://rundeck.org/docs/api/index.html#getting-project-info
+      #   Rundeck API documentation for 'GET /api/1/project/[NAME]' endpoint
+      #
+      # @example
+      #   Rundeck.project('anvils')
+      #
+      # @param  [String] name The project name
+      # @!macro options
+      # @return [Rundeck::ObjectifiedHash]
+      # @!macro exceptions
+      def project(name, options = {})
+        objectify get("/project/#{name}", options)['project']
+      end
+
+      # Delete a project
+      #
+      # @see http://rundeck.org/docs/api/index.html#project-deletion
+      #   Rundeck API documentation for 'DELETE /api/11/project/[NAME]' endpoint
+      #
+      # @example
+      #   Rundeck.delete_project('my_project')
+      #
+      # @param  [String] name The project name
+      # @!macro options
+      # @return nil
+      # @!macro exceptions
+      def delete_project(name, options = {})
+        objectify delete("/project/#{name}", options)
+      end
+    end
+  end
+end

data/lib/rundeck/objectified_hash.rb

@@ -5,7 +5,13 @@ module Rundeck
     def initialize(hash)
       @hash = hash
       @data = hash.each_with_object({}) do |(key, value), data|
-        value = ObjectifiedHash.new(value) if value.is_a? Hash
+        value = if value.is_a?(Hash)
+                  ObjectifiedHash.new(value)
+                elsif value.is_a?(Array)
+                  value.map { |e| ObjectifiedHash.new(e) }
+                else
+                  value
+                end
         data[key.to_s.downcase] = value
         data
       end

data/lib/rundeck/version.rb

@@ -1,3 +1,3 @@
 module Rundeck
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/rundeck.gemspec

@@ -28,6 +28,7 @@ Gem::Specification.new do |spec|
   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 'rubocop'
   spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'codeclimate-test-reporter'
   spec.add_development_dependency 'guard-rspec', '~> 4.3.0'

data/spec/cassettes/12/create_project_invalid.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://192.168.50.2:4440/api/12/projects
+    body:
+      encoding: UTF-8
+      string: '{ "name": "anvils" }'
+    headers:
+      Content-Type:
+      - application/json
+      X-Rundeck-Auth-Token:
+      - cmJQYoy9EAsSd0905yNjKDNGs0ESIwEd
+      Accept:
+      - application/xml
+  response:
+    status:
+      code: 409
+      message: Conflict
+    headers:
+      Set-Cookie:
+      - JSESSIONID=urdzotmxs4xr1i958fa3gzya0;Path=/
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Content-Type:
+      - text/xml;charset=UTF-8
+      X-Rundeck-Api-Version:
+      - '12'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(7.6.0.v20120127)
+    body:
+      encoding: UTF-8
+      string: |-
+        <result error='true' apiversion='12'>
+          <error code='api.error.item.alreadyexists'>
+            <message>project already exists: anvils</message>
+          </error>
+        </result>
+    http_version: 
+  recorded_at: Mon, 03 Nov 2014 18:56:26 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/12/create_project_json.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://192.168.50.2:4440/api/12/projects
+    body:
+      encoding: UTF-8
+      string: '{ "name": "json_project" }'
+    headers:
+      Content-Type:
+      - application/json
+      X-Rundeck-Auth-Token:
+      - cmJQYoy9EAsSd0905yNjKDNGs0ESIwEd
+      Accept:
+      - application/xml
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Set-Cookie:
+      - JSESSIONID=mtleb8x2y6qpqxb2a3vdup22;Path=/
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      X-Rundeck-Api-Xml-Response-Wrapper:
+      - 'false'
+      Content-Type:
+      - application/xml;charset=UTF-8
+      X-Rundeck-Api-Version:
+      - '12'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(7.6.0.v20120127)
+    body:
+      encoding: UTF-8
+      string: |-
+        <project url='http://192.168.50.2:4440/api/12/project/json_project'>
+          <name>json_project</name>
+          <description></description>
+          <config>
+            <property key='project.name' value='json_project' />
+            <property key='project.ssh-authentication' value='privateKey' />
+            <property key='service.NodeExecutor.default.provider' value='jsch-ssh' />
+            <property key='resources.source.1.config.includeServerNode' value='true' />
+            <property key='resources.source.1.config.generateFileAutomatically' value='true' />
+            <property key='resources.source.1.config.file' value='/var/rundeck/projects/json_project/etc/resources.xml' />
+            <property key='project.ssh-keypath' value='/var/lib/rundeck/.ssh/id_rsa' />
+            <property key='service.FileCopier.default.provider' value='jsch-scp' />
+            <property key='resources.source.1.type' value='file' />
+          </config>
+        </project>
+    http_version: 
+  recorded_at: Mon, 03 Nov 2014 18:50:21 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/12/create_project_xml.yml

@@ -0,0 +1,58 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://192.168.50.2:4440/api/12/projects
+    body:
+      encoding: UTF-8
+      string: |
+        <project>
+          <name>xml_project</name>
+        </project>
+    headers:
+      Content-Type:
+      - application/xml
+      X-Rundeck-Auth-Token:
+      - cmJQYoy9EAsSd0905yNjKDNGs0ESIwEd
+      Accept:
+      - application/xml
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Set-Cookie:
+      - JSESSIONID=1bj2k8scmc7jvll68akb8nm9s;Path=/
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      X-Rundeck-Api-Xml-Response-Wrapper:
+      - 'false'
+      Content-Type:
+      - application/xml;charset=UTF-8
+      X-Rundeck-Api-Version:
+      - '12'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(7.6.0.v20120127)
+    body:
+      encoding: UTF-8
+      string: |-
+        <project url='http://192.168.50.2:4440/api/12/project/xml_project'>
+          <name>xml_project</name>
+          <description></description>
+          <config>
+            <property key='project.name' value='xml_project' />
+            <property key='project.ssh-authentication' value='privateKey' />
+            <property key='service.NodeExecutor.default.provider' value='jsch-ssh' />
+            <property key='resources.source.1.config.includeServerNode' value='true' />
+            <property key='resources.source.1.config.generateFileAutomatically' value='true' />
+            <property key='resources.source.1.config.file' value='/var/rundeck/projects/xml_project/etc/resources.xml' />
+            <property key='project.ssh-keypath' value='/var/lib/rundeck/.ssh/id_rsa' />
+            <property key='service.FileCopier.default.provider' value='jsch-scp' />
+            <property key='resources.source.1.type' value='file' />
+          </config>
+        </project>
+    http_version: 
+  recorded_at: Mon, 03 Nov 2014 18:51:06 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/12/delete_project_invalid.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: http://192.168.50.2:4440/api/12/project/project1
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Rundeck-Auth-Token:
+      - cmJQYoy9EAsSd0905yNjKDNGs0ESIwEd
+      Accept:
+      - application/xml
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Set-Cookie:
+      - JSESSIONID=1x1jz735m5pf41dyllrj4dbj9h;Path=/
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Content-Type:
+      - text/xml;charset=UTF-8
+      X-Rundeck-Api-Version:
+      - '12'
+      Transfer-Encoding:
+      - chunked
+      Server:
+      - Jetty(7.6.0.v20120127)
+    body:
+      encoding: UTF-8
+      string: |-
+        <result error='true' apiversion='12'>
+          <error code='api.error.item.doesnotexist'>
+            <message>Project does not exist: project1</message>
+          </error>
+        </result>
+    http_version: 
+  recorded_at: Sun, 02 Nov 2014 18:46:21 GMT
+recorded_with: VCR 2.9.3