cdnconnect-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6d3d3255939e60f875633fb33fc3d0a5f2a52e2
-  data.tar.gz: 58ec54989764b9eb02b4d59802caddbda326dffb
+  metadata.gz: b1f2158a5e22b91680429d6bff92c989683706a8
+  data.tar.gz: 68128b30f4bead555cb4f951db73ffaf4afa1825
 SHA512:
-  metadata.gz: 42d5a6ea40556f3dced79a275fb61be47b83446e3588ea83a54a8b2de7da9f94d87fcf8d49219fd778c419750005b8af5e931f5920b0f3c5989063772fbb064a
-  data.tar.gz: 8369b89dc1e239689322b7df3d22ba0c5c65b97efa8701e4d1767520505d375e390b4f9ff0ae5fd161f002e5f9a149d16b822f1b8828772a6fb35cec6a1d6c64
+  metadata.gz: 877dd452661d8b2f24de5e3485facca42402bccf2a4c6238faebd7ff4b8e64a3d563f5a584641b56f4b337f42504c0919b6091f3844ef27d58812ba5eeba31bf
+  data.tar.gz: 4d78036142f1e38f13f089d351cbecf4df88a17eaf8a34e971512276fabd3e137a66f30ef474ea81878b4574adf06fa6c6dd8d3e36cf689e8700087012d6c302

data/README.md

@@ -1,20 +1,22 @@
-# CDN Connect API Ruby Client, v0.0.2
+# CDN Connect API Ruby Client, v0.1.0
 
-The CDN Connect API Ruby Client makes it easier to upload files and interact with
-our 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.
+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.
+
+[View the full CDN Connect API documentation](http://api.cdnconnect.com/)
 
 ## Install
 
-    $ sudo gem install cdnconnect-api
+    $ gem install cdnconnect-api
 
 [RubyGems.org: cdnconnect-api](https://rubygems.org/gems/cdnconnect-api)
 
+
 ## API Key
 
 An API Key can be created for a specific app within your CDN Connect's account. Sign into your account and go to the "API Key" tab for the app you want to interact with. Next click "Add API Key" and use this value when creating a new API client within the code. The API Key can be revoked
 by you at any time and numerous keys can be created.
 
+
 ## Example Usage
 
     # Initialize the CDN Connect API client
@@ -30,18 +32,22 @@ by you at any time and numerous keys can be created.
       # "Woot!"
     end
 
+
 ## Get Object Data
 
-An object can be either a file or a folder. Pass the `get` method the `url` you want to receive data about.
+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.
+
+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(:url => 'demo.cdnconnect.com/images/meowzers.jpg')
+    response = api_client.get('demo.cdnconnect.com/images/meowzers.jpg')
     puts response.results['data']['name']           #=> "meowzers.jpg"
 
-    # Get folder information
-    response = api_client.get(:url => 'demo.cdnconnect.com/images')
-    puts response.results['data']['name']           #=> "images"
-
 
 ## Response Object
 
@@ -65,8 +71,7 @@ All responses will be structured the same with both a `results` and `msgs` objec
       "msgs":[]
   }
 
-The `results` object contains the guts of the information your looking for, and the `msgs` object contains an array of messages which can represent errors, warnings and information. The `results` object can be null, or it can contain many objects within it. Each response can have different data within `results` object and `msgs` object. In the case above, the `results` object contains the key `data`, and within the `data` object it contains summary information of the images folder.
-
+Be sure to view the [API documentation](http://api.cdnconnect.com/) describing what each response object will contain depending on the API resource.
 
 
 ## Support

data/lib/cdnconnect_api.rb

@@ -23,7 +23,7 @@ module CDNConnect
   class APIClient
   
     @@application_name = 'cdnconnect-api-ruby'
-    @@application_version = '0.1.0'
+    @@application_version = '0.1.1'
     @@api_host = 'https://api.cdnconnect.com'
     @@user_agent = @@application_name + ' v' + @@application_version
 
@@ -37,9 +37,6 @@ module CDNConnect
     #   - <code>:api_key</code> -
     #     An API Key (commonly known as an access_token) which was previously 
     #     created within CDN Connect's account for a specific app.
-    #   - <code>:response_format</code> -
-    #     How data should be formatted on the response. Possible values for
-    #     include application/json, application/xml. JSON is the default.
     #   - <code>:client_id</code> -
     #     A unique identifier issued to the client to identify itself to CDN Connect's
     #     authorization server. This is issued by CDN Connect to external clients.
@@ -61,6 +58,8 @@ module CDNConnect
     #     The redirection URI used in the initial request.
     #   - <code>:access_token</code> -
     #     The current access token for this client, also known as the API Key.
+    #   - <code>:debug</code> -
+    #     Print out any debugging information. Default is false.
     def initialize(options={})
       # Normalize key to String to allow indifferent access.
       options = options.inject({}) { |accu, (k, v)| accu[k.to_s] = v; accu }
@@ -74,7 +73,7 @@ module CDNConnect
       @redirect_uri = options["redirect_uri"]
       options["access_token"] = options["access_token"] || options["api_key"] # both work
       @access_token = options["access_token"]
-      @response_format = options["response_format"] || 'application/json'
+      @debug = options["debug"] || false
       @prefetched_upload_urls = {}
       
       # Create the OAuth2 client which will be used to authorize the requests
@@ -93,12 +92,10 @@ module CDNConnect
     # Executes a GET request to an API URL and returns a response object.
     # GET requests are used when reading data.
     #
-    # @param url [String] The API URL to send a GET request to.
+    # @param path [String] The API path to send the GET request to.
     # @return [APIResponse] A response object with helper methods to read the response.
-    def get(url)
-      options[:path] = url
-      options[:method] = 'GET'
-      return self.fetch(options)
+    def get(path)
+      return self.fetch(:path => path, :method => 'GET')
     end
 
 
@@ -106,12 +103,10 @@ module CDNConnect
     # Executes a POST request to an API URL and returns a response object. 
     # POST requests are used when creating data.
     #
-    # @param url [String] The API URL to send a POST request to.
+    # @param path [String] The API path to send the POST request to.
     # @return [APIResponse] A response object with helper methods to read the response.
-    def post(url)
-      options[:path] = url
-      options[:method] = 'POST'
-      return self.fetch(options)
+    def post(path)
+      return self.fetch(:path => path, :method => 'POST')
     end
 
 
@@ -119,12 +114,10 @@ module CDNConnect
     # Executes a PUT request to an API URL and returns a response object.
     # PUT requests are used when updating data.
     #
-    # @param url [String] The API URL to send a GET request to.
+    # @param path [String] The API path to send the POST request to.
     # @return [APIResponse] A response object with helper methods to read the response.
-    def post(url)
-      options[:path] = url
-      options[:method] = 'POST'
-      return self.fetch(options)
+    def put(path)
+      return self.fetch(:path => path, :method => 'PUT')
     end
 
 
@@ -132,12 +125,10 @@ module CDNConnect
     # Executes a DELETE request to an API URL and returns a response object.
     # DELETE requests are used when (you guessed it) deleting data.
     #
-    # @param url [String] The API URL to send a DELETE request to.
+    # @param path [String] The API path to send the DELETE request to.
     # @return [APIResponse] A response object with helper methods to read the response.
     def delete(url)
-      options[:path] = url
-      options[:method] = 'DELETE'
-      return self.fetch(options)
+      return self.fetch(:path => path, :method => 'DELETE')
     end
 
 
@@ -159,6 +150,9 @@ 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
@@ -198,6 +192,9 @@ module CDNConnect
         end
 
         # Kick it off!
+        if @debug
+          puts 'upload, source: ' + options[:source_file_local_path] + ', destination: ' + options[:destination_folder_url]
+        end
         api_response = conn.post upload_url, post_data
 
         # Woot! Convert the response to our model and see what's up
@@ -290,11 +287,19 @@ module CDNConnect
 
       path = nil
       if destination_folder_url != nil
-        path = '/v1/' + destination_folder_url + '/upload'
+        path = destination_folder_url + '/upload'
       else
         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
+
       i = 1
       begin
         response = self.fetch(:path => path)
@@ -333,7 +338,7 @@ module CDNConnect
         raise ArgumentError, "missing url or both app_id and obj_id"
       end
 
-      return '/v1/' + path
+      return path
     end
 
 
@@ -346,23 +351,8 @@ module CDNConnect
         raise ArgumentError, 'missing api path'
       end
 
-      options[:response_format] = options[:response_format] || @response_format
-
-      headers = { 'User-Agent' => @@user_agent }
-
-      # There are three possible response content-types: JSON, XML
-      # Default Content-Type is application/json with a .json extension
-      if options[:response_format] == 'application/xml'
-        headers['Content-Type'] = 'application/xml'
-        response_extension = 'xml'
-      else
-        options[:response_format] = 'application/json'
-        headers['Content-Type'] = 'application/json'
-        response_extension = 'json'       
-      end
-      options[:headers] = headers
-
-      options[:uri] = @@api_host + options[:path] + '.' + response_extension
+      options[:headers] = { 'User-Agent' => @@user_agent }
+      options[:uri] = @@api_host + options[:path]
       options[:url] = options[:uri]
       options[:method] = options[:method] || 'GET'
 
@@ -377,6 +367,10 @@ module CDNConnect
       # Prepare the data to be shipped in the request
       options = self.prepare(options)
 
+      if @debug
+        puts 'fetch: ' + options[:uri]
+      end
+
       begin
         # Send the request and get the response
         response = @client.fetch_protected_resource(options)
@@ -388,12 +382,6 @@ module CDNConnect
       end
 
     end
-    #   - <code>:code</code> -
-    #     The authorization code received from the authorization server.
-    #   - <code>:redirect_uri</code> -
-    #     The redirection URI used in the initial request.
-    #   - <code>:access_token</code> -
-    #     The current access token for this client, also known as the API Key.
 
 
     ##

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cdnconnect-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Adam Bradley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-16 00:00:00.000000000 Z
+date: 2013-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -38,11 +38,13 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: 0.4.5
-description: The CDN Connect API Ruby Client makes it easier to upload files and interact
-  with our 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.
+description: 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.
 email: developer@cdnconnect.com
 executables: []
 extensions: []