Module: Aws::AwsBaseInterface

Included in:
AcfInterface, Ec2, Elb, Iam, Mon, Rds, S3Interface, SdbInterface, SqsInterface
Defined in:
lib/awsbase/right_awsbase.rb

Constant Summary collapse

DEFAULT_SIGNATURE_VERSION = 
'2'
@@caching = 
false

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#aws_access_key_id ⇒ Object (readonly)

Current aws_access_key_id



298
299
300
 
# File 'lib/awsbase/right_awsbase.rb', line 298

def aws_access_key_id
  @aws_access_key_id
end

#cache ⇒ Object (readonly)

Cache



314
315
316
 
# File 'lib/awsbase/right_awsbase.rb', line 314

def cache
  @cache
end

#connection ⇒ Object (readonly)

RightHttpConnection instance



312
313
314
 
# File 'lib/awsbase/right_awsbase.rb', line 312

def connection
  @connection
end

#last_errors ⇒ Object

Last AWS errors list (used by AWSErrorHandler)



304
305
306
 
# File 'lib/awsbase/right_awsbase.rb', line 304

def last_errors
  @last_errors
end

#last_request ⇒ Object (readonly)

Last HTTP request object



300
301
302
 
# File 'lib/awsbase/right_awsbase.rb', line 300

def last_request
  @last_request
end

#last_request_id ⇒ Object

Returns Amazons request ID for the latest request



306
307
308
 
# File 'lib/awsbase/right_awsbase.rb', line 306

def last_request_id
  @last_request_id
end

#last_response ⇒ Object (readonly)

Last HTTP response object



302
303
304
 
# File 'lib/awsbase/right_awsbase.rb', line 302

def last_response
  @last_response
end

#logger ⇒ Object

Logger object



308
309
310
 
# File 'lib/awsbase/right_awsbase.rb', line 308

def logger
  @logger
end

#params ⇒ Object

Initial params hash



310
311
312
 
# File 'lib/awsbase/right_awsbase.rb', line 310

def params
  @params
end

#signature_version ⇒ Object (readonly)

Signature version (all services except s3)



316
317
318
 
# File 'lib/awsbase/right_awsbase.rb', line 316

def signature_version
  @signature_version
end

Class Method Details

.caching ⇒ Object 



289
290
291
 
# File 'lib/awsbase/right_awsbase.rb', line 289

def self.caching
    @@caching
end

.caching=(caching) ⇒ Object 



293
294
295
 
# File 'lib/awsbase/right_awsbase.rb', line 293

def self.caching=(caching)
    @@caching = caching
end

Instance Method Details

#cache_hits?(function, response, do_raise = :raise) ⇒ Boolean

Check if the aws function response hits the cache or not. If the cache hits:

  • raises an AwsNoChange exception if do_raise == :raise.

  • returnes parsed response from the cache if it exists or true otherwise.

If the cache miss or the caching is off then returns false.

Returns:

  • (Boolean) 


598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
 
# File 'lib/awsbase/right_awsbase.rb', line 598

def cache_hits?(function, response, do_raise=:raise)
    result = false
    if caching?
        function     = function.to_sym
        # get rid of requestId (this bad boy was added for API 2008-08-08+ and it is uniq for every response)
        response     = response.sub(%r{<requestId>.+?</requestId>}, '')
        response_md5 =Digest::MD5.hexdigest(response).to_s
        # check for changes
        unless @cache[function] && @cache[function][:response_md5] == response_md5
            # well, the response is new, reset cache data
            update_cache(function, {:response_md5 => response_md5,
                                    :timestamp    => Time.now,
                                    :hits         => 0,
                                    :parsed       => nil})
        else
            # aha, cache hits, update the data and throw an exception if needed
            @cache[function][:hits] += 1
            if do_raise == :raise
                raise(AwsNoChange, "Cache hit: #{function} response has not changed since "+
                        "#{@cache[function][:timestamp].strftime('%Y-%m-%d %H:%M:%S')}, "+
                        "hits: #{@cache[function][:hits]}.")
            else
                result = @cache[function][:parsed] || true
            end
        end
    end
    result
end

#caching? ⇒ Boolean

Returns true if the describe_xxx responses are being cached

Returns:

  • (Boolean) 


589
590
591
 
# File 'lib/awsbase/right_awsbase.rb', line 589

def caching?
    @params.key?(:cache) ? @params[:cache] : @@caching
end

#close_conn(conn_name) ⇒ Object 



442
443
444
445
446
447
448
449
450
451
 
# File 'lib/awsbase/right_awsbase.rb', line 442

def close_conn(conn_name)
    conn_mode = @params[:connection_mode]
    if conn_mode == :per_thread || conn_mode == :single
        thread = conn_mode == :per_thread ? Thread.current : Thread.main
        if !thread[conn_name].nil?
            thread[conn_name].finish
            thread[conn_name] = nil
        end
    end
end

#generate_request(action, params = {}) ⇒ Object 



369
370
371
 
# File 'lib/awsbase/right_awsbase.rb', line 369

def generate_request(action, params={})
    generate_request2(@aws_access_key_id, @aws_secret_access_key, action, @params[:api_version], @params, params)
end

#generate_request2(aws_access_key, aws_secret_key, action, api_version, lib_params, user_params = {}, options = {}) ⇒ Object

FROM SDB



374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/awsbase/right_awsbase.rb', line 374

def generate_request2(aws_access_key, aws_secret_key, action, api_version, lib_params, user_params={}, options={}) #:nodoc:
    # remove empty params from request
    user_params.delete_if { |key, value| value.nil? }
#            user_params.each_pair do |k,v|
#                user_params[k] = v.force_encoding("UTF-8")
#            end
    #params_string  = params.to_a.collect{|key,val| key + "=#{CGI::escape(val.to_s)}" }.join("&")
    # prepare service data
    service      = lib_params[:service]
#      puts 'service=' + service.to_s
    service_hash = {"Action"         => action,
                    "AWSAccessKeyId" => aws_access_key}
    service_hash.update("Version" => api_version) if api_version
    service_hash.update(user_params)
    service_params = signed_service_params(aws_secret_key, service_hash, :get, lib_params[:server], lib_params[:service])
    #
    # use POST method if the length of the query string is too large
    # see http://docs.amazonwebservices.com/AmazonSimpleDB/2007-11-07/DeveloperGuide/MakingRESTRequests.html
    if service_params.size > 2000
        if signature_version == '2'
            # resign the request because HTTP verb is included into signature
            service_params = signed_service_params(aws_secret_key, service_hash, :post, lib_params[:server], service)
        end
        request                 = Net::HTTP::Post.new(service)
        request.body            = service_params
        request['Content-Type'] = 'application/x-www-form-urlencoded; charset=utf-8'
    else
        request = Net::HTTP::Get.new("#{service}?#{service_params}")
    end

    #puts "\n\n --------------- QUERY REQUEST TO AWS -------------- \n\n"
    #puts "#{@params[:service]}?#{service_params}\n\n"

    # prepare output hash
    {:request  => request,
     :server   => lib_params[:server],
     :port     => lib_params[:port],
     :protocol => lib_params[:protocol]}
end

#get_conn(connection_name, lib_params, logger) ⇒ Object 



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/awsbase/right_awsbase.rb', line 414

def get_conn(connection_name, lib_params, logger)
#            thread = lib_params[:multi_thread] ? Thread.current : Thread.main
#            thread[connection_name] ||= Rightscale::HttpConnection.new(:exception => Aws::AwsError, :logger => logger)
#            conn = thread[connection_name]
#            return conn
    http_conn = nil
    conn_mode = lib_params[:connection_mode]
    
    # Slice all parameters accepted by Rightscale::HttpConnection#new
    params = lib_params.slice(
      :user_agent, :ca_file, :http_connection_retry_count, :http_connection_open_timeout,
      :http_connection_read_timeout, :http_connection_retry_delay
    )
    params.merge!(:exception => AwsError, :logger => logger)
    
    if conn_mode == :per_request
        http_conn = Rightscale::HttpConnection.new(params)

    elsif conn_mode == :per_thread || conn_mode == :single
        thread                  = conn_mode == :per_thread ? Thread.current : Thread.main
        thread[connection_name] ||= Rightscale::HttpConnection.new(params)
        http_conn               = thread[connection_name]
#                ret = request_info_impl(http_conn, bench, request, parser, &block)
    end
    return http_conn

end

#hash_params(prefix, list) ⇒ Object

:nodoc:



737
738
739
740
741
 
# File 'lib/awsbase/right_awsbase.rb', line 737

def hash_params(prefix, list) #:nodoc:
    groups = {}
    list.each_index { |i| groups.update("#{prefix}.#{i+1}"=>list[i]) } if list
    return groups
end

#init(service_info, aws_access_key_id, aws_secret_access_key, params = {}) ⇒ Object

:nodoc:

Raises:



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/awsbase/right_awsbase.rb', line 318

def init(service_info, aws_access_key_id, aws_secret_access_key, params={}) #:nodoc:
    @params = params
    raise AwsError.new("AWS access keys are required to operate on #{service_info[:name]}") \
 if aws_access_key_id.blank? || aws_secret_access_key.blank?
    @aws_access_key_id     = aws_access_key_id
    @aws_secret_access_key = aws_secret_access_key
    # if the endpoint was explicitly defined - then use it
    if @params[:endpoint_url]
        @params[:server]   = URI.parse(@params[:endpoint_url]).host
        @params[:port]     = URI.parse(@params[:endpoint_url]).port
        @params[:service]  = URI.parse(@params[:endpoint_url]).path
        @params[:protocol] = URI.parse(@params[:endpoint_url]).scheme
        @params[:region]   = nil
    else
        @params[:server] ||= service_info[:default_host]
        @params[:server] = "#{@params[:region]}.#{@params[:server]}" if @params[:region]
        @params[:port]        ||= service_info[:default_port]
        @params[:service]     ||= service_info[:default_service]
        @params[:protocol]    ||= service_info[:default_protocol]
        @params[:api_version] ||= service_info[:api_version]
    end
    if !@params[:multi_thread].nil? && @params[:connection_mode].nil? # user defined this
        @params[:connection_mode] = @params[:multi_thread] ? :per_thread : :single
    end
#      @params[:multi_thread] ||= defined?(AWS_DAEMON)
    @params[:connection_mode] ||= :default
    @params[:connection_mode] = :per_request if @params[:connection_mode] == :default
    @logger = @params[:logger]
    @logger = Rails.logger if !@logger && defined?(Rails) && defined?(Rails.logger)
    @logger = ::Rails.logger if !@logger && defined?(::Rails.logger)
    @logger = Logger.new(STDOUT) if !@logger
    @logger.info "New #{self.class.name} using #{@params[:connection_mode].to_s}-connection mode"
    @error_handler     = nil
    @cache             = {}
    @signature_version = (params[:signature_version] || DEFAULT_SIGNATURE_VERSION).to_s
end

#multi_thread ⇒ Object

Return true if this instance works in multi_thread mode and false otherwise.



637
638
639
 
# File 'lib/awsbase/right_awsbase.rb', line 637

def multi_thread
    @params[:multi_thread]
end

#on_exception(options = {:raise=>true, :log=>true}) ⇒ Object

:nodoc:



631
632
633
634
 
# File 'lib/awsbase/right_awsbase.rb', line 631

def on_exception(options={:raise=>true, :log=>true}) # :nodoc:
    raise if $!.is_a?(AwsNoChange)
    AwsError::on_aws_exception(self, options)
end

#request_cache_or_info(method, link, parser_class, benchblock, use_cache = true) ⇒ Object

:nodoc:



716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'lib/awsbase/right_awsbase.rb', line 716

def request_cache_or_info(method, link, parser_class, benchblock, use_cache=true) #:nodoc:
    # We do not want to break the logic of parsing hence will use a dummy parser to process all the standard
    # steps (errors checking etc). The dummy parser does nothig - just returns back the params it received.
    # If the caching is enabled and hit then throw  AwsNoChange.
    # P.S. caching works for the whole images list only! (when the list param is blank)
    # check cache
    response, params = request_info(link, RightDummyParser.new)
    cache_hits?(method.to_sym, response.body) if use_cache
    parser = parser_class.new(:logger => @logger)
    benchblock.xml.add! { parser.parse(response, params) }
    result = block_given? ? yield(parser) : parser.result
    # update parsed data
    update_cache(method.to_sym, :parsed => result) if use_cache
    result
end

#request_info2(request, parser, lib_params, connection_name, logger, bench, options = {}, &block) ⇒ Object

Sends request to Amazon and parses the response Raises AwsError if any banana happened



461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/awsbase/right_awsbase.rb', line 461

def request_info2(request, parser, lib_params, connection_name, logger, bench, options={}, &block) #:nodoc:
    ret       = nil
#            puts 'OPTIONS=' + options.inspect
    http_conn = get_conn(connection_name, lib_params, logger)
    begin
        retry_count = 1
        count       = 0
        while count <= retry_count
            puts 'RETRYING QUERY due to QueryTimeout...' if count > 0
            begin
                ret = request_info_impl(http_conn, bench, request, parser, options, &block)
                break
            rescue Aws::AwsError => ex
                if !ex.include?(/QueryTimeout/) || count == retry_count
                    raise ex
                end
            end
            count += 1
        end
    ensure
        http_conn.finish if http_conn && lib_params[:connection_mode] == :per_request
    end
    ret
end

#request_info_impl(connection, benchblock, request, parser, options = {}, &block) ⇒ Object

:nodoc:



642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
 
# File 'lib/awsbase/right_awsbase.rb', line 642

def request_info_impl(connection, benchblock, request, parser, options={}, &block) #:nodoc:
    @connection    = connection
    @last_request  = request[:request]
    @last_response = nil
    response       =nil
    blockexception = nil

#             puts 'OPTIONS2=' + options.inspect

    if (block != nil)
        # TRB 9/17/07 Careful - because we are passing in blocks, we get a situation where
        # an exception may get thrown in the block body (which is high-level
        # code either here or in the application) but gets caught in the
        # low-level code of HttpConnection.  The solution is not to let any
        # exception escape the block that we pass to HttpConnection::request.
        # Exceptions can originate from code directly in the block, or from user
        # code called in the other block which is passed to response.read_body.
        benchblock.service.add! do
            responsehdr = @connection.request(request) do |response|
                #########
                begin
                    @last_response = response
                    if response.is_a?(Net::HTTPSuccess)
                        @error_handler = nil
                        response.read_body(&block)
                    else
                        @error_handler = AWSErrorHandler.new(self, parser, :errors_list => self.class.amazon_problems) unless @error_handler
                        check_result = @error_handler.check(request, options)
                        if check_result
                            @error_handler = nil
                            return check_result
                        end
                        request_text_data = "#{request[:server]}:#{request[:port]}#{request[:request].path}"
                        raise AwsError.new(@last_errors, @last_response.code, @last_request_id, request_text_data)
                    end
                rescue Exception => e
                    blockexception = e
                end
            end
            #########

            #OK, now we are out of the block passed to the lower level
            if (blockexception)
                raise blockexception
            end
            benchblock.xml.add! do
                parser.parse(responsehdr)
            end
            return parser.result
        end
    else
        benchblock.service.add! { response = @connection.request(request) }
        # check response for errors...
        @last_response = response
        if response.is_a?(Net::HTTPSuccess)
            @error_handler = nil
            benchblock.xml.add! { parser.parse(response) }
            return parser.result
        else
            @error_handler = AWSErrorHandler.new(self, parser, :errors_list => self.class.amazon_problems) unless @error_handler
            check_result = @error_handler.check(request, options)
            if check_result
                @error_handler = nil
                return check_result
            end
            request_text_data = "#{request[:server]}:#{request[:port]}#{request[:request].path}"
            raise AwsError.new(@last_errors, @last_response.code, @last_request_id, request_text_data)
        end
    end
rescue
    @error_handler = nil
    raise
end

#request_info_xml_simple(connection_name, lib_params, request, logger, params = {}) ⇒ Object

This is the direction we should head instead of writing our own parsers for everything, much simpler params:

- :group_tags => hash of indirection to eliminate, see: http://xml-simple.rubyforge.org/
- :force_array => true for all or an array of tag names to force
- :pull_out_array => an array of levels to dig into when generating return value (see rds.rb for example)



492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 
# File 'lib/awsbase/right_awsbase.rb', line 492

def request_info_xml_simple(connection_name, lib_params, request, logger, params = {})

    @connection = get_conn(connection_name, lib_params, logger)
    begin
        @last_request  = request[:request]
        @last_response = nil

        response       = @connection.request(request)
        #       puts "response=" + response.body
#            benchblock.service.add!{ response = @connection.request(request) }
        # check response for errors...
        @last_response = response
        if response.is_a?(Net::HTTPSuccess)
            @error_handler     = nil
#                benchblock.xml.add! { parser.parse(response) }
#                return parser.result
            force_array        = params[:force_array] || false
            # Force_array and group_tags don't work nice together so going to force array manually
            xml_simple_options = {"KeyToSymbol"=>false, 'ForceArray' => false}
            xml_simple_options["GroupTags"] = params[:group_tags] if params[:group_tags]

#                { 'GroupTags' => { 'searchpath' => 'dir' }
#                'ForceArray' => %r(_list$)
            parsed = XmlSimple.xml_in(response.body, xml_simple_options)
            # todo: we may want to consider stripping off a couple of layers when doing this, for instance:
            # <DescribeDBInstancesResponse xmlns="http://rds.amazonaws.com/admin/2009-10-16/">
            #  <DescribeDBInstancesResult>
            #    <DBInstances>
            # <DBInstance>....
            # Strip it off and only return an array or hash of <DBInstance>'s (hash by identifier).
            # would have to be able to make the RequestId available somehow though, perhaps some special array subclass which included that?
            unless force_array.is_a? Array
                force_array = []
            end
            parsed = symbolize(parsed, force_array)
#                puts 'parsed=' + parsed.inspect
            if params[:pull_out_array]
                ret        = Aws::AwsResponseArray.new(parsed[:response_metadata])
                level_hash = parsed
                params[:pull_out_array].each do |x|
                    level_hash = level_hash[x]
                end
                if level_hash.is_a? Hash # When there's only one
                    ret << level_hash
                else # should be array
#                            puts 'level_hash=' + level_hash.inspect
                    level_hash.each do |x|
                        ret << x
                    end
                end
            elsif params[:pull_out_single]
                # returns a single object
                ret        = AwsResponseObjectHash.new(parsed[:response_metadata])
                level_hash = parsed
                params[:pull_out_single].each do |x|
                    level_hash = level_hash[x]
                end
                ret.merge!(level_hash)
            else
                ret = parsed
            end
            return ret

        else
            @error_handler = AWSErrorHandler.new(self, nil, :errors_list => self.class.amazon_problems) unless @error_handler
            check_result = @error_handler.check(request)
            if check_result
                @error_handler = nil
                return check_result
            end
            request_text_data = "#{request[:server]}:#{request[:port]}#{request[:request].path}"
            raise AwsError2.new(@last_response.code, @last_request_id, request_text_data, @last_response.body)
        end
    ensure
        @connection.finish if @connection && lib_params[:connection_mode] == :per_request
    end

end

#signed_service_params(aws_secret_access_key, service_hash, http_verb = nil, host = nil, service = nil) ⇒ Object 



355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/awsbase/right_awsbase.rb', line 355

def signed_service_params(aws_secret_access_key, service_hash, http_verb=nil, host=nil, service=nil)
    case signature_version.to_s
        when '0' then
            AwsUtils::sign_request_v0(aws_secret_access_key, service_hash)
        when '1' then
            AwsUtils::sign_request_v1(aws_secret_access_key, service_hash)
        when '2' then
            AwsUtils::sign_request_v2(aws_secret_access_key, service_hash, http_verb, host, service)
        else
            raise AwsError.new("Unknown signature version (#{signature_version.to_s}) requested")
    end
end

#symbolize(hash, force_array) ⇒ Object 



571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/awsbase/right_awsbase.rb', line 571

def symbolize(hash, force_array)
    ret = {}
    hash.keys.each do |key|
        val = hash[key]
        if val.is_a? Hash
            val = symbolize(val, force_array)
            if force_array.include? key
                val = [val]
            end
        elsif val.is_a? Array
            val = val.collect { |x| symbolize(x, force_array) }
        end
        ret[key.underscore.to_sym] = val
    end
    ret
end

#update_cache(function, hash) ⇒ Object 



627
628
629
 
# File 'lib/awsbase/right_awsbase.rb', line 627

def update_cache(function, hash)
    (@cache[function.to_sym] ||= {}).merge!(hash) if caching?
end