cloudapp_api 0.1.1 → 0.2.0

data/lib/cloudapp/drop.rb

@@ -0,0 +1,197 @@
+module CloudApp
+  
+  # An ActiveResource-like interface through which to interract with CloudApp drops.
+  #
+  # @example Gets started by Authenticating
+  #   CloudApp.authenticate "username", "password"
+  #
+  # @example Usage via the Drop class
+  #   # Find a single drop by it's slug
+  #   @drop = CloudApp::Drop.find "2wr4"
+  #   
+  #   # Get a list of all drops
+  #   @drops = CloudApp::Drop.all
+  #   
+  #   # Create a new bookmark
+  #   @drop = CloudApp::Drop.create :bookmark, :name => "CloudApp", :redirect_url => "http://getcloudapp.com"
+  #   
+  #   # Create multiple bookmarks
+  #   bookmarks = [
+  #     { :name => "Authur Dent", :redirect_url => "http://en.wikipedia.org/wiki/Arthur_Dent" },
+  #     { :name => "Zaphod Beeblebrox", :redirect_url => "http://en.wikipedia.org/wiki/Zaphod_Beeblebrox" }
+  #   ]
+  #   @drops = CloudApp::Drop.create :bookmarks, bookmarks
+  #   
+  #   # Upload a file
+  #   @drop = CloudApp::Drop.create :upload, :file => "/path/to/image.png"
+  #   @drop = CloudApp::Drop.create :upload, :file => "/path/to/image.png", :private => true
+  #   
+  #   # Rename a file
+  #   CloudApp::Drop.update "http://my.cl.ly/items/1912565", :name => "Big Screenshot"
+  #   
+  #   # Set a drop's privacy
+  #   CloudApp::Drop.update "http://my.cl.ly/items/1912565", :private => true
+  #   
+  #   # Delete a drop
+  #   CloudApp::Drop.delete "http://my.cl.ly/items/1912565"
+  #
+  #   # Recover a deleted drop
+  #   CloudApp::Drop.recover "http://my.cl.ly/items/1912565"
+  #
+  # @example Usage via the class instance
+  #   # Rename a file
+  #   @drop.update :name => "Big Screenshot"
+  #   
+  #   # Set the drop's privacy
+  #   @drop.update :private => true
+  #   
+  #   # Delete a drop
+  #   @drop.delete
+  #
+  #   # Recover a deleted drop
+  #   @drop.recover
+  #
+  class Drop < Base
+    
+    # Get metadata about a cl.ly URL like name, type, or view count.
+    #
+    # Finds the drop by it's slug id, for example "2wr4".
+    #
+    # @param [String] id cl.ly slug id
+    # @return [CloudApp::Drop]
+    def self.find(id)
+      res = get "http://cl.ly/#{id}"
+      res.ok? ? Drop.new(res) : res
+    end
+    
+    # Page through your drops.
+    #
+    # Requires authentication.
+    #
+    # @param [Hash] opts options parameters
+    # @option opts [Integer] :page Page number starting at 1
+    # @option opts [Integer] :per_page Number of items per page
+    # @option opts [String] :type Filter items by type (image, bookmark, text, archive, audio, video, or unknown)
+    # @option opts [Boolean] :deleted Show trashed drops
+    # @return [Array[CloudApp::Drop]]
+    def self.all(opts = {})
+      res = get "/items", {:query => (opts.empty? ? nil : opts), :digest_auth => @@auth}
+      res.ok? ? res.collect{|i| Drop.new(i)} : res
+    end
+    
+    # Create a new drop. Multiple bookmarks can be created at once by
+    # passing an array of bookmark options parameters.
+    #
+    # Requires authentication.
+    #
+    # @param [Symbol] kind type of drop (can be +:bookmark+, +:bookmarks+ or +:upload+)
+    # @overload self.create(:bookmark, opts = {})
+    #   @param [Hash] opts options paramaters
+    #   @option opts [String] :name Name of bookmark (only required for +:bookmark+ kind)
+    #   @option opts [String] :redirect_url Redirect URL (only required for +:bookmark+ kind)
+    # @overload self.create(:bookmarks, bookmarks)
+    #   @param [Array] bookmarks array of bookmark option parameters (containing +:name+ and +:redirect_url+)
+    # @overload self.create(:upload, opts = {})
+    #   @param [Hash] opts options paramaters
+    #   @option opts [String] :file Path to file (only required for +:upload+ kind)
+    #   @option opts [Boolean] :private override the account default privacy setting
+    # @return [CloudApp::Drop]
+    def self.create(kind, opts = {})
+      case kind
+      when :bookmark
+        res = post "/items", {:body => {:item => opts}, :digest_auth => @@auth}
+      when :bookmarks
+        res = post "/items", {:body => {:items => opts}, :digest_auth => @@auth}
+      when :upload
+        r = get "/items/new", {:query => ({:item => {:private => opts[:private]}} if opts.has_key?(:private)), :digest_auth => @@auth}
+        return r unless r.ok?
+        res = post r['url'], Multipart.new(r['params'].merge!(:file => File.new(opts[:file]))).payload.merge!(:digest_auth => @@auth)
+      else
+        # TODO raise an error
+        return false
+      end
+      res.ok? ? (res.is_a?(Array) ? res.collect{|i| Drop.new(i)} : Drop.new(res)) : res
+    end
+    
+    # Modify a drop. Can currently modify it's name or security setting by passing parameters.
+    #
+    # Requires authentication.
+    #
+    # @param [String] href href attribute of drop
+    # @param [Hash] opts options paramaters
+    # @option opts [String] :name for renaming the drop
+    # @option opts [Boolean] :privacy set drop privacy
+    # @return [CloudApp::Drop]
+    def self.update(href, opts = {})
+      res = put href, {:body => {:item => opts}, :digest_auth => @@auth}
+      res.ok? ? Drop.new(res) : res
+    end
+    
+    # Send a drop to the trash.
+    #
+    # Requires authentication.
+    #
+    # @param [String] href href attribute of the drop
+    # @return [CloudApp::Drop]
+    def self.delete(href)
+      # Use delete on the Base class to avoid recursion
+      res = Base.delete href, :digest_auth => @@auth
+      res.ok? ? Drop.new(res) : res
+    end
+    
+    # Recover a drop from the trash.
+    #
+    # Requires authentication.
+    #
+    # @param [String] href href attribute of the drop
+    # @return [CloudApp::Drop]
+    def self.recover(href)
+      res = put href, {:body => {:deleted => true, :item => {:deleted_at => nil}}, :digest_auth => @@auth}
+      res.ok? ? Drop.new(res) : res
+    end
+    
+    attr_reader :href, :name, :private, :url, :content_url, :item_type, :view_counter,
+                :icon, :remote_url, :redirect_url, :created_at, :updated_at, :deleted_at
+    
+    # Create a new CloudApp::Drop object.
+    #
+    # Only used internally.
+    #
+    # @param [Hash] attributes
+    # @param [CloudApp::Drop]
+    def initialize(attributes = {})
+      load(attributes)
+    end
+    
+    # Modify the drop. Can currently modify it's name or security setting by passing parameters.
+    #
+    # @param [Hash] opts options paramaters
+    # @option opts [String] :name for renaming the drop
+    # @option opts [Boolean] :privacy set the drop's privacy
+    # @return [CloudApp::Drop]
+    def update(opts = {})
+      self.class.update self.href, opts
+    end
+    
+    # Send the drop to the trash.
+    #
+    # @return [CloudApp::Drop]
+    def delete
+      self.class.delete self.href
+    end
+    
+    # Recover the drop from the trash.
+    #
+    # @return [CloudApp::Drop]
+    def recover
+      self.class.recover self.href
+    end
+        
+  end
+  
+  # The Item class is now deprecated in favour of the Drop class.
+  # For legacy purposes you can still use the Item class but it is recommended you
+  # update your code to use the Drop class to ensure future compatibility.
+  class Item < Drop; end
+  
+end

data/lib/cloudapp/gift_card.rb

@@ -0,0 +1,64 @@
+module CloudApp
+  
+  # An ActiveResource-like interface through which to interract with CloudApp gift cards.
+  #
+  #
+  # @example Gets started by Authenticating
+  #   CloudApp.authenticate "username", "password"
+  #
+  # @example Usage via the GiftCard class
+  #   # View gift card details
+  #   @gift = CloudApp::GiftCard.find "ABC123"
+  #   
+  #   # Apply the gift card
+  #   CloudApp::GiftCard.redeem "ABC123"
+  #     # or
+  #   @gift.redeem
+  # 
+  class GiftCard < Base
+    
+    # Get the details of an unredeemed gift card.
+    #
+    # Requires authentication.
+    #
+    # @param [String] code Gift card code
+    # @return [CloudApp::GiftCard]
+    def self.find(code)
+      res = get "/gift_cards/#{code}", :digest_auth => @@auth
+      res.ok? ? GiftCard.new(res) : res
+    end
+    
+    # Apply a gift card to the authenticated account.
+    #
+    # Requires authentication.
+    #
+    # @param [String] code Gift card code
+    # @return [CloudApp::GiftCard]
+    def self.redeem(code)
+      res = put "/gift_cards/#{code}", :digest_auth => @@auth
+      res.ok? ? GiftCard.new(res) : res
+    end
+    
+    attr_reader :id, :code, :plan, :months, :href,
+                :created_at, :updated_at, :redeemed_at, :effective_at, :expires_at
+    
+    # Create a new CloudApp::GiftCard object.
+    #
+    # Only used internally
+    #
+    # @param [Hash] attributes
+    # @param [CloudApp::GiftCard]
+    def initialize(attributes = {})
+      load(attributes)
+    end
+    
+    # Apply the gift card to the authenticated account.
+    #
+    # @return [CloudApp::GiftCard]
+    def redeem
+      self.class.redeem code
+    end
+    
+  end
+  
+end

data/lib/cloudapp_api.rb

@@ -1,6 +1,6 @@
 require "httparty"
 
-["base", "item", "account", "client", "multipart", "httparty"].each do |inc|
+["base", "drop", "account", "gift_card", "client", "multipart", "httparty", "core_ext"].each do |inc|
   require File.join(File.dirname(__FILE__), "cloudapp", inc)
 end
 
@@ -10,15 +10,15 @@ end
 module CloudApp
   
   # Version number
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
   
   # Sets the authentication credentials in a class variable
   #
-  # @param [String] username cl.ly username
+  # @param [String] email cl.ly username
   # @param [String] password cl.ly password
   # @return [Hash] authentication credentials
-  def CloudApp.authenticate(username, password)
-    Base.authenticate(username, password)
+  def CloudApp.authenticate(email, password)
+    Base.authenticate(email, password)
   end
     
 end

data/spec/cloudapp_account_spec.rb

@@ -122,14 +122,14 @@ describe "Register account" do
   before(:each) do
     fake_it_all
     @email = "arthur@dent.com"
-    @account = CloudApp::Account.create :email => @email, :current_password => "towel"
+    @account = CloudApp::Account.create :email => @email, :current_password => "towel", :accept_tos => true
   end
   
   it "should be a Account object" do
     @account.should be_a_kind_of CloudApp::Account
   end
   
-  it "should do something" do
+  it "should have the same email" do
     @account.email.should == @email
   end
   
@@ -160,3 +160,28 @@ describe "Set custom domain" do
   
 end
 
+
+describe "View account statistics" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @account = CloudApp::Account.find
+    @stats = @account.stats
+  end
+  
+  it "should be a Hash object" do
+    @stats.should be_a_kind_of Hash
+  end
+  
+  it "should have a number of items" do
+    @stats[:items].should be_true
+    @stats[:items].should be_a_kind_of Integer
+  end
+  
+  it "should have a number of views" do
+    @stats[:views].should be_true
+    @stats[:views].should be_a_kind_of Integer
+  end
+  
+end

data/spec/cloudapp_client_spec.rb

@@ -15,51 +15,78 @@ describe CloudApp::Client do
     auth[:username].should == username
   end
   
-  it "should find an item" do
-    item = @client.item "2wr4"
-    item.should be_a_kind_of CloudApp::Item
+  it "should find an drop" do
+    drop = @client.drop "2wr4"
+    drop.should be_a_kind_of CloudApp::Drop
   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
+  it "should list all drops" do
+    drops = @client.drops
+    drops.should be_a_kind_of Array
+    drops.each do |drop|
+      drop.should be_a_kind_of CloudApp::Drop
     end
   end
   
-  it "should bookmark an item" do
+  it "should bookmark an drop" do
     name = "CloudApp"
-    item = @client.bookmark "http://getcloudapp.com", name
-    item.should be_a_kind_of CloudApp::Item
-    item.name.should == name
+    drop = @client.bookmark "http://getcloudapp.com", name
+    drop.should be_a_kind_of CloudApp::Drop
+    drop.name.should == name
+  end
+  
+  it "should bookmark multiple drops" do
+    # overwrite the normal fake uri for this spec
+    FakeWeb.register_uri :post, 'http://my.cl.ly/items', :response => stub_file(File.join('drop', 'index'))
+    bookmarks = [
+      { :name         => "Authur Dent",       :redirect_url => "http://en.wikipedia.org/wiki/Arthur_Dent" },
+      { :name         => "Ford Prefect",      :redirect_url => "http://en.wikipedia.org/wiki/Ford_Prefect_(character)"},
+      { :name         => "Zaphod Beeblebrox", :redirect_url => "http://en.wikipedia.org/wiki/Zaphod_Beeblebrox" }
+    ]
+    drops = @client.bookmark bookmarks
+    drops.should be_a_kind_of Array
+    drops.each do |drop|
+      drop.should be_a_kind_of CloudApp::Drop
+    end
   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"
+    drop = @client.upload "README.md"
+    drop.should be_a_kind_of CloudApp::Drop
+    drop.item_type.should == "image"
   end
   
-  it "should rename an item" do
+  it "should upload a file with specific privacy" do
+    # override the upload fakeweb uri
+    FakeWeb.register_uri :post, 'http://f.cl.ly', :status => ["303"], :location => "http://my.cl.ly/items/s3?item[private]=true"
+    drop = @client.upload "README.md", :private => true
+    drop.should be_a_kind_of CloudApp::Drop
+    drop.private.should == true
+  end
+  
+  it "should rename an drop" do
     name = "CloudApp"
-    item = @client.rename "2wr4", name
-    item.should be_a_kind_of CloudApp::Item
-    item.name.should == name
+    drop = @client.rename "2wr4", name
+    drop.should be_a_kind_of CloudApp::Drop
+    drop.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
+  it "should set an drops privacy" do
+    drop = @client.privacy "2wr4", false
+    drop.should be_a_kind_of CloudApp::Drop
+    drop.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
+  it "should delete an drop" do
+    drop = @client.delete "2wr4"
+    drop.should be_a_kind_of CloudApp::Drop
+    drop.deleted_at.should be_a_kind_of Time
   end
   
+  it "should recover an drop" do
+    drop = @client.recover "2wr4"
+    drop.should be_a_kind_of CloudApp::Drop
+    drop.deleted_at.should == nil
+  end
   
 end
-

data/spec/cloudapp_drop_spec.rb

@@ -0,0 +1,258 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe CloudApp::Drop do
+  
+  before(:each) do
+    fake_it_all
+    @drop = CloudApp::Drop.find "2wr4"
+  end
+  
+  it "should be a Drop object" do
+    @drop.should be_a_kind_of CloudApp::Drop
+  end
+  
+  it "should return a name" do
+    @drop.name.should == "CloudApp Logo.png"
+  end
+  
+  it "should return an href" do
+    @drop.href.should == "http://my.cl.ly/items/1912559"
+  end
+  
+  it "should return a privacy boolean" do
+    @drop.private.should == false
+  end
+  
+  it "should return a url" do
+    @drop.url.should == "http://cl.ly/2wr4"
+  end
+  
+  it "should return a content url" do
+    @drop.content_url.should == "http://cl.ly/2wr4/CloudApp_Logo.png"
+  end
+  
+  it "should return a drop type" do
+    @drop.item_type.should == "image"
+  end
+  
+  it "should return a view counter" do
+    @drop.view_counter.should == 42
+  end
+  
+  it "should return an icon url" do
+    @drop.icon.should == "http://my.cl.ly/images/item_types/image.png"
+  end
+  
+  it "should return a remote url" do
+    @drop.remote_url == "http://f.cl.ly/items/7c7aea1395c3db0aee18/CloudApp%20Logo.png"
+  end
+  
+  it "should not return a redirect url" do
+    @drop.redirect_url == nil
+  end
+  
+  it "should return timestamps" do
+    @drop.created_at.should be_a_kind_of Time
+    @drop.updated_at.should be_a_kind_of Time
+    @drop.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"
+    @drop = CloudApp::Drop.create :bookmark, {:name => @name, :redirect_url => @redirect_url}
+  end
+  
+  it "should be a Drop object" do
+    @drop.should be_a_kind_of CloudApp::Drop
+  end
+  
+  it "should return the same name" do
+    @drop.name.should == @name
+  end
+  
+  it "should return the same redirect_url" do
+    @drop.redirect_url.should == @redirect_url
+  end
+  
+end
+
+
+describe "Bookmark multiple links" do
+  
+  before(:each) do
+    fake_it_all
+    # overwrite the normal fake uri for this spec
+    FakeWeb.register_uri :post, 'http://my.cl.ly/items', :response => stub_file(File.join('drop', 'index'))
+    CloudApp.authenticate "testuser@test.com", "password"
+    @bookmarks = [
+      { :name         => "Authur Dent",       :redirect_url => "http://en.wikipedia.org/wiki/Arthur_Dent" },
+      { :name         => "Ford Prefect",      :redirect_url => "http://en.wikipedia.org/wiki/Ford_Prefect_(character)"},
+      { :name         => "Zaphod Beeblebrox", :redirect_url => "http://en.wikipedia.org/wiki/Zaphod_Beeblebrox" }
+    ]
+    @drops = CloudApp::Drop.create :bookmarks, @bookmarks
+  end
+  
+  it "should be an Array" do
+    @drops.should be_a_kind_of Array
+  end
+  
+  it "should contain Drop objects" do
+    @drops.each do |drop|
+      drop.should be_a_kind_of CloudApp::Drop
+    end
+  end
+    
+end
+
+
+describe "Change security of an drop" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @drop = CloudApp::Drop.update "http://my.cl.ly/items/1912565", {:private => false}
+  end
+  
+  it "should be an Drop object" do
+    @drop.should be_a_kind_of CloudApp::Drop
+  end
+  
+  it "should not be private" do
+    @drop.private.should == false
+  end
+  
+end
+
+
+
+describe "Delete a drop" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @drop = CloudApp::Drop.delete "http://my.cl.ly/items/1912565"
+  end
+  
+  it "should be an Drop object" do
+    @drop.should be_a_kind_of CloudApp::Drop
+  end
+  
+  it "should have a deleted_at timestamp" do
+    @drop.deleted_at.should be_a_kind_of Time
+  end
+  
+end
+
+
+describe "Empty trash" do
+end
+
+
+describe "List drops" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @drops = CloudApp::Drop.all
+  end
+  
+  it "should be an Array" do
+    @drops.should be_a_kind_of Array
+  end
+  
+  it "should contain Drop objects" do
+    @drops.each do |drop|
+      drop.should be_a_kind_of CloudApp::Drop
+    end
+  end
+  
+end
+
+
+describe "Recover deleted drop" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @drop = CloudApp::Drop.recover "http://my.cl.ly/items/1912565"
+  end
+  
+  it "should be an Drop object" do
+    @drop.should be_a_kind_of CloudApp::Drop
+  end
+  
+  it "should not have a deleted_at timestamp" do
+    @drop.deleted_at.should == nil
+  end
+  
+end
+
+
+describe "Rename drop" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @name = "CloudApp"
+    @drop = CloudApp::Drop.update "http://my.cl.ly/items/1912565", {:name => @name}
+  end
+  
+  it "should be an Drop object" do
+    @drop.should be_a_kind_of CloudApp::Drop
+  end
+  
+  it "should be have the same name" do
+    @drop.name.should == @name
+  end
+  
+end
+
+
+describe "Upload file" do
+  
+  before(:each) do
+    fake_it_all
+    CloudApp.authenticate "testuser@test.com", "password"
+    @drop = CloudApp::Drop.create :upload, {:file => "README.md"}
+  end
+  
+  it "should be an Drop object" do
+    @drop.should be_a_kind_of CloudApp::Drop
+  end
+  
+  it "should return a drop type" do
+    @drop.item_type.should == "image"
+  end
+  
+end
+
+
+describe "Upload file with specific privacy" do
+  
+  before(:each) do
+    fake_it_all
+    # override the upload fakeweb uri
+    FakeWeb.register_uri :post, 'http://f.cl.ly', :status => ["303"], :location => "http://my.cl.ly/items/s3?item[private]=true"
+    CloudApp.authenticate "testuser@test.com", "password"
+    @drop = CloudApp::Drop.create :upload, {:file => "README.md", :private => true}
+  end
+  
+  it "should be an Drop object" do
+    @drop.should be_a_kind_of CloudApp::Drop
+  end
+  
+  it "should return as private" do
+    @drop.private.should == true
+  end
+  
+end
+
+