tumble 0.0.3 → 0.0.4

data/lib/tumble/blog.rb

@@ -1,14 +1,195 @@
 module Tumble
   class Blog
-    def initialize(client, name)
-      @client = client
+    def initialize(connection, name)
+      @connection = connection
       @name = name
     end
 
     attr_reader :name
 
+    # This method returns general information about the blog, such as the title, 
+    # number of posts, and other high-level data.
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#blog-info
+    # @requires_authentication Yes
     def info
-      @client.connection.get("blog/#{name}/info")
+      @connection.get("/blog/#{name}/info")
+    end
+
+    # You can get a blog's avatar in 9 different sizes. The default size is 64x64.
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#blog-avatar
+    # @requires_authentication No
+    #
+    # @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)
+    end
+
+    # Retrieve a Blog's Followers
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#blog-followers
+    # @requires_authentication Yes
+    #
+    # @param options [Hash] A customizable set of options.
+    # @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)
+    end
+
+    # Retrieve Published Posts
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#posts
+    # @requires_authentication Yes
+    #
+    # @param options [Hash] A customizable set of options.
+    # @option options [String] :type The type of post to return. Specify one of the following:  text, quote, link, answer, video, audio, photo
+    # @option options [Integer] :id A specific post ID. Returns the single post specified or (if not found) a 404 error.
+    # @option options [String] :tag Limits the response to posts with the specified tag
+    # @option options [Integer] :limit The number of posts to return: 1–20, inclusive
+    # @option options [Integer] :offset Post number to start at
+    # @option options [Boolean] :reblog_info Indicates whether to return reblog information (specify true or false). Returns the various reblogged_ fields.
+    # @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)
+    end
+
+    # Retrieve Queued Posts
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#blog-queue
+    # @requires_authentication Yes
+    def queue
+      @connection.get("/blog/#{name}/posts/queue")
+    end
+
+    # Retreive Draft Posts
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#blog-drafts
+    # @requires_authentication Yes
+    def drafts
+      @connection.get("/blog/#{name}/posts/draft")
+    end
+
+    # Retreive Submission Posts
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#blog-submissions
+    # @requires_authentication Yes
+    def submissions
+      @connection.get("/blog/#{name}/posts/submission")
+    end
+
+    # Create a New Blog Post
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#posting
+    # @requires_authentication Yes
+    #
+    # @param options [Hash] A customizable set of options
+    # @option options [String] :type The type of post to create. Specify one of the following:  text, photo, quote, link, chat, audio, video
+    # @option options [String] :state The state of the post. Specify one of the following:  published, draft, queue
+    # @option options [String] :tags Comma-separated tags for this post
+    # @option options [String] :tweet Manages the autotweet (if enabled) for this post: set to off for no tweet, or enter text to override the default tweet
+    # @option options [String] :date The GMT date and time of the post, as a string
+    # @option options [Boolean] :markdown Indicates whether the post uses markdown syntax
+    # @option options [String] :slug Add a short text summary to the end of the post URL
+    # For text posts:
+    # @option options [String] :title The optional title of the post, HTML entities must be escaped
+    # @option options [String] :body The full post body, HTML allowed
+    # For photo posts:
+    # @option options [String] :caption The user-supplied caption, HTML allowed
+    # @option options [String] :link The "click-through URL" for the photo
+    # @option options [String] :source The photo source URL
+    # @option options [Array] :data One or more image files (submit multiple times to create a slide show)
+    # For quote posts:
+    # @option options [String] :quote The full text of the quote, HTML entities must be escaped
+    # @option options [String] :source Cited source, HTML allowed
+    # For link posts:
+    # @option options [String] :title The title of the page the link points to, HTML entities should be escaped
+    # @option options [String] :url The link
+    # @option options [String] :description A user-supplied description, HTML allowed
+    # For chat posts:
+    # @option options [String] :title The title of the chat
+    # @option options [String] :conversation The text of the conversation/chat, with dialogue labels (no HTML)
+    # For audio posts:
+    # @option options [String] :caption The user-supplied caption
+    # @option options [String] :external_url The URL of the site that hosts the audio file (not tumblr)
+    # @option options [String] :data An audio file
+    # For video posts:
+    # @option options [String] :caption The user-supplied caption
+    # @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)
+    end
+
+    # Edit a Blog Post
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#editing
+    # @requires_authentication Yes
+    #
+    # @param id [Integer] The ID of the post to edit
+    # @param options [Hash] A customizable set of options
+    # @option options [String] :type The type of post to create. Specify one of the following:  text, photo, quote, link, chat, audio, video
+    # @option options [String] :state The state of the post. Specify one of the following:  published, draft, queue
+    # @option options [String] :tags Comma-separated tags for this post
+    # @option options [String] :tweet Manages the autotweet (if enabled) for this post: set to off for no tweet, or enter text to override the default tweet
+    # @option options [String] :date The GMT date and time of the post, as a string
+    # @option options [Boolean] :markdown Indicates whether the post uses markdown syntax
+    # @option options [String] :slug Add a short text summary to the end of the post URL
+    # For text posts:
+    # @option options [String] :title The optional title of the post, HTML entities must be escaped
+    # @option options [String] :body The full post body, HTML allowed
+    # For photo posts:
+    # @option options [String] :caption The user-supplied caption, HTML allowed
+    # @option options [String] :link The "click-through URL" for the photo
+    # @option options [String] :source The photo source URL
+    # @option options [Array] :data One or more image files (submit multiple times to create a slide show)
+    # For quote posts:
+    # @option options [String] :quote The full text of the quote, HTML entities must be escaped
+    # @option options [String] :source Cited source, HTML allowed
+    # For link posts:
+    # @option options [String] :title The title of the page the link points to, HTML entities should be escaped
+    # @option options [String] :url The link
+    # @option options [String] :description A user-supplied description, HTML allowed
+    # For chat posts:
+    # @option options [String] :title The title of the chat
+    # @option options [String] :conversation The text of the conversation/chat, with dialogue labels (no HTML)
+    # For audio posts:
+    # @option options [String] :caption The user-supplied caption
+    # @option options [String] :external_url The URL of the site that hosts the audio file (not tumblr)
+    # @option options [String] :data An audio file
+    # For video posts:
+    # @option options [String] :caption The user-supplied caption
+    # @option options [String] :embed HTML embed code for the video
+    # @option options [String] :data A video file
+
+    def edit_post(id, options={})
+      @connection.post("/blog/#{name}/post/edit", options.merge('id' => id))
+    end
+
+    # Reblog a Post
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#reblogging
+    # @requires_authentication Yes
+    #
+    # @param id [Integer] The ID of the reblogged post on tumblelog
+    # @param reblog_key [Integer] The reblog key for the reblogged post – get the reblog key with a /posts request
+    # @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))
+    end
+
+    # Delete a Post
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#deleting-posts
+    # @requires_authentication Yes
+    #
+    # @param id [Integer] The ID of the post to delete
+    def delete_post(id)
+      @connection.post("/blog/#{name}/post/delete", :id => id)
     end
   end
 end

data/lib/tumble/client.rb

@@ -9,48 +9,101 @@ module Tumble
     # @param [String] oauth_token
     # @param [String] oauth_secret
     def initialize(access_token, access_secret)
-      @access_token = access_token
-      @access_secret = access_secret
+      @connection = Connection.new(access_token, access_secret)
     end
     
-    def connection
-      options = {
-        :url => api_url,
-        :params => { :oauth_token => @oauth_token },
-        :headers => {
-          :accept =>  'application/json',
-          :user_agent => 'tumble'
-        }
-      }
-      @connection ||= Faraday::Connection.new(options) do |builder|
-        builder.use Faraday::Request::Multipart
-        builder.use Faraday::Request::UrlEncoded
-        builder.use FaradayMiddleware::Mashify
-        builder.use FaradayMiddleware::ParseJson
-        builder.use Tumble::Request::TumblrOAuth, credentials
-        builder.adapter Faraday.default_adapter
-      end
-    end
-
-    def api_url
-      'http://api.tumblr.com/v2'
-    end
-
-    def blog(blog_name)
-      Blog.new(self, blog_name)
-    end
-
-    def credentials
-      {
-        :consumer_key => Config.consumer_key,
-        :consumer_secret => Config.consumer_secret,
-        :token => @access_token,
-        :token_secret => @access_secret,
-      }
+    def blog(name)
+      Blog.new(@connection, name)
     end
 
+    # Get Info for the Authenticated User
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#user-methods
+    # @requires_authentication Yes
     def user_info
-      @connection.post('http://api.tumblr.com/v2/user/info')
+      @connection.post('/user/info').body.response.user
+    end
+
+    # Retrieve a User's Dashboard
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#user-methods
+    # @requires_authentication Yes
+    # 
+    # @param options [Hash] A customizable set of options.
+    # @option options [Integer] :limit The number of results to return: 1–20, inclusive
+    # @option options [Integer] :offset Post number to start at
+    # @option options [String] :type The type of post to return. Specify one of the following:  text, photo, quote, link, chat, audio, video, question
+    # @option options [Integer] :since_id Return posts that have appeared after this ID
+    # @option options [Boolean] :reblog_info Indicates whether to return reblog information (specify true or false). Returns the various reblogged_ fields.
+    # @option options [Boolean] :notes_info Indicates whether to return notes information (specify true or false). Returns note count and note metadata.
+    def dashboard(options={})
+      @connection.get('/user/dashboard')
+    end
+
+    # Retrieve a User's Likes
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#user-methods
+    # @requires_authentication Yes
+    # 
+    # @param options [Hash] A customizable set of options.
+    # @option options [Integer] :limit The number of results to return: 1–20, inclusive
+    # @option options [Integer] :offset Post number to start at
+    def likes(options={})
+      @connection.get('/user/likes')
+    end
+
+    # Retrieve the Blogs a User Is Following
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#user-methods
+    # @requires_authentication Yes
+    # 
+    # @param options [Hash] A customizable set of options.
+    # @option options [Integer] :limit The number of results to return: 1–20, inclusive
+    # @option options [Integer] :offset Post number to start at
+    def following(options={})
+      @connection.get('/user/following')
+    end
+
+    # Follow a Blog
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#user-methods
+    # @requires_authentication Yes
+    # 
+    # @param url [String] The URL of the blog to follow
+    def follow(url)
+      @connection.post('/user/follow', :url => url)
+    end
+
+    # Unfollow a Blog
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#user-methods
+    # @requires_authentication Yes
+    # 
+    # @param url [String] The URL of the blog to follow
+    def unfollow(url)
+      @connection.post('/user/unfollow', :url => url)
+    end
+
+    # Like a Post
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#user-methods
+    # @requires_authentication Yes
+    # 
+    # @param id [Integer] The ID of the post to like
+    # @param reblog_key [String] The reblog key for the post id
+    def like(id, reblog_key)
+      @connection.post('/user/like', :id => id, :reblog_key => reblog_key) 
+    end
+
+    # Unlike a Post
+    #
+    # @see http://www.tumblr.com/docs/en/api/v2#user-methods
+    # @requires_authentication Yes
+    # 
+    # @param id [Integer] The ID of the post to unlike
+    # @param reblog_key [String] The reblog key for the post id
+    def unlike(id, reblog_key)
+      @connection.post('/user/unlike', :id => id, :reblog_key => reblog_key) 
     end
   end
 end

data/lib/tumble/connection.rb

@@ -0,0 +1,72 @@
+module Tumble
+  class Connection
+
+    def initialize(token, secret)
+      @token = token
+      @secret = secret
+      @faraday_connection = faraday_connection
+    end
+
+    def base_url
+      'http://api.tumblr.com/'
+    end
+
+    def delete(path, params={})
+      request(:delete, path, params)
+    end
+
+    # Perform an HTTP GET request
+    def get(path, params={})
+      request(:get, path, params)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params={})
+      request(:post, path, params)
+    end
+
+    private
+
+    def request(method, path, params)
+      path = "/v2#{path}" unless path =~ /^\/v2/
+      response = @faraday_connection.send(method) do |request|
+        case method
+        when :delete, :get
+          request.url(path, params)
+        when :post
+          request.path = path
+          request.body = params unless params.empty?
+        end
+      end
+      response.body
+    end
+
+    def faraday_connection
+      options = {
+        :url => base_url,
+        :params => { :oauth_token => @token },
+        :headers => {
+          :accept =>  'application/json',
+          :user_agent => 'tumble'
+        }
+      }
+      Faraday::Connection.new(options) do |builder|
+        builder.use Faraday::Request::Multipart
+        builder.use Faraday::Request::UrlEncoded
+        builder.use FaradayMiddleware::Mashify
+        builder.use FaradayMiddleware::ParseJson
+        builder.use Tumble::Request::TumblrOAuth, credentials
+        builder.adapter Faraday.default_adapter
+      end
+    end
+
+    def credentials
+      {
+        :consumer_key => Config.consumer_key,
+        :consumer_secret => Config.consumer_secret,
+        :token => @token,
+        :token_secret => @secret,
+      }
+    end
+  end
+end

data/lib/tumble.rb

@@ -1,11 +1,11 @@
-%w(blog client config request/oauth).each do |file|
+%w(blog client config connection request/oauth).each do |file|
   require File.join(File.dirname(__FILE__), 'tumble', file)
 end
 
 module Tumble
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 
-  def self.config
+  def self.configure
     yield Config
     Config
   end

data/spec/connection_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Tumble::Connection do
+  let(:connection) { Tumble::Connection.new('abc', '123') }
+
+  it 'should perform a get request' do
+    stub = WebMock.stub_request(:get, /http:\/\/api\.tumblr\.com\/v2\/user\/info?.*/)
+    connection.get('/user/info')
+    stub.should have_been_requested
+  end
+
+  it 'should perform a post request' do
+    stub = WebMock.stub_request(:post, /http:\/\/api\.tumblr\.com\/v2\/user\/info?.*/)
+    connection.post('/user/info')
+    stub.should have_been_requested
+  end
+end

data/spec/spec_helper.rb

@@ -2,5 +2,5 @@ require 'tumble'
 
 require 'webmock/rspec'
 
-# WebMock.disable_net_connect!
-WebMock.allow_net_connect!
+WebMock.disable_net_connect!
+# WebMock.allow_net_connect!

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.3'
+  s.version = '0.0.4'
 
   s.summary     = 'Library for accessing the Tumblr api v2'
   # TODO: s.description
@@ -26,10 +26,12 @@ Gem::Specification.new do |s|
     lib/tumble/blog.rb
     lib/tumble/client.rb
     lib/tumble/config.rb
+    lib/tumble/connection.rb
     lib/tumble/request/oauth.rb
     spec/blog_spec.rb
     spec/client_spec.rb
     spec/config_spec.rb
+    spec/connection_spec.rb
     spec/oauth_spec.rb
     spec/spec_helper.rb
     tumble.gemspec

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tumble
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70176759564620 !ruby/object:Gem::Requirement
+  requirement: &2162083700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70176759564620
+  version_requirements: *2162083700
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70176759563740 !ruby/object:Gem::Requirement
+  requirement: &2162083240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70176759563740
+  version_requirements: *2162083240
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70176759555780 !ruby/object:Gem::Requirement
+  requirement: &2162082820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70176759555780
+  version_requirements: *2162082820
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70176759555040 !ruby/object:Gem::Requirement
+  requirement: &2162082400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70176759555040
+  version_requirements: *2162082400
 description: 
 email: aubreyholland@gmail.com
 executables: []
@@ -69,10 +69,12 @@ files:
 - lib/tumble/blog.rb
 - lib/tumble/client.rb
 - lib/tumble/config.rb
+- lib/tumble/connection.rb
 - lib/tumble/request/oauth.rb
 - spec/blog_spec.rb
 - spec/client_spec.rb
 - spec/config_spec.rb
+- spec/connection_spec.rb
 - spec/oauth_spec.rb
 - spec/spec_helper.rb
 - tumble.gemspec