foursquare2 1.9.3 → 1.9.4

data/VERSION

@@ -1 +1 @@
-1.9.3
+1.9.4

data/foursquare2.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "foursquare2"
-  s.version = "1.9.3"
+  s.version = "1.9.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Mueller", "Marco Moura"]
-  s.date = "2013-02-02"
+  s.date = "2013-03-03"
   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 = [
@@ -40,6 +40,7 @@ Gem::Specification.new do |s|
     "lib/foursquare2/venues.rb",
     "test/config.rb",
     "test/fixtures/campaigns/campaign_created.json",
+    "test/fixtures/campaigns/campaigns_list.json",
     "test/fixtures/checkins/checkin.json",
     "test/fixtures/checkins/checkin_reply.json",
     "test/fixtures/checkins/friend_checkins.json",

data/lib/foursquare2/campaigns.rb

@@ -19,6 +19,37 @@ module Foursquare2
       end
         return_error_or_body(response, response.body.response.campaign)
     end
+
+    # Get a list of campaigns
+    # Details on param options can be found at https://developer.foursquare.com/docs/campaigns/list
+    #
+    # @param [Hash]  options
+    # @option options String :specialId - if specified, limits response to campaigns involving the given special
+    # @option options String :groupId - if specified, limits response to campaigns involving the given group
+    # @option options String :status - which campaigns to return: pending,scheduled,active,expired,depleted,stopped,notStarted,ended,all (default=all)
+    #
+    #
+
+    def list_campaigns(options={})
+      response = connection.get do |req|
+        req.url "campaigns/list", options
+      end
+        return_error_or_body(response, response.body.response.campaigns.items)
+    end
+
+    # End a campaign
+    # Details on param can be found at https://developer.foursquare.com/docs/campaigns/end
+    #
+    # @campaign_id String :campaignId - The ID of the campaign to end. Must be specified. Pass in as a string and not as a hash.
+    #
+    #
+
+    def end_campaign(campaign_id)
+      response = connection.post do |req|
+        req.url "campaigns/#{campaign_id}/end"
+      end
+        return_error_or_body(response, response.body.code)
+    end
     
   end
 end

data/test/fixtures/campaigns/campaigns_list.json

@@ -0,0 +1,37 @@
+{
+  "meta": {
+    "code": 200
+  },
+  "notifications": [
+    {
+      "type": "notificationTray",
+      "item": {
+        "unreadCount": 0
+      }
+    }
+  ],
+  "response": {
+    "campaigns": {
+      "count": 1,
+      "items": [
+        {
+          "id": "4e0deba2922e6f94b1410b79",
+          "venues": {
+            "count": 1,
+            "items": [
+              {
+                "id": "4e0deab3922e6f94b1410af3"
+              }
+            ]
+          },
+          "startsAt": 1309535356,
+          "specialId": "4e0debea922e6f94b1410bb7",
+          "venueGroupIds": {
+            "count": 0,
+            "items": [ ]
+          }
+        }
+      ]
+    }
+  }
+}

data/test/test_campaigns.rb

@@ -1,5 +1,7 @@
 require 'helper'
 
+require 'helper'
+
 class TestCampaigns < Test::Unit::TestCase
 
   context "When using the foursquare API and working with campaigns" do
@@ -12,6 +14,18 @@ class TestCampaigns < Test::Unit::TestCase
       campaign = @client.add_campaign(:specialId => '4bd876f886ba62b58a6e88b3')
       campaign.special.id == "4bd876f886ba62b58a6e88b3"
     end
-    
+
+    should "list all campaigns" do
+      stub_get("https://api.foursquare.com/v2/campaigns/list?oauth_token=#{@client.oauth_token}&status=active", "campaigns/campaigns_list.json")
+      campaigns = @client.list_campaigns(:status => 'active')
+      campaigns.first.id.should == "4e0deba2922e6f94b1410b79"
+    end
+
+    should "list campaigns of specialId" do
+      stub_get("https://api.foursquare.com/v2/campaigns/list?oauth_token=#{@client.oauth_token}&specialId=4e0debea922e6f94b1410bb7", "campaigns/campaigns_list.json")
+      campaigns = @client.list_campaigns(:specialId => '4e0debea922e6f94b1410bb7')
+      campaigns.first['specialId'].should == "4e0debea922e6f94b1410bb7"
+    end
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foursquare2
 version: !ruby/object:Gem::Version
-  version: 1.9.3
+  version: 1.9.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-02 00:00:00.000000000 Z
+date: 2013-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -244,6 +244,7 @@ files:
 - lib/foursquare2/venues.rb
 - test/config.rb
 - test/fixtures/campaigns/campaign_created.json
+- test/fixtures/campaigns/campaigns_list.json
 - test/fixtures/checkins/checkin.json
 - test/fixtures/checkins/checkin_reply.json
 - test/fixtures/checkins/friend_checkins.json
@@ -319,7 +320,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -789124476079947728
+      hash: 4157346706874056407
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: