foursquared 0.0.4

data/lib/foursquared/response/badge.rb

@@ -0,0 +1,87 @@
+module Foursquared
+  module Response
+    # Badge response
+    class Badge
+      attr_reader :client, :response
+      def initialize client, response
+        @client = client
+        @response = response
+      end
+
+      # The badge's id
+      # @return [String]
+      def id
+        response["id"]
+      end
+
+      # Canonical id of the badge
+      # @return [String]
+      def badge_id
+        response["badgeId"]
+      end
+
+      # The name of the badge
+      # @return [String]
+      def name
+        response["name"]
+      end
+
+      # The currently unlocked level
+      # @return [Integer]
+      def level
+        response["level"]
+      end
+
+      # Text about the level unlocked
+      # @return [String]
+      def level_text
+        response["responseText"]
+      end
+
+      # The message to be shown when user unlocks the badge
+      # @return [String]
+      def unlock_message
+        response["unlockMessage"]
+      end
+
+      # The badge description
+      # @return [String]
+      def description
+        response["description"]
+      end
+
+      # Text for the badge
+      # @return [String]
+      def badge_text
+        response["badgeText"]
+      end
+
+      # Hint about the badge
+      # @return [String]
+      def hint
+        response["hint"]
+      end
+
+      # The badge image details
+      # @return [Hash]
+      def image
+        response["image"]
+      end
+
+      # An array of unlock data
+      # @return [Array]
+      def unlocks
+        @unlocks = response["unlocks"]
+        if @unlocks
+          @unlocks.each do |unlock|
+            if unlock["checkins"]
+              unlock["checkins"].map!{|checkin| Foursquared::Response::Checkin.new(client, checkin)}
+            end
+          end
+        end
+        @unlocks
+      end
+
+    end
+  end
+end

data/lib/foursquared/response/badge_group.rb

@@ -0,0 +1,42 @@
+module Foursquared
+  module Response
+    # Badge group response
+    class BadgeGroup
+      attr_reader :client, :response
+      def initialize client, response
+        @client = client
+        @response = response
+      end
+
+      # The type of badge group
+      # @return [String]
+      def type
+        response["type"]
+      end
+
+      # Name of the badge group
+      # @return [String]
+      def name
+        response["name"]
+      end
+
+      # Image for the badge group
+      # @return [Hash]
+      def image
+        response["image"]
+      end
+
+      # Array of IDs of badges present in the group
+      # @return [Array<String>]
+      def items
+        response["items"]
+      end
+
+      # Sub groups of the group
+      # @return [Array<Foursquared::Response::BadgeGroup>]
+      def groups
+        response["groups"].map!{|group| Foursquared::Response::BadgeGroup.new(client, group)}
+      end
+    end
+  end
+end

data/lib/foursquared/response/category.rb

@@ -0,0 +1,53 @@
+module Foursquared
+  module Response
+    # Category object
+    class Category
+      attr_reader :response
+      def initialize response
+        @response = response
+      end
+
+      # Return the id of the category
+      # @return [String]
+      def id
+        response["id"]
+      end
+
+      # Return the name of the category
+      # @return [String]
+      def name
+        response["name"]
+      end
+
+      # Return the plural name of the category
+      # @return [String]
+      def plural_name
+        response["pluralName"]
+      end
+
+      # Return the short name of the category
+      # @return [String]
+      def short_name
+        response["shortName"]
+      end
+
+      # Return the details for icons of the category
+      # @return [Hash] with urls added for each icon size
+      def icon
+        @icon = response["icon"]
+        @icon["urls"] = {
+          "32x32" => "#{@icon["prefix"].chomp("_")}#{@icon["suffix"]}",
+          "64x64" => "#{@icon["prefix"]}_64#{@icon["suffix"]}",
+          "256x256" => "#{@icon["prefix"]}_256#{@icon["suffix"]}",
+        }
+        @icon
+      end
+
+      # The sub-categories for the category
+      # @return [Array] array of sub-categories
+      def categories
+        response["categories"].map!{|category| Foursquared::Response::Category.new(category)}
+      end
+    end
+  end
+end

data/lib/foursquared/response/checkin.rb

@@ -0,0 +1,180 @@
+module Foursquared
+  module Response
+    # Checkin response
+    class Checkin
+      attr_reader :client, :response
+      def initialize client, response
+        @client = client
+        @response = response
+      end
+
+      # ID of the checkin
+      # @return [String]
+      def id
+        response["id"]
+      end
+
+      # The time at which the checkin was created
+      # @return [Time]
+      def created_at
+        Time.at(response["createdAt"]) if response["createdAt"]
+      end
+
+      # One of checkin, shout, or venueless.
+      # @return [String]
+      def type
+        response["type"]
+      end
+
+      # If present, it indicates the checkin was marked as private and not sent to friends
+      def private
+        response["private"]
+      end
+
+      # If the user is not clear from context, then a compact user is present
+      # @return [Foursquared::Response::User]
+      def user
+        Foursquared::Response::User.new(client, response["user"]) if response["user"]
+      end
+
+      # The current location of the user
+      # @return [Hash]
+      def location
+        response["location"]
+      end
+
+      # Optional count and items of checkins from friends checked into the same venue around the same time.
+      # @return [Hash]
+      def overlaps
+        @overlaps = response["overlaps"]
+        @overlaps["items"].map!{|item| Foursquared::Response::Checkin.new(client, item)} if @overlaps
+        @overlaps
+      end
+
+      # Count and items for comments on this checkin.
+      # @return [Hash]
+      def comments
+        response["comments"]
+      end
+
+      # Full list of comments for this checkin
+      # @return [Hash]
+      def full_comments
+        client.get("/checkin/#{id}/comments")["comments"]
+      end
+
+      # Message from check-in, if present and visible to the acting user.
+      # @return [String]
+      def shout
+        response["shout"]
+      end
+
+      # If present, the name and url for the application that created this checkin.
+      # @return [Hash]
+      def source
+        response["source"]
+      end
+
+      # Total and scores for this checkin
+      # @return [Hash]
+      def score
+        response["score"]
+      end
+
+      # Whether the acting user likes the checkin
+      # @return [Boolean]
+      def like?
+        response["like"]
+      end
+
+      # String representation of the time zone where this check-in occurred.
+      # @return [String]
+      def time_zone_offset
+        response["timeZoneOffset"]
+      end
+
+      # The venue of checkin
+      # @return [Foursquared::Response::Venue]
+      def venue
+        Foursquared::Response::Venue.new(client, response["venue"])
+      end
+
+      # Count and items for photos on this checkin
+      # @return [Hash]
+      def photos
+        @photos = response["photos"]
+        @photos["photos"]["items"].map!{|item| Foursquared::Response::Photo.new(client, item)} if response["photos"]
+        @photos
+      end
+
+      # Groups of users who have liked the checkin
+      # @return [Hash]
+      def likes
+        @likes = response["likes"]
+        @likes["groups"].each do |group|
+          group["items"].map!{|item| Foursquared::Response::User.new(client, item)}
+        end
+        @likes
+      end
+
+      # The full groups of users who have liked the checkin
+      # @return [Hash]
+      def full_likes
+        @likes = client.get("/checkins/#{id}/likes")["response"]["likes"]
+        @likes["groups"].each do |group|
+          group["items"].map!{|item| Foursquared::Response::User.new(client, item)}
+        end
+        @likes
+      end
+
+      # The count and items of photos associated with the checkin
+      # @return [Hash]
+      def photos
+        @photos = response["photos"]
+        @photos["items"].map!{|item| Foursquared::Response::Photo.new(client, item)}
+        @photos
+      end
+
+      # The count and items of all the photos associated with the checkin
+      # @return [Hash]
+      def full_photos
+        resp = get("/checkins/#{id}/photos")
+        @photos = resp["photos"]
+        @photos["items"].map!{|item| Foursquared::Response::Photo.new(client, item)}
+        @photos
+      end
+
+      # Add a comment to a check-in 
+      # @param [Hash] options
+      # @option options [String] :text The text of the comment, up to 200 characters.
+      # @option options [String] :mentions Mentions in your check-in.
+      def add_comment options={}
+        response = post("/checkins/#{id}/addcomment", options)["response"]
+        @comment = response["comment"]
+        @comment["user"] = Foursquared::Response::User.new(client, @comment["user"])
+        @comment
+      end
+
+      # Remove commment from check-in
+      # @param [Hash] options
+      # @option options [String] :commentId The ID of the checkin to remove a comment from.
+      # @return [Foursquared::Response::Checkin] The checkin, minus this comment.
+      def delete_comment options={}
+        response = post("/checkins/#{id}/deletecomment", options)["response"]
+        @checkin = Foursquared::Response::Checkin.new(client, response["checkin"])
+      end
+
+      # Like or unlike a checkin
+      # @param [Hash] options
+      # @option options [Integer] :set If 1, like this checkin. If 0 unlike (un-do a previous like) it. Default value is 1.
+      def like options={}
+        response =  post("/checkins/#{id}/like", options)["response"]["likes"]
+        response["groups"].each do |group|
+          group["items"].map!{|item| Foursquared::Response::User.new(client, item)}
+        end
+        response
+      end
+
+    end
+  end
+end

data/lib/foursquared/response/event.rb

@@ -0,0 +1,52 @@
+module Foursquared
+  module Response
+    # Event response
+    class Event
+      attr_reader :client, :response
+      def initialize client, response
+        @client  = client
+        @response = response
+      end
+
+      [:id, :name, :url, :stats].each do |method_name|
+        define_method method_name do
+          response[method_name.to_s] if response
+        end
+      end
+
+      [:venueId, :foreignIds, :categories, :allDay, :timeZone, :unlockMessage].each do |method_name|
+        define_method method_name.to_usym do
+          response[method_name.to_s] if response[method_name.to_s]
+        end
+      end
+
+      # The time at which the event starts
+      # @return [Time]
+      def start_at
+        Time.at response["startAt"] if response["startAt"]
+      end
+
+      # The time at which the event ends
+      # @return [Time]
+      def end_at
+        Time.at response["endAt"] if response["endAt"]
+      end
+
+      # The date at which the event is happening
+      # @return [Time]
+      def date
+        Time.at response["date"] if response["date"]
+      end
+
+      # Users who are present at the event now
+      # @return [Hash]
+      def here_now
+        @here_now = response["hereNow"]
+        @here_now["groups"].each do |group| 
+          group["items"].map!{|user| Foursquared::Response::User.new(client, user)}
+        end
+        @here_now
+      end
+    end
+  end
+end

data/lib/foursquared/response/list.rb

@@ -0,0 +1,199 @@
+module Foursquared
+  module Response
+    # List response
+    class List
+      attr_reader :client, :response
+      def initialize client, response
+        @client = client
+        @response = response
+      end
+
+      # Id of the list
+      # @return [String]
+      def id
+        response["id"]
+      end
+
+      # Name of the list
+      # @return [String]
+      def name
+        response["name"]
+      end
+
+      # The list description
+      # @return [String]
+      def description
+        response["description"]
+      end
+
+      # The type of list
+      # @return [String]
+      def type
+        response["type"]
+      end
+
+      # Whether the list is editable by the acting user
+      # @return [Boolean]
+      def editable?
+        response["editable"]
+      end
+
+      # Whether the list is public
+      # @return [Boolean]
+      def public?
+        response["public"]
+      end
+
+      # Whether this list is editable by the owner's friends
+      # @return [Boolean]
+      def collaborative?
+        response["collaborative"]
+      end
+
+      # The list url
+      # @return [String]
+      def url
+        response["url"]
+      end
+
+      # Whether the acting user is following this list
+      # @return [Boolean]
+      def following?
+        response["following"]
+      end
+
+      # The canonical URL for this list
+      # @return [String]
+      def canonical_url
+        response["canonicalUrl"]
+      end
+
+      # The number of venues on the list visited by the acting user
+      # @return [Integer]
+      def visited_count
+        response["visitedCount"]
+      end
+
+      # The number of unique venues on the list.
+      # @return [Integer]
+      def venue_count
+        response["venueCount"]
+      end
+
+      # The time at which the list was created
+      # @return [Time]
+      def created_at
+        Time.at(response["createdAt"]) if response["createdAt"]
+      end
+
+      # The time at which the list was last updated
+      # @return [Time]
+      def updated_at
+        Time.at(response["updatedAt"]) if response["updatedAt"]
+      end
+
+      # The user who created the list
+      # @return [Foursquared::Response::User]
+      def user
+        Foursquared::Response::User.new(client, response["user"]) if response["user"]
+      end
+
+      # Photo for the list
+      # @return [Foursquared::Response::Photo]
+      def photo
+        Foursquared::Response::Photo.new(client, response["photo"]) if response["photo"]
+      end
+
+      # Count and items of list items on this list.
+      # @return [Hash]
+      def list_items
+        @list_items = response["listItems"]
+        if @list_items and @list_items["items"]
+          @list_items["items"].map!{|item| Foursquared::Response::ListItem.new(client, item)}
+        end
+        @list_items
+      end
+
+      # Suggests photos that may be appropriate for this item. 
+      # @param [Hash] options
+      # @option options [String] :itemId required, The ID of the list item
+      # @return [Hash] Groups user and others containing lists (a count and items of photos) of photos uploaded by this user and uploaded by other users.
+      def suggest_photo options={}
+        @photos = client.get("/lists/#{id}/suggestphoto", options)["response"]["photos"]
+        if @photos
+          @photos.each_key do |key|
+            key["items"].map!{|item| Foursquared::Response::Photo.new(client, item)}
+          end
+        end
+        @photos
+      end
+      # Suggests venues that may be appropriate for this list.
+      # @return [Array] Compact venues that may be appropriate for this list.
+      def suggest_venues
+        @suggested_venues = client.get("/lists/#{id}/suggestvenues")["response"]["suggestedVenues"]
+        @suggested_venues.each do |item|
+          item["venue"] = Foursquared::Response::Venue.new(client, item["venue"])
+        end
+        @suggested_venues
+      end
+
+      # Suggests tips that may be appropriate for a list item
+      # @param [Hash] options
+      # @option options [String] :itemId required, The ID of the list item
+      def suggest_tip options={}
+        @tips = client.get("/lists/#{id}/suggesttip", options)["response"]["tips"]
+        if @tips
+          @tips.each_key do |key|
+            key["items"].map!{|item| Foursquared::Response::Photo.new(client, item)}
+          end
+        end
+        @tips
+      end
+
+      # Add an Item to the list
+      # @param [Hash] options
+      # @option options [String] :venueId A venue to add to the list
+      # @option options [String] :text If the target is a user-created list, this will create a public tip on the venue. If the target is /userid/todos, the text will be a private note that is only visible to the author.
+      # @option options [String] :url  If adding a new tip via text, this can associate a url with the tip.
+      # @option options [String] :tipId Used to add a tip to a list. Cannot be used in conjunction with the text and url fields.
+      # @option options [String] :tipId Used to add a tip to a list. Cannot be used in conjunction with the text and url fields.
+      # @option options [String] :listId Used in conjuction with itemId, the id for a user created or followed list as well as one of USER_ID/tips, USER_ID/todos, or USER_ID/dones.
+      # @option options [String] :itemId Used in conjuction with listId, the id of an item on that list that we wish to copy to this list.
+      # @return [Foursquared::Response::ListItem] The newly added list item
+      def add_item options={}
+        @item = client.post("/lists/#{id}/additem", options)["response"]["item"]
+        Foursquared::Response::ListItem.new(client, @item) if @item
+      end
+
+      # List Followers
+      # @return [Hash] A count and items of users following this list.
+      def followers
+        @followers = client.get("/lists/#{id}/followers")["response"]["followers"]
+        if @followers and @followers["items"]
+          @followers["items"].map!{|item| Foursquared::Response::User.new(client, item)}
+        end
+        @followers
+      end
+
+      # Delete an item from the list
+      # @param [Hash] options
+      # @option options [String] :venueId ID of a venue to be deleted.
+      # @option options [String] :itemId ID of the item to delete.
+      # @option options [String] :tipId id of a tip to be deleted.
+      # @return [Hash] A count and items of list items that were just deleted.
+      def delete_item options={}
+        @items = client.post("/lists/#{id}/deleteitem", options)["response"]["items"]
+        @items["items"].map!{|item| Foursquared::Response::ListItem.new(client, item)}
+        @list_items
+      end
+
+      # Count and items of users who have edited this list
+      # @return [Hash]
+      def collaborators
+        @collaborators = response["collaborators"]
+        @collaborators["items"].map!{|item| Foursquared::Response::User.new(client, item)}
+        @collaborators
+      end
+    end
+  end
+end

data/lib/foursquared/response/list_item.rb

@@ -0,0 +1,63 @@
+module Foursquared
+  module Response
+    # List item response
+    class ListItem
+      attr_reader :client, :response
+
+      def initialize client, response
+        @client = client
+        @response = response
+      end
+
+
+      # ID of the list item
+      # @return [String]
+      def id
+        response["id"]
+      end
+
+      # The time at which the list item was created
+      # @return [Time]
+      def created_at
+        Time.at(response["createdAt"]) if response["createdAt"]
+      end
+
+      # Tip, if present, in the list
+      # @return [Foursquared::Response::Tip]
+      def tip
+        Foursquared::Response::Tip.new(client, response["tip"]) if response["tip"]
+      end
+
+      # Venue, if present, in the list
+      # @return [Foursquared::Response::Venue]
+      def venue
+        Foursquared::Response::Venue.new(client, response["venue"]) if response["venue"]
+      end
+
+      # Text entered by the user when creating this item
+      # @return [String]
+      def note
+        response["note"]
+      end
+
+      # User who added this item to the current list
+      # @return [Foursquared::Response::User]
+      def user
+        Foursquared::Response::User.new(client, response["user"]) if response["user"]
+      end
+
+      # A photo for this list item
+      # @return [Foursquared::Response::Photo]
+      def photo
+        Foursquared::Response::Photo.new(client, response["photo"]) if response["photo"]
+      end
+
+      # Information about what other lists this item appears on
+      # @return [Array] array of compact lists
+      def listed
+        response["listed"].collect{|item| Foursquared::Response::List.new(item)} if response["listed"]
+      end
+
+    end
+  end
+end