ECS 0.1.0

data/lib/ecs/help_response_group.rb

@@ -0,0 +1,67 @@
+#!/usr/local/bin/ruby
+
+module ECS
+  class HelpResponseGroup
+    @xml=''
+    
+    instance_variable_set( '@response_group_name', nil )
+    instance_variable_set( '@valid_operations', nil )
+    instance_variable_set( '@elements', nil )
+    instance_variable_set( '@help_xml', nil )
+#    @@response_group_name=nil
+
+#      @@help_map = {
+#        :valid_operations => { :call_path => 'HelpResponse.Information.ResponseGroupInformation.ValidOperations.Operation' },
+#        :elements => { :call_path => 'HelpResponse.Information.ResponseGroupInformation.Elements.Element' },
+#      }
+#      @@help_xml = nil
+
+
+
+    def self.valid_operations( force=false )
+      if force || @valid_operations.nil?
+        @valid_operations = []
+        self.help_xml.HelpResponse.Information.ResponseGroupInformation.ValidOperations.Operation.each do |o|
+          @valid_operations << o.content.to_s.to_sym
+        end
+      end
+      @valid_operations
+    end
+
+    def self.elements( force=false )
+      if force || @elements.nil?
+        @elements = []
+        self.help_xml.HelpResponse.Information.ResponseGroupInformation.Elements.Element.each do |el|
+          @elements << lambda { |xml_object| ; ( xml_object.respond_to?( :xml ) ? xml_object.xml : xml_object ).find( "//#{el.content}" ) }
+        end
+      end
+      @elements
+    end
+
+
+    def self.response_group_name
+      @response_group_name ||= self.resolve_response_group_name( self.name )
+    end
+
+    def self.help_xml( force=false )
+      if force || @help_xml.nil?
+        @help_xml = ECS.help( :HelpType => 'ResponseGroup', :About => self.aws_response_group_name ) { |x| ECS::Help.valid_aws_response?( x ) }.xml
+      end
+      @help_xml
+    end
+
+
+    def self.included( includer )
+      includer.extend( ClassMethods )
+      ECS::ResponseGroups[includer.response_group_name] = includer
+    end
+
+    def self.resolve_response_group_name( t )
+      t =~ /::([^:]*ResponseGroup)$/ ? $1 : t
+    end
+    
+    def self.aws_response_group_name
+      self.response_group_name =~ /^(.*)ResponseGroup/ ? $1 : self.response_group_name
+    end
+  end
+end

data/lib/ecs/operations.rb

@@ -0,0 +1,39 @@
+#!/usr/local/bin/ruby
+
+
+module ECS
+  class Operations
+    @@klasses = {}
+
+    def self.clear
+      @@klasses = {}
+    end
+
+    def self.[]=( ideal, actual )
+      self.clear unless @@klasses.is_a?( Hash )
+      @@klasses[( ideal.is_a?( Class ) ? ideal.name : ideal.to_s ).to_sym] = actual.is_a?( Class ) ? actual : actual.class
+    end
+
+    def self.[]( ideal )
+      self.clear unless @@klasses.is_a?( Hash )
+      @@klasses[( ideal.is_a?( Class ) ? ideal.name : ideal.to_s ).to_sym]
+    end
+    
+    def self.method_missing( meth, *args )
+      #You can send anything to ECS::Operations that you can send to a hash
+      #If there is a conflict between the hash's (@@klasses) method name and
+      #the ECS::Operations module's method name, you can call the method with o_ prepended
+      #
+      # E.G.
+      #
+      # ECS::Operations.include?( something ) # => calls the include? method on ECS::Operations
+      # ECS::Operations.o_include?( something ) # => calls the include? method on the @@klasses class variable
+      @@klasses = {} unless @@klasses.is_a?( Hash )
+      if meth == :each
+        @@klasses.each { |ideal,actual| yield( ideal, actual ) }
+      else
+        @@klasses.send( (meth.to_s =~ /^o_(.*)/ ? $1.to_sym : meth), *args )
+      end
+    end
+  end
+end

data/lib/ecs/response_groups.rb

@@ -0,0 +1,7 @@
+#!/usr/local/bin/ruby
+
+
+module ECS
+  class ResponseGroups < Operations
+  end
+end

data/lib/ecs/time_management.rb

@@ -0,0 +1,58 @@
+#!/usr/local/bin/ruby
+require 'time'
+require 'fileutils'
+require 'yaml'
+
+module ECS
+  module TimeManagement
+    @@period = 1.0 # seconds
+    @@time_file = ''
+
+    def self.sleep_duration( schroedingers_cat=true )
+      # if schroedingers_cat is true, observing the time_to_sleep affects
+      # it, effectively adding @@period to it
+      now = Time.now.to_f
+      next_available = self.next_available_timeslot
+      if schroedingers_cat == true
+        if next_available > now - @@period
+          next_available += @@period
+        else
+          next_available = now
+        end
+        self.next_available_timeslot = next_available
+      end
+      duration = next_available - now
+      duration > 0 ? duration : 0
+    end
+
+    def self.next_available_timeslot
+      if File.exist?( @@time_file )
+        t = YAML.load_file( @@time_file )
+        ( t.respond_to?( :to_f ) ? t : Time.now ).to_f
+      else
+        Time.now.to_f
+      end
+    end
+
+    def self.next_available_timeslot=( float_timestamp=nil )
+      raise ArgumentError, "float_timestamp must be a floating point number" unless float_timestamp.respond_to?( :to_f )
+      float_timestamp = Time.now.to_f if float_timestamp.nil?
+      File.open( @@time_file, 'w' ) { |f| f << YAML.dump( float_timestamp.to_f ) }
+    end
+
+
+    def self.time_file
+      @@time_file
+    end
+    def self.time_file=( f='' )
+      file = File.expand_path( f )
+      FileUtils.touch( file )
+      raise "#{file} is an unacceptable time file." unless File.writable?( file )
+      @@time_file = file
+    end
+    def self.kill_time_file
+      File.unlink( @@time_file )
+    rescue
+    end
+  end
+end

data/lib/libxml_additions.rb

@@ -0,0 +1,51 @@
+#!/usr/local/bin/ruby
+
+require 'rubygems'
+require 'xml/libxml'
+
+module XML
+  class Node
+    def method_missing( meth, *args )
+      # If one of the child nodes matches the string value of
+      # the method call that triggered this method_missing(),
+      # then why not use it?
+      #
+      # Furthermore, set an instance variable and create an
+      # instance method so we don't have to come back here again.
+      #
+      # To avoid the collision of a node name with a built-in XML::Node
+      # instance method (e.g., XML::Node#children would mask a <children> node),
+      # you can refer to the node as [node]_in_the_xml
+      # E.G.,
+      # n = XML::Node
+      # n.children # => calls the XML::Node children instance method
+      # n.children_in_the_xml # => looks for child nodes of n that happen to be named "children"
+      node_name = meth.to_s =~ /^(.*)_in_the_xml$/ ? $1 : meth.to_s
+
+      var_name = "@#{meth.to_s}_var"
+      self.instance_eval( "
+def #{meth.to_s}(force=false)
+  if force || #{var_name}.nil?
+    #{var_name} = []
+    self.each_child { |c| #{var_name} << c if c.name == '#{node_name}' }
+    #{var_name} = #{var_name}.first if #{var_name}.size == 1
+  end
+  #{var_name}
+end", __FILE__, __LINE__ )
+      self.send( meth, *args )
+    end
+  end
+
+
+  class Document
+    # In case there's already a method_missing, alias it
+    # Future proofing?
+
+    def method_missing( meth, *args )
+      return self.root if self.root.name == meth.to_s
+      raise NoMethodError, "XML::Document Additions: undefined method '#{meth.to_s}' for #{self.to_s}"
+    end
+    
+  end
+end
+

data/lib/string_additions.rb

@@ -0,0 +1,15 @@
+#!/usr/local/bin/ruby
+
+class String
+  @camel_case = nil
+  @underscore = nil
+
+  def underscore
+    @underscore ||= self.gsub( /([A-Z]+)([A-Z][a-z])/, '\1_\2' ).gsub( /([a-z\d])([A-Z])/, '\1_\2' ).gsub( /\s\s*/, '_' ).downcase
+  end
+
+  def camel_case
+    @camel_case ||= self.underscore.capitalize.gsub( /([A-Z])([A-Z]+)/ ) { "#{$1}#{$2.downcase}" }.gsub( /_(.)/ ) { $1.upcase }
+  end
+end
+

data/test/all_tests.rb

@@ -0,0 +1,16 @@
+#!/usr/local/bin/ruby
+
+def require_tests( dir ) 
+  Dir.entries( dir ).each do |f|
+    if f =~ /^[^\.]/
+      new_path = File.join( dir, f )
+      if f =~ /_test\.rb$/
+        require new_path
+      elsif File.directory?( new_path )
+        require_tests( new_path )
+      end
+    end
+  end
+end
+
+require_tests( File.expand_path( File.join( File.dirname( __FILE__ ), 'unit' ) ) )

data/test/unit/ecs_test.rb

@@ -0,0 +1,379 @@
+#!/usr/local/bin/ruby
+
+require 'test/unit'
+require "#{File.expand_path( File.dirname( __FILE__ ) )}/unit_test_setup"
+
+class ECSTest < Test::Unit::TestCase
+  def setup
+    ECS.default_locale = :us
+    ECS.cache = true
+    ECS.cache_directory = ECStest.default_test_cache_directory
+    
+    @@temp_access_key_id = ECS.access_key_id
+    @@temp_associate_id = ECS.associate_id
+  end
+  def teardown
+    ECS.access_key_id = @@temp_access_key_id
+    ECS.clear_cache
+    ECS.associate_id = @@temp_associate_id
+  end
+
+  def test_requirements
+    assert_nothing_raised do
+      Gem
+      XML::Node
+    end
+  end
+
+  def test_response_group
+    rg = nil
+    
+    assert_nothing_raised do
+      rg = ECS.request_response_group
+    end
+    
+    assert rg.ancestors.include?( ECS::HelpResponseGroup )
+    assert_equal 'RequestResponseGroup', rg.response_group_name
+  end
+
+
+  def test_with_browse_node_lookup_as_the_archetype
+    assert_nothing_raised do
+      ECS.browse_node_lookup
+    end
+   
+    b = nil
+    assert_nothing_raised do
+      b = ECS.browse_node_lookup( :something => 'or other' )
+    end
+    assert_match /BrowseNodeLookup$/, b.class.name
+    assert_equal 'or other', b.parameters[:something]
+    assert_equal nil, b.parameters[:ResponseGroup]
+
+
+    # make sure it's on the instance level
+    c = ECS.browse_node_lookup( :something => 'else entirely', :ResponseGroup => [ :Crazy ] )
+    assert_equal 'else entirely', c.parameters[:something]
+    assert_equal 'or other', b.parameters[:something]
+    assert c.parameters[:ResponseGroup].include?( :Request )
+    
+    # see what happens when you put more than just a hash in there
+    assert_nothing_raised do
+      b = ECS.browse_node_lookup( {:something => 'or other'}, 7, false )
+    end
+    assert_equal nil, b.parameters[:something]
+
+    # Bad calls do not raise an error.  You will have to check for the
+    # status on the xml
+    assert_nothing_raised do
+      ECS.browse_node_looku
+    end
+  end
+
+  def test_access_key_id
+    assert_nothing_raised do
+      ECS.access_key_id = 'hi there'
+    end
+    assert_equal 'hi there', ECS.access_key_id
+    ECS.access_key_id = 'ta ta'
+    assert_equal 'ta ta', ECS.access_key_id
+  end
+  
+  def test_associate_id
+    assert_nothing_raised do
+      ECS.associate_id = 'hi there'
+    end
+    assert_equal 'hi there', ECS.associate_id
+    ECS.associate_id = 'ta ta'
+    assert_equal 'ta ta', ECS.associate_id
+  end
+  
+  
+  
+  def test_default_locale
+    assert_equal :us, ECS.default_locale
+    
+    ECS.available_locales.each do |loc|
+      assert_nothing_raised do
+        ECS.default_locale = loc
+      end
+      assert_equal loc, ECS.default_locale
+    end
+    
+    ECS.default_locale = :ca
+    assert_equal :ca, ECS.default_locale
+    ECS.default_locale = 'nonsense'
+    assert_equal :ca, ECS.default_locale
+
+
+    ECS.default_locale = :de
+    assert_equal :de, ECS.default_locale
+    assert_nothing_raised do
+      ECS.reset_default_locale
+    end
+    assert_equal :us, ECS.default_locale
+  end
+
+
+  def test_resolve_locale
+    assert_equal :fr, ECS.resolve_locale( :fr )
+    assert_equal :fr, ECS.resolve_locale( :FR )
+    assert_equal :fr, ECS.resolve_locale( :Fr )
+    assert_equal :fr, ECS.resolve_locale( 'fr' )
+    assert_equal :fr, ECS.resolve_locale( 'FR' )
+    assert_equal :fr, ECS.resolve_locale( 'Fr' )
+    assert_equal :us, ECS.resolve_locale( 'france' )
+    assert_equal :us, ECS.resolve_locale( nil )
+    assert_equal :us, ECS.resolve_locale
+    
+    ECS.default_locale = :ca
+    assert_equal :ca, ECS.resolve_locale( nil )
+    assert_equal :ca, ECS.resolve_locale
+  end
+
+  def test_avaialable_locales
+    [ :ca, :de, :fr, :jp, :uk, :us ].each do |l|
+      assert_equal l, ECS.resolve_locale( l )
+    end
+    
+    ECS.available_locales.each do |l|
+      assert_match /^http:\/\//, ECS.base_urls[l].to_s
+    end
+  end
+  
+  def test_cache_directory
+    assert_nothing_raised do
+      ECS.cache_directory = './test'
+    end
+    assert_equal File.join( Dir.getwd, 'test' ), ECS.cache_directory
+  end
+  
+  
+  
+  def test_generate_dynamic_operation_class
+    assert_raises NameError do
+      ECS::SomethingCrazy
+    end
+    assert_nothing_raised do
+      ECS.something_crazy
+    end
+    s = ECS.something_crazy
+    s2 = ECS.something_crazy
+    assert_match /SomethingCrazy$/, s.class.name
+    assert_equal s.class.name, s2.class.name
+    assert s.class.ancestors.include?( ECS::Help )
+  end
+  
+  def test_resolve_cache_tag
+    assert_equal ECS.resolve_cache_tag( nil ), ECS.resolve_cache_tag( {} )
+    assert_equal ECS.resolve_cache_tag( nil ), ECS.resolve_cache_tag( Fixnum )
+
+    assert_equal ECS.resolve_cache_tag( :a => 'b', :c => 'd' ), ECS.resolve_cache_tag( :c => 'd', :a => 'b' )
+    assert_equal ECS.resolve_cache_tag( :a => 'b', :c => 'd' ), ECS.resolve_cache_tag( 'a=b&c=d' )
+
+    assert_not_equal ECS.resolve_cache_tag( :a => 'b', :c => 'd' ), ECS.resolve_cache_tag( :c => 'd', :a => 'b', :e => 'f' )
+    assert_not_equal ECS.resolve_cache_tag( 'a=b&c=d' ), ECS.resolve_cache_tag( 'c=d&a=b' )
+  end                                                                       
+  def test_strip_namespace
+    assert ECS.strip_namespace?
+    assert_no_match /xmlns\s*=\s*".*?"/, ECS.call_web_service( :Operation => 'Help', :HelpType => 'Operation', :About => 'Help' )
+    
+    assert_nothing_raised do
+      ECS.strip_namespace = false
+    end
+    assert !ECS.strip_namespace?
+    assert_match /xmlns\s*=\s*".*?"/, ECS.call_web_service( :Operation => 'Help', :HelpType => 'Operation', :About => 'Help' )
+
+
+    ECS.strip_namespace = Fixnum
+    assert ECS.strip_namespace?
+    assert_no_match /xmlns\s*=\s*".*?"/, ECS.call_web_service( :Operation => 'Help', :HelpType => 'Operation', :About => 'Help' )
+  end
+
+  def test_read_and_write_and_clear_cache
+    tag = File.join( ECStest.default_test_cache_directory, "test_read_and_write_cache.ecs_cache" )
+    
+    assert !ECS.cached?( tag )
+    
+    assert_nothing_raised do
+      ECS.write_cache( tag, '<?xml version="1.0" encoding="ISO-8859-1"?><awesome><radical>Thursday</radical></awesome>' )
+    end
+    
+    assert ECS.cached?( tag )
+    
+    assert_equal 'Thursday', ECS.read_cache( tag ).awesome.radical.content
+    
+    assert_nothing_raised do
+      ECS.clear_cache( tag )
+    end
+    
+    assert !ECS.cached?( tag )
+  end
+  
+  def test_clear_all_cache
+    tag = File.join( ECStest.default_test_cache_directory, "test_read_and_write_cache.ecs_cache" )
+    ECS.write_cache( tag, 'funky chicken!' )
+    tag = File.join( ECStest.default_test_cache_directory, "test_read_and_write_cache_2.ecs_cache" )
+    ECS.write_cache( tag, 'funky chicken 2!' )
+
+    assert Dir[File.join( ECS.cache_directory, "*.ecs_cache" )].size >= 2, "Actually, there are #{Dir[File.join( ECS.cache_directory, "*.#{ECS::cache_suffix}" )].size} such files."
+    
+    assert_nothing_raised do
+      ECS.clear_cache
+    end
+
+    assert Dir[File.join( ECS.cache_directory, "*.#{ECS::cache_suffix}" )].size == 0
+  end
+  
+  def test_query_string
+    assert_equal 'a=b&c=d', ECS.query_string( :a => 'b', :c => 'd' )
+    assert_equal '', ECS.query_string( 'c=d&a=b' )
+  end
+
+  def test_call_web_service
+    sleep 1 #make sure we don't need to sleep 
+    time_1 = time_2 = time_3 =  nil
+    xml = ''
+    parameters = { :Operation => 'BrowseNodeLookup', :BrowseNodeId => 22 }
+
+    assert_nothing_raised do
+      time_1 = Time.now.to_f
+      xml = ECS.call_web_service( parameters )
+      time_2 = Time.now.to_f
+      ECS.call_web_service( parameters )
+      time_3 = Time.now.to_f
+    end
+
+    assert time_3 - time_1 > 1
+    assert time_2 - time_1 < 1
+    
+    
+    assert_no_match /xmlns/, xml
+  end
+  
+  def test_cache
+    parameters = { :Operation => 'Help', :HelpType => 'Operation', :About => 'BrowseNodeLookup' }
+    tag = ECS.resolve_cache_tag( parameters )
+    ECS.cache = true
+
+    assert !ECS.cached?( tag )
+    assert_nothing_raised do
+      ECS.xml_for_parameters( parameters ) { |x| false }
+    end
+    assert !ECS.cached?( tag )
+
+    assert_nothing_raised do
+      ECS.xml_for_parameters( parameters ) { |x| true }
+    end
+    assert ECS.cached?( tag )
+    ECS.clear_cache( tag )
+    
+
+    # do it all again with cache? = false
+    ECS.cache = false
+
+    assert !ECS.cached?( tag )
+    assert_nothing_raised do
+      ECS.xml_for_parameters( parameters ) { |x| false }
+    end
+    assert !ECS.cached?( tag )
+
+    assert_nothing_raised do
+      ECS.xml_for_parameters( parameters ) { |x| true }
+    end
+    assert ECS.cached?( tag )
+    ECS.clear_cache( tag )
+
+
+    # false with no block should not cache
+    ECS.cache = false
+    assert !ECS.cached?( tag )
+    assert_nothing_raised do
+      ECS.xml_for_parameters( parameters )
+    end
+    assert !ECS.cached?( tag )
+
+    # true with no block should cache
+    ECS.cache = true
+    assert_nothing_raised do
+      ECS.xml_for_parameters( parameters )
+    end
+    assert ECS.cached?( tag )
+  end
+  
+  def test_cache?
+    assert_nothing_raised do
+      ECS.cache = false
+    end
+    assert_equal false, ECS.cache?
+    ECS.cache = true
+    assert_equal true, ECS.cache?
+    
+    ECS.cache = Fixnum
+    assert_equal true, ECS.cache?
+  end
+
+  def test_xml_for_parameters
+    parameters = { :Operation => 'Help', :HelpType => 'Operation', :About => 'BrowseNodeLookup' }
+    tag = ECS.resolve_cache_tag( parameters )
+
+    assert !ECS.cached?( tag )
+
+    xml = nil
+    assert_nothing_raised do
+      xml = ECS.xml_for_parameters( parameters )
+    end
+
+    assert ECS.cached?( tag )
+
+    assert_equal XML::Document, xml.class
+  end
+
+
+  def test_resolve_response_group_klass
+    assert_equal NilClass, ECS::ResponseGroups[:StinkyResponseGroup].class
+    klass = nil
+    assert_nothing_raised do
+      klass = ECS.resolve_response_group_klass( 'StinkyResponseGroup' )
+    end
+    assert !klass.nil?
+    assert_equal Class, klass.class
+    assert_equal Class, ECS::ResponseGroups[:StinkyResponseGroup].class
+    assert_equal klass, ECS::ResponseGroups[:StinkyResponseGroup]
+  end
+  def test_resolve_operation_klass
+    assert_equal NilClass, ECS::Operations[:Stinky].class
+    klass = nil
+    assert_nothing_raised do
+      klass = ECS.resolve_operation_klass( 'Stinky' )
+    end
+    assert !klass.nil?
+    assert_equal Class, klass.class
+    assert_equal Class, ECS::Operations[:Stinky].class
+    assert_equal klass, ECS::Operations[:Stinky]
+  end
+  
+  
+  def test_api_version
+    assert_equal '2007-02-22', ECS.api_version
+  end
+end
+
+
+module Test
+  module Unit
+    module Assertions
+      public
+      def assert_equal_hashes(hsh1, hsh2, message=nil)
+        _wrap_assertion do
+          assert_block( "assert_equal_hashes should not be called with a block." ) { !block_given? }
+          assert_block( "assert_equal_hashes expects a hash, but got a #{hsh1.class.to_s} in first parameter." ) { hsh1.is_a?( Hash ) }
+          assert_block( "assert_equal_hashes expects a hash, but got a #{hsh2.class.to_s} in second parameter." ) { hsh2.is_a?( Hash ) }
+          assert_block( build_message( message, "<?> is not equal to <?>.", hsh1, hsh2 ) ) do
+            hsh1 == hsh2
+          end
+        end
+      end
+    end
+  end
+end