foursquared 0.0.4

data/lib/foursquared/response/photo.rb

@@ -0,0 +1,102 @@
+module Foursquared
+  module Response
+    # Photo response
+    class Photo
+      attr_reader :client, :response
+      def initialize(client, response)
+        @client = client
+        @response = response
+      end
+
+      # The ID of the photo
+      # @return [String]
+      def id
+        response["id"]
+      end
+
+      # The time at which the photo was created
+      # @return [Time]
+      def created_at
+        Time.at(response["createdAt"]) if response["createdAt"]
+      end
+
+      # The name and url for the application that created this photo.
+      def source
+        response["source"]
+      end
+
+      # Start of the URL for this photo.
+      # @return [String]
+      def prefix
+        response["prefix"]
+      end
+
+      # End of the URL for this photo.
+      # @return [String]
+      def suffix
+        response["suffix"]
+      end
+
+      # The user to which the photo belongs
+      # @return [Foursquared::Response::User]
+      def user
+        Foursquared::Response::User.new(client, response["user"]) if response["user"]
+      end
+
+      # URLs for each photo size
+      # @return [Hash]
+      def urls
+        @urls = {
+          "36x36" => url(36,36),
+          "100x100" => url(100,100),
+          "300x300" => url(300,300),
+          "500x500" => url(500,500)
+        }
+        @urls.merge!({"original" => url(width, height)}) if (width and height)
+        @urls
+      end
+
+      # Height of the original photo in pixels
+      # @return [Integer]
+      def height
+        response["height"]
+      end
+
+      # Width of the original photo in pixels
+      # @return [Integer]
+      def width
+        response["width"]
+      end
+
+      # Who all can see the photo
+      # @return [String]
+      def visibility
+        response["visibility"]
+      end
+
+      # Venue at which the photo was taken
+      # @return [Foursquared::Response::Venue]
+      def venue
+        Foursquared::Response::Venue.new(client, response["venue"]) if response["venue"]
+      end
+
+      # Tip corresponding to the photo
+      # @return [Foursquared::Response::Tip]
+      def tip
+        Foursquared::Response::Tip.new(client, response["tip"]) if response["tip"]
+      end
+
+      # The checkin for which the photo was taken
+      # @return [Foursquared::Response::Checkin]
+      def checkin
+        Foursquared::Response::Checkin.new(client, response["checkin"]) if response["checkin"]
+      end
+
+      private
+      def url width, height
+        "#{prefix}#{width}x#{height}#{suffix}"
+      end
+    end
+  end
+end
+

data/lib/foursquared/response/special.rb

@@ -0,0 +1,131 @@
+module Foursquared
+  module Response
+    # Special response
+    class Special
+      attr_reader :client, :response
+
+      def initialize client, response
+        @client = client
+        @response = response
+      end
+
+      # ID of the special
+      # @return [String]
+      def id
+        response["id"]
+      end
+
+      # A description of how to unlock the special.
+      # @return [String]
+      def description
+        response["description"]
+      end
+
+      # One of mayor, count, frequency, regular, friends, swarm, flash or other.
+      # @return [String]
+      def type
+        response["type"]
+      end
+
+      # A message describing the special.
+      # @return [String]
+      def message
+        response["message"]
+      end
+
+      # Special's image urls
+      # @return [Hash]
+      def image_urls
+        response["imageUrls"]
+      end
+
+      # If the user has unlocked the special
+      # @return [Boolean]
+      def unlocked?
+        response["unlocked"]
+      end
+
+      # The name of the icon to use
+      # @return [String]
+      def icon
+        response["icon"]
+      end
+
+      # URL for the icon
+      # @return [String]
+      def icon_url
+        "http://foursquare.com/img/specials/#{icon}.png" if icon
+      end
+
+      # The header text describing the type of special.
+      # @return [String]
+      def title
+        response["title"]
+      end
+
+      # The state of the special
+      # @return [String] unlocked, before start, in progress, taken, or locked
+      def state
+        response["state"]
+      end
+
+      # A description of how close you are to unlocking the special
+      # @return [Integer] Either the number of people who have already unlocked the special (flash and swarm specials), or the number of your friends who have already checked in (friends specials)
+      def progress
+        response["progress"]
+      end
+
+      # A label describing what the number in the progress field means.
+      # @return [String]
+      def progress_description
+        response["progressDescription"]
+      end
+
+      # Minutes remaining until the special can be unlocked
+      # @return [String]
+      def detail
+        response["detail"]
+      end
+
+      # The provider of the special
+      # @return [String]
+      def provider
+        response["provider"]
+      end
+
+      # Type of redemption
+      # @return [String]
+      def redemption
+        response["redemption"]
+      end
+
+      # The count and urls for the images for the special
+      # @return [Hash]
+      def image_urls
+        response["imageUrls"]
+      end
+
+      # The specific rules for this special.
+      # @return [String]
+      def fine_print
+        response["finePrint"]
+      end
+
+      # Friends who are here
+      # @return [Array<Foursquared::Response::User>] An array of Users
+      def friends_here
+        @friends = response["friendsHere"].collect{|friend| Foursquared::Response::User.new(client, friend)}
+      end
+
+      # Flag the Special
+      # @param [Hash] options
+      # @option option [String] :venueId required The id of the venue running the special.
+      # @option option [String] :problem required One of not_redeemable, not_valuable, other.
+      # @option option [String] :text Additional text about why the user has flagged this special
+      def flag options={}
+        response = post("/specials/#{id}/flag", options)["response"]
+      end
+
+    end
+  end
+end

data/lib/foursquared/response/tip.rb

@@ -0,0 +1,134 @@
+module Foursquared
+  module Response
+    # Tip response class
+    class Tip
+      attr_reader :client, :response
+      def initialize client, response
+        @client = client
+        @response = response
+      end
+
+      # ID of the tip
+      # @return [String] tip id
+      def id
+        response["id"]
+      end
+
+      # Time since creation of the tip
+      # @return [Time]
+      def created_at
+        Time.at(response["createdAt"]) if response["createdAt"]
+      end
+
+      # The actual tip
+      # @return [String]
+      def text
+        response["text"]
+      end
+
+      # The canonical url for the tip
+      # @return [String] url
+      def canonical_url
+        response["canonicalUrl"]
+      end
+
+      # Groups of users who like the tip
+      # @return [Hash] count, groups and summary
+      def likes
+        @likes = response["likes"] 
+        @likes["groups"].each{ |group| group["items"].map!{|item| Foursquared::Response::User.new(client, item)}} if @likes and @likes["groups"]
+      end
+
+      # Whether the acting user likes the tip
+      # @return [Boolean] true or false
+      def like?
+        response["like"]
+      end
+
+      # If the context allows tips from multiple venues, the compact venue for this tip. 
+      # @return [Foursquared::Response::Venue]
+      def venue
+        Foursquared::Response::Venue.new(client, response["venue"]) if response["venue"]
+      end
+
+      # If the context allows tips from multiple venues, the compact venue for this tip. 
+      # @return [Foursquared::Response::User]
+      def user
+        Foursquared::Response::User.new(client, response["user"]) if response["user"]
+      end
+
+      # Groups of lists
+      # @return [Hash] count and groups of lists
+      def listed
+        @listed = response["listed"]
+
+        @listed["groups"].each{|group| group["items"].map!{|item| Foursquared::Response::List.new(client, item)}} if @listed and @listed["groups"]
+      end
+
+      # Photo for this tip
+      # @return [Foursquared::Response::Photo]
+      def photo
+        Foursquared::Response::Photo.new(client, response["photo"]) if response["photo"]
+      end
+
+      # Status of this tip.
+      # @return [String] todo or done
+      def status
+        response["status"]
+      end
+
+      # A URL for more information. 
+      # @return [String]
+      def url
+        response["url"]
+      end
+
+      # Users who have marked this tip todo
+      # @return [Hash] count and groups of users
+      def todo
+        @todo = response["todo"]
+        @todo["groups"].each {|group| group["items"].map!{|item| Foursquared::Response::User.new(client, item)}} if @todo and @todo["groups"]
+      end
+
+      # Users who have done this tip todo
+      # @return [Hash] count and groups of users
+      def done 
+        @done = response["done"]
+        @done["groups"].each {|group| group["items"].map!{|item| Foursquared::Response::User.new(client, item)}} if @done and @done["groups"]
+      end
+
+      # Like or unlike the tip 
+      # @param [Hash] options
+      # @option options [Integer] :set If 1, like this tip. If 0 unlike (un-do a previous like) it. Default value is 1
+      # @return [Hash] Updated count and groups of users who like this tip.
+      def like options={}
+        response = post("/tips/#{id}/like", options)["response"]
+        @likes = response["likes"]
+        @likes["groups"].each{ |group| group["items"].map!{|item| Foursquared::Response::User.new(client, item)}} if @likes and @likes["groups"]
+        @likes
+      end
+
+      # Mark the tip done 
+      # @return [Foursquared::Response::Tip] The marked to-do.
+      def mark_done 
+        response = post("/tips/#{id}/markdone")["response"]
+        Foursquared::Response::Tip.new(self, response["tip"])
+      end
+
+      # Mark the tip to-do
+      # @return [Foursquared::Response::Todo] The marked to-do.
+      def mark_todo
+        response = post("/tips/#{id}/marktodo")["response"]
+        Foursquared::Response::Todo.new(self, response["todo"])
+      end
+
+      # Unmark the tip as to-do 
+      # @return [Foursquared::Response::Tip] The current tip
+      def unmark_todo tip_id
+        response = post("/tips/#{tip_id}/unmark")["response"]
+        Foursquared::Response::Tip.new(self, response["tip"])
+      end
+      
+    end
+  end
+end

data/lib/foursquared/response/user.rb

@@ -0,0 +1,246 @@
+# Foursquared module
+module Foursquared
+  # Response module
+  module Response
+    # User response class
+    class User
+      attr_reader :client, :response
+      def initialize client, response
+        @client = client
+        @response = response
+      end
+
+      # The user's id
+      # @return [String] The user's id
+      def id
+        response["id"]
+      end
+
+      # User's first name
+      # @return [String]
+      def first_name
+        response["firstName"]
+      end
+
+      # User's last name
+      # @return [String]
+      def last_name
+        response["lastName"]
+      end
+
+      # User's full name
+      # @return [String]
+      def name
+        [first_name, last_name].join(' ').strip
+      end
+
+      # User's profile photo
+      # @return [Foursquared::Response::Photo]
+      def photo
+        Foursquared::Response::Photo.new(client, response["photo"])
+      end
+
+      # User's relationship with the acting user
+      # @return [String]
+      def relationship
+        response["relationship"]
+      end
+
+      # User's friends list retrieved from the initial response
+      # @return [Hash] count and groups of users
+      def friends
+        @friends = response["friends"]
+        @friends["groups"].each do |group|
+          group["items"].map!{|item| Foursquared::Response::User.new(client, item)}
+        end
+        @friends
+      end
+
+      # User's full friends list 
+      # @param [Hash] options
+      # @option options [Integer] :limit Number of results to return, up to 500.
+      # @option options [Integer] :offset Used to page through results.
+      # @return [Hash]  A count and items of friends.
+      def full_friends options={}
+        client.user_friends(id, options)
+      end
+
+      # User's gender
+      # @return [String]
+      def gender
+        response["gender"]
+      end
+
+      # User's home city
+      # @return [String]
+      def home_city
+        response["homeCity"]
+      end
+
+      # A short bio for the user
+      # @return [String]
+      def bio
+        response["bio"]
+      end
+
+      # Whether to ping if user checkins
+      # @return [String]
+      def checkin_pings
+        response["checkinPings"]
+      end
+
+      # Whether we receive pings from this user, if we have a relationship.
+      # @return [Boolean]
+      def pings
+        response["pings"]
+      end
+
+      # User's current game status.
+      # @return [Hash] Contains recent, max, checkinsCount, and goal for showing user's current game status.
+      def scores
+        response["scores"]
+      end
+
+      # Type of user. Optional, Present for non-standard user types
+      # @return [String] One of page, chain, celebrity, or venuePage
+      def type
+        response["type"]
+      end
+
+      # Venue details
+      # @return [Foursquared::Response::Venue] Optional For venuePage users, this field just contains an id for the relevant venue.
+      def venue
+        Foursquared::Response::Venue.new(client, response["venue"]) if response["venue"]
+      end
+
+      # User's contact details
+      # @return [Hash] An object containing none, some, or all of twitter, facebook, email, and phone.
+      def contact
+        response["contact"]
+      end
+
+      # Page details
+      # @return [Hash] Optional, Contains a detailed page, if the type is a page. 
+      def page_info
+        response["pageInfo"]
+      end
+
+      # User's refferal ID
+      # @return [String]
+      def refferal_id
+        response["refferalId"]
+      end
+
+      # User's followers
+      # @return [Hash]  Optional, Contains count of followers and groups of users who follow or like this user
+      def followers
+        if response["followers"] and response["followers"]["groups"]
+          @followers = response["followers"]
+          @followers["groups"].each do |group|
+             group["items"].map!{|item| Foursquared::Response::User.new(client, item)}
+          end
+          return @followers
+        end
+      end
+
+      # Groups of pages this user user has liked or followed.
+      # @return [Hash]
+      def following
+        if response["following"] and response["following"]["groups"]
+          @following = response["following"]
+          @following["groups"].each do |group|
+             group["items"].map!{|item| Foursquared::Response::User.new(client, item)}
+          end
+          return @following
+        end
+      end
+
+      # Return the user's lists
+      # @return [Hash]
+      def lists
+        @lists = response["lists"]
+        if @lists and @lists["groups"]
+          @lists["groups"].each do |group|
+            group["items"].map!{|item| Foursquared::Response::List.new(client, item)}
+          end
+        end
+        @lists
+      end
+
+      # Return the user's full lists
+      # @param [Hash] options
+      # @option options [String] :group "edited", "created", "followed", "friends" or "suggested"
+      # @option options [String] :ll Location of the user eg: 40.7,-74
+      # @return [Hash]
+      def full_lists options={}
+        client.user_lists(id, options)
+      end
+
+      # List user's mayorships 
+      # @return [Hash]
+      def mayorships
+        @mayorships = response["mayorships"]
+        @mayorships["items"].each{|item| item["venue"] = Foursquared::Response::Venue.new(client, item["venue"])}
+        @mayorships
+      end
+
+      # List user's full mayorships 
+      # @return [Hash]
+      def full_mayorships
+        client.user_mayorships(id)
+      end
+
+      # List user's badges
+      # @return [Hash] count and items of badges
+      def badges
+        @badges = response["badges"]
+        @badges["items"].map!{|item| Foursquared::Response::Badge.new(client, item)}
+      end
+
+      # List user's full badges
+      # @return [Hash]
+      def full_badges
+        client.user_badges(id)
+      end
+      
+      # Approves a pending friend request from this user.
+      # @return [Foursquared::Response::User] the approved user
+      def approve_friend_request user_id
+        response = post("/users/#{id}/approve")["response"]
+        @user = Foursquared::Response::User.new(client, response["user"])
+      end
+
+      # Denies a pending friend request from this user.
+      # @return [Foursquared::Response::User] the denied user
+      def deny_friend_request
+        request_response = post("/users/#{id}/deny")["response"]
+        @user = Foursquared::Response::User.new(client, request_response["user"])
+      end
+
+      # Send a Friend/Follow Request to this user
+      # @param [String, Integer] user_id The request user's/page's id
+      # @return [Foursquared::Response::User] the pending user
+      def send_friend_request
+        request_response = post("/users/#{id}/request")["response"]
+        @user = Foursquared::Response::User.new(client, request_response["userrequest_"])
+      end
+
+      # Removes a friend, unfollows a celebrity, or cancels a pending friend request. 
+      # @return [Foursquared::Response::User] the removed user
+      def unfriend
+        request_response = post("/users/#{id}/unfriend")["response"]
+        @user = Foursquared::Response::User.new(client, request_response["user"])
+      end
+
+      # Set whether to receive pings about this user 
+      # @param [Hash] options
+      # @option options [Boolean] :value required, true or false.
+      # @return [Foursquared::Response::User] User object for the user
+      def set_pings options={}
+        request_response = post("/users/#{id}/setpings", options)["response"]
+        @user = Foursquared::Response::User.new(client,request_response["user"])
+      end
+
+    end
+  end
+end