tumble 0.0.8 → 0.1.1

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Aubrey Holland
+
+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.md

@@ -1,2 +1,52 @@
 # Tumble #
+A Ruby wrapper for the v2 of Tumblr's API, supporting all endpoints.
+
+## <a name="installation"></a>Install
+    gem install tumble
+
+## <a name="configuration"></a>Configure
+
+The gem is designed to work with Tumblr's OAuth provider for authentication. If you're using omniauth,
+there's a fine adapter available [here](https://github.com/aub/omniauth-tumblr2). You'll also need to
+register your app [here](http://www.tumblr.com/oauth/apps) in order to get a consumer key and secret.
+Once you have those values, you can configure Tumble in an initializer like so:
+
+    require 'tumble'
+
+    Tumble.configure do |tumble|
+      tumble.consumer_key = config['tumblr']['key']
+      tumble.consumer_secret = config['tumblr']['secret']
+    end
+
+## <a name="usage"></a>Use
+
+Connections can then be made by creating a client, passing the OAuth token and secret you get back from
+omniauth:
+
+    client = Tumble::Client.new(access_token, access_secret)
+
+User-related endpoints can be accessed through the client directly, as documented [here](http://rdoc.info/github/aub/tumble/Tumble/Client).
+For example:
+
+    client.user_info
+
+All methods will return a Hashie::Mash of the results. For data about blogs and posts, use the blog() method on
+the client, passing the name of the blog. The methods for blogs are documented [here](http://rdoc.info/github/aub/tumble/Tumble/Blog).
+For example, getting posts for a specific blog can be done like this:
+
+    client.blog('www.riotprojects.com').posts
+
+Most of the calls allow for options to be passed, as a hash. Options are documented in the links above and are consistent
+with the naming and functionality described in the [Tumblr docs](https://github.com/aub/omniauth-tumblr2).
+
+## <a name="documentation"></a>Learn
+[http://rdoc.info/github/aub/tumble][documentation]
+
+[documentation]: http://rdoc.info/github/aub/tumble
+
+## <a name="copyright"></a>Copyright
+Copyright (c) 2012 Aubrey Holland
+See [LICENSE][] for details.
+
+[license]: https://github.com/aub/tumble/blob/master/LICENSE.md
 

data/lib/tumble/blog.rb

@@ -13,7 +13,7 @@ module Tumble
     # @see http://www.tumblr.com/docs/en/api/v2#blog-info
     # @requires_authentication Yes
     def info
-      @connection.get("/blog/#{name}/info")
+      @connection.get("/blog/#{name}/info").response
     end
 
     # You can get a blog's avatar in 9 different sizes. The default size is 64x64.
@@ -24,7 +24,7 @@ module Tumble
     # @param options [Hash] A customizable set of options.
     # @option options [Integer] :size The size of the avatar. Must be in 16, 24, 30, 40, 48, 64, 96, 128, or 512
     def avatar(options={})
-      @connection.get("/blog/#{name}/avatar", options)
+      @connection.get("/blog/#{name}/avatar", options).response
     end
 
     # Retrieve a Blog's Followers
@@ -36,7 +36,7 @@ module Tumble
     # @option options [Integer] :limit The number of results to return: 1–20, inclusive
     # @option options [Integer] :offset Result to start at
     def followers(options={})
-      @connection.get("/blog/#{name}/followers", options)
+      @connection.get("/blog/#{name}/followers", options).response
     end
 
     # Retrieve Published Posts
@@ -54,7 +54,7 @@ module Tumble
     # @option options [Boolean] :notes_info Indicates whether to return notes information (specify true or false). Returns note count and note metadata.
     # @option options [String] :format Specifies the post format to return, other than HTML. Must be either text or raw.
     def posts(options={})
-      @connection.get("/blog/#{name}/posts", options)
+      @connection.get("/blog/#{name}/posts", options).response
     end
 
     # Retrieve Queued Posts
@@ -62,7 +62,7 @@ module Tumble
     # @see http://www.tumblr.com/docs/en/api/v2#blog-queue
     # @requires_authentication Yes
     def queue
-      @connection.get("/blog/#{name}/posts/queue")
+      @connection.get("/blog/#{name}/posts/queue").response
     end
 
     # Retreive Draft Posts
@@ -70,7 +70,7 @@ module Tumble
     # @see http://www.tumblr.com/docs/en/api/v2#blog-drafts
     # @requires_authentication Yes
     def drafts
-      @connection.get("/blog/#{name}/posts/draft")
+      @connection.get("/blog/#{name}/posts/draft").response
     end
 
     # Retreive Submission Posts
@@ -78,7 +78,7 @@ module Tumble
     # @see http://www.tumblr.com/docs/en/api/v2#blog-submissions
     # @requires_authentication Yes
     def submissions
-      @connection.get("/blog/#{name}/posts/submission")
+      @connection.get("/blog/#{name}/posts/submission").response
     end
 
     # Create a New Blog Post
@@ -121,7 +121,7 @@ module Tumble
     # @option options [String] :embed HTML embed code for the video
     # @option options [String] :data A video file
     def create_post(options={})
-      @connection.post("/blog/#{name}/post", options)
+      @connection.post("/blog/#{name}/post", options).response
     end
 
     # Edit a Blog Post
@@ -166,7 +166,7 @@ module Tumble
     # @option options [String] :data A video file
 
     def edit_post(id, options={})
-      @connection.post("/blog/#{name}/post/edit", options.merge('id' => id))
+      @connection.post("/blog/#{name}/post/edit", options.merge('id' => id)).response
     end
 
     # Reblog a Post
@@ -179,7 +179,7 @@ module Tumble
     # @param options [Hash] A customizable set of options
     # @option options [String] :comment A comment added to the reblogged post
     def reblog_post(id, reblog_key, options={})
-      @connection.post("/blog/#{name}/post/reblog", options.merge('id' => id, 'reblog_key' => reblog_key))
+      @connection.post("/blog/#{name}/post/reblog", options.merge('id' => id, 'reblog_key' => reblog_key)).response
     end
 
     # Delete a Post
@@ -189,7 +189,7 @@ module Tumble
     #
     # @param id [Integer] The ID of the post to delete
     def delete_post(id)
-      @connection.post("/blog/#{name}/post/delete", :id => id)
+      @connection.post("/blog/#{name}/post/delete", :id => id).response
     end
   end
 end

data/lib/tumble.rb

@@ -3,7 +3,7 @@
 end
 
 module Tumble
-  VERSION = '0.0.8'
+  VERSION = '0.1.1'
 
   def self.configure
     yield Config

data/tumble.gemspec

@@ -3,7 +3,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 1.3.5") if s.respond_to? :required_rubygems_version=
 
   s.name    = 'tumble'
-  s.version = '0.0.8'
+  s.version = '0.1.1'
 
   s.summary     = 'Library for accessing the Tumblr api v2'
   # TODO: s.description
@@ -20,6 +20,7 @@ Gem::Specification.new do |s|
   # = MANIFEST =
   s.files = %w[
     Gemfile
+    LICENSE.md
     README.md
     Rakefile
     lib/tumble.rb

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tumble
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-17 00:00:00.000000000 -05:00
+date: 2012-02-18 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70285287262640 !ruby/object:Gem::Requirement
+  requirement: &70222430403580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70285287262640
+  version_requirements: *70222430403580
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70285287262180 !ruby/object:Gem::Requirement
+  requirement: &70222430403120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70285287262180
+  version_requirements: *70222430403120
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70285287261760 !ruby/object:Gem::Requirement
+  requirement: &70222430435700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70285287261760
+  version_requirements: *70222430435700
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70285287261340 !ruby/object:Gem::Requirement
+  requirement: &70222430435280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70285287261340
+  version_requirements: *70222430435280
 description: 
 email: aubreyholland@gmail.com
 executables: []
@@ -63,6 +63,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - Gemfile
+- LICENSE.md
 - README.md
 - Rakefile
 - lib/tumble.rb