rundeck 0.0.4 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31730efc03d57ef39d030de2aaec177f44d26a4e
-  data.tar.gz: 193d25852a20e7a351760d90e4a9a311e1ed3210
+  metadata.gz: b7b621a7132091422a6aa3950967b078fc054949
+  data.tar.gz: 7d72079c260b9a6275735ac78ca95e8706fa78b6
 SHA512:
-  metadata.gz: 7c0324e4bff89cbc319ad93c102c16927bb76928bd5be58f70679d570eb19d8a87f2ba895f6e2c9e2515d5da23193c065cbfce3d18661b18d85adefd952b8ae3
-  data.tar.gz: 564b902d2ed2f4771495809585e32899d088ed7e289c6219cdbb9fab34d04d77e3efffb958668d34d51e414b6a850ca9af95e60311fe2914b5be701368f9dd3c
+  metadata.gz: 944acfc1b5262b541368af518080915062c060943171785cbd7fba87d1cb13c185db5ec369f6c54b02f03ae181265d686ebed0214e6e4c0a6140da6b5fce75ad
+  data.tar.gz: de90f30a173206965347ffea9e9812cce828604ba6571d0802378e675f5f3ccdd6c9172e289dbe5645a625997ecaff28131bcee7e3bc49b3d5062671787cee42

data/CHANGELOG.md

@@ -1,2 +1,11 @@
-0.0.4 (November 4, 2014)
-  - First version with a CHANGELOG. Changes from here will be documented.
+1.0.1 (November 23, 2014)
+  - Version bump to push gem to RubyGems. Something during push caused an error
+    and re-pushing is not allowed.
+
+1.0.0 (November 23, 2014)
+  - First stable release
+  - Feature: Basic CRUD on Projects
+  - Feature: Token endpoints
+  - Feature: Most execution endpoints
+  - Feature: Job endpoints
+  - Feature: Private/Public key endpoints

data/README.md

@@ -1,10 +1,9 @@
 # Rundeck Ruby Gem
 
-[Website](http://dblessing.github.io/rundeck-ruby)
+[Official Website](http://dblessing.github.io/rundeck-ruby) with examples,
+documentation, and links to the RDoc technical documentation.
 
-## Work in progress. Not yet stable
-
-**Note: Although the git repository is called 'rundeck-ruby', the gem is called 'Rundeck' on Rubygems.org. There is another gem called 'rundeck-ruby' on Rubygems.org and it is not affiliated with this project.**
+**Note: Although the git repository is called 'rundeck-ruby', the gem is called 'rundeck' on Rubygems.org. There is another gem called 'rundeck-ruby' on Rubygems.org and it is not affiliated with this project.**
 
 [![Gem Version](https://badge.fury.io/rb/rundeck.svg)](http://badge.fury.io/rb/rundeck)
 [![Build Status](https://travis-ci.org/dblessing/rundeck-ruby.svg?branch=master)](https://travis-ci.org/dblessing/rundeck-ruby)
@@ -14,12 +13,17 @@
 
 A Ruby wrapper around the Rundeck API.  
 
-This library will strive to achieve reliable, 
-100% coverage of the Rundeck API. Please submit an issue if you find a bug and feel
+This library will strive to achieve reliable coverage of the Rundeck API.
+Please submit an issue if you find a bug and feel
 free to submit a pull request to contribute fixes or new features.
 
-The layout and the code in this library is inspired by https://github.com/NARKOZ/gitlab. 
-NARKOZ does a fantastic job of keeping code simple and achieving API feature parity.
+Initial versions of this gem to not achieve 100% coverage of the Rundeck API.
+Each release will include more and more endpoint support until there is 100%
+coverage.
+
+The layout and the code in this library is inspired by
+https://github.com/NARKOZ/gitlab. NARKOZ does a fantastic job of keeping code
+simple and achieving API feature parity.
 
 See http://dblessing.github.io/rundeck-ruby for documentation
 

data/lib/rundeck/client.rb

@@ -55,6 +55,7 @@ module Rundeck
     include Job
     include Key
     include Project
+    include Token
 
     # Turn a hash into an object for easy accessibility.
     #

data/lib/rundeck/client/execution.rb

@@ -2,12 +2,6 @@ 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
@@ -177,13 +171,13 @@ module Rundeck
         objectify get('/executions', options)['result']['executions']
       end
 
-      # def execution_output()
-      #
-      # end
-      #
-      # def execution_output_with_state()
-      #
-      # end
+      private
+
+      def project_options_query(project, options)
+        options[:query] = {} if options[:query].nil?
+        options[:query]['project'] = project
+        options
+      end
     end
   end
 end

data/lib/rundeck/client/job.rb

@@ -30,13 +30,12 @@ module Rundeck
 
       # Delete a job
       #
-      # @TODO: What does this return?!
-      #
       # @example
       #   Rundeck.delete_job('c07518ef-b697-4792-9a59-5b4f08855b67')
       #
       # @param  [String] id Job id
       # @!macro options
+      # @return [nil] if the delete is successful
       # @!macro exceptions
       def delete_job(id, options = {})
         delete("/job/#{id}", options)

data/lib/rundeck/client/project.rb

@@ -23,7 +23,10 @@ module Rundeck
       #   Rundeck API documentation for 'POST /api/11/projects' endpoint
       #
       # @example
-      #   @TODO: Example
+      #   Rundeck.create_project('{ "name": "json_project" }', 'json')
+      #
+      # @example
+      #   Rundeck.create_project('<project><name>xml_project</name></project>', 'xml')
       #
       # @param  [String] content The job definition(s) as yaml or xml
       # @param  [String] format The project creation format. 'json|xml',

data/lib/rundeck/client/token.rb

@@ -0,0 +1,63 @@
+module Rundeck
+  class Client
+    # Defines methods related to managing security.
+    module Token
+      # List all tokens, or all tokens for a specific user.
+      #
+      # @example
+      #   Rundeck.tokens
+      #
+      # @example
+      #   Rundeck.tokens('admin')
+      #
+      # @param  [String] user List tokens for this user.
+      # @!macro options
+      # @return [Rundeck::ObjectifiedHash] if there is only a single token
+      # @return [Array<Rundeck::ObjectifiedHash>] if there are multiple tokens
+      # @!macro exceptions
+      def tokens(user = nil, options = {})
+        path = user.nil? ? '/tokens' : "/tokens/#{user}"
+        objectify get(path, options)['tokens']
+      end
+
+      # Get a specific token
+      #
+      # @example
+      #   Rundeck.token('admin')
+      #
+      # @param  [String] id The token id
+      # @!macro options
+      # @return [Rundeck::ObjectifiedHash]
+      # @!macro exceptions
+      def token(id, options = {})
+        objectify get("/token/#{id}", options)['token']
+      end
+
+      # Create a new token for a user
+      #
+      # @example
+      #   Rundeck.create_token('user1')
+      #
+      # @param  [String] user Create a token for this user
+      # @!macro options
+      # @return [Rundeck::ObjectifiedHash]
+      # @!macro exceptions
+      def create_token(user, options = {})
+        objectify post("/tokens/#{user}", options)['token']
+      end
+
+      # Delete a token
+      #
+      # @example
+      #   Rundeck.delete_token('cmJQYoy9EAsSd0905yNjKDNGs0ESIwEd')
+      #
+      # @param  [String] id The token id
+      # @!macro options
+      # @return [nil] if the delete is successful
+      # @!macro exceptions
+      def delete_token(id, options = {})
+        delete("/token/#{id}", options)
+      end
+    end
+  end
+end

data/lib/rundeck/configuration.rb

@@ -32,10 +32,6 @@ module Rundeck
       '12'
     end
 
-    def endpoint=(endpoint)
-      @endpoint = "#{endpoint}/api/#{api_version}"
-    end
-
     # Resets all configuration options to the defaults.
     def reset
       self.endpoint       = ENV['RUNDECK_ENDPOINT']

data/lib/rundeck/request.rb

@@ -44,7 +44,7 @@ module Rundeck
       when 503 then fail Error::ServiceUnavailable, error_message(response)
       end
 
-      response.parsed_response
+      handle_response(response)
     end
 
     # Sets a base_uri and default_params for requests.
@@ -55,7 +55,7 @@ module Rundeck
       end
       @api_token = api_token
 
-      self.class.base_uri endpoint
+      self.class.base_uri "#{endpoint}/api/#{Rundeck.api_version}"
     end
 
     private
@@ -84,6 +84,12 @@ module Rundeck
       end
     end
 
+    def handle_response(response)
+      response.parsed_response
+    rescue MultiXml::ParseError
+      raise Error::Parsing, 'An unexpected error occurred. Please try again'
+    end
+
     def error_message(response)
       message = if response.parsed_response && response.parsed_response['result']
                   response.parsed_response['result']['error'][1]['message']

data/lib/rundeck/version.rb

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

data/spec/cassettes/12/create_token.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: http://192.168.50.2:4440/api/12/tokens/admin
+    body:
+      encoding: UTF-8
+      string: ''
+    headers:
+      X-Rundeck-Auth-Token:
+      - cmJQYoy9EAsSd0905yNjKDNGs0ESIwEd
+      Accept:
+      - application/xml
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Set-Cookie:
+      - JSESSIONID=1941ar9mgoofz1m1uwnn1ocgyy;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: <token id='cbsQgUIZBOyCgoipJAwKd1YgfcwPJ0FY' user='admin' />
+    http_version: 
+  recorded_at: Sun, 23 Nov 2014 16:00:00 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/12/delete_token.yml

@@ -0,0 +1,32 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: http://192.168.50.2:4440/api/12/token/cmJQYoy9EAsSd0905yNjKDNGs0ESIwEd
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Rundeck-Auth-Token:
+      - cmJQYoy9EAsSd0905yNjKDNGs0ESIwEd
+      Accept:
+      - application/xml
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Set-Cookie:
+      - JSESSIONID=13o1yjpqta9yx198hq507djfhw;Path=/
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Content-Type:
+      - text/html;charset=UTF-8
+      Server:
+      - Jetty(7.6.0.v20120127)
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Sun, 23 Nov 2014 18:34:34 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/12/delete_token_invalid.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: http://192.168.50.2:4440/api/12/token/123456
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Rundeck-Auth-Token:
+      - cbsQgUIZBOyCgoipJAwKd1YgfcwPJ0FY
+      Accept:
+      - application/xml
+  response:
+    status:
+      code: 404
+      message: Not Found
+    headers:
+      Set-Cookie:
+      - JSESSIONID=u1d9tztnztpug1t3g2mchrtg;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>Token does not exist: 123456</message>
+          </error>
+        </result>
+    http_version: 
+  recorded_at: Sun, 23 Nov 2014 18:37:05 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/12/token.yml

@@ -0,0 +1,38 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://192.168.50.2:4440/api/12/token/cmJQYoy9EAsSd0905yNjKDNGs0ESIwEd
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      X-Rundeck-Auth-Token:
+      - cmJQYoy9EAsSd0905yNjKDNGs0ESIwEd
+      Accept:
+      - application/xml
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Set-Cookie:
+      - JSESSIONID=wtzic3qqbt2utce9f4dv8nin;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: <token id='cmJQYoy9EAsSd0905yNjKDNGs0ESIwEd' user='admin' />
+    http_version: 
+  recorded_at: Sun, 23 Nov 2014 15:47:50 GMT
+recorded_with: VCR 2.9.3

data/spec/cassettes/12/token_invalid.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://192.168.50.2:4440/api/12/token/123456
+    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=1t9cqr0wjp3o2r25nlk84cvyg;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>Token does not exist: 123456</message>
+          </error>
+        </result>
+    http_version: 
+  recorded_at: Sun, 23 Nov 2014 15:47:50 GMT
+recorded_with: VCR 2.9.3