cloudfront 0.0.1 → 1.0

data/lib/cloudfront/helpers/cache_behaviors.rb

@@ -0,0 +1,108 @@
+# encoding: UTF-8
+
+require_relative 'trusted_signers'
+require_relative 'cache_behavior'
+
+class Cloudfront
+  module Helpers
+    class CacheBehaviors
+      include Cloudfront::Utils::ConfigurationChecker
+      include Cloudfront::Utils::XmlSerializer
+
+      attr_accessor :cache_behaviors
+
+      def initialize(&block)
+        #set default values
+        @cache_behaviors = []
+
+        #set values from block
+        instance_eval &block if block_given?
+      end
+
+      def validate
+        # some wrapping
+        @cache_behaviors = Array.wrap @cache_behaviors
+
+        # Error checking
+        for cache_behavior in @cache_behaviors
+          if cache_behavior.is_a?(CacheBehavior)
+            cache_behavior.check_configuration
+          else
+            error_messages.push "cache_behaviors list contains a non CacheBehavior element #{cache_behavior}"
+          end
+        end
+      end
+
+      # hash = {
+      #     "CacheBehaviors" => {
+      #         "Quantity" => "2",
+      #         "Items" => {
+      #             "CacheBehavior" => [
+      #                 {
+      #                     #see CacheBehavior
+      #                 }, {
+      #                     #...
+      #                 }
+      #             ]
+      #         }
+      #     }
+      # }
+      def self.from_hash(hash)
+        hash = hash["CacheBehaviors"] || hash
+        self.new do
+          for cache_behavior in [(hash["Items"]|| {})["CacheBehavior"]]
+            unless cache_behavior.nil?
+              self.cache_behaviors.push(CacheBehavior.from_hash(cache_behavior))
+            end
+          end
+        end
+      end
+
+      # The cache behavior class container
+      # <CacheBehaviors>
+      #    <Quantity>1</Quantity>
+      #    <Items>
+      #      <CacheBehavior>
+      #        <PathPattern>pattern that specifies files that this cache behavior applies to</PathPattern>
+      #        <TargetOriginId>ID of the origin that this cache behavior applies to</TargetOriginId>
+      #        <ForwardedValues>
+      #          <QueryString>true | false</QueryString>
+      #          <Cookies>
+      #            <Forward>all | whitelist | none</Forward>
+      #            <!-- Required when Forward = whitelist, omitted otherwise. -->
+      #            <WhitelistedNames>
+      #              <Quantity>number of cookie names to forward to origin</Quantity>
+      #              <Items>
+      #                <Name>name of a cookie to forward to the origin</Name>
+      #              </Items>
+      #            </WhitelistedNames>
+      #          </Cookies>
+      #        </ForwardedValues>
+      #        <TrustedSigners>
+      #          ... see TrustedSigners class
+      #        </TrustedSigners>
+      #        <ViewerProtocolPolicy>allow-all | https-only</ViewerProtocolPolicy>
+      #        <MinTTL>minimum TTL in seconds for files specified by PathPattern</MinTTL>
+      #      </CacheBehavior>
+      def build_xml(xml)
+      check_configuration
+        xml.CacheBehaviors {
+          xml.Quantity @cache_behaviors.size
+          if @cache_behaviors.size > 0
+            xml.Items {
+              for cache_behavior in @cache_behaviors
+                cache_behavior.build_xml(xml)
+              end
+            }
+          end
+        }
+      end
+
+    end
+  end
+end
+
+
+
+
+

data/lib/cloudfront/helpers/download_distribution.rb

@@ -0,0 +1,157 @@
+# encoding: UTF-8
+
+require_relative 'logging'
+require_relative 'origins'
+require_relative 'aliases'
+require_relative 'cache_behavior'
+require_relative 'cache_behaviors'
+
+class Cloudfront
+  module Helpers
+    class DownloadDistribution
+      include Cloudfront::Utils::ConfigurationChecker
+      include Cloudfront::Utils::XmlSerializer
+
+      attr_accessor :caller_reference,
+                    :cnames,
+                    :default_root_object,
+                    :origins,
+                    :default_cache_behavior,
+                    :cache_behaviors,
+                    :comment,
+                    :logging,
+                    :price_class,
+                    :enabled
+
+      def initialize(&block)
+        #setting default values
+        @caller_reference = Cloudfront::Utils::Util.generate_caller_reference
+        @cnames = []
+        @default_root_object = "/index.html"
+        @origins = []
+        @default_cache_behavior = CacheBehavior.new do
+          self.is_default = true
+        end
+        @cache_behaviors = []
+        @comment = "Created with cloudfront Gem, visit https://github.com/Belkacem/cloudfront"
+        @logging = Logging.new
+        @price_class = "PriceClass_All"
+        @enabled = false
+
+        #set value from block
+        instance_eval &block if block_given?
+      end
+
+      def validate
+        this = self
+
+        # aliases and behaviors are internal structures.
+        @aliases = Aliases.new do
+          self.cnames = this.cnames
+        end
+
+        @behaviors = CacheBehaviors.new do
+          self.cache_behaviors = this.cache_behaviors
+        end
+
+        @origins_container = Origins.new do
+          self.origins = this.origins
+        end
+        
+        # Error checking
+        error_messages.push "The caller_reference shouldn't be empty" if @caller_reference.empty?
+        @aliases.check_configuration
+        @origins_container.check_configuration
+        @default_cache_behavior.check_configuration
+        # Making the default cache behavior to true
+        @default_cache_behavior.is_default = true
+        @behaviors.check_configuration
+        @logging.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
+      # {
+      #   "DistributionConfig" => {
+      #       "CallerReference" => "unique description for this distribution config",
+      #       "Aliases" => "Aliases class",
+      #       "DefaultRootObject" => "URL for default root object",
+      #       "Origins" => ... see Origins class",
+      #       "DefaultCacheBehavior" =>
+      #           "\n... see CacheBehaviour class\n                       ",
+      #       "CacheBehaviors" => {
+      #          ... see CacheBehaviors
+      #        },
+      #       "Comment" => "comment about the distribution",
+      #       "Logging" =>
+      #             "... see Logging class",
+      #       "PriceClass" => "maximum price class for the distribution",
+      #       "Enabled" => "true | false"
+      #   }
+      # }
+      def self.from_hash(hash)
+        hash = hash["DistributionConfig"] || hash
+        self.new do
+          self.caller_reference = hash["CallerReference"]
+          self.cnames = Aliases.from_hash(hash["Aliases"]).cnames # Aliases class contains the code that extract cnames
+          self.default_root_object = hash["DefaultRootObject"]
+          self.origins = Origins.from_hash(hash["Origins"]).origins
+          self.default_cache_behavior = CacheBehavior.from_hash(hash["DefaultCacheBehavior"])
+          self.cache_behaviors = CacheBehaviors.from_hash(hash["CacheBehaviors"]).cache_behaviors
+          self.comment = hash["Comment"]
+          self.logging = Logging.from_hash(hash["Logging"])
+          self.price_class = hash["PriceClass"] || "PriceClass_All"
+          self.enabled = (hash["Enabled"] || "false").to_bool
+        end
+      end
+
+      #<?xml version="1.0" encoding="UTF-8"?>
+      #<DistributionConfig xmlns="http://cloudfront.amazonaws.com/doc/2012-07-01/">
+      #  <CallerReference>unique description for this distribution config</CallerReference>
+      #  <Aliases>
+      #    ... see Alias class
+      #  </Aliases>
+      #  <DefaultRootObject>URL for default root object</DefaultRootObject>
+      #  <Origins>
+      #    <Quantity>number of origins</Quantity>
+      #    <Items>
+      #       ... see Origin class
+      #    </Items>
+      #  </Origins>
+      #  <DefaultCacheBehavior>
+      #      ... see CacheBehaviour class
+      #  </DefaultCacheBehavior>
+      #  <CacheBehaviors>
+      #    <Quantity>number of cache behaviors</Quantity>
+      #    <!-- Optional. Omit when Quantity = 0. -->
+      #    <Items>
+      #      ... see CacheBehaviour class
+      #    </Items>
+      #  </CacheBehaviors>
+      #  <Comment>comment about the distribution</Comment>
+      #  <Logging>
+      #    ... see Logging class
+      #  </Logging>
+      #  <PriceClass>maximum price class for the distribution</PriceClass>
+      #  <Enabled>true | false</Enabled>
+      #</DistributionConfig>
+      def build_xml(xml)
+        check_configuration
+        xml.DistributionConfig('xmlns' => "http://cloudfront.amazonaws.com/doc/#{Cloudfront::Utils::Api.version}/") {
+          xml.CallerReference @caller_reference
+          @aliases.build_xml(xml)
+          xml.DefaultRootObject @default_root_object
+          @origins_container.build_xml(xml)
+          @default_cache_behavior.build_xml(xml)
+          @behaviors.build_xml(xml)
+          xml.Comment @comment
+          @logging.build_xml(xml)
+          xml.PriceClass @price_class
+          xml.Enabled @enabled
+        }
+      end
+
+    end
+  end
+end

data/lib/cloudfront/helpers/invalidation.rb

@@ -0,0 +1,83 @@
+# encoding: UTF-8
+
+require 'cloudfront/helpers/invalidation'
+
+class Cloudfront
+  module Helpers
+    class Invalidation
+      include Cloudfront::Utils::ConfigurationChecker
+      include Cloudfront::Utils::XmlSerializer
+
+      attr_accessor :caller_reference,
+                    :files
+
+      def initialize(&block)
+        #setting default values
+        @caller_reference = Cloudfront::Utils::Util.generate_caller_reference
+        @files = []
+
+        #set value from block
+        instance_eval &block if block_given?
+      end
+
+      def validate
+        @files = Array.wrap @files
+
+        # Error checking
+        error_messages.push "files shouldn't be empty" unless @files.any?
+        for file in @files
+          error_messages.push "the file '#{file}' isn't valid, it should start with '/'" unless file.start_with? '/'
+        end
+      end
+      
+      # Creates a Invalidation from a hash
+      # {
+      #     "InvalidationBatch" => {
+      #                   "Paths" => {
+      #             "Quantity" => "number of objects to invalidate",
+      #                "Items" => {
+      #                 "Path" => "/path to object to invalidate"
+      #             }
+      #         },
+      #         "CallerReference" => "unique identifier for this invalidation batch"
+      #     }
+      # }
+      def self.from_hash(hash)
+        hash = hash["InvalidationBatch"] || hash
+        self.new do
+          self.caller_reference = hash["CallerReference"]
+          items = (hash["Paths"] || {})["Items"]
+          self.files = Array.wrap (items["Path"])
+        end
+      end
+
+      # <?xml version="1.0" encoding="UTF-8"?>
+      # <InvalidationBatch xmlns="http://cloudfront.amazonaws.com/doc/2012-07-01/">
+      #    <Paths>
+      #       <Quantity>number of objects to invalidate</Quantity>
+      #       <Items>
+      #          <Path>/path to object to invalidate</Path>
+      #       </Items>
+      #    </Paths>
+      #    <CallerReference>unique identifier for this invalidation batch</CallerReference>
+      # </InvalidationBatch>
+      def build_xml(xml)
+        check_configuration
+        xml.InvalidationBatch('xmlns' => "http://cloudfront.amazonaws.com/doc/#{Cloudfront::Utils::Api.version}/") {
+          xml.Paths {
+            xml.Quantity @files.size
+            if @files.size > 0
+              xml.Items {
+                for file in Array.wrap @files
+                  xml.Path file
+                end
+              }
+            end
+          }
+          xml.CallerReference @caller_reference
+        }
+      end
+
+    end
+  end
+end

data/lib/cloudfront/helpers/logging.rb

@@ -0,0 +1,71 @@
+# encoding: UTF-8
+
+class Cloudfront
+  module Helpers
+    class Logging 
+      include Cloudfront::Utils::ConfigurationChecker
+      include Cloudfront::Utils::XmlSerializer
+
+      attr_accessor :enabled,
+                    :include_cookies,
+                    :bucket,
+                    :prefix
+
+      def initialize(&block)
+        #set default values
+        @enabled = false
+        @include_cookies = false
+        #set values from block
+        instance_eval &block if block_given?
+      end
+
+      def validate
+        error_messages.push "enabled should be a boolean" unless !!@enabled == @enabled
+        error_messages.push "include_cookies should be a boolean or 'undefined'" unless !!@include_cookies == @include_cookies || @include_cookies == "undefined"
+        error_messages.push "You must specify a bucket" if @enabled && @bucket.nil?
+      end
+
+      # A factory method that creates a Logging instance from a hash
+      # Input example
+      # hash = {
+      #     "Logging" => {
+      #         "Enabled" => "true | false",
+      #         "IncludeCookies" => "true | false",
+      #         "Bucket" => "Amazon S3 bucket to save logs in",
+      #         "Prefix" => "prefix for log filenames"
+      #     }
+      # }
+      def self.from_hash(hash)
+        hash = hash["Logging"] || hash
+        self.new do
+          self.enabled = (hash["Enabled"] || "false").to_bool
+          self.include_cookies = hash["IncludeCookies"].nil? ? "undefined" : hash["IncludeCookies"].to_bool
+          if self.enabled
+            self.bucket = hash["Bucket"]
+            self.prefix = hash["Prefix"]
+          end
+        end
+      end
+
+      # build the xml
+      #  <Logging>
+      #    <Enabled>true | false</Enabled>
+      #    <IncludeCookies>true | false</IncludeCookies>
+      #    <Bucket>Amazon S3 bucket to save logs in</Bucket>
+      #    <Prefix>prefix for log filenames</Prefix>
+      #  </Logging>
+      def build_xml(xml)
+        check_configuration
+        xml.Logging {
+          xml.Enabled @enabled
+          xml.IncludeCookies @include_cookies unless @include_cookies == "undefined"
+          if @enabled
+            xml.Bucket @bucket
+            xml.Prefix @prefix
+          end
+        }
+      end
+      
+    end
+  end
+end

data/lib/cloudfront/helpers/origin.rb

@@ -0,0 +1,101 @@
+# encoding: UTF-8
+
+class Cloudfront
+  module Helpers
+    class Origin 
+      include Cloudfront::Utils::ConfigurationChecker
+      include Cloudfront::Utils::XmlSerializer
+      
+      attr_accessor :id,
+                    :domain_name,
+                    :origin_access_identity,
+                    :http_port,
+                    :https_port,
+                    :origin_protocol_policy
+
+      def initialize(&block)
+        #set default values
+        @http_port = 80
+        @https_port = 443
+        @origin_protocol_policy = "match-viewer"
+        #set value from block
+        instance_eval &block if block_given?
+      end
+
+      def validate
+        error_messages.push "http_port is invalid" unless @http_port.between?(0, 65535)
+        error_messages.push "https_port is invalid" unless @https_port.between?(0, 65535)
+        error_messages.push "id can't be null" if @id.nil?
+        error_messages.push "origin_protocol_policy is invalid should be in #{Cloudfront::Utils::Util::MATCH_VIEWER_VALUES.join(', ')}" unless Cloudfront::Utils::Util::MATCH_VIEWER_VALUES.include?(@origin_protocol_policy)
+      end
+      
+      # {
+      #     "Origin"=> {
+      #         "Id"=>"unique identifier for this origin",
+      #         "DomainName"=>"domain name of origin",
+      #         "S3OriginConfig"=> {
+      #             "OriginAccessIdentity"=> "origin-access-identity/cloudfront/ID"
+      #         },
+      #         "CustomOriginConfig"=> {
+      #             "HTTPPort"=> 80,
+      #             "HTTPSPort"=> 443,
+      #            "OriginProtocolPolicy"=>"match-viewer"
+      #         }
+      #     }
+      # }
+      def self.from_hash(hash)
+        hash = hash["Origin"] || hash
+        self.new do
+          self.id = hash["Id"]
+          self.domain_name = hash["DomainName"]
+          if hash.has_key? "S3OriginConfig"
+            self.origin_access_identity = hash["S3OriginConfig"]["OriginAccessIdentity"]
+          else
+            custom_origin_config = hash["CustomOriginConfig"]
+            if custom_origin_config
+              self.http_port = (custom_origin_config["HTTPPort"] || "80").to_i
+              self.https_port = (custom_origin_config["HTTPSPort"] || "443").to_i
+              self.origin_protocol_policy = custom_origin_config["OriginProtocolPolicy"] || "match-viewer"
+            end
+          end
+        end
+      end
+
+      # The origin class container
+      #      <Origin>
+      #        <Id>unique identifier for this origin</Id>
+      #        <DomainName>domain name of origin</DomainName>
+      #        <!-- Include the S3OriginConfig element only if you use an Amazon S3 origin for your distribution. -->
+      #        <S3OriginConfig>
+      #          <OriginAccessIdentity>origin-access-identity/cloudfront/ID</OriginAccessIdentity>
+      #        </S3OriginConfig>
+      #        <!-- Include the CustomOriginConfig element only if you use a custom origin for your distribution. -->
+      #        <CustomOriginConfig>
+      #          <HTTPPort>80</HTTPPort>
+      #          <HTTPSPort>443</HTTPSPort>
+      #          <OriginProtocolPolicy>http-only |
+      #            match-viewer</OriginProtocolPolicy>
+      #        </CustomOriginConfig>
+      #      </Origin>
+      def build_xml(xml)
+        check_configuration
+        xml.Origin {
+          xml.Id @id
+          xml.DomainName @domain_name
+          if (!@origin_access_identity.nil?)
+            xml.S3OriginConfig {
+              xml.OriginAccessIdentity @origin_access_identity
+            }
+          else
+            xml.CustomOriginConfig {
+              xml.HTTPPort @http_port
+              xml.HTTPSPort @https_port
+              xml.OriginProtocolPolicy @origin_protocol_policy
+            }
+          end
+        }
+      end
+
+    end
+  end
+end