ansible_tower_client 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a34cad5e35410c160d20d10252d77061c4820686405051be201fe08877ddca8
-  data.tar.gz: e1a0323a69026441505bbc75602ef1b3786f314510417958498d33abfa524be8
+  metadata.gz: a1b0a1ac463760d8b5494152a6e9646ed367655dfbf857f1899a322cbf89b98f
+  data.tar.gz: 643abb688c74f01c1e7caaed8fb7cb3e1e65eab2a658c1825a5dd1e7176cc398
 SHA512:
-  metadata.gz: 950a9d840eb13c84df3e94ef08a5749172a549bbbc0de50cb9325c7c3aec216a221328bf02fd645f731432f64abd41f45c734085410e7f131c392c6eae038b94
-  data.tar.gz: 174f2b89477d26d9c5141c8668129c8ef13223ce38f513ad9a0ec70b13026f3e78bbbe41171f5b27b3fb92e85a259c3b6be85f70745b5415e7a33a20f3fbdd38
+  metadata.gz: 9f7a7d8a683736eddec813fd3e85aab35675e6bbe1cddc3da13f780e6ebe8d0672ea76bccfe0352f5cdd2255ad2500abf875b193973740e530db2e8704ed200f
+  data.tar.gz: 7d3388d96c17847d266597a5a47d31b02cd6777d819dcad8c448df4e44bf1787399f0d282c39d2ae45453db8f62efa4376a93f99acd04c641d91a1715f54eb18

data/CHANGELOG.md

@@ -5,6 +5,17 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.16.0] - 2018-07-06
+### Added
+- Added support for API v2 and v2 Credentials [(#107)](https://github.com/ansible/ansible_tower_client_ruby/pull/107)
+- Added AnsibleTowerClient::WorkflowJobNode [(#109)](https://github.com/ansible/ansible_tower_client_ruby/pull/109)
+- Set the Faraday logger when creating a connection [(#110)](https://github.com/ansible/ansible_tower_client_ruby/pull/110)
+- Added AnsibleTowerClient::CredentialTypev2 [(#108)](https://github.com/ansible/ansible_tower_client_ruby/pull/108)
+- Added AnsibleTowerClient::WorkflowJob#extra_vars_hash [(#111)](https://github.com/ansible/ansible_tower_client_ruby/pull/111)
+
+### Changed
+- Substitute invalid characters for dynamically defined class names [(#105)](https://github.com/ansible/ansible_tower_client_ruby/pull/105)
+
 ## [0.15.0] - 2018-06-05
 ### Added
 - Added AnsibleTowerClient::WorkflowJob [(#104)](https://github.com/ansible/ansible_tower_client_ruby/pull/104)
@@ -80,7 +91,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 ### Fixed
 - Adjusted project_spec to test on a Project [(#63)](https://github.com/ansible/ansible_tower_client_ruby/pull/63)
 
-[Unreleased]: https://github.com/ansible/ansible_tower_client_ruby/compare/v0.15.0...master
+[Unreleased]: https://github.com/ansible/ansible_tower_client_ruby/compare/v0.16.0...master
+[0.16.0]: https://github.com/ansible/ansible_tower_client_ruby/compare/v0.15.0...v0.16.0
 [0.15.0]: https://github.com/ansible/ansible_tower_client_ruby/compare/v0.14.0...v0.15.0
 [0.14.0]: https://github.com/ansible/ansible_tower_client_ruby/compare/v0.13.0...v0.14.0
 [0.13.0]: https://github.com/ansible/ansible_tower_client_ruby/compare/v0.12.2...v0.13.0

data/lib/ansible_tower_client.rb

@@ -28,11 +28,14 @@ require "ansible_tower_client/base_models/project_update"
 require "ansible_tower_client/base_models/schedule"
 require "ansible_tower_client/base_models/system_job"
 require "ansible_tower_client/base_models/system_job_template"
+require "ansible_tower_client/base_models/workflow_job_node"
 require "ansible_tower_client/base_models/workflow_job"
 require "ansible_tower_client/base_models/workflow_job_template"
 require "ansible_tower_client/base_models/workflow_job_template_node"
 
 require "ansible_tower_client/v2/job_template_v2"
+require "ansible_tower_client/v2/credential_v2"
+require "ansible_tower_client/v2/credential_type_v2"
 
 require "more_core_extensions/all"
 require "active_support/inflector"

data/lib/ansible_tower_client/api.rb

@@ -6,9 +6,10 @@ module AnsibleTowerClient
 
     DEFAULT_ERROR_MSG = "An unknown error was returned from the provider".freeze
 
-    attr_reader :instance
-    def initialize(connection)
-      @instance = connection
+    attr_reader :instance, :api_version
+    def initialize(connection, api_version)
+      @instance    = connection
+      @api_version = api_version
     end
 
     def config
@@ -35,6 +36,11 @@ module AnsibleTowerClient
       Collection.new(self, credential_class)
     end
 
+    def credential_types
+      raise AnsibleTowerClient::UnsupportedApiError, 'requires API v2 or higher' if api_version?(1)
+      Collection.new(self, credential_type_class)
+    end
+
     def groups
       Collection.new(self, group_class)
     end
@@ -95,6 +101,10 @@ module AnsibleTowerClient
       Collection.new(self, system_job_template_class)
     end
 
+    def workflow_job_nodes
+      Collection.new(self, workflow_job_node_class)
+    end
+
     def workflow_jobs
       Collection.new(self, workflow_job_class)
     end
@@ -142,7 +152,17 @@ module AnsibleTowerClient
     end
 
     def credential_class
-      @credential_class ||= AnsibleTowerClient::Credential
+      @credential_class ||= begin
+        if api_version?(2)
+          AnsibleTowerClient::CredentialV2
+        else
+          AnsibleTowerClient::Credential
+        end
+      end
+    end
+
+    def credential_type_class
+      @credential_type_class ||= AnsibleTowerClient::CredentialTypeV2
     end
 
     def group_class
@@ -179,7 +199,7 @@ module AnsibleTowerClient
 
     def job_template_class
       @job_template_class ||= begin
-        if Gem::Version.new(version).between?(Gem::Version.new(2), Gem::Version.new(3))
+        if awx_version_between?(2, 3)
           AnsibleTowerClient::JobTemplateV2
         else
           AnsibleTowerClient::JobTemplate
@@ -215,6 +235,10 @@ module AnsibleTowerClient
       @workflow_job_class ||= AnsibleTowerClient::WorkflowJob
     end
 
+    def workflow_job_node_class
+      @workflow_job_node_class ||= AnsibleTowerClient::WorkflowJobNode
+    end
+
     def workflow_job_template_class
       @workflow_job_template_class ||= AnsibleTowerClient::WorkflowJobTemplate
     end
@@ -230,5 +254,13 @@ module AnsibleTowerClient
       return original if instance.url_prefix.path == "/"
       File.join(instance.url_prefix.path, Regexp.last_match[1])
     end
+
+    def awx_version_between?(min, max)
+      Gem::Version.new(version).between?(Gem::Version.new(min), Gem::Version.new(max))
+    end
+
+    def api_version?(desired)
+      Gem::Version.new(api_version).eql?(Gem::Version.new(desired))
+    end
   end
 end

data/lib/ansible_tower_client/base_models/workflow_job.rb

@@ -1,4 +1,12 @@
 module AnsibleTowerClient
   class WorkflowJob < BaseModel
+    def workflow_job_nodes
+      # this is where Ansible API deviates from other part by using `workflow_nodes`
+      Collection.new(api).find_all_by_url(related['workflow_nodes'])
+    end
+
+    def extra_vars_hash
+      extra_vars.empty? ? {} : hashify(:extra_vars)
+    end
   end
 end

data/lib/ansible_tower_client/base_models/workflow_job_node.rb

@@ -0,0 +1,11 @@
+module AnsibleTowerClient
+  class WorkflowJobNode < BaseModel
+    def workflow_job
+      api.workflow_jobs.find(workflow_job_id)
+    end
+
+    def job
+      job_id.nil? ? nil : api.jobs.find(job_id)
+    end
+  end
+end

data/lib/ansible_tower_client/connection.rb

@@ -1,29 +1,70 @@
 module AnsibleTowerClient
   class Connection
-    attr_reader :connection
+    attr_reader :options
 
-    def initialize(options = nil)
+    # Options:
+    # - base_url: you have two options here:
+    #   a) pass in only scheme and hostname e.g. 'https://localhost:54321' to allow client to connect to both api v1
+    #      and v2 versions like this: `client.api(:version => 1)` and `client.api(:version => 2)`. This requires ansible
+    #      tower API being accessible directly at `https://localhost:54321/api/v1` and `https://localhost:54321/api/v2`.
+    #   b) pass in a complete api address e.g. 'https://localhost:54321/tower'. Client will then connect to the path
+    #      directly and it's your responsibility to know what version of API is there.
+    # - username
+    # - password
+    # - verify_ssl
+    def initialize(options = {})
       raise "Credentials are required" unless options[:username] && options[:password]
       raise ":base_url is required" unless options[:base_url]
-      verify_ssl = options[:verify_ssl] || OpenSSL::SSL::VERIFY_PEER
-      verify_ssl = verify_ssl == OpenSSL::SSL::VERIFY_NONE ? false : true
+      logger = options[:logger] || AnsibleTowerClient.logger
 
       require 'faraday'
       require 'faraday_middleware'
       require 'ansible_tower_client/middleware/raise_tower_error'
       Faraday::Response.register_middleware :raise_tower_error => -> { Middleware::RaiseTowerError }
-      @connection = Faraday.new(options[:base_url], :ssl => {:verify => verify_ssl}) do |f|
+
+      @options = {
+        :url        => options[:base_url],
+        :verify_ssl => (options[:verify_ssl] || OpenSSL::SSL::VERIFY_PEER) != OpenSSL::SSL::VERIFY_NONE,
+        :username   => options[:username],
+        :password   => options[:password],
+        :logger     => logger,
+      }
+
+      reset
+    end
+
+    def connection(url:, username:, password:, verify_ssl: false, logger: nil)
+      Faraday.new(url, :ssl => {:verify => verify_ssl}) do |f|
         f.use(FaradayMiddleware::EncodeJson)
         f.use(FaradayMiddleware::FollowRedirects, :limit => 3, :standards_compliant => true)
         f.request(:url_encoded)
         f.response(:raise_tower_error)
+        f.response(:logger, logger)
         f.adapter(Faraday.default_adapter)
-        f.basic_auth(options[:username], options[:password])
+        f.basic_auth(username, password)
       end
     end
 
-    def api
-      @api ||= Api.new(connection)
+    def api(version: 2)
+      @api[version] ||= begin
+        # Build uri path.
+        options = @options.clone.tap do |opts|
+          opts[:url] = URI(opts[:url]).tap { |url| url.path = url_path_for_version(url.path, version) }
+        end
+
+        Api.new(connection(**options), version)
+      end
+    end
+
+    def reset
+      @api = {}
+    end
+
+    private
+
+    def url_path_for_version(orig_path, api_version)
+      return orig_path unless orig_path.sub(/\/$/, "").empty?
+      "/api/v#{api_version}"
     end
   end
 end

data/lib/ansible_tower_client/exception.rb

@@ -7,4 +7,5 @@ module AnsibleTowerClient
   class ResourceNotFoundError  < ClientError; end
   class SSLError               < ClientError; end
   class UnlicensedFeatureError < ClientError; end
+  class UnsupportedApiError    < ClientError; end
 end

data/lib/ansible_tower_client/hash_model.rb

@@ -46,7 +46,8 @@ module AnsibleTowerClient
       end
 
       def convert_value(key, value, parent)
-        method = key_to_attribute(key)
+        method = key_to_attribute(key).gsub(/\W/, '_') # replace all unqualified characters for method and class names
+
         new_val =
           if attr_excluded?(method)
             value

data/lib/ansible_tower_client/v2/credential_type_v2.rb

@@ -0,0 +1,9 @@
+module AnsibleTowerClient
+  class CredentialTypeV2 < BaseModel
+    class Inputs < BaseModel; end
+
+    def self.endpoint
+      'credential_types'
+    end
+  end
+end

data/lib/ansible_tower_client/v2/credential_v2.rb

@@ -0,0 +1,13 @@
+module AnsibleTowerClient
+  class CredentialV2 < Credential
+    class Inputs < BaseModel
+      def size
+        @raw_hash.keys.size
+      end
+    end
+
+    def self.endpoint
+      'credentials'
+    end
+  end
+end

data/lib/ansible_tower_client/version.rb

@@ -1,3 +1,3 @@
 module AnsibleTowerClient
-  VERSION = "0.15.0".freeze
+  VERSION = "0.16.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ansible_tower_client
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Brandon Dunne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2018-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -165,6 +165,7 @@ files:
 - lib/ansible_tower_client/base_models/system_job.rb
 - lib/ansible_tower_client/base_models/system_job_template.rb
 - lib/ansible_tower_client/base_models/workflow_job.rb
+- lib/ansible_tower_client/base_models/workflow_job_node.rb
 - lib/ansible_tower_client/base_models/workflow_job_template.rb
 - lib/ansible_tower_client/base_models/workflow_job_template_node.rb
 - lib/ansible_tower_client/collection.rb
@@ -174,6 +175,8 @@ files:
 - lib/ansible_tower_client/logging.rb
 - lib/ansible_tower_client/middleware/raise_tower_error.rb
 - lib/ansible_tower_client/null_logger.rb
+- lib/ansible_tower_client/v2/credential_type_v2.rb
+- lib/ansible_tower_client/v2/credential_v2.rb
 - lib/ansible_tower_client/v2/job_template_v2.rb
 - lib/ansible_tower_client/version.rb
 homepage: https://github.com/Ansible/ansible_tower_client_ruby