shroud

[DEAD] A wrapper for the CloudApp REST API

git clone https://git.hawx.me/shroud.git

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta name="Content-Type" content="text/html; charset=utf-8" /> <title>Documentation by YARD 0.5.4</title> <link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" /> <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" /> <script type="text/javascript" charset="utf-8"> relpath = ''; if (relpath != '') relpath += '/'; </script> <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script> <script type="text/javascript" charset="utf-8" src="js/app.js"></script> </head> <body> <script type="text/javascript" charset="utf-8"> if (window.top.frames.main) document.body.className = 'frames'; </script> <div id="header"> <div id="menu"> <a href="_index.html" title="Index">Index</a> » File: README <div class="noframes">(<a href="." target="_top">no frames</a>)</div> </div> <div id="search"> <a id="class_list_link" href="#">Class List</a> <a id="method_list_link" href="#">Method List</a> <a id ="file_list_link" href="#">File List</a> </div> <div class="clear"></div> </div> <iframe id="search_frame"></iframe> <div id="content"><div id='filecontents'><h1 id='shroud'>Shroud</h1> A ruby wrapper for <a href='http://getcloudapp.com/'>Cloud.app’s</a> <a href='http://support.getcloudapp.com/faqs/developers/api'>REST API</a>. NB: If you try to upload an item and wonder why it doesn’t work, it’s because it doesn’t work yet. I am working on it. <h2 id='example'>Example</h2> <pre class="code">require 'shroud' Shroud.get_item('a') #=> returns a hash of info on http://cl.ly/a # For every other thing you need to log in c = Shroud::Session.new('my_email', 'my_password') c.list_items(:type => 'image') #=> return a list of my recent images b = c.create_bookmark('http://getcloudapp.com/', 'CloudApp') #=> Shorten url c.delete_item(b['slug']) #=> Delete the bookmark you just created # not working atm c.upload_file('list.txt') #=> uploads 'list.txt'</pre> <h2 id='command_line'>Command Line</h2> You can use the <code>shroud</code> executable to interact with the REST API from the command line. Type <code>shroud -h</code> to see the list of commands. To add your login details you need to edit your <code>~/.bashrc</code> and add: <pre class="code">export SHROUD_USER="yourusername" export SHROUD_PASS="yourpassword"</pre> <h2 id='license'>License</h2> MIT LICENSE Copyright (c) 2010 Joshua Hawxwell 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.</div></div> <div id="footer"> Generated on Thu May 13 18:53:17 2010 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a> 0.5.4 (ruby-1.9.1). </div> </body> </html>