tumblr_wrapper 0.0.3 → 0.1.0

data/.gitignore

@@ -15,3 +15,10 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+spec/vcr_cassettes/access_token.yml
+spec/vcr_cassettes/authorize_url.yml
+spec/vcr_cassettes/blog_followers.yml
+spec/vcr_cassettes/blog_info.yml
+spec/vcr_cassettes/blog_posts.yml
+spec/vcr_cassettes/post_create.yml
+spec/support/token_helper.rb

data/README.md

@@ -32,37 +32,51 @@ then authorize in browser here:
 
     client.authorize_url
 
-tumblr oauth is strict, you need to save the oauth verifier from the response:
+    request_token = client.request_token.token
+    request_token_secret = client.request_token.secret
 
-    client.request_token(request_token, request_token_secret) // set the request token again
-    access_token = client.access_token("OAUTH VERIFIER")
+tumblr oauth is strict, you need the oauth verifier from the response to get the access token:
+
+    client.build_request_token(request_token, request_token_secret)
+    access_token = client.request_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")
+    access_token = client.build_access_token("TOKEN", "SECRET")
 
 The access token is memoized in either case, so you can call it again once it was set:
 
     access_token = client.access_token
+    => {
+          consumer_key: "YOUR APPLICATION KEY",
+          consumer_secret: "YOUR APPLICATION SECRET",
+          oauth_token: 'TOKEN',
+          oauth_secret: 'SECRET',
+        }
 
 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)
+    blog = blog_resource.blow
+    blog.posts(limit: 40)
 
 or with pagination:
 
-    blog_resource.blog.posts(limit: 20, offset: 0)
-    blog_resource.blog.posts(limit: 20, offset: 20)
+    blog.posts(limit: 20, offset: 0)
+    blog.posts(limit: 20, offset: 20)
 
 To post:
 
     blog_resource.post.create({ type: 'text', body: "Hello world." })
 
+To update a post:
+
+    post.update({id: "ID FROM TUMBLR", body: "Goodbye world."})
+
 To delete a post:
 
-    blog_resource.post.delete({id: "ID FROM TUMBLR"})
+    post.delete({id: "ID FROM TUMBLR"})
 
 ## Contributing
 

data/lib/tumblr_wrapper/blog.rb

@@ -3,20 +3,21 @@ class TumblrWrapper::Blog < TumblrWrapper::BlogResource
   # Required parameters: N/A
   # http://www.tumblr.com/docs/en/api/v2#blog-info
   def info
-    request('info')
+    http_get('info')
   end
 
   ##
   # Required parameters: N/A
   # http://www.tumblr.com/docs/en/api/v2#blog-followers
   def followers(parameters={})
-    oauth_request('followers', parameters)
+    http_get('followers', {signed: true}, parameters)
   end
 
   ##
   # Required parameters: N/A
   # http://www.tumblr.com/docs/en/api/v2#posts
   def posts(parameters={})
-    request('posts', parameters)
+    # for some reason the / is needed for this endpoint... -RH
+    http_get('posts/', parameters)
   end
 end

data/lib/tumblr_wrapper/blog_resource.rb

@@ -15,21 +15,9 @@ class TumblrWrapper::BlogResource < TumblrWrapper::Resource
   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
+  def long_path(path)
+    "/#{TumblrWrapper.version}/blog/#{hostname}/#{path}"
   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

@@ -1,44 +1,38 @@
 class TumblrWrapper::Client
-  attr_reader :consumer
-  def initialize
-    @consumer = OAuth::Consumer.new(
-      TumblrWrapper.consumer_key,
-      TumblrWrapper.consumer_secret,
-      site: 'http://www.tumblr.com'
-    )
-  end
+  attr_reader :access_token, :request_token
 
   def authorize_url
-    @request_token = @consumer.get_request_token
+    @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
+  def request_access_token(oauth_verifier)
+    token = request_token.get_access_token({:oauth_verifier => oauth_verifier})
+    @access_token = {
+      consumer_key: TumblrWrapper.consumer_key,
+      consumer_secret: TumblrWrapper.consumer_secret,
+      token: token.token,
+      token_secret: token.secret
+    }
   end
 
-  def request_token(token = nil, secret=nil)
-    if token && secret
-      @request_token = OAuth::RequestToken.new(consumer, token, secret)
-    else
-      @request_token
-    end
-    @request_token
+  def build_request_token(token, secret)
+    @request_token = OAuth::RequestToken.new(consumer, token, secret)
   end
 
-  def access_token_from_hash(token_hash)
-    @access_token = OAuth::AccessToken.from_hash(consumer, token_hash)
+  def build_access_token(token, secret)
+    @access_token = {
+      consumer_key: TumblrWrapper.consumer_key,
+      consumer_secret: TumblrWrapper.consumer_secret,
+      oauth_token: token,
+      oauth_token_secret: secret }
   end
 
-  def token
-    @access_token.try(:token)
-  end
-
-  def secret
-    @access_token.try(:secret)
+  def consumer
+    @consumer ||= OAuth::Consumer.new(
+      TumblrWrapper.consumer_key,
+      TumblrWrapper.consumer_secret,
+      site: 'http://www.tumblr.com'
+    )
   end
 end

data/lib/tumblr_wrapper/http.rb

@@ -0,0 +1,45 @@
+module TumblrWrapper::HTTP
+
+  def http_get(path, opts={signed: false}, params={})
+    validate_oauth if opts[:signed]
+    connection = Faraday.new TumblrWrapper.endpoint do |conn|
+      conn.request :oauth, access_token if opts[:signed]
+      conn.request :url_encoded
+      conn.adapter Faraday.default_adapter
+    end
+    if opts[:signed]
+      connection.get(long_path(path), params)
+    else
+      parameters = params.merge({api_key: TumblrWrapper.consumer_key})
+      connection.get(long_path(path), parameters)
+    end
+  end
+
+  def http_post(path, body)
+    validate_oauth
+    connection = Faraday.new TumblrWrapper.endpoint do |conn|
+      conn.request :oauth, access_token
+      conn.request :url_encoded
+      conn.adapter Faraday.default_adapter
+    end
+
+    connection.post long_path(path), body
+  end
+
+  private
+  def content_type
+    'application/json'
+  end
+
+  def accept
+    'application/json'
+  end
+
+  def long_path(path)
+    raise NotImplementedError
+  end
+
+  def blank?(thing)
+    thing.nil? || thing.length == 0
+  end
+end

data/lib/tumblr_wrapper/post.rb

@@ -6,7 +6,7 @@ class TumblrWrapper::Post < TumblrWrapper::BlogResource
     validate_present(:type, parameters)
     validate_not_present(:id, parameters)
 
-    oauth_request('post', :post, parameters)
+    http_post('post', parameters)
   end
 
   ##
@@ -14,7 +14,7 @@ class TumblrWrapper::Post < TumblrWrapper::BlogResource
   # http://www.tumblr.com/docs/en/api/v2#editing
   def update(parameters = {})
     validate_present(:id, parameters)
-    oauth_request('post/edit', :post, parameters)
+    http_post('post/edit', parameters)
   end
 
   ##
@@ -22,6 +22,6 @@ class TumblrWrapper::Post < TumblrWrapper::BlogResource
   # http://www.tumblr.com/docs/en/api/v2#editing
   def delete(parameters = {})
     validate_present(:id, parameters)
-    oauth_request('post/delete', :post, parameters)
+    http_post('post/delete', parameters)
   end
 end

data/lib/tumblr_wrapper/resource.rb

@@ -1,19 +1,10 @@
 class TumblrWrapper::Resource
+  include TumblrWrapper::Validators
+  include TumblrWrapper::HTTP
+
   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/validators.rb

@@ -0,0 +1,13 @@
+module TumblrWrapper::Validators
+  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/version.rb

@@ -1,3 +1,3 @@
 module TumblrWrapper
-  VERSION = "0.0.3"
+  VERSION = "0.1.0"
 end

data/lib/tumblr_wrapper.rb

@@ -1,6 +1,11 @@
+require 'json'
 require 'oauth'
-require 'rest-client'
+require 'faraday'
+require 'faraday_middleware'
+
 require "tumblr_wrapper/version"
+require "tumblr_wrapper/validators"
+require "tumblr_wrapper/http"
 require "tumblr_wrapper/client"
 require "tumblr_wrapper/resource"
 require "tumblr_wrapper/blog_resource"
@@ -8,8 +13,9 @@ require "tumblr_wrapper/blog"
 require "tumblr_wrapper/post"
 
 module TumblrWrapper
-  ENDPOINT = 'http://api.tumblr.com/v2'
+  ENDPOINT = 'http://api.tumblr.com'
   OAUTH_ENPOINT = 'http://www.tumblr.com'
+  VERSION = 'v2'
 
   def self.consumer_key=(key)
     @@consumer_key = key
@@ -35,6 +41,10 @@ module TumblrWrapper
     ENDPOINT
   end
 
+  def self.version
+    VERSION
+  end
+
   class NoAccessToken < StandardError
     def initialize(message = "Oauth request. Set access_token")
       super(message)

data/spec/blog_spec.rb

@@ -10,7 +10,7 @@ describe TumblrWrapper::Blog do
 
   describe '.info' do
     it "makes an api request" do
-      blog.should_receive(:request).with('info')
+      blog.should_receive(:http_get).with('info')
 
       blog.info
     end
@@ -18,13 +18,13 @@ describe TumblrWrapper::Blog do
 
   describe "followers" do
     it "makes an oauth request" do
-      blog.should_receive(:oauth_request).with('followers', {})
+      blog.should_receive(:http_get).with('followers', {signed: true}, {})
 
       blog.followers
     end
 
     it "accepts parameters" do
-      blog.should_receive(:oauth_request).with('followers', { limit: 20, offset: 5 })
+      blog.should_receive(:http_get).with('followers', {signed: true}, { limit: 20, offset: 5 })
 
       blog.followers({ limit: 20, offset: 5 })
     end
@@ -32,13 +32,13 @@ describe TumblrWrapper::Blog do
 
   describe "posts" do
     it "makes an api request" do
-      blog.should_receive(:request).with('posts', {})
+      blog.should_receive(:http_get).with('posts/', {})
 
       blog.posts
     end
 
     it "accepts type parameter" do
-      blog.should_receive(:request).with('posts', type: 'text')
+      blog.should_receive(:http_get).with('posts/', type: 'text')
 
       blog.posts(type: 'text')
     end

data/spec/integration/tumblr_wrapper_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe TumblrWrapper, type: :integration do
+  before do
+    TumblrWrapper.consumer_key = consumer_key
+    TumblrWrapper.consumer_secret = consumer_secret
+  end
+
+  it "can get an authorize url" do
+    VCR.use_cassette('authorize_url') do
+      client = TumblrWrapper::Client.new
+      client.authorize_url.should =~ /http\:\/\/www\.tumblr\.com\/oauth\/authorize\?oauth_token/
+    end
+  end
+
+  context "given a valid verifier and request token" do
+    it "can get an access token" do
+      VCR.use_cassette('access_token') do
+        client = TumblrWrapper::Client.new
+        client.build_request_token(request_token, request_secret)
+
+        token = client.request_access_token(oauth_verifier)
+      end
+    end
+  end
+
+  context "given an access token" do
+    describe "blog" do
+      it "can request blog info" do
+        VCR.use_cassette('blog_info') do
+          client = TumblrWrapper::Client.new
+          token = client.build_access_token(access_token, access_token_secret)
+
+          blog_resource = TumblrWrapper::Blog.new(blogname, token)
+          info = blog_resource.info
+        end
+      end
+
+      it "can request followers" do
+        VCR.use_cassette('blog_followers') do
+          client = TumblrWrapper::Client.new
+          token = client.build_access_token(access_token, access_token_secret)
+
+          blog_resource = TumblrWrapper::Blog.new(blogname, token)
+          followers = blog_resource.followers
+        end
+      end
+
+      it "can request posts" do
+        VCR.use_cassette('blog_posts') do
+          client = TumblrWrapper::Client.new
+          token = client.build_access_token(access_token, access_token_secret)
+
+          blog_resource = TumblrWrapper::Blog.new(blogname, token)
+          posts = blog_resource.posts
+        end
+      end
+    end
+
+    describe "post" do
+      it "can create a post" do
+        VCR.use_cassette('post_create') do
+          client = TumblrWrapper::Client.new
+          token = client.build_access_token(access_token, access_token_secret)
+
+          post = TumblrWrapper::Post.new(blogname, token)
+          post = post.create({
+            type: 'text',
+            body: "<p>hello world</p>"
+          })
+        end
+      end
+
+      xit "can delete a post" do
+      end
+
+      xit "can update a post" do
+      end
+    end
+  end
+end

data/spec/post_spec.rb

@@ -10,7 +10,7 @@ describe TumblrWrapper::Post do
 
   describe "create" do
     it "makes an oauth request with parameters" do
-      post.should_receive(:oauth_request).with('post', :post, {:type => 'text'})
+      post.should_receive(:http_post).with('post', {:type => 'text'})
 
       post.create({:type => 'text'})
     end
@@ -30,7 +30,7 @@ describe TumblrWrapper::Post do
 
   describe "update" do
     it "makes an oauth request with parameters" do
-      post.should_receive(:oauth_request).with('post/edit', :post, {:id => '1234'})
+      post.should_receive(:http_post).with('post/edit', {:id => '1234'})
 
       post.update({:id => '1234'})
     end
@@ -44,7 +44,7 @@ describe TumblrWrapper::Post do
 
   describe "delete" do
     it "makes an oauth request with parameters" do
-      post.should_receive(:oauth_request).with('post/delete', :post, {:id => '1234'})
+      post.should_receive(:http_post).with('post/delete', {:id => '1234'})
 
       post.delete({:id => '1234'})
     end

data/spec/spec_helper.rb

@@ -3,9 +3,19 @@ require 'spork'
 
 Spork.prefork do
   require 'rspec'
+  require 'vcr'
+  require 'webmock'
   require 'tumblr_wrapper'
+  Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|f| require f}
+
+  VCR.configure do |c|
+    c.cassette_library_dir = 'spec/vcr_cassettes'
+    c.hook_into :webmock
+  end
 
   RSpec.configure do |config|
     config.mock_with :rspec
+
+    config.include TokenHelper, type: :integration
   end
 end

data/spec/support/token_helper.rb.template

@@ -0,0 +1,34 @@
+module TokenHelper
+  def consumer_key
+    ""
+  end
+
+  def consumer_secret
+    ""
+  end
+
+  def blogname
+    ""
+  end
+
+  def access_token
+    ""
+  end
+
+  def access_token_secret
+    ""
+  end
+
+  # these are all part of the auth request set...
+  def oauth_verifier
+    ""
+  end
+
+  def request_token
+    ""
+  end
+
+  def request_secret
+    ""
+  end
+end

data/tumblr_wrapper.gemspec

@@ -16,6 +16,10 @@ Gem::Specification.new do |gem|
   gem.version       = TumblrWrapper::VERSION
   gem.add_development_dependency 'spork'
   gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock'
   gem.add_dependency 'oauth'
-  gem.add_dependency 'rest-client'
+  gem.add_dependency 'faraday'
+  gem.add_dependency 'faraday_middleware'
+  gem.add_dependency 'simple_oauth'
 end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
+  - 1
   - 0
-  - 3
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors: 
 - rheaton
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-08-01 00:00:00 -04:00
+date: 2012-08-02 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,7 +44,7 @@ dependencies:
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: oauth
+  name: vcr
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -54,10 +54,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rest-client
+  name: webmock
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
@@ -67,8 +67,60 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: faraday
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: faraday_middleware
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: simple_oauth
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id008
 description: ruby wrapper for tumblr api
 email: 
 - rachelmheaton@gmail.com
@@ -89,14 +141,17 @@ files:
 - lib/tumblr_wrapper/blog.rb
 - lib/tumblr_wrapper/blog_resource.rb
 - lib/tumblr_wrapper/client.rb
+- lib/tumblr_wrapper/http.rb
 - lib/tumblr_wrapper/post.rb
 - lib/tumblr_wrapper/resource.rb
-- lib/tumblr_wrapper/rest_client.rb
+- lib/tumblr_wrapper/validators.rb
 - lib/tumblr_wrapper/version.rb
 - spec/blog_resource_spec.rb
 - spec/blog_spec.rb
+- spec/integration/tumblr_wrapper_spec.rb
 - spec/post_spec.rb
 - spec/spec_helper.rb
+- spec/support/token_helper.rb.template
 - tumblr_wrapper.gemspec
 has_rdoc: true
 homepage: ""
@@ -133,5 +188,7 @@ summary: ""
 test_files: 
 - spec/blog_resource_spec.rb
 - spec/blog_spec.rb
+- spec/integration/tumblr_wrapper_spec.rb
 - spec/post_spec.rb
 - spec/spec_helper.rb
+- spec/support/token_helper.rb.template

data/lib/tumblr_wrapper/rest_client.rb

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