cmdrkeene-foursquare 0.0.2

data/LICENSE

@@ -0,0 +1 @@
+Until further notice: Copyright 2009 Brandon Keene - All Rights Reserved

data/README

@@ -0,0 +1,11 @@
+= A Ruby API for Foursquare (playfoursquare.com)
+
+
+== Supported Actions
+
+== Check In
+
+To check into a venue by id:
+  
+  @foursquare = Foursquare.new(username, password)
+  @foursquare.check_in(12345) # => {"score" => {...}, ...}

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "foursquare"
+    gemspec.summary = "Ruby API for Foursquare (playfoursquare.com)"
+    gemspec.description = "Ruby API for Foursquare (playfoursquare.com)"
+    gemspec.email = "bkeene@gmail.com"
+    gemspec.homepage = "http://github.com/cmdrkeene/foursquare"
+    gemspec.authors = ["Brandon Keene"]
+    gemspec.add_dependency('httparty', '>= 0.4.4')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/foursquare.gemspec

@@ -0,0 +1,54 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE
+# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{foursquare}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Brandon Keene"]
+  s.date = %q{2009-08-12}
+  s.description = %q{Ruby API for Foursquare (playfoursquare.com)}
+  s.email = %q{bkeene@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README"
+  ]
+  s.files = [
+    "LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "foursquare.gemspec",
+     "init.rb",
+     "lib/foursquare.rb",
+     "spec/fixtures/checkin_failure.json",
+     "spec/fixtures/checkin_success.json",
+     "spec/foursquare_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/cmdrkeene/foursquare}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Ruby API for Foursquare (playfoursquare.com)}
+  s.test_files = [
+    "spec/foursquare_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.4.4"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.4.4"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.4.4"])
+  end
+end

data/init.rb

@@ -0,0 +1 @@
+require 'lib/foursquare'

data/lib/foursquare.rb

@@ -0,0 +1,20 @@
+require 'httparty'
+
+class Foursquare
+  class VenueNotFoundError < StandardError;end
+  
+  include HTTParty
+  base_uri "http://api.playfoursquare.com/v1"
+  format :json
+  
+  def initialize(username, password)
+    @auth = {:username => username, :password => password}
+  end
+  
+  def checkin(venue_id)
+    raise ArgumentError, "you must pass a venue_id" unless venue_id
+    response = self.class.post("/checkin.json", {:query => {:vid => venue_id}, :basic_auth => @auth})
+    raise VenueNotFoundError if response.keys.include?("addvenueprompt")
+    response["checkin"]
+  end
+end

data/spec/fixtures/checkin_failure.json

@@ -0,0 +1 @@
+"addvenueprompt":null

data/spec/fixtures/checkin_success.json

@@ -0,0 +1 @@
+{"checkin":{"message":"OK! We've got you @ Santana's Bay Park.","id":701707,"created":"Tue, 11 Aug 09 16:02:13 +0000","venue":{"id":84689,"name":"Santana's Bay Park","address":"1975 Morena Blvd.","crossstreet":null,"city":"San Diego","state":"CA","zip":92110,"cityid":38,"geolat":32.782,"geolong":-117.207},"badges":{"badge":{"id":54494,"name":"Newbie","icon":"http://playfoursquare.com/images/badges/newbie_on.png","text":"Congrats on your first check-in!"}},"scoring":{"score":{"points":5,"icon":"http://playfoursquare.com/images/scoring/1.png","message":"First time @ Santana's Bay Park!"},"score":{"points":1,"icon":"http://playfoursquare.com/images/scoring/2.png","message":"First stop today"},"total":{"points":6,"message":"6 pts "},"rank":{"friends":{"position":1,"message":"#1 amongst friends"},"city":{"position":42,"city":"San Diego","message":"#42 in San Diego (this week)"}}},"mayor":{"type":"nochange","message":"Casey W. is The Mayor of Santana's Bay Park."}}}

data/spec/foursquare_spec.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/spec_helper'
+require File.dirname(__FILE__) + '/../init'
+
+describe Foursquare do
+  describe ".checkin" do
+    before do
+      @valid_venue_id   = 84689
+      @invalid_venue_id = 111
+      @username = "user@example.com"
+      @password = "secret"
+
+      # Success
+      FakeWeb.register_uri(:post,
+                           "http://api.playfoursquare.com/v1/checkin.json?vid=#{@valid_venue_id}",
+                           :body => "Unauthorized",
+                           :status => ["401", "Unauthorized"])
+      FakeWeb.register_uri(:post,
+                           "http://user%40example.com:secret@api.playfoursquare.com/v1/checkin.json?vid=#{@valid_venue_id}",
+                           :body => fakeweb_read('checkin_success.json'))
+
+      # Failure
+      FakeWeb.register_uri(:post,
+                           "http://api.playfoursquare.com/v1/checkin.json?vid=#{@invalid_venue_id}",
+                           :body => "Unauthorized",
+                           :status => ["401", "Unauthorized"])
+      FakeWeb.register_uri(:post,
+                           "http://user%40example.com:secret@api.playfoursquare.com/v1/checkin.json?vid=#{@invalid_venue_id}",
+                           :body => fakeweb_read('checkin_failure.json'))
+    end
+    
+    it "should require a venue_id" do
+      lambda {
+        Foursquare.new(@username, @password).checkin
+      }.should raise_error(ArgumentError)
+    end
+    
+    it "should raise an error if user is invalid" do
+      lambda {
+        Foursquare.new("bork@pork.com", "arglebargle").checkin(@valid_venue_id)
+      }.should raise_error
+    end
+    
+    describe "to a valid venue, with a valid user" do
+      it "should check in and return check in data" do
+        @foursquare = Foursquare.new(@username, @password)
+        checkin = @foursquare.checkin(@valid_venue_id)
+        checkin.should == {
+          "mayor"     => {"type"=>"nochange", "message"=>"Casey W. is The Mayor of Santana's Bay Park."},
+          "scoring"   => {
+            "score" => {"icon"=>"http://playfoursquare.com/images/scoring/2.png", "points"=>1, "message"=>"First stop today"},
+            "total" => {"points"=>6, "message"=>"6 pts "},
+            "rank"  => {
+              "city"    => {"city"=>"San Diego", "position"=>42, "message"=>"#42 in San Diego (this week)"},
+              "friends" => {"position"=>1, "message"=>"#1 amongst friends"}
+            },
+          },
+          "id" => 701707, 
+          "badges" => {
+            "badge" => {"name"=>"Newbie", "text"=>"Congrats on your first check-in!", "icon"=>"http://playfoursquare.com/images/badges/newbie_on.png", "id"=>54494}
+          },
+          "venue" => {"city"=>"San Diego", "address"=>"1975 Morena Blvd.", "name"=>"Santana's Bay Park", "zip"=>92110, "geolong"=>-117.207, "geolat"=>32.782, "crossstreet"=>nil, "id"=>84689, "cityid"=>38, "state"=>"CA"},
+          "message" => "OK! We've got you @ Santana's Bay Park.", "created"=>"Tue, 11 Aug 09 16:02:13 +0000"
+        }
+      end
+    end
+    
+    describe "with an invalid venue" do
+      it "should raise an error" do
+        lambda {
+          @foursquare = Foursquare.new(@username, @password)
+          @foursquare.checkin(@invalid_venue_id).should == "foo"
+        }.should raise_error(Foursquare::VenueNotFoundError)
+      end
+    end
+  end
+
+  describe ".city" do
+  end
+
+  describe ".tip" do
+  end
+  
+  describe ".user" do
+  end
+    
+  describe ".venue" do
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+require 'spork'
+require 'fakeweb'
+
+Spork.prefork do
+  require 'spec/autorun'
+
+  Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+  
+  FakeWeb.allow_net_connect = false
+
+  Spec::Runner.configure do |config|
+    # nothing
+  end
+end
+
+Spork.each_run do
+  # nothing
+end
+
+def fakeweb_read(filename)
+  File.read(File.join(File.dirname(__FILE__), "fixtures", filename))
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: cmdrkeene-foursquare
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Brandon Keene
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-12 00:00:00 -07: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.4
+    version: 
+description: Ruby API for Foursquare (playfoursquare.com)
+email: bkeene@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+files: 
+- LICENSE
+- README
+- Rakefile
+- VERSION
+- foursquare.gemspec
+- init.rb
+- lib/foursquare.rb
+- spec/fixtures/checkin_failure.json
+- spec/fixtures/checkin_success.json
+- spec/foursquare_spec.rb
+- spec/spec_helper.rb
+has_rdoc: false
+homepage: http://github.com/cmdrkeene/foursquare
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: Ruby API for Foursquare (playfoursquare.com)
+test_files: 
+- spec/foursquare_spec.rb
+- spec/spec_helper.rb