tumbl_rb 0.1.0

data/.gitignore

@@ -0,0 +1,14 @@
+*.gem
+*.rbc
+.DS_Store
+.bundle
+.rvmrc
+.swp
+Gemfile.lock
+*~
+.yardoc
+
+coverage
+doc/
+pkg
+rdoc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,8 @@
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})                   { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^lib/tumbl_rb/(.+)\.rb$})          { |m| "spec/tumbl_rb/#{m[1]}_spec.rb" }
+  watch(%r{^lib/tumbl_rb/client/(.+)\.rb$})   { |m| "spec/tumbl_rb/client/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')                { "spec" }
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Andrew Thorp
+
+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

@@ -0,0 +1,62 @@
+# Tumbl_rb
+Simple Ruby wrapper for the Tumblr v2 API
+
+[![Build Status](https://secure.travis-ci.org/andrewpthorp/tumbl_rb.png)](http://travis-ci.org/andrewpthorp/tumbl_rb) [![Dependency Status](https://gemnasium.com/andrewpthorp/tumbl_rb.png)](https://gemnasium.com/andrewpthorp/tumbl_rb)
+
+## Installation
+    gem install 'tumbl_rb'
+
+## Documentation
+    none yet
+
+## Examples
+
+### Add your api_key (consumer_oauth_key)
+```ruby
+TumblRb.configure do |config|
+    config.consumer_oauth_key = "1234567890"
+end
+```
+
+### Get a Blog's info
+```ruby
+TumblRb.info("andrewpthorp")
+```
+
+### Get a Blog's avatar
+```ruby
+TumblRb.avatar("andrewpthorp")
+```
+
+### Get Blog Posts
+```ruby
+TumblRb.posts("andrewpthorp")
+```
+
+### Get all posts of a specific type (text, quote, link, answer, video, audio, photo, chat)
+```ruby
+TumblRb.posts("andrewpthorp", :type => "link")
+```
+
+### Get a specific post
+```ruby
+TumblRb.posts("andrewpthorp", :id => 123456789)
+```
+
+**Different types bring back different responses. To check them out, [visit the documentation](http://www.tumblr.com/docs/en/api/v2)**
+
+## Version
+This gem supports the methods of the Tumblr API that do not require OAuth. This may change before v3 of the Tumblr API, and will definitely change after v3 of the Tumblr API.
+
+## Inspiration
+Tumbl_rb was heavily inspired by [octokit][octokit] and [sqoot][sqoot]. Reading through
+and understanding those projects was crucial to understanding the anatomy of a gem (specifically
+an API wrapper gem). Thanks!
+
+[octokit]: https://github.com/pengwynn/octokit
+[sqoot]: https://github.com/causemetric/sqoot
+
+## Copyright
+Copyright (c) 2012 Andrew Thorp. See [LICENSE][license] for details.
+
+[license]: https://github.com/andrewpthorp/tumbl_rb/blob/master/LICENSE

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :test => :spec
+task :default => :spec
+
+namespace :doc do
+  require 'yard'
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['README.md', 'LICENSE.md', 'lib/**/*.rb']
+    task.options = [
+      '--output-dir', 'doc/yard',
+      '--markup', 'markdown',
+    ]
+  end
+end

data/lib/faraday/response/raise_tumbl_rb_error.rb

@@ -0,0 +1,28 @@
+require 'faraday'
+require 'multi_json'
+
+# @api private
+module Faraday
+  class Response::RaiseTumblRbError < Response::Middleware
+    def on_complete(response)
+      case response[:status].to_i
+      when 401
+        raise TumblRb::Unauthorized, error_message(response)
+      when 404
+        raise TumblRb::NotFound, error_message(response)
+      end
+    end
+
+    def error_message(response)
+      message = if (body = response[:body]) && !body.empty?
+        if body.is_a?(String)
+          body = MultiJson.load(body, :symbolize_keys => true)
+        end
+        ": #{body[:error] || body[:message] || ''}"
+      else
+        ''
+      end
+      "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}#{message}"
+    end
+  end
+end

data/lib/tumbl_rb.rb

@@ -0,0 +1,25 @@
+require 'tumbl_rb/configuration'
+require 'tumbl_rb/client'
+require 'tumbl_rb/error'
+
+module TumblRb
+  extend Configuration
+  class << self
+    # Alias for TumblRb::Client.new
+    #
+    # @return [TumblRb::Client]
+    def new(options={})
+      TumblRb::Client.new(options)
+    end
+
+    # Delegate to TumblRb::Client.new
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private=false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+  end
+end

data/lib/tumbl_rb/blog.rb

@@ -0,0 +1,36 @@
+module TumblRb
+  class Blog
+    attr_accessor :hostname, :username
+
+    def initialize(blog)
+      case blog
+      when String
+        if blog.include?(".")
+          @hostname = blog
+          @username = blog.include?(".tumblr.com") ? blog.chomp(".tumblr.com") : nil
+        else
+          @hostname = "#{blog}.tumblr.com"
+          @username = blog
+        end
+      when Hash
+        @hostname = blog[:hostname] ||= blog[:blog]
+        @username = blog[:username] ||= blog[:user]
+      end
+    end
+
+    # Returns the hostname
+    #
+    # @return [String]
+    def to_s
+      @hostname
+    end
+
+    # Returns the url
+    #
+    # @return [String]
+    def url
+      "http://#{@hostname}"
+    end
+
+  end
+end

data/lib/tumbl_rb/client.rb

@@ -0,0 +1,40 @@
+require 'tumbl_rb/connection'
+require 'tumbl_rb/request'
+require 'tumbl_rb/blog'
+
+require 'tumbl_rb/client/blogs'
+
+module TumblRb
+
+  class Client
+    attr_accessor(*Configuration::VALID_OPTIONS_KEYS)
+
+    def initialize(options={})
+      options = TumblRb.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+    end
+
+    # Provides the URL for accessing the API
+    #
+    # @return [String]
+    def api_url
+      "http://api.tumblr.com"
+    end
+
+    # Determine if an consumer_oauth_key has been set
+    #
+    # @return [Boolean]
+    def oauthed?
+      !consumer_oauth_key.nil?
+    end
+
+    include TumblRb::Connection
+    include TumblRb::Request
+
+    include TumblRb::Client::Blogs
+
+  end
+
+end

data/lib/tumbl_rb/client/blogs.rb

@@ -0,0 +1,48 @@
+module TumblRb
+  class Client
+    module Blogs
+
+      # Get the info of a blog
+      #
+      # @param [String, Hash] blog to get information for
+      #
+      # @return [Hashie::Mash]
+      # @example
+      #   TumblRb.info("andrewpthorp")
+      def info(blog)
+        get("/v2/blog/#{Blog.new blog}/info", {}, false)
+      end
+
+
+      # Get the avatar of a blog
+      #
+      # @param [String, Hash] blog
+      #
+      # @return [Hashie::Mash]
+      # @example
+      #   TumblRb.avatar("andrewpthorp")
+      def avatar(blog)
+        get("/v2/blog/#{Blog.new blog}/avatar", {}, false)
+      end
+
+      # Get the posts of a blog
+      #
+      # @param [String, Hash] blog
+      # @param [String] post type
+      #
+      # @return [Hashie::Mash]
+      # @example
+      #   TumblRb.posts("andrewpthorp", "text")
+      def posts(blog, options={})
+        url = "/v2/blog/#{Blog.new blog}/posts"
+
+        if !options[:type].nil?
+          url += "/#{options[:type]}"
+        end
+
+        get(url, options, false)
+      end
+
+    end
+  end
+end

data/lib/tumbl_rb/configuration.rb

@@ -0,0 +1,39 @@
+require 'faraday'
+require 'tumbl_rb/version'
+
+module TumblRb
+  module Configuration
+    VALID_OPTIONS_KEYS = [
+      :adapter,
+      :api_version,
+      :proxy,
+      :consumer_oauth_key,
+      :user_agent].freeze
+
+    DEFAULT_ADAPTER        = Faraday.default_adapter
+    DEFAULT_API_VERSION    = 2
+    DEFAULT_USER_AGENT     = "TumblRb Ruby Gem #{TumblRb::VERSION}".freeze
+
+    attr_accessor(*VALID_OPTIONS_KEYS)
+
+    def self.extended(base)
+      base.reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def options
+      VALID_OPTIONS_KEYS.inject({}){|o,k| o.merge!(k => send(k)) }
+    end
+
+    def reset
+      self.adapter                = DEFAULT_ADAPTER
+      self.api_version            = DEFAULT_API_VERSION
+      self.consumer_oauth_key     = nil
+      self.proxy                  = nil
+      self.user_agent             = DEFAULT_USER_AGENT
+    end
+  end
+end

data/lib/tumbl_rb/connection.rb

@@ -0,0 +1,34 @@
+require 'faraday_middleware'
+require 'faraday/response/raise_tumbl_rb_error'
+
+module TumblRb
+  # @private
+  module Connection
+    private
+
+    def connection(raw=false)
+
+      options = {
+        :proxy => proxy,
+        :ssl => { :verify => false },
+        :url => api_url
+      }
+
+      options.merge!(:params => { :api_key => consumer_oauth_key}) if oauthed?
+
+      connection = Faraday.new(options) do |builder|
+        builder.request :url_encoded
+
+        builder.use Faraday::Response::RaiseTumblRbError
+        unless raw
+          builder.use FaradayMiddleware::Mashify
+          builder.use FaradayMiddleware::ParseJson
+        end
+
+        builder.adapter adapter
+      end
+
+      connection
+    end
+  end
+end

data/lib/tumbl_rb/error.rb

@@ -0,0 +1,12 @@
+module TumblRb
+
+  # Custom error class for rescuing from all Tumblr errors
+  class Error < StandardError; end
+
+  # 401 HTTP Status Code
+  class Unauthorized < Error; end
+
+  # 404 HTTP Status Code
+  class NotFound < Error; end
+
+end

data/lib/tumbl_rb/request.rb

@@ -0,0 +1,29 @@
+require 'multi_json'
+
+module TumblRb
+  module Request
+    def get(path, options={}, raw=false, include_meta=false)
+      request(:get, path, options, raw, include_meta)
+    end
+
+    private
+
+    def request(method, path, options, raw, include_meta)
+      response = connection(raw).send(method) do |request|
+        request.url(path, options)
+      end
+
+      if raw
+        response
+      else
+
+        if include_meta
+          response.body
+        else
+          response.body.response
+        end
+      end
+    end
+
+  end
+end