ec2-metadata 0.1.0 → 0.2.0

data/.gitignore

@@ -1,21 +1,22 @@
-## MAC OS
-.DS_Store
 
-## TEXTMATE
-*.tmproj
-tmtags
 
-## EMACS
-*~
-\#*
-.\#*
 
-## VIM
-*.swp
 
+
+## EMACS
+## MAC OS
 ## PROJECT::GENERAL
+## PROJECT::SPECIFIC
+## TEXTMATE
+## VIM
+*.swp
+*.tmproj
+*~
+.DS_Store
+.\#*
+/ec2-metadata-0.1.0.gem
+\#*
 coverage
-rdoc
 pkg
-
-## PROJECT::SPECIFIC
+rdoc
+tmtags

data/README.rdoc

@@ -1,6 +1,50 @@
 = ec2-metadata
 
-Description goes here.
+== Install
+ $ [sudo] gem install ec2-metadata
+
+== As ruby library
+ec-metadata provides a way to access meta-data and user-data on EC2 instance. 
+
+ Ec2Metadata[:instance_id]
+ Ec2Metadata['instance_id']
+ Ec2Metadata[:'instance-id']
+ Ec2Metadata['instance-id']
+
+If you want to specify API version, you can get data like this:
+ Ec2Metadata['1.0'][:instance_id]
+
+If you can also get it like this:
+ Ec2Metadata['1.0']['meta-data'][:instance_id]
+
+For more detail, see also:
+http://github.com/akm/ec2-metadata/blob/master/spec/introduction_spec.rb
+
+
+== As a command
+ec2-metadata shows various meta-data and user-data
+ $ ec2-metadata
+
+For more detail, type 
+ $ ec2-metadata -h
+
+
+== Dummy YAML
+If you want to access meta-data or user-data not on EC2 Instance like on it,
+make one of these files
+ ./config/ec2_metadata.yml
+ ./ec2_metadata.yml
+ ~/ec2_metadata.yml
+ /etc/ec2_metadata.yml
+
+Dummy YAML file must be like output of ec2-metadata on EC2 instance.
+You can export it on EC2 instance like this:
+ $ ec2-medatata > ec2_metadata.yml
+ $ cp ec2_metadata.yml /path/to/dir/for/non/ec2/instance
+
+Or if you don't have EC2 instance, you can get an example by
+ $ ec2-metadata -d
+
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -10,6 +10,8 @@ begin
     gem.email = "akm2000@gmail.com"
     gem.homepage = "http://github.com/akm/ec2-metadata"
     gem.authors = ["Takeshi AKIMA"]
+    gem.bindir = 'bin'
+    gem.executables = ['ec2-metadata']
     gem.add_development_dependency "rspec", ">= 1.2.9"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
@@ -28,6 +30,9 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.libs << 'lib' << 'spec'
   spec.pattern = 'spec/**/*_spec.rb'
   spec.rcov = true
+  spec.rcov_opts = lambda do
+    IO.readlines("spec/rcov.opts").map {|l| l.chomp.split " "}.flatten
+  end
 end
 
 task :spec => :check_dependencies

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/bin/ec2-metadata

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'ec2_metadata'
+require 'yaml'
+require 'optparse'
+
+options = {:api_version => 'latest'}
+
+ARGV.options do |o|
+  o.banner = 'Usage: ec2-metadata [options]'
+  
+  o.on("-a [api-version]", '--api-version', 
+    "Specify an API version. default is 'latest'.") do |v|
+    options[:api_version] = v
+  end
+
+  o.on("-V", '--display-api-versions', 
+    "Display API versions and quit.") do
+    Ec2Metadata::Command.show_api_versions
+    exit
+  end
+
+  o.on("-d", '--display-dummy-yaml', 
+    "Display a dummy YAML and quit.") do
+    Ec2Metadata::Command.show_dummy_yaml
+    exit
+  end
+
+  o.separator("General Options:")
+
+  o.on("-v", '--version', "Show the version number.") do
+    puts("ec2-metadata " << 
+      IO.read(File.join(File.dirname(__FILE__), "../VERSION")))
+    exit
+  end
+
+  o.on("-h", '--help', "Show this help message."){ puts o; exit}
+
+  o.parse!
+end
+
+Ec2Metadata::Command.show(options[:api_version])
+

data/ec2-metadata.gemspec

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ec2-metadata}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Takeshi AKIMA"]
+  s.date = %q{2010-04-08}
+  s.default_executable = %q{ec2-metadata}
+  s.description = %q{ec2-metadata provides to access metadata, and you can use in outside of ec2 like in ec2}
+  s.email = %q{akm2000@gmail.com}
+  s.executables = ["ec2-metadata"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "bin/ec2-metadata",
+     "ec2-metadata.gemspec",
+     "lib/ec2_metadata.rb",
+     "lib/ec2_metadata/base.rb",
+     "lib/ec2_metadata/command.rb",
+     "lib/ec2_metadata/dummy.rb",
+     "lib/ec2_metadata/dummy.yml",
+     "lib/ec2_metadata/http_client.rb",
+     "lib/ec2_metadata/revision.rb",
+     "lib/ec2_metadata/root.rb",
+     "lib/hash_key_orderable.rb",
+     "spec/ec2_metadata/base_spec.rb",
+     "spec/ec2_metadata/command_spec.rb",
+     "spec/ec2_metadata/dummy_spec.rb",
+     "spec/ec2_metadata/http_client_spec.rb",
+     "spec/ec2_metadata/revision_spec.rb",
+     "spec/ec2_metadata/root_spec.rb",
+     "spec/ec2_metadata_spec.rb",
+     "spec/hash_key_orderable_spec.rb",
+     "spec/introduction_spec.rb",
+     "spec/rcov.opts",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "spec/to_hash_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/akm/ec2-metadata}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{ec2-metadata provides to access metadata}
+  s.test_files = [
+    "spec/ec2_metadata/base_spec.rb",
+     "spec/ec2_metadata/command_spec.rb",
+     "spec/ec2_metadata/dummy_spec.rb",
+     "spec/ec2_metadata/http_client_spec.rb",
+     "spec/ec2_metadata/revision_spec.rb",
+     "spec/ec2_metadata/root_spec.rb",
+     "spec/ec2_metadata_spec.rb",
+     "spec/hash_key_orderable_spec.rb",
+     "spec/introduction_spec.rb",
+     "spec/spec_helper.rb",
+     "spec/to_hash_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/ec2_metadata.rb

@@ -1,12 +1,19 @@
 require 'net/http'
+Net::HTTP.version_1_2
 
 module Ec2Metadata
   DEFAULT_HOST = "169.254.169.254".freeze
 
+  autoload :HttpClient, 'ec2_metadata/http_client'
   autoload :Base, 'ec2_metadata/base'
-  autoload :NamedBase, 'ec2_metadata/named_base'
   autoload :Root, 'ec2_metadata/root'
   autoload :Revision, 'ec2_metadata/revision'
+  autoload :Dummy, 'ec2_metadata/dummy'
+  autoload :Command, 'ec2_metadata/command'
+
+  DEFAULT_REVISION = 'latest'
+
+  extend HttpClient
 
   class << self
     def instance
@@ -21,10 +28,21 @@ module Ec2Metadata
       instance[key]
     end
 
-    def get(path)
-      logging("Ec2Metadata.get(#{path.inspect})") do
-        Net::HTTP.get(DEFAULT_HOST, path)
-      end
+    def to_hash(revision = DEFAULT_REVISION)
+      self[revision].to_hash
+    end
+
+    def from_hash(hash, revision = DEFAULT_REVISION)
+      # hash = {revision => hash}
+      # instance.from_hash(hash)
+      rev_obj = instance.new_child(revision)
+      instance.instance_variable_set(:@children, {revision => rev_obj})
+      instance.instance_variable_set(:@child_keys, [revision])
+      rev_obj.from_hash(hash)
+    end
+
+    def formalize_key(key)
+      key.to_s.gsub(/_/, '-')
     end
 
     def logging(msg)
@@ -46,3 +64,7 @@ module Ec2Metadata
   end
 
 end
+
+unless ENV['EC2_METADATA_DUMMY_DISABLED'] =~ /yes|true|on/i
+  Ec2Metadata::Dummy.search_and_load_yaml
+end

data/lib/ec2_metadata/base.rb

@@ -36,7 +36,7 @@ module Ec2Metadata
 
     def get(child_key)
       logging("#{self.class.name}.get(#{child_key.inspect})") do
-        child_key = child_key.to_s.gsub(/_/, '-')
+        child_key = Ec2Metadata.formalize_key(child_key)
         if children.has_key?(child_key)
           result = children[child_key]
         else
@@ -61,13 +61,17 @@ module Ec2Metadata
     end
 
     def is_struct?(child_key)
-      k = child_key.to_s.gsub(/_/, '-') << '/'
+      k = Ec2Metadata.formalize_key(child_key) << '/'
       child_keys.include?(k) || (defined?(@child_names) && @child_names.keys.include?(child_key))
     end
 
     def new_child(child_key)
       if defined?(@child_names) && (name = @child_names[child_key])
-        NamedBase.new(name, "#{path}#{child_key}/")
+        grandchild = Base.new("#{path}#{child_key}/")
+        child = Base.new("#{path}#{child_key}/")
+        child.instance_variable_set(:@children, {name => grandchild})
+        child.instance_variable_set(:@child_keys, [name])
+        child
       else
         Base.new("#{path}#{child_key}/")
       end
@@ -81,6 +85,35 @@ module Ec2Metadata
       end
     end
 
+    def to_hash
+      keys.inject({}) do |dest, key|
+        key = key.sub(/\/$/, '')
+        value = get(key)
+        dest[key] = value.respond_to?(:to_hash) ? value.to_hash : value
+        dest
+      end
+    end
+
+    def from_hash(hash)
+      hash = hash.inject({}){|d, (k, v)| d[Ec2Metadata.formalize_key(k)] = v; d}
+      @child_keys = hash.keys
+      @children = {}
+      hash.each do |key, value|
+        if value.is_a?(Array)
+          idx = 0
+          value = value.inject({}){|d, v| d[idx] = v; idx += 1; d}
+        end
+        if value.is_a?(Hash)
+          child = new_child(key)
+          @children[key] = child
+          child.from_hash(value)
+        else
+          @children[key] = value
+        end
+      end
+    end
+
+
     private
     def logging(msg, &block)
       Ec2Metadata.logging(msg, &block)

data/lib/ec2_metadata/command.rb

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+require 'ec2_metadata'
+require 'hash_key_orderable'
+
+module Ec2Metadata
+  module Command
+    class << self
+      DATA_KEY_ORDER = %w(meta-data user-data)
+      # %w(...)の中に改行を入れるとrcovがパスしていることを認識してくれないので、各行毎に%w(..)します
+      META_DATA_KEY_ORDER = 
+        %w(ami-id ami-launch-index ami-manifest-path ancestor-ami-ids) +
+        %w(instance-id instance-type instance-action) +
+        %w(public-keys/ placement/ security-groups) +
+        %w(hostname) +
+        %w(public-hostname public-ipv4) +
+        %w(local-hostname  local-ipv4) +
+        %w(block-device-mapping/) +
+        %w(kernel-id) +
+        %w(ramdisk-id) +
+        %w(reservation-id)
+
+      def show(api_version = 'latest')
+        timeout do
+          v = (api_version || '').strip
+          unless Ec2Metadata.instance.keys.include?(v)
+            raise ArgumentError, "API version must be one of #{Ec2Metadata.instance.keys.inspect} but was #{api_version.inspect}"
+          end
+          show_yaml_path_if_loaded
+          data = Ec2Metadata[v].to_hash
+          data.extend(HashKeyOrderable)
+          data.key_order = DATA_KEY_ORDER
+          meta_data = data['meta-data']
+          meta_data.extend(HashKeyOrderable)
+          meta_data.key_order = META_DATA_KEY_ORDER
+          puts YAML.dump(data)
+        end
+      end
+
+      def show_api_versions
+        timeout do
+          show_yaml_path_if_loaded
+          puts Ec2Metadata.instance.keys
+        end
+      end
+
+      def show_dummy_yaml
+        show_yaml_path_if_loaded
+        puts IO.read(File.expand_path(File.join(File.dirname(__FILE__), 'dummy.yml')))
+      end
+
+      private
+      def timeout
+        begin
+          yield
+        rescue Timeout::Error, SystemCallError => error
+          puts "HTTP request timed out. You can use dummy YAML for non EC2 Instance. #{Dummy.yaml_paths.inspect}"
+        end
+      end
+
+      def show_yaml_path_if_loaded
+        if path = Ec2Metadata::Dummy.loaded_yaml_path
+          puts "Actually these data is based on a DUMMY yaml file: #{path}"
+        end
+      end
+    
+    end
+  end
+end

data/lib/ec2_metadata/dummy.rb

@@ -0,0 +1,38 @@
+module Ec2Metadata
+  module Dummy
+    YAML_FILENAME = 'ec2_metadata.yml'.freeze
+    YAML_SEARCH_DIRS = ['./config', '.', '~', '/etc'].freeze
+    ENV_SPECIFIED_PATH = "EC2_METADATA_DUMMY_YAML".freeze
+
+    class << self
+      def yaml_paths
+        dirs = YAML_SEARCH_DIRS.dup
+        if Module.constants.include?('RAILS_ROOT')
+          dirs.unshift(File.join(Module.const_get('RAILS_ROOT'), 'config'))
+        end
+        result = dirs.map{|d| File.join(d, YAML_FILENAME)}
+        if specified_path = ENV[ENV_SPECIFIED_PATH]
+          result.unshift(specified_path)
+        end
+        result
+      end
+
+      def search_and_load_yaml
+        paths = Dir.glob(yaml_paths.map{|path| File.expand_path(path)})
+        load_yaml(paths.first) unless paths.empty?
+      end
+
+      def load_yaml(path)
+        erb = ERB.new(IO.read(path))
+        erb.filename = path
+        text = erb.result
+        Ec2Metadata.from_hash(YAML.load(text))
+        @loaded_yaml_path = path
+      end
+      
+      def loaded_yaml_path
+        @loaded_yaml_path
+      end
+    end
+  end
+end