cdnconnect-api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1f2158a5e22b91680429d6bff92c989683706a8
-  data.tar.gz: 68128b30f4bead555cb4f951db73ffaf4afa1825
+  metadata.gz: 87036814444c22863b8635b0d8004733180fe3c7
+  data.tar.gz: e570f55d47c36fda2ddb196e5371ec35b18178aa
 SHA512:
-  metadata.gz: 877dd452661d8b2f24de5e3485facca42402bccf2a4c6238faebd7ff4b8e64a3d563f5a584641b56f4b337f42504c0919b6091f3844ef27d58812ba5eeba31bf
-  data.tar.gz: 4d78036142f1e38f13f089d351cbecf4df88a17eaf8a34e971512276fabd3e137a66f30ef474ea81878b4574adf06fa6c6dd8d3e36cf689e8700087012d6c302
+  metadata.gz: a948d0f7bbdbdc95767ad1a5dc2bb1c033e0ef084951250b349816fe5c9682d56e0eadf0e90f5e3d7d85cac69453bf32e45d482cb39e937fcb6c9ec25f82a273
+  data.tar.gz: c9246b9728a2ea0b098f95b6075cd53133dd8eb8e8e202ebebc5f177418a12d0ee0dadb0cdacca17650d6e613c1493b728c9de5f599c4266af6dc552fce19b2c

data/README.md

@@ -1,4 +1,4 @@
-# CDN Connect API Ruby Client, v0.1.0
+# CDN Connect API Ruby Client, v0.1.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, etc. The CDN Connect API Ruby Client makes it easier to upload files and interact with the API. Most interactions with CDN Connect APIs require users to authorize applications via OAuth 2.0. This library simplifies the communication with CDN Connect even further allowing you to easily upload files and get information with only a few lines of code.
 
@@ -17,7 +17,7 @@ An API Key can be created for a specific app within your CDN Connect's account.
 by you at any time and numerous keys can be created.
 
 
-## Example Usage
+## Upload Example
 
     # Initialize the CDN Connect API client
     require 'cdnconnect_api'
@@ -33,43 +33,48 @@ by you at any time and numerous keys can be created.
     end
 
 
-## Get Object Data
+## API Requests
 
 Following the [API documentation](http://api.cdnconnect.com/), you can use these methods to  build a requests and return an APIResponse object.
 
-* `get`: GET Request. Used when needing to just read data.
-* `post`: POST Request. Used when creating data.
-* `put`: PUT Request. Used when updating data.
-* `delete`: DELETE Request. Used when deleting data.
+* `get` GET Request. Used when needing to just read data.
+* `post` POST Request. Used when creating data.
+* `put` PUT Request. Used when updating data.
+* `delete` DELETE Request. Used when deleting data.
 
 Each of these methods take one parameter which is the API path you want to request. Depending on which method you use, it will send the request with the correct HTTP verb.
 
-    # Get file information
-    response = api_client.get('demo.cdnconnect.com/images/meowzers.jpg')
-    puts response.results['data']['name']           #=> "meowzers.jpg"
+    response = api_client.get('/v1/demo.cdnconnect.com/images/meowzers.jpg.json')
+    puts response.results['object']['name']           #=> "meowzers.jpg"
+
+The path in the API request is broken down as:
+
+* `/v1/` The API version, which must always prefix an API request path.
+* `demo.cdnconnect.com/images/meowzers.jpg` The URL which you want to get information about.
+* `.json` The response format, which can be `json` or `xml`.
 
 
 ## Response Object
 
 All responses will be structured the same with both a `results` and `msgs` object at the root level, such as:
 
-  {
-      "results":
-      {
-          "data":
-          {
-              "id": "bU1SS1JyvF9I", 
-              "status": 1,
-              "name": "images",
-              "created": "2013-03-12T17:02Z",
-              "parent_id": "iF637hnbwI4G",
-              "folder": true, 
-              "files": [],
-              "folders": []
-          }
-      },
-      "msgs":[]
-  }
+    {
+        "results":
+        {
+            "object":
+            {
+                "id": "bU1SS1JyvF9I", 
+                "status": 1,
+                "name": "images",
+                "created": "2013-03-12T17:02Z",
+                "parent_id": "iF637hnbwI4G",
+                "folder": true, 
+                "files": [],
+                "folders": []
+            }
+        },
+        "msgs":[]
+    }
 
 Be sure to view the [API documentation](http://api.cdnconnect.com/) describing what each response object will contain depending on the API resource.
 

data/lib/cdnconnect_api.rb

@@ -150,9 +150,6 @@ module CDNConnect
     #     are not provided then you must use the url option.
     #   - <code>:source_file_local_path</code> -
     #     A string of a source file's local paths to upload.
-    #   - <code>:response_format</code> -
-    #     How data should be formatted on the response. Possible values 
-    #     include json (default) or xml.
     # @return [APIResponse] A response object with helper methods to read the response.
     def upload(options={})
       # Make sure we've got good data before starting the upload
@@ -292,13 +289,7 @@ module CDNConnect
         path = generate_obj_path(options) + '/upload'
       end
 
-      # Default Content-Type is application/json with a .json extension
-      response_extension = 'json'
-      if options[:response_format] == 'xml'
-        response_extension = 'xml'
-      end
-
-      path = '/v1/' + path + '.' + response_extension
+      path = '/v1/' + path + '.json'
 
       i = 1
       begin
@@ -451,12 +442,7 @@ module CDNConnect
     def api_key
       @access_token
     end
-
-
-    # @return [String]
-    def response_format
-      @response_format
-    end
+    
 
   end
 

data/lib/cdnconnect_api/response.rb

@@ -31,16 +31,14 @@ module CDNConnect
     end
 
     def data()
-      # Convert the response body depending on the response format
+      # Decode the response body from JSON into an object.
       # Keep the parsed data in an instance variable so we 
       # don't keep parsing it every time we reference data()
       if @data == nil
         if format.include? 'application/json'
           @data = ActiveSupport::JSON.decode(body)
-        elsif format.include? 'application/xml'
-          @data = ActiveSupport::XML.decode(body)
         else
-          raise "invalid data format"
+          raise "Data response type must be JSON"
         end
       end
       @data
@@ -92,6 +90,10 @@ module CDNConnect
       (status >= 400)
     end
 
+    def is_client_error()
+      (status >= 400 and status < 500)
+    end
+
     def is_bad_request()
       (status == 400)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cdnconnect-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Adam Bradley