skydrive 0.0.2 → 0.1.0

data/README.md

@@ -16,9 +16,54 @@ Or install it yourself as:
 
     $ gem install skydrive
 
+## Initial steps
+
+### OAuth2 Authentication
+
+  Skydrive uses OAuth2 authentication. First you will have to initialize a Skydrive::Oauth::Client object with the client id, client secret, callback url and scopes [(explained here)](http://msdn.microsoft.com/en-us/library/live/hh243646.aspx)
+
+    oauth_client = Skydrive::Oauth::Client.new("your_client_id", "your_client_secret", "http://yourcallbackurl", "wl.skydrive_update,wl.offline_access")
+
+  Obtain the authentication url
+
+    auth_url = oauth_client.authorize_url
+
+  Redirect the user to the above obtained auth_url. After user gives access to your app, they will be redirected to the callback url with a 'code' parameter. Extract this code and get the access token by invoking the following method
+
+    access_token = oauth_client.get_access_token("the_extracted_code")
+
+  If you have already stored the access_token details somewhere, you can instantiate the access token without having to authorize again. But this might require you to store the refresh token(if scope 'wl.offline_access' has been requested) as well.
+
+    access_token = oauth_client..get_access_token_from_hash("access_token", {:refresh_token => "refresh_token", :expires_at => 1234567})
+
+
+### Instantiate a client
+
+  After getting the access token instantiate the Skydrive client
+
+    client = Skydrive::Client.new(:access_token => access_token)
+
 ## Usage
 
-TODO: Write usage instructions here
+### Get the user's home folder
+
+  To get the details about the acting user's home folder
+    folder = client.my_skydrive
+
+  This returns a Skydrive::Folder object.
+
+  Please refer to the documentation for full details about the operations
+
+## Features
+
+1. Every thing is an object. For eg: Skydrive::Folder, Skydrive::File
+2. I have introduced a new object Skydrive::Collection when the result contains multiple type objects
+3. Downloading files have been enabled
+
+## Todo
+
+1. File upload
+2. More specs
 
 ## Contributing
 

data/lib/skydrive/comment.rb

@@ -7,9 +7,15 @@ module Skydrive
       object["message"]
     end
 
+    # Always return 'comment'
+    # @return [String]
     def type
       "comment"
     end
 
+    # Delete the comment
+    def delete
+      client.delete("/#{id}")
+    end
   end
 end

data/lib/skydrive/folder.rb

@@ -1,7 +1,7 @@
 module Skydrive
   # The folder object
   class Folder < Skydrive::Object
-    
+
     # Items in the folder
     # @param [Hash] options Additional parameters
     # @option options [Integer] :limit the maximum number of results to return

data/lib/skydrive/object.rb

@@ -96,5 +96,17 @@ module Skydrive
       object["is_embeddable"]
     end
 
+    # Comments associated with the object
+    # @return [Skydrive::Collection]
+    def comments
+      client.get("/#{id}/comments")
+    end
+
+    # Make a comment about the object
+    # @params [Hash] options
+    # @option options [String] :message The comment 
+    def comment options={}
+      client.post("/#{id}/comments", options)
+    end
   end
 end

data/lib/skydrive/operations.rb

@@ -120,6 +120,7 @@ module Skydrive
       response = put("/#{object_id}", options)
     end
 
+
     alias :update_folder :update_skydrive_object
     alias :update_album :update_skydrive_object
     alias :update_file :update_skydrive_object
@@ -152,5 +153,26 @@ module Skydrive
       response = post("/me/albums", options)
     end
 
+    # Get comments associated with an object
+    # @param [String] object_id The ID of the object
+    # @return [Skydrive::Collection]
+    def object_comments object_id
+      response = get("/#{object_id}/comments")
+    end
+
+    # Delete a comment
+    # @param [String] comment_id TD od the comment
+    def delete_comment comment_id
+      response = delete("/#{comment_id}")
+    end
+
+    # Comment about an object
+    # @param [String] object_id ID of the object
+    # @param [Hash] options
+    # @options options [String] :message The comment message
+    def create_comment object_id, options={}
+      response = post("/#{object_id}/comments", options)
+    end
+
   end
 end

data/lib/skydrive/tag.rb

@@ -0,0 +1,17 @@
+module Skydrive
+  # Contains info about tags that are associated with a photo or a video on SkyDrive
+  class Tag < Skydrive::Object
+
+    # The center of the tag's horizontal position, measured as a floating-point percentage from 0 to 100, from the left edge of the photo
+    # @return [Integer]
+    def x
+      object["x"]
+    end
+
+    # The center of the tag's vertical position, measured as a floating-point percentage from 0 to 100, from the top edge of the photo
+    def y
+      object["y"]
+    end
+
+  end
+end

data/lib/skydrive/version.rb

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

data/spec/skydrive/oauth/client_spec.rb

@@ -7,7 +7,7 @@ describe Skydrive::Oauth::Client do
       @uri = URI.parse(subject.authorize_url)
       @uri_params = CGI.parse(@uri.query)
     end
-    
+
     it "should have the correct request token path" do
       @uri.path.should == "/oauth20_authorize.srf"
     end
@@ -31,15 +31,15 @@ describe Skydrive::Oauth::Client do
           "code"          =>  "code",
           "grant_type"    =>  "authorization_code",
           "redirect_uri"  =>  "http://callback_demo"
-        }, 
+        },
         :headers  => {
           'Accept'        =>  '*/*',
           'Content-Type'  =>  'application/x-www-form-urlencoded',
-          'User-Agent'    =>  'Ruby'
+          'User-Agent'    =>  'Faraday v0.8.7'
         }
       ).to_return(
         :status   => 200, :body => {
-          "token_type"            =>  "bearer", 
+          "token_type"            =>  "bearer",
           "expires_in"            =>  3600,
           "scope"                 =>  "wl.skydrive_update,wl.offline_access",
           "access_token"          =>  "access_token",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skydrive
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-02 00:00:00.000000000 Z
+date: 2013-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -311,6 +311,7 @@ files:
 - lib/skydrive/object.rb
 - lib/skydrive/operations.rb
 - lib/skydrive/photo.rb
+- lib/skydrive/tag.rb
 - lib/skydrive/user.rb
 - lib/skydrive/version.rb
 - lib/skydrive/video.rb