cdnconnect-api 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b09f95fa8be041f1279b13ad5fc9d5964d8ad776
-  data.tar.gz: bb62899381127af7f009090327f9dc019d85ebb6
+  metadata.gz: c6d3d3255939e60f875633fb33fc3d0a5f2a52e2
+  data.tar.gz: 58ec54989764b9eb02b4d59802caddbda326dffb
 SHA512:
-  metadata.gz: 63abdcbb70be485314a599ba7a9f0a9f824e88714a31f673086db4774ed8179c367e0e4614410793a275d62085750c72a84cc8dc7ecf3e9bf4b3a32276adfc07
-  data.tar.gz: f8f45b12ca80ee4cb9ca1e57196addcc22cc34febe954b3830f739efa29bbcc5b32c1b84161575a7b8c3a8054e8987ebdedb700f2ce84dfbe974860df6adcea7
+  metadata.gz: 42d5a6ea40556f3dced79a275fb61be47b83446e3588ea83a54a8b2de7da9f94d87fcf8d49219fd778c419750005b8af5e931f5920b0f3c5989063772fbb064a
+  data.tar.gz: 8369b89dc1e239689322b7df3d22ba0c5c65b97efa8701e4d1767520505d375e390b4f9ff0ae5fd161f002e5f9a149d16b822f1b8828772a6fb35cec6a1d6c64

data/README.md

@@ -1,6 +1,4 @@
-# CDN Connect API Ruby Client, v0.0.1
-
-## Description
+# CDN Connect API Ruby Client, v0.0.2
 
 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
@@ -10,9 +8,11 @@ to easily upload files and get information with only a few lines of code.
 
     $ sudo gem install cdnconnect-api
 
+[RubyGems.org: cdnconnect-api](https://rubygems.org/gems/cdnconnect-api)
+
 ## API Key
 
-An API Key is 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
+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
@@ -47,25 +47,27 @@ An object can be either a file or a folder. Pass the `get` method the `url` you
 
 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": []
+          "data":
+          {
+              "id": "bU1SS1JyvF9I", 
+              "status": 1,
+              "name": "images",
+              "created": "2013-03-12T17:02Z",
+              "parent_id": "iF637hnbwI4G",
+              "folder": true, 
+              "files": [],
+              "folders": []
           }
       },
       "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.
+
 
-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. 
 
 ## Support
 

data/lib/cdnconnect_api.rb

@@ -23,7 +23,7 @@ module CDNConnect
   class APIClient
   
     @@application_name = 'cdnconnect-api-ruby'
-    @@application_version = '0.0.2'
+    @@application_version = '0.1.0'
     @@api_host = 'https://api.cdnconnect.com'
     @@user_agent = @@application_name + ' v' + @@application_version
 
@@ -42,11 +42,13 @@ module CDNConnect
     #     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 individual clients.
+    #     authorization server. This is issued by CDN Connect to external clients.
+    #     This is only needed if an API Key isn't already known. 
     #   - <code>:client_secret</code> -
-    #     A shared secret issued by the CDN Connect's authorization server,
+    #     A secret issued by the CDN Connect's authorization server,
     #     which is used to authenticate the client. Do not confuse this is an access_token
-    #     or an api_key.
+    #     or an api_key. This is only required if an API Key
+    #     isn't already known. A client secret should not be shared.
     #   - <code>:scope</code> -
     #     The scope of the access request, expressed either as an Array
     #     or as a space-delimited String.
@@ -88,23 +90,53 @@ module CDNConnect
 
 
     ##
-    # Used to receive information about an object, which can be either a file or 
-    # folder. This method requires either a CDN Connect URL, or both an
-    # app_id and obj_id.
+    # Executes a GET request to an API URL and returns a response object.
+    # GET requests are used when reading data.
     #
-    # @param [Hash] options
-    #   The configuration parameters for the client.
-    #   - <code>:url</code> -
-    #     The URL of the object to get data on. If the URL option is not provided
-    #     then you must use the app_id and obj_id options.
-    #   - <code>:app_id</code> -
-    #     The app_id of the object to get data on. If the app_id or obj_id options 
-    #     are not provided then you must use the url option.
-    #   - <code>:obj_id</code> -
-    #     The obj_id of the object to get data on. If the app_id or obj_id options 
-    #     are not provided then you must use the url option.
-    def get(options={})
-      options[:path] = self.generate_obj_path(options)
+    # @param url [String] The API URL to send a 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)
+    end
+
+
+    ##
+    # 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.
+    # @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)
+    end
+
+
+    ##
+    # 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.
+    # @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)
+    end
+
+
+    ##
+    # 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.
+    # @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)
     end
 
@@ -127,6 +159,7 @@ 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.
+    # @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
       prepare_upload(options)
@@ -278,6 +311,11 @@ module CDNConnect
     # path common needed by a few methods.
     # @!visibility private
     def generate_obj_path(options={})
+      path = options[:path]
+      if path != nil
+        return path
+      end
+
       app_id = options[:app_id]
       obj_id = options[:obj_id]
       uri = options[:uri] || options[:url]
@@ -350,36 +388,84 @@ 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.
 
 
+    ##
+    # 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.
+    # This is only needed if an API Key isn't already known. 
+    #
+    # @return [String]
     def client_id
       @client_id
     end
 
+
+    ##
+    # A secret issued by the CDN Connect's authorization server,
+    # which is used to authenticate the client. Do not confuse this is an access_token
+    # or an api_key. This is only required if an API Key
+    # isn't already known. A client secret should not be shared.
+    #
+    # @return [String]
     def client_secret
       @client_secret
     end
 
+
+    ##
+    # The scope of the access request, expressed either as an Array
+    # or as a space-delimited String. This is only required if an API Key
+    # isn't already known. 
+    #
+    # @return [String]
     def scope
       @scope
     end
 
+
+    ##
+    # An unguessable random string designed to allow the client to maintain state
+    # to protect against cross-site request forgery attacks. 
+    # This is only required if an API Key isn't already known. 
+    #
+    # @return [String]
     def state
       @state
     end
 
+
+    # @return [String]
     def code
       @code
     end
 
+
+    # @return [String]
     def redirect_uri
       @redirect_uri
     end
 
+
+    # @return [String]
     def access_token
       @access_token
     end
 
+
+    # @return [String]
+    def api_key
+      @access_token
+    end
+
+
+    # @return [String]
     def response_format
       @response_format
     end

metadata

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