cdnconnect-api 0.3.3 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e14f403c44ad1b4147938d544ee7a9f174eaa683
-  data.tar.gz: a1338d951826739fcd1de0bd9696b87f58a279a2
+  metadata.gz: f95d221d91731fe7d4e5a692ab98022967568902
+  data.tar.gz: 9dda2004ac29c4c96c5c35e1592086b937bf9f60
 SHA512:
-  metadata.gz: 6ec0d3fe81b41b31d76bea214e7f9586e009b704b3a10534095503154958b44163e8ac129f0d9f21326b8ca4de35c76d1e08d563d62b7e6a7ce6bbdc6527d782
-  data.tar.gz: c4c79851fa5b7540e992111a26a9d35a0a1da8fbd9294f7d39c9d54558742e456c2c1bf68bca626a95098795d330affba2852354202c968351b7cdcd43e9d526
+  metadata.gz: 0054b88586c70b771227ba87abaf86f5bd79d7c53b2eed6cdee8d4ca3029dde8322859428b2a83360dcac5b6d342db04ec7613e3421b423866f1ecb93d695070
+  data.tar.gz: fb945dba898215fe1b5ed8738fc92a6c2a3ef1ab5acb6bbb92e23d626df76d9b4a6ed5edd1784c19a6ed64a15fa359d332b7b709ff4d09e5b9149ef31b7bbe02

data/README.md

@@ -1,4 +1,4 @@
-# CDN Connect API Ruby Client, v0.3.3
+# CDN Connect API Ruby Client, v0.4.0
 
 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.
 

data/lib/cdnconnect_api.rb

@@ -25,7 +25,7 @@ module CDNConnect
   class APIClient
   
     @@application_name = 'cdnconnect-api-ruby'
-    @@application_version = '0.3.3'
+    @@application_version = '0.4.0'
     @@user_agent = @@application_name + ' v' + @@application_version
     @@api_host = 'https://api.cdnconnect.com'
     @@api_version = 'v1'
@@ -172,7 +172,11 @@ module CDNConnect
     #     or `xml`. The defautl format is `json`.
     #
     # @return [APIResponse] A response object with helper methods to read the response.
-    def upload(options={})
+    def upload(options)
+        if options[:app_host] == nil
+            options[:app_host] = @app_host
+        end
+
         # Make sure we've got good source data before starting the upload
         prepare_upload(options)
 
@@ -200,7 +204,7 @@ module CDNConnect
                 # 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(destination_path)
+                upload_url_response = self.get_upload_url(options, destination_path)
                 if upload_url_response.is_error
                     return upload_url_response
                 end
@@ -530,7 +534,7 @@ module CDNConnect
     # 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={})
+    def prepare_upload(options)
 
       # Check if we've got valid source files
       if options[:source_folder_path] != nil
@@ -600,18 +604,18 @@ module CDNConnect
     # 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(destination_path)
+    def get_upload_url(options, destination_path)
         if destination_path == "/"
             destination_path = ""
         end
         upload_id = ((9_999_999 - 1_000_000) * rand + 1_000_000).to_i
-        api_path = "#{destination_path}/upload-#{upload_id}.json"
+        path = "/#{options[:app_host]}#{destination_path}/upload-#{upload_id}.json"
 
-        @logger.debug("get_upload_url: #{api_path}")
+        @logger.debug("get_upload_url: #{path}")
 
         i = 1
         begin
-            response = get(api_path)
+            response = get(path)
             if not response.is_server_error
                 return response
             elsif i > 2
@@ -637,8 +641,11 @@ module CDNConnect
     #     True or false value indicating if a folder's response should contain
     #     its sub-folders or not. Default is false.
     # @return [APIResponse] A response object with helper methods to read the response.
-    def get_object(options={})
-        api_path = options[:path] + '.json'
+    def get_object(options)
+        if options[:app_host] == nil
+            options[:app_host] = @app_host
+        end
+        path = "/#{options[:app_host]}#{options[:path]}.json"
         data = {}
         if options[:files] == true
             data[:files] = true
@@ -646,7 +653,7 @@ module CDNConnect
         if options[:folders] == true
             data[:folders] = true
         end
-        get(api_path, data)
+        get(path, data)
     end
 
     
@@ -659,10 +666,13 @@ module CDNConnect
     #   - <code>:new_name</code> -
     #     The new filename or folder name for the object. (required)
     # @return [APIResponse] A response object with helper methods to read the response.
-    def rename_object(options={})
-        api_path = options[:path] + '/rename.json'
+    def rename_object(options)
+        if options[:app_host] == nil
+            options[:app_host] = @app_host
+        end
+        path = "/#{options[:app_host]}#{options[:path]}/rename.json"
         data = { :new_name => options[:new_name] }
-        put(api_path, data)
+        put(path, data)
     end
 
     
@@ -673,9 +683,12 @@ module CDNConnect
     #   - <code>:path</code> -
     #     The path to the CDN Connect object to delete. (required)
     # @return [APIResponse] A response object with helper methods to read the response.
-    def delete_object(options={})
-        api_path = options[:path] + '.json'
-        delete(api_path)
+    def delete_object(options)
+        if options[:app_host] == nil
+            options[:app_host] = @app_host
+        end
+        path = "/#{options[:app_host]}#{options[:path]}.json"
+        delete(path)
     end
 
     
@@ -684,9 +697,33 @@ module CDNConnect
     # already exist they will be created.
     #
     # @return [APIResponse] A response object with helper methods to read the response.
-    def create_path(options={})
-        api_path = options[:path] + '/create-path.json'
-        get(api_path)
+    def create_path(options)
+        if options[:app_host] == nil
+            options[:app_host] = @app_host
+        end
+        path = "/#{options[:app_host]}#{options[:path]}/create-path.json"
+        get(path)
+    end
+
+    
+    ##
+    # Create a new CDN Connect app. The creator of the app will be the 
+    # same user as the creator of the API Key for the request.
+    #
+    # @param [Hash] options
+    #   The configuration parameters for the client.
+    #   - <code>:subdomain</code> -
+    #     This new app's subdomain to the "cdnconnect.com" domain.
+    #   - <code>:label</code> -
+    #     The label for this new app.
+    #
+    # @return [APIResponse] A response object with helper methods to read the response.
+    def create_app(options)
+        path = '/apps.json'
+        data = {}
+        data[:subdomain] = options[:subdomain]
+        data[:label] = options[:label]
+        post(path, data)
     end
     
 
@@ -694,11 +731,11 @@ module CDNConnect
     # Executes a GET request to an API URL and returns a response object.
     # GET requests are used when reading data.
     #
-    # @param api_path [String] The API path to send the GET request to.
+    # @param path [String] The API path to send the GET request to.
     # @param data [Hash] Data which will be placed in the GET request's querystring. (Optional)
     # @return [APIResponse] A response object with helper methods to read the response.
-    def get(api_path, data={})
-        fetch(:api_path => api_path, :method => 'GET', :data => data)
+    def get(path, data={})
+        fetch(:path => path, :method => 'GET', :data => data)
     end
 
 
@@ -706,11 +743,11 @@ module CDNConnect
     # Executes a POST request to an API URL and returns a response object. 
     # POST requests are used when creating data.
     #
-    # @param api_path [String] The API path to send the POST request to.
+    # @param path [String] The API path to send the POST request to.
     # @param data [Hash] Data which will be sent in the POST request.
     # @return [APIResponse] A response object with helper methods to read the response.
-    def post(api_path, data)
-        fetch(:api_path => api_path, :method => 'POST', :data => data)
+    def post(path, data)
+        fetch(:path => path, :method => 'POST', :data => data)
     end
 
 
@@ -718,11 +755,11 @@ module CDNConnect
     # Executes a PUT request to an API URL and returns a response object.
     # PUT requests are used when updating data.
     #
-    # @param api_path [String] The API path to send the PUT request to.
+    # @param path [String] The API path to send the PUT request to.
     # @param data [Hash] Data which will be sent in the PUT request.
     # @return [APIResponse] A response object with helper methods to read the response.
-    def put(api_path, data)
-        fetch(:api_path => api_path, :method => 'PUT', :data => data)
+    def put(path, data)
+        fetch(:path => path, :method => 'PUT', :data => data)
     end
 
 
@@ -730,24 +767,24 @@ 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 api_path [String] The API path to send the 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(api_path)
-        fetch(:api_path => api_path, :method => 'DELETE')
+    def delete(path)
+        fetch(:path => path, :method => 'DELETE')
     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[:api_path] == nil
-            raise ArgumentError, 'missing api path'
+    def prepare(options)
+        if options[:path] == nil
+            raise ArgumentError, 'missing path'
         end
 
         options[:headers] = { 'User-Agent' => @@user_agent }
-        options[:uri] = "#{@@api_host}/#{@@api_version}/#{@app_host}#{options[:api_path]}"
+        options[:uri] = "#{@@api_host}/#{@@api_version}#{options[:path]}"
 
         options[:method] = options[:method] || 'GET'
 
@@ -768,7 +805,7 @@ module CDNConnect
     ##
     # Guts of an authorized request. Do not call this directly.
     # @!visibility private
-    def fetch(options={})
+    def fetch(options)
         # Prepare the data to be shipped in the request
         options = prepare(options)
 

data/lib/cdnconnect_api/response.rb

@@ -30,8 +30,8 @@ module CDNConnect
         @data = nil
         @body = nil
       else
-        @status = 0
-        @data = {"results" => {}, "msgs" => []}
+        @status = 503
+        @data = { "results" => {}, "msgs" => [{"text" => "http_response was nil", "status" => "error"}] }
         @body = nil
       end
       return self

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cdnconnect-api
 version: !ruby/object:Gem::Version
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors:
 - Adam Bradley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-24 00:00:00.000000000 Z
+date: 2013-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday