rundeck 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3458d53ff90537da707c22e709751439806a0e3c
+  data.tar.gz: 3d4414a87b8d98dce1bceb9d66c46ad2d5583e66
+SHA512:
+  metadata.gz: 6fc35d21ed3a2138a6ac831b349ea5ecb23b16a15db24a254a1c7487d49adb333de9095b2a2235a0f23d66a1868406a01411e8f55d410418195e34ee7626eebb
+  data.tar.gz: 9629f50b5e04535b8e84b8095a4c5711186bf2af58ebb9a61dfa822f8b2752f09e854a81b86d509a9d0321167e75b3ebcdac2097d4906a8db5f15c6e004e8e66

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea
+.ruby-version
+.ruby-gemset
+.idea/

data/.hound.yml

@@ -0,0 +1,4 @@
+# Prefer single quotes
+StringLiterals:
+  EnforcedStyle: single_quotes
+  Enabled: true

data/.rubocop.yml

@@ -0,0 +1,7 @@
+# This is the configuration used to check the rubocop source code.
+
+inherit_from: .rubocop_todo.yml
+
+# Lots of crappy false-positives from this cop. Go home!
+GuardClause:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,35 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2014-09-01 15:55:09 -0500 using RuboCop version 0.25.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Offense count: 1
+# Configuration parameters: AllowURI.
+Metrics/LineLength:
+  Max: 159
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 12
+
+# Offense count: 2
+Style/Documentation:
+  Severity: warning
+  Enabled: false
+
+# Offense count: 1
+# Configuration parameters: MaxSlashes.
+Style/RegexpLiteral:
+  Enabled: false
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/SpecialGlobalVars:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+script:
+  - bundle exec rake
+#  - bundle exec rubocop
+addons:
+  code_climate:
+    repo_token: 2aea108baa65d08ea87fb2371ec22a1741cb760027b8605bdabd5e153e595f4c

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rundeck.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,16 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+group :red_green_refactor, halt_on_fail: true do
+
+  guard :rspec, cmd: 'bundle exec rspec' do
+    watch(/^spec\/.+_spec\.rb$/)
+    watch(/^lib\/(.+)\.rb$/) { |m| "spec/lib/#{m[1]}_spec.rb" }
+    watch('spec/spec_helper.rb')  { 'spec' }
+  end
+
+  guard :rubocop do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+
+end

data/LICENSE.txt

@@ -0,0 +1,10 @@
+Copyright (c) 2014, Drew A. Blessing
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,49 @@
+# Rundeck Ruby Gem
+
+## 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.**
+
+[![Build Status](https://travis-ci.org/dblessing/rundeck-ruby.svg?branch=master)](https://travis-ci.org/dblessing/rundeck-ruby)
+[![Dependency Status](https://gemnasium.com/dblessing/rundeck-ruby.svg)](https://gemnasium.com/dblessing/rundeck-ruby)
+[![Code Climate](https://codeclimate.com/github/dblessing/rundeck-ruby/badges/gpa.svg)](https://codeclimate.com/github/dblessing/rundeck-ruby)
+[![Test Coverage](https://codeclimate.com/github/dblessing/rundeck-ruby/badges/coverage.svg)](https://codeclimate.com/github/dblessing/rundeck-ruby)
+
+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
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rundeck'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rundeck
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+Released under the BSD 2-clause license. See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.rspec_opts = ['--color', '--format d']
+end
+
+task default: :spec

data/lib/rundeck.rb

@@ -0,0 +1,29 @@
+require 'rundeck/version'
+require 'rundeck/configuration'
+require 'rundeck/error'
+require 'rundeck/objectified_hash'
+require 'rundeck/request'
+require 'rundeck/api'
+require 'rundeck/client'
+
+module Rundeck
+  extend Configuration
+
+  # Alias for Rundeck::Client.new
+  #
+  # @return [Rundeck::Client]
+  def self.client(options = {})
+    Rundeck::Client.new(options)
+  end
+
+  # Delegate to Gitlab::Client
+  def self.method_missing(method, *args, &block)
+    return super unless client.respond_to?(method)
+    client.send(method, *args, &block)
+  end
+
+  # Delegate to Gitlab::Client
+  def self.respond_to?(method)
+    client.respond_to?(method) || super
+  end
+end

data/lib/rundeck/api.rb

@@ -0,0 +1,17 @@
+module Rundeck
+  # @private
+  class API < Request
+    # @private
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    # Creates a new API.
+    # @raise [Error:MissingCredentials]
+    def initialize(options = {})
+      options = Rundeck.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+      set_request_defaults @endpoint, @api_token
+    end
+  end
+end

data/lib/rundeck/client.rb

@@ -0,0 +1,21 @@
+module Rundeck
+  # Wrapper for the Rundeck REST API.
+  class Client < API
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
+
+    include Jobs
+    include Keys
+
+    def objectify(result)
+      if result.is_a?(Hash)
+        ObjectifiedHash.new(result)
+      elsif result.is_a? Array
+        result.map! { |e| ObjectifiedHash.new(e) }
+      elsif result.nil?
+        nil
+      else
+        fail Error::Parsing, "Couldn't parse a response body"
+      end
+    end
+  end
+end

data/lib/rundeck/client/jobs.rb

@@ -0,0 +1,119 @@
+module Rundeck
+  class Client
+    # Defines methods related to projects.
+    module Jobs
+      # Gets a list of jobs for a specific project.
+      #
+      # @example
+      #   Rundeck.jobs('project')
+      #
+      # @param  [String] project Project name
+      # @param  [Hash] options A set of options passed directly to HTTParty
+      # @return [Array<Rundeck::ObjectifiedHash>]
+      def jobs(project, options = {})
+        objectify get("/project/#{project}/jobs", options)['jobs']['job']
+      end
+
+      # Gets a single job by id
+      #
+      # @example Rundeck.job('c07518ef-b697-4792-9a59-5b4f08855b67')
+      #
+      # @param  [String] id Job id
+      # @param  [Hash] options A set of options passed directly to HTTParty
+      # @return [Rundeck::ObjectifiedHash]
+      def job(id, options = {})
+        objectify get("/job/#{id}", options)['joblist']['job']
+      end
+
+      # Delete a job
+      #
+      # @example
+      #   Rundeck.delete_job('c07518ef-b697-4792-9a59-5b4f08855b67')
+      #
+      # @param  [String] id Job id
+      # @param  [Hash] options A set of options passed directly to HTTParty
+      # @return [Rundeck::ObjectifiedHash]
+      def delete_job(id, options = {})
+        delete("/job/#{id}", options)
+      end
+
+      # Get executions for a specific job
+      #
+      # @example
+      #   Rundeck.job_executions('c07518ef-b697-4792-9a59-5b4f08855b67')
+      #
+      # @param  [String] id Job id
+      # @param  [Hash] options A set of options passed directly to HTTParty
+      # @return [Rundeck::ObjectifiedHash]
+      def job_executions(id, options = {})
+        r = get("/job/#{id}/executions", options)['result']['executions']['execution']
+        objectify r
+      end
+
+      # Run a job
+      #
+      # @example
+      #   Rundeck.run_job('c07518ef-b697-4792-9a59-5b4f08855b67', 'DEBUG')
+      #
+      # @param  [String] id Job id
+      # @param  [Hash]   options A set of options passed directly to HTTParty
+      # @return [Rundeck::ObjectifiedHash]
+      def run_job(id, options = {})
+        objectify post("/job/#{id}/executions", options)['result']['executions']['execution']
+      end
+
+      # Import a job or multiple jobs
+      #
+      # @example
+      #   job = "- id: c07518ef-b697-4792-9a59-5b4f08855b67
+      #            project: Endeca
+      #            ..."
+      #   Rundeck.import_jobs(job)
+      #
+      # @example
+      #   job = "<joblist>
+      #            <job>
+      #              <id>c07518ef-b697-4792-9a59-5b4f08855b67</id>
+      #              ..."
+      #   Rundeck.import_jobs(job, 'xml')
+      #
+      # @param  [String] content The job definition(s) as yaml or xml
+      # @param  [String] format The import format. 'yaml|xml', defaults to 'yaml'
+      # @param  [Hash]   options A set of options passed directly to HTTParty
+      # @return [Rundeck::ObjectifiedHash]
+      def import_jobs(content, format = 'yaml', options = {})
+        unless format =~ /yaml|xml/
+          fail Error::InvalidAttributes, 'format must be yaml or xml'
+        end
+        options[:headers] = {} if options[:headers].nil?
+        options[:headers].merge!(
+            'Content-Type' => 'application/x-www-form-urlencoded')
+        options[:body] = "xmlBatch=#{content}"
+        options[:query] = {} if options[:query].nil?
+        options[:query]['format'] = format
+
+        objectify post('/jobs/import', options)['result']
+      end
+
+      # Export jobs to yaml or xml format
+      #
+      # @example
+      #   Rundeck.export_jobs('project')
+      #
+      # @param  [String] project Project name
+      # @param  [String] format The export format. 'yaml|xml', defaults to 'yaml'
+      # @param  [Hash]   options A set of options passed directly to HTTParty
+      # @return [String]
+      def export_jobs(project, format = 'yaml', options = {})
+        unless format =~ /yaml|xml/
+          fail Error::InvalidAttributes, 'format must be yaml or xml'
+        end
+        options[:query] = {} if options[:query].nil?
+        options[:query].merge!('project' => project, 'format' => format)
+        options[:format] = format
+
+        get('/jobs/export', options)
+      end
+    end
+  end
+end

data/lib/rundeck/client/keys.rb

@@ -0,0 +1,177 @@
+module Rundeck
+  class Client
+    # Defines methods related to projects.
+    module Keys
+      STORAGE_KEYS_PATH = '/storage/keys'
+
+      # Gets a list of keys at a specific path.
+      #
+      # @example
+      #   Rundeck.keys('path')
+      #
+      # @param  [String] path A key storage path
+      # @param  [Hash] options A set of options passed directly to HTTParty
+      # @return [Array<Rundeck::ObjectifiedHash>]
+      def keys(path = '', options = {})
+        r = get("#{STORAGE_KEYS_PATH}/#{path}", options)
+
+        #         # In case a user provides a direct path to a key, error.
+        if r['resource']['contents']
+          objectify r['resource']['contents']['resource']
+        else
+          fail Error::InvalidAttributes,
+               'Please provide a key storage path that ' \
+               'isn\'t a direct path to a key'
+        end
+      end
+
+      # Get a single key's metadata
+      #
+      # @example
+      #   Rundeck.key_metadata('path/to/key1')
+      #
+      # @param  [String] path A key storage path, including key name
+      # @param  [Hash] options A set of options passed directly to HTTParty
+      # @return [Rundeck::ObjectifiedHash]
+      def key_metadata(path, options = {})
+        r = get("#{STORAGE_KEYS_PATH}/#{path}", options)
+
+        # In case a user provides a key path instead of a path to a single key.
+        if r['resource']['contents']
+          fail Error::InvalidAttributes,
+               'Please provide a key storage path that ' \
+               'is a direct path to a key'
+        else
+          objectify r['resource']['resource_meta']
+        end
+      end
+
+      # Get the contents of a key. Only allowed for public keys.
+      # Note: This method returns a raw string of the public key,
+      # not at ObjectifiedHash.
+      #
+      # @example
+      #   Rundeck.key_contents('path/to/key1')
+      #
+      # @param  [String] path A key storage path, including key name
+      # @param  [Hash] options A set of options passed directly to HTTParty
+      # @return [Rundeck::ObjectifiedHash]
+      def key_contents(path, options = {})
+        # Check if key exists first. Otherwise we could return some
+        # weird strings. Also, raise error if user is trying to get a
+        # private key.
+        if key_metadata(path, options).rundeck_key_type == 'private'
+          fail Error::Unauthorized,
+               'You are not allowed to retrieve the contents of a private key'
+        end
+
+        options.merge!(format: :plain,
+                       headers: { 'Accept' => 'application/pgp-keys' })
+        key = get("#{STORAGE_KEYS_PATH}/#{path}", options)
+        objectify 'public_key' => key
+      end
+
+      # Create a private key
+      #
+      # @example
+      #   key = "-----BEGIN RSA PRIVATE KEY-----\nProc-Type:..."
+      #   Rundeck.create_private_key('path', key)
+      #
+      # @param  [String] path A key storage path
+      # @param  [String] key The entire private key value
+      # @param  [Hash] options A set of options passed directory to HTTParty
+      # @return [Rundeck::ObjectifiedHash]
+      def create_private_key(path, key, options = {})
+        create_or_update_key(path, key, 'private', 'post', options)
+      end
+
+      # Update a private key
+      #
+      # @example
+      #   key = "-----BEGIN RSA PRIVATE KEY-----\nProc-Type:..."
+      #   Rundeck.update_private_key('path', key)
+      #
+      # @param  [String] path A key storage path
+      # @param  [String] key The entire private key value
+      # @param  [Hash] options A set of options passed directory to HTTParty
+      # @return [Rundeck::ObjectifiedHash]
+      def update_private_key(path, key, options = {})
+        key_check(path, 'private', options)
+        create_or_update_key(path, key, 'public', 'put', options)
+      end
+
+      # Create a public key
+      #
+      # @example
+      #   key = "ssh-rsa AAAA.....3MOj user@example.com"
+      #   Rundeck.create_public_key('path/to/key', key)
+      #
+      # @param  [String] path A key storage path
+      # @param  [String] key The entire private key value
+      # @param  [Hash] options A set of options passed directory to HTTParty
+      # @return [Array<Rundeck::ObjectifiedHash>]
+      def create_public_key(path, key, options = {})
+        create_or_update_key(path, key, 'public', 'post', options)
+      end
+
+      # Update a public key
+      #
+      # @example
+      #   key = "ssh-rsa AAAA.....3MOj user@example.com"
+      #   Rundeck.update_public_key('path/to/key', key)
+      #
+      # @param  [String] path A key storage path
+      # @param  [String] key The entire private key value
+      # @param  [Hash] options A set of options passed directory to HTTParty
+      # @return [Array<Rundeck::ObjectifiedHash>]
+      def update_public_key(path, key, options = {})
+        key_check(path, 'public', options)
+        create_or_update_key(path, key, 'public', 'put', options)
+      end
+
+      # Delete a key
+      #
+      # @example
+      # Rundeck.delete_key('path/to/key')
+      #
+      # @param  [String] path A key storage path
+      # @param  [Hash] options A set of options passed directly to HTTParty
+      # @return [nil]
+      def delete_key(path, options = {})
+        delete("#{STORAGE_KEYS_PATH}/#{path}", options)
+      end
+
+      private
+
+      def key_check(path, type, options)
+        # Check existence and type
+        if key_metadata(path, options).rundeck_key_type != type
+          fail Error::NotFound,
+               "A #{type} key was not found at the specified path."
+        end
+      end
+
+      def create_or_update_key(path, key, type, method, options)
+        key_type_headers(type, options)
+        options.merge!(body: key)
+
+        if method == 'post'
+          objectify post("#{STORAGE_KEYS_PATH}/#{path}", options)['resource']['resource_meta']
+        elsif method == 'put'
+          objectify put("#{STORAGE_KEYS_PATH}/#{path}", options)['resource']['resource_meta']
+        end
+      end
+
+      def key_type_headers(type, options)
+        if type == 'private'
+          options.merge!(headers: { 'Content-Type' => 'application/octet-stream' })
+        elsif type == 'public'
+          options.merge!(headers: { 'Content-Type' => 'application/pgp-key' })
+        else
+          fail Error::InvalidAttributes,
+               'Invalid key type specified. Must be public or private.'
+        end
+      end
+    end
+  end
+end