skydrive 0.0.1 → 0.0.2

data/README.md

@@ -1,6 +1,6 @@
 # Skydrive
 
-TODO: Write a gem description
+Simple client library for Microsoft Skydrive API with OAuth2 authentication
 
 ## Installation
 

data/lib/skydrive/album.rb

@@ -1,6 +1,6 @@
 module Skydrive
   # A user's album in SkyDrive
-  class Album < Skydrive::Object
+  class Album < Skydrive::Folder
 
     # The total number of items in the album.
     # @return [Integer]

data/lib/skydrive/audio.rb

@@ -1,6 +1,6 @@
 module Skydrive
   # A user's audio file in SkyDrive.
-  class Audio < Skydrive::Object
+  class Audio < Skydrive::File
 
     # The size, in bytes, of the audio
     # @return [Integer]
@@ -20,12 +20,6 @@ module Skydrive
       object["comments_enabled"]
     end
 
-    # A value that indicates whether this audio can be embedded
-    # @return [Boolean]
-    def is_embeddable
-      object["is_embeddable"]
-    end
-
     # The URL to use to download the audio from SkyDrive
     # @return [String]
     def source
@@ -74,5 +68,18 @@ module Skydrive
       object["picture"]
     end
 
+    # The link that can be used to download the audio file
+    # @return [String]
+    def download_link
+      url = client.get("/#{id}/content", :download => true, :suppress_redirects => true)["location"]
+    end
+
+    # Download the audio file
+    def download
+      uri = URI(download_link)
+      response = HTTParty.get("http://#{uri.host}#{uri.path}?#{uri.query}")
+      response.parsed_response
+    end
+
   end
 end

data/lib/skydrive/client.rb

@@ -72,6 +72,8 @@ module Skydrive
           raise Skydrive::Error.new(filtered_response["error"]) if filtered_response["error"]
           if filtered_response["data"]
             return Skydrive::Collection.new(self, filtered_response["data"])
+          elsif filtered_response["location"]
+            return filtered_response
           elsif filtered_response["id"].match /^comment\..+/
             return Skydrive::Comment.new(self, filtered_response)
           else
@@ -83,8 +85,6 @@ module Skydrive
       else
         raise Skydrive::Error.new("code" => "http_error_#{response.response.code}", "message" => response.response.message)
       end
-      
-      
     end
 
   end

data/lib/skydrive/file.rb

@@ -20,16 +20,24 @@ module Skydrive
       object["comments_enabled"]
     end
 
-    # A value that indicates whether this file can be embedded
-    # @return [Boolean]
-    def is_embeddable
-      object["is_embeddable"]
-    end
-
     # The URL to use to download the file from SkyDrive
     # @return [String]
     def source
       object["source"]
     end
+
+    # The link that can be used to download the file
+    # @return [String]
+    def download_link
+      url = client.get("/#{id}/content", :download => true, :suppress_redirects => true)["location"]
+    end
+
+    # Download the file
+    def download
+      uri = URI(download_link)
+      response = HTTParty.get("http://#{uri.host}#{uri.path}?#{uri.query}")
+      response.parsed_response
+    end
+
   end
 end

data/lib/skydrive/folder.rb

@@ -3,11 +3,50 @@ module Skydrive
   class Folder < Skydrive::Object
     
     # Items in the folder
+    # @param [Hash] options Additional parameters
+    # @option options [Integer] :limit the maximum number of results to return
+    # @option options [Integer] :offset the index of the first item to get
+    # @option options [String] :sort_by set the item's sort criteria. Can be 'created, updated, name, size, or default'
+    # @option options [String] :sort_order set the item's sort order. Can be 'ascending or descending'
     # @return [Skydrive::Collection]
-    def files
+    def files options={}
       response = client.get("/#{id}/files")
     end
 
-    
+    # Get all the photos in the folder
+    # @param [Hash] options Additional parameters
+    # @option options [Integer] :limit the maximum number of results to return
+    # @option options [Integer] :offset the index of the first item to get
+    # @option options [String] :sort_by set the item's sort criteria. Can be 'created, updated, name, size, or default'
+    # @option options [String] :sort_order set the item's sort order. Can be 'ascending or descending'
+    # @return [Skydrive::Collection]
+    def photos options={}
+      response = client.get("/#{id}/photos", options)
+    end
+
+    # Get all the videos in the folder
+    # @param [Hash] options Additional parameters
+    # @option options [Integer] :limit the maximum number of results to return
+    # @option options [Integer] :offset the index of the first item to get
+    # @option options [String] :sort_by set the item's sort criteria. Can be 'created, updated, name, size, or default'
+    # @option options [String] :sort_order set the item's sort order. Can be 'ascending or descending'
+    # @return [Skydrive::Collection]
+    def videos options={}
+      response = client.get("/#{id}/videos", options)
+    end
+
+    # Delete the folder
+    def delete
+      client.delete("/#{id}")
+    end
+
+    # Update the folder properties
+    # @param [Hash] options
+    # @option options [String] :name New name of the folder
+    # @option options [String] :description Description for the folder
+    # @return [Skydrive::Folder] the updated folder object
+    def update options={}
+      client.put("/#{id}", options)
+    end
   end
 end

data/lib/skydrive/notebook.rb

@@ -1,5 +1,6 @@
 module Skydrive
   # The notebook object 
   class Notebook < Skydrive::File
+    
   end
 end

data/lib/skydrive/object.rb

@@ -90,5 +90,11 @@ module Skydrive
       client.delete("/#{id}")
     end 
 
+    # A value that indicates whether this object can be embedded
+    # @return [Boolean]
+    def is_embeddable?
+      object["is_embeddable"]
+    end
+
   end
 end

data/lib/skydrive/operations.rb

@@ -8,56 +8,134 @@ module Skydrive
       response = get("/me/skydrive")
     end
 
+    # Get the home folder of a particular user
+    # @param [String] user_id ID of the user
+    # @return [Skydrive::Folder]
+    def user_skydrive user_id
+      response = get("/#{user_id}/skydrive")
+    end
+
     # Your camera_roll folder
     # @return [Skydrive::Folder]
     def my_camera_roll
       response = get("/me/skydrive/camera_roll")
     end
 
+    # Get the camera_roll folder of a particular user
+    # @param [String] user_id ID of the user
+    # @return [Skydrive::Folder]
+    def user_camera_roll user_id
+      response = get("/#{user_id}/camera_roll")
+    end
+
     # Your documents
     # @return [Skydrive::Folder]
     def my_documents
       response = get("/me/skydrive/my_documents")
     end
 
+    # User's documents
+    # @param [String] user_id ID of the user
+    # @return [Skydrive::Folder]
+    def user_documents user_id
+      response = get("/#{user_id}/skydrive/my_documents")
+    end
+
     # Your default album
-    # @return [Skydrive::Photos]
+    # @return [Skydrive::Album]
     def my_photos
       response = get("/me/skydrive/my_photos")
     end
 
+    # User's photos
+    # @param [String] user_id ID of the user
+    # @return [Skydrive::Folder]
+    def user_photos user_id
+      response = get("/#{user_id}/skydrive/my_photos")
+    end
+
     # Your public documents
     # @return [Skydrive::Folder]
     def my_public_documents
       response = get("/me/skydrive/public_documents")
     end
 
+    # User's public documents
+    # @param [String] user_id ID of the user
+    # @return [Skydrive::Folder]
+    def user_public_documents user_id
+      response = get("/#{user_id}/skydrive/public_documents")
+    end
+
     # Your shared items
     # @return [Skydrive::Collection]
     def my_shared_stuff
       response = get("/me/skydrive/shared")
     end
 
+    # User's shared items
+    # @return [Skydrive::Collection]
+    def user_shared_stuff
+      response = get("/#{id}/skydrive/shared")
+    end
+
     # Your recent documents
+    # @param [String] user_id ID of the user
     # @return [Skydrive::Collection]
-    def recent_documents
+    def my_recent_documents
       response = get("/me/skydrive/recent_docs")
     end
 
+    # User's recent documents
+    # @param [String] user_id ID of the user
+    # @return [Skydrive::Collection]
+    def user_recent_documents user_id
+      response = get("/#{user_id}/skydrive/recent_docs")
+    end
+
     # Your total and remaining storage quota
     # @return [Hash] contains keys quota and available
-    def storage_quota
+    def my_storage_quota
+      response = get("/me/skydrive/quota")
+    end
+
+    # User's total and remaining storage quota
+    # @return [Hash] contains keys quota and available
+    def user_storage_quota
       response = get("/me/skydrive/quota")
     end
 
     # Delete an object with given id
-    def delete_object object_id
+    # @param [String] object_id the id of the object to be deleted
+    def delete_skydrive_object object_id
       response = delete("/#{object_id}")
     end
 
+    # Update a skydrive object
+    # @param [String] object_id the id of the object to be updated
+    # @param [Hash] options The properties to be updated
+    # @option options [String] :name The friendly name of the object
+    # @option options [String] :description The description text about the object
+    def update_skydrive_object object_id, options={}
+      response = put("/#{object_id}", options)
+    end
+
+    alias :update_folder :update_skydrive_object
+    alias :update_album :update_skydrive_object
+    alias :update_file :update_skydrive_object
+    alias :update_video :update_skydrive_object
+    alias :update_audio :update_skydrive_object
+    alias :update_photo :update_skydrive_object
+
+    alias :delete_folder :delete_skydrive_object
+    alias :delete_album :delete_skydrive_object
+    alias :delete_file :delete_skydrive_object
+    alias :delete_video :delete_skydrive_object
+    alias :delete_audio :delete_skydrive_object
+    alias :delete_photo :delete_skydrive_object
     # Create a new folder
     # @param [String] path the path where the new folder should be created
-    # @param [Hash] options the additional parameters to be passed
+    # @param [Hash] options the details of the new folder
     # @option options [String] :name required, the name of the new folder
     # @option options [String] :description the description about the folder
     # @return [Skydrive::Folder] the new folder
@@ -65,5 +143,14 @@ module Skydrive
       response = post("/#{path}", options)
     end
 
+    # Create a new album. Albums can only be created in the path '/me/albums', so no need to pass the path as a parameter
+    # @param [Hash] options the details of the new album
+    # @option options [String] :name required, the name of the new album
+    # @option options [String] :description the description about the album
+    # @return [Skydrive::Album] the new album
+    def create_album options={}
+      response = post("/me/albums", options)
+    end
+
   end
 end

data/lib/skydrive/photo.rb

@@ -1,5 +1,17 @@
 module Skydrive
   # A user's photo in SkyDrive.
-  class Photo < Skydrive::Object
+  class Photo < Skydrive::File
+    # The link that can be used to download the photo
+    # @return [String]
+    def download_link
+      url = client.get("/#{id}/content", :download => true, :suppress_redirects => true)["location"]
+    end
+
+    # Download the photo
+    def download
+      uri = URI(download_link)
+      response = HTTParty.get("http://#{uri.host}#{uri.path}?#{uri.query}")
+      response.parsed_response
+    end
   end
 end

data/lib/skydrive/user.rb

@@ -20,7 +20,7 @@ module Skydrive
     end
 
     # User's default album
-    # @return [Skydrive::Photos]
+    # @return [Skydrive::Album]
     def photos
       response = get("/#{id}/skydrive/my_photos")
     end

data/lib/skydrive/version.rb

@@ -1,5 +1,5 @@
 # Skydrive base module
 module Skydrive
   # The gem version
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/skydrive/video.rb

@@ -1,5 +1,17 @@
 module Skydrive
   # A user's video in SkyDrive.
-  class Video < Skydrive::Object
+  class Video < Skydrive::File
+    # The link that can be used to download the video file
+    # @return [String]
+    def download_link
+      url = client.get("/#{id}/content", :download => true, :suppress_redirects => true)["location"]
+    end
+
+    # Download the video file
+    def download
+      uri = URI(download_link)
+      response = HTTParty.get("http://#{uri.host}#{uri.path}?#{uri.query}")
+      response.parsed_response
+    end
   end
 end

data/skydrive.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.name          = "skydrive"
   gem.require_paths = ["lib"]
   gem.version       = Skydrive::VERSION
-  gem.add_dependency 'httparty', '>= 0.10.2'
+  gem.add_dependency 'httparty', '>= 0.11.0'
   gem.add_dependency 'activesupport'
   gem.add_dependency 'httmultiparty'
   gem.add_dependency 'oauth2'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skydrive
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-29 00:00:00.000000000 Z
+date: 2013-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.10.2
+        version: 0.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.10.2
+        version: 0.11.0
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement