ansible_tower_client 0.20.2 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1feb80243276376bf97dde6659e9120ee50077d2c07f91daeb006ed63f95262f
-  data.tar.gz: 27dabdade9e2e6483cd8f7d46e575feaeef64ebbc4069d7009d68c9e7d5420d2
+  metadata.gz: 6c69651105f775ced783576fea3e67136e99706f69e977ea2cc3c552c982c09c
+  data.tar.gz: ecb65f36c686dd4e9729823a6d752df2aba5f1d25d53e14d579390734a99aebf
 SHA512:
-  metadata.gz: a1cc2ee34f52c11605806b2a99f8012aba5203364a8ca485d66e7ce8b78fc8ec741b1703e6bbb5465814586ecc2725ca829cd9c18113f9f152410882fb9c5ab4
-  data.tar.gz: 1e4459f11c5e1443b414e88b3f94c82d5975e8d0febb9d9e65c55648d4cc1971531e050ca7d173f2e4eb9a16ab8b82d81babfd1527b2ee913f6b556abf68eac2
+  metadata.gz: 8cfd7f0ddc93a0d0bbbe75ca11737b4687667d6e8d9ab472208c873d8d8483f31fadd4865e6ec9ab40ac01955850d4cf94f4cd24e35961d35341f48b73a5f644
+  data.tar.gz: 3fdec2bed48fbb01b38e521db077509cee7907a4e8e4142f13ceddac874ae1dddd62e8de219618bfb760345d6bfec81798def2c1263e34ad175cc169d70ac952

data/CHANGELOG.md

@@ -5,6 +5,18 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [0.21.0] - 2020-02-12
+### Added
+- Add support for connection headers and proxy [(#134)](https://github.com/ansible/ansible_tower_client_ruby/pull/134)
+- Allow request options to be passed to Faraday [(#140)](https://github.com/ansible/ansible_tower_client_ruby/pull/140)
+- Add usage documentation to the README [(#138)](https://github.com/ansible/ansible_tower_client_ruby/pull/138)
+
+### Fixed
+- Fix issue where passing no options gives a NilError [(#136)](https://github.com/ansible/ansible_tower_client_ruby/pull/136)
+
+### Changed
+- Extract MockApi responses into JSON files [(#137)](https://github.com/ansible/ansible_tower_client_ruby/pull/137)
+
 ## [0.20.2] - 2019-08-19
 ### Fixed
 - Ensure #vault_password is never nil [(#132)](https://github.com/ansible/ansible_tower_client_ruby/pull/132)
@@ -126,7 +138,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.20.2...master
+[Unreleased]: https://github.com/ansible/ansible_tower_client_ruby/compare/v0.21.0...master
+[0.21.0]: https://github.com/ansible/ansible_tower_client_ruby/compare/v0.20.2...v0.21.0
 [0.20.2]: https://github.com/ansible/ansible_tower_client_ruby/compare/v0.20.1...v0.20.2
 [0.20.1]: https://github.com/ansible/ansible_tower_client_ruby/compare/v0.20.0...v0.20.1
 [0.20.0]: https://github.com/ansible/ansible_tower_client_ruby/compare/v0.19.1...v0.20.0

data/Gemfile

@@ -1,11 +1,11 @@
 source 'https://rubygems.org'
 
+plugin "bundler-inject", "~> 1.1"
+require File.join(Bundler::Plugin.index.load_paths("bundler-inject")[0], "bundler-inject") rescue nil
+
 # Specify your gem's dependencies in ansible_tower_client.gemspec
 gemspec
 
-# Pull in a development Gemfile if one exists
-eval_gemfile('Gemfile.dev.rb') if File.exists?('Gemfile.dev.rb')
-
 # HACK: Rails 5 dropped support for Ruby < 2.2.2
 active_support_version = "< 5" if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.2.2")
 gem "activesupport", active_support_version

data/README.md

@@ -23,6 +23,36 @@ Or install it yourself as:
 
     $ gem install ansible_tower_client
 
+## Usage
+
+```ruby
+require 'ansible_tower_client'
+
+# Optionally set a global logger
+AnsibleTowerClient.logger = Logger.new(STDOUT)
+
+# Create a connection
+conn = AnsibleTowerClient::Connection.new(
+  :base_url   => "https://awx.example.com/",
+  :username   => "admin",
+  :password   => "pa$$w0rd!",
+  :verify_ssl => OpenSSL::SSL::VERIFY_PEER # Optional: an OpenSSL::SSL::VERIFY_* constant
+)
+
+# Query the config
+conn.api.config
+# => {"eula"=>"text"
+#     "version"=>"3.2.2",
+#     "project_base_dir"=>"/var/lib/awx/projects",
+#     "ansible_version"=>"2.4.1.0",
+#     ...}
+
+# Query a collection
+conn.api.job_templates.all
+# => [<AnsibleTowerClient::JobTemplate id=580, type="job_template", url="/api/v1/job_templates/580/", name="ems_refresh_spec-job_template", description="EmsRefreshSpec JobTemplate", ...>
+#     <AnsibleTowerClient::JobTemplate id=585, type="job_template", url="/api/v1/job_templates/585/", name="ems_refresh_spec-job_template2", description="EmsRefreshSpec JobTemplate", ...>]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/ansible_tower_client/api.rb

@@ -12,7 +12,7 @@ module AnsibleTowerClient
     end
 
     def config
-      JSON.parse(get("config/").body)
+      JSON.parse(get("config").body)
     end
 
     def version

data/lib/ansible_tower_client/connection.rb

@@ -5,8 +5,9 @@ module AnsibleTowerClient
     attr_reader :connection
 
     def initialize(options = nil)
-      raise "Credentials are required" unless options[:username] && options[:password]
+      raise ":username and :password are required" if options.nil? || !options[:username] || !options[:password]
       raise ":base_url is required" unless options[:base_url]
+
       logger     = options[:logger] || AnsibleTowerClient.logger
       verify_ssl = options[:verify_ssl] || OpenSSL::SSL::VERIFY_PEER
       verify_ssl = verify_ssl == OpenSSL::SSL::VERIFY_NONE ? false : true
@@ -15,7 +16,13 @@ module AnsibleTowerClient
       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|
+
+      connection_opts = { :ssl => {:verify => verify_ssl} }
+      connection_opts[:proxy] = options[:proxy] if options[:proxy].present?
+      connection_opts[:headers] = options[:headers] if options[:headers].present?
+      connection_opts[:request] = options[:request] if options[:request].present?
+
+      @connection = Faraday.new(options[:base_url], connection_opts) do |f|
         f.use(FaradayMiddleware::EncodeJson)
         f.use(FaradayMiddleware::FollowRedirects, :limit => 3, :standards_compliant => true)
         f.request(:url_encoded)

data/lib/ansible_tower_client/version.rb

@@ -1,3 +1,3 @@
 module AnsibleTowerClient
-  VERSION = "0.20.2".freeze
+  VERSION = "0.21.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ansible_tower_client
 version: !ruby/object:Gem::Version
-  version: 0.20.2
+  version: 0.21.0
 platform: ruby
 authors:
 - Brandon Dunne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-19 00:00:00.000000000 Z
+date: 2020-02-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -183,8 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Ansible Tower REST API wrapper gem