foauth 0.2.1 → 0.2.2

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -2,6 +2,12 @@
 
 [foauth.org][foauth] Ruby client built on top of [faraday][].
 
+## Prerequisites
+
+To use this gem you'll need to go to [foauth.org][foauth] and register
+for an account, then go to the [services page][foauth services] and
+authenticate with the services you want to get your data out of.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -38,9 +44,29 @@ puts response.body      # [{"created_at":"Mon Dec 31 23:59:13 +0000 2012"...
 puts response.status    # 200
 ```
 
+### Faraday
+
 The `client` returned is an instance of `Faraday::Connection` and the
-`response` is an instance of `Faraday::Response`. See [faraday][] for
-more information.
+`response` is an instance of `Faraday::Response`.
+
+You can pass a block to `Foauth.new` which will yield a
+`Faraday::Builder` instance.  This allows you to customize middleware
+and change the default http adapter.
+
+For example, if you want `response.body` to be automatically decoded for
+you then add `faraday_middleware` to your `Gemfile` and use the
+following code to add the json and xml parsing middleware.
+
+```ruby
+require 'faraday_middleware'
+
+client = Foauth.new 'bob@example.org', 'secret' do |builder|
+  builder.response :json, :content_type => /\bjson$/
+  builder.response :xml, :content_type => /\bxml$/
+end
+```
+
+See [faraday][] for more information.
 
 ## Contributing
 
@@ -52,6 +78,10 @@ more information.
 
 ## Version history
 
+**0.2.2** (January 6, 2013)
+
+* Documentation updates
+
 **0.2.1** (January 5, 2013)
 
 * Make sure client works without blocks

data/lib/foauth.rb

@@ -1,15 +1,36 @@
 require 'faraday'
-
 require 'foauth/version'
-require 'foauth/rewrite_middleware'
 
 module Foauth
-  def self.new(email, password, &block)
+  Faraday.register_middleware :request, :foauth_proxy => lambda { Proxy }
+
+  # Creates a new `Faraday` instance using the given `email` and `password`.
+  #
+  # @param [String] email Your foauth.org email address.
+  # @param [String] password Your foauth.org password.
+  # @yield [builder] Passes the `Faraday::Builder` instance to the block if given.
+  # @return [Faraday::Connection] Configured to proxy requests to foauth.org.
+  def self.new(email, password)
     Faraday.new do |builder|
+      builder.request :foauth_proxy
       builder.request :basic_auth, email, password
-      builder.use RewriteMiddleware
       builder.adapter Faraday.default_adapter
-      block.call(builder) if block_given?
+      yield builder if block_given?
+    end
+  end
+
+  class Proxy < Faraday::Middleware
+    def call(env)
+      env[:url] = foauth_proxy_url(env[:url])
+      @app.call(env)
+    end
+
+    private
+
+    def foauth_proxy_url(url)
+      uri = URI.parse("https://foauth.org/#{url.host}#{url.path}")
+      uri.query = url.query
+      uri
     end
   end
 end

data/lib/foauth/version.rb

@@ -1,3 +1,3 @@
 module Foauth
-  VERSION = "0.2.1"
+  VERSION = "0.2.2"
 end

data/spec/middleware_spec.rb

@@ -1,9 +1,9 @@
 require 'spec_helper'
 
-describe Foauth::RewriteMiddleware do
+describe Foauth::Proxy do
   let(:conn) do
     Faraday.new do |builder|
-      builder.use Foauth::RewriteMiddleware
+      builder.request :foauth_proxy
       builder.adapter :test do |stub|
         stub.get('/api.twitter.com/1/statuses/user_timeline.json') {[ 200, {}, '{}' ]}
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foauth
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-05 00:00:00.000000000 Z
+date: 2013-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -52,13 +52,13 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
+- .yardopts
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - foauth.gemspec
 - lib/foauth.rb
-- lib/foauth/rewrite_middleware.rb
 - lib/foauth/version.rb
 - spec/client_spec.rb
 - spec/middleware_spec.rb
@@ -91,3 +91,4 @@ test_files:
 - spec/client_spec.rb
 - spec/middleware_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/lib/foauth/rewrite_middleware.rb

@@ -1,12 +0,0 @@
-require 'faraday'
-
-module Foauth
-  class RewriteMiddleware < Faraday::Middleware
-    def call(env)
-      url = env[:url]
-      env[:url] = URI.parse("https://foauth.org/#{url.host}#{url.path}")
-      env[:url].query = url.query
-      @app.call(env)
-    end
-  end
-end