tumblr_client 0.5

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,26 @@
+Copyright (c) 2012, John Bunting, Tumblr, Inc.
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice,
+this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright
+notice, this list of conditions and the following disclaimer in the
+documentation and/or other materials provided with the distribution.
+* Neither the name of Tumblr, Inc. nor the names of its contributors may
+be used to endorse or promote products derived from this software without
+specific prior written permission.
+* This license can change at any time.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,78 @@
+# Tumblr Ruby Gem
+
+This is a ruby wrapper for the Tumblr v2 API. There should be support for all endpoints
+currently available on the [Tumblr API](http://www.tumblr.com/docs/en/api/v2).
+
+## Installation
+
+It hasn't been submitted to ruby gems yet so you'll have to build your gem first. 
+
+    gem build tumblr.gemspec
+
+Then you can just install with:
+
+    gem install tumblr-0.5.gem
+
+## Usage
+
+First and foremost, this gem will *not* do a three legged oauth request for you. It is just a wrapper to help make
+your life easier when using the v2 api. If you need to do the full oauth workflow, then please check out the 
+[Ruby OAuth Gem](http://oauth.rubyforge.org/).
+
+### Configuration
+
+Configuration for the gem is actually pretty easy:
+
+    Tumblr.configure do |config|
+        config.consumer_key = "consumer_key"
+        config.consumer_secret = "consumer_secret"
+        config.oauth_token = "access_token"
+        config.oauth_token_secret = "access_token_secret"
+    end
+
+Once you have your configuration squared away it's time to make some requests!
+
+    >> client = Tumblr.new
+
+That's it! You now have a client that can make any request to the Tumblr API.
+
+### Some quick examples
+
+Getting use information:
+    
+    >> client.info
+
+Getting a specific blog's posts and type:
+    
+    #Grabbing a specific blogs posts
+    >> client.posts("codingjester.tumblr.com")
+    
+    #Grabbing only the last 10 photos off the blog
+    >> client.posts("codingjester.tumblr.com", "photo", :limit => 10)
+
+
+Posting some photos to Tumblr:
+
+    #Uploads a great photoset
+    >> client.photo("codingjester.tumblr.com", {:data => ['/path/to/pic.jpg', '/path/to/pic.jpg']}) 
+
+### The irb Console
+
+Finally, there is an irb console packaged with the gem that should help you test any calls you want to make.
+The magic here is that you have a ```.tumblr``` file in your home directory. Inside this file it's just a basic
+YAML layout with four lines:
+
+    consumer_key: "your_consumer_key"
+    consumer_secret: "your_consumer_secret"
+    oauth_token: "your_access_token"
+    oauth_token_secret: "your_access_token_secret"
+
+From there, you should be able to run any of the above commands, with no problem! Just fire off the command ```tumblr``
+from the terminal and you should be dropped into a console.
+
+
+### Contributions and Pull Requests
+
+No request is too small and I encourage everyone to get involved. As you can see, we're sorely lacking in tests! So
+please if you would like to contribute, let me know and throw me a pull request!
+

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec

data/bin/tumblr

@@ -0,0 +1,33 @@
+#!/usr/bin/env ruby
+$:.unshift File.join File.dirname(__FILE__), '..', 'lib'
+require 'rubygems'
+require 'tumblr'
+require 'yaml'
+require 'irb'
+require 'irb/completion'
+
+configuration = YAML.load_file File.join ENV['HOME'], '.tumblr' rescue {}
+
+ENV['IRBRC'] = '.irbrc' if File.exists? '.irbrc'
+
+Tumblr.configure do |config|
+  config.consumer_key = configuration["consumer_key"]
+  config.consumer_secret = configuration["consumer_secret"]
+  config.oauth_token = configuration["oauth_token"]
+  config.oauth_token_secret = configuration["oauth_token_secret"]
+end
+
+puts %q[
+        .                                 .o8       oooo
+      .o8                                "888       `888
+    .o888oo oooo  oooo  ooo. .oo.  .oo.   888oooo.   888  oooo d8b
+      888   `888  `888  `888P"Y88bP"Y88b  d88' `88b  888  `888""8P
+      888    888   888   888   888   888  888   888  888   888
+      888 .  888   888   888   888   888  888   888  888   888    .o.
+      "888"  `V88V"V8P' o888o o888o o888o `Y8bod8P' o888o d888b   Y8P
+
+]
+
+ARGV.clear
+IRB.start
+exit!

data/lib/tumblr.rb

@@ -0,0 +1,11 @@
+require "tumblr/client"
+require "tumblr/config"
+
+module Tumblr
+  extend Config
+  class << self
+    def new(options={})
+      Tumblr::Client.new(options)
+    end
+  end
+end

data/lib/tumblr/blog.rb

@@ -0,0 +1,56 @@
+module Tumblr
+  class Client
+    module Blog
+      
+      #
+      #Gets the info about the blog
+      #
+      def blog_info(blog_name)
+        info = get("v2/blog/#{blog_name}/info", {:api_key => Tumblr::consumer_key})
+      end
+    
+      #
+      #Gets the avatar of specified size
+      #Defaults to 64
+      #
+      def avatar(blog_name, size=64)
+        avatar = get("v2/blog/#{blog_name}/avatar", {:size => size})
+      end
+    
+      #
+      # Gets the list of followers for the blog
+      #
+      def followers(blog_name, options={})
+        if valid_options([:limit, :offset], options)
+           get("v2/blog/#{blog_name}/followers", options)
+        end
+      end
+
+      def posts(blog_name, type=false, options={})
+        url = "v2/blog/#{blog_name}/posts"
+        
+        if type
+          url = "#{url}/#{type}"
+        end
+        
+        params = {:api_key => Tumblr::consumer_key}
+        unless options.empty?
+          params.merge!(options)
+        end
+        get(url, params)
+      end
+
+      def queue(blog_name)
+        get("v2/blog/#{blog_name}/posts/queue", {})
+      end
+      
+      def draft(blog_name)
+        get("v2/blog/#{blog_name}/posts/draft", {})
+      end
+        
+      def submissions(blog_name)
+        get("v2/blog/#{blog_name}/posts/submission", {})
+      end
+    end
+  end
+end

data/lib/tumblr/client.rb

@@ -0,0 +1,24 @@
+require 'tumblr/blog'
+require 'tumblr/user'
+require 'tumblr/request'
+require 'tumblr/connection'
+require 'tumblr/post'
+require 'tumblr/helpers'
+
+module Tumblr
+  class Client
+    include Tumblr::Request
+    include Tumblr::Client::Blog
+    include Tumblr::Client::User
+    include Tumblr::Client::Post
+    include Tumblr::Client::Helper
+    include Tumblr::Connection
+    
+    def initialize(attrs= {})
+      attrs = Tumblr.options.merge(attrs)
+      Config::VALID_OPTIONS_KEYS.each do |key|
+        instance_variable_set("@#{key}".to_sym, attrs[key])
+      end
+    end
+  end
+end

data/lib/tumblr/config.rb

@@ -0,0 +1,36 @@
+module Tumblr
+  
+  module Config
+
+    VALID_OPTIONS_KEYS = [
+      :consumer_key,
+      :consumer_secret,
+      :oauth_token,
+      :oauth_token_secret
+    ]
+    
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def configure
+      yield self
+      self
+    end
+    
+    def options
+      options = {}
+      VALID_OPTIONS_KEYS.each{ |k| options[k] = send(k) }
+      options
+    end
+
+    def credentials
+      {
+          :consumer_key => consumer_key,
+          :consumer_secret => consumer_secret,
+          :token => oauth_token,
+          :token_secret => oauth_token_secret
+      }
+    end
+
+  end
+
+end

data/lib/tumblr/connection.rb

@@ -0,0 +1,23 @@
+require 'faraday'
+require 'faraday_stack'
+require 'tumblr/request/oauth'
+
+module Tumblr
+  module Connection
+    def connection(options={})
+      default_options = {
+        :headers => {
+          :accept => "application/json",
+          :user_agent => "Tumblr v1.0"
+        },
+        :url => "http://api.tumblr.com/"
+      }
+      Faraday.new("http://api.tumblr.com/", default_options.merge(options)) do |builder|
+        builder.use FaradayStack::ResponseJSON, content_type: "application/json"
+        builder.use Tumblr::Request::TumblrOAuth, Tumblr::credentials if not Tumblr::credentials.empty?
+        builder.use Faraday::Request::UrlEncoded
+        builder.use Faraday::Adapter::NetHttp
+      end
+    end
+  end
+end

data/lib/tumblr/helpers.rb

@@ -0,0 +1,13 @@
+module Tumblr
+  class Client
+    module Helper
+      def valid_options(valid_opts, opts)
+        bad_opts = opts.select { |val| !valid_opts.include?(val) }
+        if !bad_opts.empty?
+          raise Exception, "Invalid options passed, Only #{valid_opts} allowed."
+        end
+        return true
+      end
+    end
+  end
+end

data/lib/tumblr/post.rb

@@ -0,0 +1,73 @@
+module Tumblr
+  class Client
+    module Post
+      
+      def edit(blog_name, options={})
+        post("v2/blog/#{blog_name}/post/edit", options)  
+      end
+
+      #Don't be lazy and create a nice interface
+      def reblog(blog_name, options={})
+        post("v2/blog/#{blog_name}/post/reblog", options)  
+      end
+      
+      def delete(blog_name, id)
+        post("v2/blog/#{blog_name}/post/delete", {:id => id})  
+      end
+
+      def photo(blog_name, options={})
+        options[:type] = "photo"
+        if options.has_key?(:data)
+          #Probably can be refactored
+          if options[:data].kind_of?(Array)
+            count = 0
+            options[:data].each do |filepath|
+              options["data[#{count}]"] = File.open(filepath, 'rb').read()
+              count += 1
+            end
+            options.delete(:data)
+          else
+            options[:data] = File.open(options[:data],'rb').read()
+          end
+        end
+        post("v2/blog/#{blog_name}/post", options)  
+      end
+      
+      def quote(blog_name, options={})
+        options[:type] = "quote"
+        post("v2/blog/#{blog_name}/post", options)
+      end
+
+      def text(blog_name, options={})
+        options[:type] = "text"
+        post("v2/blog/#{blog_name}/post", options)
+      end
+
+      def link(blog_name, options={})
+        options[:type] = "link"
+        post("v2/blog/#{blog_name}/post", options)
+      end
+
+      def chat(blog_name, options={})
+        options[:type] = "chat"
+        post("v2/blog/#{blog_name}/post", options)
+      end
+
+      def audio(blog_name, options={})
+        options[:type] = "audio"
+        post("v2/blog/#{blog_name}/post", options)
+      end
+      
+      def video(blog_name, options={})
+        options[:type] = "video"
+        post("v2/blog/#{blog_name}/post", options)
+      end
+
+      def answer(blog_name, options={})
+        options[:type] = "answer"
+        post("v2/blog/#{blog_name}/post", options)
+      end
+
+    end
+  end
+end

data/lib/tumblr/request.rb

@@ -0,0 +1,26 @@
+require 'json'
+
+module Tumblr
+  module Request
+
+    #Performs a get request
+    def get(path, params={})
+      response = connection.get do |req|
+        req.url path 
+        req.params = params
+      end
+      #check for errors and encapsulate
+      JSON.parse(response.body)['response']
+    end
+    
+    #Performs post request
+    def post(path, params={})
+      response = connection.post do |req|
+        req.url path
+        req.body = params unless params.empty?
+      end
+      #Check for errors and encapsulate
+      JSON.parse(response.body)['response']
+    end
+  end
+end

data/lib/tumblr/request/oauth.rb

@@ -0,0 +1,72 @@
+require 'faraday'
+require 'time'
+require 'uri'
+require 'openssl'
+require 'base64'
+
+module Tumblr
+  module Request
+    class TumblrOAuth < Faraday::Middleware
+      def call(env)
+        if env[:method].to_s == "get"
+            params = env[:url].query_values || {}
+            url = "#{env[:url].scheme}://#{env[:url].host}#{env[:url].path}"
+        else
+            params = env[:body] || {}
+            url = env[:url]
+        end
+        signature_params = params
+        params.each do |key, value|
+          signature_params = {} if value.respond_to?(:content_type)
+        end
+        env[:request_headers]["Authorization"] = self.oauth_gen(env[:method], url, signature_params) 
+        env[:request_headers]["Content-type"] = "application/x-www-form-urlencoded"                                                                              
+        env[:request_headers]["Host"] = "api.tumblr.com"
+        
+
+        @app.call(env)
+      end
+
+      def initialize(app, options={})
+        @app, @options = app, options
+      end
+
+      def oauth_gen(method, url, params)
+         params[:oauth_consumer_key] = @options[:consumer_key]
+         params[:oauth_nonce] = Time.now.to_i
+         params[:oauth_signature_method] = 'HMAC-SHA1'
+         params[:oauth_timestamp] = Time.now.to_i
+         params[:oauth_token] = @options[:token]
+         params[:oauth_version] = "1.0"
+         params[:oauth_signature] = self.oauth_sig(method, url, params)
+         
+         header = []
+         params.each do |key, value|
+            if key.to_s.include?("oauth")
+              header << "#{key.to_s}=#{value}"
+            end
+         end
+
+         "OAuth #{header.join(", ")}"
+
+      end
+      
+      def oauth_sig(method, url, params)
+        parts = [method.upcase, URI.encode(url.to_s, /[^a-z0-9\-\.\_\~]/i)]
+        
+        #sort the parameters
+        params = Hash[params.sort_by{ |key, value| key.to_s}]
+        
+        encoded = []
+        params.each do |key, value|
+            encoded << "#{key.to_s}=#{URI.encode(value.to_s, /[^a-z0-9\-\.\_\~]/i)}"
+        end
+
+        parts << URI.encode(encoded.join("&"), /[^a-z0-9\-\.\_\~]/i)
+        signature_base = parts.join("&")
+        secret = "#{@options[:consumer_secret]}&#{@options[:token_secret]}"
+        Base64.encode64(OpenSSL::HMAC.digest(OpenSSL::Digest::SHA1.new, secret, signature_base)).chomp.gsub(/\n/, '')
+      end
+    end
+  end
+end

data/lib/tumblr/user.rb

@@ -0,0 +1,40 @@
+module Tumblr
+  class Client
+    module User
+      def info
+        info = post("v2/user/info")
+      end
+
+      def dashboard(options={})
+        valid_opts = [:limit, :offset, :type, :since_id, :reblog_info, :notes_info]
+        if valid_options(valid_opts, options)
+          get("v2/user/dashboard", options)
+        end
+      end
+
+      def likes(offset=0, limit=20)
+        likes = get("v2/user/likes", {:limit => limit, :offset => offset})
+      end
+
+      def following(offset=0, limit=20)
+        following = get("v2/user/following", {:limit => limit, :offset => offset})
+      end
+
+      def follow(url)
+        follow = post("v2/user/follow", {:url => url})
+      end
+    
+      def unfollow(url)
+        follow = post("v2/user/unfollow", {:url => url})
+      end
+
+      def like(id, reblog_key)
+        like = post("v2/user/like", {:id => id, :reblog_key => reblog_key})
+      end
+
+      def unlike(id, reblog_key)
+        unlike = post("v2/user/unlike", {:id => id, :reblog_key => reblog_key})
+      end 
+    end
+  end
+end

data/tumblr.gemspec

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+Gem::Specification.new do |gem|
+    gem.add_dependency 'faraday', '~> 0.7'
+    gem.add_dependency 'faraday-stack'
+    gem.add_dependency 'json'
+    gem.add_development_dependency 'rake'
+    gem.add_development_dependency 'rspec'
+    gem.add_development_dependency 'webmock'
+    gem.authors = ["John Bunting"]
+    gem.description = %q{A Ruby wrapper for the Tumblr v2 API}
+    gem.email = ['codingjester@gmail.com']
+    gem.executables = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+    gem.files = `git ls-files`.split("\n")
+    gem.homepage = "http://github.com/codingjester/tumblr"
+    gem.name = "tumblr_client"
+    gem.require_paths = ["lib"]
+    gem.required_rubygems_version = Gem::Requirement.new('>= 1.3.6')
+    gem.summary = %q{Tumblr API wrapper}
+    gem.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+    gem.version = "0.5"
+end

metadata

@@ -0,0 +1,151 @@
+--- !ruby/object:Gem::Specification 
+name: tumblr_client
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  version: "0.5"
+platform: ruby
+authors: 
+- John Bunting
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-03-31 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: faraday-stack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: webmock
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+description: A Ruby wrapper for the Tumblr v2 API
+email: 
+- codingjester@gmail.com
+executables: 
+- tumblr
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/tumblr
+- lib/tumblr.rb
+- lib/tumblr/blog.rb
+- lib/tumblr/client.rb
+- lib/tumblr/config.rb
+- lib/tumblr/connection.rb
+- lib/tumblr/helpers.rb
+- lib/tumblr/post.rb
+- lib/tumblr/request.rb
+- lib/tumblr/request/oauth.rb
+- lib/tumblr/user.rb
+- tumblr.gemspec
+has_rdoc: true
+homepage: http://github.com/codingjester/tumblr
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Tumblr API wrapper
+test_files: []
+