croaker-aws-s3 0.5.2.20090127001

data/support/rdoc/code_info.rb

@@ -0,0 +1,211 @@
+require 'rubygems'
+require 'rake'
+require 'rdoc/rdoc'
+
+module RDoc
+  class CodeInfo    
+    class << self
+      def parse(wildcard_pattern = nil)
+        @info_for_corpus = parse_files(wildcard_pattern)
+      end
+      
+      def for(constant)
+        new(constant).info
+      end
+      
+      def info_for_corpus
+        raise RuntimeError, "You must first generate a corpus to search by using RDoc::CodeInfo.parse" unless @info_for_corpus
+        @info_for_corpus
+      end
+      
+      def parsed_files
+        info_for_corpus.map {|info| info.file_absolute_name}
+      end
+      
+      def files_to_parse
+        @files_to_parse ||= Rake::FileList.new
+      end
+      
+      private
+        def parse_files(pattern)
+          files   = pattern ? Rake::FileList[pattern] : files_to_parse
+          options = Options.instance
+          options.parse(files << '-q', RDoc::GENERATORS)
+          rdoc.send(:parse_files, options)
+        end
+        
+        def rdoc
+          TopLevel.reset
+          rdoc  = RDoc.new
+          stats = Stats.new
+          # We don't want any output so we'll override the print method
+          stats.instance_eval { def print; nil end } 
+          rdoc.instance_variable_set(:@stats, stats)
+          rdoc
+        end
+    end
+    
+    attr_reader :info
+    def initialize(location)
+      @location = CodeLocation.new(location)
+      find_constant
+      find_method if @location.has_method?
+    end
+    
+    private
+      attr_reader :location
+      attr_writer :info
+      def find_constant
+        parts = location.namespace_parts
+        self.class.info_for_corpus.each do |file_info|
+          @info = parts.inject(file_info) do |result, const_part|
+            (result.find_module_named(const_part) || result.find_class_named(const_part)) || break
+          end
+          return if info
+        end
+      end
+      
+      def find_method
+        return unless info
+        self.info = info.method_list.detect do |method_info|
+          next unless method_info.name == location.method_name
+          if location.class_method?
+            method_info.singleton
+          elsif location.instance_method?
+            !method_info.singleton
+          else
+            true
+          end
+        end
+      end
+  end
+  
+  class CodeLocation
+    attr_reader :location
+
+    def initialize(location)
+      @location = location
+    end
+
+    def parts
+      location.split(/::|\.|#/)
+    end
+
+    def namespace_parts
+      has_method? ? parts[0...-1] : parts
+    end
+
+    def has_method?
+      ('a'..'z').include?(parts.last[0, 1])
+    end
+
+    def instance_method?
+      !location['#'].nil?
+    end
+
+    def class_method?
+      has_method? && !location[/#|\./]
+    end
+
+    def method_name
+      parts.last if has_method?
+    end
+  end
+end
+
+if __FILE__ == $0
+  require 'test/unit'
+  class CodeInfoTest < Test::Unit::TestCase
+    def setup
+      RDoc::CodeInfo.parse(__FILE__)
+    end
+    
+    def test_constant_lookup
+      assert RDoc::CodeInfo.for('RDoc')
+      
+      info = RDoc::CodeInfo.for('RDoc::CodeInfo')
+      assert_equal 'CodeInfo', info.name      
+    end
+    
+    def test_method_lookup
+      {'RDoc::CodeInfo.parse'          => true,
+       'RDoc::CodeInfo::parse'         => true,
+       'RDoc::CodeInfo#parse'          => false,
+       'RDoc::CodeInfo.find_method'    => true,
+       'RDoc::CodeInfo::find_method'   => false,
+       'RDoc::CodeInfo#find_method'    => true,
+       'RDoc::CodeInfo#no_such_method' => false,
+       'RDoc::NoSuchConst#foo'         => false}.each do |location, result_of_lookup|
+         assert_equal result_of_lookup, !RDoc::CodeInfo.for(location).nil?
+       end
+    end
+  end
+  
+  class CodeLocationTest < Test::Unit::TestCase
+    def test_parts
+       {'Foo'           => %w(Foo),
+        'Foo::Bar'      => %w(Foo Bar),
+        'Foo::Bar#baz'  => %w(Foo Bar baz),
+        'Foo::Bar.baz'  => %w(Foo Bar baz),
+        'Foo::Bar::baz' => %w(Foo Bar baz),
+        'Foo::Bar::Baz' => %w(Foo Bar Baz)}.each do |location, parts|
+          assert_equal parts, RDoc::CodeLocation.new(location).parts
+        end
+    end
+    
+    def test_namespace_parts
+      {'Foo'           => %w(Foo),
+       'Foo::Bar'      => %w(Foo Bar),
+       'Foo::Bar#baz'  => %w(Foo Bar),
+       'Foo::Bar.baz'  => %w(Foo Bar),
+       'Foo::Bar::baz' => %w(Foo Bar),
+       'Foo::Bar::Baz' => %w(Foo Bar Baz)}.each do |location, namespace_parts|
+         assert_equal namespace_parts, RDoc::CodeLocation.new(location).namespace_parts
+       end
+     end
+    
+    def test_has_method?
+      {'Foo'           => false,
+       'Foo::Bar'      => false,
+       'Foo::Bar#baz'  => true,
+       'Foo::Bar.baz'  => true,
+       'Foo::Bar::baz' => true,
+       'Foo::Bar::Baz' => false}.each do |location, has_method_result|
+         assert_equal has_method_result, RDoc::CodeLocation.new(location).has_method?
+       end
+     end
+     
+    def test_instance_method?
+      {'Foo'           => false,
+       'Foo::Bar'      => false,
+       'Foo::Bar#baz'  => true,
+       'Foo::Bar.baz'  => false,
+       'Foo::Bar::baz' => false,
+       'Foo::Bar::Baz' => false}.each do |location, is_instance_method|
+         assert_equal is_instance_method, RDoc::CodeLocation.new(location).instance_method?
+       end
+     end
+     
+     def test_class_method?
+       {'Foo'           => false,
+        'Foo::Bar'      => false,
+        'Foo::Bar#baz'  => false,
+        'Foo::Bar.baz'  => false,
+        'Foo::Bar::baz' => true,
+        'Foo::Bar::Baz' => false}.each do |location, is_class_method|
+          assert_equal is_class_method, RDoc::CodeLocation.new(location).class_method?
+        end
+      end
+      
+      def test_method_name
+        {'Foo'           => nil,
+         'Foo::Bar'      => nil,
+         'Foo::Bar#baz'  => 'baz',
+         'Foo::Bar.baz'  => 'baz',
+         'Foo::Bar::baz' => 'baz',
+         'Foo::Bar::Baz' => nil}.each do |location, method_name|
+           assert_equal method_name, RDoc::CodeLocation.new(location).method_name
+         end
+       end
+  end
+end

data/test/acl_test.rb

@@ -0,0 +1,254 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class PolicyReadingTest < Test::Unit::TestCase
+  
+  def setup
+    @policy = prepare_policy
+  end
+  
+  def test_policy_owner
+    assert_kind_of Owner, @policy.owner
+    assert_equal 'bb2041a25975c3d4ce9775fe9e93e5b77a6a9fad97dc7e00686191f3790b13f1', @policy.owner.id
+    assert_equal 'mmolina@onramp.net', @policy.owner.display_name
+  end
+  
+  def test_grants
+    assert @policy.grants
+    assert !@policy.grants.empty?
+    grant = @policy.grants.first
+    assert_kind_of ACL::Grant, grant
+    assert_equal 'FULL_CONTROL', grant.permission
+  end
+  
+  def test_grants_have_grantee
+    grant = @policy.grants.first
+    assert grantee = grant.grantee
+    assert_kind_of ACL::Grantee, grantee
+    assert_equal 'bb2041a25975c3d4ce9775fe9e93e5b77a6a9fad97dc7e00686191f3790b13f1', grantee.id
+    assert_equal 'mmolina@onramp.net', grantee.display_name
+    assert_equal 'CanonicalUser', grantee.type
+  end
+  
+  def test_grantee_always_responds_to_email_address
+    assert_nothing_raised do
+      @policy.grants.first.grantee.email_address
+    end
+  end
+  
+  private
+    def prepare_policy
+      ACL::Policy.new(parsed_policy)
+    end
+  
+    def parsed_policy
+      Parsing::XmlParser.new Fixtures::Policies.policy_with_one_grant
+    end
+end
+
+class PolicyWritingTest < PolicyReadingTest
+  
+  def setup
+    policy = prepare_policy
+    # Dump the policy to xml and retranslate it back from the xml then run all the tests in the xml reading
+    # test. This round tripping indirectly asserts that the original xml document is the same as the to_xml
+    # dump.
+    @policy = ACL::Policy.new(Parsing::XmlParser.new(policy.to_xml))
+  end
+  
+end
+
+class PolicyTest < Test::Unit::TestCase
+  def test_building_policy_by_hand
+    policy = grant = grantee = nil
+    assert_nothing_raised do
+      policy                = ACL::Policy.new
+      grant                 = ACL::Grant.new
+      grantee               = ACL::Grantee.new
+      grantee.email_address = 'marcel@vernix.org'
+      grant.permission      = 'READ_ACP'
+      grant.grantee         = grantee
+      policy.grants << grant
+      policy.owner          = Owner.new('id' => '123456789', 'display_name' => 'noradio')
+    end
+    
+    assert_nothing_raised do
+      policy.to_xml
+    end
+    
+    assert !policy.grants.empty?
+    assert_equal 1, policy.grants.size
+    assert_equal 'READ_ACP', policy.grants.first.permission
+  end
+  
+  def test_include?
+    policy = ACL::Policy.new(Parsing::XmlParser.new(Fixtures::Policies.policy_with_one_grant))
+    assert !policy.grants.include?(:public_read)
+    policy.grants << ACL::Grant.grant(:public_read)
+    assert policy.grants.include?(:public_read)
+    
+    assert policy.grants.include?(ACL::Grant.grant(:public_read))
+    [false, 1, '1'].each do |non_grant|
+      assert !policy.grants.include?(non_grant)
+    end
+  end
+  
+  def test_delete
+    policy = ACL::Policy.new(Parsing::XmlParser.new(Fixtures::Policies.policy_with_one_grant))
+    policy.grants << ACL::Grant.grant(:public_read)
+    assert policy.grants.include?(:public_read)
+    assert policy.grants.delete(:public_read)
+    assert !policy.grants.include?(:public_read)
+    [false, 1, '1'].each do |non_grant|
+      assert_nil policy.grants.delete(non_grant)
+    end
+  end
+  
+  def test_grant_list_comparison
+    policy  = ACL::Policy.new
+    policy2 = ACL::Policy.new
+    
+    grant_names = [:public_read, :public_read_acp, :authenticated_write]
+    grant_names.each {|grant_name| policy.grants << ACL::Grant.grant(grant_name)}
+    grant_names.reverse_each {|grant_name| policy2.grants << ACL::Grant.grant(grant_name)}
+    
+    assert_equal policy.grants, policy2.grants
+  end
+end
+
+class GrantTest < Test::Unit::TestCase
+  def test_permission_must_be_valid
+    grant = ACL::Grant.new
+    assert_nothing_raised do
+      grant.permission = 'READ_ACP'
+    end
+    
+    assert_raises(InvalidAccessControlLevel) do
+      grant.permission = 'not a valid permission'
+    end
+  end
+  
+  def test_stock_grants
+    assert_raises(ArgumentError) do
+      ACL::Grant.grant :this_is_not_a_stock_grant
+    end
+    
+    grant = nil
+    assert_nothing_raised do
+      grant = ACL::Grant.grant(:public_read)
+    end
+    
+    assert grant
+    assert_kind_of ACL::Grant, grant
+    assert_equal 'READ', grant.permission
+    assert grant.grantee
+    assert_kind_of ACL::Grantee, grant.grantee
+    assert_equal 'AllUsers', grant.grantee.group
+  end
+end
+
+class GranteeTest < Test::Unit::TestCase
+  def test_type_inference
+    grantee = ACL::Grantee.new
+    
+    assert_nothing_raised do
+      grantee.type
+    end
+    
+    assert_nil grantee.type
+    grantee.group = 'AllUsers'
+    assert_equal 'AllUsers', grantee.group
+    assert_equal 'Group', grantee.type
+    grantee.email_address = 'marcel@vernix.org'
+    assert_equal 'AmazonCustomerByEmail', grantee.type
+    grantee.display_name = 'noradio'
+    assert_equal 'AmazonCustomerByEmail', grantee.type
+    grantee.id = '123456789'
+    assert_equal 'CanonicalUser', grantee.type
+  end
+  
+  def test_type_is_extracted_if_present
+    grantee = ACL::Grantee.new('xsi:type' => 'CanonicalUser')
+    assert_equal 'CanonicalUser', grantee.type
+  end
+  
+  def test_type_representation
+    grantee = ACL::Grantee.new('uri' => 'http://acs.amazonaws.com/groups/global/AllUsers')
+    
+    assert_equal 'AllUsers Group', grantee.type_representation
+    grantee.group = 'AuthenticatedUsers'
+    assert_equal 'AuthenticatedUsers Group', grantee.type_representation
+    grantee.email_address = 'marcel@vernix.org'
+    assert_equal 'marcel@vernix.org', grantee.type_representation
+    grantee.display_name = 'noradio'
+    grantee.id = '123456789'
+    assert_equal 'noradio', grantee.type_representation
+  end
+end
+
+class ACLOptionProcessorTest < Test::Unit::TestCase
+  def test_empty_options
+    options = {}
+    assert_nothing_raised do
+      process! options
+    end
+    assert_equal({}, options)
+  end
+  
+  def test_invalid_access_level
+    options = {:access => :foo}
+    assert_raises(InvalidAccessControlLevel) do
+      process! options
+    end
+  end
+  
+  def test_valid_access_level_is_normalized
+    valid_access_levels = [
+      {:access     => :private},
+      {'access'    => 'private'},
+      {:access     => 'private'},
+      {'access'    => :private},
+      {'x-amz-acl' => 'private'},
+      {:x_amz_acl  => :private},
+      {:x_amz_acl  => 'private'},
+      {'x_amz_acl' => :private}
+    ]
+    
+    valid_access_levels.each do |options|
+      assert_nothing_raised do
+        process! options
+      end
+      assert_equal 'private', acl(options)
+    end
+    
+    valid_hyphenated_access_levels = [
+      {:access     => :public_read},
+      {'access'    => 'public_read'},
+      {'access'    => 'public-read'},
+      {:access     => 'public_read'},
+      {:access     => 'public-read'},
+      {'access'    => :public_read},
+      
+      {'x-amz-acl' => 'public_read'},
+      {:x_amz_acl  => :public_read},
+      {:x_amz_acl  => 'public_read'},
+      {:x_amz_acl  => 'public-read'},
+      {'x_amz_acl' => :public_read}
+    ]
+    
+    valid_hyphenated_access_levels.each do |options|
+      assert_nothing_raised do
+        process! options
+      end
+      assert_equal 'public-read', acl(options)
+    end
+  end
+  
+  private
+    def process!(options)
+      ACL::OptionProcessor.process!(options)
+    end
+    
+    def acl(options)
+      options['x-amz-acl']
+    end
+end

data/test/authentication_test.rb

@@ -0,0 +1,114 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class HeaderAuthenticationTest < Test::Unit::TestCase  
+  def test_encoded_canonical
+    signature = Authentication::Signature.new(request, key_id, secret)
+    assert_equal AmazonDocExampleData::Example1.canonical_string, signature.send(:canonical_string)
+    assert_equal AmazonDocExampleData::Example1.signature, signature.send(:encoded_canonical)
+  end
+  
+  def test_authorization_header
+    header = Authentication::Header.new(request, key_id, secret)
+    assert_equal AmazonDocExampleData::Example1.canonical_string, header.send(:canonical_string)
+    assert_equal AmazonDocExampleData::Example1.authorization_header, header
+  end
+  
+  private
+    def request; AmazonDocExampleData::Example1.request end
+    def key_id ; AmazonDocExampleData::Example1.access_key_id end
+    def secret ; AmazonDocExampleData::Example1.secret_access_key end
+end
+
+class QueryStringAuthenticationTest < Test::Unit::TestCase
+  def test_query_string
+    query_string = Authentication::QueryString.new(request, key_id, secret, :expires_in => 60)
+    assert_equal AmazonDocExampleData::Example3.canonical_string, query_string.send(:canonical_string)
+    assert_equal AmazonDocExampleData::Example3.query_string, query_string
+  end
+  
+  def test_query_string_with_explicit_expiry
+    query_string = Authentication::QueryString.new(request, key_id, secret, :expires => expires)
+    assert_equal expires, query_string.send(:canonical_string).instance_variable_get(:@options)[:expires]
+    assert_equal AmazonDocExampleData::Example3.query_string, query_string
+  end
+  
+  def test_expires_in_is_coerced_to_being_an_integer_in_case_it_is_a_special_integer_proxy
+    # References bug: http://rubyforge.org/tracker/index.php?func=detail&aid=17458&group_id=2409&atid=9356
+    integer_proxy = Class.new do
+      attr_reader :integer
+      def initialize(integer)
+        @integer = integer
+      end
+      
+      def to_int
+        integer
+      end
+    end
+    
+    actual_integer = 25
+    query_string = Authentication::QueryString.new(request, key_id, secret, :expires_in => integer_proxy.new(actual_integer))
+    assert_equal actual_integer, query_string.send(:expires_in)
+  end
+  
+  private
+    def request; AmazonDocExampleData::Example3.request end
+    def key_id ; AmazonDocExampleData::Example3.access_key_id end
+    def secret ; AmazonDocExampleData::Example3.secret_access_key end
+    def expires; AmazonDocExampleData::Example3.expires end
+end
+
+class CanonicalStringTest < Test::Unit::TestCase  
+  def setup
+    @request = Net::HTTP::Post.new('/test')
+    @canonical_string = Authentication::CanonicalString.new(@request)
+  end
+  
+  def test_path_does_not_include_query_string
+    request = Net::HTTP::Get.new('/test/query/string?foo=bar&baz=quux')
+    assert_equal '/test/query/string', Authentication::CanonicalString.new(request).send(:path)
+    
+    # Make sure things still work when there is *no* query string
+    request = Net::HTTP::Get.new('/')
+    assert_equal '/', Authentication::CanonicalString.new(request).send(:path)
+    request = Net::HTTP::Get.new('/foo/bar')
+    assert_equal '/foo/bar', Authentication::CanonicalString.new(request).send(:path)
+  end
+  
+  def test_path_includes_significant_query_strings
+    significant_query_strings = [
+      ['/test/query/string?acl',             '/test/query/string?acl'],
+      ['/test/query/string?acl&foo=bar',     '/test/query/string?acl'],
+      ['/test/query/string?foo=bar&acl',     '/test/query/string?acl'],
+      ['/test/query/string?acl=foo',         '/test/query/string?acl'],
+      ['/test/query/string?torrent=foo',     '/test/query/string?torrent'],
+      ['/test/query/string?logging=foo',     '/test/query/string?logging'],
+      ['/test/query/string?bar=baz&acl=foo', '/test/query/string?acl']
+    ]
+    
+    significant_query_strings.each do |uncleaned_path, expected_cleaned_path|
+      assert_equal expected_cleaned_path, Authentication::CanonicalString.new(Net::HTTP::Get.new(uncleaned_path)).send(:path)
+    end
+  end
+  
+  def test_default_headers_set
+    Authentication::CanonicalString.default_headers.each do |header|
+      assert @canonical_string.headers.include?(header)
+    end
+  end
+  
+  def test_interesting_headers_are_copied_over
+    an_interesting_header = 'content-md5'
+    string_without_interesting_header = Authentication::CanonicalString.new(@request)
+    assert string_without_interesting_header.headers[an_interesting_header].empty?
+    
+    # Add an interesting header
+    @request[an_interesting_header] = 'foo'
+    string_with_interesting_header = Authentication::CanonicalString.new(@request)
+    assert_equal 'foo', string_with_interesting_header.headers[an_interesting_header]
+  end
+  
+  def test_canonical_string
+    request = AmazonDocExampleData::Example1.request
+    assert_equal AmazonDocExampleData::Example1.canonical_string, Authentication::CanonicalString.new(request)
+  end
+end