foursquare2 1.4.2 → 1.5.0

data/Gemfile

@@ -22,3 +22,7 @@ group :development do
   gem 'json_pure', '~> 1.4'
   gem 'multi_json', '>= 0.0.5', '< 2.0.0'
 end
+
+group :test do
+  gem 'mocha'
+end

data/Gemfile.lock

@@ -15,6 +15,9 @@ GEM
       rake
     jnunemaker-matchy (0.4.0)
     json_pure (1.5.1)
+    metaclass (0.0.1)
+    mocha (0.11.4)
+      metaclass (~> 0.0.1)
     multi_json (1.0.2)
     multipart-post (1.1.5)
     rake (0.9.2.2)
@@ -34,6 +37,7 @@ DEPENDENCIES
   jeweler (~> 1.5)
   jnunemaker-matchy (~> 0.4)
   json_pure (~> 1.4)
+  mocha
   multi_json (>= 0.0.5, < 2.0.0)
   rcov
   shoulda

data/Readme.md

@@ -20,6 +20,9 @@ Currently this gem does not handle the oauth2 authentication flow for you, use t
 
     client = Foursquare2::Client.new(:oauth_token => 'user_oauth_token')
 
+### Instantiate a client (With versioning)
+
+    client = Foursquare2::Client.new(:api_version => '20120505')
 
 ### Examples
 

data/VERSION

@@ -1 +1 @@
-1.4.2
+1.5.0

data/foursquare2.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "foursquare2"
-  s.version = "1.4.2"
+  s.version = "1.5.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-05-08"
+  s.date = "2012-06-17"
   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 = [

data/lib/foursquare2/client.rb

@@ -2,6 +2,13 @@ require 'forwardable'
 
 module Foursquare2
   class Client
+    DEFAULT_CONNECTION_MIDDLEWARE = [
+      Faraday::Request::Multipart,
+      Faraday::Request::UrlEncoded,
+      FaradayMiddleware::Mashify,
+      FaradayMiddleware::ParseJson
+    ]
+
     extend Forwardable
 
     include Venues
@@ -12,7 +19,7 @@ module Foursquare2
     include Specials
     include Users
 
-    attr_reader :client_id, :client_secret, :oauth_token
+    attr_reader :client_id, :client_secret, :oauth_token, :api_version
 
     #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.
     #
@@ -22,13 +29,18 @@ module Foursquare2
     # @option options String :client_id Your foursquare app's client_id
     # @option options String :client_secret Your foursquare app's client_secret
     # @option options String :oauth_token A valid oauth token for a user (or the 'secret' value from api v1)
+    # @option options String :api_version A date formatted as YYYYMMDD indicating the API version you intend to use
+    # @option options Array  :connection_middleware A collection of different middleware to be applied when the connection is created
     # @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]
       @oauth_token = options[:oauth_token]
+      @api_version = options[:api_version]
       @ssl = options[:ssl].nil? ? Hash.new : options[:ssl]
+      @connection_middleware = options.fetch(:connection_middleware, [])
+      @connection_middleware += DEFAULT_CONNECTION_MIDDLEWARE
     end
 
     def ssl
@@ -42,15 +54,12 @@ module Foursquare2
       params[:client_id] = @client_id if @client_id
       params[:client_secret] = @client_secret if @client_secret
       params[:oauth_token] = @oauth_token if @oauth_token
+      params[:v] = @api_version if @api_version
       @connection ||= Faraday::Connection.new(:url => api_url, :ssl => @ssl, :params => params, :headers => default_headers) do |builder|
-        builder.use Faraday::Request::Multipart
-        builder.use Faraday::Request::UrlEncoded
-
-        builder.use FaradayMiddleware::Mashify
-        builder.use FaradayMiddleware::ParseJson
-
+        @connection_middleware.each do |middleware|
+          builder.use *middleware
+        end
         builder.adapter Faraday.default_adapter
-
       end
     end
 

data/test/helper.rb

@@ -14,6 +14,7 @@ require 'fakeweb'
 require 'json'
 require 'hashie'
 require 'awesome_print'
+require 'mocha'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))

data/test/test_client.rb

@@ -2,7 +2,7 @@ require 'helper'
 
 class TestClient < Test::Unit::TestCase
   
- context "when instantiating a client instance" do
+  context "when instantiating a client instance" do
     should "use the correct url for api requests" do
       @client = Foursquare2::Client.new
       @client.api_url.should == 'https://api.foursquare.com/v2'
@@ -19,6 +19,11 @@ class TestClient < Test::Unit::TestCase
       @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 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 == {}
@@ -28,6 +33,20 @@ class TestClient < Test::Unit::TestCase
       @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
+
+    should "apply the middleware to the connection" do
+      middleware = [FaradayMiddleware::Instrumentation,
+                    [FaradayMiddleware::ParseJson, {:content_type => /\bjson$/}]]
+      client = Foursquare2::Client.new(:connection_middleware => middleware)
+
+      Faraday::Builder.any_instance.expects(:use).at_least_once
+      Faraday::Builder.any_instance.expects(:use) \
+        .with(FaradayMiddleware::Instrumentation)
+      Faraday::Builder.any_instance.expects(:use) \
+        .with(FaradayMiddleware::ParseJson, {:content_type => /\bjson$/})
+
+      client.connection
+    end
   end
 
   context "When returning a successful response" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foursquare2
 version: !ruby/object:Gem::Version
-  version: 1.4.2
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-08 00:00:00.000000000Z
+date: 2012-06-17 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70329057858160 !ruby/object:Gem::Requirement
+  requirement: &70180411619020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70329057858160
+  version_requirements: *70180411619020
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70329057857680 !ruby/object:Gem::Requirement
+  requirement: &70180411612380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0.8'
   type: :runtime
   prerelease: false
-  version_requirements: *70329057857680
+  version_requirements: *70180411612380
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70329057857200 !ruby/object:Gem::Requirement
+  requirement: &70180411609000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70329057857200
+  version_requirements: *70180411609000
 - !ruby/object:Gem::Dependency
   name: awesome_print
-  requirement: &70329057856720 !ruby/object:Gem::Requirement
+  requirement: &70180411602640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +55,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70329057856720
+  version_requirements: *70180411602640
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70329057856240 !ruby/object:Gem::Requirement
+  requirement: &70180411583840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -66,10 +66,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70329057856240
+  version_requirements: *70180411583840
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70329057855760 !ruby/object:Gem::Requirement
+  requirement: &70180411551580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70329057855760
+  version_requirements: *70180411551580
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &70329057855280 !ruby/object:Gem::Requirement
+  requirement: &70180411546880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: '1.5'
   type: :development
   prerelease: false
-  version_requirements: *70329057855280
+  version_requirements: *70180411546880
 - !ruby/object:Gem::Dependency
   name: rcov
-  requirement: &70329057871940 !ruby/object:Gem::Requirement
+  requirement: &70180407658900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -99,10 +99,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70329057871940
+  version_requirements: *70180407658900
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70329057871460 !ruby/object:Gem::Requirement
+  requirement: &70180407648380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -110,10 +110,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70329057871460
+  version_requirements: *70180407648380
 - !ruby/object:Gem::Dependency
   name: jnunemaker-matchy
-  requirement: &70329057870980 !ruby/object:Gem::Requirement
+  requirement: &70180407633840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,10 +121,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70329057870980
+  version_requirements: *70180407633840
 - !ruby/object:Gem::Dependency
   name: json_pure
-  requirement: &70329057870500 !ruby/object:Gem::Requirement
+  requirement: &70180407618500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -132,10 +132,10 @@ dependencies:
         version: '1.4'
   type: :development
   prerelease: false
-  version_requirements: *70329057870500
+  version_requirements: *70180407618500
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70329057870000 !ruby/object:Gem::Requirement
+  requirement: &70180407608020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - <
@@ -146,7 +146,7 @@ dependencies:
         version: 0.0.5
   type: :development
   prerelease: false
-  version_requirements: *70329057870000
+  version_requirements: *70180407608020
 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:
@@ -222,7 +222,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3885395942000903583
+      hash: 1620543926034426764
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: