foursquare 0.0.1 → 0.1.0

data/History

@@ -1 +1,7 @@
-0.0.1 - initial release
+== 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

@@ -1,3 +1,55 @@
 == foursquare
 
-A gem that provides a simple Ruby wrapper for the Foursquare API.
+A simple Ruby Gem wrapper for the Foursquare API.
+
+== install
+	
+	gem install foursquare
+		
+== example
+	
+	require 'rubygems'
+	require 'foursquare'
+
+	fq = Foursquare.new('username_or_phone','password')
+
+	fq.test
+	fq.cities
+	fq.venues(lat,long,radius,limit,query)
+	fq.tips(lat,long,limit)
+	fq.check_city(lat, long)
+	fq.switch_city(city_id)
+	fq.friend_checkins
+	fq.checkin(vid,venue,shout,private_checkin,tweetThis,geolat,geolong)
+	fq.history(limit)
+	fq.user_details(user_id,badges,mayor)
+	fq.friends
+	fq.venue_details(venue_id)
+	fq.add_venue(city_id,name,address,cross_street,city,state,zip,phone)
+	fq.add_tip(venue_id,text,type)
+	
+	
+== 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

@@ -6,22 +6,19 @@ require 'spec/rake/spectask'
 
 spec = Gem::Specification.new do |s|
   s.name = "foursquare"
-  s.version = "0.0.1"
+  s.version = "0.1.0"
   s.author = "Jeremy Welch"
   s.email = "hello@jeremyrwelch.com"
-  s.homepage = "http://jeremyrwelch.com"
+  s.homepage = "http://foursquare.rubyforge.org"
   s.description = s.summary = "A simple Ruby wrapper for the Foursquare API"
   
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true
-  s.extra_rdoc_files = ["README.rdoc", "LICENSE", "History"]
-  
-  # Uncomment this to add a dependency
-  # s.add_dependency "foo"
+  s.extra_rdoc_files = ["README.rdoc", "History"]
   
   s.require_path = 'lib'
   s.autorequire = 'foursquare'
-  s.files = %w(LICENSE README.rdoc Rakefile History) + Dir.glob("{lib,spec,script,examples}/**/*")
+  s.files = %w(README.rdoc Rakefile History) + Dir.glob("{lib,spec,script,examples}/**/*")
   
   s.add_dependency('httparty', '0.4.3')
 end

data/lib/foursquare.rb

@@ -6,9 +6,10 @@ class Foursquare
   include HTTParty
   base_uri 'api.foursquare.com'
   format :xml
+  
 
 # auth user    
-  def initialize(user,pass)
+  def initialize(user="",pass="")
     self.class.basic_auth user, pass
   end
   
@@ -18,23 +19,23 @@ class Foursquare
     self.class.get("/v1/test") 
   end
 
-# does not require auth  
+# no auth required 
   def cities
     self.class.get("/v1/cities")
   end
   
-  def venues(lat,long,radius="",limit="",query="")
-    self.class.get("/v1/venues?geolat=#{lat}&geolong=#{long}&r=#{radius}&l=#{limit}&q=#{query}")
+  def venues(geolat,geolong,radius="",limit="",query="")
+    self.class.get("/v1/venues?geolat=#{geolat}&geolong=#{geolong}&r=#{radius}&l=#{limit}&q=#{query}")
   end
   
-  def tips(lat,long,limit)
-    self.class.get("/v1/tips?geolat=#{lat}&geolong=#{long}&l=#{limit}")
+  def tips(geolat,geolong,limit="")
+    self.class.get("/v1/tips?geolat=#{geolat}&geolong=#{geolong}&l=#{limit}")
   end
 
 
-# require auth
-  def check_city(lat, long) 
-    self.class.get("/v1/checkcity?geolat=#{lat}&geolong=#{long}")
+# auth required
+  def check_city(geolat, geolong) 
+    self.class.get("/v1/checkcity?geolat=#{geolat}&geolong=#{geolong}")
   end
 
   def switch_city(city_id)
@@ -49,11 +50,11 @@ class Foursquare
     self.class.get("/v1/checkin?vid=#{vid}&venue=#{venue}&shout=#{shout}&private=#{private_checkin}&twitter=#{tweetThis}&geolat=#{geolat}&geolong=#{geolong}")
   end
   
-  def history(limit)
+  def history(limit="10")
     self.class.get("/v1/history?l=#{limit}")
   end
   
-  def user_details(user_id,badges,mayor)
+  def user_details(user_id,badges="0",mayor="0")
     self.class.get("/v1/user?uid=#{user_id}&badges=#{badges}&mayor=#{mayor}")
   end
   
@@ -65,7 +66,7 @@ class Foursquare
     self.class.get("/v1/venue?vid=#{venue_id}")
   end
   
-  def add_venue(city_id,name,address,cross_street,city,state,zip='0',phone='0')
+  def add_venue(city_id,name,address,cross_street,city,state,zip="",phone="")
     self.class.post("/v1/addvenue", :body => {:name => name, :address => address, :crossstreet => cross_street, :city => city, :state => state, :zip => zip, :cityid => city_id, :phone => phone})
   end
   
@@ -74,6 +75,3 @@ class Foursquare
   end
   
 end
-
-
-

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: foursquare
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors: 
 - Jeremy Welch
@@ -9,7 +9,7 @@ autorequire: foursquare
 bindir: bin
 cert_chain: []
 
-date: 2009-10-31 00:00:00 -04:00
+date: 2009-11-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -30,10 +30,8 @@ extensions: []
 
 extra_rdoc_files: 
 - README.rdoc
-- LICENSE
 - History
 files: 
-- LICENSE
 - README.rdoc
 - Rakefile
 - History
@@ -42,9 +40,8 @@ files:
 - spec/spec_helper.rb
 - script/destroy
 - script/generate
-- examples/fq_test_script.rb
 has_rdoc: true
-homepage: http://jeremyrwelch.com
+homepage: http://foursquare.rubyforge.org
 licenses: []
 
 post_install_message: 

data/LICENSE

@@ -1,20 +0,0 @@
-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/examples/fq_test_script.rb

@@ -1,7 +0,0 @@
-require 'rubygems'
-require 'foursquare'
-
-
-fq = Foursquare.new('','') #Add Your Foursquare Login (email or phone number) and Pass
-puts fq.cities.inspect
-puts fq.test