foursquare_venues 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in foursquare_venues.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/foursquare_venues.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "foursquare_venues/version"
+
+Gem::Specification.new do |s|
+  s.name        = "foursquare_venues"
+  s.version     = FoursquareVenues::VERSION
+  s.authors     = ["Tres Trantham"]
+  s.email       = ["tres@trestrantham.com"]
+  s.homepage    = ""
+  s.summary     = %q{A Foursquare Venues API Wrapper}
+  s.description = %q{A Foursquare Venues API Wrapper}
+
+  s.rubyforge_project = "foursquare_venues"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.licenses = ["MIT"]
+end

data/lib/foursquare_venues/base.rb

@@ -0,0 +1,57 @@
+module FoursquareVenues
+  class Base
+    API = "https://api.foursquare.com/v2/venues/"
+
+    def initialize(*args)
+      case args.size
+      when 2
+        @client_id, @client_secret = args
+      else
+        raise ArgumentError, "You need to pass a client_id and client_secret"
+      end
+    end
+
+    def venues
+      FoursquareVenues::VenueProxy.new(self)
+    end
+
+    def get(path, params={})
+      params = camelize(params)
+      FoursquareVenues.log("GET #{API + path}")
+      FoursquareVenues.log("PARAMS: #{params.inspect}")
+			params.merge!(:client_id => @client_id, :client_secret => @client_secret)
+      response = JSON.parse(Typhoeus::Request.get(API + path, :params => params).body)
+      FoursquareVenues.log(response.inspect)
+      error(response) || response["response"]
+    end
+
+    private
+
+    def camelize(params)
+      params.inject({}) { |o, (k, v)|
+        o[k.to_s.gsub(/(_[a-z])/) { |m| m[1..1].upcase }] = v
+        o
+      }
+    end
+
+    def error(response)
+      case response["meta"]["errorType"]
+      when nil
+        # It's all good.
+      when "deprecated"
+        FoursquareVenues.log(FoursquareVenues::ERRORS[response['meta']['errorType']])
+        nil
+      else
+        error_type = response['meta']['errorType']
+        case error_type
+        when "invalid_auth"
+          raise FoursquareVenues::InvalidAuth.new(FoursquareVenues::ERRORS[error_type])
+        when "server_error"
+          raise FoursquareVenues::ServiceUnavailable.new(FoursquareVenues::ERRORS[error_type])
+        else
+          raise FoursquareVenues::Error.new(FoursquareVenues::ERRORS[error_type])
+        end
+      end
+    end
+  end
+end

data/lib/foursquare_venues/category.rb

@@ -0,0 +1,30 @@
+module FoursquareVenues
+  class Category
+    
+    def initialize(json)
+      @json = json
+    end
+    
+    def name
+      @json["name"]
+    end
+    
+    def plural_name
+      @json["pluralName"]
+    end
+    
+    def icon
+      @json["icon"]
+    end
+    
+    # array
+    def parents
+      @json["parents"]
+    end
+    
+    def primary?
+      @json["primary"] == true
+    end
+    
+  end
+end

data/lib/foursquare_venues/location.rb

@@ -0,0 +1,47 @@
+# https://developer.foursquare.com/docs/responses/venue.html
+
+module FoursquareVenues
+  class Location
+    
+    def initialize(json)
+      @json = json
+    end
+    
+    def address
+      @json["address"]
+    end
+    
+    def cross_street
+      @json["crossStreet"]
+    end
+    
+    def city
+      @json["city"]
+    end
+    
+    def state
+      @json["state"]
+    end
+    
+    def postal_code
+      @json["postalCode"]
+    end
+    
+    def country
+      @json["country"]
+    end
+    
+    def lat
+      @json["lat"]
+    end
+    
+    def lng
+      @json["lng"]
+    end
+    
+    def distance
+      @json["distance"]
+    end
+    
+  end
+end

data/lib/foursquare_venues/photo.rb

@@ -0,0 +1,52 @@
+module FoursquareVenues
+  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
+    
+    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_venues/venue.rb

@@ -0,0 +1,102 @@
+module FoursquareVenues
+  class Venue
+    attr_reader :json
+
+    def initialize(foursquare, json)
+      @foursquare, @json = foursquare, json
+    end
+    
+    def fetch
+      @json = @foursquare.get("#{id}")["venue"]
+      self
+    end
+
+    def id
+      @json["id"]
+    end
+
+    def name
+      @json["name"]
+    end
+
+    def contact
+      @json["contact"]
+    end
+
+    def location
+      FoursquareVenues::Location.new(@json["location"])
+    end
+
+    def categories
+      @categories ||= @json["categories"].map { |hash| FoursquareVenues::Category.new(hash) }
+    end
+
+    def verified?
+      @json["verified"]
+    end
+
+    def checkins_count
+      @json["stats"]["checkinsCount"]
+    end
+
+    def users_count
+      @json["stats"]["usersCount"]
+    end
+
+    def todos_count
+      @json["todos"]["count"]
+    end
+    
+    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
+		# optionally accepts a size to return 64px or 256px icon
+    def icon(size = '')
+			icon_url = primary_category ? primary_category.icon : "https://foursquare.com/img/categories/none.png"
+			# return "https://foursquare.com/img/categories/none.png"
+			if ['64','256'].include?(size)
+				icon_url = icon_url.split('.png').first + '_' + size + '.png'
+			end
+			icon_url
+    end
+    
+    def short_url
+      @json["shortUrl"]
+    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|
+        FoursquareVenues::Photo.new(@foursquare, item)
+      end
+    end
+    
+    # https://developer.foursquare.com/docs/venues/photos.html
+    def all_photos(options={:group => "venue"})
+      @foursquare.get("#{id}/photos", options)["photos"]["items"].map do |item|
+        FoursquareVenues::Photo.new(@foursquare, item)
+      end
+    end
+    
+    # count the people who have checked-in at the venue in the last two hours
+    def here_now_count
+      fetch unless @json.has_key?("hereNow")
+      @json["hereNow"]["count"]
+    end
+    
+  end
+end

data/lib/foursquare_venues/venues.rb

@@ -0,0 +1,50 @@
+module FoursquareVenues
+  class Venues
+    def initialize(*args)
+      case args.size
+      when 2
+        @client_id, @client_secret = args
+				@foursquare = FoursquareVenues::Base.new(@client_id, @client_secret)
+      else
+        raise ArgumentError, "You need to pass a client_id and client_secret"
+      end
+    end
+
+    def find(id)
+      FoursquareVenues::Venue.new(@foursquare, @foursquare.get("#{id}")["venue"])
+    end
+
+    def search(options={})
+      raise ArgumentError, "You must include :ll" unless options[:ll]
+      response = @foursquare.get('search', options)["groups"].inject({}) do |venues, group|
+        venues[group["type"]] ||= []
+        venues[group["type"]] += group["items"].map do |json|
+          FoursquareVenues::Venue.new(@foursquare, json)
+        end
+        venues
+      end
+    end
+
+    def trending(options={})
+      search_group("trending", options)
+    end
+
+    def favorites(options={})
+      search_group("favorites", options)
+    end
+
+    def nearby(options={})
+      search_group("nearby", options)
+    end
+
+    private
+
+    def search_group(name, options)
+      raise ArgumentError, "You must include :ll" unless options[:ll]
+      response = @foursquare.get('search', options)["groups"].detect { |group| group["type"] == name }
+      response ? response["items"].map do |json|
+        FoursquareVenues::Venue.new(@foursquare, json)
+      end : []
+    end
+  end
+end

data/lib/foursquare_venues/version.rb

@@ -0,0 +1,3 @@
+module FoursquareVenues
+  VERSION = "0.0.1"
+end

data/lib/foursquare_venues.rb

@@ -0,0 +1,39 @@
+require "typhoeus"
+require "json"
+require "foursquare_venues/version"
+require "foursquare_venues/base"
+require "foursquare_venues/venues" # proxy for Venue
+require "foursquare_venues/venue"
+require "foursquare_venues/location"
+require "foursquare_venues/category"
+require "foursquare_venues/photo"
+
+module FoursquareVenues
+  class Error < StandardError ; end
+  class InvalidAuth < FoursquareVenues::Error; end
+  class ServiceUnavailable < FoursquareVenues::Error; end
+
+  def self.verbose=(setting)
+    @verbose = setting
+  end
+
+  def self.verbose?
+    @verbose
+  end
+
+  def self.log(msg)
+    return unless verbose?
+    puts "[foursquare_venues] #{msg}"
+  end
+
+  ERRORS = {
+    "invalid_auth" => "OAuth token was not provided or was invalid.",
+    "param_error" => "A required parameter was missing or a parameter was malformed. This is also used if the resource ID in the path is incorrect.",
+    "endpoint_error" => "The requested path does not exist.",
+    "not_authorized" => "Although authentication succeeded, the acting user is not allowed to see this information due to privacy restrictions.",
+    "rate_limit_exceeded" => "Rate limit for this hour exceeded.",
+    "deprecated" => "Something about this request is using deprecated functionality, or the response format may be about to change.",
+    "server_error" => "Server is currently experiencing issues. Check status.foursquare.com for udpates.",
+    "other" => "Some other type of error occurred."
+  }
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: foursquare_venues
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tres Trantham
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-07-08 00:00:00 Z
+dependencies: []
+
+description: A Foursquare Venues API Wrapper
+email: 
+- tres@trestrantham.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README
+- Rakefile
+- foursquare_venues.gemspec
+- lib/foursquare_venues.rb
+- lib/foursquare_venues/base.rb
+- lib/foursquare_venues/category.rb
+- lib/foursquare_venues/location.rb
+- lib/foursquare_venues/photo.rb
+- lib/foursquare_venues/venue.rb
+- lib/foursquare_venues/venues.rb
+- lib/foursquare_venues/version.rb
+homepage: ""
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: foursquare_venues
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: A Foursquare Venues API Wrapper
+test_files: []
+