cloudfront 0.0.1 → 1.0

data/lib/cloudfront/helpers/origin_access_identity.rb

@@ -0,0 +1,58 @@
+# encoding: UTF-8
+
+class Cloudfront
+  module Helpers
+    class OriginAccessIdentity
+      include Cloudfront::Utils::ConfigurationChecker
+      include Cloudfront::Utils::XmlSerializer
+
+      attr_accessor :caller_reference,
+                    :comment
+
+      def initialize(&block)
+        #setting default values
+        @caller_reference = Cloudfront::Utils::Util.generate_caller_reference
+        @comment = "Created with cloudfront Gem, visit https://github.com/Belkacem/cloudfront"
+
+        #set value from block
+        instance_eval &block if block_given?
+      end
+
+      def validate
+        this = self
+
+        # Error checking
+        error_messages.push "The caller_reference shouldn't be empty" if @caller_reference.empty?
+      end
+
+      #{
+      #    "CloudFrontOriginAccessIdentityConfig" => {
+      #        "CallerReference" => "ref",
+      #        "Comment" => "The comment."
+      #    }
+      #}
+      def self.from_hash(hash)
+        hash = hash["CloudFrontOriginAccessIdentityConfig"] || hash
+        self.new do
+          self.caller_reference = hash["CallerReference"]
+          self.comment = hash["Comment"]
+        end
+      end
+
+      #<?xml version="1.0" encoding="UTF-8"?>
+      #<CloudFrontOriginAccessIdentityConfig xmlns="http://cloudfront.amazonaws.com/doc/2012-07-01/">
+      #   <CallerReference>ref</CallerReference>
+      #   <Comment>The comment.</Comment>
+      #</CloudFrontOriginAccessIdentityConfig>
+
+      def build_xml(xml)
+        check_configuration
+        xml.CloudFrontOriginAccessIdentityConfig('xmlns' => "http://cloudfront.amazonaws.com/doc/#{Cloudfront::Utils::Api.version}/") {
+          xml.CallerReference @caller_reference
+          xml.Comment @comment
+        }
+      end
+
+    end
+  end
+end

data/lib/cloudfront/helpers/origins.rb

@@ -0,0 +1,94 @@
+# encoding: UTF-8
+
+require_relative 'origin'
+
+class Cloudfront
+  module Helpers
+    class Origins 
+      include Cloudfront::Utils::ConfigurationChecker
+      include Cloudfront::Utils::XmlSerializer
+
+      attr_accessor :origins
+
+      def initialize(&block)
+        #set default values
+        @origins = []
+
+        #set values from block
+        instance_eval &block if block_given?
+      end
+
+      def validate
+        # put origin in a list (this is done for single origin distributions)
+        @origins = [@origins] unless @origins.is_a? Array
+        
+        for origin in @origins
+          if origin.is_a?(Origin)
+            origin.check_configuration
+          end
+        end
+      end
+
+      # {
+      #     "Origins" => {
+      #         "Quantity" => "2",
+      #         "Items" => {
+      #             "Origin" => [
+      #                 {
+      #                     "Id" => "example-Amazon S3-origin",
+      #                     "DomainName" => "myawsbucket.s3.amazonaws.com",
+      #                     "S3OriginConfig" => {
+      #                         "OriginAccessIdentity" => "origin-access-identity/cloudfront/E74FTE3AEXAMPLE"
+      #                     }
+      #                 },
+      #                 {
+      #                     "Id" => "example-custom-origin",
+      #                     "DomainName" => "example.com",
+      #                     "CustomOriginConfig" => {
+      #                         "HTTPPort" => "80",
+      #                         "HTTPSPort" => "443",
+      #                         "OriginProtocolPolicy" => "match-viewer"
+      #                     }
+      #                 }
+      #             ]
+      #         }
+      #     }
+      # }
+      def self.from_hash(hash)
+        hash = hash["Origins"] || hash
+        self.new do
+          unless hash["Items"].nil?
+            origins_list = hash["Items"]["Origin"].is_a?(Hash) ? [hash["Items"]["Origin"]] : hash["Items"]["Origin"]
+            for origin_hash in origins_list
+              unless origin_hash.nil?
+                self.origins.push(Origin.from_hash(origin_hash))
+              end
+            end
+          end
+        end
+      end
+
+      # <Origins>
+      #  <Quantity>number of origins</Quantity>
+      #  <Items>
+      #     ... see Origin class
+      #   </Items>
+      # </Origins>
+      #
+      def build_xml(xml)
+        check_configuration
+        xml.Origins {
+          xml.Quantity @origins.size
+          if @origins.size > 0
+            xml.Items {
+              for origin in @origins
+                origin.build_xml(xml)
+              end
+            }
+          end
+        }
+      end
+
+    end
+  end
+end

data/lib/cloudfront/helpers/s3_origin.rb

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+
+class Cloudfront
+  module Helpers
+    class S3Origin
+      include Cloudfront::Utils::ConfigurationChecker
+      include Cloudfront::Utils::XmlSerializer
+      
+      attr_accessor :domain_name,
+                    :origin_access_identity
+
+      def initialize(&block)
+        #set value from block
+        instance_eval &block if block_given?
+      end
+
+      def validate
+        error_messages.push "domain_name can't be null" if @domain_name.nil?
+        error_messages.push "origin_access_identity can't be null" if @origin_access_identity.nil?
+      end
+      
+      # {
+      #   "S3Origin" => {
+      #     "DomainName" => "CloudFront domain name assigned to the distribution",
+      #     "OriginAccessIdentity" => "origin-access-identity/cloudfront/ID"
+      #   }
+      # }
+      def self.from_hash(hash)
+        hash = hash["S3Origin"] || hash
+        self.new do
+          self.domain_name = hash["DomainName"]
+          self.origin_access_identity = hash["OriginAccessIdentity"]
+        end
+      end
+
+      # The origin class container
+      #   <S3Origin>
+      #      <DomainName>CloudFront domain name assigned to the distribution</DNSName>
+      #      <OriginAccessIdentity>origin-access-identity/cloudfront/ID</OriginAccessIdentity>
+      #   </S3Origin>
+      def build_xml(xml)
+        check_configuration
+        xml.S3Origin {
+          xml.DomainName @domain_name unless @domain_name.nil?
+          xml.OriginAccessIdentity @origin_access_identity
+        }
+      end
+
+    end
+  end
+end

data/lib/cloudfront/helpers/streaming_distribution.rb

@@ -0,0 +1,150 @@
+# encoding: UTF-8
+
+require_relative 's3_origin'
+require_relative 'aliases'
+require_relative 'logging'
+require_relative 'trusted_signers'
+
+class Cloudfront
+  module Helpers
+    class StreamingDistribution
+      include Cloudfront::Utils::ConfigurationChecker
+      include Cloudfront::Utils::XmlSerializer
+
+      attr_accessor :caller_reference,
+                    :domain_name,
+                    :origin_access_identity,
+                    :cnames,
+                    :comment,
+                    :logging,
+                    :trusted_signers,
+                    :price_class,
+                    :enabled
+
+      def initialize(&block)
+        #setting default values
+        @caller_reference = Cloudfront::Utils::Util.generate_caller_reference
+        @s3_origin = S3Origin.new
+        @cnames = []
+        @comment = "Created with cloudfront Gem, visit https://github.com/Belkacem/cloudfront"
+        @logging = Logging.new
+        @trusted_signers = []
+        @price_class = "PriceClass_All"
+        @enabled = false
+
+        #set value from block
+        instance_eval &block if block_given?
+      end
+
+      def validate
+        this = self
+
+        # s3_origin, aliases and trusted_signers_container are internal structures.
+        @s3_origin = S3Origin.new do
+          self.domain_name = this.domain_name
+          self.origin_access_identity = this.origin_access_identity
+        end
+
+        @aliases = Aliases.new do
+          self.cnames = this.cnames
+        end
+
+        @trusted_signers_container = TrustedSigners.new do
+          #self.enabled = true
+          self.trusted_signers = this.trusted_signers
+        end
+
+        @logging.include_cookies = "undefined"
+        
+        # Error checking
+        error_messages.push "The caller_reference shouldn't be empty" if @caller_reference.empty?
+        @s3_origin.check_configuration
+        @aliases.check_configuration
+        @logging.check_configuration
+        @trusted_signers_container.check_configuration
+
+        error_messages.push "price_class is invalid should be in #{Cloudfront::Utils::Util::PRICE_CLASS.join(', ')}" unless Cloudfront::Utils::Util::PRICE_CLASS.include?(@price_class)
+        error_messages.push "enabled should be a boolean" unless !!@enabled == @enabled
+      end
+      
+      # Creates a distribution configuration wrapper from a hash
+      # {
+      #     "StreamingDistributionConfig" => {
+      #         "CallerReference" => "unique description for this distribution",
+      #         "S3Origin" => {
+      #           ... see s3Origin
+      #         },
+      #         "Aliases" => {
+      #             "Quantity" => "number of CNAME aliases",
+      #             "Items" => {
+      #                 "CNAME" => "CNAME alias"
+      #             }
+      #         },
+      #         "Comment" => "comment about the distribution",
+      #         "Logging" => {
+      #             "Enabled" => "true | false",
+      #             "Bucket" => "Amazon S3 bucket for logs",
+      #             "Prefix" => "prefix for log file names"
+      #         },
+      #         "TrustedSigners" => {
+      #             "Quantity" => "number of trusted signers",
+      #             "Items" => {
+      #                 "AwsAccountNumber" => "self | AWS account that can create \n            signed URLs"
+      #             }
+      #         },
+      #         "PriceClass" => "maximum price class for the distribution",
+      #         "Enabled" => "true | false"
+      #     }
+      # }
+      def self.from_hash(hash)
+        hash = hash["StreamingDistributionConfig"] || hash
+        self.new do
+          self.caller_reference = hash["CallerReference"]
+          origin = S3Origin.from_hash(hash)
+          self.domain_name = origin.domain_name
+          self.origin_access_identity = origin.origin_access_identity
+          self.cnames = Aliases.from_hash(hash).cnames # Aliases class contains the code that extract cnames
+          self.comment = hash["Comment"]
+          self.logging = Logging.from_hash(hash)
+          self.trusted_signers = TrustedSigners.from_hash(hash).trusted_signers
+          self.price_class = hash["PriceClass"] || "PriceClass_All"
+          self.enabled = (hash["Enabled"] || "false").to_bool
+        end
+      end
+
+      #<StreamingDistributionConfig xmlns="http://cloudfront.amazonaws.com/doc/2012-07-01/">
+      #   <CallerReference>unique description for this distribution</CallerReference>
+      #   <S3Origin>
+      #      <DNSName>CloudFront domain name assigned to the distribution</DNSName>
+      #      <OriginAccessIdentity>origin-access-identity/cloudfront/ID</OriginAccessIdentity>
+      #   </S3Origin>
+      #   <Aliases>
+      #      ... see Aliases class
+      #   </Aliases>
+      #   <Comment>comment about the distribution</Comment>
+      #   <Logging>
+      #      ... see Logging class.
+      #   </Logging>
+      #   <TrustedSigners>
+      #      ... see TrustedSigners.
+      #   </TrustedSigners>
+      #   <PriceClass>maximum price class for the distribution</PriceClass>
+      #   <Enabled>true | false</Enabled>
+      #</StreamingDistributionConfig>
+      def build_xml(xml)
+        check_configuration
+        xml.StreamingDistributionConfig('xmlns' => "http://cloudfront.amazonaws.com/doc/#{Cloudfront::Utils::Api.version}/") {
+          xml.CallerReference @caller_reference
+          @s3_origin.build_xml(xml)
+          @aliases.build_xml(xml)
+          xml.Comment @comment
+          @logging.build_xml(xml)
+          @trusted_signers_container.build_xml(xml)
+          xml.PriceClass @price_class
+          xml.Enabled @enabled
+        }
+      end
+
+    end
+  end
+end

data/lib/cloudfront/helpers/trusted_signers.rb

@@ -0,0 +1,73 @@
+# encoding: UTF-8
+
+class Cloudfront
+  module Helpers
+    class TrustedSigners
+      include Cloudfront::Utils::ConfigurationChecker
+      include Cloudfront::Utils::XmlSerializer
+
+      attr_accessor :enabled,
+                    :trusted_signers
+
+      def initialize(&block)
+        #set default values
+        @enabled = false
+        @trusted_signers = []
+
+        #set values from block
+        instance_eval &block if block_given?
+      end
+
+      def validate
+        @trusted_signers = Array.wrap @trusted_signers
+        @trusted_signers.push "self" unless @trusted_signers.include? "self"
+      end
+
+      # A factory method that creates a TrustedSigners instance from a hash
+      # Input example
+      # hash = {
+      #     "TrustedSigners" => {
+      #         "Enabled" => "true | false",
+      #         "Quantity" => "number of trusted signers",
+      #         "Items" => {
+      #             "AwsAccountNumber" => "self | AWS account that can create signed URLs"
+      #         }
+      #     }
+      # }
+      #
+      def self.from_hash(hash)
+        hash = hash["TrustedSigners"] || hash
+        self.new do
+          self.enabled = hash["Enabled"].nil? ? nil : hash["Enabled"].to_bool
+          if (hash["Quantity"]|| "0").to_i > 0
+            self.trusted_signers = Array.wrap((hash["Items"]|| {})["AwsAccountNumber"])
+          end
+        end
+      end
+
+      # Output example
+      #  <TrustedSigners>
+      #    <Enabled>true</Enabled>
+      #    <Quantity>number of trusted signers</Quantity>
+      #    <Items>
+      #      <AwsAccountNumber>self</AwsAccountNumber>
+      #    </Items>
+      #  </TrustedSigners>
+      def build_xml(xml)
+        check_configuration
+        xml.TrustedSigners {
+          xml.Enabled (@enabled || @trusted_signers.any?)
+          xml.Quantity @trusted_signers.size
+          if @trusted_signers.any?
+            xml.Items {
+              for signer in @trusted_signers
+                xml.AwsAccountNumber signer
+              end
+            }
+          end
+        }
+      end
+
+    end
+  end
+end

data/lib/cloudfront/invalidation/invalidations.rb

@@ -0,0 +1,57 @@
+# encoding: UTF-8
+
+require 'cloudfront/helpers/invalidation'
+
+class Cloudfront
+  module Invalidation
+    module Invalidations
+      INVALIDATION_URL = "/#{Cloudfront::Utils::Api.version}/distribution/%s/invalidation"
+
+      # Invalidates files
+      # @param distribution_id [String] The id of the distribution.
+      # @param files [Array] an array of files to be invalidated.
+      # @param caller_reference [String] The custom caller reference to be added to the request.
+      # @return [Faraday::Response] the response from cloudfront
+      def invalidation_send(distribution_id, files, caller_reference = nil)
+        connection.post do |request|
+          request.url INVALIDATION_URL % distribution_id
+          request.body = invalidation_body(files, caller_reference)
+        end
+      end
+
+      # Lists all the invalidations.
+      # @param distribution_id [String] The id of the distribution.
+      # @param max_items [int] the max items to be retrieved
+      # @param marker [String] The invalidation from which begins the list.
+      # @return [Faraday::Response] the response from cloudfront
+      def invalidation_list(distribution_id, max_items = 0, marker = "")
+        connection.get do |request|
+          request.url INVALIDATION_URL % distribution_id
+          request.params['Marker'] = marker unless marker.nil? || marker.strip.empty?
+          request.params['MaxItems'] = max_items if max_items > 0
+        end
+      end
+
+      # gets the invalidation information.
+      # @param distribution_id [String] The id of the distribution.
+      # @param invalidation_id [String] The id of the invalidation.
+      # @return [Faraday::Response] the response from cloudfront
+      def invalidation_get(distribution_id, invalidation_id)
+        connection.get INVALIDATION_URL % distribution_id + '/' + invalidation_id
+      end
+
+private
+      # Method that builds the invalidation body.
+      # @param files [Array] an array containing the list of files to be invalidated.
+      # @return [String] the xml to be sent to cloudfront.
+      def invalidation_body(files, caller_reference)
+        invalidation = Helpers::Invalidation.new do
+          self.files = files
+          self.caller_reference = caller_reference unless caller_reference.nil?
+        end
+        invalidation.to_xml
+      end
+
+    end
+  end
+end