foursquared 0.0.4

data/lib/foursquared/venues.rb

@@ -0,0 +1,217 @@
+# Foursquared module
+module Foursquared
+  # Venues module
+  module Venues
+
+    # Venue detail
+    # @param [String] venue_id ID of venue to retrieve
+    # @return [Foursquared::Response::Venue]
+    def venue venue_id
+      response = get("/venues/#{venue_id}")["response"]
+      @venue = Foursquared::Response::Venue.new(self, response["venue"])
+    end
+
+    # Add a venue
+    # @param [Hash] options
+    # @option options [String] :name required The name of the venue
+    # @option options [String] :address The address of the venue
+    # @option options [String] :crossStreet The nearest intersecting street or streets.
+    # @option options [String] :city The city name where this venue is.
+    # @option options [String] :state The nearest state or province to the venue.
+    # @option options [String] :zip The zip or postal code for the venue.
+    # @option options [String] :phone The phone number of the venue.
+    # @option options [String] :twitter The twitter handle of the venue.
+    # @option options [String] :ll required Latitude and longitude of the venue, as accurate as is known.
+    # @option options [String] :primaryCategoryId The ID of the category to which you want to assign this venue.
+    # @option options [String] :description A freeform description of the venue, up to 300 characters.
+    # @option options [String] :url The url of the homepage of the venue.
+    # @option options [Boolean] :ignoreDuplicates A boolean flag telling the server to ignore duplicates and force the addition of this venue.
+    # @option options [String] :ignoreDuplicatesKey Required if ignoreDuplicates is true. This key will be available in the response of the HTTP 409 error of the first (failed) attempt to add venue.
+    def add_venue options={}
+      response = post("/venues/add", options)["response"]
+      Foursquared::Response::Venue.new(self, response["venue"])
+    end
+
+    # Returns a hierarchical list of categories applied to venues.
+    # @return [Array<Foursquared::Response::Category>]
+    def venue_categories
+      response = get("/venues/categories")["response"]
+      response["categories"].collect{|category| Foursquared::Response::Category.new(self, category) }
+    end
+
+    # Explore Recommended and Popular Venues
+    # @param [Hash] options
+    # @option options [String] :ll required unless :near is provided. Latitude and longitude of the user's location.
+    # @option options [String] :near required unless :ll is provided. A string naming a place in the world
+    # @option options [String] :llAcc Accuracy of latitude and longitude, in meters.
+    # @option options [String] :alt Altitude of the user's location, in meters.
+    # @option options [String] :altAcc Accuracy of the user's altitude, in meters.
+    # @option options [String] :radius Radius to search within, in meters.
+    # @option options [String] :section One of food, drinks, coffee, shops, arts, outdoors, sights, trending or specials, nextVenues or topPicks
+    # @option options [String] :query A term to be searched against a venue's tips, category, etc.
+    # @option options [Integer] :limit Number of results to return, up to 50.
+    # @option options [Integer] :offset Used to page through results.
+    # @option options [String] :novelty Pass new or old to limit results to places the acting user hasn't been or has been, respectively.
+    # @option options [String] :friendVisits Pass visited or notvisited to limit results to places the acting user's friends have or haven't been, respectively.
+    # @option options [String] :venuePhotos Boolean flag to include a photo in the response for each venue, if one is available (1/0)
+    # @option options [String] :lastVenue A venue ID to use in combination with the intent=nextVenues parameter, which returns venues users often visit after a given venue.
+    def explore_venues options={}
+      response = get("/venues/explore", options)["response"]
+      response["groups"].each do |group|
+        response["items"].each do |item|
+          item["venue"] = Foursquared::Response::Venue.new(self, item["venue"])
+          item["tips"].map!{|tip| Foursquared::Response::List.new(self, tip)}
+        end
+      end
+      response
+    end
+
+    # Get a list of venues the current user manages.
+    # @return [Array<Foursquared::Response::Venue>] An array of compact venues the user manages.
+    def managed_venues
+      response = get("/venues/managed")["response"]
+      @venues = response["venues"].collect{|venue| Foursquared::Response::Venue.new(self, venue)}
+    end
+
+    # Returns a list of venues near the current location, optionally matching a search term.
+    # @param [Hash] options
+    # @option options [String] :ll required unless :near is provided. Latitude and longitude of the user's location.
+    # @option options [String] :near required unless :ll is provided. A string naming a place in the world
+    # @option options [String] :llAcc Accuracy of latitude and longitude, in meters.
+    # @option options [String] :alt Altitude of the user's location, in meters.
+    # @option options [String] :altAcc Accuracy of the user's altitude, in meters.
+    # @option options [String] :radius Radius to search within, in meters.
+    # @option options [String] :query A search term to be applied against venue names.
+    # @option options [Integer] :limit Number of results to return, up to 50.
+    # @option options [String] :intent Checkout https://developer.foursquare.com/docs/venues/search for the possible values
+    # @option options [String] :sw Checkout https://developer.foursquare.com/docs/venues/search for details
+    # @option options [String] :ne Checkout https://developer.foursquare.com/docs/venues/search for details
+    # @option options [String] :categoryId A comma separated list of categories to limit results to
+    # @option options [String] :url A third-party URL which we will attempt to match against our map of venues to URLs
+    # @option options [String] :providerId Identifier for a known third party that is part of our map of venues to URLs
+    # @option options [String] :linkedId Identifier used by third party specified in providerId, which we will attempt to match against our map of venues to URLs
+    # @return [Array] An array of compact venues.
+    def search_venues options={}
+      response = get("/venues/search", options)["response"]
+      @venues = response["venues"].collect{|venue| Foursquared::Response::Venue.new(self, venue)}
+    end
+
+    # Returns a list of venues near the current location with the most people currently checked in.
+    # @param [Hash] options
+    # @option options [String] :ll required Latitude and longitude of the user's location.
+    # @option options [Integer] :limit Number of results to return, up to 50.
+    # @option options [Integer] :radius Radius in meters, up to approximately 2000 meters.
+    # @return [Array] An array of venues that are currently trending, with their hereNow populated.
+    def trending_venues options={}
+      response = get("/venues/trending", options)["response"]
+      @venues = response["venues"].collect{|venue| Foursquared::Response::Venue.new(self, venue)}
+    end
+
+    # Gives information about the current events at a place.
+    # @param [String] venue_id required The venue id for which events are being requested.
+    # @return [Hash] A count and items of event items. Also includes a "summary" string describing the set of events at the venue.
+    def venue_events venue_id
+      response = get("/venues/#{venue_id}/events")["response"]
+      @events = response["events"]
+      @events["items"].map!{|item| Foursquared::Response::Event.new(self, item)}
+      @events
+    end
+
+    # Returns hours for a venue.
+    # @param [String] venue_id required The venue id for which hours are being requested.
+    # @return [Array] An array of timeframes of hours.
+    def venue_hours venue_id
+      response = get("/venues/#{venue_id}/hours")["response"]["hours"]
+    end
+
+    # Users who have liked a venue
+    # @param [String] venue_id required The venue id for which hours are being requested.
+    # @return [Hash] A count and groups of users who like this venue
+    def venue_likes venue_id
+      response = get("/venues/#{venue_id}/likes")["response"]["likes"]
+      response["groups"].each do |group|
+        response["items"].map!{|item| Foursquared::Response::User.new(self, item)}
+      end
+      response
+    end
+
+    # The lists that this venue appears on.
+    # @param [String] venue_id required The venue id for which hours are being requested.
+    # @param [Hash] options
+    # @option options [String] :group Can be created, edited, followed, friends, other.
+    # @option options [Integer] :limit Number of results to return, up to 200.
+    # @option options [Integer] :offset Used to page through results. Must specify a group
+    # @return [Hash]
+    def venue_lists venue_id, options={}
+      response = get("/venues/#{venue_id}/lists", options)["response"]["lists"]
+      if response["groups"]
+        response["groups"].each do |group|
+          group["items"].map!{|item| Foursquared::Response::Lists.new(self, item)} if group["items"]
+        end
+      else
+        response["items"].map!{|item| Foursquared::Response::Lists.new(self, item)}
+      end
+      response
+    end
+
+    # Returns photos for a venue.
+    # @param [String] venue_id required The venue id for which hours are being requested.
+    # @param [Hash] options
+    # @option options [String] :group required  Pass checkin for photos added by friends (including on their recent checkins). Pass venue for public photos added to the venue by non-friends. Use multi to fetch both.
+    # @option options [Integer] :limit Number of results to return, up to 200.
+    # @option options [Integer] :offset Used to page through results
+    # @return [Hash] A count and items of photos
+    def venue_photos venue_id, options={}
+      response = get("/venues/#{venue_id}/photos", options)["response"]["photos"]
+      response["items"].map!{|item| Foursquared::Response::Photo.new(self, item)}
+      response
+    end
+
+    # Returns a list of venues similar to the specified venue.
+    # @param [String] venue_id required The venue you want similar venues for.
+    # @return [Hash] A count and items of similar venues.
+    def venue_likes venue_id
+      response = get("/venues/#{venue_id}/similar")["response"]["similarVenues"]
+      response["items"].map!{|item| Foursquared::Response::Venue.new(self, item)}
+      response
+    end
+
+    # Flag a Venue
+    # @param [String] venue_id required The venue id for which hours are being requested.
+    # @param [Hash] options
+    # @option options [String] :problem required One of mislocated, closed, duplicate, inappropriate, doesnt_exist, event_over
+    # @option options [String] :venueId ID of the duplicated venue (for problem duplicate)
+    def flag_venue venue_id, options={}
+      response = post("/venues/#{venue_id}/flag", options)
+    end
+
+    # Like or unlike a venue
+    # @param [String] venue_id required The venue id for which hours are being requested.
+    # @param [Hash] options
+    # @option options [Integer] :set If 1, like this venue. If 0 unlike (un-do a previous like) it. Default value is 1.
+    # @return [Hash] Updated count and groups of users who like this venue
+    def like_venue venue_id, options={}
+      response = post("/venues/#{venue_id}/like", options)["response"]["likes"]
+      response["groups"].each do |group|
+        response["items"].map!{|item| Foursquared::Response::User.new(self, item)}
+      end
+      response
+    end
+
+    # Propose an Edit to a Venue
+    # @param [Hash] options
+    # @option options [String] :name The name of the venue
+    # @option options [String] :address The address of the venue
+    # @option options [String] :crossStreet The nearest intersecting street or streets.
+    # @option options [String] :city The city name where this venue is.
+    # @option options [String] :state The nearest state or province to the venue.
+    # @option options [String] :zip The zip or postal code for the venue.
+    # @option options [String] :phone The phone number of the venue.
+    # @option options [String] :ll Latitude and longitude of the venue, as accurate as is known.
+    # @option options [String] :primaryCategoryId The ID of the category to which you want to assign this venue.
+    # @option options [String] :hours The hours for the venue, as a semi-colon separated list of open segments and named segments
+    def propose_venue_edit venue_id, options={}
+      response = post("/venues/#{venue_id}", options)
+    end
+  end
+end

data/lib/foursquared/version.rb

@@ -0,0 +1,4 @@
+module Foursquared
+  # The gem version
+  VERSION = "0.0.4"
+end

data/lib/foursquared.rb

@@ -0,0 +1,47 @@
+require 'httmultiparty'
+require 'json'
+directory = File.expand_path(File.dirname(__FILE__))
+require 'core_ext/symbol'
+module Foursquared
+  class << self
+
+    
+    attr_accessor :client_id, :client_secret, :api_version, :ssl, :access_token, :locale 
+
+
+    def configure
+      yield self
+      true
+    end
+  end
+
+  # require 'foursquare2/campaigns'
+  require 'foursquared/users'
+  require 'foursquared/photos'
+  require 'foursquared/lists'
+  require 'foursquared/checkins'
+  require 'foursquared/venues'
+  require 'foursquared/badges'
+  require 'foursquared/events'
+  require 'foursquared/pages'
+  require 'foursquared/specials'
+  require 'foursquared/tips'
+  require 'foursquared/oauth/client'
+  require 'foursquared/client'
+  require 'foursquared/response/user'
+  require 'foursquared/response/list'
+  require 'foursquared/response/list_item'
+  require 'foursquared/response/photo'
+  require 'foursquared/response/venue'
+  require 'foursquared/response/checkin'
+  require 'foursquared/response/badge'
+  require 'foursquared/response/badge_group'
+  require 'foursquared/response/event'
+  require 'foursquared/response/category'
+  require 'foursquared/response/special'
+  require 'foursquared/response/tip'
+  require 'foursquared/error'
+
+end
+
+include Foursquared::Response

data/spec/foursquared/badges_spec.rb

@@ -0,0 +1,82 @@
+require 'spec_helper'
+require 'foursquared/badges'
+
+describe Foursquared::Badges do
+
+  let(:user_badges) do
+    YAML.load(%{
+      meta:
+        code: 200
+      response:
+        sets:
+          groups:
+            - type: "all"
+              name: "All Badges"
+              image:
+                prefix: "https://foursquare.com/img/badge/"
+                sizes:
+                - 24
+                - 32
+              name: "/allbadges.png"
+              items:
+              - "508b859de4b01167eaad0476"
+              - "5066d689e4b0ca8b1f1c1804"
+        badges:
+          4f7a7d3ae4b02f1b2c869efb:
+            id: "4f7a7d3ae4b02f1b2c869efb"
+            badgeId: "4c4f08667a0803bbaa202ab7"
+        defaultSetType: "foursquare"
+      }
+    )
+  end
+
+  let(:badge) do
+    YAML.load(%{
+        meta:
+          code: 200
+        response:
+          badge:
+            id: "4f7a7d3ae4b02f1b2c869efb"
+            badgeId: "4c4f08667a0803bbaa202ab7"
+            name: "Newbie"
+            unlockMessage: "You unlocked the Newbie badge!"
+            description: "Your first check-in!"
+            badgeText: "Your first check-in!"
+            image:
+              prefix: "https://playfoursquare.s3.amazonaws.com/badge/"
+              sizes:
+              - 57
+                114
+              name: "/newbie.png"
+            unlocks:
+            - checkins:
+              - id: "4f7a7d3ae4b02f1b2c869eef"
+      }
+    )
+  end
+
+  subject { foursquared_test_client }
+
+  before(:each) do
+    stub_request(:get, "https://api.foursquare.com/v2/users/self/badges?oauth_token=TestToken&v=#{Time.now.strftime("%Y%m%d")}").to_return(:status => 200, :body => user_badges.to_json, :headers => {})
+    stub_request(:get, "https://api.foursquare.com/v2/badges/4f7a7d3ae4b02f1b2c869efb?oauth_token=TestToken&v=#{Time.now.strftime("%Y%m%d")}").
+         to_return(:status => 200, :body => badge.to_json, :headers => {})
+    @user_badges = subject.user_badges("self")
+  end
+  describe "#user_badges" do
+    describe "sets" do
+      it "should give the sets of badge types" do
+        @user_badges["sets"]["groups"].should each { |group|
+          group.should be_a(Foursquared::Response::BadgeGroup)
+        }
+      end
+    end
+    describe "badges" do
+      it "should give the badges' details" do
+        @user_badges["badges"].keys.should each {|badge_id|
+          @user_badges["badges"][badge_id].should be_a(Foursquared::Response::Badge)
+        }
+      end
+    end
+  end
+end

data/spec/foursquared/events_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+require 'foursquared/events'
+
+describe Foursquared::Events do
+  let(:event) do
+    YAML.load(%{
+        meta:
+          code: 200
+        response:
+          event:
+            venueId: "40afe980f964a5203bf31ee3"
+            id: "5093492991d4a3bd84c82646"
+            name: "Skyfall: The IMAX Experience"
+            foreignIds:
+              count: 1
+              items:
+              - domain: "fandango.com"
+                id: "5826-153164"
+            hereNow:
+              count: 0
+              groups:
+              - type: "friends"
+                name: "Friends here"
+                count: 0
+                items: []
+              - type: "others"
+                name: "Other people here"
+                count: 0
+                items: []
+            allDay: true
+            date: 1355115600
+            timeZone: "America/New_York"
+            stats:
+              checkinsCount: 9
+              usersCount: 9
+            url: "https://foursquare.com/events/movies?theater=AAORE&movie=153164&wired=true"
+      }
+    )
+  end
+  subject { foursquared_test_client }
+
+  before :each do
+    stub_request(:get, "https://api.foursquare.com/v2/events/5093492991d4a3bd84c82646?oauth_token=TestToken&v=#{Time.now.strftime("%Y%m%d")}").to_return(:status => 200, :body => event.to_json, :headers => {})
+  end
+
+  it "should return the event with the given id" do
+    subject.event("5093492991d4a3bd84c82646").should be_a Foursquared::Response::Event
+  end
+
+end

data/spec/foursquared/oauth/client_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'foursquared/oauth/client'
+require 'pp'
+require 'httparty'
+describe Foursquared::OAuth::Client do
+  before :each do
+    @client = Foursquared::OAuth::Client.new("abc", "S2TJO3KFFXZSXS44WKVGWGKH204U455MI3P0JUV0ADTWRORZ","http://localhost")
+  end
+
+  describe "#authorize_url" do
+    it "includes the client_id" do
+      expect(@client.authorize_url).to include('client_id=abc')
+    end
+
+    it "includes the type" do
+      expect(@client.authorize_url).to include('response_type=code')
+    end
+
+    it "includes the redirect_uri" do
+      cb = 'http://localhost'
+      expect(@client.authorize_url).to include("redirect_uri=#{Rack::Utils.escape(cb)}")
+    end
+  end
+end

data/spec/foursquared/pages_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+require 'foursquared/pages'
+
+describe Foursquared::Pages do
+
+  let(:page) do
+    YAML.load(%{
+      meta:
+        code: 200
+      response:
+        user:
+          id: "1070527"
+          firstName: "Starbucks"
+          type: "chain"
+          followers:
+            groups:
+            - type: "friends"
+              name: "Liked by 2 friends"
+              items:
+              - id: "36332988"
+                firstName: "Sree"
+                lastName: "Ram"
+                relationship: "friend"
+              - id: "38283243"
+                firstName: "Vineeth"
+                lastName: "Nix"
+                relationship: "friend"
+      }
+    )
+  end
+
+  subject { foursquared_test_client }
+
+  before :each do
+    stub_request(:get, "https://api.foursquare.com/v2/pages/1070527?oauth_token=TestToken&v=#{Time.now.strftime("%Y%m%d")}").to_return(:body => page.to_json)
+  end
+
+  it "should return the page with the id" do
+    subject.page(1070527).should be_a(Foursquared::Response::User)
+  end
+
+end

data/spec/foursquared/photos_spec.rb

@@ -0,0 +1,41 @@
+  require 'spec_helper'
+require 'foursquared/response/user'
+require 'foursquared/response/photo'
+require 'foursquared/client'
+require 'foursquared/photos'
+
+describe Foursquared::Photos do
+  let(:photo) do
+    YAML.load(%{
+      meta:
+        code: 200
+      response:
+        photo:
+          id: "4d0fb8162d39a340637dc42b"
+          createdAt: 1292875798
+          source:
+            name: "foursquare for iPhone"
+            url: "https://foursquare.com/download/#/iphone"
+          prefix: "https://irs0.4sqi.net/img/general/"
+          suffix: "/UYU54GYOCURPAUYXH5V2U3EOM4DCX4VZPT3YOMN43H555KU2.jpg"
+          width: 540
+          height: 720
+          user:
+            id: "2102"
+            firstName: "Kushal"
+            lastName: "D."
+            photo:
+              prefix: "https://irs1.4sqi.net/img/user/"
+              suffix: "/2102_1242573242.jpg"
+          visibility: "public"
+      }
+    )
+  end
+
+  before :each do
+    stub_request(:get, "https://api.foursquare.com/v2/photos/12345?oauth_token=TestToken&v=#{Time.now.strftime("%Y%m%d")}").
+         to_return(:status => 200, :body => photo.to_json, :headers => {})
+  end
+
+
+end

data/spec/foursquared/response/badge_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+require 'foursquared/response/badge'
+
+describe Foursquared::Response::Badge do
+
+  let(:badge) do
+    YAML.load(%{
+        meta:
+          code: 200
+        response:
+          badge:
+            id: "4f7a7d3ae4b02f1b2c869efb"
+            badgeId: "4c4f08667a0803bbaa202ab7"
+            name: "Newbie"
+            unlockMessage: "You unlocked the Newbie badge!"
+            description: "Your first check-in!"
+            badgeText: "Your first check-in!"
+            image:
+              prefix: "https://playfoursquare.s3.amazonaws.com/badge/"
+              sizes:
+              - 57
+                114
+              name: "/newbie.png"
+            unlocks:
+            - checkins:
+              - id: "4f7a7d3ae4b02f1b2c869eef"
+      }
+    )
+  end
+  subject {foursquared_test_client.badge("4f7a7d3ae4b02f1b2c869efb")}
+
+  before :each do
+    stub_request(:get, "https://api.foursquare.com/v2/badges/4f7a7d3ae4b02f1b2c869efb?oauth_token=TestToken&v=#{Time.now.strftime("%Y%m%d")}").to_return(:status => 200, :body => badge.to_json, :headers => {})
+  end
+
+  it "should return the badge's id" do
+    subject.id.should == "4f7a7d3ae4b02f1b2c869efb"
+  end
+
+end

data/spec/foursquared/response/category_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+require 'foursquared/response/category'
+
+describe Foursquared::Response::Category do
+
+  let(:event_category) do
+    YAML.load(%{
+          id: "4dfb90c6bd413dd705e8f897"
+          name: "Movies"
+          pluralName: "Movies"
+          shortName: "Movie"
+          icon:
+            prefix: "https://foursquare.com/img/categories_v2/arts_entertainment/movietheater_"
+            suffix: ".png"
+          categories:
+          - id: "4e132f48bd41026cd50e8f8e"
+            name: "Baseball Games"
+            pluralName: "Baseball Games"
+            shortName: "Baseball"
+            icon:
+              prefix: "https://foursquare.com/img/categories_v2/arts_entertainment/stadium_baseball_"
+              suffix: ".png"
+            categories: []
+      }
+    )
+  end
+
+  subject {Foursquared::Response::Category.new(event_category)}
+
+  describe "#icon" do
+    it "should have prefix, suffix and urls" do
+      subject.icon.keys.should ~ ["urls", "prefix", "suffix", ]
+    end
+
+    describe "urls" do
+      it "should have urls for 32x32, 64x64 and 256x256 icons" do
+        subject.icon["urls"].keys.should ~ ["32x32", "64x64", "256x256"]
+      end
+    end
+
+  end
+
+  it "should give the sub categories of the category" do
+    subject.categories.should each { |category|
+      category.should be_a(Foursquared::Response::Category)
+    }
+  end
+end