engineyard-metadata 0.2.4 → 0.2.5

data/.document

@@ -1,4 +1,4 @@
-README.rdoc
+README.markdown
 lib/**/*.rb
 bin/*
 features/**/*.feature

data/.gitignore

@@ -15,8 +15,10 @@ tmtags
 
 ## PROJECT::GENERAL
 coverage
-rdoc
+doc
 pkg
 
 ## PROJECT::SPECIFIC
 Gemfile.lock
+.yardoc/
+*.gem

data/Gemfile

@@ -2,3 +2,8 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in engineyard-metadata.gemspec
 gemspec
+
+gem 'yard'
+gem "webmock"
+gem "fakefs"
+gem "rspec", "~>2"

data/{README.rdoc → README.markdown}

@@ -1,46 +1,44 @@
-= engineyard-metadata
+# engineyard-metadata
 
 Presents a simple interface to get metadata about your EngineYard AppCloud instances running on Amazon EC2.
 
-== Purpose
+## Purpose
 
 To define a simple interface to useful metadata (passwords, IP addresses, etc.) that is otherwise buried deep inside EngineYard's chef config files and various API calls.
 
-== Examples
-
-* Get the current database password so that you can write a script that connects to it. (<tt>EY.metadata.database_password</tt>)
+## Examples
 
 Here's the current method list:
 
-	EY.metadata.app_master
-	EY.metadata.app_name
-	EY.metadata.app_servers
-	EY.metadata.app_slaves
-	EY.metadata.current_path
-	EY.metadata.database_host
-	EY.metadata.database_name
-	EY.metadata.database_password       (only works from cloud instances)
-	EY.metadata.database_username
-	EY.metadata.db_master
-	EY.metadata.db_servers
-	EY.metadata.db_slaves
-	EY.metadata.environment_name
-	EY.metadata.mysql_command           (only works from cloud instances)
-	EY.metadata.mysqldump_command       (only works from cloud instances)
-	EY.metadata.present_instance_id     (only works from cloud instances)
-	EY.metadata.present_instance_role   (only works from cloud instances)
-	EY.metadata.present_public_hostname (only works from cloud instances)
-	EY.metadata.present_security_group  (only works from cloud instances)
-	EY.metadata.repository_uri
-	EY.metadata.shared_path
-	EY.metadata.solo
-	EY.metadata.ssh_aliases
-	EY.metadata.ssh_password            (only works from cloud instances)
-	EY.metadata.ssh_username
-	EY.metadata.stack_name
-	EY.metadata.utilities
-
-== public_hostname, amazon_id, etc.
+    EY.metadata.app_master
+    EY.metadata.app_name
+    EY.metadata.app_servers
+    EY.metadata.app_slaves
+    EY.metadata.current_path
+    EY.metadata.database_host
+    EY.metadata.database_name
+    EY.metadata.database_password       (only works from cloud instances)
+    EY.metadata.database_username
+    EY.metadata.db_master
+    EY.metadata.db_servers
+    EY.metadata.db_slaves
+    EY.metadata.environment_name
+    EY.metadata.mysql_command           (only works from cloud instances)
+    EY.metadata.mysqldump_command       (only works from cloud instances)
+    EY.metadata.present_instance_id     (only works from cloud instances)
+    EY.metadata.present_instance_role   (only works from cloud instances)
+    EY.metadata.present_public_hostname (only works from cloud instances)
+    EY.metadata.present_security_group  (only works from cloud instances)
+    EY.metadata.repository_uri
+    EY.metadata.shared_path
+    EY.metadata.solo
+    EY.metadata.ssh_aliases
+    EY.metadata.ssh_password            (only works from cloud instances)
+    EY.metadata.ssh_username
+    EY.metadata.stack_name
+    EY.metadata.utilities
+
+## public\_hostname, amazon\_id, etc.
 
 Thanks to Nick Marden, you can do things like:
 
@@ -49,11 +47,11 @@ Thanks to Nick Marden, you can do things like:
 
 By default, you get the public hostname.
 
-== Use
+## Use
 
-See the rdoc at {the engineyard-metadata rdoc}[http://rubydoc.info/gems/engineyard-metadata].
+See the documentation at (the engineyard-metadata documentation}[http://rubydoc.info/gems/engineyard-metadata].
 
-=== When you're executing this gem from INSIDE the cloud
+### When you're executing this gem from INSIDE the cloud
 
 When you're executing the gem from your instances, you don't have to configure anything. Just require the gem.
 
@@ -67,56 +65,67 @@ then I suggest adding something like this to `deploy/before_bundle.rb`
 
 or find some other way to make the file readable.
 
-=== When you're executing this gem from OUTSIDE the cloud
+The Engine Yard recipes will often reset the permissions on the file, so you can periodically fix that using
+a custom chef recipe like this:
+
+    # Only run on app server instances.
+    if ['app','app_master'].include?(node[:instance_role]) then
+      cron "Make /etc/chef/dna.json readable" do 
+        minute "*/5" 
+        command "chmod a+r /etc/chef/dna.json" 
+      end 
+    end
+
+### When you're executing this gem from OUTSIDE the cloud
 
 You must...
 
-* have <tt>~/.eyrc</tt> or set <tt>EY.metadata.ey_cloud_token=</tt> or set <tt>ENV['EY_CLOUD_TOKEN']</tt>.
-* execute the gem from the local copy of your application's repo or set <tt>EY.metadata.environment_name=</tt> or set <tt>ENV['EY_ENVIRONMENT_NAME']</tt>.
+* have `~/.eyrc` or set `EY.metadata.ey_cloud_token=` or set `ENV['EY_CLOUD_TOKEN']`.
+* execute the gem from the local copy of your application's repo or set `EY.metadata.environment_name=` or set `ENV['EY_ENVIRONMENT_NAME']`.
 
-=== Where the methods are defined
+### Where the methods are defined
 
-Metadata getters are defined directly on <tt>EY.metadata</tt> (which in turn delegates out to various adapters). Even if EngineYard changes the structure of the config files or Amazon EC2's API changes, these methods will stay the same.
+Metadata getters are defined directly on `EY.metadata` (which in turn delegates out to various adapters). Even if EngineYard changes the structure of the config files or Amazon EC2's API changes, these methods will stay the same.
 
-  [...]
-  >> require 'rubygems'
-  [...]
-  >> require 'engineyard-metadata'
-  [...]
-  >> EY.metadata.database_host
-  => "external_db_master.compute-1.amazonaws.com"
-  >> EY.metadata.app_servers
-  => [ 'app_1.compute-1.amazonaws.com' , 'app_master.compute-1.amazonaws.com' ]
-  >> EY.metadata.db_servers
-  => [ 'db_master.compute-1.amazonaws.com', 'db_slave_1.compute-1.amazonaws.com' ]
-  [...and many more...]
+    [...]
+    >> require 'rubygems'
+    [...]
+    >> require 'engineyard-metadata'
+    [...]
+    >> EY.metadata.database_host
+    => "external_db_master.compute-1.amazonaws.com"
+    >> EY.metadata.app_servers
+    => [ 'app_1.compute-1.amazonaws.com' , 'app_master.compute-1.amazonaws.com' ]
+    >> EY.metadata.db_servers
+    => [ 'db_master.compute-1.amazonaws.com', 'db_slave_1.compute-1.amazonaws.com' ]
+    [...and many more...]
 
-== SSH alias helper
+## SSH alias helper
 
-You can put the output of <tt>ey_ssh_aliases</tt> into <tt>~/.ssh/config</tt>:
+You can put the output of `ey_ssh_aliases` into `~/.ssh/config`:
 
-	$ EY_ENVIRONMENT_NAME=my_env ey_ssh_aliases 
-	Host my_env-app_master
-	  Hostname ec2-11-11-111-11.compute-1.amazonaws.com
-	  User deploy
-	  StrictHostKeyChecking no
+    $ EY_ENVIRONMENT_NAME=my_env ey_ssh_aliases 
+    Host my_env-app_master
+      Hostname ec2-11-11-111-11.compute-1.amazonaws.com
+      User deploy
+      StrictHostKeyChecking no
 
-	Host my_env-db_master
-	  Hostname ec2-111-11-11-11.compute-1.amazonaws.com
-	  User deploy
-	  StrictHostKeyChecking no
+    Host my_env-db_master
+      Hostname ec2-111-11-11-11.compute-1.amazonaws.com
+      User deploy
+      StrictHostKeyChecking no
 
-== Known issues
+## Known issues
 
 * Doesn't work with multiple apps per environment. [FIXED!]
-* It's not always clear what environment you're running in. For example, you say <tt>EY.metadata.something</tt> and you're just supposed to know what environment you're in. You can use <tt>.environment_name=</tt>, but you might not remember.
-* There are no factory methods. If we fully fleshed this out, it might be like <tt>my_env = EY::Environment.find('my_env')</tt> and <tt>my_app_master = my_env.app_master</tt>. Not sure that complexity would add a lot of value.
+* It's not always clear what environment you're running in. For example, you say `EY.metadata.something` and you're just supposed to know what environment you're in. You can use `.environment_name=`, but you might not remember.
+* There are no factory methods. If we fully fleshed this out, it might be like `my_env = EY::Environment.find('my_env')` and `my_app_master = my_env.app_master`. Not sure that complexity would add a lot of value.
 
-== History
+## History
 
 This is the second generation of http://rubygems.org/gems/ey_cloud_awareness.
 
-== Sample test output
+## Sample test output
 
     engineyard-metadata (master) $ rake
     
@@ -250,6 +259,6 @@ This is the second generation of http://rubygems.org/gems/ey_cloud_awareness.
     Finished in 0.95816 seconds
     112 examples, 0 failures
 
-== Copyright
+## Copyright
 
-Copyright (c) 2010 Seamus Abshere. See LICENSE for details.
+Copyright (c) 2012 Seamus Abshere. See LICENSE for details.

data/Rakefile

@@ -3,15 +3,8 @@ Bundler::GemHelper.install_tasks
 
 require 'rake'
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "engineyard-metadata #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'yard'
+YARD::Rake::YardocTask.new
 
 require 'rspec/core/rake_task'
 

data/engineyard-metadata.gemspec

@@ -22,7 +22,4 @@ Gem::Specification.new do |s|
   s.add_dependency 'activesupport', '>=2.3.4'
   s.add_dependency 'nap', '>=0.4'
   s.add_dependency 'eat', '>=0.0.5'
-  s.add_development_dependency "fakeweb"
-  s.add_development_dependency "fakefs"
-  s.add_development_dependency "rspec", "~>2"
 end

data/lib/engineyard-metadata/amazon_ec2_api.rb

@@ -1,4 +1,4 @@
-require 'open-uri'
+require 'eat'
 
 module EY
   class Metadata
@@ -6,12 +6,12 @@ module EY
     class AmazonEc2Api
       # The present instance's Amazon Ec2 instance id.
       def present_instance_id
-        @present_instance_id ||= open('http://169.254.169.254/latest/meta-data/instance-id').read
+        @present_instance_id ||= eat('http://169.254.169.254/latest/meta-data/instance-id')
       end
 
       # The present instance's Amazon Ec2 security group.
       def present_security_group
-        @present_security_group ||= open('http://169.254.169.254/latest/meta-data/security-groups').read
+        @present_security_group ||= eat('http://169.254.169.254/latest/meta-data/security-groups')
       end
     end
   end

data/lib/engineyard-metadata/version.rb

@@ -1,5 +1,5 @@
 module EY
   class Metadata
-    VERSION = '0.2.4'
+    VERSION = '0.2.5'
   end
 end

data/spec/spec_helper.rb

@@ -3,7 +3,7 @@ require 'bundler'
 Bundler.setup
 require 'rspec'
 require 'active_support/json/encoding'
-require 'fakeweb'
+require 'webmock/rspec'
 require 'fakefs/safe'
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
@@ -14,11 +14,11 @@ FAKE_INSTANCE_ID = 'i-ff17d493'
 FAKE_CLOUD_TOKEN = 'justareallygreatsecret'
 
 def pretend_we_are_on_a_developer_machine
-  FakeWeb.allow_net_connect = false
-  FakeWeb.register_uri  :get,
-                        "https://cloud.engineyard.com/api/v2/environments",
-                        :status => ["200", "OK"],
-                        :body => File.read(File.join(File.dirname(__FILE__), 'support', 'engine_yard_cloud_api_response.json'))
+  WebMock.enable!
+  WebMock.stub_request(:get, "https://cloud.engineyard.com/api/v2/environments").to_return(
+    :status => 200,
+    :body => File.read(File.join(File.dirname(__FILE__), 'support', 'engine_yard_cloud_api_response.json')))
+    
   dot_git_config = File.read File.join(File.dirname(__FILE__), 'support', 'dot.git.config')
   FakeFS.activate!
   git_config_path = File.join Dir.pwd, '.git', 'config'
@@ -29,18 +29,18 @@ def pretend_we_are_on_a_developer_machine
 end
 
 def pretend_we_are_on_an_engineyard_appcloud_ec2_instance
-  FakeWeb.allow_net_connect = false
+  WebMock.enable!
   # fake call to amazon ec2 api to get present security group
-  FakeWeb.register_uri  :get,
-                        "http://169.254.169.254/latest/meta-data/security-groups",
-                        :status => ["200", "OK"],
-                        :body => FAKE_SECURITY_GROUP
+  WebMock.stub_request(:get, "http://169.254.169.254/latest/meta-data/security-groups").to_return(
+    :status => 200,
+    :body => FAKE_SECURITY_GROUP
+  )
 
   # fake call to amazon ec2 api to get present instance id
-  FakeWeb.register_uri  :get,
-                        "http://169.254.169.254/latest/meta-data/instance-id",
-                        :status => ["200", "OK"],
-                        :body => FAKE_INSTANCE_ID
+  WebMock.stub_request(:get, "http://169.254.169.254/latest/meta-data/instance-id").to_return(
+    :status => 200,
+    :body => FAKE_INSTANCE_ID
+  )
 
   # first read a file from the real file system...
   dna_json = File.read File.join(File.dirname(__FILE__), 'support', 'dna.json')
@@ -57,5 +57,5 @@ def stop_pretending
   # http://lukeredpath.co.uk/blog/using-fakefs-with-cucumber-features.html
   FakeFS::FileSystem.clear
   FakeFS.deactivate!
-  FakeWeb.clean_registry
+  WebMock.reset!
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: engineyard-metadata
 version: !ruby/object:Gem::Version
-  version: 0.2.4
+  version: 0.2.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-03 00:00:00.000000000Z
+date: 2012-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &2153302620 !ruby/object:Gem::Requirement
+  requirement: &2156735380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 2.3.4
   type: :runtime
   prerelease: false
-  version_requirements: *2153302620
+  version_requirements: *2156735380
 - !ruby/object:Gem::Dependency
   name: nap
-  requirement: &2153289780 !ruby/object:Gem::Requirement
+  requirement: &2156734440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *2153289780
+  version_requirements: *2156734440
 - !ruby/object:Gem::Dependency
   name: eat
-  requirement: &2153287620 !ruby/object:Gem::Requirement
+  requirement: &2156733900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,40 +43,7 @@ dependencies:
         version: 0.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *2153287620
-- !ruby/object:Gem::Dependency
-  name: fakeweb
-  requirement: &2153286600 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2153286600
-- !ruby/object:Gem::Dependency
-  name: fakefs
-  requirement: &2153285120 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *2153285120
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2153283100 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2'
-  type: :development
-  prerelease: false
-  version_requirements: *2153283100
+  version_requirements: *2156733900
 description: Pulls metadata from EC2 and EngineYard so that your EngineYard AppCloud
   (Amazon EC2) instances know about each other.
 email:
@@ -90,7 +57,7 @@ files:
 - .gitignore
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.markdown
 - Rakefile
 - bin/ey_ssh_aliases
 - engineyard-metadata.gemspec
@@ -128,7 +95,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: engineyard-metadata
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Make your EngineYard AppCloud (Amazon EC2) instances aware of each other.