foursquare2 1.9.5 → 1.9.6

data/VERSION

@@ -1 +1 @@
-1.9.5
+1.9.6

data/foursquare2.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "foursquare2"
-  s.version = "1.9.5"
+  s.version = "1.9.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Mueller", "Marco Moura"]
-  s.date = "2013-03-09"
+  s.date = "2013-04-14"
   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 = [
@@ -37,8 +37,10 @@ Gem::Specification.new do |s|
     "lib/foursquare2/specials.rb",
     "lib/foursquare2/tips.rb",
     "lib/foursquare2/users.rb",
+    "lib/foursquare2/venuegroups.rb",
     "lib/foursquare2/venues.rb",
     "test/config.rb",
+    "test/fixtures/campaigns/campaign.json",
     "test/fixtures/campaigns/campaign_created.json",
     "test/fixtures/campaigns/campaigns_list.json",
     "test/fixtures/checkins/checkin.json",
@@ -76,6 +78,9 @@ Gem::Specification.new do |s|
     "test/fixtures/users/user_tips.json",
     "test/fixtures/users/user_venuestats.json",
     "test/fixtures/users/user_venuestats_friend_id.json",
+    "test/fixtures/venuegroups/venuegroup.json",
+    "test/fixtures/venuegroups/venuegroup_add.json",
+    "test/fixtures/venuegroups/venuegroup_update.json",
     "test/fixtures/venues/explore_venues.json",
     "test/fixtures/venues/managed_venues.json",
     "test/fixtures/venues/no_venues_by_tip.json",
@@ -85,6 +90,7 @@ Gem::Specification.new do |s|
     "test/fixtures/venues/trending_venues.json",
     "test/fixtures/venues/venue.json",
     "test/fixtures/venues/venue_herenow.json",
+    "test/fixtures/venues/venue_hours.json",
     "test/fixtures/venues/venue_links.json",
     "test/fixtures/venues/venue_menus.json",
     "test/fixtures/venues/venue_photos.json",
@@ -101,6 +107,7 @@ Gem::Specification.new do |s|
     "test/test_specials.rb",
     "test/test_tips.rb",
     "test/test_users.rb",
+    "test/test_venuegroups.rb",
     "test/test_venues.rb"
   ]
   s.homepage = "http://github.com/mattmueller/foursquare2"

data/lib/foursquare2.rb

@@ -35,6 +35,7 @@ module Foursquare2
   require 'foursquare2/tips'
   require 'foursquare2/checkins'
   require 'foursquare2/venues'
+  require 'foursquare2/venuegroups'
   require 'foursquare2/pages'
   require 'foursquare2/lists'
   require 'foursquare2/events'

data/lib/foursquare2/campaigns.rb

@@ -1,5 +1,13 @@
 module Foursquare2
   module Campaigns
+
+    # Retrieve information about a campaign
+    #
+    # param [String] campaign_id The ID of the venue
+    def campaign(campaign_id)
+      response = connection.get("campaigns/#{campaign_id}")
+      return_error_or_body(response, response.body.response.campaign)
+    end
     
     # Add a campaign 
     # Details on param options can be found at https://developer.foursquare.com/docs/campaigns/add

data/lib/foursquare2/client.rb

@@ -12,6 +12,7 @@ module Foursquare2
     extend Forwardable
 
     include Venues
+    include Venuegroups
     include Checkins
     include Tips
     include Photos

data/lib/foursquare2/venuegroups.rb

@@ -0,0 +1,61 @@
+module Foursquare2
+  module Venuegroups
+
+    # Retrieve information about a venuegroup
+    #
+    # param [String] group_id The ID of the venuegroup
+
+    def venuegroup(group_id)
+      response = connection.get("venuegroups/#{group_id}")
+      return_error_or_body(response, response.body.response.venueGroup)
+    end
+
+    # Create a venue group. If the venueId parameter is specified, 
+    # then the endpoint will add the specified venues to the venue group. 
+    # If it is not possible to add all of the specified venues to the group, 
+    # then creation of the venue group will fail entirely.
+    # @param [Hash]  options
+    # @option options String :name - Required. The name to give the group.
+    # @option options String :venueId - Comma-delimited list of venue IDs to add to the group. If this parameter is not specified, then the venue group will initially be empty.  
+
+    def add_venuegroup(options={})
+      response = connection.post do |req|
+        req.url "venuegroups/add", options
+      end
+      return_error_or_body(response, response.body.response.venueGroup)
+    end
+
+    # Updates a venue group. At least one of the name and venueId parameters must be specified.
+    # @param [String] group_id - required The ID of the venue group to modify
+    # @param [Hash]  options
+    # @option options String :name - If specified, the new name to give to the group.
+    # @option options String :venueId - If specified, a comma-delimited list of venue IDs that will become the new set of venue IDs for the group.
+
+
+    def venuegroup_update(group_id, options={})
+      response = connection.post do |req|
+        req.url "venuegroups/#{group_id}/update", options
+      end
+      return_error_or_body(response, response.body.response.venueGroup)
+    end
+
+    # List all venue groups owned by the user.
+
+    def list_venuegroup
+      response = connection.get do |req|
+        req.url "venuegroups/list"
+      end
+      return_error_or_body(response, response.body.response.venueGroups)
+    end
+
+    # Delete a venue group.
+    # param [String] group_id - The ID of the venuegroup to delete.
+
+    def delete_venuegroup(group_id)
+      response = connection.post do |req|
+        req.url "venuegroups/#{group_id}/delete"
+      end
+      return_error_or_body(response, response.body.response)
+    end
+  end
+end

data/lib/foursquare2/venues.rb

@@ -246,5 +246,14 @@ module Foursquare2
       end
       return_error_or_body(response, response.body.response)
     end
+
+    # Get venue hours information.
+    #
+    # param [String] venue_id The ID of the venue
+
+    def venue_hours(venue_id)
+      response = connection.get("venues/#{venue_id}/hours")
+      return_error_or_body(response, response.body.response)
+    end
   end
 end

data/test/fixtures/campaigns/campaign.json

@@ -0,0 +1,33 @@
+{
+  "meta": {"code": 200},
+  "response": {
+    "campaign": {
+      "id": "4e0deba2922e6f94b1410b79",
+      "venues": {
+        "count": 1,
+        "items": [
+          {
+            "id": "4e0deab3922e6f94b1410af3"
+          }
+        ]
+      },
+      "startsAt": 1309535356,
+      "startable": false,
+      "deleteable": false,
+      "requiresCodes": false,
+      "uploadInProgress": false,
+      "status": "active",
+      "special": {
+        "id": "4e0debea922e6f94b1410bb7",
+        "name": "Friends Special 7/1/2011",
+        "title": "Friends Special",
+        "text": "Check in with 2 friends and receive a free cowsy dungy clock!"
+      },
+      "timeZoneOffset": -240,
+      "venueGroups": {
+        "count": 0,
+        "items": [ ]
+      }
+    }
+  }
+}

data/test/fixtures/venuegroups/venuegroup.json

@@ -0,0 +1,17 @@
+{
+  "meta": {"code": 200},
+  "response": {
+    "venueGroup": {
+      "id": "4e15cd13b61c42e7c54e5bb6",
+      "name": "Venues",
+      "venues": {
+        "count": 1,
+        "items": [
+          {
+            "id": "4b8c3d87f964a520f7c532e3"
+          }
+        ]
+      }
+    }
+  }
+}

data/test/fixtures/venuegroups/venuegroup_add.json

@@ -0,0 +1,17 @@
+{
+  "meta": {"code": 200},
+  "response": {
+    "venueGroup": {
+      "id": "4e15cd13b61c42e7c54e5bb6",
+      "name": "Venues",
+      "venues": {
+        "count": 1,
+        "items": [
+          {
+            "id": "4b8c3d87f964a520f7c532e3"
+          }
+        ]
+      }
+    }
+  }
+}

data/test/fixtures/venuegroups/venuegroup_update.json

@@ -0,0 +1,20 @@
+{
+  "meta": {"code": 200},
+  "response": {
+    "venuegroup": {
+      "id": "4e15cd13b61c42e7c54e5bb6",
+      "name": "Venues",
+      "venues": {
+        "count": 2,
+        "items": [
+          {
+            "id": "4b8c3d87f964a520f7c532e3"
+          },
+          {
+            "id": "4d572bcc9e508cfab975189b"
+          }
+        ]
+      }
+    }
+  }
+}

data/test/fixtures/venues/venue_hours.json

@@ -0,0 +1 @@
+{"meta":{"code":200},"notifications":[{"type":"notificationTray","item":{"unreadCount":0}}],"response":{"hours":{"timeframes":[{"days":[1,2,3,4,5,6],"includesToday":true,"open":[{"start":"0700","end":"1900"}],"segments":[]},{"days":[7],"open":[{"start":"0800","end":"1800"}],"segments":[]}]},"popular":{"timeframes":[{"days":[3],"includesToday":true,"open":[{"start":"0600","end":"1500"}],"segments":[]},{"days":[4],"open":[{"start":"0600","end":"1600"}],"segments":[]},{"days":[5],"open":[{"start":"0600","end":"1700"}],"segments":[]},{"days":[6],"open":[{"start":"0700","end":"1700"}],"segments":[]},{"days":[7],"open":[{"start":"0800","end":"1600"}],"segments":[]},{"days":[1],"open":[{"start":"0700","end":"1600"}],"segments":[]},{"days":[2],"open":[{"start":"0700","end":"1500"}],"segments":[]}]}}}

data/test/test_campaigns.rb

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

data/test/test_venuegroups.rb

@@ -0,0 +1,29 @@
+require 'helper'
+
+class TestVenuegroups < Test::Unit::TestCase
+
+  context "When using the foursquare API and working with venuegroups" do
+    setup do
+      @client = foursquare_test_client
+    end
+
+    should "get a venuegroup" do
+      stub_get("https://api.foursquare.com/v2/venuegroups/4e15cd13b61c42e7c54e5bb6?oauth_token=#{@client.oauth_token}", "venuegroups/venuegroup.json")
+      venuegroup = @client.venuegroup('4e15cd13b61c42e7c54e5bb6')
+      venuegroup.id == "4e15cd13b61c42e7c54e5bb6"
+    end
+
+    should "add a venuegroup" do
+      stub_post("https://api.foursquare.com/v2/venuegroups/add?oauth_token=#{@client.oauth_token}&name=Venues&venueId=4b8c3d87f964a520f7c532e3", "venuegroups/venuegroup_add.json")
+      venuegroup = @client.add_venuegroup(:name => 'Venues', :venueId => '4b8c3d87f964a520f7c532e3')
+      venuegroup.name == "Venues"
+    end
+
+    should "update a venuegroup" do
+      stub_post("https://api.foursquare.com/v2/venuegroups/4e15cd13b61c42e7c54e5bb6/update?oauth_token=#{@client.oauth_token}?venueId=4b8c3d87f964a520f7c532e3,4d572bcc9e508cfab975189b", "venuegroups/venuegroup_update.json")
+      venuegroup = @client.venuegroup('4e15cd13b61c42e7c54e5bb6')
+      venuegroup.venues.count == 2
+    end
+
+  end
+end

data/test/test_venues.rb

@@ -132,6 +132,12 @@ class TestVenues < Test::Unit::TestCase
       response.stats.totalCheckins.should == 1
     end
 
+    should "get hours from a venue" do
+      stub_get("https://api.foursquare.com/v2/venues/49d68c61f964a520e65c1fe3/hours?oauth_token=#{@client.oauth_token}", "venues/venue_hours.json")
+      response = @client.venue_hours('49d68c61f964a520e65c1fe3')
+      response.hours.timeframes.first.days.should == [1, 2, 3, 4, 5, 6]
+    end
+
     context "and getting detailed stats for a venue not managed by user" do
       should "raise a 'not authorized' API error" do
         stub_get("https://api.foursquare.com/v2/venues/4ad4c04af964a52065f220e3/stats?oauth_token=#{@client.oauth_token}", nil,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foursquare2
 version: !ruby/object:Gem::Version
-  version: 1.9.5
+  version: 1.9.6
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-09 00:00:00.000000000 Z
+date: 2013-04-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -241,8 +241,10 @@ files:
 - lib/foursquare2/specials.rb
 - lib/foursquare2/tips.rb
 - lib/foursquare2/users.rb
+- lib/foursquare2/venuegroups.rb
 - lib/foursquare2/venues.rb
 - test/config.rb
+- test/fixtures/campaigns/campaign.json
 - test/fixtures/campaigns/campaign_created.json
 - test/fixtures/campaigns/campaigns_list.json
 - test/fixtures/checkins/checkin.json
@@ -280,6 +282,9 @@ files:
 - test/fixtures/users/user_tips.json
 - test/fixtures/users/user_venuestats.json
 - test/fixtures/users/user_venuestats_friend_id.json
+- test/fixtures/venuegroups/venuegroup.json
+- test/fixtures/venuegroups/venuegroup_add.json
+- test/fixtures/venuegroups/venuegroup_update.json
 - test/fixtures/venues/explore_venues.json
 - test/fixtures/venues/managed_venues.json
 - test/fixtures/venues/no_venues_by_tip.json
@@ -289,6 +294,7 @@ files:
 - test/fixtures/venues/trending_venues.json
 - test/fixtures/venues/venue.json
 - test/fixtures/venues/venue_herenow.json
+- test/fixtures/venues/venue_hours.json
 - test/fixtures/venues/venue_links.json
 - test/fixtures/venues/venue_menus.json
 - test/fixtures/venues/venue_photos.json
@@ -305,6 +311,7 @@ files:
 - test/test_specials.rb
 - test/test_tips.rb
 - test/test_users.rb
+- test/test_venuegroups.rb
 - test/test_venues.rb
 homepage: http://github.com/mattmueller/foursquare2
 licenses:
@@ -321,7 +328,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1921105295492671255
+      hash: -43746040217970609
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: