tumblrb 1.0.3 → 1.0.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem "nokogiri", "~> 1.4.4"
+gem "curb", "~> 0.7.15"
+
+gemspec

data/LICENSE.mkd

@@ -0,0 +1,19 @@
+Copyright (c) 2011 Jesse Reiss
+
+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.mkd

@@ -0,0 +1,65 @@
+Tumblr API Wrapper
+====================
+
+A simple, easy to use ruby wrapper for the Tumblr API. 
+
+Installation
+------------
+
+Run 
+
+    gem install tumblrb
+
+Or add
+
+    gem 'tumblrb', :require => "tumblr"
+    
+to your Gemfile
+
+Setup
+------------
+
+Add
+
+    Tumblr.user = Tumblr::User.new 'email@email.com', 'password'
+    Tumblr.blog = 'myblogname'
+
+into your initialization
+
+Fetching 
+------------
+
+Just like `will_paginate` :
+
+    @posts = Tumblr::Item.paginate(:page => 1, :per_page => 20)
+    @posts.next_page => 1
+    @posts.previous_page => nil
+    @posts.each do |post|
+      =render :partial => "post", :object => post
+    end
+
+In addition to any paging parameters, `paginate` also accepts all the documented params from the [Tumblr API](http://www.tumblr.com/docs/en/api).
+
+You can also fetch the last post with
+
+    Tumblr::Item.first
+  
+Item Classes
+------------
+
+Every Tumblr entry type is a separate class so you can do stuff like :
+
+    case post
+    when Tumblr::Regular
+      # Display a regular post
+    when Tumblr::Quote
+      # Display a quote
+    when Tumblr::Photo
+      # Display a photo
+    ...
+    end
+
+Anything else?
+------------
+
+Questions, requests, concerns? Find me at [the gorgon lab](http://www.thegorgonlab.com)

data/lib/tumblr.rb

@@ -0,0 +1,26 @@
+require 'nokogiri'
+require 'curl'
+require 'tumblr/user'
+require 'tumblr/page'
+require 'tumblr/item'
+require 'tumblr/answer'
+require 'tumblr/audio'
+require 'tumblr/conversation'
+require 'tumblr/item'
+require 'tumblr/link'
+require 'tumblr/photo'
+require 'tumblr/quote'
+require 'tumblr/regular'
+require 'tumblr/video'
+
+module Tumblr
+  mattr_accessor :user
+  
+  def self.blog=(blog)
+    @blog = (blog =~ /\./) ? blog : "#{blog}.tumblr.com"
+  end
+  
+  def self.blog
+    @blog
+  end
+end

data/lib/tumblr/answer.rb

@@ -0,0 +1,21 @@
+module Tumblr
+  class Answer < Item
+    attr_accessor :question, :answer
+    
+    def as_json
+      super.merge!({
+        :question => question,
+        :answer => answer
+      })
+    end
+
+    private
+    
+    def parse_xml_node(node)
+      super(node)
+      self.caption = node.css('question').first.try(:content)
+      self.source = node.css('answer').first.try(:content)
+      self
+    end
+  end
+end

data/lib/tumblr/audio.rb

@@ -0,0 +1,21 @@
+module Tumblr
+  class Audio < Item
+    attr_accessor :caption, :player
+  
+    def as_json
+      super.merge!({
+        :caption => caption,
+        :player => player
+      })
+    end
+  
+    private
+    
+    def parse_xml_node(node)
+      super(node)
+      self.caption = node.css('audio-caption').first.try(:content)
+      self.source = node.css('audio-player').first.try(:content)
+      self
+    end    
+  end
+end

data/lib/tumblr/conversation.rb

@@ -0,0 +1,35 @@
+module Tumblr
+  class Conversation < Item
+    attr_accessor :title, :text, :lines
+    
+    class Line < Struct.new(:name, :label, :content)
+      def as_json
+        {
+          :name => name,
+          :label => label,
+          :content => content
+        }
+      end
+    end
+
+    def as_json
+      super.merge!({
+        :title => title,
+        :text => text,
+        :lines => lines.map { |l| l.as_json }
+      })
+    end
+
+    private
+    
+    def self.parse_xml_node(node)
+      super(node)
+      self.title = node.css('conversation-title').first.try(:content)
+      self.text = node.css('conversation-text').first.try(:content)
+      self.lines = node.css("convesation line").collect do |line|
+        Line.new(line["name"], line["label"], label.content)
+      end
+      self
+    end    
+  end
+end

data/lib/tumblr/item.rb

@@ -0,0 +1,103 @@
+module Tumblr
+  class Item
+    PAGE_SIZE = 20
+    attr_accessor :id, :slug, :type, :date, :format, :xml
+    attr_accessor :tags
+    
+    def self.paginate(params={})
+      params[:num] = params[:per_page].to_i > 0 ? params[:per_page].to_i : PAGE_SIZE
+      params[:start] = ([params[:page].to_i, 1].max - 1) * params[:num]
+      params.delete(:limit)
+      params.delete(:page)
+      if Tumblr.user
+        params[:email] = Tumblr.user.email
+        params[:password] = Tumblr.user.password
+      end
+      page_xml = xml(params)
+      items = parse(page_xml)
+      page_meta = page_xml.at("posts")
+      if page_meta
+        Tumblr::Page.new(items, page_meta["start"], page_meta["total"], params[:num])
+      else
+        Tumblr::Page.new(items, 0, items.length, params[:num])
+      end
+    end
+    
+    def self.find(id)
+      paginate(:page => 1, :per_page => 1).first
+    end
+    
+    def self.all(params={})
+      parse(xml(params))
+    end
+    
+    def self.xml(params={})
+      Nokogiri::XML(raw(params))
+    end
+    
+    def self.raw(params={})
+      Rails.logger.info "tumblr : fetching url #{url(params)}"
+      curl = Curl::Easy.perform(url(params))
+      curl.body_str
+    end
+
+    def self.find(id)
+      parse(xml(:id => id.to_i)).first
+    end
+    
+    def to_param
+      "#{id}-#{slug}"
+    end
+    
+    def date_string
+      date.strftime("%B %d, %Y")
+    end
+    
+    def dom_class
+      self.class.to_s.split("::").last.underscore
+    end
+
+    def as_json
+      {
+        :id => id,
+        :slug => slug,
+        :date => date,
+        :type => type,
+        :format => format,
+        :tags => tags
+      }
+    end
+
+    private
+
+    def self.url(params)
+      url = "http://#{Tumblr.blog}/api/read"
+      url += "?#{params.to_query}" if params.keys.length > 0
+      url
+    end
+
+    def self.parse(xml)
+      xml.css("posts post").collect do |post|
+        object_class = "Tumblr::#{post['type'].classify}".constantize rescue nil
+        if object_class
+          object = object_class.new
+          object.send(:parse_xml_node, post)
+          object
+        end
+      end
+    end
+    
+    def parse_xml_node(node)
+      self.xml = node.to_s
+      self.id = node['id']
+      self.type = node['type']
+      self.slug = node['slug']
+      self.date = Time.at(node['unix-timestamp'].to_i)
+      self.format = node['format']
+      self.tags = node.css("tag").collect do |tag|
+        tag.content
+      end
+      self
+    end    
+  end
+end

data/lib/tumblr/link.rb

@@ -0,0 +1,21 @@
+module Tumblr
+  class Link < Item
+    attr_accessor :text, :url
+    
+    def as_json
+      super.merge!({
+        :text => text,
+        :url => url
+      })
+    end
+    
+    private
+    
+    def parse_xml_node(node)
+      super(node)
+      self.text = node.css('link-text').first.try(:content)
+      self.source = node.css('link-url').first.try(:content)
+      self
+    end    
+  end
+end

data/lib/tumblr/page.rb

@@ -0,0 +1,35 @@
+module Tumblr
+  class Page
+    include Enumerable
+    attr_accessor :items, :start, :total, :page_size
+    
+    def initialize(items, start, total, page_size)
+      self.items = items
+      self.start = start.to_i
+      self.total = total.to_i
+      self.page_size = page_size.to_i
+    end
+        
+    def page
+      (start / page_size).floor + 1      
+    end
+    
+    def next_page
+      (total - start) > page_size ? page + 1 : nil
+    end
+    
+    def previous_page
+      page > 1 ? page - 1 : nil
+    end
+    
+    [:size, :count, :length].each do |m|
+      define_method m do
+        @items.send(m)
+      end
+    end    
+    
+    def each(&block)
+      items.each(&block)
+    end
+  end
+end

data/lib/tumblr/quote.rb

@@ -0,0 +1,21 @@
+module Tumblr
+  class Quote < Item
+    attr_accessor :text, :source
+    
+    def as_json
+      super.merge!({
+        :text => text,
+        :source => source
+      })
+    end
+    
+    private
+    
+    def parse_xml_node(node)
+      super(node)
+      self.text = node.css('quote-text').first.try(:content)
+      self.source = node.css('quote-source').first.try(:content)
+      self
+    end    
+  end
+end

data/lib/tumblr/regular.rb

@@ -0,0 +1,21 @@
+module Tumblr
+  class Regular < Item
+    attr_accessor :title, :body
+    
+    def as_json
+      super.merge!({
+        :title => title,
+        :body => body
+      })
+    end
+    
+    private
+    
+    def parse_xml_node(node)
+      super(node)
+      self.title = node.css('regular-title').first.try(:content)
+      self.body = node.css('regular-body').first.try(:content)
+      self
+    end    
+  end
+end

data/lib/tumblr/user.rb

@@ -0,0 +1,11 @@
+module Tumblr
+  class User
+    attr_accessor :email, :password, :tumblr
+  
+    # creates a User object and authenticates the user through the Tumblr API to get user data.  
+    def initialize(email, password)
+      self.email = email
+      self.password = password
+    end
+  end
+end

data/lib/tumblr/version.rb

@@ -0,0 +1,4 @@
+module Tumblr
+  # The version of the gem
+  VERSION = '1.0.4'.freeze unless defined?(::Twitter::VERSION)
+end

data/lib/tumblr/video.rb

@@ -0,0 +1,23 @@
+module Tumblr
+  class Video < Item
+    attr_accessor :caption, :source, :player
+
+    def as_json
+      super.merge!({
+        :caption => caption,
+        :source => source,
+        :player => player
+      })
+    end
+
+    private
+    
+    def parse_xml_node(node)
+      super(node)
+      self.caption = node.css('video-title').first.try(:content)
+      self.source = node.css('video-text').first.try(:content)
+      self.player = node.css('video-player').first.try(:content)
+      self
+    end    
+  end
+end

data/tumblrb.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tumblr/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.add_dependency('nokogiri', '~> 1.4.4')
+  s.add_dependency('curb', '~> 0.7.15')
+  s.authors = ["Jesse Reiss"]
+  s.description = %q{A Ruby wrapper for the Tumblr XML API}
+  s.email = ['jessereiss@gmail.com']
+  s.homepage = 'https://github.com/thegorgon/tumblrb'
+  s.name = 'tumblrb'
+  s.platform = Gem::Platform::RUBY
+  s.require_paths << 'lib'
+  s.required_rubygems_version = Gem::Requirement.new('>= 1.3.6') if s.respond_to? :required_rubygems_version=
+  s.rubyforge_project = s.name
+  s.summary = %q{Ruby wrapper for the Tumblr API}
+  s.files = [
+    "README.mkd",
+    "LICENSE.mkd",
+    "Gemfile",
+    "tumblrb.gemspec",
+    "lib/tumblr.rb",
+    "lib/tumblr/answer.rb",
+    "lib/tumblr/audio.rb",
+    "lib/tumblr/conversation.rb",
+    "lib/tumblr/item.rb",
+    "lib/tumblr/link.rb",
+    "lib/tumblr/page.rb",
+    "lib/tumblr/quote.rb",
+    "lib/tumblr/regular.rb",
+    "lib/tumblr/user.rb",
+    "lib/tumblr/version.rb",
+    "lib/tumblr/video.rb"
+  ]
+  s.version = Tumblr::VERSION.dup
+end

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: tumblrb
 version: !ruby/object:Gem::Version 
-  hash: 17
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 3
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors: 
 - Jesse Reiss
@@ -15,7 +10,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-16 00:00:00 Z
+date: 2011-05-16 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: nokogiri
@@ -25,11 +21,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 4
-        - 4
         version: 1.4.4
   type: :runtime
   version_requirements: *id001
@@ -41,11 +32,6 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 29
-        segments: 
-        - 0
-        - 7
-        - 15
         version: 0.7.15
   type: :runtime
   version_requirements: *id002
@@ -58,8 +44,24 @@ extensions: []
 
 extra_rdoc_files: []
 
-files: []
-
+files: 
+- README.mkd
+- LICENSE.mkd
+- Gemfile
+- tumblrb.gemspec
+- lib/tumblr.rb
+- lib/tumblr/answer.rb
+- lib/tumblr/audio.rb
+- lib/tumblr/conversation.rb
+- lib/tumblr/item.rb
+- lib/tumblr/link.rb
+- lib/tumblr/page.rb
+- lib/tumblr/quote.rb
+- lib/tumblr/regular.rb
+- lib/tumblr/user.rb
+- lib/tumblr/version.rb
+- lib/tumblr/video.rb
+has_rdoc: true
 homepage: https://github.com/thegorgon/tumblrb
 licenses: []
 
@@ -74,25 +76,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 23
-      segments: 
-      - 1
-      - 3
-      - 6
       version: 1.3.6
 requirements: []
 
 rubyforge_project: tumblrb
-rubygems_version: 1.8.2
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper for the Tumblr API