cdnconnect-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b09f95fa8be041f1279b13ad5fc9d5964d8ad776
+  data.tar.gz: bb62899381127af7f009090327f9dc019d85ebb6
+SHA512:
+  metadata.gz: 63abdcbb70be485314a599ba7a9f0a9f824e88714a31f673086db4774ed8179c367e0e4614410793a275d62085750c72a84cc8dc7ecf3e9bf4b3a32276adfc07
+  data.tar.gz: f8f45b12ca80ee4cb9ca1e57196addcc22cc34febe954b3830f739efa29bbcc5b32c1b84161575a7b8c3a8054e8987ebdedb700f2ce84dfbe974860df6adcea7

data/LICENSE

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,73 @@
+# CDN Connect API Ruby Client, v0.0.1
+
+## 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.
+
+## Install
+
+    $ sudo gem install 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
+by you at any time and numerous keys can be created.
+
+## Example Usage
+
+    # Initialize the CDN Connect API client
+    require 'cdnconnect_api'
+    api_client = CDNConnect::APIClient.new(:api_key => YOUR_API_KEY)
+    
+    # Upload to a folder in the app the API Key was created for
+    response = api_client.upload(:destination_folder_url => 'demo.cdnconnect.com/images', 
+                                 :source_file_local_path => 'meowzers.jpg')
+
+    # Read the response
+    if response.is_success
+      # "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.
+
+    # Get file information
+    response = api_client.get(:url => '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
+
+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":[]
+    }
+
+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
+
+Please [report any bugs](https://github.com/cdnconnect/cdnconnect-api-ruby/issues) on this project's issues page. Additionally, please don't hesitate to contact us and/or submit a pull request with any ideas you may have to improve the service. We will continue to improve upon and build out the API in order to bring more value to you and your projects.
+

data/lib/cdnconnect_api.rb

@@ -0,0 +1,389 @@
+# Copyright 2013 CDN Connect
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'faraday'
+require 'faraday/utils'
+require 'signet/oauth_2/client'
+require 'cdnconnect_api/response'
+
+
+module CDNConnect
+
+  class APIClient
+  
+    @@application_name = 'cdnconnect-api-ruby'
+    @@application_version = '0.0.2'
+    @@api_host = 'https://api.cdnconnect.com'
+    @@user_agent = @@application_name + ' v' + @@application_version
+
+    ##
+    # Creates a client to authorize interactions with the API using the OAuth 2.0 protocol.
+    # This can be given a known API Key (access_token) or can use OAuth 2.0 
+    # web application flow designed for 3rd party web sites (clients).
+    #
+    # @param [Hash] options
+    #   The configuration parameters for the client.
+    #   - <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 individual clients.
+    #   - <code>:client_secret</code> -
+    #     A shared 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.
+    #   - <code>:scope</code> -
+    #     The scope of the access request, expressed either as an Array
+    #     or as a space-delimited String.
+    #   - <code>:state</code> -
+    #     An unguessable random string designed to allow the client to maintain state
+    #     to protect against cross-site request forgery attacks.
+    #   - <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.
+    def initialize(options={})
+      # Normalize key to String to allow indifferent access.
+      options = options.inject({}) { |accu, (k, v)| accu[k.to_s] = v; accu }
+      
+      # Initialize all of the options
+      @client_id = options["client_id"]
+      @client_secret = options["client_secret"]
+      @scope = options["scope"]
+      @state = options["state"]
+      @code = options["code"]
+      @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'
+      @prefetched_upload_urls = {}
+      
+      # Create the OAuth2 client which will be used to authorize the requests
+      @client = Signet::OAuth2::Client.new(:client_id => client_id,
+                                           :client_secret => @client_secret,
+                                           :scope => @scope,
+                                           :state => @state,
+                                           :code => @code,
+                                           :redirect_uri => @redirect_uri,
+                                           :access_token => @access_token)
+      return self
+    end
+
+
+    ##
+    # 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.
+    #
+    # @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)
+      return self.fetch(options)
+    end
+
+
+    ##
+    # Used to upload a file or files within a folder to a destination folder within
+    # a CDN Connect app. This method requires either a CDN Connect URL, or both an app_id
+    # and obj_id. If you are uploading many files be sure to use the same client instance.
+    #
+    # @param [Hash] options
+    #   The configuration parameters for the client.
+    #   - <code>:destination_folder_url</code> -
+    #     The URL of the folder to upload to. If the destination folder 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 app to upload to. 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 folder to upload to. If the app_id or obj_id options 
+    #     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.
+    def upload(options={})
+      # Make sure we've got good data before starting the upload
+      prepare_upload(options)
+
+      i = 1
+      begin
+
+        # Check if we have a prefetched upload url before requesting a new one
+        upload_url = get_prefetched_upload_url(options[:destination_folder_url], 
+                                               options[:app_id], 
+                                               options[:obj_id])
+        if upload_url == nil
+          # We do not already have an upload url created. The first upload request
+          # will need to make a request for an upload url. After the first upload
+          # each upload response will also include a new upload url which can be used 
+          # for the next upload when uploading to the same folder.
+          upload_url_response = self.get_upload_url(options)
+          if upload_url_response.is_error
+            return upload_url_response
+          end
+          upload_url = upload_url_response.get_result('upload_url')
+        end
+
+        # Create the POST data that gets sent in the request
+        post_data = {}
+        post_data[:create_upload_url] = 'true' # have the API also create the next upload url
+        post_data[:file] = Faraday::UploadIO.new(options[:source_file_local_path], options[:mime_type])
+
+        # Build the request to the API
+        conn = Faraday.new() do |req|
+          # https://github.com/lostisland/faraday
+          req.headers['User-Agent'] = @@user_agent
+          req.headers['Authorization'] = 'Bearer ' + @access_token
+          req.request :multipart
+          req.adapter :net_http
+        end
+
+        # Kick it off!
+        api_response = conn.post upload_url, post_data
+
+        # Woot! Convert the response to our model and see what's up
+        response = APIResponse.new(api_response)
+
+        # an upload response also contains a new upload url. Save it for the next upload.
+        set_prefetched_upload_url(options[:destination_folder_url], 
+                                  options[:app_id], 
+                                  options[:obj_id],
+                                  response.get_result('upload_url'))
+
+        # Rettempt the upload a max of two times if there was a server error
+        # Otherwise return the response data
+        if not response.is_server_error or i > 2
+          return response
+        end
+        i += 1
+      end while i <= 3
+      
+    end
+
+
+    ##
+    # This method should not be called directly, but is used by the upload method
+    # to get the options all ready to go and validated before uploading a file(s).
+    # @!visibility private
+    def prepare_upload(options={})
+      # Validate we've got a source file
+      source_file_local_path = options[:source_file_local_path]
+      if source_file_local_path == nil
+        raise ArgumentError, 'source_file_local_path required'
+      end
+
+      # Validate we've got a destination folder to upload to
+      destination_folder_url = options[:destination_folder_url]
+      app_id = options[:app_id]
+      obj_id = options[:obj_id]
+      if destination_folder_url == nil and (app_id == nil or obj_id == nil)
+        raise ArgumentError, 'destination_folder_url or app_id/obj_id required'
+      end      
+
+      # Ideally it'd be awesome to already set what the mime type is, but getting that
+      # info accurately is a pain. If you do not send in the mime_type we will 
+      # figure it out for you by the file extension (so ALWAYS have an extension)
+      # This will only work when using the source_file option, and will not 
+      # work with the source_files or source_folder option.
+      if options[:mime_type] == nil
+        options[:mime_type] = 'application/octet-stream'
+      end
+
+      options
+    end
+
+
+    ##
+    # This method should not be called directly, but is used to check if we
+    # already have an upload url ready to go for the folder we're uploading to.
+    # @!visibility private
+    def get_prefetched_upload_url(destination_url, app_id, obj_id)
+      # Build a unique key for the folder which was used to save an new upload url
+      key = destination_url || ''
+      key += app_id || ''
+      key += obj_id || ''
+      rtn_url = @prefetched_upload_urls[key]
+      @prefetched_upload_urls[key] = nil
+      return rtn_url
+    end
+
+
+    ##
+    # This method should not be called directly, but is used to remember an upload url 
+    # for the next upload to this folder.
+    # @!visibility private
+    def set_prefetched_upload_url(destination_url, app_id, obj_id, upload_url)
+      # Build a unique key for the folder to save an new upload url value to
+      key = destination_url || ''
+      key += app_id || ''
+      key += obj_id || ''
+      @prefetched_upload_urls[key] = upload_url
+    end
+
+
+    ##
+    # An upload url must be optained first before uploading a file. After the first
+    # upload url is received, all upload responses contain another upload which can be
+    # used to eliminate the need to do seperate requests for an upload url.
+    # @!visibility private
+    def get_upload_url(options={})
+      destination_folder_url = options[:destination_folder_url]
+
+      path = nil
+      if destination_folder_url != nil
+        path = '/v1/' + destination_folder_url + '/upload'
+      else
+        path = generate_obj_path(options) + '/upload'
+      end
+
+      i = 1
+      begin
+        response = self.fetch(:path => path)
+        if not response.is_server_error or i > 2
+          return response
+        end
+        i += 1
+      end while i <= 3
+    end
+
+
+    ##
+    # This method should not be called directly, but is used to build the api
+    # path common needed by a few methods.
+    # @!visibility private
+    def generate_obj_path(options={})
+      app_id = options[:app_id]
+      obj_id = options[:obj_id]
+      uri = options[:uri] || options[:url]
+      path = nil
+
+      # An object's path can either be made up of an app_id and an obj_id
+      # Or it can be made up of the entire URI
+      if app_id != nil and obj_id != nil
+        path = 'apps/' + app_id + '/objects/' + obj_id
+      elsif uri != nil
+        path = uri
+      end
+
+      if path == nil
+        raise ArgumentError, "missing url or both app_id and obj_id"
+      end
+
+      return '/v1/' + path
+    end
+
+
+    ##
+    # This method should not be called directly, but is used to validate data
+    # and make it all pretty before firing off the request to the API.
+    # @!visibility private
+    def prepare(options={})
+      if options[:path] == nil
+        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[:url] = options[:uri]
+      options[:method] = options[:method] || 'GET'
+
+      return options
+    end
+
+
+    ##
+    # Guts of an authorized request. Do not call this directly.
+    # @!visibility private
+    def fetch(options={})
+      # Prepare the data to be shipped in the request
+      options = self.prepare(options)
+
+      begin
+        # Send the request and get the response
+        response = @client.fetch_protected_resource(options)
+
+        # Return the API response
+        return APIResponse.new(response)
+      rescue Signet::AuthorizationError => detail
+        return APIResponse.new(detail.response)
+      end
+
+    end
+
+
+    def client_id
+      @client_id
+    end
+
+    def client_secret
+      @client_secret
+    end
+
+    def scope
+      @scope
+    end
+
+    def state
+      @state
+    end
+
+    def code
+      @code
+    end
+
+    def redirect_uri
+      @redirect_uri
+    end
+
+    def access_token
+      @access_token
+    end
+
+    def response_format
+      @response_format
+    end
+
+  end
+
+end

data/lib/cdnconnect_api/response.rb

@@ -0,0 +1,129 @@
+# Copyright 2013 CDN Connect
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module CDNConnect
+
+  ##
+  # Used to simpilfy things by creating easy to use helper functions to read
+  # response data. Responses from the API are all structured the same way,
+  # and this class is used as a small wrapper to make it easier to get data.
+  class APIResponse
+
+    def initialize(response)
+      @response = response
+      @data = nil
+      return self
+    end
+
+    def body()
+      @response.body
+    end
+
+    def data()
+      # Convert the response body depending on the response format
+      # 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"
+        end
+      end
+      @data
+    end
+
+    def results()
+      # this is just double checking the results data
+      # exists and is built with the correct structure
+      d = data
+      if d.has_key?('results')
+        return d['results']
+      end
+      nil
+    end
+
+    def get_result(key)
+      # A helper method so you don't have to do any nil checking
+      # as you dig through the response results
+      r = results
+      if r != nil
+        return results[key]
+      end
+      nil
+    end
+
+    def msgs()
+      # this is just double checking the msgs data
+      # exists and is built with the correct structure
+      d = data
+      if d.has_key?('msgs')
+        return d['msgs']
+      end
+      nil
+    end
+
+    def format()
+      @response.headers['content-type']
+    end
+
+    def status()
+      @response.status
+    end
+
+    def is_success()
+      (status >= 200 and status < 300)
+    end
+
+    def is_error()
+      (status >= 400)
+    end
+
+    def is_bad_request()
+      (status == 400)
+    end
+
+    def is_unauthorized()
+      (status == 401)
+    end
+
+    def is_forbidden()
+      (status == 403)
+    end
+
+    def is_not_found()
+      (status == 404)
+    end
+
+    def is_method_not_allowed()
+      (status == 405)
+    end
+
+    def is_server_error()
+      (status >= 500)
+    end
+
+    def is_bad_gateway()
+      (status >= 502)
+    end
+
+    def is_service_unavailable()
+      (status >= 503)
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: cdnconnect-api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Adam Bradley
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.6
+- !ruby/object:Gem::Dependency
+  name: signet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+description: CDN Connect API Ruby Client which makes it easier to interact with api.cdnconnect.com.
+email: developer@cdnconnect.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+files:
+- lib/cdnconnect_api.rb
+- lib/cdnconnect_api/response.rb
+- LICENSE
+- README.md
+homepage: http://www.cdnconnect.com/
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.0
+signing_key: 
+specification_version: 4
+summary: Package Summary
+test_files: []
+has_rdoc: