john-mayer 0.1.4 → 0.2.0

data/README.md

@@ -1,6 +1,7 @@
 # John Mayer
 
-It's a Foursquare API wrapper.
+It's a Foursquare API wrapper, designed to "just work", just like all of John Mayer's hooks and
+sweet guitar licks. It uses objects instead of hashes, and tries to be smart about when to load things.
 
 ## Usage
 
@@ -8,25 +9,65 @@ Get a foursquare:
 
     foursquare = Foursquare::Base.new("ACCESS_TOKEN")
 
+### Users
+
 Find a user:
 
-    foursquare.users.find("USER_ID")
+    user = foursquare.users.find("USER_ID")
+
+Now we've got a `Foursquare::User` object. You can call sweet methods like `user.name` and even
+`user.last_checkin`. **In general, John Mayer's Foursquare object methods are just snake-cased
+versions of the attributes returned in the JSON.** Now let's accidentally that user's friends:
+
+    user.friends
+
+This will return an array of `Foursquare::User` objects. Don't worry about the fact that they're
+populated by limited JSON. John Mayer will fetch the extra JSON if you need it. For example:
+
+    friend = user.friends.first
+    friend.name # Will not trigger a network call, since we already have it
+    friend.twitter # Will trigger a network to load the user's contact information
+
+### Checkins
+
+But wait, Foursquare isn't just users! It's checkins too! So let's find some checkins:
 
-Find a checkin:
+    user.checkins
 
-    foursquare.checkins.find("CHECKIN_ID")
+Now we have an array of `Foursquare::Checkin` objects. We can also grab a specific checkin:
 
-Find a venue:
+    checkin = foursquare.checkins.find("CHECKIN_ID")
+
+### Venues
+
+We can get at a checkin's venue by calling `checkin.venue`. Pretty easy, RIGHT? Right. If you want to
+find a venue directly, here ya go:
 
     foursquare.venues.find("VENUE_ID")
 
+You can also search venues:
+
+    foursquare.venues.search(:ll => "40.7236307,-73.9999479") # Returns all resulting groups
+    foursquare.venues.nearby(:ll => "40.7236307,-73.9999479") # Returns only nearby venues
+    foursquare.venues.trending(:ll => "40.7236307,-73.9999479") # Returns only trending venues
+    foursquare.venues.favorites(:ll => "40.7236307,-73.9999479") # Returns only favorite venues
+
+The `:ll` option is required for venue searches. You can also feel free to pass any of the other
+available Foursquare API options, as specified in the docs.
+
 ### Logging
 
 If you want to see what's going on up in there, you can set `Foursquare.verbose` to `true`
 
     Foursquare.verbose = true
 
-Right now it'll log to `STDOUT`. Maybe I'll add nicer logging later. If you're lucky.
+Right now it'll log to `STDOUT`. Maybe I'll add nicer logging later. If you're lucky. In the meantime,
+if you want to use your own logger, and you're kind of a jerk like me, you can do something like this:
+
+    Foursquare.verbose = true
+    def Foursquare.log(message)
+      Rails.logger.info("[foursquare] #{message}") # HAX, SORRY BRANDON
+    end
 
 ## TODO
 

data/lib/foursquare.rb

@@ -3,6 +3,7 @@ $LOAD_PATH << File.dirname(__FILE__)
 require "rubygems"
 require "typhoeus"
 require "json"
+require "cgi"
 require "foursquare/base"
 require "foursquare/checkin_proxy"
 require "foursquare/checkin"
@@ -11,6 +12,8 @@ require "foursquare/user"
 require "foursquare/venue_proxy"
 require "foursquare/venue"
 require "foursquare/settings"
+require "foursquare/tip"
+require "foursquare/photo"
 
 module Foursquare
   class Error < StandardError ; end

data/lib/foursquare/base.rb

@@ -29,16 +29,17 @@ module Foursquare
       params.merge!(:oauth_token => @access_token)
       response = JSON.parse(Typhoeus::Request.get(API + path, :params => params).body)
       Foursquare.log(response.inspect)
-      response["meta"]["errorType"] ? error(response) : response["response"]
+      error(response) || response["response"]
     end
 
     def post(path, params={})
       params = camelize(params)
       Foursquare.log("POST #{API + path}")
+      Foursquare.log("PARAMS: #{params.inspect}")
       params.merge!(:oauth_token => @access_token)
       response = JSON.parse(Typhoeus::Request.post(API + path, :params => params).body)
       Foursquare.log(response.inspect)
-      response["meta"]["errorType"] ? error(response) : response["response"]
+      error(response) || response["response"]
     end
 
     private
@@ -51,7 +52,15 @@ module Foursquare
     end
 
     def error(response)
-      raise Foursquare::Error.new(Foursquare::ERRORS[response['meta']['errorType']])
+      case response["meta"]["errorType"]
+      when nil
+        # It's all good.
+      when "deprecated"
+        Foursquare.log(Foursquare::ERRORS[response['meta']['errorType']])
+        nil
+      else
+        raise Foursquare::Error.new(Foursquare::ERRORS[response['meta']['errorType']])
+      end
     end
   end
 end

data/lib/foursquare/checkin_proxy.rb

@@ -27,5 +27,6 @@ module Foursquare
         nil
       end
     end
+    alias_method :add, :create
   end
 end

data/lib/foursquare/multi.rb

@@ -0,0 +1,38 @@
+# Here's how I want this to work:
+#
+#   users, venues = foursquare.multi do |request|
+#     request.users.search :twitter => "nakajima"
+#     request.venues.search :ll => "12,-71"
+#   end
+#
+# It's just difficult to implement. So it's not implemented yet.
+module Foursquare
+  class Multi
+    def initialize(foursquare, block)
+      @foursquare = foursquare
+      @requests = []
+      @responses = []
+    end
+
+    def get(path, options={})
+      @requests << path + query(params)
+    end
+
+    def perform
+      responses = @foursquare.get("multi", :requests => @requests.join(','))
+    end
+
+    private
+
+    def query(params)
+      camelized = params.inject({}) { |o, (k, v)|
+        o[k.to_s.gsub(/(_[a-z])/) { |m| m[1..1].upcase }] = v
+        o
+      }
+      camelized.inject([]) { |o, (k, v)|
+        o << CGI.escape(k) + "=" CGI.escape(v)
+        o
+      }.join('&')
+    end
+  end
+end

data/lib/foursquare/photo.rb

@@ -0,0 +1,27 @@
+module Foursquare
+  class Photo
+    def initialize(foursquare, json)
+      @foursquare, @json = foursquare, json
+    end
+
+    def id
+      @json["id"]
+    end
+
+    def name
+      @json["name"]
+    end
+
+    def created_at
+      @json["createdAt"]
+    end
+
+    def url
+      @json["url"]
+    end
+
+    def sizes
+      @json["sizes"]
+    end
+  end
+end

data/lib/foursquare/tip.rb

@@ -0,0 +1,35 @@
+module Foursquare
+  class Tip
+    def initialize(foursquare, json)
+      @foursquare, @json = foursquare, json
+    end
+
+    def id
+      @json["id"]
+    end
+
+    def text
+      @json["text"]
+    end
+
+    def created_at
+      @json["createdAt"]
+    end
+
+    def status
+      @json["status"]
+    end
+
+    def photo
+      @json["photo"]
+    end
+
+    def user
+      @json["user"] && Foursquare::User.new(@foursquare, @json["user"])
+    end
+
+    def venue
+      @json["venue"] && Foursquare::Venue.new(@foursquare, @json["venue"])
+    end
+  end
+end

data/lib/foursquare/user.rb

@@ -102,5 +102,11 @@ module Foursquare
         Foursquare::User.new(@foursquare, item)
       end
     end
+
+    def tips(options={})
+      @foursquare.get("users/#{id}/tips", options)["tips"]["items"].map do |item|
+        Foursquare::Tip.new(@foursquare, item)
+      end
+    end
   end
 end

data/lib/foursquare/user_proxy.rb

@@ -4,8 +4,18 @@ module Foursquare
       @foursquare = foursquare
     end
 
+    def self.search(foursquare, options={})
+      
+    end
+
     def find(id)
       Foursquare::User.new(@foursquare, @foursquare.get("users/#{id}")["user"])
     end
+
+    def search(options={})
+      @foursquare.get("users/search", options)["results"].map do |json|
+        Foursquare::User.new(@foursquare, json)
+      end
+    end
   end
 end

data/lib/foursquare/venue.rb

@@ -39,5 +39,11 @@ module Foursquare
     def todos_count
       @json["todos"]["count"]
     end
+
+    def photos(options={:group => "checkin"})
+      @foursquare.get("venues/#{id}/photos", options)["photos"]["items"].map do |item|
+        Foursquare::Photo.new(@foursquare, item)
+      end
+    end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: john-mayer
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 23
   prerelease: 
   segments: 
   - 0
-  - 1
-  - 4
-  version: 0.1.4
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Pat Nakajima
@@ -59,14 +59,16 @@ files:
 - lib/foursquare.rb
 - lib/foursquare/base.rb
 - lib/foursquare/settings.rb
+- lib/foursquare/tip.rb
+- lib/foursquare/multi.rb
 - lib/foursquare/checkin.rb
+- lib/foursquare/photo.rb
 - lib/foursquare/checkin_proxy.rb
 - lib/foursquare/user.rb
 - lib/foursquare/user_proxy.rb
 - lib/foursquare/venue.rb
 - lib/foursquare/venue_proxy.rb
 - spec/THERE_ARENT_ANY
-- test.rb
 has_rdoc: true
 homepage: https://github.com/groupme/john-mayer
 licenses: []

data/test.rb

@@ -1,4 +0,0 @@
-require 'lib/foursquare'
-
-FOURSQUARE = Foursquare::Base.new('YSQQ2G4HOATU5515IFH4ODCKUQYYKZ2M4DVBNPI1ZCXKL3QS')
-# FOURSQUARE = Foursquare::Base.new('T2UPWWBXJP2UFBRTBXKDM1UQAH3A3TUDELQ3YQRFAWGLKTTT')