Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Add README and License

  • Loading branch information...
commit 8b12c5f8da72c1864d4626a3b332bd10ad359748 1 parent fba4a89
Riccardo Cambiassi authored
Showing with 56 additions and 0 deletions.
  1. +8 −0 License.md
  2. +48 −0 README.md
View
8 License.md
@@ -0,0 +1,8 @@
+Copyright (c) 2012 Riccardo Cambiassi
+
+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.
+
View
48 README.md
@@ -0,0 +1,48 @@
+# Radian6
+
+Radian6 gem is a (rough) ruby interface to the Radian6 EST API (http://labs.radian6.com/api/)
+
+## INSTALLATION
+
+ gem install radian6
+
+## Usage
+
+ # connect to the API
+ api = Radian6::API.new(username, password, app_key, :sandbox =>
+true, :proxy => myproxy, :debug => true, :async => false)
+
+ # get a XML dump of the posts within a specified range
+ posts_xml = api.fetchRangeTopicPostsXML( ((Time.now - 3600)*1000).to_s, (Time.now * 1000).to_s, [topic])
+
+ # get topics
+ topics = api.topics
+
+
+
+## Status
+
+This is just the first draft of the wrapper. It can be improved in many, many ways.
+The API class in particular is quite messy, as it's the result of several experiments, expect it to change quite dramatically in the near future.
+
+Feel free to help (see Contributing below)
+
+## TODO
+
+* Clean up API class (maybe structuring the various calls in different "services" as suggested by the API documentation)
+* better support for object output (right now only Post and Topic are
+ supported)
+* remove the option to generate objects from xml as it's too slow and hogs the memory when dealing with big pages.
+
+## Contributing to the code (a.k.a. submitting a pull request)
+
+1. Fork the project.
+2. Create a topic branch.
+3. Implement your feature or bug fix.
+4. Commit and push your changes.
+5. Submit a pull request. Please do not include changes to the gemspec, version, or history file. (If you want to create your own version for some reason, please do so in a separate commit.)
+
+
+## Copyright
+
+Copyright (c) 2012 Riccardo Cambiassi. See LICENSE for details.
Please sign in to comment.
Something went wrong with that request. Please try again.