cloudpt-api 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+spec/connection.yml
+bin
+coverage
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in cloudpt-api.gemspec
+gemspec
+
+gem "rspec"
+gem "rake"
+gem 'simplecov'
+gem "ruby-debug19"
+gem "yajl-ruby"

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2011 Marcin Bunsch, Future Simple Inc.
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,322 @@
+Cloudpt::API - Cloudpt Ruby API client
+=========
+
+A Ruby client for the Cloudpt REST API.
+
+Goal:
+
+To deliver a more Rubyesque experience when using the Cloudpt API.
+
+Current state:
+
+First release, whole API covered.
+
+Installation
+------------
+
+Cloudpt::API is available on RubyGems, so:
+
+```
+gem install cloudpt-api
+```
+
+Or in your Gemfile:
+
+```ruby
+gem "cloudpt-api"
+```
+
+Configuration
+-------------
+
+In order to use this client, you need to have an app created on https://www.Cloudpt.com/developers/apps.
+
+Once you have it, put this configuration somewhere in your code, before you start working with the client.
+
+```ruby
+Cloudpt::API::Config.app_key    = YOUR_APP_TOKEN
+Cloudpt::API::Config.app_secret = YOUR_APP_SECRET
+Cloudpt::API::Config.mode       = "sandbox" # if you have a single-directory app or "Cloudpt" if it has access to the whole Cloudpt
+```
+
+Cloudpt::API::Client
+--------------------
+
+The client is the base for all communication with the API and wraps around almost all calls
+available in the API.
+
+In order to create a Cloudpt::API::Client object, you need to have the configuration set up for OAuth.
+Second thing you need is to have the user authorize your app using OAuth. Here's a short intro
+on how to do this:
+
+```ruby
+consumer = Cloudpt::API::OAuth.consumer(:authorize)
+request_token = consumer.get_request_token
+request_token.authorize_url(:oauth_callback => 'http://yoursite.com/callback')
+# Here the user goes to Cloudpt, authorizes the app and is redirected
+# The oauth_token will be available in the params
+request_token.get_access_token(:oauth_verifier => oauth_token)
+```
+
+Now that you have the oauth token and secret, you can create a new instance of the Cloudpt::API::Client, like this:
+
+```ruby
+client = Cloudpt::API::Client.new :token => token, :secret => secret
+```
+
+Rake-based authorization
+------------------------
+
+Cloudpt::API supplies you with a helper rake which will authorize a single client. This is useful for development and testing.
+
+In order to have this rake available, put this on your Rakefile:
+
+```ruby
+require "cloudpt-api/tasks"
+Cloudpt::API::Tasks.install
+```
+
+You will notice that you have a new rake task - Cloudpt:authorize
+
+When you call this Rake task, it will ask you to provide the consumer key and secret. Afterwards it will present you with an authorize url on Cloudpt.
+
+Simply go to that url, authorize the app, then press enter in the console.
+
+The rake task will output valid ruby code which you can use to create a client.
+
+What differs this from the Cloudpt Ruby SDK?
+--------------------------------------------
+
+A few things:
+
+* It's using the ruby oauth gem, instead of reinventing the wheel and implementing OAuth communication
+* It treats files and directories as Ruby objects with appropriate classes, on which you can perform operations
+
+Consider the following example which takes all files with names like 'test.txt' and copies them with a suffix '.old'
+
+This is how it would look using the SDK:
+
+```ruby
+# Because you need the session with the right access token, you need to create one instance per user
+@session = CloudptSession.new(APP_TOKEN, APP_SECRET)
+@session.set_access_token(ACCESS_TOKEN, ACCESS_SECRET)
+@client = CloudptClient.new(@session, :app_folder)
+# The result is a hash, so we need to call a method on the client, supplying the right key from the hash
+@client.search('/', 'test.txt').each do |hash|
+  @client.file_copy(hash['path'], hash['path'] + ".old")
+end
+```
+
+With Cloudpt::API, you can clean it up, first you put the app token and secret in a config or initializer file:
+
+```ruby
+Cloudpt::API::Config.app_key    = APP_TOKEN
+Cloudpt::API::Config.app_secret = APP_SECRET
+```
+
+And when you want to use it, just create a new client object with a specific access token and secret:
+
+```ruby
+# The app token and secret are read from config, that's all you need to have a client ready for one user
+@client = Cloudpt::API::Client.new(:token  => ACCESS_TOKEN, :secret => ACCESS_SECRET)
+# The file is a Cloudpt::API::File object, so you can call methods on it!
+@client.search('test.txt').each do |file|
+  file.copy(file.path + ".old2")
+end
+```
+
+What differs this from the Cloudpt gem?
+--------------------------------------
+
+Cloudpt::API does not extend the Ruby primitives, like the Cloudpt gem:
+
+https://github.com/RISCfuture/Cloudpt/tree/master/lib/Cloudpt/extensions
+
+Cloudpt::API::Client methods
+----------------------------
+
+### Cloudpt::API::Client#account
+
+Returns a simple object with information about the account:
+
+```ruby
+client.account # => #<Cloudpt::API::Object>
+```
+
+For more info, see [https://www.Cloudpt.com/developers/reference/api#account-info](https://www.Cloudpt.com/developers/reference/api#account-info)
+
+### Cloudpt::API::Client#find
+
+When provided a path, returns a single file or directory
+
+```ruby
+client.find 'file.txt' # => #<Cloudpt::API::File>
+```
+
+### Cloudpt::API::Client#ls
+
+When provided a path, returns a list of files or directories within that path
+
+By default it's the root path:
+
+```ruby
+client.ls # => [#<Cloudpt::API::File>, #<Cloudpt::API::Dir>]
+```
+
+But you can provide your own path:
+
+```ruby
+client.ls 'somedir' # => [#<Cloudpt::API::File>, #<Cloudpt::API::Dir>]
+```
+
+### Cloudpt::API::Client#mkdir
+
+Creates a new directory and returns a Cloudpt::API::Dir object
+
+```ruby
+client.mkdir 'new_dir' # => #<Cloudpt::API::Dir>
+```
+
+### Cloudpt::API::Client#upload
+
+Stores a file with a provided body under a provided name and returns a Cloudpt::API::File object
+
+```ruby
+client.upload 'file.txt', 'file body' # => #<Cloudpt::API::File>
+```
+
+### Cloudpt::API::Client#download
+
+Downloads a file with a provided name and returns it's content
+
+```ruby
+client.download 'file.txt' # => 'file body'
+```
+
+### Cloudpt::API::Client#search
+
+When provided a pattern, returns a list of files or directories within that path
+
+By default it searches the root path:
+
+```ruby
+client.search 'pattern' # => [#<Cloudpt::API::File>, #<Cloudpt::API::Dir>]
+```
+
+However, you can specify your own path:
+
+```ruby
+client.search 'pattern', :path => 'somedir' # => [#<Cloudpt::API::File>, #<Cloudpt::API::Dir>]
+```
+
+### Cloudpt::API::Client#delta
+
+Returns a cursor and a list of files that have changed since the cursor was generated.
+
+```ruby
+delta = client.delta 'abc123'
+delta.cursor # => 'def456'
+delta.entries # => [#<Cloudpt::API::File>, #<Cloudpt::API::Dir>]
+```
+
+When called without a cursor, it returns all the files.
+
+```ruby
+delta = client.delta 'abc123'
+delta.cursor # => 'abc123'
+delta.entries # => [#<Cloudpt::API::File>, #<Cloudpt::API::Dir>]
+```
+
+Cloudpt::API::File and Cloudpt::API::Dir methods
+----------------------------
+
+These methods are shared by Cloudpt::API::File and Cloudpt::API::Dir
+
+### Cloudpt::API::File#copy | Cloudpt::API::Dir#copy
+
+Copies a file/directory to a new specified filename
+
+```ruby
+file.copy 'newfilename.txt' # => #<Cloudpt::API::File>
+```
+
+### Cloudpt::API::File#move | Cloudpt::API::Dir#move
+
+Moves a file/directory to a new specified filename
+
+```ruby
+file.move 'newfilename.txt' # => #<Cloudpt::API::File>
+```
+
+### Cloudpt::API::File#destroy | Cloudpt::API::Dir#destroy
+
+Deletes a file/directory
+
+```ruby
+file.destroy 'newfilename.txt' # => #<Cloudpt::API::File>
+```
+
+
+Cloudpt::API::File methods
+----------------------------
+
+### Cloudpt::API::File#revisions
+
+Returns an Array of Cloudpt::API::File objects with appropriate rev attribute
+
+For more info, see [https://www.Cloudpt.com/developers/reference/api#revisions](https://www.Cloudpt.com/developers/reference/api#revisions)
+
+### Cloudpt::API::File#restore
+
+Restores a file to a specific revision
+
+For more info, see [https://www.Cloudpt.com/developers/reference/api#restore](https://www.Cloudpt.com/developers/reference/api#restore)
+
+### Cloudpt::API::File#share_url
+
+Returns the link to a file page in Cloudpt
+
+For more info, see [https://www.Cloudpt.com/developers/reference/api#shares](https://www.Cloudpt.com/developers/reference/api#shares)
+
+### Cloudpt::API::File#direct_url
+
+Returns the link to a file in Cloudpt
+
+For more info, see [https://www.Cloudpt.com/developers/reference/api#media](https://www.Cloudpt.com/developers/reference/api#media)
+
+### Cloudpt::API::File#thumbnail
+
+Returns the thumbnail for an image
+
+For more info, see [https://www.Cloudpt.com/developers/reference/api#thumbnail](https://www.Cloudpt.com/developers/reference/api#thumbnail)
+
+### Cloudpt::API::File#download
+
+Downloads a file and returns it's content
+
+```ruby
+file.download # => 'file body'
+```
+
+Cloudpt::API::Dir methods
+----------------------------
+
+### Cloudpt::API::Dir#ls
+
+Returns a list of files or directorys within that directory
+
+```ruby
+dir.ls # => [#<Cloudpt::API::File>, #<Cloudpt::API::Dir>]
+```
+
+Testing
+---------
+
+In order to run tests, you need to have an application created and authorized. Put all tokens in spec/connection.yml and you're good to go.
+
+Check out spec/connection.sample.yml for an example.
+
+Copyright
+---------
+
+Copyright (c) 2011 Marcin Bunsch, Future Simple Inc. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/gem_tasks'
+
+require "cloudpt-api/tasks"
+Cloudpt::API::Tasks.install

data/cloudpt-api.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+# regards to Marcin Bunsch, creator of dropbox-api gem.
+$:.push File.expand_path("../lib", __FILE__)
+require "cloudpt-api/version"
+
+Gem::Specification.new do |s|
+  s.name        = "cloudpt-api"
+  s.version     = Cloudpt::API::VERSION
+  s.authors     = ["Fabio Batista"]
+  s.email       = ["fbatista@webreakstuff.com"]
+  s.homepage    = "http://github.com/fbatista/cloudpt-api"
+  s.summary     = "A Ruby client for the cloudpt REST API."
+  s.description = "To deliver a more Rubyesque experience when using the cloudpt API."
+
+  s.rubyforge_project = "cloudpt-api"
+
+  s.add_dependency 'multi_json'
+  s.add_dependency 'oauth'
+  s.add_dependency 'hashie'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/cloudpt-api.rb

@@ -0,0 +1,22 @@
+require "oauth"
+require "multi_json"
+require "hashie"
+
+module Cloudpt
+  module API
+
+  end
+end
+
+require "cloudpt-api/version"
+require "cloudpt-api/util/config"
+require "cloudpt-api/util/oauth"
+require "cloudpt-api/util/error"
+require "cloudpt-api/util/util"
+require "cloudpt-api/objects/object"
+require "cloudpt-api/objects/fileops"
+require "cloudpt-api/objects/file"
+require "cloudpt-api/objects/dir"
+require "cloudpt-api/objects/delta"
+require "cloudpt-api/connection"
+require "cloudpt-api/client"

data/lib/cloudpt-api/client.rb

@@ -0,0 +1,72 @@
+require "cloudpt-api/client/raw"
+require "cloudpt-api/client/files"
+
+module Cloudpt
+  module API
+
+    class Client
+
+      attr_accessor :raw, :connection
+
+      def initialize(options = {})
+        @connection = Cloudpt::API::Connection.new(:token  => options.delete(:token),
+                                                   :secret => options.delete(:secret))
+        @raw        = Cloudpt::API::Raw.new :connection => @connection
+        @options    = options
+      end
+
+      include Cloudpt::API::Client::Files
+
+      def find(filename)
+        data = self.raw.metadata(:path => filename)
+        data.delete('contents')
+        Cloudpt::API::Object.convert(data, self)
+      end
+
+      def list(path = '')
+        response = raw.list :path => path
+      end
+
+      def ls(path = '')
+        Cloudpt::API::Dir.init({'path' => path}, self).ls
+      end
+
+      def account
+        Cloudpt::API::Object.init(self.raw.account, self)
+      end
+
+      def mkdir(path)
+        # Remove the characters not allowed by Cloudpt
+        path = path.gsub(/[\\\:\?\*\<\>\"\|]+/, '')
+        response = raw.create_folder :path => path
+        Cloudpt::API::Dir.init(response, self)
+      end
+
+      def search(term, options = {})
+        options[:path] ||= ''
+        results = raw.search({ :query => term }.merge(options))
+        Cloudpt::API::Object.convert(results, self)
+      end
+
+      def delta(cursor=nil)
+        entries  = []
+        has_more = true
+        params   = cursor ? {:cursor => cursor} : {}
+        while has_more
+          response        = raw.delta(params)
+          params[:cursor] = response['cursor']
+          has_more        = response['has_more']
+          entries.push     *response['entries']
+        end
+
+        files = entries.map do |entry|
+          entry.last || {:is_deleted => true, :path => entry.first}
+        end
+
+        Delta.new(params[:cursor], Cloudpt::API::Object.convert(files, self))
+      end
+
+    end
+
+  end
+end