collins_client 0.2.7

data/Gemfile

@@ -0,0 +1,15 @@
+source :rubygems
+
+gem 'httparty',      '~> 0.8.3'
+
+group :development do
+  gem 'jeweler',       '~> 1.8.3'
+  gem 'yard'
+  gem 'redcarpet'
+end
+
+group :test do
+  gem 'rspec'
+  gem 'webmock'
+  gem 'simplecov'
+end

data/Gemfile.lock

@@ -0,0 +1,50 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.3.2)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    git (1.2.5)
+    httparty (0.8.3)
+      multi_json (~> 1.0)
+      multi_xml
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    multi_json (1.3.6)
+    multi_xml (0.5.1)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    redcarpet (2.1.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    simplecov (0.6.4)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+    webmock (1.8.10)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+    yard (0.8.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty (~> 0.8.3)
+  jeweler (~> 1.8.3)
+  redcarpet
+  rspec
+  simplecov
+  webmock
+  yard

data/README.md

@@ -0,0 +1,46 @@
+# Collins::Client
+
+The collins-service gem provides a library for API access to Collins.
+
+## Installation
+
+First install rvm
+
+    $ bash -s stable < <(curl -s https://raw.github.com/wayneeseguin/rvm/master/binscripts/rvm-installer)
+    $ source ~/.bash_profile
+    $ rvm requirements
+    $ rvm install 1.9.3
+    $ rvm use 1.9.3
+
+Install the collins gem and use it
+
+    $ gem install --source=http://repo.tumblr.net:9929/ collins_client
+
+Remember, if you don't have 1.9.3 set as the default, before you use collins you'll need to do `rvm use 1.9.3`.
+
+## Usage
+
+    #!/usr/bin/env ruby
+    require 'collins_client'
+    config = {:username => "foo", :password => "bar", :host => "http://127.0.0.1:8080"}
+    client = Collins::Client.new config
+    client.find :HOSTNAME => /^abc.*/
+
+## Note for developers
+
+If you are implementing support for a new API endpoint, and that endpoint
+requires an asset tag, please observe the standard of having the method
+parameter be named `asset_or_tag`. For instance do:
+
+    def new_method asset_or_tag
+      # some work
+    end
+
+and not
+
+    def new_method an_asset
+      # some work
+    end
+
+The `AssetClient` class depends on this naming convention to know how to
+appropriately proxy method calls to the collins client instance.

data/Rakefile

@@ -0,0 +1,66 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+require 'jeweler'
+require 'yard'
+
+jeweler = Jeweler::Tasks.new do |gem|
+  gem.name = 'collins_client'
+  gem.homepage = 'https://github.com/tumblr/collins/tree/master/support/ruby/collins-client'
+  gem.license = 'APL 2.0'
+  gem.summary = %Q{Client library for Collins API}
+  gem.description = "Provides ruby support for interacting with the Collins API"
+  gem.email = 'bmatheny@tumblr.com'
+  gem.authors = ['Blake Matheny']
+  gem.files.exclude "spec/**/*"
+  gem.files.exclude '.gitignore'
+  gem.files.exclude '.rspec'
+  gem.files.exclude '.rvmrc'
+  gem.add_runtime_dependency 'httparty', '~> 0.8.3'
+end
+
+task :help do
+  puts("rake -T                  # See available rake tasks")
+  puts("rake publish             # generate gemspec, build it, push it to repo")
+  puts("rake version:bump:patch  # Bump patch number")
+  puts("rake all                 # bump patch and publish")
+  puts("rake                     # Run tests")
+end
+
+task :publish => [:gemspec, :build] do
+  package_abs = jeweler.jeweler.gemspec_helper.gem_path
+  package_name = File.basename(package_abs)
+
+  ["repo.tumblr.net","repo.ewr01.tumblr.net"].each do |host|
+    puts("Copying #{package_abs} to #{host} and installing, you may be prompted for your password")
+    system "scp #{package_abs} #{host}:"
+    system "ssh -t #{host} 'sudo tumblr_gem install #{package_name}'"
+  end
+end
+
+task :all => ["version:bump:patch", :publish] do
+  puts("Done!")
+end
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.fail_on_error = false
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+  t.options = ['--markup', 'markdown']
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.7

data/collins_client.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "collins_client"
+  s.version = "0.2.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Blake Matheny"]
+  s.date = "2012-10-31"
+  s.description = "Provides ruby support for interacting with the Collins API"
+  s.email = "bmatheny@tumblr.com"
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "collins_client.gemspec",
+    "lib/collins/address.rb",
+    "lib/collins/api.rb",
+    "lib/collins/api/admin.rb",
+    "lib/collins/api/asset.rb",
+    "lib/collins/api/asset_state.rb",
+    "lib/collins/api/attributes.rb",
+    "lib/collins/api/ip_address.rb",
+    "lib/collins/api/logging.rb",
+    "lib/collins/api/management.rb",
+    "lib/collins/api/tag.rb",
+    "lib/collins/api/util.rb",
+    "lib/collins/api/util/errors.rb",
+    "lib/collins/api/util/parameters.rb",
+    "lib/collins/api/util/requests.rb",
+    "lib/collins/api/util/responses.rb",
+    "lib/collins/asset.rb",
+    "lib/collins/asset_client.rb",
+    "lib/collins/client.rb",
+    "lib/collins/errors.rb",
+    "lib/collins/ipmi.rb",
+    "lib/collins/logging.rb",
+    "lib/collins/monkeypatch.rb",
+    "lib/collins/option.rb",
+    "lib/collins/power.rb",
+    "lib/collins/profile.rb",
+    "lib/collins/simple_callback.rb",
+    "lib/collins/state.rb",
+    "lib/collins/util.rb",
+    "lib/collins_client.rb"
+  ]
+  s.homepage = "https://github.com/tumblr/collins/tree/master/support/ruby/collins-client"
+  s.licenses = ["APL 2.0"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "Client library for Collins API"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, ["~> 0.8.3"])
+    else
+      s.add_dependency(%q<httparty>, ["~> 0.8.3"])
+    end
+  else
+    s.add_dependency(%q<httparty>, ["~> 0.8.3"])
+  end
+end
+

data/lib/collins/address.rb

@@ -0,0 +1,74 @@
+module Collins
+
+  class Address
+    include Collins::Util
+
+    attr_accessor :id, :asset_id, :address, :gateway, :netmask, :pool
+
+    class << self
+      def from_json json
+        return [] if json.nil? || json.empty?
+        if not json.is_a?(Array) then
+          json = [json]
+        end
+        json.map { |j| Collins::Address.new j }
+      end
+
+      def is_private? address
+        if address =~ /^10\./ then
+          true
+        elsif address =~ /^192\.168\./ then
+          true
+        elsif address =~ /^172\.(?:1[6-9]|2[0-9]|3[0-1])\./ then
+          true
+        else
+          false
+        end
+      end
+      def is_public? address
+        not is_private?(address)
+      end
+    end
+
+    def initialize model = {}
+      hash = symbolize_hash(model).inject({}) do |result, (k,v)|
+        result[k.downcase] = v
+        result
+      end
+      @id = hash[:id].to_s.to_i
+      @asset_id = hash[:asset_id].to_s.to_i
+      @address = hash[:address].to_s
+      @gateway = hash[:gateway].to_s
+      @netmask = hash[:netmask].to_s
+      @pool = hash[:pool].to_s
+    end
+
+    def is_addressable?
+      @address.length > 0
+    end
+
+    def is_private?
+      Collins::Address.is_private? @address
+    end
+
+    def is_public?
+      is_addressable? and not is_private?
+    end
+
+    def to_hash
+      {
+        :address => @address,
+        :gateway => @gateway,
+        :netmask => @netmask,
+        :pool => @pool,
+        :is_private => is_private?,
+        :is_public => is_public?
+      }
+    end
+    def to_s
+      "Collins::Address(address = %{address}, gateway = %{gateway}, netmask = %{netmask}, is_private = %{is_private})" % to_hash
+    end
+
+  end
+
+end

data/lib/collins/api.rb

@@ -0,0 +1,119 @@
+require 'collins/api/admin'
+require 'collins/api/asset'
+require 'collins/api/asset_state'
+require 'collins/api/attributes'
+require 'collins/api/ip_address'
+require 'collins/api/logging'
+require 'collins/api/management'
+require 'collins/api/tag'
+require 'collins/api/util'
+
+module Collins
+  module Api
+
+    # Provides get_asset_or_tag, require stuff, and symbolize
+    include Collins::Util
+
+    # @abstract
+    # @return [Hash<String,String>] hash with header keys/values
+    def headers
+      raise NotImplementedError.new("Classes including the Api module must provide a headers hash")
+    end
+
+    # @abstract
+    # @return [String] the collins host
+    def host
+      raise NotImplementedError.new("Classes including the Api module must provide a host")
+    end
+
+    # Only used for multi-collins systems
+    # @abstract
+    # @return [Hash<Symbol,OpenStruct>] hash with keys as locations, values as collins credentials.
+    def locations
+      raise NotImplementedError.new("Classes including the Api module must provide a locations hash")
+    end
+
+    # @abstract
+    # @return [Logger] a logger instance
+    def logger
+      raise NotImplementedError.new("Classes including the Api module must provide a logger")
+    end
+
+    # @abstract
+    # @return [String] a password for authentication
+    def password
+      raise NotImplementedError.new("Classes including the Api module must provide a password")
+    end
+
+    # How to deal with unexpected API responses
+    #
+    # When true, API methods will throw an exception if an unexpected response is encountered.
+    # When false, API methods will usually normalize responses to an appropriate value indicating
+    # failure.
+    #
+    # @param [Boolean] default
+    # @abstract
+    # @return [Boolean] strict or not
+    def strict? default = false
+      raise NotImplementedError.new("Classes including the Api module must provide a strict? method")
+    end
+
+    # @abstract
+    # @return [Fixnum] a timeout in seconds
+    def timeout_i
+      raise NotImplementedError.new("Classes including the Api module must provide a timeout")
+    end
+
+    # @abstract
+    # @return [String] a username for authentication
+    def username
+      raise NotImplementedError.new("Classes including the Api module must provide a username")
+    end
+
+    # Clear out all headers
+    # @return [nil]
+    def clear_headers
+      headers.clear # Yes, this returns an empty hash not nil
+    end
+
+    # Set a key/value in the headers hash
+    #
+    # @param [Symbol,String] key
+    # @param [String] value
+    # @return [nil]
+    def set_header key, value
+      headers.update(key => value)
+    end
+
+    # Provides a safe wrapper for our monkeypatched logger
+    #
+    # If the provided logger responds to a trace method, use that method. Otherwise fallback to
+    # using the debug method.
+    def trace(progname = nil, &block)
+      if logger.respond_to?(:trace) then
+        logger.trace(progname, &block)
+      else
+        logger.debug(progname, &block)
+      end
+    end
+
+    def use_api_version version
+      set_header "Accept", "application/json,#{version_string(version)}"
+    end
+
+    include Collins::Api::Admin
+    include Collins::Api::Asset
+    include Collins::Api::AssetState
+    include Collins::Api::Attributes
+    include Collins::Api::IpAddress
+    include Collins::Api::Logging
+    include Collins::Api::Management
+    include Collins::Api::Tag
+    include Collins::Api::Util
+
+    protected
+    def version_string version
+      "application/com.tumblr.collins;version=#{version}"
+    end
+  end
+end