cdnconnect-api 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b1927a121609f5f80071326dae5a35749b7ca64
-  data.tar.gz: 5d5ad9dd4d8769ea5678f26ecf00c8d3886c0b3c
+  metadata.gz: e14424ffa772eae0884c92cbe5ca7f372c708dff
+  data.tar.gz: 8acc7e7039ecd25f8962738a20c63f5e0d94c5b8
 SHA512:
-  metadata.gz: e660745ae9fa2805368ab3120022e464de1f901ec1266604d76ff82a332c2d4ab37e6a93dd4a04ca50bb61e0e675fd298cefa6f4fec5c3675338fae686761087
-  data.tar.gz: 543c7d4a4aed195bf8322913602c4410ce1968e733edd74fe9aec71337345ec4d33f215630cc435e93ace66d428c7eb02848f9ebdf9d3cef82c0d1a87ffde22c
+  metadata.gz: cc1434d7a16cda0a7e02bfdce07a0a5664d38a358afb0867b78d41f64b7b0ce7026d9eb8eb1eb403fae6ca64ddf5e89d5f022524160fa2038e84937a89dce4cb
+  data.tar.gz: fe16c5b082c3dcdf28b00292b685a9d2b53e47101380f3290e6385422624660f106c1fab53b07cbf9fc73a4c8121ee19cefe347e6d1fcee816ff6a67b8dabd8a

data/README.md

@@ -1,4 +1,4 @@
-# CDN Connect API Ruby Client, v0.2.1
+# CDN Connect API Ruby Client, v0.2.2
 
 CDN Connect makes it easier to manage production assets for teams of developers and designers, all while serving files from a fast content delivery network. Features include image optimization, resizing, cropping, filters, changing output formats, convert to WebP image format, etc. The CDN Connect API Ruby Client makes it easier to upload files and interact with the API with only a few lines of code.
 
@@ -44,7 +44,8 @@ Below are the possible parameters for the `upload` method. You must set `destina
  - `valid_extensions` : An array of valid extensions which should be uploaded. This is only applied when the `source_folder_path` options is used. If nothing is provided, which is the default, all files within the folder are uploaded. The extensions should be in all lower case, and they should not contain a period or asterisks. Example `valid_extensions => ['js', 'css', 'jpg', jpeg', 'png', 'gif', 'webp']`
  - `recursive_local_folders` : A true or false value indicating if this call should recursively upload all of the local folder's sub-folders, and their sub-folders, etc. This option is only used when the `source_folder_path` option is used.
  - `async` : A true or false value indicating if the processing of the data should be asynchronous or not. The default value is false meaning that the processing of the data will be synchronous. An async response will be faster because the resposne doesn't wait on the system to complete processing the data. However, because an async response does not wait for the data to complete processing then the response will not contain any information about the data which was just uploaded. Use async only if you do not need to know the details of the upload.
- - `webhook_url` : A URL which the system should `POST` the response to. This works for both synchronous and asynchronous calls. The data sent to the `webhook_url` will be the same as the data that is sent in a synchronous response. By default there is not webhook URL.
+ - `webhook_url` : A URL which the system should `POST` the response to. This works for both synchronous and asynchronous calls. The data sent to the `webhook_url` will be the same as the data that is responded in a synchronous response, and is sent within the `data` parameter. The format sent can be in either `json` or `xml` by using the `webhook_format` parameter. By default there is no webhook URL.
+ - `webhook_format` : When a `webhook_url` is provided, you can have the data formatted as either `json` or `xml`. The defautl format is `json`.
 
 ### Upload One File: `source_file_path`
 
@@ -83,11 +84,16 @@ Both files and folders are considered "objects", and object data contains inform
     response = api_client.get_object(:path => '/images/spacewalk.jpg')
 
 
-#### Get Folder Information
+#### Get Folder's Basic Information
 
     response = api_client.get_object(:path => '/images')
 
 
+#### Get Folder's Sub-Files and Sub-Folders
+
+    response = api_client.get_object(:path => '/images', :files => true, :folders => true)
+
+
 ## Rename File or Folder
 
 Renames a file or folder, which are both also known as an object.

data/lib/cdnconnect_api.rb

@@ -150,7 +150,13 @@ module CDNConnect
     #   - <code>:webhook_url</code> -
     #     A URL which the system should `POST` the response to. This works for both synchronous
     #     and asynchronous calls. The data sent to the `webhook_url` will be the same as the
-    #     data that is sent in a synchronous response. By default there is not webhook URL.
+    #     data that is responded in a synchronous response, and is sent within the `data` 
+    #     parameter. The format sent can be in either `json` or `xml` by using the 
+    #     `webhook_format` parameter. By default there is no webhook URL.
+    #   - <code>:webhook_format</code> -
+    #     When a `webhook_url` is provided, you can have the data formatted as either `json`
+    #     or `xml`. The defautl format is `json`.
+    #
     # @return [APIResponse] A response object with helper methods to read the response.
     def upload(options={})
         # Make sure we've got good source data before starting the upload
@@ -196,7 +202,9 @@ module CDNConnect
             post_data = build_post_data(destination_path, 
                                         max_files_per_request = 25, 
                                         max_request_size = 25165824, 
-                                        async = options.fetch(:async, false))
+                                        async = options.fetch(:async, false),
+                                        webhook_url = options[:webhook_url],
+                                        webhook_format = options[:webhook_format])
 
             # Build the request to send to the API
             # Uses the Faraday: https://github.com/lostisland/faraday
@@ -247,7 +255,7 @@ module CDNConnect
     ##
     # Build the POST data that gets sent in the request
     # @!visibility private
-    def build_post_data(destination_path, max_files_per_request = 25, max_request_size = 25165824, async = false)
+    def build_post_data(destination_path, max_files_per_request = 25, max_request_size = 25165824, async = false, webhook_url = nil, webhook_format = nil)
         # @active_uploads will hold all of the upload keys  
         # which are actively being uploaded.
         @active_uploads = []
@@ -261,6 +269,15 @@ module CDNConnect
         # Processing of the data can be async. However, an async response will
         # not contain any information about the data uploaded.
         post_data[:async] = async
+
+        # send with the post data the webhook_url if there is one
+        if webhook_url != nil
+            post_data[:webhook_url] = webhook_url
+            # send in the webhook_format, but defaults to json if nothing sent
+            if webhook_format != nil
+                post_data[:webhook_format] = webhook_format
+            end
+        end
         
         # Mime type doesn't matter because it gets figured out on the server-side
         # using the file extension. So be sure file extensions are valid!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cdnconnect-api
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Adam Bradley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-21 00:00:00.000000000 Z
+date: 2013-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday