cloudapp_api 0.0.3 → 0.1.0

data/lib/cloudapp/multipart.rb

@@ -2,9 +2,10 @@ require "mime/types"
 
 module CloudApp
   
-  class Multipart
+  # TODO - Document the Multipart Class
+  class Multipart #:nodoc:
     
-    EOL = "\r\n"
+    EOL = "\r\n" #:nodoc:
     
     def initialize(params)
       @params = params
@@ -19,28 +20,28 @@ module CloudApp
       @body += EOL + bound + "--#{EOL}"
     end
     
-    def payload
+    def payload #:nodoc:
       {
         :headers => {"Content-Type" => "multipart/form-data; boundary=#{boundary}"},
         :body => @body
       }
     end
     
-    def boundary
+    def boundary #:nodoc:
       @boundary ||= "#{HEADERS["User-Agent"]}.#{Array.new(16/2) { rand(256) }.pack("C*").unpack("H*").first}"
     end
     
-    def create_regular_field(key, val)
+    def create_regular_field(key, val) #:nodoc:
       %Q{Content-Disposition: form-data; name="#{key}"} + EOL + EOL + val
     end
     
-    def create_file_field(file)
+    def create_file_field(file) #:nodoc:
       %Q{Content-Disposition: form-data; name="file"; filename="#{File.basename(file.path)}"} + EOL +
         "Content-Type: #{mime_for(file.path)}" + EOL + EOL +
         file.read 
     end
     
-    def mime_for(path)
+    def mime_for(path) #:nodoc:
       (MIME::Types.type_for(path)[0] || MIME::Types["application/octet-stream"][0]).simplified
     end
     

data/lib/cloudapp_api.rb

@@ -1,13 +1,21 @@
 require "httparty"
 
-["base", "client", "multipart", "httparty"].each do |inc|
+["base", "item", "account", "client", "multipart", "httparty"].each do |inc|
   require File.join(File.dirname(__FILE__), "cloudapp", inc)
 end
 
+# A simple Ruby wrapper for the CloudApp API. Uses HTTParty and provides
+# two alternative interfaces for interracting with the API.
+# An ActiveResource-like interface is provided alongside a simple client interface.
 module CloudApp
   
-  VERSION = "0.0.2"
+  # Version number
+  VERSION = "0.1.0"
   
+  # Sets the authentication credentials in a class variable
+  # @param [String] cl.ly username
+  # @param [String] cl.ly password
+  # @return [Hash] authentication credentials
   def CloudApp.authenticate(username, password)
     Base.authenticate(username, password)
   end

data/spec/cloudapp_account_spec.rb

@@ -0,0 +1,162 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CloudApp::Account do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @account = CloudApp::Account.find
+  end
+  
+  it "should be a Account object" do
+    @account.should be_a_kind_of CloudApp::Account
+  end
+  
+  it "should return an id" do
+    @account.id.should == 1
+  end
+  
+  it "should return an email" do
+    @account.email.should == "arthur@dent.com"
+  end
+  
+  it "should return a blank domain" do
+    @account.domain.should == nil
+  end
+  
+  it "should return a blank domain home page" do
+    @account.domain_home_page.should == nil
+  end
+  
+  it "should return a private items booleans" do
+    @account.private_items.should == true
+  end
+  
+  it "should return a subscribed boolean" do
+    @account.subscribed.should == false
+  end
+  
+  it "should return a alpha boolean" do
+    @account.alpha.should == false
+  end
+  
+  it "should return timestamps" do
+    @account.created_at.should be_a_kind_of Time
+    @account.updated_at.should be_a_kind_of Time
+    @account.activated_at.should be_a_kind_of Time
+  end
+  
+end
+
+
+describe "Change default security" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @account = CloudApp::Account.update :private_items => false
+  end
+  
+  it "should be a Account object" do
+    @account.should be_a_kind_of CloudApp::Account
+  end
+  
+  it "should have private items set to false" do
+    @account.private_items.should == false
+  end
+  
+end
+
+
+describe "Change email" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @email = "ford@prefect.com"
+    @account = CloudApp::Account.update :email => @email, :current_password => "towel"
+  end
+  
+  it "should be a Account object" do
+    @account.should be_a_kind_of CloudApp::Account
+  end
+  
+  it "should have the new email address" do
+    @account.email.should == @email
+  end
+  
+end
+
+
+describe "Change password" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @account = CloudApp::Account.update :password => "hoopy frood", :current_password => "towel"
+  end
+  
+  it "should be a Account object" do
+    @account.should be_a_kind_of CloudApp::Account
+  end
+  
+end
+
+
+describe "Reset password" do
+  
+  before(:each) do
+    fake_it_all
+    @response = CloudApp::Account.reset :email => "arthur@dent.com"
+  end
+  
+  it "should return true" do
+    @response.should == true
+  end
+  
+end
+
+
+describe "Register account" do
+  
+  before(:each) do
+    fake_it_all
+    @email = "arthur@dent.com"
+    @account = CloudApp::Account.create :email => @email, :current_password => "towel"
+  end
+  
+  it "should be a Account object" do
+    @account.should be_a_kind_of CloudApp::Account
+  end
+  
+  it "should do something" do
+    @account.email.should == @email
+  end
+  
+end
+
+
+describe "Set custom domain" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @domain = "dent.com"
+    @dhp = "http://hhgproject.org"
+    @account = CloudApp::Account.update :domain => @domain, :domain_home_page => @dhp
+  end
+  
+  it "should be a Account object" do
+    @account.should be_a_kind_of CloudApp::Account
+  end
+  
+  it "should have the same domain" do
+    @account.domain.should == @domain
+  end
+  
+  it "should have the same domain home page" do
+    @account.domain_home_page.should == @dhp
+  end
+  
+end
+

data/spec/cloudapp_api_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CloudApp do
+  
+  it "should set correct headers" do
+    CloudApp::HEADERS['User-Agent'].should    == "Ruby.CloudApp.API"
+    CloudApp::HEADERS['Accept'].should        == "application/json"
+    CloudApp::HEADERS['Content-Type'].should  == "application/json"
+  end
+  
+  it "should be authenticatable" do
+    auth = {
+      :username => "testuser@test.com",
+      :password => "password"
+    }
+    CloudApp.authenticate(auth[:username], auth[:password]).should == auth
+  end
+  
+end
+

data/spec/cloudapp_client_spec.rb

@@ -0,0 +1,65 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CloudApp::Client do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @client = CloudApp::Client.new
+  end
+  
+  it "should be reautheticatable" do
+    username = "joe.bloggs@testing.com"
+    password = "password"
+    auth = @client.authenticate username, password
+    auth[:username].should == username
+  end
+  
+  it "should find an item" do
+    item = @client.item "2wr4"
+    item.should be_a_kind_of CloudApp::Item
+  end
+  
+  it "should list all items" do
+    items = @client.items
+    items.should be_a_kind_of Array
+    items.each do |item|
+      item.should be_a_kind_of CloudApp::Item
+    end
+  end
+  
+  it "should bookmark an item" do
+    name = "CloudApp"
+    item = @client.bookmark "http://getcloudapp.com", name
+    item.should be_a_kind_of CloudApp::Item
+    item.name.should == name
+  end
+  
+  it "should upload a file" do
+    item = @client.upload "README.md"
+    item.should be_a_kind_of CloudApp::Item
+    item.item_type.should == "image"
+  end
+  
+  it "should rename an item" do
+    name = "CloudApp"
+    item = @client.rename "2wr4", name
+    item.should be_a_kind_of CloudApp::Item
+    item.name.should == name
+  end
+  
+  it "should set an items privacy" do
+    item = @client.privacy "2wr4", false
+    item.should be_a_kind_of CloudApp::Item
+    item.private.should == false
+  end
+  
+  it "should delete an item" do
+    item = @client.delete "2wr4"
+    item.should be_a_kind_of CloudApp::Item
+    item.deleted_at.should be_a_kind_of Time
+  end
+  
+  
+end
+

data/spec/cloudapp_item_spec.rb

@@ -0,0 +1,195 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CloudApp::Item do
+  
+  before(:each) do
+    fake_it_all
+    @item = CloudApp::Item.find "2wr4"
+  end
+  
+  it "should be a Item object" do
+    @item.should be_a_kind_of CloudApp::Item
+  end
+  
+  it "should return a name" do
+    @item.name.should == "CloudApp Logo.png"
+  end
+  
+  it "should return an href" do
+    @item.href.should == "http://my.cl.ly/items/1912559"
+  end
+  
+  it "should return a privacy boolean" do
+    @item.private.should == false
+  end
+  
+  it "should return a url" do
+    @item.url.should == "http://cl.ly/2wr4"
+  end
+  
+  it "should return a content url" do
+    @item.content_url.should == "http://cl.ly/2wr4/CloudApp_Logo.png"
+  end
+  
+  it "should return a item type" do
+    @item.item_type.should == "image"
+  end
+  
+  it "should return a view counter" do
+    @item.view_counter.should == 42
+  end
+  
+  it "should return an icon url" do
+    @item.icon.should == "http://my.cl.ly/images/item_types/image.png"
+  end
+  
+  it "should return a remote url" do
+    @item.remote_url == "http://f.cl.ly/items/7c7aea1395c3db0aee18/CloudApp%20Logo.png"
+  end
+  
+  it "should not return a redirect url" do
+    @item.redirect_url == nil
+  end
+  
+  it "should return timestamps" do
+    @item.created_at.should be_a_kind_of Time
+    @item.updated_at.should be_a_kind_of Time
+    @item.deleted_at.should == nil
+  end
+  
+end
+
+
+describe "Bookmark link" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @name = "CloudApp"
+    @redirect_url = "http://getcloudapp.com"
+    @item = CloudApp::Item.create :bookmark, {:name => @name, :redirect_url => @redirect_url}
+  end
+  
+  it "should be a Item object" do
+    @item.should be_a_kind_of CloudApp::Item
+  end
+  
+  it "should return the same name" do
+    @item.name.should == @name
+  end
+  
+  it "should return the same redirect_url" do
+    @item.redirect_url.should == @redirect_url
+  end
+  
+end
+
+
+describe "Change security of an item" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @item = CloudApp::Item.update "http://my.cl.ly/items/1912565", {:private => false}
+  end
+  
+  it "should be an Item object" do
+    @item.should be_a_kind_of CloudApp::Item
+  end
+  
+  it "should not be private" do
+    @item.private.should == false
+  end
+  
+end
+
+
+
+describe "Delete an item" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @item = CloudApp::Item.delete "http://my.cl.ly/items/1912565"
+  end
+  
+  it "should be an Item object" do
+    @item.should be_a_kind_of CloudApp::Item
+  end
+  
+  it "should have a deleted_at timestamp" do
+    @item.deleted_at.should be_a_kind_of Time
+  end
+  
+end
+
+
+describe "Empty trash" do
+end
+
+
+describe "List items" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @items = CloudApp::Item.all
+  end
+  
+  it "should be an Array" do
+    @items.should be_a_kind_of Array
+  end
+  
+  it "should contain Item objects" do
+    @items.each do |item|
+      item.should be_a_kind_of CloudApp::Item
+    end
+  end
+  
+end
+
+
+describe "Recover deleted item" do
+end
+
+
+describe "Rename item" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @name = "CloudApp"
+    @item = CloudApp::Item.update "http://my.cl.ly/items/1912565", {:name => @name}
+  end
+  
+  it "should be an Item object" do
+    @item.should be_a_kind_of CloudApp::Item
+  end
+  
+  it "should be have the same name" do
+    @item.name.should == @name
+  end
+  
+end
+
+
+describe "Upload file" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @item = CloudApp::Item.create :upload, {:file => "README.md"}
+  end
+  
+  it "should be an Item object" do
+    @item.should be_a_kind_of CloudApp::Item
+  end
+  
+  it "should return a item type" do
+    @item.item_type.should == "image"
+  end
+  
+end
+
+
+