cloudfront 1.1 → 1.2

data/Rakefile

@@ -15,7 +15,7 @@ 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 = '1.1'
+  gem.version = '1.2'
   gem.homepage = "https://github.com/Belkacem/cloudfront"
   gem.license = "MIT"
   gem.summary = %Q{A tested Cloudfront™ gem}

data/cloudfront.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "cloudfront"
-  s.version = "1.1"
+  s.version = "1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Belkacem REBBOUH"]

data/lib/cloudfront.rb

@@ -30,7 +30,7 @@ class Cloudfront
   end
   
   def credentials_test
-    distribution_list.status == 200
+    download_distribution_list.status == 200
   end
 end
 

data/lib/cloudfront/distribution/distribution.rb

@@ -4,10 +4,6 @@ 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
@@ -15,11 +11,6 @@ class Cloudfront
         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
@@ -28,32 +19,14 @@ class Cloudfront
         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'
@@ -62,10 +35,6 @@ class Cloudfront
         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)
@@ -82,10 +51,6 @@ class Cloudfront
         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)
@@ -101,10 +66,6 @@ class Cloudfront
         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)

data/lib/cloudfront/distribution/download_distribution.rb

@@ -10,34 +10,63 @@ class Cloudfront
 
       ::DOWNLOAD_DISTRIBUTION_URL = "/#{Cloudfront::Utils::Api.version}/distribution"
 
+      # Creates a download distribution.
+      # @param distribution [Cloudfront::Helpers::DownloadDistribution] a distribution configuration wrapper
+      # @return [Faraday::Response] the response from cloudfront
       def download_distribution_create(distribution)
         distribution_create(DOWNLOAD_DISTRIBUTION_URL, distribution)
       end
 
+      # Lists all the download distributions.
+      # @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 download_distribution_list(max_items = 0, marker = "")
         distribution_list(DOWNLOAD_DISTRIBUTION_URL, max_items, marker)
       end
 
+      # Gets the download distribution information.
+      # @param distribution_id [String] The id of the distribution to be returned.
+      # @return [Faraday::Response] the response from cloudfront
       def download_distribution_get(distribution_id)
         distribution_get(DOWNLOAD_DISTRIBUTION_URL, distribution_id)
       end
 
+      # Returns the download distribution configuration.
+      # @param distribution_id [String] The id of the distribution to be returned.
+      # @return [Faraday::Response] the response from cloudfront
       def download_distribution_get_config(distribution_id)
         distribution_get_config(DOWNLOAD_DISTRIBUTION_URL, distribution_id)
       end
 
+      # Puts the download distribution configuration.
+      # To put a distribution config we must follow a certain process defined in
+      # http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToUpdateDistribution.html
+      # @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 download_distribution_put_config(distribution_id, distribution, etag)
         distribution_put_config(DOWNLOAD_DISTRIBUTION_URL, distribution_id, distribution, etag)
       end
 
+      # Enables a download distribution.
+      # @param distribution_id [String] The id of the distribution to be enabled.
+      # @return [Faraday::Response] the response from cloudfront
       def download_distribution_enable(distribution_id)
         distribution_enable(DOWNLOAD_DISTRIBUTION_URL, distribution_id)
       end
 
+      # Disables a download distribution.
+      # @param distribution_id [String] The id of the distribution to be disabled.
+      # @return [Faraday::Response] the response from cloudfront
       def download_distribution_disable(distribution_id)
         distribution_disable(DOWNLOAD_DISTRIBUTION_URL, distribution_id)
       end
 
+      # Deletes a download distribution.
+      # @param distribution_id [String] The id of the distribution to be deleted.
+      # @return [Faraday::Response] the response from cloudfront
       def download_distribution_delete(distribution_id)
         distribution_delete(DOWNLOAD_DISTRIBUTION_URL, distribution_id)
       end

data/lib/cloudfront/distribution/streaming_distribution.rb

@@ -10,34 +10,64 @@ class Cloudfront
 
       ::STREAMING_DISTRIBUTION_URL = "/#{Cloudfront::Utils::Api.version}/streaming-distribution"
 
+      # Creates a streaming distribution.
+      # @param distribution [Cloudfront::Helpers::DownloadDistribution] a distribution configuration wrapper
+      # @return [Faraday::Response] the response from cloudfront
       def streaming_distribution_create(distribution)
         distribution_create(STREAMING_DISTRIBUTION_URL, distribution)
       end
 
+      # Lists all the streaming distributions.
+      # @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 streaming_distribution_list(max_items = 0, marker = "")
         distribution_list(STREAMING_DISTRIBUTION_URL, max_items, marker)
       end
 
+      # Gets the streaming distribution information.
+      # @param distribution_id [String] The id of the distribution to be returned.
+      # @return [Faraday::Response] the response from cloudfront
       def streaming_distribution_get(distribution_id)
         distribution_get(STREAMING_DISTRIBUTION_URL, distribution_id)
       end
 
+      # Returns the streaming distribution configuration.
+      # @param distribution_id [String] The id of the distribution to be returned.
+      # @return [Faraday::Response] the response from cloudfront
       def streaming_distribution_get_config(distribution_id)
         distribution_get_config(STREAMING_DISTRIBUTION_URL, distribution_id)
       end
 
+
+      # Puts the streaming distribution configuration.
+      # To put a distribution config we must follow a certain process defined in
+      # http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/HowToUpdateDistribution.html
+      # @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 streaming_distribution_put_config(distribution_id, distribution, etag)
         distribution_put_config(STREAMING_DISTRIBUTION_URL, distribution_id, distribution, etag)
       end
 
+      # Enables a streaming distribution.
+      # @param distribution_id [String] The id of the distribution to be enabled.
+      # @return [Faraday::Response] the response from cloudfront
       def streaming_distribution_enable(distribution_id)
         distribution_enable(STREAMING_DISTRIBUTION_URL, distribution_id)
       end
 
+      # Disables a streaming distribution.
+      # @param distribution_id [String] The id of the distribution to be disabled.
+      # @return [Faraday::Response] the response from cloudfront
       def streaming_distribution_disable(distribution_id)
         distribution_disable(STREAMING_DISTRIBUTION_URL, distribution_id)
       end
 
+      # Deletes a streaming distribution.
+      # @param distribution_id [String] The id of the distribution to be deleted.
+      # @return [Faraday::Response] the response from cloudfront
       def streaming_distribution_delete(distribution_id)
         distribution_delete(STREAMING_DISTRIBUTION_URL, distribution_id)
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudfront
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
   prerelease: 
 platform: ruby
 authors:
@@ -277,7 +277,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1341546795153992287
+      hash: -1728956242891598010
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: