tumble 0.1.1 → 0.2.0

data/README.md

@@ -1,5 +1,5 @@
 # Tumble #
-A Ruby wrapper for the v2 of Tumblr's API, supporting all endpoints.
+A Ruby wrapper for v2 of Tumblr's API, supporting all endpoints.
 
 ## <a name="installation"></a>Install
     gem install tumble
@@ -9,19 +9,19 @@ A Ruby wrapper for the v2 of Tumblr's API, supporting all endpoints.
 The gem is designed to work with Tumblr's OAuth provider for authentication. If you're using omniauth,
 there's a fine adapter available [here](https://github.com/aub/omniauth-tumblr2). You'll also need to
 register your app [here](http://www.tumblr.com/oauth/apps) in order to get a consumer key and secret.
-Once you have those values, you can configure Tumble in an initializer like so:
+Once you have those, you can configure Tumble in an initializer like so:
 
     require 'tumble'
 
     Tumble.configure do |tumble|
-      tumble.consumer_key = config['tumblr']['key']
-      tumble.consumer_secret = config['tumblr']['secret']
+      tumble.consumer_key = ENV['tumblr']['key']
+      tumble.consumer_secret = ENV['tumblr']['secret']
     end
 
 ## <a name="usage"></a>Use
 
-Connections can then be made by creating a client, passing the OAuth token and secret you get back from
-omniauth:
+A connection can then be made by creating a client, passing the OAuth token and secret you get back from
+the provider:
 
     client = Tumble::Client.new(access_token, access_secret)
 
@@ -36,7 +36,7 @@ For example, getting posts for a specific blog can be done like this:
 
     client.blog('www.riotprojects.com').posts
 
-Most of the calls allow for options to be passed, as a hash. Options are documented in the links above and are consistent
+Most of the calls allow for options to be passed as a hash. Options are documented in the links above and are consistent
 with the naming and functionality described in the [Tumblr docs](https://github.com/aub/omniauth-tumblr2).
 
 ## <a name="documentation"></a>Learn

data/lib/tumble.rb

@@ -3,7 +3,7 @@
 end
 
 module Tumble
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 
   def self.configure
     yield Config

data/lib/tumble/blog.rb

@@ -87,7 +87,7 @@ module Tumble
     # @requires_authentication Yes
     #
     # @param options [Hash] A customizable set of options
-    # @option options [String] :type The type of post to create. Specify one of the following:  text, photo, quote, link, chat, audio, video
+    # @option options [String, required] :type The type of post to create. Specify one of the following:  text, photo, quote, link, chat, audio, video
     # @option options [String] :state The state of the post. Specify one of the following:  published, draft, queue
     # @option options [String] :tags Comma-separated tags for this post
     # @option options [String] :tweet Manages the autotweet (if enabled) for this post: set to off for no tweet, or enter text to override the default tweet
@@ -96,30 +96,30 @@ module Tumble
     # @option options [String] :slug Add a short text summary to the end of the post URL
     # For text posts:
     # @option options [String] :title The optional title of the post, HTML entities must be escaped
-    # @option options [String] :body The full post body, HTML allowed
+    # @option options [String, required] :body The full post body, HTML allowed
     # For photo posts:
     # @option options [String] :caption The user-supplied caption, HTML allowed
     # @option options [String] :link The "click-through URL" for the photo
-    # @option options [String] :source The photo source URL
-    # @option options [Array] :data One or more image files (submit multiple times to create a slide show)
+    # @option options [String, required] :source The photo source URL
+    # @option options [Array, required] :data One or more image files (submit multiple times to create a slide show)
     # For quote posts:
-    # @option options [String] :quote The full text of the quote, HTML entities must be escaped
+    # @option options [String, required] :quote The full text of the quote, HTML entities must be escaped
     # @option options [String] :source Cited source, HTML allowed
     # For link posts:
     # @option options [String] :title The title of the page the link points to, HTML entities should be escaped
-    # @option options [String] :url The link
+    # @option options [String, required] :url The link
     # @option options [String] :description A user-supplied description, HTML allowed
     # For chat posts:
     # @option options [String] :title The title of the chat
-    # @option options [String] :conversation The text of the conversation/chat, with dialogue labels (no HTML)
+    # @option options [String, required] :conversation The text of the conversation/chat, with dialogue labels (no HTML)
     # For audio posts:
     # @option options [String] :caption The user-supplied caption
-    # @option options [String] :external_url The URL of the site that hosts the audio file (not tumblr)
-    # @option options [String] :data An audio file
+    # @option options [String, required] :external_url The URL of the site that hosts the audio file (not tumblr)
+    # @option options [String, required] :data An audio file
     # For video posts:
     # @option options [String] :caption The user-supplied caption
-    # @option options [String] :embed HTML embed code for the video
-    # @option options [String] :data A video file
+    # @option options [String, required] :embed HTML embed code for the video
+    # @option options [String, required] :data A video file
     def create_post(options={})
       @connection.post("/blog/#{name}/post", options).response
     end

data/lib/tumble/connection.rb

@@ -50,11 +50,11 @@ module Tumble
         :params => { :api_key => credentials[:consumer_key] }
       }
       @faraday_connection ||= Faraday::Connection.new(options) do |builder|
+        builder.use Tumble::Request::TumblrOAuth, credentials
         builder.use Faraday::Request::UrlEncoded
         builder.use Faraday::Request::Multipart
         builder.use FaradayMiddleware::Mashify
         builder.use FaradayMiddleware::ParseJson
-        builder.use Tumble::Request::TumblrOAuth, credentials
         builder.adapter Faraday.default_adapter
       end
     end

data/lib/tumble/request/oauth.rb

@@ -1,21 +1,49 @@
 require 'faraday'
-require 'simple_oauth'
 
 module Tumble
   module Request
+
     class TumblrOAuth < Faraday::Middleware
+      dependency 'simple_oauth'
+
+      AUTH_HEADER = 'Authorization'.freeze
+
+      def initialize(app, options)
+        super(app)
+        @options = options
+      end
 
       def call(env)
-        params = env[:body].is_a?(Hash) ? env[:body] : {}
-        signature_params = params.reject{ |k,v| v.respond_to?(:content_type) }
-        header = SimpleOAuth::Header.new(env[:method], env[:url], signature_params, @options)
-        env[:request_headers]['Authorization'] = header.to_s
+        env[:request_headers][AUTH_HEADER] ||= oauth_header(env).to_s if sign_request?(env)
         @app.call(env)
       end
 
-      def initialize(app, options)
-        @app = app
-        @options = options
+      def oauth_header(env)
+        SimpleOAuth::Header.new env[:method],
+                                env[:url].to_s,
+                                signature_params(body_params(env)),
+                                oauth_options(env)
+      end
+
+      def sign_request?(env)
+        !!env[:request].fetch(:oauth, true)
+      end
+
+      def oauth_options(env)
+        if extra = env[:request][:oauth] and extra.is_a? Hash and !extra.empty?
+          @options.merge extra
+        else
+          @options
+        end
+      end
+
+      def body_params(env)
+        env[:body] || {}
+      end
+
+      def signature_params(params)
+        params.empty? ? params :
+          params.reject {|k,v| v.respond_to?(:content_type) }
       end
     end
   end

data/tumble.gemspec

@@ -3,7 +3,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 1.3.5") if s.respond_to? :required_rubygems_version=
 
   s.name    = 'tumble'
-  s.version = '0.1.1'
+  s.version = '0.2.0'
 
   s.summary     = 'Library for accessing the Tumblr api v2'
   # TODO: s.description

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tumble
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-02-18 00:00:00.000000000 -05:00
+date: 2012-02-29 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70222430403580 !ruby/object:Gem::Requirement
+  requirement: &70335286948320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70222430403580
+  version_requirements: *70335286948320
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70222430403120 !ruby/object:Gem::Requirement
+  requirement: &70335286947860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70222430403120
+  version_requirements: *70335286947860
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70222430435700 !ruby/object:Gem::Requirement
+  requirement: &70335286947440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70222430435700
+  version_requirements: *70335286947440
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70222430435280 !ruby/object:Gem::Requirement
+  requirement: &70335286947020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70222430435280
+  version_requirements: *70335286947020
 description: 
 email: aubreyholland@gmail.com
 executables: []