collins_client 0.2.9 → 0.2.10

data/.rbenv-version

@@ -0,0 +1 @@
+1.9.2-p290

data/VERSION

@@ -1 +1 @@
-0.2.9
+0.2.10

data/collins_client.gemspec

@@ -5,17 +5,18 @@
 
 Gem::Specification.new do |s|
   s.name = "collins_client"
-  s.version = "0.2.9"
+  s.version = "0.2.10"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Blake Matheny"]
-  s.date = "2012-11-19"
+  s.date = "2012-12-17"
   s.description = "Provides ruby support for interacting with the Collins API"
   s.email = "bmatheny@tumblr.com"
   s.extra_rdoc_files = [
     "README.md"
   ]
   s.files = [
+    ".rbenv-version",
     "Gemfile",
     "Gemfile.lock",
     "README.md",
@@ -39,6 +40,8 @@ Gem::Specification.new do |s|
     "lib/collins/api/util/responses.rb",
     "lib/collins/asset.rb",
     "lib/collins/asset_client.rb",
+    "lib/collins/asset_find.rb",
+    "lib/collins/asset_update.rb",
     "lib/collins/client.rb",
     "lib/collins/errors.rb",
     "lib/collins/ipmi.rb",

data/lib/collins/api/asset.rb

@@ -79,11 +79,6 @@ module Collins; module Api
     # @return [Array<Collins::Asset>] An array of assets matching the query
     # @raise [UnexpectedResponseError] If the HTTP response code is not a 200
     def find options = {}
-      solrquery = options.delete(:query)
-      if solrquery != nil then
-        return search solrquery, (options[:size] || 50), (options[:sort] || "ASC"), "tag", options
-      end
-      use_api_version "1.1"
       query = asset_hash_to_find_query options
       params = query.to_a.map do |param|
         key, val = param
@@ -102,32 +97,14 @@ module Collins; module Api
     end
 
     def search query, size = 50, sort = "ASC", sort_field = "tag", options = {}
-      use_api_version "1.2"
-      if query.start_with? "\"" and query.end_with? "\"" then
-        query = query[1..-2]
-      end
+      logger.warn("client method \"search\" is deprecated, please use find instead")
       params = {
         :query => query,
         :size => size,
         :sort => sort,
-        :sort_field => sort_field
+        :sortField => sort_field
       }
-      query = asset_hash_to_find_query options.merge(params)
-      params = query.to_a.map do |(key,val)|
-        if val.is_a?(Array) then
-          val.map{|v| "#{key}=#{asset_escape_attribute(v)}"}.join("&")
-        elsif val.nil? then
-          ""
-        else
-          "#{key}=#{asset_escape_attribute(val)}"
-        end
-      end.reject{|s| s.empty?}
-      logger.debug("perform asset search using query #{query} - #{params.inspect}")
-      http_get("/api/assets",params) do |response|
-        parse_response response, :expects => 200, :as => :paginated do |json|
-          json.map { |j| Collins::Asset.from_json(j) }
-        end
-      end
+      find params
     end
 
     def find_similar asset_or_tag, size = 50, sort = "ASC", sort_type = "distance", only_unallocated = true
@@ -152,7 +129,7 @@ module Collins; module Api
     end
 
     def asset_hash_to_find_query opts = {}
-      options = opts.clone
+      options = deep_copy_hash opts
       hash = {:attribute => []}
       okeys = options.keys
       Collins::Asset::Find::DATE_PARAMS.each do |query_key|

data/lib/collins/api/attributes.rb

@@ -1,6 +1,7 @@
 module Collins; module Api
 
   module Attributes
+
     def delete_attribute! asset_or_tag, attribute, group_id = nil
       asset = get_asset_or_tag asset_or_tag
       parameters = {
@@ -12,14 +13,36 @@ module Collins; module Api
         parse_response response, :expects => 202, :as => :status, :raise => strict?, :default => false
       end
     end
+
     def set_attribute! asset_or_tag, key, value, group_id = nil
+      set_multi_attribute! asset_or_tag, {key => value}, group_id
+    end
+
+    def set_multi_attribute! asset_or_tag, kv_hash, group_id = nil
       asset = get_asset_or_tag asset_or_tag
+      http_overrides = {}
       parameters = {
-        :attribute => "#{key};#{value}",
-        :groupId => group_id
+        :groupId => group_id,
+        :attribute => []
       }
+      kv_hash.each do |key,value|
+        if ::Collins::Asset::Update.is_attribute?(key) then
+          parameters[:attribute] << "#{key};#{value}"
+        else
+          p = ::Collins::Asset::Update.get_param(key)
+          parameters[p.to_sym] = ::Collins::Asset::Update.get_param_value(key, value)
+        end
+      end
+      if parameters[:attribute].empty? then
+        parameters[:attribute] = nil
+      elsif parameters[:attribute].size == 1 then
+        parameters[:attribute] = parameters[:attribute].first
+      else
+        http_overrides[:query_string_normalizer] = HTTParty::Request::NON_RAILS_QUERY_STRING_NORMALIZER
+      end
       parameters = select_non_empty_parameters parameters
-      logger.debug("Setting attribute #{key} to #{value} on #{asset.tag}")
+      logger.debug("Setting attributes #{parameters.inspect} on #{asset.tag}")
+      parameters[:http_options] = http_overrides unless http_overrides.empty?
       http_post("/api/asset/#{asset.tag}", parameters, asset.location) do |response|
         parse_response response, :expects => 200, :as => :status, :raise => strict?, :default => false
       end

data/lib/collins/api/logging.rb

@@ -109,7 +109,8 @@ module Collins; module Api
     # new solr interface
     def search_logs options = {}
       parameters = get_page_options(options).merge(
-        :query => get_option(:query, options, nil)
+        :query => get_option(:query, options, nil),
+        :sortField => get_option(:sortField, options, 'ID')
       )
       parameters = select_non_empty_parameters parameters
       logger.debug("Fetching logs for all assets with parameters #{parameters.inspect}")
@@ -118,7 +119,6 @@ module Collins; module Api
           json.map{|j| OpenStruct.new(symbolize_hash(j))}
         end
       end
-
     end
 
     # Same as logs but for all assets

data/lib/collins/api/util/requests.rb

@@ -37,8 +37,9 @@ module Collins; module Api; module Util
 
     def http_post uri, parameters = {}, remote = nil
       http_call(uri) {
+        http_overrides = parameters.delete(:http_options) || {}
         params = strip_request :body, :body => parameters
-        result = self.class.post(uri, http_options(params, remote))
+        result = self.class.post(uri, http_options(params, remote, http_overrides))
         if block_given? then
           yield(result)
         else
@@ -59,7 +60,7 @@ module Collins; module Api; module Util
       }
     end
 
-    def http_options opts = {}, remote = nil
+    def http_options opts = {}, remote = nil, overrides = {}
       if remote then
         host_info = get_location_information remote
         auth = {:username => host_info.username, :password => host_info.password}
@@ -70,6 +71,7 @@ module Collins; module Api; module Util
       end
       http_opts = opts.merge!({:basic_auth => auth, :base_uri => base_uri, :timeout => timeout_i})
       http_opts[:headers] = headers unless headers.empty?
+      http_opts.merge!(overrides)
       http_opts[:debug_output] = $stderr if (logger.level < 0 and Module.const_defined?(:HTTP_DEBUG) and HTTP_DEBUG)
       http_opts
     end

data/lib/collins/asset.rb

@@ -1,4 +1,6 @@
 require 'collins/address'
+require 'collins/asset_find'
+require 'collins/asset_update'
 require 'collins/ipmi'
 require 'collins/power'
 require 'collins/state'
@@ -14,33 +16,8 @@ module Collins
 
     # Asset finder related parameter descriptions
     # @note these exist here instead of the API module for convenience
-    module Find
-      # Find API parameters that are dates
-      # @return [Array<String>] Date related query parameters
-      DATE_PARAMS = [
-        "createdAfter", "createdBefore", "updatedAfter", "updatedBefore"
-      ]
-      # Find API parameters that are not dates
-      # This list exists so that when assets are being queries, we know what keys in the find hash
-      # are attributes of the asset (such as hostname), and which are nort (such as sort or page).
-      # @return [Array,<String>] Non-date related query parameters that are 'reserved'
-      GENERAL_PARAMS = [
-        "details", "tag", "type", "status", "page", "size", "sort", "state", "operation", "remoteLookup", "query",
-        "sort_field"
-      ]
-      # @return [Array<String>] DATE_PARAMS plus GENERAL_PARAMS
-      ALL_PARAMS = DATE_PARAMS + GENERAL_PARAMS
-
-      class << self
-        def to_a
-          Collins::Asset::Find::ALL_PARAMS
-        end
-        def valid? key
-          to_a.include?(key.to_s)
-        end
-      end
-    end
-
+    include Collins::Asset::Find
+    include Collins::Asset::Update
     include Collins::Util
 
     # @return [Array<CollinsAddress>] Addresses associated with asset

data/lib/collins/asset_find.rb

@@ -0,0 +1,29 @@
+module Collins
+  class Asset
+    module Find
+      # Find API parameters that are dates
+      # @return [Array<String>] Date related query parameters
+      DATE_PARAMS = [
+        "createdAfter", "createdBefore", "updatedAfter", "updatedBefore"
+      ]
+      # Find API parameters that are not dates
+      # This list exists so that when assets are being queries, we know what keys in the find hash
+      # are attributes of the asset (such as hostname), and which are nort (such as sort or page).
+      # @return [Array,<String>] Non-date related query parameters that are 'reserved'
+      GENERAL_PARAMS = [
+        "details", "tag", "type", "status", "page", "size", "sort", "state", "operation", "remoteLookup", "query",
+        "sortField"
+      ]
+      # @return [Array<String>] DATE_PARAMS plus GENERAL_PARAMS
+      ALL_PARAMS = DATE_PARAMS + GENERAL_PARAMS
+      class << self
+        def to_a
+          Collins::Asset::Find::ALL_PARAMS
+        end
+        def valid? key
+          to_a.include?(key.to_s)
+        end
+      end
+    end
+  end
+end

data/lib/collins/asset_update.rb

@@ -0,0 +1,69 @@
+module Collins
+  class Asset
+    # Params we know about for updates, others come in via attribute hash
+    module Update
+
+      NON_ATTRIBUTE_PARAMS = [
+        "CHASSIS_TAG", "RACK_POSITION", /^POWER_(.*)_(.*)/i
+      ]
+      FILE_PARAMS = [
+        "lshw", "lldp"
+      ]
+      ALL_PARAMS = NON_ATTRIBUTE_PARAMS + FILE_PARAMS
+
+      class << self
+
+        def to_a
+          Collins::Asset::Update::ALL_PARAMS
+        end
+
+        def get_param_value key, value
+          if is_file_param?(key) then
+            if value.start_with?('@') then
+              filename = File.expand_path(value[1..-1])
+              if !File.readable?(filename) then
+                msg = "Could not read file '#{filename}' for key '#{key}'"
+                raise ::Collins::ExpectationFailedError.new msg
+              else
+                File.read(filename)
+              end
+            else
+              value
+            end
+          else
+            value
+          end
+        end # get_param_value
+
+        def get_param key
+          to_a.each do |k|
+            if k.is_a?(Regexp) && !k.match(key).nil? then
+              # Assume it's a power setting until we have >1 regexp
+              return key.upcase
+            elsif key.to_s.downcase == k.to_s.downcase then
+              return k
+            end
+          end
+          return key
+        end # get_param
+
+        def is_file_param? key
+          FILE_PARAMS.map{|k|k.to_s.downcase}.include?(key.to_s.downcase)
+        end # is_file_param?
+
+        def is_attribute? key
+          to_a.each do |k|
+            if k.is_a?(Regexp) && !k.match(key).nil? then
+              return false
+            elsif key.to_s.downcase == k.to_s.downcase then
+              return false
+            end
+          end
+          return true
+        end # is_attribute?
+
+      end # class << self
+
+    end # module Update
+  end # class Asset
+end # module Collins

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: collins_client
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.2.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-19 00:00:00.000000000 Z
+date: 2012-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -34,6 +34,7 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
+- .rbenv-version
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -57,6 +58,8 @@ files:
 - lib/collins/api/util/responses.rb
 - lib/collins/asset.rb
 - lib/collins/asset_client.rb
+- lib/collins/asset_find.rb
+- lib/collins/asset_update.rb
 - lib/collins/client.rb
 - lib/collins/errors.rb
 - lib/collins/ipmi.rb
@@ -84,7 +87,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -117054897362145987
+      hash: -2685565510305324275
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: