foursquare2 1.8.0 → 1.8.1

data/Readme.md

@@ -30,7 +30,7 @@ See [the documentation](http://rubydoc.info/gems/foursquare2/frames) for a list
 
 #### Get information about a user (use 'self' for the authenticated user)
 
-    client.user(108914) 
+    client.user(108914)
 
 #### Get information about a venue
 
@@ -45,7 +45,7 @@ See [the documentation](http://rubydoc.info/gems/foursquare2/frames) for a list
     client.add_checkin(:venueId => "4b2afcaaf964a5205bb324e3", :broadcast => 'public', :ll => '36.142064,-86.816086', :shout => 'zomg coffee!1!')
 
 
-#### Search user by tip 
+#### Search user by tip
 
      client.search_users_by_tip(:ll => '36.142064,-86.816086', :name => 'Marco')
 
@@ -53,7 +53,7 @@ See [the documentation](http://rubydoc.info/gems/foursquare2/frames) for a list
 
      client.user_tips("123456", :query => 'coffee')
 
-#### Search venues by tip 
+#### Search venues by tip
 
      client.search_venues_by_tip(:ll => '36.142064,-86.816086', :query => 'coffee')
 
@@ -116,6 +116,7 @@ See [the documentation](http://rubydoc.info/gems/foursquare2/frames) or [foursqu
     client.flag_venue
     client.propose_venue_edit
 	client.managed_venues
+    client.managed_venue_stats
 	client.add_special
 	client.add_campaign
 

data/VERSION

@@ -1 +1 @@
-1.8.0
+1.8.1

data/foursquare2.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "foursquare2"
-  s.version = "1.8.0"
+  s.version = "1.8.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Mueller", "Marco Moura"]
-  s.date = "2012-07-22"
+  s.date = "2012-08-19"
   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 = [
@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
     "test/fixtures/campaign_created.json",
     "test/fixtures/checkin.json",
     "test/fixtures/error.json",
+    "test/fixtures/error_template.json",
     "test/fixtures/explore_venues.json",
     "test/fixtures/friend_checkins.json",
     "test/fixtures/list.json",
@@ -73,6 +74,7 @@ Gem::Specification.new do |s|
     "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/helper.rb",
     "test/test_campaigns.rb",

data/lib/foursquare2/venues.rb

@@ -54,7 +54,7 @@ module Foursquare2
       response = connection.get("venues/categories")
       return_error_or_body(response, response.body.response.categories)
     end
-    
+
     # Retrieve links for a venue.
     #
     # param [String] venue_id The ID of the venue
@@ -150,7 +150,7 @@ module Foursquare2
       return_error_or_body(response, response.body.response)
     end
 
-    # Suggest venue completions. Returns a list of mini-venues partially matching the search term, near the location. 
+    # Suggest venue completions. Returns a list of mini-venues partially matching the search term, near the location.
     #
     # @param [Hash]  options
     # @option options String :ll - Latitude and longitude in format LAT,LON
@@ -166,7 +166,7 @@ module Foursquare2
       end
       return_error_or_body(response, response.body.response)
     end
-  
+
     # Retrieve menus for a venue.
     #
     # param [String] venue_id The ID of the venue
@@ -175,16 +175,31 @@ 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 
+
+    # Get venue stats over a given time range. Client instance should represent an OAuth user who is the venue owner.
+    # Note: returns more detailed statistics than the basic stats returned when calling venue(venue_id)
+    #
+    # param [String] venue_id The ID of the venue managed by the current user
+    # @param [Hash] options
+    # @option options Integer :startAt - The start of the time range to retrieve stats for (seconds since epoch). If omitted, all-time stats will be returned.
+    # @option options Integer :endAt - The end of the time range to retrieve stats for (seconds since epoch). If omitted, the current time is assumed.
+
+    def managed_venue_stats(venue_id, options={})
+      response = connection.get do |req|
+        req.url "venues/#{venue_id}/stats", options
+      end
+      return_error_or_body(response, response.body.response)
+    end
+  end
 end

data/test/fixtures/error_template.json

@@ -0,0 +1 @@
+{ "meta": { "code": %error_code%, "errorType": "%error_type%", "errorDetail": "%error_message%" } }

data/test/fixtures/venue_stats.json

@@ -0,0 +1,148 @@
+{
+  "meta": {
+    "code": 200
+  },
+  "response": {
+    "stats": {
+      "totalCheckins": 1,
+      "newCheckins": 1,
+      "uniqueVisitors": 1,
+      "sharing": {
+        "twitter": 0,
+        "facebook": 0
+      },
+      "genderBreakdown": {
+        "female": 0,
+        "male": 1
+      },
+      "ageBreakdown": [{
+        "age": "13-17",
+        "checkins": 0
+      }, {
+        "age": "18-24",
+        "checkins": 0
+      }, {
+        "age": "25-34",
+        "checkins": 1
+      }, {
+        "age": "35-44",
+        "checkins": 0
+      }, {
+        "age": "45-54",
+        "checkins": 0
+      }, {
+        "age": "55+",
+        "checkins": 0
+      }],
+      "hourBreakdown": [{
+        "hour": 0,
+        "checkins": 1
+      }, {
+        "hour": 1,
+        "checkins": 0
+      }, {
+        "hour": 2,
+        "checkins": 0
+      }, {
+        "hour": 3,
+        "checkins": 0
+      }, {
+        "hour": 4,
+        "checkins": 0
+      }, {
+        "hour": 5,
+        "checkins": 0
+      }, {
+        "hour": 6,
+        "checkins": 0
+      }, {
+        "hour": 7,
+        "checkins": 0
+      }, {
+        "hour": 8,
+        "checkins": 0
+      }, {
+        "hour": 9,
+        "checkins": 0
+      }, {
+        "hour": 10,
+        "checkins": 0
+      }, {
+        "hour": 11,
+        "checkins": 0
+      }, {
+        "hour": 12,
+        "checkins": 0
+      }, {
+        "hour": 13,
+        "checkins": 0
+      }, {
+        "hour": 14,
+        "checkins": 0
+      }, {
+        "hour": 15,
+        "checkins": 0
+      }, {
+        "hour": 16,
+        "checkins": 0
+      }, {
+        "hour": 17,
+        "checkins": 0
+      }, {
+        "hour": 18,
+        "checkins": 0
+      }, {
+        "hour": 19,
+        "checkins": 0
+      }, {
+        "hour": 20,
+        "checkins": 0
+      }, {
+        "hour": 21,
+        "checkins": 0
+      }, {
+        "hour": 22,
+        "checkins": 0
+      }, {
+        "hour": 23,
+        "checkins": 0
+      }],
+      "visitCountHistogram": [{
+        "checkins": 1,
+        "users": 1
+      }],
+      "topVisitors": [{
+        "user": {
+          "id": "4372259",
+          "firstName": "Murugan",
+          "lastName": "V.",
+          "photo": "https://is1.4sqi.net/userpix_thumbs/2QVZXGQQA2LILWY3.jpg",
+          "tips": {
+            "count": 2
+          },
+          "gender": "male",
+          "homeCity": "Chennai, India",
+          "bio": "",
+          "contact": {}
+        },
+        "checkins": 1
+      }],
+      "recentVisitors": [{
+        "user": {
+          "id": "4372259",
+          "firstName": "Murugan",
+          "lastName": "V.",
+          "photo": "https://is1.4sqi.net/userpix_thumbs/2QVZXGQQA2LILWY3.jpg",
+          "tips": {
+            "count": 2
+          },
+          "gender": "male",
+          "homeCity": "Chennai, India",
+          "bio": "",
+          "contact": {}
+        },
+        "lastCheckin": 1338182425
+      }]
+    }
+  }
+}

data/test/helper.rb

@@ -46,7 +46,7 @@ end
 
 def stub_get(url, filename, options={})
   opts = {
-    :body => fixture_file(filename),
+    :body => error_or_standard_body(filename, options),
     :content_type => 'application/json; charset=utf-8'
   }.merge(options)
   FakeWeb.register_uri(:get, foursquare_url(url), opts)
@@ -54,11 +54,20 @@ end
 
 def stub_post(url, filename, options={})
   opts = {
-    :body => fixture_file(filename),
+    :body => error_or_standard_body(filename, options),
     :content_type => 'application/json; charset=utf-8'
   }.merge(options)
   FakeWeb.register_uri(:post, foursquare_url(url), opts)
 end
 
+def error_or_standard_body(filename, options)
+  error_options = options.delete(:error)
+  body = fixture_file(error_options ? 'error_template.json' : filename)
+  body = body.gsub(/%error_code%/, error_options[:code])
+             .gsub(/%error_type%/, error_options[:type])
+             .gsub(/%error_message%/, error_options[:message]) if error_options
+  body
+end
+
 class Test::Unit::TestCase
 end

data/test/test_venues.rb

@@ -41,7 +41,7 @@ class TestVenues < Test::Unit::TestCase
 
     should "get tips from a venue only with some term" do
       stub_get("https://api.foursquare.com/v2/venues/4c94a45c82b56dcb47cad0aa/tips?oauth_token=#{@client.oauth_token}", "venue_tips.json")
-      tips = @client.venue_tips('4c94a45c82b56dcb47cad0aa', {:query => "legal"}) 
+      tips = @client.venue_tips('4c94a45c82b56dcb47cad0aa', {:query => "legal"})
       tips[:count].should == 1
       tips.items.first.id.should == "4c94a45c82b56dcb47cad0aa"
     end
@@ -60,7 +60,7 @@ class TestVenues < Test::Unit::TestCase
 
       tips[:items].size.should == 0
     end
-    
+
     should "allow venues to be explored" do
       stub_get("https://api.foursquare.com/v2/venues/explore?section=food&ll=40.7%2C-74&oauth_token=#{@client.oauth_token}&limit=2", "explore_venues.json")
       venues = @client.explore_venues(:ll => '40.7,-74', :section => 'food', :limit => '2')
@@ -74,7 +74,7 @@ class TestVenues < Test::Unit::TestCase
       links.items.size == links.count
       links.items.size.should == 2
     end
-    
+
     should "get photos for a venue" do
       stub_get("https://api.foursquare.com/v2/venues/4b8c3d87f964a520f7c532e3/photos?group=venue&oauth_token=#{@client.oauth_token}&limit=3", "venue_photos.json")
       photos = @client.venue_photos('4b8c3d87f964a520f7c532e3', { :group => 'venue', :limit => 3 })
@@ -88,7 +88,7 @@ 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()
@@ -104,6 +104,28 @@ class TestVenues < Test::Unit::TestCase
       response.menu.menus.items.first['entries']['items'].first['entries'].items.count.should == 11
     end
 
+    should "get detailed stats for a venue managed by user" do
+      stub_get("https://api.foursquare.com/v2/venues/4b8c3d87f964a520f7c532e3/stats?oauth_token=#{@client.oauth_token}", "venue_stats.json")
+      response = @client.managed_venue_stats('4b8c3d87f964a520f7c532e3')
+      response.stats.totalCheckins.should == 1
+    end
+
+    should "get a subset of detailed stats for a venue managed by user when passing in options" do
+      stub_get("https://api.foursquare.com/v2/venues/4b8c3d87f964a520f7c532e3/stats?oauth_token=#{@client.oauth_token}&startAt=1343085269&endAt=1343171627", "venue_stats.json")
+      response = @client.managed_venue_stats('4b8c3d87f964a520f7c532e3', { :startAt => 1343085269, :endAt => 1343171627})
+      response.stats.totalCheckins.should == 1
+    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,
+          :error => { :code => '403', :type => 'not_authorized', :message => 'User is not authorized to view venue stats' })
+        assert_raises(Foursquare2::APIError) do
+          @client.managed_venue_stats('4ad4c04af964a52065f220e3')
+        end
+      end
+    end
+
   end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foursquare2
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.8.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-22 00:00:00.000000000Z
+date: 2012-08-19 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70215631196980 !ruby/object:Gem::Requirement
+  requirement: &70129938827720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70215631196980
+  version_requirements: *70129938827720
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70215631193980 !ruby/object:Gem::Requirement
+  requirement: &70129938826180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70215631193980
+  version_requirements: *70129938826180
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70215631187100 !ruby/object:Gem::Requirement
+  requirement: &70129938824040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70215631187100
+  version_requirements: *70129938824040
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70215631181060 !ruby/object:Gem::Requirement
+  requirement: &70129938809900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70215631181060
+  version_requirements: *70129938809900
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70215631173680 !ruby/object:Gem::Requirement
+  requirement: &70129938807520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70215631173680
+  version_requirements: *70129938807520
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70215631252540 !ruby/object:Gem::Requirement
+  requirement: &70129938805700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70215631252540
+  version_requirements: *70129938805700
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70215639898860 !ruby/object:Gem::Requirement
+  requirement: &70129938803120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: '1.5'
   type: :development
   prerelease: false
-  version_requirements: *70215639898860
+  version_requirements: *70129938803120
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70215640489100 !ruby/object:Gem::Requirement
+  requirement: &70129938801720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70215640489100
+  version_requirements: *70129938801720
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70215640804220 !ruby/object:Gem::Requirement
+  requirement: &70129938799960 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -110,10 +110,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70215640804220
+  version_requirements: *70129938799960
 - !ruby/object:Gem::Dependency
   name: jnunemaker-matchy
-  requirement: &70215641074800 !ruby/object:Gem::Requirement
+  requirement: &70129938798420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,10 +121,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70215641074800
+  version_requirements: *70129938798420
 - !ruby/object:Gem::Dependency
   name: json_pure
-  requirement: &70215641073740 !ruby/object:Gem::Requirement
+  requirement: &70129938796880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -132,10 +132,10 @@ dependencies:
         version: '1.4'
   type: :development
   prerelease: false
-  version_requirements: *70215641073740
+  version_requirements: *70129938796880
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70215641072600 !ruby/object:Gem::Requirement
+  requirement: &70129938795140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - <
@@ -146,7 +146,7 @@ dependencies:
         version: 0.0.5
   type: :development
   prerelease: false
-  version_requirements: *70215641072600
+  version_requirements: *70129938795140
 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:
@@ -182,6 +182,7 @@ files:
 - test/fixtures/campaign_created.json
 - test/fixtures/checkin.json
 - test/fixtures/error.json
+- test/fixtures/error_template.json
 - test/fixtures/explore_venues.json
 - test/fixtures/friend_checkins.json
 - test/fixtures/list.json
@@ -214,6 +215,7 @@ files:
 - 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/helper.rb
 - test/test_campaigns.rb
@@ -241,7 +243,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1840967499921104058
+      hash: 1196371132867193506
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: