cloudfront 0.0.1 → 1.0

data/Gemfile

@@ -1,15 +1,18 @@
 source "http://rubygems.org"
-# Add dependencies required to use your gem here.
-# Example:
-#   gem "activesupport", ">= 2.3.5"
+
+gem "faraday"
+gem "faraday_middleware"
+gem "multi_xml"
+gem "nokogiri"
 
 # Add dependencies to develop your gem here.
-# Include everything needed to run rake, tests, features, etc.
 group :development do
   gem "minitest", ">= 0"
-  gem "yard", "~> 0.7"
-  gem "rdoc", "~> 3.12"
+  gem "yard", "~> 0.6.0"
   gem "bundler", "~> 1.0.0"
-  gem "jeweler", "~> 1.8.3"
-  gem "rcov", ">= 0"
+  gem "jeweler", "~> 1.6.4"
+  gem 'simplecov', :require => false
+  gem "vcr", ">= 0"
+  gem "webmock", ">= 0"
+  gem "timecop", ">= 0"
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Belkacem REBBOUH
+Copyright (c) 2011 Belkacem REBBOUH
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,19 +1,76 @@
 = cloudfront
 
-Description goes here.
+A simple wrapper to cloudfront API.
+
+== Usage
+
+    cloudfront = Cloudfront.new('aws_access_key_id', 'aws_secret_access_key')
+
+Create a distribution
+    download_distribution = DownloadDistribution.new do
+      self.cnames.concat ["test.com", "test2.com"]
+      self.default_root_object = "/index.php"
+      self.origins.push Origin.new {
+        self.id = "test origin"
+        self.domain_name = "example.com"
+        self.http_port = 90
+        self.https_port = 90
+      }
+      self.origins.push Origin.new {
+        self.id = "test origin 2"
+        self.domain_name = "example2.com"
+        self.origin_access_identity = "origin-access-identity/cloudfront/ID"
+      }
+      self.default_cache_behavior = CacheBehavior.new {
+        self.is_default = true
+        self.target_origin_id = "test origin"
+        self.query_string_forward = true
+      }
+      self.cache_behaviors.push CacheBehavior.new {
+        self.path_pattern = "*.jpg"
+        self.target_origin_id = "test origin"
+        self.query_string_forward = true
+        self.cookies_forward_policy = "whitelist"
+        self.cookies_to_forward = "cookies"
+        self.trusted_signers = TrustedSigners.new {
+          self.enabled = true
+          self.trusted_signers.push "signer"
+        }
+      }
+
+      self.logging = Logging.new {
+        self.enabled = true
+        self.bucket = "belkacem.rebbouh.com.s3.amazonaws.com"
+        self.prefix = "distribution_test"
+      }
+      self.price_class = "PriceClass_All"
+    end
+
+Then call
+    cloudfront.download_distribution_create(download_distribution)
+
+See tests and documentation for more actions.
+
+== Installation
+
+    gem install cloudfront
+
+Then run the following command in the gem folder:
+
+    rake install
 
 == Contributing to cloudfront
  
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
 == Copyright
 
-Copyright (c) 2012 Belkacem REBBOUH. See LICENSE.txt for
+Copyright (c) 2011 Belkacem REBBOUH. See LICENSE.txt for
 further details.
 

data/Rakefile

@@ -15,13 +15,18 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "cloudfront"
-  gem.version = "0.0.1"
-  gem.homepage = "http://github.com/Belkacem/cloudfront"
+  gem.version = '1.0'
+  gem.homepage = "https://github.com/Belkacem/cloudfront"
   gem.license = "MIT"
-  gem.summary = %Q{one-line summary of your gem}
-  gem.description = %Q{longer description of your gem}
+  gem.summary = %Q{A tested Cloudfront™ gem}
+  gem.description = %Q{A tested Cloudfront™ client, that handles all api actions on distributions and invalidations}
   gem.email = "belkacem@rebbouh.com"
   gem.authors = ["Belkacem REBBOUH"]
+  gem.files = Dir['lib/**/*.rb'] + %w(Gemfile
+    LICENSE.txt
+    README.rdoc
+    Rakefile
+    cloudfront.gemspec)
   # dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new
@@ -29,16 +34,8 @@ Jeweler::RubygemsDotOrgTasks.new
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
-require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
 end
 
 task :default => :test

data/cloudfront.gemspec

@@ -4,61 +4,119 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = %q{cloudfront}
-  s.version = "0.0.1"
+  s.name = "cloudfront"
+  s.version = "1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = [%q{Belkacem REBBOUH}]
-  s.date = %q{2012-05-27}
-  s.description = %q{longer description of your gem}
-  s.email = %q{belkacem@rebbouh.com}
+  s.authors = ["Belkacem REBBOUH"]
+  s.date = "2013-05-09"
+  s.description = "A tested Cloudfront\u{2122} client, that handles all api actions on distributions and invalidations"
+  s.email = "belkacem@rebbouh.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.rdoc"
   ]
   s.files = [
-    ".document",
     "Gemfile",
-    "Gemfile.lock",
     "LICENSE.txt",
     "README.rdoc",
     "Rakefile",
     "cloudfront.gemspec",
     "lib/cloudfront.rb",
-    "test/helper.rb",
-    "test/test_cloudfront.rb"
+    "lib/cloudfront/connection.rb",
+    "lib/cloudfront/distribution/distribution.rb",
+    "lib/cloudfront/distribution/download_distribution.rb",
+    "lib/cloudfront/distribution/streaming_distribution.rb",
+    "lib/cloudfront/errors/cloudfront_error.rb",
+    "lib/cloudfront/errors/cname_already_exists_error.rb",
+    "lib/cloudfront/errors/distribution_already_exists_error.rb",
+    "lib/cloudfront/errors/illegal_update_error.rb",
+    "lib/cloudfront/errors/invalid_origin_access_identity_error.rb",
+    "lib/cloudfront/errors/invalid_origin_error.rb",
+    "lib/cloudfront/errors/invalid_required_protocol_error.rb",
+    "lib/cloudfront/errors/missing_body_error.rb",
+    "lib/cloudfront/errors/precondition_failed_error.rb",
+    "lib/cloudfront/errors/too_many_distribution_cnames_error.rb",
+    "lib/cloudfront/errors/too_many_distributions_error.rb",
+    "lib/cloudfront/errors/too_many_trusted_signers_error.rb",
+    "lib/cloudfront/errors/trusted_signer_does_not_exist_error.rb",
+    "lib/cloudfront/exceptions/delete_enabled_distribution_exception.rb",
+    "lib/cloudfront/exceptions/distribution_already_disabled_exception.rb",
+    "lib/cloudfront/exceptions/distribution_already_enabled_exception.rb",
+    "lib/cloudfront/exceptions/distribution_configuration_exception.rb",
+    "lib/cloudfront/exceptions/missing_etag_exception.rb",
+    "lib/cloudfront/helpers/aliases.rb",
+    "lib/cloudfront/helpers/cache_behavior.rb",
+    "lib/cloudfront/helpers/cache_behaviors.rb",
+    "lib/cloudfront/helpers/download_distribution.rb",
+    "lib/cloudfront/helpers/invalidation.rb",
+    "lib/cloudfront/helpers/logging.rb",
+    "lib/cloudfront/helpers/origin.rb",
+    "lib/cloudfront/helpers/origin_access_identity.rb",
+    "lib/cloudfront/helpers/origins.rb",
+    "lib/cloudfront/helpers/s3_origin.rb",
+    "lib/cloudfront/helpers/streaming_distribution.rb",
+    "lib/cloudfront/helpers/trusted_signers.rb",
+    "lib/cloudfront/invalidation/invalidations.rb",
+    "lib/cloudfront/origin_access_identity/origin_access_identity.rb",
+    "lib/cloudfront/utils/api.rb",
+    "lib/cloudfront/utils/array.rb",
+    "lib/cloudfront/utils/configuration_checker.rb",
+    "lib/cloudfront/utils/string.rb",
+    "lib/cloudfront/utils/util.rb",
+    "lib/cloudfront/utils/xml_serializer.rb",
+    "lib/faraday/request/cloudfront_signer.rb",
+    "lib/faraday/request/xml_content_type.rb"
   ]
-  s.homepage = %q{http://github.com/Belkacem/cloudfront}
-  s.licenses = [%q{MIT}]
-  s.require_paths = [%q{lib}]
-  s.rubygems_version = %q{1.8.8}
-  s.summary = %q{one-line summary of your gem}
+  s.homepage = "https://github.com/Belkacem/cloudfront"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A tested Cloudfront\u{2122} gem"
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<faraday>, [">= 0"])
+      s.add_runtime_dependency(%q<faraday_middleware>, [">= 0"])
+      s.add_runtime_dependency(%q<multi_xml>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, [">= 0"])
       s.add_development_dependency(%q<minitest>, [">= 0"])
-      s.add_development_dependency(%q<yard>, ["~> 0.7"])
-      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<vcr>, [">= 0"])
+      s.add_development_dependency(%q<webmock>, [">= 0"])
+      s.add_development_dependency(%q<timecop>, [">= 0"])
     else
+      s.add_dependency(%q<faraday>, [">= 0"])
+      s.add_dependency(%q<faraday_middleware>, [">= 0"])
+      s.add_dependency(%q<multi_xml>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, [">= 0"])
       s.add_dependency(%q<minitest>, [">= 0"])
-      s.add_dependency(%q<yard>, ["~> 0.7"])
-      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
       s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<vcr>, [">= 0"])
+      s.add_dependency(%q<webmock>, [">= 0"])
+      s.add_dependency(%q<timecop>, [">= 0"])
     end
   else
+    s.add_dependency(%q<faraday>, [">= 0"])
+    s.add_dependency(%q<faraday_middleware>, [">= 0"])
+    s.add_dependency(%q<multi_xml>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, [">= 0"])
     s.add_dependency(%q<minitest>, [">= 0"])
-    s.add_dependency(%q<yard>, ["~> 0.7"])
-    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
     s.add_dependency(%q<bundler>, ["~> 1.0.0"])
-    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
-    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<vcr>, [">= 0"])
+    s.add_dependency(%q<webmock>, [">= 0"])
+    s.add_dependency(%q<timecop>, [">= 0"])
   end
 end
 

data/lib/cloudfront.rb

@@ -0,0 +1,39 @@
+# encoding: UTF-8
+
+require 'cloudfront/connection'
+
+require 'cloudfront/utils/util'
+require 'cloudfront/utils/api'
+require 'cloudfront/utils/configuration_checker'
+require 'cloudfront/utils/xml_serializer'
+
+require 'cloudfront/distribution/download_distribution'
+require 'cloudfront/distribution/streaming_distribution'
+
+require 'cloudfront/origin_access_identity/origin_access_identity'
+require 'cloudfront/invalidation/invalidations'
+
+# Errors and exceptions
+require 'cloudfront/exceptions/distribution_configuration_exception'
+
+class Cloudfront
+  include Cloudfront::Connection
+  include Cloudfront::Distribution::DownloadDistribution
+  include Cloudfront::Distribution::StreamingDistribution
+  include Cloudfront::Invalidation::Invalidations
+  include Cloudfront::OriginAccessIdentity
+
+  # @attr_reader [Faraday::Connection] connection accession to the connection established with cloudfront.
+  attr_accessor :connection
+  def initialize(key_id, key_secret)
+    @connection = build_connection(key_id, key_secret)
+  end
+  
+  def credentials_test
+    distribution_list.status == 200
+  end
+end
+
+# For easier handling of helpers
+include Cloudfront::Helpers
+

data/lib/cloudfront/connection.rb

@@ -0,0 +1,25 @@
+# encoding: UTF-8
+
+require 'faraday'
+require 'faraday/response/parse_xml'
+require 'faraday/request/cloudfront_signer'
+require 'faraday/request/xml_content_type.rb'
+
+class Cloudfront
+  module Connection
+    HOST = 'https://cloudfront.amazonaws.com'
+    
+    def build_connection(key_id, key_secret)
+      Faraday::Connection.new(HOST) do |builder|
+        builder.use Faraday::Request::CloudfrontSigner, key_id, key_secret
+        builder.use Faraday::Request::XmlContentType
+        builder.use Faraday::Response::ParseXml
+
+        # Used for debug purpose only.
+        # builder.use Faraday::Response::Logger
+        
+        builder.use Faraday::Adapter::NetHttp
+      end
+    end
+  end
+end

data/lib/cloudfront/distribution/distribution.rb

@@ -0,0 +1,136 @@
+# encoding: UTF-8
+
+class Cloudfront
+  module Distribution
+    module Distribution
+      private
+      # Creates a distribution.
+      # @param distribution [Cloudfront::Helpers::Distribution] a distribution configuration wrapper
+      # @param url [String] the resource url
+      # @return [Faraday::Response] the response from cloudfront
+      def distribution_create(url, distribution)
+        connection.post do |request|
+          request.url url
+          request.body = distribution.to_xml
+        end
+      end
+
+      # Lists all the distributions.
+      # @param url [String] the resource url
+      # @param max_items [int] the max items to be retrieved
+      # @param marker [String] The distribution id from which begins the list.
+      # @return [Faraday::Response] the response from cloudfront
+      def distribution_list(url, max_items = 0, marker = "")
+        connection.get do |request|
+          request.url url
+          request.params['Marker'] = marker unless marker.nil? || marker.blank?
+          request.params['MaxItems'] = max_items if max_items > 0
+        end
+      end
+
+      # Gets the distribution information.
+      # @param url [String] the resource url
+      # @param distribution_id [String] The id of the distribution to be returned.
+      # @return [Faraday::Response] the response from cloudfront
+      def distribution_get(url, distribution_id)
+        connection.get url + '/' + distribution_id
+      end
+
+      # Returns the distribution configuration.
+      # @param url [String] the resource url
+      # @param distribution_id [String] The id of the distribution to be returned.
+      # @return [Faraday::Response] the response from cloudfront
+      def distribution_get_config(url, distribution_id)
+        connection.get url + '/' + distribution_id + '/config'
+      end
+
+      # Puts the distribution configuration.
+      # To put a distribution config we must follow a certain process defined in
+      # http://docs.amazonwebservices.com/AmazonCloudFront/latest/APIReference/PutConfig.html
+      # and
+      # http://docs.amazonwebservices.com/AmazonCloudFront/latest/DeveloperGuide//HowToUpdateDistribution.html
+      # @param url [String] the resource url
+      # @param distribution_id [String] The id of the distribution.
+      # @param distribution [Cloudfront::Helpers::Distribution] a distribution configuration wrapper
+      # @param etag [String] The etag.
+      # @return [Faraday::Response] the response from cloudfront
+      def distribution_put_config(url, distribution_id, distribution, etag)
+        connection.put do |request|
+          request.url url + '/' + distribution_id + '/config'
+          request.headers['If-Match'] = etag
+          request.body = distribution.to_xml
+        end
+      end
+
+      # Enables a distribution.
+      # @param url [String] the resource url
+      # @param distribution_id [String] The id of the distribution to be enabled.
+      # @return [Faraday::Response] the response from cloudfront
+      def distribution_enable(url, distribution_id)
+        # 1. get the distribution configuration
+        response = distribution_get_config(url, distribution_id)
+        etag = response.headers['etag']
+        raise Cloudfront::Exceptions::MissingEtagException.new("The etag for the distribution #{distribution_id} is missing") if etag.nil? || etag.blank?
+
+        distribution = get_distribution_wrapper(url, response.body)
+        raise Cloudfront::Exceptions::DistributionAlreadyEnabledException.new("The distribution #{distribution_id} is already enabled!") if distribution.enabled
+
+        # 2. change the Enabled state
+        distribution.enabled = true
+
+        # 3. send a put configuration request with the returned etag
+        distribution_put_config(url, distribution_id, distribution, etag)
+      end
+
+      # Disables a distribution.
+      # @param url [String] the resource url
+      # @param distribution_id [String] The id of the distribution to be disabled.
+      # @return [Faraday::Response] the response from cloudfront
+      def distribution_disable(url, distribution_id)
+        # 1. get the distribution configuration
+        response = distribution_get_config(url, distribution_id)
+        etag = response.headers['etag']
+        raise Cloudfront::Exceptions::MissingEtagException.new("The etag for the distribution #{distribution_id} is missing") if etag.nil? || etag.blank?
+
+        distribution = get_distribution_wrapper(url, response.body)
+        raise Cloudfront::Exceptions::DistributionAlreadyDisabledException.new("The distribution #{distribution_id} is already disabled") unless distribution.enabled
+
+        # 2. change the enabled to false
+        distribution.enabled = false
+        # 2. send a put configuration request with the returned etag
+        distribution_put_config(url, distribution_id, distribution, etag)
+      end
+
+      # Deletes a distribution.
+      # @param url [String] the resource url
+      # @param distribution_id [String] The id of the distribution to be deleted.
+      # @return [Faraday::Response] the response from cloudfront
+      def distribution_delete(url, distribution_id)
+        # 1. get the distribution configuration
+        response = distribution_get_config(url, distribution_id)
+        etag = response.headers['etag']
+        raise Cloudfront::Exceptions::MissingEtagException.new("The etag for the distribution #{distribution_id} is missing") if etag.nil? || etag.blank?
+
+        distribution = get_distribution_wrapper(url, response.body)
+        raise Cloudfront::Exceptions::DeleteEnabledDistributionException.new("The distribution #{distribution_id} can't be deleted, disabled it first!") if distribution.enabled
+
+        # 2. send a delete request with the returned etag
+        connection.delete do |request|
+          request.url url + '/' + distribution_id
+          request.headers['If-Match'] = etag
+        end
+      end
+
+      def get_distribution_wrapper(url, hash)
+        if (url.include? "streaming")
+          get_streaming_distribution_wrapper(hash)
+        else
+          get_download_distribution_wrapper(hash)
+        end
+      end
+
+    end
+  end
+end
+
+