cloudapp_api 0.1.0 → 0.1.1

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

data/cloudapp_api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{cloudapp_api}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Aaron Russell"]
-  s.date = %q{2010-12-15}
+  s.date = %q{2011-01-30}
   s.description = %q{A simple Ruby wrapper for the CloudApp API. Uses HTTParty with a simple ActiveResource-like interface.}
   s.email = %q{aaron@gc4.co.uk}
   s.extra_rdoc_files = [

data/lib/cloudapp/base.rb

@@ -18,8 +18,9 @@ module CloudApp
     format :json
     
     # Sets the authentication credentials in a class variable.
-    # @param [String] cl.ly username
-    # @param [String] cl.ly password
+    #
+    # @param [String] username cl.ly username
+    # @param [String] password cl.ly password
     # @return [Hash] authentication credentials
     def self.authenticate(username, password)
       @@auth = {:username => username, :password => password}
@@ -28,6 +29,7 @@ module CloudApp
     private
     
     # Sets the attributes for object.
+    #
     # @param [Hash] attributes
     def load(attributes = {})
       attributes.each do |key, val|

data/lib/cloudapp/client.rb

@@ -31,9 +31,12 @@ module CloudApp
   class Client
     
     # Creates a new CloudApp::Client instance.
-    # @example Optionally provide an authentication hash
-    #   { :username => "testuser@test.com", :password => "password" }
-    # @param [Hash] authentication credentials.
+    #
+    # You can pass +:username+ and +:password+ parameters to the call.
+    #
+    # @param [Hash] opts authentication credentials.
+    # @option opts [String] :username cl.ly username
+    # @option opts [String] :password cl.ly username
     # @return [CloudApp::Client]
     def initialize(opts = {})
       if opts[:username] && opts[:password]
@@ -42,56 +45,67 @@ module CloudApp
     end
     
     # Sets the authentication credentials in a class variable.
-    # @param [String] cl.ly username
-    # @param [String] cl.ly password
+    #
+    # @param [String] username cl.ly username
+    # @param [String] password cl.ly password
     # @return [Hash] authentication credentials
     def authenticate(username, password)
       Base.authenticate(username, password)
     end
     
     # Get metadata about a cl.ly URL like name, type, or view count.
+    #
     # Finds the item by it's slug id, for example "2wr4".
-    # @param [String] cl.ly slug id
+    #
+    # @param [String] id cl.ly slug id
     # @return [CloudApp::Item]
     def item(id)
       Item.find(id)
     end
     
     # Page through your items.
-    # @example Optionally pass a hash of parameters.
-    #   :page => 1        # Page number starting at 1
-    #   :per_page => 5    # Number of items per page
-    #   :type => image    # Filter items by type (image, bookmark, text, archive, audio, video, or unknown)
-    #   :deleted => true  # Show trashed items
+    #
     # Requires authentication.
-    # @param [Hash] options parameters
-    # @return [Array] of CloudApp::Item items
+    #
+    # @param [Hash] opts options parameters
+    # @option opts [Integer] :page (1) Page number starting at 1
+    # @option opts [Integer] :per_page (5) Number of items per page
+    # @option opts [String] :type ('image') Filter items by type (image, bookmark, text, archive, audio, video, or unknown)
+    # @option opts [Boolean] :deleted (true) Show trashed items
+    # @return [Array[CloudApp::Item]]
     def items(opts = {})
       Item.all(opts)
     end
     
     # Create a new cl.ly item by bookmarking a link.
+    #
     # Requires authentication.
-    # @param [String] url to bookmark
-    # @param [String] name of bookmark
+    #
+    # @param [String] url url to bookmark
+    # @param [String] name name of bookmark
     # @return [CloudApp::Item]
     def bookmark(url, name = "")
       Item.create(:bookmark, {:name => name, :redirect_url => url})
     end
     
     # Create a new cl.ly item by uploading a file.
+    #
     # Requires authentication.
-    # @param [String] local path to file
+    #
+    # @param [String] file local path to file
     # @return [CloudApp::Item]
     def upload(file)
       Item.create(:upload, :file => file)
     end
     
     # Change the name of an item.
+    #
     # Finds the item by it's slug id, for example "2wr4".
+    #
     # Requires authentication.
-    # @param [String] cl.ly item id
-    # @param [String] new item name
+    #
+    # @param [String] id cl.ly item id
+    # @param [String] name new item name
     # @return [CloudApp::Item]
     def rename(id, name = "")
       item = Item.find(id)
@@ -99,10 +113,13 @@ module CloudApp
     end
     
     # Modify an item with a private URL to have a public URL or vice versa.
+    #
     # Finds the item by it's slug id, for example "2wr4".
+    #
     # Requires authentication.
-    # @param [String] cl.ly item id
-    # @param [Boolean] privacy setting
+    #
+    # @param [String] id cl.ly item id
+    # @param [Boolean] privacy privacy setting
     # @return [CloudApp::Item]
     def privacy(id, privacy = false)
       item = Item.find(id)
@@ -110,9 +127,12 @@ module CloudApp
     end
     
     # Send an item to the trash.
+    #
     # Finds the item by it's slug id, for example "2wr4".
+    #
     # Requires authentication.
-    # @param [String] cl.ly item id
+    #
+    # @param [String] id cl.ly item id
     # @return [CloudApp::Item]
     def delete(id)
       item = Item.find(id)
@@ -121,4 +141,4 @@ module CloudApp
         
   end
   
-end
+end

data/lib/cloudapp/item.rb

@@ -40,39 +40,40 @@ module CloudApp
   class Item < Base
     
     # Get metadata about a cl.ly URL like name, type, or view count.
+    #
     # Finds the item by it's slug id, for example "2wr4".
-    # @param [String] cl.ly slug id
+    #
+    # @param [String] id cl.ly slug id
     # @return [CloudApp::Item]
     def self.find(id)
       res = get "http://cl.ly/#{id}"
       res.ok? ? Item.new(res) : res
     end
     
-    # Page through your items. Optionally pass a hash of parameters.
-    # @example Optionally pass a hash of parameters.
-    #   :page => 1        # Page number starting at 1
-    #   :per_page => 5    # Number of items per page
-    #   :type => image    # Filter items by type (image, bookmark, text, archive, audio, video, or unknown)
-    #   :deleted => true  # Show trashed items
+    # Page through your items.
+    #
     # Requires authentication.
-    # @param [Hash] options parameters
-    # @return [Array] of CloudApp::Item items
+    #
+    # @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 items
+    # @return [Array[CloudApp::Item]]
     def self.all(opts = {})
       res = get "/items?#{opts.to_params}", :digest_auth => @@auth
       res.ok? ? res.collect{|i| Item.new(i)} : res
     end
     
-    # Create a new cl.ly item. Can be one of two types:
-    #   :bookmark         # Bookmark link
-    #   :upload           # Upload file
-    # Depending on the type of item, a parameter hash is required.
-    # @example Options for a bookmark
-    #   { :name => "CloudApp", :redirect_url => "http://getcloudapp.com" }
-    # @example Options for a file upload
-    #   { :file => "/path/to/image.png" }
+    # Create a new cl.ly item. 
+    #
     # Requires authentication.
-    # @param [Symbol] type of cl.ly item
-    # @param [Hash] item parameters
+    #
+    # @param [Symbol] kind type of cl.ly item (can be :bookmark or :upload)
+    # @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)
+    # @option opts [String] :file Path to file (only required for +:upload+ kind)
     # @return [CloudApp::Item]
     def self.create(kind, opts = {})
       case kind
@@ -90,13 +91,13 @@ module CloudApp
     end
     
     # Modify a cl.ly item. Can currently modify it's name or security setting by passing parameters.
-    # @example Options for renaming
-    #   { :name => "CloudApp" }
-    # @example Options for modifying privacy
-    #   { :privacy => true }
+    #
     # Requires authentication.
-    # @param [String] href of cl.ly item
-    # @param [Hash] item parameters
+    #
+    # @param [String] href href attribute of cl.ly item
+    # @param [Hash] opts item parameters
+    # @option opts [String] :name for renaming the item
+    # @option opts [Boolean] :privacy set item privacy
     # @return [CloudApp::Item]
     def self.update(href, opts = {})
       res = put href, {:body => {:item => opts}, :digest_auth => @@auth}
@@ -104,8 +105,10 @@ module CloudApp
     end
     
     # Send an item to the trash.
+    #
     # Requires authentication.
-    # @param [String] href of cl.ly item
+    #
+    # @param [String] href href attribute of cl.ly item
     # @return [CloudApp::Item]
     def self.delete(href)
       res = Base.delete href, :digest_auth => @@auth
@@ -116,27 +119,31 @@ module CloudApp
                 :icon, :remote_url, :redirect_url, :created_at, :updated_at, :deleted_at
     
     # Create a new CloudApp::Item object.
-    # Only used internally
+    #
+    # Only used internally.
+    #
     # @param [Hash] attributes
     # @param [CloudApp::Item]
     def initialize(attributes = {})
       load(attributes)
     end
     
-    # Modify the cl.ly item. Can currently modify it's name or security setting by passing parameters.
-    # @example Options for renaming
-    #   { :name => "CloudApp" }
-    # @example Options for modifying privacy
-    #   { :privacy => true }
+    # Modify the item. Can currently modify it's name or security setting by passing parameters.
+    #
     # Requires authentication.
-    # @param [Hash] item parameters
+    #
+    # @param [Hash] opts item parameters
+    # @option opts [String] :name for renaming the item
+    # @option opts [Boolean] :privacy set item privacy
     # @return [CloudApp::Item]
     def update(opts = {})
       self.class.update self.href, opts
     end
     
     # Send the item to the trash.
+    #
     # Requires authentication.
+    #
     # @return [CloudApp::Item]
     def delete
       self.class.delete self.href

data/lib/cloudapp_api.rb

@@ -13,8 +13,9 @@ module CloudApp
   VERSION = "0.1.0"
   
   # Sets the authentication credentials in a class variable
-  # @param [String] cl.ly username
-  # @param [String] cl.ly password
+  #
+  # @param [String] username cl.ly username
+  # @param [String] password cl.ly password
   # @return [Hash] authentication credentials
   def CloudApp.authenticate(username, password)
     Base.authenticate(username, password)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cloudapp_api
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Aaron Russell
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-15 00:00:00 +00:00
+date: 2011-01-30 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency