ubuntu_ami 0.4.0 → 0.4.1

data/lib/chef/knife/ec2_amis_ubuntu.rb

@@ -31,22 +31,66 @@ module KnifePlugins
 
     banner "knife ec2 amis ubuntu DISTRO [TYPE] (options)"
 
+    # Substitutes dashes for underscores in region portion of type for
+    # nice display. Replaces "1" as implied for most regions.
+    #
+    # === Parameters
+    # region<String>:: comes from Ubuntu::Ami#region
+    #
+    # === Returns
+    # String:: e.g., us_east_small or us_east_small_ebs
     def region_fix(region)
       region.gsub(/-1/,'').gsub(/-/,'_')
     end
 
+    # Indicates whether a particular image has EBS root volume.
+    #
+    # === Parameters
+    # store<String>:: comes from Ubuntu::Ami#root_store
+    #
+    # === Returns
+    # String:: "_ebs" if the #root_store is EBS, otherwise empty.
     def disk_store(store)
       store =~ /ebs/ ? "_ebs" : ''
     end
 
+    # Indicates whether the architecture type is a large or small AMI.
+    #
+    # === Parameters
+    # arch<String>:: Values can be amd64, x86_64, large, or begin with
+    # "64". Intended to be from Ubuntu::Ami#arch, but this method
+    # move to Ubuntu directly.
+    #
+    # === Returns
+    # String:: For 64 bit architectures (Ubuntu::Ami#arch #=> amd64),
+    # this will return "large". Otherwise, it returns "small".
     def size_of(arch)
       String(arch) =~ /(amd64|x86_64|large|^64)/ ? "large" : "small"
     end
 
+    # Makes a nice string for the type of AMI to display, including
+    # the region, architecture size and whether the AMI has EBS root
+    # store.
+    #
+    # === Parameters
+    # region<String>:: from Ubuntu::Ami#region
+    # arch<String>:: from Ubuntu::Ami#arch
+    # root_store<String>:: from Ubuntu::Ami#root_store
+    #
+    # === Returns
+    # String:: The region, arch and root_store (if EBS) concatenated
+    # with underscore (_).
     def build_type(region, arch, root_store)
       "#{region_fix(region)}_#{size_of(arch)}#{disk_store(root_store)}"
     end
 
+    # Iterates over the AMIs available for the specified distro.
+    #
+    # === Parameters
+    # distro<String>:: Release name of the distro to display.
+    #
+    # === Returns
+    # Hash:: Keys are the AMI type, values are the AMI ID.
     def list_amis(distro)
       amis = Hash.new
       Ubuntu.release(distro).amis.each do |ami|
@@ -55,6 +99,8 @@ module KnifePlugins
       amis
     end
 
+    # Runs the plugin. If TYPE (name_args[1]) is passed, then select a
+    # specified type, based on #build_type, above.
     def run
       distro = name_args[0]
       type = name_args[1]

data/lib/ubuntu_ami.rb

@@ -34,6 +34,10 @@ class Ubuntu
     @release_name = release_name
   end
 
+  # Map the output from Canonical's image list.
+  #
+  # === Returns
+  # Array:: An array of Ubuntu::Ami objects.
   def amis
     content.map do |line|
       Ami.new(
@@ -45,10 +49,22 @@ class Ubuntu
     end
   end
 
+  # The URL of Canonical's current released AMIs for the given
+  # release.
+  #
+  # Visit "http://uec-images.ubuntu.com/query" to get a list of
+  # available releases.
+  #
+  # === Returns
+  # String:: The full URL to the released AMIs.
   def url
     "http://uec-images.ubuntu.com/query/#{release_name}/server/released.current.txt"
   end
 
+  # Reads the URL for processing.
+  # === Exception
+  # Raises an exception if the release name was not specified or was
+  # not found.
   def content
     begin
       @content ||= open(url).read.split("\n")
@@ -57,6 +73,7 @@ class Ubuntu
     end
   end
 
+  # Provides accessors for the properties of the AMI list.
   class Ami
     attr_reader :name, :root_store, :arch, :region, :virtualization_type
 

data/lib/ubuntu_ami/version.rb

@@ -17,6 +17,6 @@
 
 class Ubuntu
   class Ami
-    VERSION = '0.4.0'
+    VERSION = '0.4.1'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ubuntu_ami
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.4.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,13 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-11 00:00:00.000000000Z
+date: 2013-02-02 00:00:00.000000000 Z
 dependencies: []
-description: Retrieves AMI information from Canonical's Ubuntu release list.
+description: Retrieves AMI information from Canonical's Ubuntu release list.Also provides
+  a knife plugin to retrieve the list.
 email: joshua@opscode.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- LICENSE
 files:
 - LICENSE
 - README.md
@@ -42,7 +45,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Retrieves AMI information from Canonical's Ubuntu release list.