foursquare2 1.6.0 → 1.7.0

data/Readme.md

@@ -115,6 +115,9 @@ See [the documentation](http://rubydoc.info/gems/foursquare2/frames) or [foursqu
     client.mark_venue_todo
     client.flag_venue
     client.propose_venue_edit
+	client.managed_venues
+	client.add_special
+	client.add_campaign
 
 ## Todo
 

data/VERSION

@@ -1 +1 @@
-1.6.0
+1.7.0

data/foursquare2.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "foursquare2"
-  s.version = "1.6.0"
+  s.version = "1.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Mueller", "Marco Moura"]
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
     "foursquare2.gemspec",
     "lib/foursquare2.rb",
     "lib/foursquare2/api_error.rb",
+    "lib/foursquare2/campaigns.rb",
     "lib/foursquare2/checkins.rb",
     "lib/foursquare2/client.rb",
     "lib/foursquare2/pages.rb",
@@ -36,10 +37,12 @@ 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/error.json",
     "test/fixtures/explore_venues.json",
     "test/fixtures/friend_checkins.json",
+    "test/fixtures/managed_venues.json",
     "test/fixtures/no_venues_by_tip.json",
     "test/fixtures/page.json",
     "test/fixtures/page_venues.json",
@@ -51,6 +54,7 @@ Gem::Specification.new do |s|
     "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",
@@ -63,6 +67,7 @@ Gem::Specification.new do |s|
     "test/fixtures/venue_photos.json",
     "test/fixtures/venue_tips.json",
     "test/helper.rb",
+    "test/test_campaigns.rb",
     "test/test_checkins.rb",
     "test/test_client.rb",
     "test/test_pages.rb",

data/lib/foursquare2.rb

@@ -18,6 +18,7 @@ module Foursquare2
 
   end
 
+  require 'foursquare2/campaigns'
   require 'foursquare2/users'
   require 'foursquare2/specials'
   require 'foursquare2/settings'
@@ -28,6 +29,7 @@ module Foursquare2
   require 'foursquare2/pages'
   require 'foursquare2/client'
   require 'foursquare2/api_error'
+  
 
 end
 

data/lib/foursquare2/campaigns.rb

@@ -0,0 +1,24 @@
+module Foursquare2
+  module Campaigns
+    
+    # Add a campaign 
+    # Details on param options can be found at https://developer.foursquare.com/docs/campaigns/add
+    #
+    # @param [Hash]  options
+    # @option options String :specialId - required (unless the campaignId parameter has been provided). special ID
+    # @option options String :groupId - comma-separated list of venue group IDs (either groupId or venueId is required)
+    # @option options String :venueId - comma-separated list of venue IDs (either groupId or venueId is required)
+    # @option options Integer :endAt - DateTime when the campaign is to be automatically deactivated (seconds since epoch)
+    # @option options Integer :startAt - DateTime when the campaign is to be started (seconds since epoch)
+    # @option options String :campaignId - ID of an existing campaign to copy. 
+    #
+
+    def add_campaign(options={})
+      response = connection.post do |req|
+        req.url "campaigns/add", options
+      end
+        return_error_or_body(response, response.body.response.campaign)
+    end
+    
+  end
+end

data/lib/foursquare2/client.rb

@@ -19,6 +19,7 @@ module Foursquare2
     include Specials
     include Users
     include Pages
+    include Campaigns
 
     attr_reader :client_id, :client_secret, :oauth_token, :api_version
 

data/lib/foursquare2/specials.rb

@@ -26,6 +26,29 @@ module Foursquare2
       return_error_or_body(response, response.body.response.specials.items)
     end
     
+    # Add a special for venue managers
+    # Details on param options can be found at https://developer.foursquare.com/docs/specials/add
+    #
+    # @param [Hash]  options
+    # @option options String :name - A name for the special.
+    # @option options String :text - Required
+    # @option options String :unlockedText - Required. Special text that is shown when the user has unlocked the special.
+    # @option options String :finePrint 
+    # @option options Integer :count1 
+    # @option options Integer :count2 
+    # @option options Integer :count3 
+    # @option options String :type - Required.
+    # @option options String :offerId
+    # @option options Float :cost
+    #
+
+    def add_special(options={})
+      response = connection.post do |req|
+        req.url "specials/add", options
+      end
+        return_error_or_body(response, response.body.response.special)
+    end
+    
   end
 end
 

data/lib/foursquare2/venues.rb

@@ -175,5 +175,16 @@ module Foursquare2
       response = connection.get("venues/#{venue_id}/menu")
       return_error_or_body(response, response.body.response)
     end
+    
+    #
+    #Returns a list of venues managed
+    #
+    
+    def managed_venues()
+      response = connection.get do |req|
+        req.url "venues/managed"
+      end
+      return_error_or_body(response, response.body.response.venues)
+    end
   end 
 end

data/test/fixtures/campaign_created.json

@@ -0,0 +1,34 @@
+{
+  "meta":{"code":200},  "response":{
+  "campaign":{
+    "id":"123",
+    "special":{
+          "id":"4bd876f886ba62b58a6e88b3",
+		  "text":"Test Special",
+		  "name":"Special"
+		},
+	"startsAt":"1284286794",
+	"endsAt":"1284286794",
+	"venues":[
+		{
+		   "count":1,
+			"items":[
+				{
+					"id": "4c94a45c82b56dcb47cad0aa"
+				}
+			 ]
+			}
+			],
+	"venueGroups":[
+		{
+			"count":1,
+			"items":[
+				{
+					"id": "4d94a45c82b56dcb47cad0aa"
+				}
+			]
+		}
+	]
+	}
+	}
+	}

data/test/fixtures/managed_venues.json

@@ -0,0 +1 @@
+{"meta":{"code":200},"notifications":[{"type":"notificationTray","item":{"unreadCount":0}}],"response":{"venues":[{"id":"4f2de7567beb9d72b6d80050","name":"Black Founders Startup Ventures","contact":{"twitter":"blackfounders"},"location":{"address":"625 2nd St","crossStreet":"Brannan","lat":37.78145065623611,"lng":-122.39134311676025,"postalCode":"94107","city":"San Francisco","state":"CA","country":"United States"},"categories":[{"id":"4bf58dd8d48988d130941735","name":"Building","pluralName":"Buildings","shortName":"Other - Buildings","icon":{"prefix":"https:\/\/foursquare.com\/img\/categories\/building\/default_","sizes":[32,44,64,88,256],"name":".png"},"primary":true}],"verified":true,"stats":{"checkinsCount":0,"usersCount":0,"tipCount":0}}]}}

data/test/fixtures/special_created.json

@@ -0,0 +1,13 @@
+{
+    "meta": {
+        "code": 200
+    },
+    "response": {
+        "special": {
+            "id": "4bd876f886ba62b58a6e88b3",
+            "type": "mayor",
+            "message": "Test",
+            "description": "Congrats"
+        }
+    }
+}

data/test/test_campaigns.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class TestCampaigns < Test::Unit::TestCase
+
+  context "When using the foursquare API and working with campaigns" do
+    setup do
+      @client = foursquare_test_client
+    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")
+      campaign = @client.add_campaign(:specialId => '4bd876f886ba62b58a6e88b3')
+      campaign.special.id == "4bd876f886ba62b58a6e88b3"
+    end
+    
+  end
+end

data/test/test_specials.rb

@@ -19,5 +19,12 @@ class TestSpecials < Test::Unit::TestCase
       specials.count.should == 1
       specials.first.message.should == "Buy 1 Get 1 40% Off All Video Games (priced up to $19.99)\r\n\r\nItems must be of equal or lesser value to the lowest priced item purchased\r\n\r\nEnds 2/12/2011"
     end
+    
+    should "add a special for a venue with given params" do
+      stub_post("https://api.foursquare.com/v2/specials/add?text=Test&unlockedText=Congrats&oauth_token=#{@client.oauth_token}", "special_created.json")
+      special = @client.add_special(:text => 'Test', :unlockedText => 'Congrats')
+      special.message.should == "Test"
+    end
+    
   end
 end

data/test/test_venues.rb

@@ -88,6 +88,13 @@ class TestVenues < Test::Unit::TestCase
       venues = @client.suggest_completion_venues(:ll => "40.7,-74", :query => "coffee")
       venues.minivenues.first.id.should == '44dc96e4f964a520b0361fe3'
     end
+    
+    should "fetch venue for manager" do
+      stub_get("https://api.foursquare.com/v2/venues/managed?oauth_token=#{@client.oauth_token}", "managed_venues.json")
+      venues = @client.managed_venues()
+      venues.first.name.should == 'Black Founders Startup Ventures'
+      venues.first.location.address.should == '625 2nd St'
+    end
 
     should "get menus for a venue" do
       stub_get("https://api.foursquare.com/v2/venues/4b2a544ff964a5204ca724e3/menu?oauth_token=#{@client.oauth_token}", "venue_menus.json")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foursquare2
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
   prerelease: 
 platform: ruby
 authors:
@@ -14,7 +14,7 @@ date: 2012-07-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70327044534400 !ruby/object:Gem::Requirement
+  requirement: &70120923893680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70327044534400
+  version_requirements: *70120923893680
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70327044524520 !ruby/object:Gem::Requirement
+  requirement: &70120923880880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70327044524520
+  version_requirements: *70120923880880
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70327044517420 !ruby/object:Gem::Requirement
+  requirement: &70120923869540 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70327044517420
+  version_requirements: *70120923869540
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70327044512180 !ruby/object:Gem::Requirement
+  requirement: &70120923858740 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70327044512180
+  version_requirements: *70120923858740
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70327044506440 !ruby/object:Gem::Requirement
+  requirement: &70120923854980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70327044506440
+  version_requirements: *70120923854980
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70327044499940 !ruby/object:Gem::Requirement
+  requirement: &70120923848180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70327044499940
+  version_requirements: *70120923848180
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70327044497000 !ruby/object:Gem::Requirement
+  requirement: &70120923844180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: '1.5'
   type: :development
   prerelease: false
-  version_requirements: *70327044497000
+  version_requirements: *70120923844180
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70327044494380 !ruby/object:Gem::Requirement
+  requirement: &70120923841120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70327044494380
+  version_requirements: *70120923841120
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70327044490300 !ruby/object:Gem::Requirement
+  requirement: &70120923838680 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -110,10 +110,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70327044490300
+  version_requirements: *70120923838680
 - !ruby/object:Gem::Dependency
   name: jnunemaker-matchy
-  requirement: &70327044485980 !ruby/object:Gem::Requirement
+  requirement: &70120923836120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,10 +121,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70327044485980
+  version_requirements: *70120923836120
 - !ruby/object:Gem::Dependency
   name: json_pure
-  requirement: &70327044470460 !ruby/object:Gem::Requirement
+  requirement: &70120923833420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -132,10 +132,10 @@ dependencies:
         version: '1.4'
   type: :development
   prerelease: false
-  version_requirements: *70327044470460
+  version_requirements: *70120923833420
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70327044468140 !ruby/object:Gem::Requirement
+  requirement: &70120923831160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - <
@@ -146,7 +146,7 @@ dependencies:
         version: 0.0.5
   type: :development
   prerelease: false
-  version_requirements: *70327044468140
+  version_requirements: *70120923831160
 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.
 email:
@@ -167,6 +167,7 @@ files:
 - foursquare2.gemspec
 - lib/foursquare2.rb
 - lib/foursquare2/api_error.rb
+- lib/foursquare2/campaigns.rb
 - lib/foursquare2/checkins.rb
 - lib/foursquare2/client.rb
 - lib/foursquare2/pages.rb
@@ -177,10 +178,12 @@ files:
 - lib/foursquare2/users.rb
 - lib/foursquare2/venues.rb
 - test/config.rb
+- test/fixtures/campaign_created.json
 - test/fixtures/checkin.json
 - test/fixtures/error.json
 - test/fixtures/explore_venues.json
 - test/fixtures/friend_checkins.json
+- test/fixtures/managed_venues.json
 - test/fixtures/no_venues_by_tip.json
 - test/fixtures/page.json
 - test/fixtures/page_venues.json
@@ -192,6 +195,7 @@ files:
 - 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
@@ -204,6 +208,7 @@ files:
 - test/fixtures/venue_photos.json
 - test/fixtures/venue_tips.json
 - test/helper.rb
+- test/test_campaigns.rb
 - test/test_checkins.rb
 - test/test_client.rb
 - test/test_pages.rb
@@ -227,7 +232,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1902868301601312681
+      hash: -1741211467567860950
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: