foursquare-oauth 0.2.2

data/History

@@ -0,0 +1,16 @@
+== 0.2.2 March 5, 2010
+* oauth support
+* method_missing api mapping
+== 0.2.0 February 7th, 2010
+* updated methods to reflect updates to Foursquare API
+* added validations
+* deprecated cities, check_city, switch_city, and friend_checkins calls in line with updates to the Foursquare API
+* updated readme to reflect code changes
+
+== 0.1.0 November 8th, 2009
+* added website
+* added defaults for optional method variables
+* fleshed out readme
+
+== 0.0.1 - October 31, 2009
+* initial release

data/README.rdoc

@@ -0,0 +1,114 @@
+== foursquare
+
+A simple Ruby Gem wrapper for the Foursquare API. With OAuth authentication.
+
+== install
+  
+  gem install foursquare
+    
+== example
+  
+  require 'rubygems'
+  require 'foursquare'
+  
+  oauth_key 'your_key'
+  oauth_secret = 'your_secret'
+  
+  oauth = Foursquare::OAuth.new(oauth_key, oauth_secret)
+  
+  request_token = oauth.request_token.token
+  request_secret = oauth.request_token.secret
+  
+  # redirecting user to foursquare to authorize
+  oauth.request_token.authorize_url
+  
+  # foursquare redirects back to your callback url, passing the verifier in the url params
+  
+  access_token, access_secret = oauth.authorize_from_request(request_token, request_secret, verifier)
+  
+  # save the user's access token and secret
+  
+  
+  oauth = Foursquare::OAuth.new(oauth_key, oauth_secret)
+  oauth.authorize_from_access(access_token, access_secret)
+  foursquare = Foursquare::Base.new(oauth)
+  
+  foursquare.test
+  
+  foursquare.venues :geolat => geolat, :geolong => geolong, :limit => 10, :q => 'pizza'
+  foursquare.tips :geolat => geolat, :geolong => geolong, :limit => 10
+  foursquare.checkins :geolat => geolat, :geolong => geolong
+  
+  checkin = {
+    :vid => vid,
+    :shout => "this is what i'm up to",
+    :venue => "Cohabitat",
+    :private => 0,
+    :twitter => 0,
+    :geolat => geolat,
+    :geolong => geolong
+  }
+  
+  # these all do the same thing
+  # the response is a hashie object built from the checkin json.  so you can do new_checkin.shout
+  new_checkin = foursquare.checkin(checkin)
+  new_checkin.class
+  => Hashie::Mash
+  new_checkin
+  => {...checkin hashie...}
+  new_checkin = foursquare.send('checkin=', checkin)
+  new_checkin.class
+  => Hash
+  new_checkin
+  => {'checkin' => {...}}
+  new_checkin = foursquare.api(:checkin=, checkin)
+  new_checkin.class
+  => Hashie::Mash
+  new_checkin
+  => {:checkin => {...}}
+  
+  foursquare.history :limit => 10
+  foursquare.api(:history, :limit => 10).checkins
+  foursquare.user :uid => user_id :badges => 0
+  foursquare.user # currently authenticated user
+  foursquare.friends :uid => 99999
+  foursquare.venue :vid => venue_id
+  foursquare.addvenue :name => name, :address => address, :city => city, ...
+  foursquare.venue_proposeedit :venue_id => venue_id, :name => name, :address => address, :city => ...
+  foursquare.venue_flagclosed :vid => venue_id
+  foursquare.addtip :vid => 12345, :tip => 'here is a tip'
+  foursquare.tip_marktodo :tid => tip_id
+  foursquare.tip_markdone :tid => tip_id
+  foursquare.friend_requests
+  foursquare.friend_approve :uid => friend_id
+  foursquare.friend_deny :uid => friend_id
+  foursquare.friend_sendrequest :uid => friend_id
+  foursquare.findfriends_byname :q => search_string
+  foursquare.findfriends_byphone :q => '555 123'
+  foursquare.findfriends_bytwitter :q => twitter_name
+  foursquare.settings_setping :uid => user_id, :self => global_ping_status
+  
+== license 
+
+(the MIT license)
+
+Copyright (c) 2009 Workperch Inc
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems' unless ENV['NO_RUBYGEMS']
+require 'rake/gempackagetask'
+require 'rubygems/specification'
+require 'date'
+require 'spec/rake/spectask'
+
+spec = Gem::Specification.new do |s|
+  s.name = "foursquare-oauth"
+  s.version = '0.2.2'
+  s.authors = ['Jeremy Welch', 'Thomas Hanley', 'Elise Wood']
+  s.email = "hello@jeremyrwelch.com"
+  s.homepage = "http://github.com/glytch/Foursquare"
+  s.description = s.summary = "A simple Ruby wrapper for the Foursquare API"
+  s.post_install_message = "NOTE: This version of the Foursquare Gem has significant changes to the way methods are called. Please review the examples in the README"
+  
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README.rdoc", "History"]
+  
+  s.require_path = 'lib'
+  s.autorequire = 'foursquare'
+  s.files = %w(README.rdoc Rakefile History) + Dir.glob("{lib,spec,script,examples}/**/*")
+  
+  s.add_dependency('httparty', '0.4.3')
+  s.add_dependency('oauth', '0.3.6')
+  s.add_dependency('hashie', '0.1.5')
+end
+
+task :default => :spec
+
+desc "Run specs"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.spec_opts = %w(-fs --color)
+end
+
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the gem locally"
+task :install => [:package] do
+  sh %{sudo gem install pkg/#{GEM}-#{GEM_VERSION}}
+end
+
+desc "create a gemspec file"
+task :make_spec do
+  File.open("foursquare.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/foursquare.rb

@@ -0,0 +1,226 @@
+require 'rubygems'
+require 'httparty'
+require 'hashie'
+require 'oauth'
+
+Hash.send :include, Hashie::HashExtensions
+
+
+
+module Foursquare
+  class OAuth
+    def initialize(ctoken, csecret, options={})
+      @consumer_token, @consumer_secret = ctoken, csecret
+    end
+  
+    def consumer
+      return @consumer if @consumer
+      @consumer = ::OAuth::Consumer.new(@consumer_token, @consumer_secret, {
+        :site               => "http://foursquare.com",
+        :scheme             => :header,
+        :http_method        => :post,
+        :request_token_path => "/oauth/request_token",
+        :access_token_path  => "/oauth/access_token",
+        :authorize_path     => "/oauth/authorize",
+        :proxy              => (ENV['HTTP_PROXY'] || ENV['http_proxy'])
+      })
+    end
+  
+    def set_callback_url(url)
+      clear_request_token
+      request_token(:oauth_callback => url)
+    end
+    
+    def request_token(options={})
+      @request_token ||= consumer.get_request_token(options)
+    end
+  
+    def authorize_from_request(request_token, request_secret, verifier)
+      request_token = ::OAuth::RequestToken.new(consumer, request_token, request_secret)
+      access_token = request_token.get_access_token(:oauth_verifier => verifier)
+      @atoken, @asecret = access_token.token, access_token.secret
+    end
+  
+    def access_token
+      @access_token ||= ::OAuth::AccessToken.new(consumer, @atoken, @asecret)
+    end
+  
+    def authorize_from_access(atoken, asecret)
+      @atoken, @asecret = atoken, asecret
+    end
+    
+    private
+    
+    def clear_request_token
+      @request_token = nil
+    end
+  end
+  
+  class Base
+    BASE_URL = 'http://api.foursquare.com/v1'
+    FORMAT = 'json'
+    
+    attr_accessor :oauth
+    
+    def initialize(oauth)
+      @oauth = oauth
+    end
+    
+    #
+    # Foursquare API: http://groups.google.com/group/foursquare-api/web/api-documentation
+    #
+    # .test                                          # api test method
+    #  => {'response': 'ok'}
+    # .checkin = {:shout => 'At home. Writing code'} # post new check in
+    #  => {...checkin hash...}
+    # .history                                       # authenticated user's checkin history
+    # => [{...checkin hashie...}, {...another checkin hashie...}]
+    # .send('venue.flagclosed=', {:vid => 12345})     # flag venue 12345 as closed
+    # => {'response': 'ok'}
+    # .venue_flagclosed = {:vid => 12345}
+    # => {'response': 'ok'}
+    #
+    # Assignment methods(POSTs) always return a hash. Annoyingly Ruby always returns what's on
+    # the right side of the assignment operator. So there are some wrapper methods below
+    # for POSTs that make sure it gets turned into a hashie
+    #
+    def method_missing(method_symbol, params = {})
+      method_name = method_symbol.to_s.split(/\.|_/).join('/')
+      
+      if (method_name[-1,1]) == '='
+        method = method_name[0..-2]
+        result = post(api_url(method), params)
+        params.replace(result[method] || result)
+      else
+        result = get(api_url(method_name, params))
+        result[method_name] || result
+      end
+    end
+    
+    def api(method_symbol, params = {})
+      Hashie::Mash.new(method_missing(method_symbol, params))
+    end
+    
+    def api_url(method_name, options = nil)
+      params = options.is_a?(Hash) ? to_query_params(options) : options
+      params = nil if params and params.blank?
+      url = BASE_URL + '/' + method_name.split('.').join('/')
+      url += ".#{FORMAT}"
+      url += "?#{params}" if params
+      url
+    end
+    
+    def parse_response(response)
+      raise_errors(response)
+      Crack::JSON.parse(response.body)
+    end
+    
+    def to_query_params(options)
+      options.collect { |key, value| "#{key}=#{value}" }.join('&')
+    end
+    
+    def get(url)
+      parse_response(@oauth.access_token.get(url))
+    end
+    
+    def post(url, body)
+      parse_response(@oauth.access_token.post(url, body))
+    end
+    
+    # API method wrappers
+    
+    def checkin(params = {})
+      api(:checkin=, params).checkin
+    end
+    
+    def history(params = {})
+      api(:history, params).checkins
+    end
+    
+    def addvenue(params = {})
+      api(:addvenue=, params).venue
+    end
+    
+    def venue_proposeedit(params = {})
+      api(:venue_proposeedit=, params)
+    end
+    
+    def venue_flagclosed(params = {})
+      api(:venue_flagclosed=, params)
+    end
+    
+    def addtip(params = {})
+      api(:addtip=, params).tip
+    end
+    
+    def tip_marktodo(params = {})
+      api(:tip_marktodo=, params).tip
+    end
+    
+    def tip_markdone(params = {})
+      api(:tip_markdone=, params).tip
+    end
+    
+    def friend_requests
+      api(:friend_requests).requests
+    end
+    
+    def friend_approve(params = {})
+      api(:friend_approve=, params).user
+    end
+    
+    def friend_deny(params = {})
+      api(:friend_deny=, params).user
+    end
+
+    def friend_sendrequest(params = {})
+      api(:friend_sendrequest=, params).user
+    end
+    
+    def findfriends_byname(params = {})
+      api(:findfriends_byname, params).users
+    end
+    
+    def findfriends_byphone(params = {})
+      api(:findfriends_byphone, params).users
+    end
+    
+    def findfriends_bytwitter(params = {})
+      api(:findfriends_bytwitter, params).users
+    end
+    
+    def settings_setpings(params = {})
+      api(:settings_setpings=, params).settings
+    end
+    
+    private
+    
+    
+    def raise_errors(response)
+      message = "(#{response.code}): #{response.message} - #{response.inspect} - #{response.body}"
+      
+      case response.code.to_i
+        when 400
+          raise BadRequest, message
+        when 401
+          raise Unauthorized, message
+        when 403
+          raise General, message
+        when 404
+          raise NotFound, message
+        when 500
+          raise InternalError, "Foursquare had an internal error. Please let them know in the group.\n#{message}"
+        when 502..503
+          raise Unavailable, message
+      end
+    end
+  end
+  
+  
+  class BadRequest < StandardError; end
+  class Unauthorized      < StandardError; end
+  class General           < StandardError; end
+  class Unavailable       < StandardError; end
+  class InternalError     < StandardError; end
+  class NotFound          < StandardError; end
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:newgem_simple, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:newgem_simple, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/foursquare_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "foursquare" do
+  it "should do nothing" do
+    true.should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$TESTING=true
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification 
+name: foursquare-oauth
+version: !ruby/object:Gem::Version 
+  version: 0.2.2
+platform: ruby
+authors: 
+- Jeremy Welch
+- Thomas Hanley
+- Elise Wood
+autorequire: foursquare
+bindir: bin
+cert_chain: []
+
+date: 2010-03-08 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.4.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.3.6
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hashie
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 0.1.5
+    version: 
+description: A simple Ruby wrapper for the Foursquare API
+email: hello@jeremyrwelch.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- History
+files: 
+- README.rdoc
+- Rakefile
+- History
+- lib/foursquare.rb
+- spec/foursquare_spec.rb
+- spec/spec_helper.rb
+- script/destroy
+- script/generate
+has_rdoc: true
+homepage: http://github.com/glytch/Foursquare
+licenses: []
+
+post_install_message: "NOTE: This version of the Foursquare Gem has significant changes to the way methods are called. Please review the examples in the README"
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: A simple Ruby wrapper for the Foursquare API
+test_files: []
+