ansible_tower_client 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3b2dc19710dcd49dc3f01afcb0c098c05b493ada
-  data.tar.gz: 2b4c93dc99dd27fe22da7772d84f4b525705a575
+  metadata.gz: b745ac89684afcf6633ca64b8a8e8e16615c22c9
+  data.tar.gz: 5bad31a0e9ad53ff33c2e25d59d474638dae7a16
 SHA512:
-  metadata.gz: 9f83694a37572b9605ef8c8ab3427beac58c12d568c4d535dbe1b751b18a4206a9f3912b6ade318ed6b2ac0e0e6dbebc1d3a7d95bdeec613cb160c5d5467c1d4
-  data.tar.gz: 36e5f3499c43259246444b49f65a8b89328c6f811c54c0303ccf85d097692da1841252c0a2fa8e4a2c1ea6f579e111e586745c5f90cc3627671e34ec6fb48685
+  metadata.gz: 0eb05bf1f05c2091be7034346c0b4d400348b21adbafa6ede16e13ca1d7b8c43c6fdc59c7fba23299db3aae90f574cf298ca6f2fd8ba61a921d7a992388f90f9
+  data.tar.gz: de27338f770e7153fe5926a2824c187143ae6d6b672ba6d68e48a5af1fa5bca82b660ddf183fc3cc0d9d182138b08c399043ce0170afef1dd34f78a9c9166d70

data/.gitignore

@@ -1,6 +1,7 @@
 /.bundle/
 /.yardoc
 /Gemfile.lock
+/Gemfile.dev.rb
 /_yardoc/
 /coverage/
 /doc/

data/Gemfile

@@ -3,6 +3,9 @@ source 'https://rubygems.org'
 # 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/ansible_tower_client.gemspec

@@ -25,7 +25,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "more_core_extensions", "~> 3.0"
 
   spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "byebug"
   spec.add_development_dependency "factory_girl"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"

data/lib/ansible_tower_client.rb

@@ -11,7 +11,9 @@ require "ansible_tower_client/hash_model"
 require "ansible_tower_client/base_model"
 require "ansible_tower_client/collection"
 
+require "ansible_tower_client/base_models/activity_stream"
 require "ansible_tower_client/base_models/ad_hoc_command"
+require "ansible_tower_client/base_models/credential"
 require "ansible_tower_client/base_models/group"
 require "ansible_tower_client/base_models/host"
 require "ansible_tower_client/base_models/inventory"
@@ -19,6 +21,7 @@ require "ansible_tower_client/base_models/inventory_source"
 require "ansible_tower_client/base_models/inventory_update"
 require "ansible_tower_client/base_models/job"
 require "ansible_tower_client/base_models/job_template"
+require "ansible_tower_client/base_models/project"
 
 require "ansible_tower_client/v2/job_template_v2"
 

data/lib/ansible_tower_client/api.rb

@@ -4,6 +4,8 @@ module AnsibleTowerClient
   class Api < Connection
     include Logging
 
+    DEFAULT_ERROR_MSG = "An unknown error was returned from the provider".freeze
+
     attr_reader :instance
     def initialize(connection)
       @instance = connection
@@ -21,10 +23,18 @@ module AnsibleTowerClient
       JSON.parse(get("me").body).fetch_path("results", 0, "username")
     end
 
+    def activity_stream
+      Collection.new(self, activity_stream_class)
+    end
+
     def ad_hoc_commands
       Collection.new(self, ad_hoc_command_class)
     end
 
+    def credentials
+      Collection.new(self, credential_class)
+    end
+
     def groups
       Collection.new(self, group_class)
     end
@@ -53,6 +63,10 @@ module AnsibleTowerClient
       Collection.new(self, job_template_class)
     end
 
+    def projects
+      Collection.new(self, project_class)
+    end
+
     def method_missing(method_name, *args, &block)
       if instance.respond_to?(method_name)
         logger.debug { "#{self.class.name} Sending <#{method_name}> with <#{args.inspect}>" }
@@ -65,10 +79,11 @@ module AnsibleTowerClient
     rescue Faraday::ConnectionFailed, Faraday::SSLError => err
       raise
     rescue Faraday::ClientError => err
+      raise if err.response.nil?
       response = err.response
       logger.debug { "#{self.class.name} #{err.class.name} #{response.pretty_inspect}" }
       message   = JSON.parse(response[:body])['detail'] rescue nil
-      message ||= "An unknown error was returned from the provider"
+      message ||= DEFAULT_ERROR_MSG
       logger.error("#{self.class.name} #{err.class.name} #{message}")
       raise AnsibleTowerClient::ConnectionError, message
     end
@@ -79,10 +94,18 @@ module AnsibleTowerClient
 
     # Object class accessors patched for the appropriate version of the API
 
+    def activity_stream_class
+      @activity_stream_class ||= AnsibleTowerClient::ActivityStream
+    end
+
     def ad_hoc_command_class
       @ad_hoc_command_class ||= AnsibleTowerClient::AdHocCommand
     end
 
+    def credential_class
+      @credential_class ||= AnsibleTowerClient::Credential
+    end
+
     def group_class
       @group_class ||= AnsibleTowerClient::Group
     end
@@ -116,5 +139,9 @@ module AnsibleTowerClient
         end
       end
     end
+
+    def project_class
+      @project_class ||= AnsibleTowerClient::Project
+    end
   end
 end

data/lib/ansible_tower_client/base_model.rb

@@ -37,6 +37,110 @@ module AnsibleTowerClient
       super(raw_hash)
     end
 
+    # Persist a brand new record and return a
+    # representation of that object to the caller.
+    # Pass in the api connection and a JSON string.
+    #
+    # Example:
+    #    project = AnsibleTowerClient::Project.create!(connection.api, {:name => 'test'}.to_json)
+    #
+    #    # The values passed to create! are available in the resulting object
+    #    project.name            # => 'test'
+    # Errors:
+    #    Any error raised by the API will be returned and logged
+    #
+    def self.create!(api, attributes)
+      response = api.post("#{endpoint}/", attributes).body
+      new(api, JSON.parse(response))
+    end
+
+    # Just like create! except a false
+    #   is returned if the object is not saved.
+    #
+    def self.create(*args)
+      create!(*args)
+    rescue AnsibleTowerClient::Error
+      false
+    end
+
+    # Persist changes passed in as a Hash and return a
+    # representation of that object to the caller.
+    #
+    # Example:
+    #    project = connection.api.projects.find 2
+    #    project.update_attributes!(:name => 'test')
+    #
+    #    # The values passed to update_attributes! are available in calling object
+    #    project.name            # => 'test'
+    # Errors:
+    #    Any error raised by the API will be returned and logged
+    #
+    def update_attributes!(attributes)
+      @api.patch(url, attributes.to_json)
+      attributes.each do |method_name, value|
+        send("#{method_name}=", value)
+      end
+      true
+    end
+
+    # Just like update_attributes! except a true or false
+    #   is returned if the object is saved or not.
+    #
+    def update_attributes(attributes)
+      update_attributes!(attributes)
+    rescue AnsibleTowerClient::Error
+      false
+    end
+
+    # Persist in memory changes.
+    #
+    # Example:
+    #    project = connection.api.projects.find 2
+    #    project.name = 'test'
+    #    project.save!
+    #
+    #    # The in memory values are persisted.
+    #    project.name            # => 'test'
+    # Errors:
+    #    Any error raised by the API will be returned and logged
+    #
+    def save!
+      @api.patch(url, to_h.to_json)
+      true
+    end
+
+    # Just like save! except a true or false
+    #   is returned if the object is saved or not.
+    #
+    def save
+      save!
+    rescue AnsibleTowerClient::Error
+      false
+    end
+
+    # Delete the current object and
+    #   return the original instance.
+    #
+    # Example
+    #   project = connection.api.projects.find 2
+    #   project.destroy!
+    # Errors:
+    #    Any error raised by the API will be returned and logged
+    #
+    def destroy!
+      @api.delete(url)
+      self
+    end
+
+    # Just like destroy! except a false
+    #   is returned if the object is not deleted.
+    #
+    def destroy
+      destroy!
+    rescue AnsibleTowerClient::Error
+      false
+    end
+
     def hashify(attribute)
       YAML.safe_load(send(attribute))
     end
@@ -71,10 +175,6 @@ module AnsibleTowerClient
         key = "#{key}_id" if !key.end_with?('_id') && id_attrs.include?(key)
         key.underscore
       end
-
-      def generate_writer?
-        false
-      end
     end
   end
 end

data/lib/ansible_tower_client/base_models/activity_stream.rb

@@ -0,0 +1,7 @@
+module AnsibleTowerClient
+  class ActivityStream < BaseModel
+    def self.endpoint
+      "activity_stream".freeze
+    end
+  end
+end

data/lib/ansible_tower_client/base_models/credential.rb

@@ -0,0 +1,7 @@
+module AnsibleTowerClient
+  class Credential < BaseModel
+    def self.endpoint
+      "credentials".freeze
+    end
+  end
+end

data/lib/ansible_tower_client/base_models/project.rb

@@ -0,0 +1,7 @@
+module AnsibleTowerClient
+  class Project < BaseModel
+    def self.endpoint
+      "projects".freeze
+    end
+  end
+end

data/lib/ansible_tower_client/collection.rb

@@ -6,17 +6,20 @@ module AnsibleTowerClient
       @klass = klass
     end
 
-    def all
-      find_all_by_url(klass.endpoint)
+    # @param get_options [Hash] a hash of http GET params to pass to the api request
+    #   e.g. { :order_by => 'timestamp', :name__contains => 'foo' }
+    def all(get_options = nil)
+      find_all_by_url(klass.endpoint, get_options)
     end
 
-    def find_all_by_url(url)
+    def find_all_by_url(url, get_options = nil)
       Enumerator.new do |yielder|
         @collection = []
         next_page   = url
 
         loop do
-          next_page = fetch_more_results(next_page) if @collection.empty?
+          next_page = fetch_more_results(next_page, get_options) if @collection.empty?
+          get_options = nil
           raise StopIteration if @collection.empty?
           yielder.yield(@collection.shift)
         end
@@ -27,15 +30,23 @@ module AnsibleTowerClient
       build_object(parse_response(api.get("#{klass.endpoint}/#{id}/")))
     end
 
+    def create!(*args)
+      klass.create!(api, *args)
+    end
+
+    def create(*args)
+      klass.create(api, *args)
+    end
+
     private
 
     def class_from_type(type)
       api.send("#{type}_class")
     end
 
-    def fetch_more_results(next_page)
+    def fetch_more_results(next_page, get_options)
       return if next_page.nil?
-      body = parse_response(api.get(next_page))
+      body = parse_response(api.get(next_page, get_options))
       parse_result_set(body["results"])
 
       body["next"]

data/lib/ansible_tower_client/exception.rb

@@ -1,3 +1,6 @@
 module AnsibleTowerClient
-  class ConnectionError < Exception; end
+  class Error < Exception; end
+  class ConnectionError < Error; end
+  class NoMethodError < Error; end
+  class ClientError < Error; end
 end

data/lib/ansible_tower_client/logging.rb

@@ -1,3 +1,4 @@
+require 'forwardable'
 module AnsibleTowerClient
   module Logging
     extend Forwardable

data/lib/ansible_tower_client/middleware/raise_tower_error.rb

@@ -11,7 +11,7 @@ module AnsibleTowerClient
           # mimic the behavior that we get with proxy requests with HTTPS
           raise Faraday::Error::ConnectionFailed, %(407 "Proxy Authentication Required ")
         when CLIENT_ERROR_STATUSES
-          raise Faraday::Error::ClientError, env.body
+          raise AnsibleTowerClient::ClientError, env.body
         end
       end
 

data/lib/ansible_tower_client/version.rb

@@ -1,3 +1,3 @@
 module AnsibleTowerClient
-  VERSION = "0.4.1"
+  VERSION = "0.5.0".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ansible_tower_client
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Brandon Dunne
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-05 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -81,20 +81,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: factory_girl
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +133,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_local.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -158,7 +146,9 @@ files:
 - lib/ansible_tower_client.rb
 - lib/ansible_tower_client/api.rb
 - lib/ansible_tower_client/base_model.rb
+- lib/ansible_tower_client/base_models/activity_stream.rb
 - lib/ansible_tower_client/base_models/ad_hoc_command.rb
+- lib/ansible_tower_client/base_models/credential.rb
 - lib/ansible_tower_client/base_models/group.rb
 - lib/ansible_tower_client/base_models/host.rb
 - lib/ansible_tower_client/base_models/inventory.rb
@@ -166,6 +156,7 @@ files:
 - lib/ansible_tower_client/base_models/inventory_update.rb
 - lib/ansible_tower_client/base_models/job.rb
 - lib/ansible_tower_client/base_models/job_template.rb
+- lib/ansible_tower_client/base_models/project.rb
 - lib/ansible_tower_client/collection.rb
 - lib/ansible_tower_client/connection.rb
 - lib/ansible_tower_client/exception.rb