skydrive 0.0.1

data/lib/skydrive/notebook.rb

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

data/lib/skydrive/oauth/client.rb

@@ -0,0 +1,54 @@
+require 'oauth2'
+module Skydrive
+  # Oauth module
+  module Oauth
+    # Oauth client class
+    class Client
+      attr_accessor :client_id, :client_secret, :oauth_client, :callback_url, :access_token, :scope
+      def initialize(client_id, client_secret, callback_url, scope, opts={})
+        @client_id = client_id
+        @client_secret = client_secret
+        @callback_url = callback_url
+        @scope = scope
+        ssl = opts.delete(:ssl)
+
+        @options = {
+                    :site => 'https://login.live.com/',
+                    :authorize_url => "oauth20_authorize.srf?response_type=code&scope=#{scope}",
+                    :token_url => 'oauth20_token.srf',
+                    :parse_json => true}.merge(opts)
+        @options[:connection_opts][:ssl] = ssl if ssl
+        @oauth_client = OAuth2::Client.new(client_id, client_secret, @options)
+      end
+
+      # Step 1: URL for OAuth2 authorization of Microsoft Live
+      # @return [String]
+      def authorize_url
+        oauth_client.auth_code.authorize_url(:redirect_uri => callback_url)
+      end
+
+      # Step 2: Get access token after authorizing user
+      # @param [String] code The value extracted from the callback url param 'code'
+      # @return [OAuth2::AccessToken] the access token
+      def get_access_token code
+        @access_token = oauth_client.auth_code.get_token(code, :redirect_uri => callback_url)
+      end
+      
+      # Alternate Step2: Make an access token from already available data
+      # @param [String] token the Access Token value
+      # @param [Hash] opts the options to create the Access Token with
+      # @option opts [String] :refresh_token (nil) the refresh_token value
+      # @option opts [FixNum, String] :expires_in (nil) the number of seconds in which the AccessToken will expire
+      # @option opts [FixNum, String] :expires_at (nil) the epoch time in seconds in which AccessToken will expire
+      # @option opts [Symbol] :mode (:header) the transmission mode of the Access Token parameter value
+      # one of :header, :body or :query
+      # @option opts [String] :header_format ('Bearer %s') the string format to use for the Authorization header
+      # @option opts [String] :param_name ('access_token') the parameter name to use for transmission of the Access Token value in :body or :query transmission mode
+      # @return [OAuth2::AccessToken] the access token
+      def get_access_token_from_hash token, opts={}
+        @access_token = OAuth2::AccessToken.new(@oauth_client, token, opts)
+      end
+
+    end
+  end
+end

data/lib/skydrive/object.rb

@@ -0,0 +1,94 @@
+module Skydrive
+  # The base class for all objects
+  class Object
+    attr_reader :client, :object
+    def initialize client, data
+      @client = client
+      @object = data
+    end
+
+    # ID of the object
+    # @return [String] object id
+    def id
+      object["id"]
+    end
+
+    # Info about the user who uploaded the file.
+    # @return [Skydrive::User]
+    def from
+      Skydrive::User.new(client,  object["from"]) if object["from"]
+    end
+
+    # Name of the object
+    # @return [String]
+    def name
+      object["name"]
+    end
+
+    # Desciption of the object
+    # @return [String]
+    def description
+      object["description"]
+    end
+
+    # Type of object
+    # @return [String]
+    def type
+      object["type"]
+    end
+
+    # A URL to view the item on SkyDrive
+    # @return [String]
+    def link
+      object["link"]
+    end
+
+    # The time at which the object was created.
+    # @return [Time]
+    def created_time
+      Time.parse(object["created_time"]) if object["created_time"]
+    end
+
+    # The time at which the object was updated.
+    # @return [Time]
+    def updated_time
+      Time.parse(object["updated_time"]) if object["updated_time"]
+    end
+
+    # The URL to upload file content hosted in SkyDrive.
+    # @return [String]
+    def upload_location
+      object["upload_location"]
+    end
+
+    # The ID of the parent object
+    # @return [String]
+    def parent_id
+      object["parent_id"]
+    end
+
+    # The object that contains permission info.
+    # @return [Hash]
+    def shared_with
+      object["shared_with"]
+    end
+
+    # Get json format object
+    # @return [String]
+    def to_json
+      object.to_json
+    end
+
+    # Get the hash equivalent of the data
+    # @return [Hash]
+    def to_hash
+      object
+    end
+
+    # Delete the object from Skydrive
+    def delete
+      client.delete("/#{id}")
+    end 
+
+  end
+end

data/lib/skydrive/operations.rb

@@ -0,0 +1,69 @@
+module Skydrive
+  # The basic operations
+  module Operations
+
+    # Your home folder
+    # @return [Skydrive::Folder]
+    def my_skydrive
+      response = get("/me/skydrive")
+    end
+
+    # Your camera_roll folder
+    # @return [Skydrive::Folder]
+    def my_camera_roll
+      response = get("/me/skydrive/camera_roll")
+    end
+
+    # Your documents
+    # @return [Skydrive::Folder]
+    def my_documents
+      response = get("/me/skydrive/my_documents")
+    end
+
+    # Your default album
+    # @return [Skydrive::Photos]
+    def my_photos
+      response = get("/me/skydrive/my_photos")
+    end
+
+    # Your public documents
+    # @return [Skydrive::Folder]
+    def my_public_documents
+      response = get("/me/skydrive/public_documents")
+    end
+
+    # Your shared items
+    # @return [Skydrive::Collection]
+    def my_shared_stuff
+      response = get("/me/skydrive/shared")
+    end
+
+    # Your recent documents
+    # @return [Skydrive::Collection]
+    def recent_documents
+      response = get("/me/skydrive/recent_docs")
+    end
+
+    # Your total and remaining storage quota
+    # @return [Hash] contains keys quota and available
+    def storage_quota
+      response = get("/me/skydrive/quota")
+    end
+
+    # Delete an object with given id
+    def delete_object object_id
+      response = delete("/#{object_id}")
+    end
+
+    # 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
+    # @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
+    def create_folder path, options={}
+      response = post("/#{path}", options)
+    end
+
+  end
+end

data/lib/skydrive/photo.rb

@@ -0,0 +1,5 @@
+module Skydrive
+  # A user's photo in SkyDrive.
+  class Photo < Skydrive::Object
+  end
+end

data/lib/skydrive/user.rb

@@ -0,0 +1,53 @@
+module Skydrive
+  # The user object
+  class User < Skydrive::Object
+    # User's home directory
+    # @return [Skydrive::Folder]
+    def skydrive
+      response = get("/#{id}/skydrive")
+    end
+
+    # User's camera_roll folder
+    # @return [Skydrive::Folder]
+    def camera_roll
+      response = get("/#{id}/skydrive/camera_roll")
+    end
+
+    # User's documents
+    # @return [Skydrive::Folder]
+    def documents
+      response = get("/#{id}/skydrive/my_documents")
+    end
+
+    # User's default album
+    # @return [Skydrive::Photos]
+    def photos
+      response = get("/#{id}/skydrive/my_photos")
+    end
+
+    # User's public documents
+    # @return [Skydrive::Folder]
+    def public_documents
+      response = get("/#{id}/skydrive/public_documents")
+    end
+
+    # User's shared items
+    # @return [Skydrive::Collection]
+    def shared_stuff
+      response = get("/#{id}/skydrive/shared")
+    end
+
+    # User's recent documents
+    # @return [Skydrive::Collection]
+    def recent_documents
+      response = get("/#{id}/skydrive/recent_docs")
+    end
+
+    # User's total and remaining storage quota
+    # @return [Hash] contains keys quota and available
+    def storage_quota
+      response = get("/#{id}/skydrive/quota")
+    end
+
+  end
+end

data/lib/skydrive/version.rb

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

data/lib/skydrive/video.rb

@@ -0,0 +1,5 @@
+module Skydrive
+  # A user's video in SkyDrive.
+  class Video < Skydrive::Object
+  end
+end

data/skydrive.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/skydrive/version', __FILE__)
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Rony Varghese"]
+  gem.email         = ["rony@mobme.in"]
+  gem.description   = "Simple ruby client library for Skydrive cloud storage service with OAuth2"
+  gem.summary       = "Ruby client library for Microsoft Skydrive"
+  gem.homepage      = "https://github.com/ronyv89/skydrive"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "skydrive"
+  gem.require_paths = ["lib"]
+  gem.version       = Skydrive::VERSION
+  gem.add_dependency 'httparty', '>= 0.10.2'
+  gem.add_dependency 'activesupport'
+  gem.add_dependency 'httmultiparty'
+  gem.add_dependency 'oauth2'
+  gem.add_development_dependency "rspec"
+  gem.add_development_dependency "rake"
+  gem.add_development_dependency "rb-inotify"
+  gem.add_development_dependency "guard"
+  gem.add_development_dependency "guard-rspec"
+  gem.add_development_dependency "simplecov"
+  gem.add_development_dependency "metric_abc"
+  gem.add_development_dependency "yard"
+  gem.add_development_dependency "ci_reporter"
+  gem.add_development_dependency "simplecov-rcov"
+  gem.add_development_dependency "rdiscount"
+  gem.add_development_dependency "webmock"
+  gem.add_development_dependency "rspec_multi_matchers"
+end

data/spec/skydrive/client_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+require 'active_support/time'
+describe Skydrive::Client do
+
+  let(:oauth_client) { Skydrive::Oauth::Client.new("client_id", "client_secret", "http://callback_demo", "wl.skydrive_update,wl.offline_access")}
+  let(:access_token) { OAuth2::AccessToken.new(oauth_client, "access_token", {:refresh_token => "refresh_token", :expires_at => 1.hour.since(Time.now).to_i}) }
+  subject { Skydrive::Client.new(access_token)}
+
+  describe '#object' do
+    it "should return a collection when there is 'data' key" do
+
+    end
+  end
+end

data/spec/skydrive/collection_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Skydrive::Collection do
+
+  let(:collection) do
+    YAML.load(%{
+    - id: folder.8c8ce076ca27823f.8C8CE076CA27823F!142
+      from:
+        name: Roberto Tamburello
+        id: 8c8ce076ca27823f
+      name: My Sample Folder in Album 1
+      description: ''
+      parent_id: folder.de57f4126ed7e411
+      upload_location: https://apis.live.net/v5.0/folder.de57f4126ed7e411.DE57F4126ED7E411!126/files/
+      is_embeddable: true
+      count: 3
+      link: https://cid-8c8ce076ca27823f.skydrive.live.com/redir.aspx?page=self&resid=8C8CE076CA27823F!142&parid=8C8CE076CA27823F!126&type=5
+      type: folder
+      shared_with:
+        access: Just me
+      created_time: '2011-04-22T00:36:30+0000'
+      updated_time: '2011-04-22T19:18:12+0000'
+    - id: file.22688711f5410e6c.22688711F5410E6C!942
+      from:
+        name: William Flash
+        id: 22688711f5410e6c
+      name: Processing.docx
+      description: 
+      parent_id: folder.22688711f5410e6c.22688711F5410E6C!479
+      size: 12692
+      upload_location: https://apis.live.net/v5.0/file.22688711f5410e6c.22688711F5410E6C!942/content/
+      comments_count: 0
+      comments_enabled: true
+      is_embeddable: false
+      source: http://storage.live.com/s1pEwo9qzyT4_BJZqMNm-aVzgLo-WRsQGzjzFsXjyREuQG5pDYr237vKz3i2pmqFuniYPzsuIZAOCUMB_gdfKCUpLpVcaAMXGrk4T7jOWenRniCv9vex7GWfSvy-XCVBVnU/Processing.docx:Binary
+      link: https://skydrive-df.live.com/redir.aspx?cid=22688711f5410e6c&page=view&resid=22688711F5410E6C!942&parid=22688711F5410E6C!479
+      type: file
+      shared_with:
+        access: Everyone (public)
+      created_time: '2011-10-12T23:18:23+0000'
+      updated_time: '2011-10-12T23:18:23+0000'
+    - id: comment.22688711f5410e6c.22688711f0410e6c!818.22688711F5410E6C!979
+      from:
+        name: Roberto Tamburello
+        id: 8c8ce076ca27823f
+      message: A lighthouse built on some rocks.
+      created_time: '2011-04-21T23:21:28+0000'
+    })
+  end
+
+  subject { Skydrive::Collection.new(skydrive_test_client, collection) }
+  describe "#items" do
+    it "should return an array" do
+      subject.items.should be_a Array
+    end
+
+    it "should return the items in the collection as skydrive objects" do
+      subject.items.should each {|item|
+        item.should be_a Skydrive::Object
+      }
+    end
+
+    it "should resolve objects with no 'type' key in the hash" do
+      subject.items[2].should be_a Skydrive::Comment
+    end
+  end
+
+  describe "#type" do
+    it "should return always return collection" do
+      subject.type.should == "collection"
+    end
+  end
+end

data/spec/skydrive/comment_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Skydrive::Comment do
+
+  let(:comment) do 
+    YAML.load(%{
+      id: comment.22688711f5410e6c.22688711f0410e6c!818.22688711F5410E6C!979
+      from:
+        name: Roberto Tamburello
+        id: 8c8ce076ca27823f
+      message: A lighthouse built on some rocks.
+      created_time: '2011-04-21T23:21:28+0000'
+    })
+  end
+
+  subject {skydrive_test_client}
+
+  before :each do
+    stub_request(:get, "https://apis.live.net/v5.0/comment.22688711f5410e6c.22688711f0410e6c!818.22688711F5410E6C!979?access_token=access_token").to_return(:status => 200, :body => comment.to_json, :headers => {})
+    @comment = skydrive_test_client.get("/comment.22688711f5410e6c.22688711f0410e6c!818.22688711F5410E6C!979")
+  end
+
+  it "should return the message associated with the comment" do
+    @comment.message.should  eql "A lighthouse built on some rocks."
+  end
+end