quimby 0.3.0 → 0.4.0

data/README.md

@@ -13,6 +13,28 @@ Get a foursquare:
 You can also user `client_id` and `client_secret`
 
     foursquare = Foursquare::Base.new("CLIENT_ID", "CLIENT_SECRET")
+    
+### Authentication
+
+First, you need to [register your application](https://foursquare.com/oauth).
+
+#### Web server application
+
+Get a foursquare with your `client_id` and `client_secret`
+
+    foursquare = Foursquare::Base.new("CLIENT_ID", "CLIENT_SECRET")
+  
+Redirect users to the Foursquare authentication page. You need to pass your `callback_url`. Get the url to redirect to with:
+
+    foursquare.authorize_url("CALLBACK_SESSION_URL")
+  
+Then Foursquare will redirect the user to your callback url with a code parameter in the url. Exchange this code for an access token using:
+
+    access_token = foursquare.access_token(params["code"], "CALLBACK_SESSION_URL")
+    
+Now you can get a foursquare using only an access token and make requests on user's behalf:
+
+    foursquare = Foursquare::Base.new("ACCESS_TOKEN")
 
 ### Users
 
@@ -42,6 +64,10 @@ But wait, Foursquare isn't just users! It's checkins too! So let's find some che
 Now we have an array of `Foursquare::Checkin` objects. We can also grab a specific checkin:
 
     checkin = foursquare.checkins.find("CHECKIN_ID")
+    
+You also have a convenient method if you want to get all the user checkins:
+
+    user.all_checkins
 
 ### Venues
 

data/lib/foursquare/base.rb

@@ -48,8 +48,55 @@ module Foursquare
       Foursquare.log(response.inspect)
       error(response) || response["response"]
     end
+    
+    def authorize_url(redirect_uri)
+      # http://developer.foursquare.com/docs/oauth.html
+      
+      # check params
+      raise "you need to define a client id before" if @client_id.blank?
+      raise "no callback url provided" if redirect_uri.blank?
+      
+      # params
+      params = {}
+      params["client_id"] = @client_id
+      params["response_type"] = "code"
+      params["redirect_uri"] = redirect_uri
+      
+      # url
+      oauth2_url('authenticate', params)
+    end
+    
+    def access_token(code, redirect_uri)
+      # http://developer.foursquare.com/docs/oauth.html
+      
+      # check params
+      raise "you need to define a client id before" if @client_id.blank?
+      raise "you need to define a client secret before" if @client_secret.blank?
+      raise "no code provided" if code.blank?
+      raise "no redirect_uri provided" if redirect_uri.blank?
+      
+      # params
+      params = {}
+      params["client_id"] = @client_id
+      params["client_secret"] = @client_secret
+      params["grant_type"] = "authorization_code"
+      params["redirect_uri"] = redirect_uri
+      params["code"] = code
+      
+      # url
+      url = oauth2_url('access_token', params)
+      
+      # response
+      # http://developer.foursquare.com/docs/oauth.html
+      response = JSON.parse(Typhoeus::Request.get(url).body)
+      response["access_token"]
+    end
 
     private
+    
+    def oauth2_url(method_name, params)
+      "https://foursquare.com/oauth2/#{method_name}?#{params.to_query}"
+    end
 
     def camelize(params)
       params.inject({}) { |o, (k, v)|

data/lib/foursquare/photo.rb

@@ -23,5 +23,30 @@ module Foursquare
     def sizes
       @json["sizes"]
     end
+    
+    def square_300
+      @square_300 ||= @json["sizes"]["items"].select { |i| i["width"] == 300 }.first
+    end
+    
+    def square_300_url
+      square_300["url"]
+    end
+    
+    def square_100
+      @square_100 ||= @json["sizes"]["items"].select { |i| i["width"] == 100 }.first
+    end
+    
+    def square_100_url
+      square_100["url"]
+    end
+    
+    def square_36
+      @square_36 ||= @json["sizes"]["items"].select { |i| i["width"] == 36 }.first
+    end
+    
+    def square_36_url
+      square_36["url"]
+    end
+    
   end
 end

data/lib/foursquare/user.rb

@@ -74,6 +74,27 @@ module Foursquare
       fetch unless @json.has_key?("mayorships")
       @json["mayorships"]["items"]
     end
+    
+    # https://developer.foursquare.com/docs/users/checkins.html
+    # https://developer.foursquare.com/docs/explore.html#req=users/self/checkins
+    def checkins(options={})
+      @foursquare.get("users/#{id}/checkins", options)["checkins"]["items"].map do |item|
+        Foursquare::Checkin.new(@foursquare, item)
+      end
+    end
+    
+    def all_checkins
+      count = 250
+      offset = 0
+      array = []
+      while count == 250
+        checkins = checkins(:limit => count, :offset => offset)
+        array += checkins
+        count = checkins.count
+        offset = offset + count
+      end
+      array
+    end
 
     def checkin_count
       fetch unless @json.has_key?("checkins")

data/lib/foursquare/venue.rb

@@ -19,11 +19,11 @@ module Foursquare
     end
 
     def location
-      @json["location"]
+      Foursquare::Location.new(@json["location"])
     end
 
     def categories
-      @json["categories"]
+      @categories ||= @json["categories"].map { |hash| Foursquare::Category.new(hash) }
     end
 
     def verified?
@@ -41,11 +41,41 @@ module Foursquare
     def todos_count
       @json["todos"]["count"]
     end
-
-    def photos(options={:group => "checkin"})
+    
+    def stats
+      @json["stats"]
+    end
+    
+    def primary_category
+      return nil if categories.blank?
+      @primary_category ||= categories.select { |category| category.primary? }.try(:first)
+    end
+    
+    # return the url to the icon of the primary category
+    # if no primary is available, then return a default icon
+    def icon
+      primary_category ? primary_category["icon"] : "https://foursquare.com/img/categories/none.png"
+    end
+    
+    def photos_count
+      @json["photos"]["count"]
+    end
+    
+    # not all photos may be present here (but we try to avoid one extra API call)
+    # if you want to get all the photos, try all_photos
+    def photos
+      return all_photos if @json["photos"].blank?
+      @json["photos"]["groups"].select { |g| g["type"] == "venue" }.first["items"].map do |item|
+        Foursquare::Photo.new(@foursquare, item)
+      end
+    end
+    
+    # https://developer.foursquare.com/docs/venues/photos.html
+    def all_photos(options={:group => "venue"})
       @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: quimby
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Pat Nakajima