ogle 0.1.2 → 0.2.0

data/README.md

@@ -16,31 +16,7 @@ Depending on the call you make, glance will sometimes return JSON and others XML
 
 ### Examples
 
-    require "ogle"
-
-    CONNECTION = Ogle::Client.new(
-      :host => "example.com"
-    )
-
-    # This will give a list of all the images
-    response = CONNECTION.image.all
-    puts response
-
-    # This will give a detailed list of all the images
-    response = CONNECTION.image true
-    puts response
-
-    # This will return a list of only images that are runable (are not aki or ari)
-    response = CONNECTION.image.runable
-    puts response
-
-    # This will return headers for a specific image as a hash
-    response = CONNECTION.image.find 6
-    puts response
-
-    # This will delete a given image
-    response = CONNECTION.image.delete 6
-    puts response.code
+Please see the examples wiki here: https://github.com/kevinbringard/ogle/wiki/Examples
 
 ## Compatability
 

data/lib/ogle/image.rb

@@ -1,4 +1,33 @@
 module Ogle
+  class ImageData
+    ##
+    # Return a valid ami id from the given 'glance id'.
+    #
+    # +glance_id+: A String representing an image id in glance.
+    #
+    # Note:
+    #   Glance image ids differ from those used by the EC2 API.
+    #   Currently there is no way to query EC2 for a glance_id
+    #   or vice versa.
+
+    def to_ami_id
+      hex    = self.id.to_i.to_s 16
+      padded = hex.to_s.rjust 8,"0"
+
+      "ami-#{padded}"
+    end
+
+    def initialize hash
+      class << self; self end.instance_eval do
+        hash.each_pair.each do |k, v|
+          define_method k do
+            v
+          end
+        end
+      end
+    end
+  end
+
   class Image
     def initialize connection
       @connection = connection
@@ -15,7 +44,9 @@ module Ogle
 
       response = @connection.get path
 
-      response.body['images']
+      response.body['images'].collect do |r|
+        ImageData.new r
+      end
     end
 
     ##
@@ -26,17 +57,19 @@ module Ogle
     def find image_id
       response = @connection.head "/images/#{image_id}"
 
-      Hash.new.tap do |h|
-        properties = h['properties'] = Hash.new
-        response.each_header do |k, v|
-          case k.downcase.tr '-', '_'
-            when %r{^x_image_meta_property_([a-z_]+)$}
-              properties[$1] = v
-            when %r{^x_image_meta_([a-z_]+)$}
-              h[$1] = v
+      ImageData.new(
+        Hash.new.tap do |h|
+          properties = h['properties'] = Hash.new
+          response.each_header do |k, v|
+            case k.downcase.tr '-', '_'
+              when %r{^x_image_meta_property_([a-z_]+)$}
+                properties[$1] = v
+              when %r{^x_image_meta_([a-z_]+)$}
+                h[$1] = v
+            end
           end
         end
-      end
+      )
     end
 
     ##
@@ -51,13 +84,11 @@ module Ogle
       end
     end
 
-    def create file
-    end
-
     ##
-    # Delete an image
+    # Delete an image.
+    #
     # +image_id+: A String representing an image_id.
-    
+
     def delete image_id
       response = @connection.delete "/images/#{image_id}"
     end
@@ -67,8 +98,8 @@ module Ogle
     # Kernels and Ramdisks are not runable, so we want to ignore them.
 
     def runable? image
-      image['container_format'] == "ami" &&
-      image['disk_format'] == "ami"
+      image.container_format == "ami" &&
+      image.disk_format == "ami"
     end
   end
 end

data/lib/ogle/version.rb

@@ -1,3 +1,3 @@
 module Ogle
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/test/cassettes/image_find.yml

@@ -0,0 +1,139 @@
+--- 
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :head
+    uri: http://10.3.170.32:9292/images/6
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      connection: 
+      - keep-alive
+      keep-alive: 
+      - 30
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - text/html; charset=UTF-8
+      content-length: 
+      - "0"
+      x-image-meta-property-distro: 
+      - CentOS
+      x-image-meta-id: 
+      - "6"
+      x-image-meta-property-arch: 
+      - x86_64
+      x-image-meta-deleted: 
+      - "False"
+      x-image-meta-container-format: 
+      - ami
+      x-image-meta-location: 
+      - file:///var/lib/glance/images/6
+      x-image-meta-deleted-at: 
+      - ""
+      x-image-meta-created-at: 
+      - 2011-04-11T21:04:51
+      x-image-meta-size: 
+      - "816906240"
+      x-image-meta-status: 
+      - active
+      x-image-meta-property-type: 
+      - machine
+      x-image-meta-property-uploader: 
+      - root@cc-01
+      x-image-meta-is-public: 
+      - "True"
+      x-image-meta-updated-at: 
+      - 2011-04-11T21:04:56
+      x-image-meta-checksum: 
+      - 6277381feb8708c393c64499a0ce7e1e
+      x-image-meta-property-version: 
+      - "5.5"
+      x-image-meta-disk-format: 
+      - ami
+      x-image-meta-name: 
+      - CentOS5-5.5-Base_VM-032311-212432
+      location: 
+      - http://10.3.170.32:9292/images/6
+      etag: 
+      - 6277381feb8708c393c64499a0ce7e1e
+      date: 
+      - Thu, 21 Apr 2011 00:17:37 GMT
+      connection: 
+      - keep-alive
+    body: 
+    http_version: "1.1"
+- !ruby/struct:VCR::HTTPInteraction 
+  request: !ruby/struct:VCR::Request 
+    method: :head
+    uri: http://10.3.170.32:9292/images/17
+    body: 
+    headers: 
+      accept: 
+      - application/json
+      connection: 
+      - keep-alive
+      keep-alive: 
+      - 30
+  response: !ruby/struct:VCR::Response 
+    status: !ruby/struct:VCR::ResponseStatus 
+      code: 200
+      message: OK
+    headers: 
+      content-type: 
+      - text/html; charset=UTF-8
+      content-length: 
+      - "0"
+      x-image-meta-property-distro: 
+      - Ubuntu
+      x-image-meta-id: 
+      - "17"
+      x-image-meta-property-arch: 
+      - amd64
+      x-image-meta-deleted: 
+      - "False"
+      x-image-meta-container-format: 
+      - ami
+      x-image-meta-property-uploader: 
+      - root@e21ab3
+      x-image-meta-location: 
+      - file:///var/lib/glance/images/17
+      x-image-meta-deleted-at: 
+      - ""
+      x-image-meta-created-at: 
+      - 2011-04-18T17:08:02
+      x-image-meta-size: 
+      - "2610561024"
+      x-image-meta-status: 
+      - active
+      x-image-meta-property-type: 
+      - machine
+      x-image-meta-property-kernel-name: 
+      - maverick-server-uec-amd64-vmlinuz-virtual
+      x-image-meta-is-public: 
+      - "True"
+      x-image-meta-property-kernel-id: 
+      - "1"
+      x-image-meta-updated-at: 
+      - 2011-04-18T17:08:32
+      x-image-meta-checksum: 
+      - c283810a95e1c8028cb22ca39f0fc40d
+      x-image-meta-property-version: 
+      - "10.10"
+      x-image-meta-disk-format: 
+      - ami
+      x-image-meta-name: 
+      - maverick-server-uec-amd64-CloudFoundry
+      location: 
+      - http://10.3.170.32:9292/images/17
+      etag: 
+      - c283810a95e1c8028cb22ca39f0fc40d
+      date: 
+      - Thu, 21 Apr 2011 00:17:37 GMT
+      connection: 
+      - keep-alive
+    body: 
+    http_version: "1.1"

data/test/lib/ogle/{resource_test.rb → image_test.rb}

@@ -4,11 +4,6 @@ CONNECTION = Ogle::Client.new(
   :host => "10.3.170.32"
 )
 
-def must_have_valid_keys response, keys
-  raise "The response passed in is empty." if response.keys.empty?
-  response.keys.delete_if { |k| keys.include? k }.must_be_empty
-end
-
 describe Ogle::Image do
   describe "#all" do
     before do
@@ -17,12 +12,12 @@ describe Ogle::Image do
       end
     end
 
-    it "returns a hash of images" do
+    it "returns all images" do
       @response.size.must_be :>=, 1
     end
 
     it "returns metadata" do
-      must_have_valid_keys @response.first, METADATA_KEYS
+      must_have_valid_methods @response.first, METADATA_KEYS
     end
   end
 
@@ -33,12 +28,12 @@ describe Ogle::Image do
       end
     end
 
-    it "returns a detailed hash of images" do
+    it "returns detailed images" do
       @response.size.must_be :>=, 1
     end
 
     it "returns metadata" do
-      must_have_valid_keys @response.first, DETAILED_METADATA_KEYS
+      must_have_valid_methods @response.first, DETAILED_METADATA_KEYS
     end
   end
 
@@ -49,12 +44,12 @@ describe Ogle::Image do
       end
     end
 
-    it "returns a hash of all images which are runable" do
-      @response.any? { |i| i['id'] != 1}.must_equal true
+    it "returns all images which are runable" do
+      @response.any? { |i| i.id != 1}.must_equal true
     end
 
     it "returns metadata" do
-      must_have_valid_keys @response.first, METADATA_KEYS
+      must_have_valid_methods @response.first, METADATA_KEYS
     end
   end
 
@@ -63,7 +58,7 @@ describe Ogle::Image do
       response = CONNECTION.image.runable(true)
 
       it "returns metadata" do
-        must_have_valid_keys response.first, DETAILED_METADATA_KEYS
+        must_have_valid_methods response.first, DETAILED_METADATA_KEYS
       end
     end
   end
@@ -76,11 +71,11 @@ describe Ogle::Image do
     end
 
     it "returns X-Image-Meta-* headers as a hash" do
-      must_have_valid_keys @response, DETAILED_METADATA_KEYS
+      must_have_valid_methods @response, DETAILED_METADATA_KEYS
     end
 
     it "returns a nested properties hash" do
-      must_have_valid_keys @response['properties'], %w(
+      must_have_valid_keys @response.properties, %w(
         distro
         arch
         uploader
@@ -95,10 +90,39 @@ describe Ogle::Image do
   describe "#delete" do
     VCR.use_cassette "image_delete" do
       response = CONNECTION.image.delete 15
-    
+
       it "returns an HTTP/1.1 200 OK" do
         response.code.must_equal "200"
       end
     end
   end
+
+  def must_have_valid_keys response, keys
+    raise "The response passed in is empty." if response.keys.empty?
+    response.keys.delete_if { |k| keys.include? k }.must_be_empty
+  end
+
+  def must_have_valid_methods response, keys
+    keys.each { |k| response.respond_to? k }
+  end
+end
+
+describe Ogle::ImageData do
+  describe "#to_ami_id" do
+    it "return a valid ami id" do
+      VCR.use_cassette "image_find" do
+        @response = CONNECTION.image.find 6
+
+        @response.to_ami_id.must_equal "ami-00000006"
+      end
+    end
+
+    it "return a valid hex ami id" do
+      VCR.use_cassette "image_find" do
+        @response = CONNECTION.image.find 17
+
+        @response.to_ami_id.must_equal "ami-00000011"
+      end
+    end
+  end
 end

data/test/test_helper.rb

@@ -28,13 +28,12 @@ class MiniTest::Unit::TestCase
     properties
     size
   )
-
 end
 
 VCR.config do |c|
   c.stub_with :webmock
   c.cassette_library_dir     = "test/cassettes"
-  c.default_cassette_options = { :record => :new_episodes }
+  c.default_cassette_options = { :record => :none }
 end
 
 MiniTest::Unit.autorun

metadata

@@ -2,7 +2,7 @@
 name: ogle
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Kevin Bringard
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-18 00:00:00 -06:00
+date: 2011-04-21 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -89,12 +89,13 @@ files:
 - lib/ogle/version.rb
 - ogle.gemspec
 - test/cassettes/image_delete.yml
+- test/cassettes/image_find.yml
 - test/cassettes/images_all.yml
 - test/cassettes/images_all_with_details.yml
 - test/cassettes/images_find.yml
 - test/cassettes/images_runable.yml
 - test/cassettes/images_runable_with_details.yml
-- test/lib/ogle/resource_test.rb
+- test/lib/ogle/image_test.rb
 - test/test_helper.rb
 has_rdoc: true
 homepage: ""
@@ -126,10 +127,11 @@ specification_version: 3
 summary: Ruby interface for OpenStack Glance
 test_files: 
 - test/cassettes/image_delete.yml
+- test/cassettes/image_find.yml
 - test/cassettes/images_all.yml
 - test/cassettes/images_all_with_details.yml
 - test/cassettes/images_find.yml
 - test/cassettes/images_runable.yml
 - test/cassettes/images_runable_with_details.yml
-- test/lib/ogle/resource_test.rb
+- test/lib/ogle/image_test.rb
 - test/test_helper.rb