tumblr_wrapper 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.2-p290@tumblr_wrapper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tumblr_wrapper.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 rheaton
+
+MIT License
+
+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,72 @@
+# TumblrWrapper
+
+This is a basic wrapper for the tumblr api written in ruby. It requires Oauth and RestClient.
+I haven't wrapped the response objects yet.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'tumblr_wrapper'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tumblr_wrapper
+
+## Usage
+
+Set up:
+
+    TumblrWrapper.consumer_key = "YOUR APPLICATION KEY"
+    TumberWrapper.consumer_secret = "YOUR APPLICATION SECRET"
+
+If you need the token and secret for a user:
+
+    client = TumblrWrapper::Client.new
+
+then authorize in browser here:
+
+    client.authorize_url
+
+tumblr oauth is strict, you need to save the oauth verifier from the response:
+
+    access_token = client.access_token("OAUTH VERIFIER")
+
+If you have the token and secret for your user:
+
+    access_token = client.access_token_from_hash(oauth_token: "TOKEN", oauth_token_secret: "SECRET")
+
+The access token is memoized in either case, so you can call it again once it was set:
+
+    access_token = client.access_token
+
+To get the first 40 posts of your blog:
+
+    blog_resource = TumblrWrapper::BlogResource.new('yourblog.tumblr.com', access_token)
+
+    blog_resource.blog.posts(limit: 40)
+
+or with pagination:
+
+    blog_resource.blog.posts(limit: 20, offset: 0)
+    blog_resource.blog.posts(limit: 20, offset: 20)
+
+To post:
+
+    blog_resource.post.create({ type: 'text', body: "Hello world." })
+
+To delete a post:
+
+    blog_resource.post.delete({id: "ID FROM TUMBLR"})
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/tumblr_wrapper/blog.rb

@@ -0,0 +1,22 @@
+class TumblrWrapper::Blog < TumblrWrapper::BlogResource
+  ##
+  # Required parameters: N/A
+  # http://www.tumblr.com/docs/en/api/v2#blog-info
+  def info
+    request('info')
+  end
+
+  ##
+  # Required parameters: N/A
+  # http://www.tumblr.com/docs/en/api/v2#blog-followers
+  def followers(parameters={})
+    oauth_request('followers', parameters)
+  end
+
+  ##
+  # Required parameters: N/A
+  # http://www.tumblr.com/docs/en/api/v2#posts
+  def posts(parameters={})
+    request('posts', parameters)
+  end
+end

data/lib/tumblr_wrapper/blog_resource.rb

@@ -0,0 +1,35 @@
+class TumblrWrapper::BlogResource < TumblrWrapper::Resource
+  attr_reader :hostname, :access_token
+
+  def initialize(base_hostname, access_token=nil)
+    @hostname = base_hostname
+    super(access_token)
+  end
+
+  def blog
+    TumblrWrapper::Blog.new(@hostname, access_token)
+  end
+
+  def post
+    TumblrWrapper::Post.new(@hostname, access_token)
+  end
+
+  protected
+  def oauth_request(path, method_type = :get, body = {})
+    validate_oauth
+
+    url = "#{endpoint}/blog/#{hostname}/#{path}"
+    if parameters.present?
+      access_token.request(method_type, url, body)
+    else
+      access_token.request(method_type, url)
+    end
+  end
+
+  def request(path, method_type = :get, parameters = {})
+    parameters.merge!({ api_key: TumblrWrapper.consumer_key })
+    params = (method_type == :get) ? { params: parameters } : parameters
+
+    TumblrWrapper::RestClient.send(method_type, "#{endpoint}/blog/#{hostname}/#{path}", params)
+  end
+end

data/lib/tumblr_wrapper/client.rb

@@ -0,0 +1,35 @@
+class TumblrWrapper::Client
+  attr_reader :consumer, :request_token
+  def initialize
+    @consumer = OAuth::Consumer.new(
+      TumblrWrapper.consumer_key,
+      TumblrWrapper.consumer_secret,
+      site: 'http://www.tumblr.com'
+    )
+  end
+
+  def authorize_url
+    @request_token = @consumer.get_request_token
+    @request_token.authorize_url
+  end
+
+  def access_token(oauth_verifier = nil)
+    if oauth_verifier
+      @access_token = request_token.get_access_token({:oauth_verifier => oauth_verifier})
+    else
+      @access_token
+    end
+  end
+
+  def access_token_from_hash(token_hash)
+    @access_token = OAuth::AccessToken.from_hash(consumer, token_hash)
+  end
+
+  def token
+    @access_token.try(:token)
+  end
+
+  def secret
+    @access_token.try(:secret)
+  end
+end

data/lib/tumblr_wrapper/post.rb

@@ -0,0 +1,27 @@
+class TumblrWrapper::Post < TumblrWrapper::BlogResource
+  ##
+  # Required parameters: :type
+  # http://www.tumblr.com/docs/en/api/v2#posting
+  def create(parameters = {})
+    validate_present(:type, parameters)
+    validate_not_present(:id, parameters)
+
+    oauth_request('post', :post, parameters)
+  end
+
+  ##
+  # Required parameters: :id
+  # http://www.tumblr.com/docs/en/api/v2#editing
+  def update(parameters = {})
+    validate_present(:id, parameters)
+    oauth_request('post/edit', :post, parameters)
+  end
+
+  ##
+  # Required parameters: :id
+  # http://www.tumblr.com/docs/en/api/v2#editing
+  def delete(parameters = {})
+    validate_present(:id, parameters)
+    oauth_request('post/delete', :post, parameters)
+  end
+end

data/lib/tumblr_wrapper/resource.rb

@@ -0,0 +1,19 @@
+class TumblrWrapper::Resource
+  attr_reader :access_token
+
+  def initialize(access_token)
+    @access_token = access_token
+  end
+
+  def validate_oauth
+    raise TumblrWrapper::OauthNeeded unless access_token
+  end
+
+  def validate_present(key, parameters)
+    raise TumblrWrapper::MissingRequiredParameter, key unless parameters[key]
+  end
+
+  def validate_not_present(key, parameters)
+    raise TumblrWrapper::InvalidParameter, key if parameters[key]
+  end
+end

data/lib/tumblr_wrapper/rest_client.rb

@@ -0,0 +1,2 @@
+class TumblrWrapper::RestClient < ::RestClient
+end

data/lib/tumblr_wrapper/version.rb

@@ -0,0 +1,3 @@
+module TumblrWrapper
+  VERSION = "0.0.1"
+end

data/lib/tumblr_wrapper.rb

@@ -0,0 +1,49 @@
+require 'oauth'
+require 'rest-client'
+require "tumblr_wrapper/version"
+require "tumblr_wrapper/client"
+require "tumblr_wrapper/resource"
+require "tumblr_wrapper/blog_resource"
+require "tumblr_wrapper/blog"
+require "tumblr_wrapper/post"
+
+module TumblrWrapper
+  ENDPOINT = 'http://api.tumblr.com/v2'
+  OAUTH_ENPOINT = 'http://www.tumblr.com'
+
+  def self.consumer_key=(key)
+    @@consumer_key = key
+  end
+
+  def self.consumer_key
+    @@consumer_key
+  end
+
+  def self.consumer_secret=(secret)
+    @@consumer_secret = secret
+  end
+
+  def self.consumer_secret
+    @@consumer_secret
+  end
+
+  def self.oauth_endpoint
+    OAUTH_ENDPOINT
+  end
+
+  def self.endpoint
+    ENDPOINT
+  end
+
+  class NoAccessToken < StandardError
+    def initialize(message = "Oauth request. Set access_token")
+      super(message)
+    end
+  end
+
+  class MissingRequiredParameter < StandardError
+  end
+
+  class InvalidParameter < StandardError
+  end
+end

data/spec/blog_resource_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe TumblrWrapper::BlogResource do
+  let(:token) { mock(:token) }
+  subject(:blog_resource) { TumblrWrapper::BlogResource.new('myblog.tumblr.com') }
+
+  describe "blog" do
+    it "returns a new blog with the hostname and access token" do
+      blog = blog_resource.blog
+      blog.class.should == TumblrWrapper::Blog
+
+      blog.access_token.should == blog_resource.access_token
+      blog.hostname.should == blog_resource.hostname
+    end
+  end
+
+  describe "post" do
+    it "returns a new post with the hostname and access token" do
+      post = blog_resource.post
+      post.class.should == TumblrWrapper::Post
+
+      post.access_token.should == blog_resource.access_token
+      post.hostname.should == blog_resource.hostname
+    end
+  end
+end

data/spec/blog_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe TumblrWrapper::Blog do
+  let(:token) { mock(:token) }
+  subject(:blog) { TumblrWrapper::Blog.new('myblog.tumblr.com') }
+
+  it "is a blog resource" do
+    TumblrWrapper::Blog.superclass.should == TumblrWrapper::BlogResource
+  end
+
+  describe '.info' do
+    it "makes an api request" do
+      blog.should_receive(:request).with('info')
+
+      blog.info
+    end
+  end
+
+  describe "followers" do
+    it "makes an oauth request" do
+      blog.should_receive(:oauth_request).with('followers', {})
+
+      blog.followers
+    end
+
+    it "accepts parameters" do
+      blog.should_receive(:oauth_request).with('followers', { limit: 20, offset: 5 })
+
+      blog.followers({ limit: 20, offset: 5 })
+    end
+  end
+
+  describe "posts" do
+    it "makes an api request" do
+      blog.should_receive(:request).with('posts', {})
+
+      blog.posts
+    end
+
+    it "accepts type parameter" do
+      blog.should_receive(:request).with('posts', type: 'text')
+
+      blog.posts(type: 'text')
+    end
+  end
+end

data/spec/post_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe TumblrWrapper::Post do
+  let(:token) { mock(:token) }
+  subject(:post) { TumblrWrapper::Post.new('myblog.tumblr.com') }
+
+  it "is a blog resource" do
+    TumblrWrapper::Post.superclass.should == TumblrWrapper::BlogResource
+  end
+
+  describe "create" do
+    it "makes an oauth request with parameters" do
+      post.should_receive(:oauth_request).with('post', :post, {:type => 'text'})
+
+      post.create({:type => 'text'})
+    end
+
+    it "raises unless type is specified" do
+      lambda do
+        post.create
+      end.should raise_error(TumblrWrapper::MissingRequiredParameter)
+    end
+
+    it "raises if id is sent" do
+      lambda do
+        post.create({type: 'text', id: '1234'})
+      end.should raise_error(TumblrWrapper::InvalidParameter)
+    end
+  end
+
+  describe "update" do
+    it "makes an oauth request with parameters" do
+      post.should_receive(:oauth_request).with('post/edit', :post, {:id => '1234'})
+
+      post.update({:id => '1234'})
+    end
+
+    it "raises unless id is specified" do
+      lambda do
+        post.update
+      end.should raise_error(TumblrWrapper::MissingRequiredParameter)
+    end
+  end
+
+  describe "delete" do
+    it "makes an oauth request with parameters" do
+      post.should_receive(:oauth_request).with('post/delete', :post, {:id => '1234'})
+
+      post.delete({:id => '1234'})
+    end
+
+    it "raises unless id is specified" do
+      lambda do
+        post.delete
+      end.should raise_error(TumblrWrapper::MissingRequiredParameter)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'spork'
+
+Spork.prefork do
+  require 'rspec'
+  require 'tumblr_wrapper'
+
+  RSpec.configure do |config|
+    config.mock_with :rspec
+  end
+end

data/tumblr_wrapper.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/tumblr_wrapper/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["rheaton"]
+  gem.email         = ["rachelmheaton@gmail.com"]
+  gem.description   = %q{ruby wrapper for tumblr api}
+  gem.summary       = %q{}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(spec)/})
+  gem.name          = "tumblr_wrapper"
+  gem.require_paths = ["lib"]
+  gem.version       = TumblrWrapper::VERSION
+  gem.add_development_dependency 'spork'
+  gem.add_development_dependency 'rspec'
+  gem.add_dependency 'oauth'
+  gem.add_dependency 'rest-client'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification 
+name: tumblr_wrapper
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- rheaton
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-01 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: spork
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: ruby wrapper for tumblr api
+email: 
+- rachelmheaton@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/tumblr_wrapper.rb
+- lib/tumblr_wrapper/blog.rb
+- lib/tumblr_wrapper/blog_resource.rb
+- lib/tumblr_wrapper/client.rb
+- lib/tumblr_wrapper/post.rb
+- lib/tumblr_wrapper/resource.rb
+- lib/tumblr_wrapper/rest_client.rb
+- lib/tumblr_wrapper/version.rb
+- spec/blog_resource_spec.rb
+- spec/blog_spec.rb
+- spec/post_spec.rb
+- spec/spec_helper.rb
+- tumblr_wrapper.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: ""
+test_files: 
+- spec/blog_resource_spec.rb
+- spec/blog_spec.rb
+- spec/post_spec.rb
+- spec/spec_helper.rb