debut 0.0.1

data/README.md

@@ -0,0 +1,100 @@
+![livetribe](http://en.gravatar.com/userimage/37511139/d08dfb0c999f540b24b0e042d27e5b17.png)
+
+LiveTribe Debut
+===============
+[![Build Status](https://secure.travis-ci.org/livetribe/livetribe-debut.png?branch=master)](http://travis-ci.org/livetribe/livetribe-debut)
+[![Gem Version](https://fury-badge.herokuapp.com/rb/debut.png)](http://badge.fury.io/rb/debut)
+[![Dependency Status](https://gemnasium.com/livetribe/livetribe-debut.png)](https://gemnasium.com/livetribe/livetribe-debut)
+[![Code Climate](https://codeclimate.com/github/livetribe/livetribe-debut.png)](https://codeclimate.com/github/livetribe/livetribe-debut)
+[![Coverage Status](https://coveralls.io/repos/livetribe/livetribe-debut/badge.png)](https://coveralls.io/r/livetribe/livetribe-debut)
+
+Register your cloud instance w/ DNS and other lookup services.
+
+## About
+
+LiveTribe's `debut` command can be used to register your cloud instance with a
+DNS service, e.g. Amazon Route 53.  It can also be used to unregister your
+cloud instance as well.
+
+The `debut` command allows for the addition of providers which allow the
+`debut` command to interface with different DNS providers.  At the moment
+there is only one Amazon Route 53 provider.  Come join the fun and add one!
+
+## Getting Started
+
+    sudo gem install debut
+
+Now, after
+[setting up your Fog credentials]http://fog.io/about/getting_started.html#credentials "Setting up your Fog credentials"),
+you are ready to introduce your cloud instance:
+
+    $ debut -h ec2-164-62-8-61.us-west-1.compute.amazonaws.com -s mock.livetribe.org. -n travis hello
+    Registered hostname ec2-164-62-8-61.us-west-1.compute.amazonaws.com at travis.mock.livetribe.org.
+    $ debut -h ec2-164-62-8-61.us-west-1.compute.amazonaws.com -s mock.livetribe.org. -n travis goodbye
+    Unregistered travis.mock.livetribe.org.
+
+If the hostname, sub-domain, and name are not specified, the `aws` provider
+will attempt obtain the information from the
+[user data of the meta-data service](http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/AESDG-chapter-instancedata.html).
+Here, the `aws` provider will be looking for a valid JSON object:
+
+    {
+      "hostname": "ec2-184-72-8-21.us-west-1.compute.amazonaws.com",
+      "subdomain": "mock.livetribe.org.",
+      "name": "travis"
+    }
+
+If any of the above parameters are not specified in the user data they must be
+provided on the command line.
+
+### AWS Policies
+
+The AWS security policy for the user must allow for the reading of the list of
+zones and for the modification of the zone onto which `CNAME` records will be
+added.  The following represents the minimum policy which seems to work:
+
+    {
+      "Version": "2012-10-17",
+      "Statement": [
+        {
+          "Effect": "Allow",
+          "Action": [
+            "route53:Get*",
+            "route53:List*"
+          ],
+          "Resource": [
+            "*"
+          ]
+        },
+        {
+          "Action": [
+            "route53:ChangeResourceRecordSets"
+          ],
+          "Resource": [
+            "arn:aws:route53:::hostedzone/YOURHOSTEDZONEID"
+          ],
+          "Effect": "Allow"
+        }
+      ]
+    }
+
+Where `YOURHOSTEDZONEID` needs to be replaced with the zone id of your Amazon
+Route 53 zone.  The first policy statement allows for the scanning of zones and
+the second policy allows for the modification of a specific zone.
+
+## Contributing
+
+* Find something you would like to work on.
+  * Look for anything you can help with in the [issue tracker](https://github.com/livetribe/livetribe-debut/issues).
+  * Look at the [code quality metrics](https://codeclimate.com/github/livetribe/livetribe-debut) for anything you can help clean up.
+  * Or anything else!
+* Fork the project and do your work in a topic branch.
+  * Make sure your changes will work on both Ruby 1.9 and Ruby 2.0
+* Add minitests tests to prove your code works and run all the tests using `bundle exec rake`.
+* Rebase your branch against `livetribe/livetribe-debut` to make sure everything is up to date.
+* Commit your changes and send a pull request.
+
+## Additional Resources
+
+* [livetribe.org](http://www.livetribe.org)
+* [Provider Documentation](http://www.livetribe.org/about/Debut-Provider)

data/bin/debut

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+#
+# Copyright 2013 the original author or authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+require 'gli'
+
+include GLI::App
+
+program_desc 'Register your cloud instance w/ DNS and other lookup services'
+
+version Debut::VERSION
+
+desc 'Use local hostname'
+switch [:l,:local], :default_value => LiveTribe::Debut::Debutante::USE_LOCAL_HOSTNAME
+
+desc 'The Fog provider'
+default_value 'aws'
+arg_name 'provider'
+flag [:p,:provider]
+
+desc 'The hostname of the cloud instance'
+default_value LiveTribe::Debut::Debutante::USE_ENVIRONMENT
+arg_name 'hostname'
+flag [:h,:hostname]
+
+desc 'The name of the cloud instance'
+default_value LiveTribe::Debut::Debutante::USE_ENVIRONMENT
+arg_name 'name'
+flag [:n,:name]
+
+desc 'The subdomain of the cloud instance'
+default_value LiveTribe::Debut::Debutante::USE_ENVIRONMENT
+arg_name 'subdomain'
+flag [:s,:subdomain]
+
+desc 'Announce the arrival of your cloud instance to the world'
+command :hello do |c|
+  c.action do |global_options, options, args|
+    provider = global_options[:provider]
+
+    debutant = LiveTribe::Debut::Debutante::new({:provider => provider})
+    debutant.hostname = global_options[:hostname]
+    debutant.name = global_options[:name]
+    debutant.subdomain = global_options[:subdomain]
+    debutant.use_local_hostname = global_options[:local]
+
+    debutant.hello
+  end
+end
+
+desc 'Announce the departure of your cloud instance to the world'
+command :goodbye do |c|
+  c.action do |global_options, options, args|
+    provider = global_options[:provider]
+
+    debutant = LiveTribe::Debut::Debutante::new({:provider => provider})
+    debutant.hostname = global_options[:hostname]
+    debutant.name = global_options[:name]
+    debutant.subdomain = global_options[:subdomain]
+
+    debutant.goodbye
+  end
+end
+
+exit run(ARGV)

data/lib/debut/aws.rb

@@ -0,0 +1,167 @@
+#
+# Copyright 2013 the original author or authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+module LiveTribe
+  module Debut
+    INSTANCE_METADATA_HOST = 'http://169.254.169.254'
+    INSTANCE_METADATA_PATH = '/latest/user-data'
+    INSTANCE_LOCAL_HOSTNAME_PATH = '/latest/meta-data/local-hostname'
+    INSTANCE_PUBLIC_HOSTNAME_PATH = '/latest/meta-data/public-hostname'
+
+    class AWS < LiveTribe::Debut::Provider
+      require 'json'
+      require 'fog'
+
+      def initialize(attributes)
+        @dns = Fog::DNS.new(attributes)
+
+        @hostname = LiveTribe::Debut::Debutante::USE_ENVIRONMENT
+        @name = LiveTribe::Debut::Debutante::USE_ENVIRONMENT
+        @subdomain = LiveTribe::Debut::Debutante::USE_ENVIRONMENT
+        @use_local_hostname = LiveTribe::Debut::Debutante::USE_LOCAL_HOSTNAME
+      end
+
+      def hostname
+        @hostname
+      end
+
+      def hostname=(hostname)
+        @hostname = hostname
+      end
+
+      def name
+        @name
+      end
+
+      def name=(name)
+        @name = name
+      end
+
+      def subdomain
+        @subdomain
+      end
+
+      def subdomain=(subdomain)
+        @subdomain = subdomain
+      end
+
+      def use_local_hostname
+        @use_local_hostname
+      end
+
+      def use_local_hostname=(use_local_hostname)
+        @use_local_hostname = use_local_hostname
+      end
+
+      def to_s
+        'aws'
+      end
+
+      def hello
+        name, subdomain = collect_name_and_subdomain
+        hostname = collect_hostname
+        fqdn = "#{name}.#{subdomain}"
+        for zone in @dns.zones
+          if zone.domain == subdomain
+            record = zone.records.find { |r| r.name == fqdn && r.type == 'CNAME' }
+            if record
+              puts "Destroying old record for #{fqdn}"
+
+              record.destroy
+            end
+
+            zone.records.create(
+                :value => hostname,
+                :name => fqdn,
+                :type => 'CNAME'
+            )
+
+            puts "Registered hostname #{hostname} at #{fqdn}"
+
+            return
+          end
+        end
+        raise ArgumentError.new("Unable to find route53 zone: #{subdomain}")
+      end
+
+      def goodbye
+        name, subdomain = collect_name_and_subdomain
+        fqdn = "#{name}.#{subdomain}"
+        @dns.zones.each { |zone|
+          if zone.domain == subdomain
+            record = zone.records.find { |r| r.name == fqdn && r.type == 'CNAME' }
+            if record
+              record.destroy
+            end
+
+            puts "Unregistered #{fqdn}"
+
+            return
+          end
+        }
+        raise ArgumentError.new("Unable to find route53 zone: #{subdomain}")
+      end
+
+      protected
+
+      def collect_name_and_subdomain
+        name = @name
+        subdomain = @subdomain
+
+        if name == LiveTribe::Debut::Debutante::USE_ENVIRONMENT || subdomain == LiveTribe::Debut::Debutante::USE_ENVIRONMENT
+          connection = Excon.new(INSTANCE_METADATA_HOST)
+          metadata = Fog::JSON.decode(connection.get(:path => INSTANCE_METADATA_PATH, :expects => 200).body)
+          metadata.default = LiveTribe::Debut::Debutante::USE_ENVIRONMENT
+
+          if name == LiveTribe::Debut::Debutante::USE_ENVIRONMENT
+            name = metadata['name']
+          end
+
+          if subdomain == LiveTribe::Debut::Debutante::USE_ENVIRONMENT
+            subdomain = metadata['subdomain']
+          end
+        end
+
+        if name == LiveTribe::Debut::Debutante::USE_ENVIRONMENT || subdomain == LiveTribe::Debut::Debutante::USE_ENVIRONMENT
+          raise ArgumentError.new("Name or subdomain not set: #{name}, #{subdomain}")
+        end
+
+        return name, subdomain
+      end
+
+      def collect_hostname
+        hostname = @hostname
+
+        if hostname == LiveTribe::Debut::Debutante::USE_ENVIRONMENT
+          connection = Excon.new(INSTANCE_METADATA_HOST)
+
+          if @use_local_hostname
+            path = INSTANCE_LOCAL_HOSTNAME_PATH
+          else
+            path = INSTANCE_PUBLIC_HOSTNAME_PATH
+          end
+
+          metadata = Fog::JSON.decode(connection.get(:path => path, :expects => 200).body)
+
+          hostname = metadata['hostname']
+        end
+
+        hostname
+      end
+    end
+  end
+end

data/lib/debut/version.rb

@@ -0,0 +1,20 @@
+#
+# Copyright 2013 the original author or authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+module Debut
+  VERSION = '0.0.1'
+end

data/lib/debut.rb

@@ -0,0 +1,105 @@
+#
+# Copyright 2013 the original author or authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+require 'debut/version'
+
+module LiveTribe
+  module Debut
+
+    class Debutante
+
+      USE_ENVIRONMENT = '<use environment>'
+      USE_LOCAL_HOSTNAME = true
+
+      def initialize(attributes)
+        provider = attributes[:provider].to_s.downcase.to_sym
+        begin
+          require "debut/#{provider}"
+          if LiveTribe::Debut.providers.include?(provider)
+            @provider = LiveTribe::Debut.providers[provider].new(attributes)
+          else
+            raise ArgumentError.new("#{provider} is not a recognized debut provider")
+          end
+        rescue LoadError
+          raise ArgumentError.new("#{provider} is not a recognized debut provider")
+        end
+
+        @provider.use_local_hostname = USE_LOCAL_HOSTNAME
+      end
+
+      def hostname
+        @provider.hostname
+      end
+
+      def hostname=(hostname)
+        @provider.hostname = hostname
+      end
+
+      def name
+        @provider.name
+      end
+
+      def name=(name)
+        @provider.name = name
+      end
+
+      def subdomain
+        @provider.subdomain
+      end
+
+      def subdomain=(subdomain)
+        @provider.subdomain = subdomain
+      end
+
+      def use_local_hostname
+        @provider.use_local_hostname
+      end
+
+      def use_local_hostname=(use_local_hostname)
+        @provider.use_local_hostname = use_local_hostname
+      end
+
+      def hello
+        @provider.hello
+      end
+
+      def goodbye
+        @provider.goodbye
+      end
+
+      def to_s
+        "#{@provider.name}.#{@provider.subdomain}:#{@provider.to_s}"
+      end
+    end
+
+    def self.providers
+      @providers ||= {}
+    end
+
+    def self.providers=(new_providers)
+      @providers = new_providers
+    end
+
+    class Provider
+      def Provider.inherited(clazz)
+        provider = clazz.to_s.split('::').last
+        LiveTribe::Debut.providers[provider.downcase.to_sym] = clazz
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: debut
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- LiveTribe - Systems Management Project
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: gli
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A simple way to register your cloud instance with DNS and other lookup
+  services
+email: dev@livetribe.codehaus.org
+executables:
+- debut
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- bin/debut
+- lib/debut/aws.rb
+- lib/debut/version.rb
+- lib/debut.rb
+- README.md
+homepage: http://www.livetribe.org
+licenses:
+- ASL-2
+post_install_message: 
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: A simple way to register your cloud instance
+test_files: []
+has_rdoc: