Ruby client for foauth.org - Makes OAuth optional
Ruby
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
lib
spec
.gitignore
.rspec
.travis.yml
.yardopts
Gemfile
LICENSE.txt
README.md
Rakefile
foauth.gemspec

README.md

Foauth

foauth.org Ruby client built on top of faraday.

Prerequisites

To use this gem you'll need to go to foauth.org and register for an account, then go to the services page and authenticate with the services you want to get your data out of.

Installation

Add this line to your application's Gemfile:

gem 'foauth'

And then execute:

$ bundle

Or install it yourself as:

$ gem install foauth

Usage

Create a new client passing in your foauth email and password. If you don't pass any credentials then it will look in the FOAUTH_EMAIL and FOAUTH_PASSWORD environment variables.

client = Foauth.new('bob@example.org', 'secret')

When you make a request to one of the supported foauth services the url will automatically be converted to a foauth url using the hostname and the path.

response = client.get('https://api.twitter.com/1/statuses/user_timeline.json')
# An authenticated request is made to https://foauth.org/api.twitter.com/1/statuses/user_timeline.json

puts response.success?  # true
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.

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.

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.

Build status

Build status badge

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Version history

0.4.0 (January 19, 2013)

  • Credentials can now be read from the environment variables FOAUTH_EMAIL and FOAUTH_PASSWORD. With these set you can create a new client with no arguments (Foauth.new).

0.3.0 (January 12, 2013)

  • Ruby 1.8 support
  • Travis CI builds

0.2.2 (January 6, 2013)

  • Documentation updates

0.2.1 (January 5, 2013)

  • Make sure client works without blocks (#3)

0.2.0 (January 5, 2013)

  • Allow client to accept a block to configure Faraday (#2)

0.1.0 (January 5, 2013)

  • Make sure query string is passed through to foauth (#1)

0.0.1 (January 3, 2013)

  • Initial release

Credits

Thanks to @gulopine for creating foauth.org.

Inspired by requests-foauth by @kennethreitz.

Copyright (c) Chris Mytton