foursquare2 1.8.2 → 1.9.0

data/Readme.md

@@ -119,6 +119,7 @@ See [the documentation](http://rubydoc.info/gems/foursquare2/frames) or [foursqu
     client.propose_venue_edit
 	client.managed_venues
     client.managed_venue_stats
+    client.venues_timeseries
 	client.add_special
 	client.add_campaign
 

data/VERSION

@@ -1 +1 @@
-1.8.2
+1.9.0

data/foursquare2.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "foursquare2"
-  s.version = "1.8.2"
+  s.version = "1.9.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Matt Mueller", "Marco Moura"]
-  s.date = "2012-09-01"
+  s.date = "2012-11-10"
   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 = [
@@ -63,6 +63,7 @@ Gem::Specification.new do |s|
     "test/fixtures/specials/special_created.json",
     "test/fixtures/tips/search_tips.json",
     "test/fixtures/tips/tip.json",
+    "test/fixtures/users/leaderboard.json",
     "test/fixtures/users/search_users.json",
     "test/fixtures/users/user.json",
     "test/fixtures/users/user_lists.json",
@@ -96,7 +97,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/mattmueller/foursquare2"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
+  s.rubygems_version = "1.8.23"
   s.summary = "Foursquare API v2 gem in the spirit of the original foursquare gem"
 
   if s.respond_to? :specification_version then

data/lib/foursquare2.rb

@@ -6,6 +6,10 @@ directory = File.expand_path(File.dirname(__FILE__))
 module Foursquare2
   class << self
 
+    FIELDS = [ :client_id, :client_secret, :api_version,
+               :ssl, :connection_middleware, :locale ]
+    attr_accessor(*FIELDS)
+
     def filter tips, term
       tip = []
       unless tips.nil?
@@ -16,6 +20,11 @@ module Foursquare2
       Hashie::Mash.new({:count => tip.count, :items => tip })
     end
 
+    def configure
+      yield self
+      true
+    end
+
   end
 
   require 'foursquare2/campaigns'

data/lib/foursquare2/client.rb

@@ -23,7 +23,7 @@ module Foursquare2
     include Lists
     include Events
 
-    attr_reader :client_id, :client_secret, :oauth_token, :api_version
+    attr_reader :client_id, :client_secret, :oauth_token, :api_version, :locale
 
     #Initialize the client class that will be used for all foursquare API requests.  Note that either a valid user oauth token OR a valid client_id + secret is required.
     #
@@ -38,12 +38,13 @@ module Foursquare2
     # @option options Hash   :ssl Additional SSL options (like the path to certificate file)
 
     def initialize(options={})
-      @client_id = options[:client_id]
-      @client_secret = options[:client_secret]
+      @client_id = options[:client_id] || Foursquare2.client_id
+      @client_secret = options[:client_secret] || Foursquare2.client_secret
       @oauth_token = options[:oauth_token]
-      @api_version = options[:api_version]
-      @ssl = options[:ssl].nil? ? Hash.new : options[:ssl]
-      @connection_middleware = options.fetch(:connection_middleware, [])
+      @api_version = options[:api_version] || Foursquare2.api_version
+      @locale = options[:locale] || Foursquare2.locale
+      @ssl = options[:ssl] || Foursquare2.ssl || Hash.new
+      @connection_middleware = options[:connection_middleware] || Foursquare2.connection_middleware || []
       @connection_middleware += DEFAULT_CONNECTION_MIDDLEWARE
     end
 
@@ -59,6 +60,7 @@ module Foursquare2
       params[:client_secret] = @client_secret if @client_secret
       params[:oauth_token] = @oauth_token if @oauth_token
       params[:v] = @api_version if @api_version
+      params[:locale] = @locale if @locale
       @connection ||= Faraday::Connection.new(:url => api_url, :ssl => @ssl, :params => params, :headers => default_headers) do |builder|
         @connection_middleware.each do |middleware|
           builder.use *middleware

data/lib/foursquare2/users.rb

@@ -1,6 +1,18 @@
 module Foursquare2
   module Users
 
+    # Get user's leaderboard details
+    #
+    # @param [Hash] options
+    # @option options Integer :neighbors Number of friends' scores adjacent to your score
+    
+    def leaderboard(options={})
+      response = connection.get do |req|
+        req.url "users/leaderboard", options
+      end
+      return_error_or_body(response, response.body.response)
+    end
+
     # Get information about a user
     #
     # @param [Integer] user_id - User to get information for.

data/lib/foursquare2/venues.rb

@@ -199,5 +199,22 @@ module Foursquare2
       end
       return_error_or_body(response, response.body.response)
     end
+
+    # Get daily venue stats for a list of venues over a time range.
+    # Client instance should represent an OAuth user who is the venues owner.
+    #
+    # @param [Hash] options
+    # @option options Array[String] :venueId - A list of venue ids to retrieve series data for.
+    # @option options Integer :startAt - Required. The start of the time range to retrieve stats for (seconds since epoch).
+    # @option options Integer :endAt - The end of the time range to retrieve stats for (seconds since epoch). If omitted, the current time is assumed.
+    # @option options String :fields - Specifies which fields to return. May be one or more of totalCheckins, newCheckins, uniqueVisitors, sharing, genders, ages, hours, separated by commas.
+
+    def venues_timeseries(options={})
+      options[:venueId] = options[:venueId].join(',') # Transforms the array into a 'comma-separated list' of ids.
+      response = connection.get do |req|
+        req.url "venues/timeseries", options
+      end
+      return_error_or_body(response, response.body.response)
+    end
   end
 end

data/test/fixtures/users/leaderboard.json

@@ -0,0 +1,74 @@
+{
+    "meta": {
+        "code": 200
+    },
+    "notifications": [
+        {
+            "type": "notificationTray",
+            "item": {
+                "unreadCount": 1
+            }
+        }
+    ],
+    "response": {
+        "leaderboard": {
+            "count": 3,
+            "items": [
+                {
+                    "user": {
+                        "id": "14839073",
+                        "firstName": "Neeraj",
+                        "lastName": "P N",
+                        "relationship": "friend",
+                        "photo": {
+                            "prefix": "https://irs0.4sqi.net/img/user/",
+                            "suffix": "/C1WP30SUDZUCZC2X.jpg"
+                        }
+                    },
+                    "scores": {
+                        "recent": 18,
+                        "max": 115,
+                        "checkinsCount": 5
+                    },
+                    "rank": 26
+                },
+                {
+                    "user": {
+                        "id": "25052241",
+                        "firstName": "Rony",
+                        "lastName": "Varghese",
+                        "relationship": "self",
+                        "photo": {
+                            "prefix": "https://irs1.4sqi.net/img/user/",
+                            "suffix": "/HE1OX3T3S3HN5OI4.jpg"
+                        }
+                    },
+                    "scores": {
+                        "recent": 16,
+                        "max": 123,
+                        "checkinsCount": 4
+                    },
+                    "rank": 27
+                },
+                {
+                    "user": {
+                        "id": "32747767",
+                        "firstName": "Georgy",
+                        "lastName": "Koshy",
+                        "relationship": "friend",
+                        "photo": {
+                            "prefix": "https://irs0.4sqi.net/img/user/",
+                            "suffix": "/blank_boy.png"
+                        }
+                    },
+                    "scores": {
+                        "recent": 16,
+                        "max": 94,
+                        "checkinsCount": 8
+                    },
+                    "rank": 27
+                }
+            ]
+        }
+    }
+}

data/test/test_client.rb

@@ -1,7 +1,44 @@
 require 'helper'
 
 class TestClient < Test::Unit::TestCase
-  
+
+  context "when configuring the client at a class level" do
+    should "use the class-assigned attributes for new instances" do
+      Foursquare2.configure do |config|
+        config.client_id = 'awesome'
+        config.client_secret = 'sauce'
+        config.api_version = 5551234
+        config.ssl = true
+      end
+      client = Foursquare2::Client.new
+      client.client_id.should == 'awesome'
+      client.client_secret.should == 'sauce'
+      client.api_version.should == 5551234
+      client.ssl.should == true
+    end
+
+    should 'use the class-assigned middleware if provided' do
+      Foursquare2.configure do |config|
+        config.connection_middleware = [:middleware]
+      end
+      Faraday::Builder.any_instance.expects(:use).at_least_once
+      Faraday::Builder.any_instance.expects(:use) \
+        .with(:middleware)
+      client = Foursquare2::Client.new
+      client.connection
+    end
+
+    teardown do
+      Foursquare2.configure do |config|
+        config.client_id = nil
+        config.client_secret = nil
+        config.api_version = nil
+        config.connection_middleware = nil
+        config.ssl = nil
+      end
+    end
+  end
+
   context "when instantiating a client instance" do
     should "use the correct url for api requests" do
       @client = Foursquare2::Client.new
@@ -18,19 +55,24 @@ class TestClient < Test::Unit::TestCase
       @client.client_id.should == 'awesome'
       @client.client_secret.should == 'sauce'
     end
-    
+
     should "retain api version for requests" do
       @client = Foursquare2::Client.new(:api_version => '20120505')
       @client.api_version.should == "20120505"
     end
 
+    should "retain api locale for requests" do
+      @client = Foursquare2::Client.new(:locale => 'es')
+      @client.locale.should == "es"
+    end
+
     should "retain SSL option for requests when you don't pass it as param" do
       @client = Foursquare2::Client.new(:client_id => 'awesome', :client_secret => 'sauce')
       @client.ssl.should == {}
     end
-    
+
     should "retain SSL option for requests" do
-      @client = Foursquare2::Client.new(:client_id => 'awesome', :client_secret => 'sauce', :ssl => {:ca_file => 'path_to_ca_file'})      
+      @client = Foursquare2::Client.new(:client_id => 'awesome', :client_secret => 'sauce', :ssl => {:ca_file => 'path_to_ca_file'})
       @client.ssl[:ca_file].should == 'path_to_ca_file'
     end
 
@@ -63,7 +105,7 @@ class TestClient < Test::Unit::TestCase
     should "raise Foursquare2::Error." do
       response = Faraday::Response.new(:body => fixture_file('error.json', :parse => true))
       client   = Foursquare2::Client.new
-  
+
       assert_raises(Foursquare2::APIError) do
         client.return_error_or_body(response, response.body)
       end

data/test/test_users.rb

@@ -7,6 +7,12 @@ class TestUsers < Test::Unit::TestCase
       @client = foursquare_test_client
     end
 
+    should "fetch user's leaderboard" do
+      stub_get("https://api.foursquare.com/v2/users/leaderboard?oauth_token=#{@client.oauth_token}&neighbors=2", "users/leaderboard.json", )
+      leaderboard = @client.leaderboard(:neighbors => 2)
+      leaderboard.leaderboard['count'].should == 3
+    end
+
     should "fetch info for a single user" do
       stub_get("https://api.foursquare.com/v2/users/self?oauth_token=#{@client.oauth_token}", "users/user.json")
       user = @client.user('self')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foursquare2
 version: !ruby/object:Gem::Version
-  version: 1.8.2
+  version: 1.9.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-01 00:00:00.000000000Z
+date: 2012-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70235098690600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,15 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70235098690600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70235098689440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +38,15 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70235098689440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70235098687800 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +54,15 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70235098687800
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70235098686020 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +70,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70235098686020
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70235098682920 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +86,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70235098682920
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70235098680680 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +102,15 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70235098680680
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70235098678820 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +118,15 @@ dependencies:
         version: '1.5'
   type: :development
   prerelease: false
-  version_requirements: *70235098678820
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70235098676620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +134,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70235098676620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70235098675260 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -110,10 +150,15 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70235098675260
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: jnunemaker-matchy
-  requirement: &70235098661440 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,10 +166,15 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70235098661440
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: json_pure
-  requirement: &70235098660120 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -132,10 +182,15 @@ dependencies:
         version: '1.4'
   type: :development
   prerelease: false
-  version_requirements: *70235098660120
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70235098658060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - <
@@ -146,7 +201,15 @@ dependencies:
         version: 0.0.5
   type: :development
   prerelease: false
-  version_requirements: *70235098658060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - <
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.5
 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:
@@ -204,6 +267,7 @@ files:
 - test/fixtures/specials/special_created.json
 - test/fixtures/tips/search_tips.json
 - test/fixtures/tips/tip.json
+- test/fixtures/users/leaderboard.json
 - test/fixtures/users/search_users.json
 - test/fixtures/users/user.json
 - test/fixtures/users/user_lists.json
@@ -248,7 +312,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2014267550921023463
+      hash: -1147232695662133352
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -257,7 +321,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Foursquare API v2 gem in the spirit of the original foursquare gem