Ruby wrapper for the Gowalla API.
sudo gem install gowalla
Be sure and get your API key: http://gowalla.com/api/keys
gowalla = Gowalla::Client.new(:username => 'pengwynn', :password => 'somepassword', :api_key => 'your_api_key')
Gowalla.configure do |config|
config.api_key = 'your_api_key'
config.username = 'pengwynn'
config.password = 'somepassword'
end
gowalla = Gowalla::Client.new
For OAuth2, you'll need to specify a callback URL when you set up your app and get your API keys.
Let's create the client in a protected method in our controller:
protected
def client
Gowalla::Client.new (
:api_key => "your_api_key",
:api_secret => "your_api_secret",
:access_token => session[:access_token]
)
end
We need to get an access token. Perhaps in an a before filter where you need to access Gowalla:
redirect(@client.web_server.authorize_url(:redirect_uri => redirect_uri, :state => 1))
You'll need a callback route to catch the code coming back from Gowalla after a user grants you access and this must match what you specified when you created your app on Gowalla:
get '/auth/gowalla/callback' do
session[:access_token] = client.web_server.get_access_token(params[:code], :redirect_uri => redirect_uri).token
if session[:access_token]
redirect '/auth/gowalla/test'
else
"Error retrieving access token."
end
end
Now that we have an access token we can use the client to make calls, just like we would with Basic Auth. You can checkout a basic Sinatra example.
gowalla.user('pengwynn')
=> <#Hashie::Mash accept_url="/friendships/accept?user_id=1707" activity_url="/users/1707/events" bio="Web designer and Ruby developer." events_url="/users/1707/events" fb_id=605681706 first_name="Wynn" friends_count=27 friends_only=false friends_url="/users/1707/friends" hometown="Aubrey, TX" image_url="http://s3.amazonaws.com/static.gowalla.com/users/1707-standard.jpg?1262011383" is_friend=false items_count=5 items_url="/users/1707/items" last_name="Netherland" last_visit=<#Hashie::Mash comment="Closing every account I have " created_at="2010/01/26 15:31:46 +0000" spot=<#Hashie::Mash image_url="http://static.gowalla.com/categories/186-standard.png" name="Bank Of America" small_image_url="http://static.gowalla.com/categories/186-small-standard.png" url="/spots/164052"name="Wynn Netherland" pins_count=3 pins_url="/users/1707/pins" reject_url="/friendships/reject?user_id=1707" request_url="/friendships/request?user_id=1707" stamps_count=15 stamps_url="/users/1707/stamps" top_spots_url="/users/1707/top_spots" twitter_username="pengwynn" url="/users/1707" username="pengwynn" vaulted_kinds_count=0 visited_spots_count=15 website="http://wynnnetherland.com">
Details for the current user
gowalla.user
Details for another user
gowalla.user('bradleyjoyce')
gowalla.user(1707)
I'm working on a new library i'm calling Smashie. Use it to extend the API by easily extending your requests.
Smashie extends any property ending in "_url" or "url". For example we can call.
user.get_pins
to get a users pins
user.get_stamps
to a get a users stamps or if you wish to get the data from a user's url you could issue.
user.get
Smashie simplifies navigating data structure, but excels at stringing together methods. For example if you wanted to get all of the last_checkins at the most recent checkin of a specific user you could call:
gowalla.user(username).last_checkins.first.spot.get.last_checkins
Smashie will automatically propagate the connection object through any return values. So as long as you have an object that was returned from a gowalla connection you can make an API call off of it.
So instead of: user1 = gowalla.user(username) user2 = gowalla.user(some_other_username)
You can use: user1 = gowalla.user(username) user2 = user1.connection.user(some_other_username)
Let me know if you have any feedback on Smashie, it is still very much a work in progress.
There are some sanitize methods if you're worried about any security issues, though I haven't gotten the chance to test them well.
- Fork the project.
- Make your feature addition or bug fix.
- Add tests for it. This is important so I don't break it in a future version unintentionally.
- Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
- Send me a pull request. Bonus points for topic branches.
Copyright (c) 2010 Wynn Netherland. See LICENSE for details.