cloudapp_api 0.0.3 → 0.1.0

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+gem "httparty", ">= 0.6.0"
+gem "mime-types"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.1.0"
+  gem "fakeweb"
+  gem "yard", "~> 0.6.0"
+  gem "bluecloth"
+  gem "cucumber", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.1"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,53 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bluecloth (2.0.9)
+    builder (3.0.0)
+    crack (0.1.8)
+    cucumber (0.10.0)
+      builder (>= 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    diff-lcs (1.1.2)
+    fakeweb (1.3.0)
+    gherkin (2.3.2)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    git (1.2.5)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    jeweler (1.5.1)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    mime-types (1.16)
+    rake (0.8.7)
+    rcov (0.9.9)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    term-ansicolor (1.0.5)
+    yard (0.6.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bluecloth
+  bundler (~> 1.0.0)
+  cucumber
+  fakeweb
+  httparty (>= 0.6.0)
+  jeweler (~> 1.5.1)
+  mime-types
+  rcov
+  rspec (~> 2.1.0)
+  yard (~> 0.6.0)

data/README.md

@@ -2,10 +2,9 @@
 
 A simple Ruby wrapper for the [CloudApp API](http://support.getcloudapp.com/faqs/developers/api). Uses [HTTParty](http://github.com/jnunemaker/httparty) with a simple ActiveResource-like interface.
 
-## TODO
+Two interfaces are provided for interacting with the CloudApp API. The first is a ActiveResource-like interface, directly calling methods on the Item and Account class. The second option is to interact through a Client interface.
 
-* Add tests
-* Improve the docs
+* [Familiarise yourself with the documentation](http://rubydoc.info/github/aaronrussell/cloudapp_api/)
 
 ## Installation
 
@@ -13,70 +12,107 @@ To install as a Gem:
 
     sudo gem install cloudapp_api
 
-## Usage
+## Authentication
 
-### Authentication
-
-Authentication isn't necessary if you are just attempting to find an individual item. However, if you are trying to create, delete or list all items, you must authenticate.
+Authentication is necessary for most actions, the only exceptions being when creating a new Account or querying a specific Item.
 
     CloudApp.authenticate "email@address.com", "password"
 
-### Initialize client interface
+## Item examples
 
-If you are using the client interface, you must create a client instance.
+* Documentation - {CloudApp::Item}
 
-    # Optionally you can pass a hash containing :username and :password to authenticate.
-    
-    client = CloudApp::Client.new opts
+---
+
+### Usage via the Item class
+    # Find a single item by it's slug
+    item = CloudApp::Item.find "2wr4"
+  
+    # Get a list of all items
+    items = CloudApp::Item.all
+  
+    # Create a new bookmark
+    item = CloudApp::Item.create :bookmark, :name => "CloudApp", :redirect_url => "http://getcloudapp.com"
+  
+    # Upload a file
+    item = CloudApp::Item.create :upload, :file => "/path/to/image.png"
+  
+    # Rename a file
+    CloudApp::Item.update "http://my.cl.ly/items/1912565", :name => "Big Screenshot"
+  
+    # Set an items privacy
+    CloudApp::Item.update "http://my.cl.ly/items/1912565", :private => true
+  
+    # Delete an item
+    CloudApp::Item.delete "http://my.cl.ly/items/1912565"
+
+### Usage via an Item instance
+    # Rename a file
+    @item.update :name => "Big Screenshot"
+  
+    # Set an items privacy
+    @item.update :private => true
+  
+    # Delete an item
+    @tem.delete
+
+## Usage via a Client instance
+
+* Documentation - {CloudApp::Client}
 
-### View an item by short URL
+---
 
-    short_url = "19xM"
+    # Create a Client instance
+    @client = CloudApp::Client.new
     
-    @item = client.item short_url
+    # Find a single item by it's slug
+    item = @client.item "2wr4"
     
-    # or ..
+    # Get a list of all items
+    items = @client.all
     
-    @item = CloudApp::Item.find short_url
-
-### List items
+    # Create a new bookmark
+    item = @client.bookmark "http://getcloudapp.com", "CloudApp"
     
-    # Allowed params
-    #   :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
+    # Upload a file
+    item = @client.upload "/path/to/image.png"
     
-    @items = client.items params
+    # Rename a file
+    @client.rename "2wr4", "Big Screenshot"
     
-    # or ..
+    # Set an items privacy
+    @client.privacy "2wr4", true
     
-    @items = CloudApp::Item.all params
+    # Delete an item
+    @client.delete "2wr4"
 
-### Create a bookmark
+## Account examples
 
-    @item = client.bookmark url, name
-    
-    # or ..
+* Documentation - {CloudApp::Account}
+
+---
+
+    # Create a CloudApp account
+    @account = CloudApp::Account.create :email => "arthur@dent.com", :password => "towel"
     
-    @item = CloudApp::Item.create :bookmark, {:name => name, :redirect_url => url}
+    # Forgot password
+    CloudApp::Account.reset :email => "arthur@dent.com"
     
-### Upload a file
-
-    @item = client.upload file_name
+    # View details of authenticated account
+    @account = CloudApp::Account.find
     
-    # or ..
+    # Change default security
+    @account.update :private_items => false
     
-    @item = CloudApp::Item.create :upload, {:file => file_name}
+    # Change email
+    @account.update :email => "ford@prefect.com", :current_password => "towel"
     
-### Delete an item
-
-    client.delete short_url
+    # Change password
+    @account.update :password => "happy frood", :current_password => "towel"
     
-    # or ..
+    # Set custom domain
+    @account.update :domain => "dent.com", :domain_home_page => "http://hhgproject.org"
     
-    @item.delete
 
 ## Note on Patches/Pull Requests
  
@@ -90,7 +126,6 @@ If you are using the client interface, you must create a client instance.
 ## Author & Contributors
 
 * [Aaron Russell](http://www.aaronrussell.co.uk)
-* [Wade West](http://github.com/wadewest)
 
 ## Copyright
 

data/Rakefile

@@ -1,54 +1,47 @@
 require 'rubygems'
-require 'rake'
-
+require 'bundler'
 begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "cloudapp_api"
-    gem.summary = %Q{A simple Ruby wrapper for the CloudApp API. Uses HTTParty with a simple ActiveResource-like interface.}
-    gem.description = %Q{A simple Ruby wrapper for the CloudApp API. Uses HTTParty with a simple ActiveResource-like interface.}
-    gem.email = "aaron@gc4.co.uk"
-    gem.homepage = "http://github.com/aaronrussell/cloud_app"
-    gem.authors = ["Aaron Russell", "Wade West"]
-    gem.add_dependency "httparty", ">= 0.5.2"
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
-    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
 end
+require 'rake'
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name        = "cloudapp_api"
+  gem.homepage    = "http://github.com/aaronrussell/cloud_app"
+  gem.summary     = %Q{A simple Ruby wrapper for the CloudApp API. Uses HTTParty with a simple ActiveResource-like interface.}
+  gem.description = %Q{A simple Ruby wrapper for the CloudApp API. Uses HTTParty with a simple ActiveResource-like interface.}
+  gem.email       = "aaron@gc4.co.uk"
+  gem.authors     = ["Aaron Russell"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency "httparty", ">= 0.6.0"
+  gem.add_development_dependency "rspec", "~> 2.1.0"
+  gem.add_development_dependency "yard", "~> 0.6.0"
 end
+Jeweler::RubygemsDotOrgTasks.new
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new do |test|
-    test.libs << 'test'
-    test.pattern = 'test/**/test_*.rb'
-    test.verbose = true
-  end
-rescue LoadError
-  task :rcov do
-    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
-  end
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+  spec.verbose
 end
 
-task :test => :check_dependencies
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
 
-task :default => :test
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features)
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+task :default => :spec
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "cloudapp_api #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.1.0

data/cloudapp_api.gemspec

@@ -1,53 +1,64 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{cloudapp_api}
-  s.version = "0.0.3"
+  s.version = "0.1.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Aaron Russell", "Wade West"]
-  s.date = %q{2010-11-13}
+  s.authors = ["Aaron Russell"]
+  s.date = %q{2010-12-15}
   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 = [
     "LICENSE",
-     "README.md"
+    "README.md"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.md",
-     "Rakefile",
-     "VERSION",
-     "cloudapp_api.gemspec",
-     "lib/cloudapp/base.rb",
-     "lib/cloudapp/client.rb",
-     "lib/cloudapp/httparty.rb",
-     "lib/cloudapp/monkey_patch/httparty.rb",
-     "lib/cloudapp/monkey_patch/net_digest_auth.rb",
-     "lib/cloudapp/multipart.rb",
-     "lib/cloudapp_api.rb",
-     "test/helper.rb",
-     "test/helper/faking_setup.rb",
-     "test/helper/methods.rb",
-     "test/test_base.rb",
-     "test/test_cloudapp_api.rb"
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "cloudapp_api.gemspec",
+    "lib/cloudapp/account.rb",
+    "lib/cloudapp/base.rb",
+    "lib/cloudapp/client.rb",
+    "lib/cloudapp/httparty.rb",
+    "lib/cloudapp/item.rb",
+    "lib/cloudapp/multipart.rb",
+    "lib/cloudapp_api.rb",
+    "spec/cloudapp_account_spec.rb",
+    "spec/cloudapp_api_spec.rb",
+    "spec/cloudapp_client_spec.rb",
+    "spec/cloudapp_item_spec.rb",
+    "spec/fakeweb_helper.rb",
+    "spec/spec_helper.rb",
+    "spec/stubs/account/create",
+    "spec/stubs/account/show",
+    "spec/stubs/account/update",
+    "spec/stubs/item/create",
+    "spec/stubs/item/delete",
+    "spec/stubs/item/index",
+    "spec/stubs/item/new",
+    "spec/stubs/item/show",
+    "spec/stubs/item/update"
   ]
   s.homepage = %q{http://github.com/aaronrussell/cloud_app}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{A simple Ruby wrapper for the CloudApp API. Uses HTTParty with a simple ActiveResource-like interface.}
   s.test_files = [
-    "test/helper/faking_setup.rb",
-     "test/helper/methods.rb",
-     "test/helper.rb",
-     "test/test_base.rb",
-     "test/test_cloudapp_api.rb"
+    "spec/cloudapp_account_spec.rb",
+    "spec/cloudapp_api_spec.rb",
+    "spec/cloudapp_client_spec.rb",
+    "spec/cloudapp_item_spec.rb",
+    "spec/fakeweb_helper.rb",
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -55,15 +66,48 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<httparty>, [">= 0.5.2"])
-      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.0"])
+      s.add_runtime_dependency(%q<mime-types>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_development_dependency(%q<bluecloth>, [">= 0"])
+      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_development_dependency(%q<yard>, ["~> 0.6.0"])
     else
-      s.add_dependency(%q<httparty>, [">= 0.5.2"])
-      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0.6.0"])
+      s.add_dependency(%q<mime-types>, [">= 0"])
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
+      s.add_dependency(%q<bluecloth>, [">= 0"])
+      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0.6.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+      s.add_dependency(%q<yard>, ["~> 0.6.0"])
     end
   else
-    s.add_dependency(%q<httparty>, [">= 0.5.2"])
-    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0.6.0"])
+    s.add_dependency(%q<mime-types>, [">= 0"])
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
+    s.add_dependency(%q<bluecloth>, [">= 0"])
+    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.1"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0.6.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.1.0"])
+    s.add_dependency(%q<yard>, ["~> 0.6.0"])
   end
 end