foursquare2 1.8.1 → 1.8.2

data/Readme.md

@@ -72,6 +72,8 @@ See [the documentation](http://rubydoc.info/gems/foursquare2/frames) or [foursqu
     client.recent_checkins
     client.add_checkin
     client.add_checkin_comment
+    client.add_checkin_post
+    client.add_checkin_reply
     client.delete_checkin_comment
     client.photo
     client.add_photo

data/VERSION

@@ -1 +1 @@
-1.8.1
+1.8.2

data/foursquare2.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "foursquare2"
-  s.version = "1.8.1"
+  s.version = "1.8.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Mueller", "Marco Moura"]
-  s.date = "2012-08-19"
+  s.date = "2012-09-01"
   s.description = "Gives access to all endpoints in version 2 of foursquare's API with syntax that will be familiar to those who used the original foursquare gem by Jeremy Welch."
   s.email = ["muellermr@gmail.com", "email@marcomoura.com"]
   s.extra_rdoc_files = [
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
     "lib/foursquare2/campaigns.rb",
     "lib/foursquare2/checkins.rb",
     "lib/foursquare2/client.rb",
+    "lib/foursquare2/events.rb",
     "lib/foursquare2/lists.rb",
     "lib/foursquare2/pages.rb",
     "lib/foursquare2/photos.rb",
@@ -38,48 +39,52 @@ Gem::Specification.new do |s|
     "lib/foursquare2/users.rb",
     "lib/foursquare2/venues.rb",
     "test/config.rb",
-    "test/fixtures/campaign_created.json",
-    "test/fixtures/checkin.json",
+    "test/fixtures/campaigns/campaign_created.json",
+    "test/fixtures/checkins/checkin.json",
+    "test/fixtures/checkins/checkin_reply.json",
+    "test/fixtures/checkins/friend_checkins.json",
+    "test/fixtures/checkins/post_created.json",
     "test/fixtures/error.json",
     "test/fixtures/error_template.json",
-    "test/fixtures/explore_venues.json",
-    "test/fixtures/friend_checkins.json",
-    "test/fixtures/list.json",
-    "test/fixtures/list_created.json",
-    "test/fixtures/list_followed.json",
-    "test/fixtures/list_item.json",
-    "test/fixtures/list_moved_item.json",
-    "test/fixtures/list_updated.json",
-    "test/fixtures/managed_venues.json",
-    "test/fixtures/no_venues_by_tip.json",
-    "test/fixtures/page.json",
-    "test/fixtures/page_venues.json",
-    "test/fixtures/photo.json",
-    "test/fixtures/search_pages.json",
-    "test/fixtures/search_specials.json",
-    "test/fixtures/search_tips.json",
-    "test/fixtures/search_users.json",
-    "test/fixtures/search_venues.json",
-    "test/fixtures/search_venues_by_tip.json",
-    "test/fixtures/special.json",
-    "test/fixtures/special_created.json",
-    "test/fixtures/suggest_completion_venues.json",
-    "test/fixtures/tip.json",
-    "test/fixtures/user.json",
-    "test/fixtures/user_lists.json",
-    "test/fixtures/user_mayorships.json",
-    "test/fixtures/user_tips.json",
-    "test/fixtures/user_tips_empty.json",
-    "test/fixtures/venue.json",
-    "test/fixtures/venue_links.json",
-    "test/fixtures/venue_menus.json",
-    "test/fixtures/venue_photos.json",
-    "test/fixtures/venue_stats.json",
-    "test/fixtures/venue_tips.json",
+    "test/fixtures/events/event.json",
+    "test/fixtures/events/event_categories.json",
+    "test/fixtures/lists/list.json",
+    "test/fixtures/lists/list_created.json",
+    "test/fixtures/lists/list_followed.json",
+    "test/fixtures/lists/list_item.json",
+    "test/fixtures/lists/list_moved_item.json",
+    "test/fixtures/lists/list_updated.json",
+    "test/fixtures/pages/page.json",
+    "test/fixtures/pages/page_venues.json",
+    "test/fixtures/pages/search_pages.json",
+    "test/fixtures/photos/photo.json",
+    "test/fixtures/specials/search_specials.json",
+    "test/fixtures/specials/special.json",
+    "test/fixtures/specials/special_created.json",
+    "test/fixtures/tips/search_tips.json",
+    "test/fixtures/tips/tip.json",
+    "test/fixtures/users/search_users.json",
+    "test/fixtures/users/user.json",
+    "test/fixtures/users/user_lists.json",
+    "test/fixtures/users/user_mayorships.json",
+    "test/fixtures/users/user_tips.json",
+    "test/fixtures/venues/explore_venues.json",
+    "test/fixtures/venues/managed_venues.json",
+    "test/fixtures/venues/no_venues_by_tip.json",
+    "test/fixtures/venues/search_venues.json",
+    "test/fixtures/venues/search_venues_by_tip.json",
+    "test/fixtures/venues/suggest_completion_venues.json",
+    "test/fixtures/venues/venue.json",
+    "test/fixtures/venues/venue_links.json",
+    "test/fixtures/venues/venue_menus.json",
+    "test/fixtures/venues/venue_photos.json",
+    "test/fixtures/venues/venue_stats.json",
+    "test/fixtures/venues/venue_tips.json",
     "test/helper.rb",
     "test/test_campaigns.rb",
     "test/test_checkins.rb",
     "test/test_client.rb",
+    "test/test_events.rb",
     "test/test_lists.rb",
     "test/test_pages.rb",
     "test/test_photos.rb",

data/lib/foursquare2/checkins.rb

@@ -73,6 +73,35 @@ module Foursquare2
       return_error_or_body(response, response.body.response)  
     end
 
+    # Add a post to a checkin.
+    #
+    # @param [String] checkin_id the ID of the checkin.
+    # @param [Hash]  options
+    # @option options String :text - The text of the post, up to 200 characters.
+    # @option options String :url - Link for more details. This page will be opened in an embedded web view in the foursquare application, unless contentId is specified and a native link handler is registered and present. We support the following URL schemes: http, https, foursquare, mailto, tel, and sms.
+    # @option options String :contentId - Identifier for the post to be used in a native link, up to 50 characters. A url must also be specified in the request.
+
+    def add_checkin_post(checkin_id, options={})
+      response = connection.post do |req|
+        req.url "checkins/#{checkin_id}/addpost", options
+      end
+      return_error_or_body(response, response.body.response.post)  
+    end
+
+    # Add a reply to a checkin.
+    #
+    # @param [String] checkin_id the ID of the checkin.
+    # @param [Hash]  options
+    # @option options String :text - The text of the post, up to 200 characters.
+    # @option options String :url - Link for more details. This page will be opened in an embedded web view in the foursquare application, unless contentId is specified and a native link handler is registered and present. We support the following URL schemes: http, https, foursquare, mailto, tel, and sms.
+    # @option options String :contentId - Identifier for the post to be used in a native link, up to 50 characters. A url must also be specified in the request.
+
+    def add_checkin_reply(checkin_id, options={})
+      response = connection.post do |req|
+        req.url "checkins/#{checkin_id}/reply", options
+      end
+      return_error_or_body(response, response.body.response.reply)  
+    end
   end    
 end
 

data/lib/foursquare2/client.rb

@@ -21,6 +21,7 @@ module Foursquare2
     include Pages
     include Campaigns
     include Lists
+    include Events
 
     attr_reader :client_id, :client_secret, :oauth_token, :api_version
 

data/lib/foursquare2/events.rb

@@ -0,0 +1,21 @@
+module Foursquare2
+  module Events
+
+    # Retrieve information about an event
+    #
+    # param [String] event_id The ID of the event
+
+    def event(event_id)
+      response = connection.get("events/#{event_id}")
+      return_error_or_body(response, response.body.response.event)
+    end
+
+    # Retrieve information about all event categories.
+
+    def event_categories
+      response = connection.get("events/categories")
+      return_error_or_body(response, response.body.response.categories)
+    end
+
+  end
+end

data/lib/foursquare2/venues.rb

@@ -47,8 +47,6 @@ module Foursquare2
     end
 
     # Retrieve information about all venue categories.
-    #
-    # param [String] venue_id The ID of the venue
 
     def venue_categories
       response = connection.get("venues/categories")

data/lib/foursquare2.rb

@@ -28,6 +28,7 @@ module Foursquare2
   require 'foursquare2/venues'
   require 'foursquare2/pages'
   require 'foursquare2/lists'
+  require 'foursquare2/events'
   require 'foursquare2/client'
   require 'foursquare2/api_error'
 

data/test/fixtures/checkins/checkin_reply.json

@@ -0,0 +1,30 @@
+{
+    "meta": {
+        "code": 200, 
+        "errorDetail": "Please provide an API version to avoid future errors.See http://bit.ly/vywCav", 
+        "errorType": "deprecated"
+    }, 
+    "notifications": [
+        {
+            "item": {
+                "unreadCount": -1
+            }, 
+            "type": "notificationTray"
+        }
+    ], 
+    "response": {
+        "reply": {
+            "createdAt": 1346497989, 
+            "id": "5041edc5e4b09ae79babd551", 
+            "source": {
+                "detailUrl": "https://foursquare.com/device/app/SDDBI1SDSDEGVP3YUJGAJC0TRNCKCPA5WABTMYQ5OFBVDOLJ", 
+                "icon": "https://foursquare.com/img/blank_app_16.png", 
+                "id": "SDDBI1SDSDEGVP3YUJGAJC0TRNCKCPA5WABTMYQ5OFBVDOLJ", 
+                "name": "Foursquare API documentation", 
+                "photo": "https://foursquare.com/img/blank_app.png", 
+                "url": "https://developer.foursquare.com"
+            }, 
+            "text": "Test"
+        }
+    }
+}

data/test/fixtures/checkins/post_created.json

@@ -0,0 +1,30 @@
+{
+    "meta": {
+        "code": 200,
+        "errorDetail": "Please provide an API version to avoid future errors.See http://bit.ly/vywCav",
+        "errorType": "deprecated"
+    },
+    "notifications": [
+        {
+            "item": {
+                "unreadCount": -1
+            },
+            "type": "notificationTray"
+        }
+    ],
+    "response": {
+        "post": {
+            "createdAt": 1346497204,
+            "id": "5041eab4e4b05127f7e64be6",
+            "source": {
+                "detailUrl": "https://foursquare.com/device/app/SDDBI1SDSDEGVP3YUJGAJC0TRNCKCPA5WABTMYQ5OFBVDOLJ",
+                "icon": "https://foursquare.com/img/blank_app_16.png",
+                "id": "SDDBI1SDSDEGVP3YUJGAJC0TRNCKCPA5WABTMYQ5OFBVDOLJ",
+                "name": "Foursquare API documentation",
+                "photo": "https://foursquare.com/img/blank_app.png",
+                "url": "https://developer.foursquare.com"
+            },
+            "text": "Test"
+        }
+    }
+}

data/test/fixtures/events/event.json

@@ -0,0 +1,53 @@
+{
+  "meta": {
+    "code": 200
+  },
+  "notifications": [{
+    "type": "notificationTray",
+    "item": {
+      "unreadCount": -1
+    }
+  }],
+  "response": {
+    "event": {
+      "venueId": "4b108b9ef964a5208f7223e3",
+      "id": "4f98d496f6903e7ae2a3628c",
+      "name": "Marvel's The Avengers",
+      "foreignIds": {
+        "count": 0,
+        "items": []
+      },
+      "categories": [{
+        "id": "4dfb90c6bd413dd705e8f897",
+        "name": "Movies",
+        "pluralName": "Movies",
+        "shortName": "Movie",
+        "icon": {
+          "prefix": "https:\/\/foursquare.com\/img\/categories_v2\/arts_entertainment\/movietheater_",
+          "suffix": ".png"
+        },
+        "primary": true
+      }],
+      "hereNow": {
+        "count": 0,
+        "groups": [{
+          "type": "friends",
+          "name": "Friends here",
+          "count": 0,
+          "items": []
+        }, {
+          "type": "others",
+          "name": "Other people here",
+          "count": 0,
+          "items": []
+        }]
+      },
+      "allDay": true,
+      "date": 1336021200,
+      "stats": {
+        "checkinsCount": 128,
+        "usersCount": 125
+      }
+    }
+  }
+}

data/test/fixtures/events/event_categories.json

@@ -0,0 +1,153 @@
+{
+    "meta": {
+        "code": 200
+    },
+    "response": {
+        "categories": [
+            {
+                "id": "4dfb90c6bd413dd705e8f897",
+                "name": "Movies",
+                "pluralName": "Movies",
+                "shortName": "Movie",
+                "icon": {
+                    "prefix": "https://foursquare.com/img/categories_v2/arts_entertainment/movietheater_",
+                    "suffix": ".png"
+                },
+                "categories": []
+            },
+            {
+                "id": "4e0a4b91bd41eda0d6092f89",
+                "name": "Music",
+                "pluralName": "Music",
+                "shortName": "Music",
+                "icon": {
+                    "prefix": "https://foursquare.com/img/categories_v2/arts_entertainment/musicvenue_",
+                    "suffix": ".png"
+                },
+                "categories": []
+            },
+            {
+                "id": "4e458e3bbd41d66894dbdecc",
+                "name": "Other",
+                "pluralName": "Other",
+                "shortName": "Other",
+                "icon": {
+                    "prefix": "https://foursquare.com/img/categories_v2/event/default_",
+                    "suffix": ".png"
+                },
+                "categories": []
+            },
+            {
+                "id": "4f59477b33bdcd006285c0e4",
+                "name": "Panels",
+                "pluralName": "Panels",
+                "shortName": "Panel",
+                "icon": {
+                    "prefix": "https://foursquare.com/img/categories_v2/event/default_",
+                    "suffix": ".png"
+                },
+                "categories": []
+            },
+            {
+                "id": "4e09f7a5bd41dc571bc3b1dc",
+                "name": "Sporting Events",
+                "pluralName": "Sporting Events",
+                "shortName": "Sport",
+                "icon": {
+                    "prefix": "https://foursquare.com/img/categories_v2/event/default_",
+                    "suffix": ".png"
+                },
+                "categories": [
+                    {
+                        "id": "4e132f48bd41026cd50e8f8e",
+                        "name": "Baseball Games",
+                        "pluralName": "Baseball Games",
+                        "shortName": "Baseball",
+                        "icon": {
+                            "prefix": "https://foursquare.com/img/categories_v2/arts_entertainment/stadium_baseball_",
+                            "suffix": ".png"
+                        },
+                        "categories": []
+                    },
+                    {
+                        "id": "4e132f48bd41026cd50e8f91",
+                        "name": "Basketball Games",
+                        "pluralName": "Basketball Games",
+                        "shortName": "Basketball",
+                        "icon": {
+                            "prefix": "https://foursquare.com/img/categories_v2/arts_entertainment/stadium_basketball_",
+                            "suffix": ".png"
+                        },
+                        "categories": []
+                    },
+                    {
+                        "id": "4e132f48bd41026cd50e8f8f",
+                        "name": "Football Game",
+                        "pluralName": "Football Game",
+                        "shortName": "Football",
+                        "icon": {
+                            "prefix": "https://foursquare.com/img/categories_v2/arts_entertainment/stadium_football_",
+                            "suffix": ".png"
+                        },
+                        "categories": []
+                    },
+                    {
+                        "id": "4e1ca351bd4159e7d88bd90c",
+                        "name": "Golf Tournaments",
+                        "pluralName": "Golf Tournaments",
+                        "shortName": "Golf",
+                        "icon": {
+                            "prefix": "https://foursquare.com/img/categories_v2/parks_outdoors/golfcourse_",
+                            "suffix": ".png"
+                        },
+                        "categories": []
+                    },
+                    {
+                        "id": "4e132f48bd41026cd50e8f90",
+                        "name": "Hockey Games",
+                        "pluralName": "Hockey Games",
+                        "shortName": "Hockey",
+                        "icon": {
+                            "prefix": "https://foursquare.com/img/categories_v2/arts_entertainment/stadium_hockey_",
+                            "suffix": ".png"
+                        },
+                        "categories": []
+                    },
+                    {
+                        "id": "4e1dbf8dbd4146b989a9d9ee",
+                        "name": "Races",
+                        "pluralName": "Races",
+                        "shortName": "Racing",
+                        "icon": {
+                            "prefix": "https://foursquare.com/img/categories_v2/arts_entertainment/racetrack_",
+                            "suffix": ".png"
+                        },
+                        "categories": []
+                    },
+                    {
+                        "id": "4e173846bd41c6d19e8dd5a3",
+                        "name": "Soccer Matches",
+                        "pluralName": "Soccer Matches",
+                        "shortName": "Soccer",
+                        "icon": {
+                            "prefix": "https://foursquare.com/img/categories_v2/arts_entertainment/stadium_soccer_",
+                            "suffix": ".png"
+                        },
+                        "categories": []
+                    },
+                    {
+                        "id": "4e29cd20bd41a4ce124ac881",
+                        "name": "Tennis Matches",
+                        "pluralName": "Tennis Matches",
+                        "shortName": "Tennis",
+                        "icon": {
+                            "prefix": "https://foursquare.com/img/categories_v2/arts_entertainment/stadium_tennis_",
+                            "suffix": ".png"
+                        },
+                        "categories": []
+                    }
+                ]
+            }
+        ]
+    }
+}

data/test/test_campaigns.rb

@@ -8,7 +8,7 @@ class TestCampaigns < Test::Unit::TestCase
     end
     
     should "add a campaign" do
-      stub_post("https://api.foursquare.com/v2/campaigns/add?oauth_token=#{@client.oauth_token}&specialId=4bd876f886ba62b58a6e88b3", "campaign_created.json")
+      stub_post("https://api.foursquare.com/v2/campaigns/add?oauth_token=#{@client.oauth_token}&specialId=4bd876f886ba62b58a6e88b3", "campaigns/campaign_created.json")
       campaign = @client.add_campaign(:specialId => '4bd876f886ba62b58a6e88b3')
       campaign.special.id == "4bd876f886ba62b58a6e88b3"
     end

data/test/test_checkins.rb

@@ -8,19 +8,31 @@ class TestCheckins < Test::Unit::TestCase
     end
 
     should "fetch info for a single checkin" do
-      stub_get("https://api.foursquare.com/v2/checkins/4d572bcc9e508cfab975189b?oauth_token=#{@client.oauth_token}", "checkin.json")
+      stub_get("https://api.foursquare.com/v2/checkins/4d572bcc9e508cfab975189b?oauth_token=#{@client.oauth_token}", "checkins/checkin.json")
       checkin = @client.checkin('4d572bcc9e508cfab975189b')
       checkin.venue.name.should == 'Bridgestone Arena'
       checkin.user.firstName.should == 'Matt'
     end
 
     should "fetch recent checkins from friends"do
-      stub_get("https://api.foursquare.com/v2/checkins/recent?oauth_token=#{@client.oauth_token}&limit=2", "friend_checkins.json")
+      stub_get("https://api.foursquare.com/v2/checkins/recent?oauth_token=#{@client.oauth_token}&limit=2", "checkins/friend_checkins.json")
       checkins = @client.recent_checkins(:limit => 2)
       checkins.count.should == 2
       checkins.first.venue.name.should == 'Buffalo Billiards'
       checkins.last.user.firstName.should == 'David'
     end
+
+    should "add a post to an existing checkin" do
+      stub_post("https://api.foursquare.com/v2/checkins/5041335de4b08d95c1591453/addpost?oauth_token=#{@client.oauth_token}&text=Test", "checkins/post_created.json")
+      post = @client.add_checkin_post('5041335de4b08d95c1591453', :text => "Test")
+      post.text.should == "Test"
+    end
+
+    should "add a reply to an existing checkin" do
+      stub_post("https://api.foursquare.com/v2/checkins/5041eda9e4b0133020c2292c/reply?oauth_token=#{@client.oauth_token}&text=Test", "checkins/checkin_reply.json")
+      reply = @client.add_checkin_reply('5041eda9e4b0133020c2292c', :text => "Test")
+      reply.text.should == "Test"
+    end
   end
 
 end

data/test/test_client.rb

@@ -51,7 +51,7 @@ class TestClient < Test::Unit::TestCase
 
   context "When returning a successful response" do
     should "return the response body as a Hash." do
-      response = Faraday::Response.new(:body => fixture_file('search_venues.json', :parse => true))
+      response = Faraday::Response.new(:body => fixture_file('venues/search_venues.json', :parse => true))
       client   = Foursquare2::Client.new
 
       subject = client.return_error_or_body(response, response.body.response)