right_aws 1.10.0 → 2.0.0

data/lib/acf/right_acf_origin_access_identities.rb

@@ -0,0 +1,230 @@
+#
+# Copyright (c) 2010 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module RightAws
+  
+  class AcfInterface
+
+    # List Origin Access Identities.
+    #
+    #  acf.list_origin_access_identities #=>
+    #    [{:comment=>"kd: TEST",
+    #      :s3_canonical_user_id=>
+    #       "c7ca36f6c5d384e60aeca02032ac748bae3c458c5322a2e279382935f1f71b16d9ac251f7f71f1ea91c37d3c214645b8",
+    #      :aws_id=>"E3TL4XWF5KTGH"},
+    #     {:comment=>"kd: TEST-2",
+    #      :s3_canonical_user_id=>
+    #       "9af7058b1d197c2c03fdcc3ddad07012a7822f5fc4a8156025409ffac646bdae4dc714820482c92e6988e5703c8d9954",
+    #      :aws_id=>"E3HJ7V8C3324VF"},
+    #     {:comment=>"MyTestAccessIdentity",
+    #      :s3_canonical_user_id=>
+    #       "de4361b33dbaf499d3d77159bfa1571d3451eaec25a2b16553de5e534da8089bb8c31a4898d73d1a658155d0e48872a7",
+    #      :aws_id=>"E3JPJZ80ZBX24G"}]
+    #
+    def list_origin_access_identities
+      result = []
+      incrementally_list_origin_access_identities do |response|
+        result += response[:origin_access_identities]
+        true
+      end
+      result
+    end
+
+    # Incrementally list Origin Access Identities.
+    # Optional params: +:marker+ and +:max_items+.
+    #
+    #  acf.incrementally_list_origin_access_identities(:max_items => 2) #=>
+    #    {:origin_access_identities=>
+    #      [{:comment=>"kd: TEST",
+    #        :s3_canonical_user_id=>
+    #         "c7ca36f6c5d384e60aeca02032ac748bae3c458c5322a2e279382935f1f71b16d9ac251f7f71f1ea91c37d3c214645b8",
+    #        :aws_id=>"E3TL4XWF5KTGH"},
+    #       {:comment=>"kd: TEST-2",
+    #        :s3_canonical_user_id=>
+    #         "9af7058b1d197c2c03fdcc3ddad07012a7822f5fc4a8156025409ffac646bdae4dc714820482c92e6988e5703c8d9954",
+    #        :aws_id=>"E3HJ7V8C3324VF"}],
+    #     :is_truncated=>true,
+    #     :max_items=>2,
+    #     :marker=>"",
+    #     :next_marker=>"E3HJ7V8C3324VF"}
+    #
+    #   # get max 100 origin access identities (the list will be restricted by a default MaxItems value ==100 )
+    #   incrementally_list_origin_access_identities
+    #
+    #   # list origin access identities by 10
+    #   acf.incrementally_list_origin_access_identities(:max_items => 10) do |response|
+    #     puts response.inspect # a list of 10 distributions
+    #     true # return false if the listing should be broken otherwise use true
+    #   end
+    #
+    def incrementally_list_origin_access_identities(params={}, &block)
+      opts = {}
+      opts['MaxItems'] = params[:max_items] if params[:max_items]
+      opts['Marker']   = params[:marker]    if params[:marker]
+      last_response = nil
+      loop do
+        link = generate_request('GET', 'origin-access-identity/cloudfront', opts)
+        last_response = request_info(link,  AcfOriginAccesIdentitiesListParser.new(:logger => @logger))
+        opts['Marker'] = last_response[:next_marker]
+        break unless block && block.call(last_response) && !last_response[:next_marker].blank?
+      end
+      last_response
+    end
+
+    #-----------------------------------------------------------------
+    #      Origin Access Identity
+    #-----------------------------------------------------------------
+
+    # Create a new CloudFront Origin Access Identity.
+    #
+    #  acf.create_origin_access_identity('MyTestAccessIdentity') #=>
+    #    {:e_tag=>"E2QOKZEXCUWHJX",
+    #     :comment=>"MyTestAccessIdentity",
+    #     :location=>
+    #       "https://cloudfront.amazonaws.com/origin-access-identity/cloudfront/E3JPJZ80ZBX24G",
+    #     :caller_reference=>"201004161657467493031273",
+    #     :s3_canonical_user_id=>
+    #       "de4361b33dbaf499d3d77159bfa1571d3451eaec25a2b16553de5e534da8089bb8c31a4898d73d1a658155d0e48872a7",
+    #     :aws_id=>"E3JPJZ80ZBX24G"}
+    #
+    def create_origin_access_identity(comment='', caller_reference=nil)
+      config = { :comment          => comment,
+                 :caller_reference => caller_reference }
+      create_origin_access_identity_by_config(config)
+    end
+
+    def create_origin_access_identity_by_config(config)
+      config[:caller_reference] ||= generate_call_reference
+      link = generate_request('POST', 'origin-access-identity/cloudfront', {}, origin_access_identity_config_to_xml(config))
+      merge_headers(request_info(link, AcfOriginAccesIdentitiesListParser.new(:logger => @logger))[:origin_access_identities].first)
+    end
+
+    # Get Origin Access Identity
+    #
+    #  acf.get_origin_access_identity('E3HJ7V8C3324VF') #=>
+    #    {:comment=>"kd: TEST-2",
+    #     :caller_reference=>"201004161655035372351604",
+    #     :aws_id=>"E3HJ7V8C3324VF",
+    #     :s3_canonical_user_id=>
+    #      "9af7058b1d197c2c03fdcc3ddad07012a7822f5fc4a8156025409ffac646bdae4dc714820482c92e6988e5703c8d9954",
+    #     :e_tag=>"E309Q4IM450498"}
+    #
+    def get_origin_access_identity(aws_id)
+      link = generate_request('GET', "origin-access-identity/cloudfront/#{aws_id}")
+      merge_headers(request_info(link, AcfOriginAccesIdentitiesListParser.new(:logger => @logger))[:origin_access_identities].first)
+    end
+
+    # Get Origin Access Identity
+    #
+    #  acf.get_origin_access_identity('E3HJ7V8C3324VF') #=>
+    #    {:comment=>"kd: TEST-2",
+    #     :caller_reference=>"201004161655035372351604",
+    #     :aws_id=>"E3HJ7V8C3324VF",
+    #     :s3_canonical_user_id=>
+    #      "9af7058b1d197c2c03fdcc3ddad07012a7822f5fc4a8156025409ffac646bdae4dc714820482c92e6988e5703c8d9954",
+    #     :e_tag=>"E309Q4IM450498"}
+    #
+    #  acf.delete_origin_access_identity("E3HJ7V8C3324VF","E309Q4IM450498") #=> true
+    #
+    def delete_origin_access_identity(aws_id, e_tag)
+      link = generate_request('DELETE', "origin-access-identity/cloudfront/#{aws_id}", {}, nil,
+                                        'If-Match' => e_tag)
+      request_info(link, RightHttp2xxParser.new(:logger => @logger))
+    end
+
+    #-----------------------------------------------------------------
+    #      Config
+    #-----------------------------------------------------------------
+
+    def origin_access_identity_config_to_xml(config) # :nodoc:
+      "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" +
+      "<CloudFrontOriginAccessIdentityConfig xmlns=\"http://#{@params[:server]}/doc/#{API_VERSION}/\">\n" +
+      "  <CallerReference>#{config[:caller_reference]}</CallerReference>\n" +
+      "  <Comment>#{AcfInterface::escape(config[:comment].to_s)}</Comment>\n" +
+      "</CloudFrontOriginAccessIdentityConfig>"
+    end
+
+    # Get Origin Access Identity config
+    #
+    #  acf.get_origin_access_identity_config("E3JPJZ80ZBX24G") #=>
+    #    {:comment=>"MyTestAccessIdentity",
+    #     :caller_reference=>"201004161657467493031273",
+    #     :e_tag=>"E2QOKZEXCUWHJX"}
+    #
+    def get_origin_access_identity_config(aws_id)
+      link = generate_request('GET', "origin-access-identity/cloudfront/#{aws_id}/config")
+      merge_headers(request_info(link, AcfOriginAccesIdentitiesListParser.new(:logger => @logger))[:origin_access_identities].first)
+    end
+
+    # Set Origin Access Identity config
+    #
+    #
+    #  acf.set_origin_access_identity_config("E2QOKZEXCUWHJX",
+    #                                        :comment => "MyBestOriginAccessConfig",
+    #                                        :caller_reference => '01234567890',
+    #                                        :e_tag=>"E2QOKZEXCUWHJX") #=> true
+    #                                        
+    # P.S. This guy is not tested yet: http://developer.amazonwebservices.com/connect/thread.jspa?threadID=45256
+    def set_origin_access_identity_config(aws_id, config)
+      link = generate_request('PUT', "origin-access-identity/cloudfront/#{aws_id}/config", {}, origin_access_identity_config_to_xml(config),
+                                     'If-Match' => config[:e_tag])
+      request_info(link, RightHttp2xxParser.new(:logger => @logger))
+    end
+
+    #-----------------------------------------------------------------
+    #      PARSERS:
+    #-----------------------------------------------------------------
+
+    class AcfOriginAccesIdentitiesListParser < RightAWSParser # :nodoc:
+      def reset
+        @result = { :origin_access_identities => [] }
+      end
+      def tagstart(name, attributes)
+        case full_tag_name
+        when %r{CloudFrontOriginAccessIdentitySummary$},
+             %r{^CloudFrontOriginAccessIdentity$},
+             %r{^CloudFrontOriginAccessIdentityConfig$}
+          @item = {}
+        end
+      end
+      def tagend(name)
+        case name
+        when 'Marker'            then @result[:marker]       = @text
+        when 'NextMarker'        then @result[:next_marker]  = @text
+        when 'MaxItems'          then @result[:max_items]    = @text.to_i
+        when 'IsTruncated'       then @result[:is_truncated] = (@text == 'true')
+        when 'Id'                then @item[:aws_id]               = @text
+        when 'S3CanonicalUserId' then @item[:s3_canonical_user_id] = @text
+        when 'CallerReference'   then @item[:caller_reference] = @text
+        when 'Comment'           then @item[:comment]              = AcfInterface::unescape(@text)
+        end
+        case full_tag_name
+        when %r{CloudFrontOriginAccessIdentitySummary$},
+             %r{^CloudFrontOriginAccessIdentity$},
+             %r{^CloudFrontOriginAccessIdentityConfig$}
+          @result[:origin_access_identities] << @item
+        end
+      end
+    end
+
+  end
+end

data/lib/acf/right_acf_streaming_interface.rb

@@ -0,0 +1,236 @@
+#
+# Copyright (c) 2008 RightScale Inc
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+module RightAws
+  
+  class AcfInterface
+    
+    def streaming_distribution_config_to_xml(config) # :nodoc:
+      distribution_config_to_xml(config, 'StreamingDistributionConfig')
+    end
+
+    #-----------------------------------------------------------------
+    #      API Calls:
+    #-----------------------------------------------------------------
+
+    # List all streaming distributions.
+    # Returns an array of distributions or RightAws::AwsError exception.
+    #
+    #  acf.list_streaming_distributions #=>
+    #    [{:status=>"Deployed",
+    #      :aws_id=>"E3CWE2Z9USOS6B",
+    #      :enabled=>true,
+    #      :domain_name=>"s2jz1ourvss1fj.cloudfront.net",
+    #      :origin=>"bucket-for-konstantin-00.s3.amazonaws.com",
+    #      :last_modified_time=>"2010-04-19T08:53:32.574Z",
+    #      :comment=>"Woo-Hoo!",
+    #      :cnames=>["stream.web.my-awesome-site.net"]},
+    #      ...
+    #     {:status=>"Deployed",
+    #      :aws_id=>"E3NPQZY4LKAYQ8",
+    #      :enabled=>true,
+    #      :domain_name=>"sw9nrsq9pudk3.cloudfront.net",
+    #      :origin=>"bucket-for-konstantin-00.s3.amazonaws.com",
+    #      :last_modified_time=>"2010-04-19T08:59:09.600Z",
+    #      :comment=>"Woo-Hoo!",
+    #      :cnames=>["stream-6.web.my-awesome-site.net"]}]
+    #
+    def list_streaming_distributions
+      result = []
+      incrementally_list_streaming_distributions do |response|
+        result += response[:distributions]
+        true
+      end
+      result
+    end
+
+    # Incrementally list streaming distributions.
+    #
+    # Optional params: +:marker+ and +:max_items+.
+    #
+    #   # get first streaming distribution
+    #   incrementally_list_distributions(:max_items => 1) #=>
+    #    {:marker=>"",
+    #     :next_marker=>"E3CWE2Z9USOS6B",
+    #     :distributions=>
+    #      [{:status=>"Deployed",
+    #        :cnames=>["stream.web.my-awesome-site.net"],
+    #        :aws_id=>"E3CWE2Z9USOS6B",
+    #        :enabled=>true,
+    #        :last_modified_time=>"2010-04-19T08:53:32.574Z",
+    #        :domain_name=>"s2jz1ourvss1fj.cloudfront.net",
+    #        :origin=>"bucket-for-konstantin-00.s3.amazonaws.com",
+    #        :comment=>"Woo-Hoo!"}],
+    #     :max_items=>1,
+    #     :is_truncated=>true}
+    #
+    #   # get max 100 streaming distributions (the list will be restricted by a default MaxItems value ==100 )
+    #   incrementally_list_streaming_distributions
+    #
+    #   # list streaming distributions by 10
+    #   incrementally_list_streaming_distributions(:max_items => 10) do |response|
+    #     puts response.inspect # a list of 10 distributions
+    #     true # return false if the listing should be broken otherwise use true
+    #   end
+    #
+    def incrementally_list_streaming_distributions(params={}, &block)
+      opts = {}
+      opts['MaxItems'] = params[:max_items] if params[:max_items]
+      opts['Marker']   = params[:marker]    if params[:marker]
+      last_response = nil
+      loop do
+        link = generate_request('GET', 'streaming-distribution', opts)
+        last_response = request_info(link,  AcfDistributionListParser.new(:logger => @logger))
+        opts['Marker'] = last_response[:next_marker]
+        break unless block && block.call(last_response) && !last_response[:next_marker].blank?
+      end
+      last_response
+    end
+
+    # Create a new streaming distribution.
+    # Returns the just created distribution or RightAws::AwsError exception.
+    #
+    #  acf.create_streaming_distribution('bucket-for-konstantin-00.s3.amazonaws.com', 'Woo-Hoo!', true,
+    #                                    ['stream-1.web.my-awesome-site.net']) #=>
+    #    {:status=>"InProgress",
+    #     :caller_reference=>"201004191254412191173215",
+    #     :cnames=>["stream-1.web.my-awesome-site.net"],
+    #     :aws_id=>"E1M5LERJLU636F",
+    #     :e_tag=>"E2588L5QL4BLXH",
+    #     :enabled=>true,
+    #     :domain_name=>"s1di8imd85wgld.cloudfront.net",
+    #     :origin=>"bucket-for-konstantin-00.s3.amazonaws.com",
+    #     :last_modified_time=>Mon Apr 19 08:54:42 UTC 2010,
+    #     :location=>
+    #      "https://cloudfront.amazonaws.com/streaming-distribution/E1M5LERJLU636F",
+    #     :comment=>"Woo-Hoo!"}
+    #
+    def create_streaming_distribution(origin, comment='', enabled=true, cnames=[], caller_reference=nil)
+      config = { :origin  => origin,
+                 :comment => comment,
+                 :enabled => enabled,
+                 :cnames  => Array(cnames),
+                 :caller_reference => caller_reference }
+      create_streaming_distribution_by_config(config)
+    end
+
+    def create_streaming_distribution_by_config(config)
+      config[:caller_reference] ||= generate_call_reference
+      link = generate_request('POST', 'streaming-distribution', {}, streaming_distribution_config_to_xml(config))
+      merge_headers(request_info(link, AcfDistributionListParser.new(:logger => @logger))[:distributions].first)
+    end
+
+    # Get a streaming distribution's information.
+    # Returns a distribution's information or RightAws::AwsError exception.
+    #
+    #  acf.get_streaming_distribution('E3CWE2Z9USOS6B') #=>
+    #    {:status=>"Deployed",
+    #     :e_tag=>"EXTZ2SXAQT39K",
+    #     :cnames=>["stream.web.my-awesome-site.net"],
+    #     :aws_id=>"E3CWE2Z9USOS6B",
+    #     :enabled=>true,
+    #     :domain_name=>"s2jz1ourvss1fj.cloudfront.net",
+    #     :origin=>"bucket-for-konstantin-00.s3.amazonaws.com",
+    #     :last_modified_time=>"2010-04-19T08:53:32.574Z",
+    #     :comment=>"Woo-Hoo!",
+    #     :caller_reference=>"201004191253311625537161"}
+    #
+    #  acf.get_streaming_distribution('E1M5LERJLU636F') #=>
+    #    {:trusted_signers=>["self", "648772220000", "120288270000"],
+    #     :status=>"InProgress",
+    #     :e_tag=>"E2K6XD13RCJQ6E",
+    #     :cnames=>["stream-1.web.my-awesome-site.net"],
+    #     :active_trusted_signers=>
+    #      [{:key_pair_ids=>["APKAIK74BJWCLXZUMEJA"],
+    #        :aws_account_number=>"120288270000"},
+    #       {:aws_account_number=>"self"},
+    #       {:aws_account_number=>"648772220000"}],
+    #     :aws_id=>"E1M5LERJLU636F",
+    #     :enabled=>false,
+    #     :domain_name=>"s1di8imd85wgld.cloudfront.net",
+    #     :origin=>"bucket-for-konstantin-00.s3.amazonaws.com",
+    #     :last_modified_time=>"2010-04-19T09:14:07.160Z",
+    #     :comment=>"Olah-lah!",
+    #     :origin_access_identity=>"origin-access-identity/cloudfront/E3JPJZ80ZBX24G",
+    #     :caller_reference=>"201004191254412191173215"}
+    #
+    def get_streaming_distribution(aws_id)
+      link = generate_request('GET', "streaming-distribution/#{aws_id}")
+      merge_headers(request_info(link, AcfDistributionListParser.new(:logger => @logger))[:distributions].first)
+    end
+
+    # Get a streaming distribution's configuration.
+    # Returns a distribution's configuration or RightAws::AwsError exception.
+    #
+    #  acf.get_streaming_distribution_config('E1M5LERJLU636F') #=>
+    #    {:trusted_signers=>["self", "648772220000", "120288270000"],
+    #     :e_tag=>"E2K6XD13RCJQ6E",
+    #     :cnames=>["stream-1.web.my-awesome-site.net"],
+    #     :enabled=>false,
+    #     :origin=>"bucket-for-konstantin-00.s3.amazonaws.com",
+    #     :comment=>"Olah-lah!",
+    #     :origin_access_identity=>"origin-access-identity/cloudfront/E3JPJZ80ZBX24G",
+    #     :caller_reference=>"201004191254412191173215"}
+    #
+    def get_streaming_distribution_config(aws_id)
+      link = generate_request('GET', "streaming-distribution/#{aws_id}/config")
+      merge_headers(request_info(link, AcfDistributionListParser.new(:logger => @logger))[:distributions].first)
+    end
+
+    # Set a streaming distribution's configuration
+    # (the :origin and the :caller_reference cannot be changed).
+    # Returns +true+ on success or RightAws::AwsError exception.
+    #
+    #  acf.get_streaming_distribution_config('E1M5LERJLU636F') #=>
+    #    {:e_tag=>"E2588L5QL4BLXH",
+    #     :cnames=>["stream-1.web.my-awesome-site.net"],
+    #     :enabled=>true,
+    #     :origin=>"bucket-for-konstantin-00.s3.amazonaws.com",
+    #     :comment=>"Woo-Hoo!",
+    #     :caller_reference=>"201004191254412191173215"}
+    #
+    #  config[:comment]                = 'Olah-lah!'
+    #  config[:enabled]                = false
+    #  config[:origin_access_identity] = "origin-access-identity/cloudfront/E3JPJZ80ZBX24G"
+    #  config[:trusted_signers]        = ['self', '648772220000', '120288270000']
+    #
+    #  acf.set_distribution_config('E2REJM3VUN5RSI', config) #=> true
+    #
+    def set_streaming_distribution_config(aws_id, config)
+      link = generate_request('PUT', "streaming-distribution/#{aws_id}/config", {}, streaming_distribution_config_to_xml(config),
+                                     'If-Match' => config[:e_tag])
+      request_info(link, RightHttp2xxParser.new(:logger => @logger))
+    end
+
+    # Delete a streaming distribution. The enabled distribution cannot be deleted.
+    # Returns +true+ on success or RightAws::AwsError exception.
+    #
+    #  acf.delete_streaming_distribution('E1M5LERJLU636F', 'E2588L5QL4BLXH') #=> true
+    #
+    def delete_streaming_distribution(aws_id, e_tag)
+      link = generate_request('DELETE', "streaming-distribution/#{aws_id}", {}, nil,
+                                        'If-Match' => e_tag)
+      request_info(link, RightHttp2xxParser.new(:logger => @logger))
+    end
+
+  end
+end