gowalla-ruby 0.0.1 → 0.0.5

data/Manifest

@@ -3,15 +3,25 @@ README.markdown
 Rakefile
 init.rb
 lib/gowalla.rb
+lib/gowalla/activity.rb
 lib/gowalla/address.rb
 lib/gowalla/base.rb
+lib/gowalla/category.rb
 lib/gowalla/checkin.rb
+lib/gowalla/event.rb
+lib/gowalla/map_bound.rb
 lib/gowalla/spot.rb
 lib/gowalla/stamp.rb
+lib/gowalla/top_10.rb
 lib/gowalla/user.rb
+test/fixtures/event.json
+test/fixtures/spot.json
+test/fixtures/spots.json
 test/fixtures/stamps.json
 test/fixtures/user.json
 test/helper.rb
+test/test_event.rb
+test/test_spot.rb
 test/test_stamp.rb
 test/test_user.rb
 Manifest

data/README.markdown

@@ -1,33 +1,36 @@
 gowalla-ruby
 ===
 
-Gowalla API wrapper for Ruby.
+Gowalla API wrapper for Ruby. Not yet intended for production use, thought it is functional and more tests are always being added.
 
 Install
 ===
 gem install gowalla-ruby
+config.gem 'gowalla-ruby', :lib => 'gowalla' # in environment.rb
+
+or 
+
+./script/plugin install git@github.com:webandy/gowalla-ruby.git
 
 Usage
 ===
 
-    # for Rails as a plugin
-    >> ./script/plugin install git@github.com:webandy/gowalla-ruby.git
-    >> ./script/console
-    >> user = Gowalla::User.find('andyatkinson')
-    >> user.stamps
+    user = Gowalla::User.find('andyatkinson')
+    user.stamps
+    spot = Gowalla::Spot.find(23534)
+    spot.checkins_count
+    spot.creator                        # returns a Gowalla::User
+    spot.top_10
+    spot.top_10.first.user              # returns a Gowalla::User
+    spot.events.activity                # see all checkins
+    spot.events.activity.first.user     # see the user from a checkin
     
-    # for Rails as a gem
-    >> gem install gowalla-ruby
-    >> config.gem 'gowalla', :lib => 'gowalla-ruby' # in environment.rb
-    >> ./script/console
-    >> user = Gowalla::User.find('andyatkinson')
-    >> user.stamps
     
-    # for Ruby
-    >> irb -r rubygems
-    >> require 'init'
-    >> Gowalla::User.find('andyatkinson')
-    >> Gowalla::Stamp.find('andyatkinson')
+    Some real world usages
+    ---
+    Gowalla::User.find('andyatkinson').stamps_count # => 80
+    Gowalla::User.find('andyatkinson').last_checkins.first.spot.name => "Tea Garden"
+    "http://gowalla.com" + Gowalla::User.find('andyatkinson').last_checkins.first.spot.url # url to Tea Garden on Gowalla.com
 
 Testing
 ===

data/Rakefile

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('gowalla-ruby', '0.0.1') do |p|
+Echoe.new('gowalla-ruby', '0.0.5') do |p|
   p.description    = "Gowalla API wrapper for Ruby"
   p.url            = "http://github.com/webandy/gowalla-ruby"
   p.author         = "Andy Atkinson"

data/gowalla-ruby.gemspec

@@ -2,22 +2,22 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gowalla-ruby}
-  s.version = "0.0.1"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Andy Atkinson"]
-  s.date = %q{2010-02-21}
+  s.date = %q{2010-03-07}
   s.description = %q{Gowalla API wrapper for Ruby}
   s.email = %q{andy@webandy.com}
-  s.extra_rdoc_files = ["LICENSE", "README.markdown", "lib/gowalla.rb", "lib/gowalla/address.rb", "lib/gowalla/base.rb", "lib/gowalla/checkin.rb", "lib/gowalla/spot.rb", "lib/gowalla/stamp.rb", "lib/gowalla/user.rb"]
-  s.files = ["LICENSE", "README.markdown", "Rakefile", "init.rb", "lib/gowalla.rb", "lib/gowalla/address.rb", "lib/gowalla/base.rb", "lib/gowalla/checkin.rb", "lib/gowalla/spot.rb", "lib/gowalla/stamp.rb", "lib/gowalla/user.rb", "test/fixtures/stamps.json", "test/fixtures/user.json", "test/helper.rb", "test/test_stamp.rb", "test/test_user.rb", "Manifest", "gowalla-ruby.gemspec"]
+  s.extra_rdoc_files = ["LICENSE", "README.markdown", "lib/gowalla.rb", "lib/gowalla/activity.rb", "lib/gowalla/address.rb", "lib/gowalla/base.rb", "lib/gowalla/category.rb", "lib/gowalla/checkin.rb", "lib/gowalla/event.rb", "lib/gowalla/map_bound.rb", "lib/gowalla/spot.rb", "lib/gowalla/stamp.rb", "lib/gowalla/top_10.rb", "lib/gowalla/user.rb"]
+  s.files = ["LICENSE", "README.markdown", "Rakefile", "init.rb", "lib/gowalla.rb", "lib/gowalla/activity.rb", "lib/gowalla/address.rb", "lib/gowalla/base.rb", "lib/gowalla/category.rb", "lib/gowalla/checkin.rb", "lib/gowalla/event.rb", "lib/gowalla/map_bound.rb", "lib/gowalla/spot.rb", "lib/gowalla/stamp.rb", "lib/gowalla/top_10.rb", "lib/gowalla/user.rb", "test/fixtures/event.json", "test/fixtures/spot.json", "test/fixtures/spots.json", "test/fixtures/stamps.json", "test/fixtures/user.json", "test/helper.rb", "test/test_event.rb", "test/test_spot.rb", "test/test_stamp.rb", "test/test_user.rb", "Manifest", "gowalla-ruby.gemspec"]
   s.homepage = %q{http://github.com/webandy/gowalla-ruby}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Gowalla-ruby", "--main", "README.markdown"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{gowalla-ruby}
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{Gowalla API wrapper for Ruby}
-  s.test_files = ["test/test_stamp.rb", "test/test_user.rb"]
+  s.test_files = ["test/test_event.rb", "test/test_spot.rb", "test/test_stamp.rb", "test/test_user.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/init.rb

@@ -5,4 +5,9 @@ require File.join(File.dirname(__FILE__), 'lib', 'gowalla', 'user')
 require File.join(File.dirname(__FILE__), 'lib', 'gowalla', 'spot')
 require File.join(File.dirname(__FILE__), 'lib', 'gowalla', 'stamp')
 require File.join(File.dirname(__FILE__), 'lib', 'gowalla', 'checkin')
-require File.join(File.dirname(__FILE__), 'lib', 'gowalla', 'address')
+require File.join(File.dirname(__FILE__), 'lib', 'gowalla', 'address')
+require File.join(File.dirname(__FILE__), 'lib', 'gowalla', 'event')
+require File.join(File.dirname(__FILE__), 'lib', 'gowalla', 'activity')
+require File.join(File.dirname(__FILE__), 'lib', 'gowalla', 'category')
+require File.join(File.dirname(__FILE__), 'lib', 'gowalla', 'map_bound')
+require File.join(File.dirname(__FILE__), 'lib', 'gowalla', 'top_10')

data/lib/gowalla/activity.rb

@@ -0,0 +1,13 @@
+module Gowalla
+  class Activity
+    attr_accessor :type, :message, :user, :created_at, :activity
+    
+    def initialize(data={})
+      @type = data['type']
+      @message = data['message']
+      @user = User.new(data['user'])
+      @created_at = DateTime.parse(data['created_at'])
+      @activity = data['activity']
+    end
+  end
+end

data/lib/gowalla/address.rb

@@ -2,7 +2,7 @@ module Gowalla
   class Address
     attr_accessor :region, :locality
     
-    def initialize(data)
+    def initialize(data={})
       @region = data['region']
       @locality = data['locality']
     end

data/lib/gowalla/category.rb

@@ -0,0 +1,10 @@
+module Gowalla
+  class Category
+    attr_accessor :name, :url
+    
+    def initialize(data={})
+      @name = data['name']
+      @url = data['url']
+    end
+  end
+end

data/lib/gowalla/event.rb

@@ -0,0 +1,18 @@
+module Gowalla
+  # Retrieve a list of check-ins at a particular spot. Shows only the activity that is visible to a given user.
+  # model is singular. activities is an array for a given event.
+  class Event < Base
+    attr_accessor :url, :activity
+  
+    def initialize(data={}) 
+      @url = data['url']
+      @activity = data['activity'].map{|activity| Activity.new(activity)}
+    end
+    
+    protected
+      def self.fetch(id)
+        get("/spots/#{id}/events", :headers => {'Accept' => 'application/json'})
+      end
+    
+  end
+end

data/lib/gowalla/map_bound.rb

@@ -0,0 +1,12 @@
+module Gowalla
+  class MapBound
+    attr_accessor :north, :south, :east, :west
+    
+    def initialize(data={})
+      @north = data['north']
+      @south = data['south']
+      @east = data['east']
+      @west = data['west']
+    end
+  end
+end

data/lib/gowalla/spot.rb

@@ -1,13 +1,51 @@
 module Gowalla  
   class Spot < Base
-    attr_accessor :name, :address, :url, :image_url
+    attr_accessor :name, :address, :url, :image_url, :activity_url, :radius_meters, :remove_bookmark_url, :checkins_url, :checkins_count, :items_count, :facebook_url, :websites, :founders, :created_at, :description, :bookmarks_url, :max_items_count, :trending_level, :lat, :lng, :users_count, :twitter_username, :creator, :list_image_url_320, :spot_categories, :items_url, :strict_radius, :map_bounds, :phone_number, :address, :top_10
     
-    def initialize(data)
+    def initialize(data={})
       @name = data['name']
       @address = Address.new(data['address']) if !data['address'].blank?
       @url = data['url']
       @image_url = data['image_url']
+      @activity_url = data['activity_url']
+      @radius_meters = data['radius_meters']
+      @remove_bookmark_url = data['remove_bookmark_url']
+      @checkins_url = data['checkins_url']
+      @checkins_count = data['checkins_count']
+      @items_count = data['items_count']
+      @facebook_url = data['facebook_url']
+      @websites = data['websites']
+      @founders = data['founders'].map{|user| User.new(user)} unless data['founders'].blank?
+      @created_at = data['created_at']
+      @description = data['description']
+      @bookmarks_url = data['bookmarks_url']
+      @max_items_count = data['max_items_count']
+      @trending_level = data['trending_level']
+      @lat = data['lat']
+      @lng = data['lng']
+      @users_count = data['users_count']
+      @twitter_username = data['twitter_username']
+      @creator = User.new(data['creator']) unless data['creator'].blank?
+      @list_image_url_320 = data['list_image_url_320']
+      @items_url = data['items_url']
+      @spot_categories = data['spot_categories'].map{|c| Category.new(c)} unless data['spot_categories'].blank?
+      @strict_radius = data['strict_radius']
+      @map_bounds = MapBound.new(data['map_bounds']) unless data['map_bounds'].blank?
+      @phone_number = data['phone_number']
+      @top_10 = data['top_10'].map{|top_10| Top10.new(top_10)} unless data['top_10'].blank?
     end
+    def self.find(id)
+      Spot.new(self.fetch(id))
+    end
+    def events
+      event_id = self.activity_url.split("/")[2] # TODO probably better way
+      Event.new(Event.fetch(event_id))
+    end
+    
+    protected
+      def self.fetch(id)
+        get("/spots/#{id}", :headers => {'Accept' => 'application/json'})
+      end
     
   end
 end

data/lib/gowalla/stamp.rb

@@ -2,7 +2,7 @@ module Gowalla
   class Stamp < Base
     attr_accessor :spot, :checkins_count, :first_checkin_at, :last_checkin_at
                   
-    def initialize(data)
+    def initialize(data={})
       @spot = Spot.new(data['spot'])
       @checkins_count = data['checkins_count']
       @first_checkin_at = DateTime.parse(data['first_checkin_at'])

data/lib/gowalla/top_10.rb

@@ -0,0 +1,17 @@
+module Gowalla
+  class Top10
+    attr_accessor :checkins_count, :first_name, :last_name, :url, :image_url
+    
+    def initialize(data={})
+      @checkins_count = data['checkins_count']
+      @first_name = data['first_name']
+      @last_name = data['last_name']
+      @url = data['url']
+      @image_url = data['image_url']
+    end
+    
+    def user
+      User.find(self.url.split("/users/").last) # grab the user id
+    end
+  end
+end

data/lib/gowalla/user.rb

@@ -24,7 +24,7 @@ module Gowalla
       @add_friend_url = data['add_friend_url']
       @friends_url = data['friends_url']
       @_is_friend = data['_is_friend']
-      @last_checkins = data['last_checkins'].map{|checkin| Checkin.new(checkin)}
+      @last_checkins = data['last_checkins'].map{|checkin| Checkin.new(checkin)} unless data['last_checkins'].blank?
       @pins_count = data['pins_count']
     end
     def self.find(username)

data/test/fixtures/event.json

@@ -0,0 +1,195 @@
+{
+    "url": "/spots/18568",
+    "activity": [{
+        "type": "checkin",
+        "message": "Obligatacos",
+        "user": {
+            "first_name": "Phillip",
+            "image_url": "http://s3.amazonaws.com/static.gowalla.com/users/12-standard.jpg?1249405659",
+            "url": "/users/12",
+            "last_name": "Bowden"
+        },
+        "created_at": "2010-02-22T01:25:06+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "Best queso evvvvver.",
+        "user": {
+            "first_name": "MK ",
+            "image_url": "http://s3.amazonaws.com/static.gowalla.com/users/114792-standard.jpg?1265692718",
+            "url": "/users/114792",
+            "last_name": "Butler"
+        },
+        "created_at": "2010-02-20T03:38:06+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "",
+        "user": {
+            "first_name": "Tommy",
+            "image_url": "http://s3.amazonaws.com/static.gowalla.com/users/61820-standard.jpg?1261076899",
+            "url": "/users/61820",
+            "last_name": "Davis"
+        },
+        "created_at": "2010-02-20T03:35:36+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "",
+        "user": {
+            "first_name": "Rob",
+            "image_url": "http://s3.amazonaws.com/static.gowalla.com/users/3104-standard.jpg?1253304471",
+            "url": "/users/3104",
+            "last_name": "Mack"
+        },
+        "created_at": "2010-02-19T22:37:34+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "",
+        "user": {
+            "first_name": "Geoff",
+            "image_url": "http://s3.amazonaws.com/static.gowalla.com/users/6417-standard.jpg?1254429296",
+            "url": "/users/6417",
+            "last_name": "Lou"
+        },
+        "created_at": "2010-02-19T19:07:48+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "",
+        "user": {
+            "first_name": "Keegan",
+            "image_url": "http://s3.amazonaws.com/static.gowalla.com/users/5-standard.jpg?1253829277",
+            "url": "/users/5",
+            "last_name": "Jones"
+        },
+        "created_at": "2010-02-19T02:43:45+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "",
+        "user": {
+            "first_name": "Willy",
+            "image_url": "http://gowalla.com/images/default-user.jpg",
+            "url": "/users/122330",
+            "last_name": "Wonka"
+        },
+        "created_at": "2010-02-18T23:41:51+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "",
+        "user": {
+            "first_name": "Blake",
+            "image_url": "http://s3.amazonaws.com/static.gowalla.com/users/132-standard.jpg?1236965251",
+            "url": "/users/132",
+            "last_name": "Burris"
+        },
+        "created_at": "2010-02-18T18:45:51+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "",
+        "user": {
+            "first_name": "Amy",
+            "image_url": "http://gowalla.com/images/default-user.jpg",
+            "url": "/users/53327",
+            "last_name": "Delk"
+        },
+        "created_at": "2010-02-18T02:20:12+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "",
+        "user": {
+            "first_name": "Weston",
+            "image_url": "http://s3.amazonaws.com/static.gowalla.com/users/97465-standard.jpg?1264027703",
+            "url": "/users/97465",
+            "last_name": "Sewell"
+        },
+        "created_at": "2010-02-18T01:31:23+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "",
+        "user": {
+            "first_name": "Back",
+            "image_url": "http://s3.amazonaws.com/static.gowalla.com/users/57629-standard.jpg?1264621883",
+            "url": "/users/57629",
+            "last_name": "Hand"
+        },
+        "created_at": "2010-02-17T18:18:25+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "Refueling",
+        "user": {
+            "first_name": "Susan",
+            "image_url": "http://s3.amazonaws.com/static.gowalla.com/users/38153-standard.jpg?1261953895",
+            "url": "/users/38153",
+            "last_name": "Pevovar"
+        },
+        "created_at": "2010-02-14T19:38:15+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "",
+        "user": {
+            "first_name": "Cynthia Ruth",
+            "image_url": "http://s3.amazonaws.com/static.gowalla.com/users/62151-standard.jpg?1264486348",
+            "url": "/users/62151",
+            "last_name": "Nava"
+        },
+        "created_at": "2010-02-14T01:48:11+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "",
+        "user": {
+            "first_name": "Joe",
+            "image_url": "http://gowalla.com/images/default-user.jpg",
+            "url": "/users/84619",
+            "last_name": "Liemandr"
+        },
+        "created_at": "2010-02-13T23:40:53+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "my wife's favorite ... it's been a long time!",
+        "user": {
+            "first_name": "Kye S.",
+            "image_url": "http://s3.amazonaws.com/static.gowalla.com/users/4758-standard.jpg?1261603239",
+            "url": "/users/4758",
+            "last_name": "Chung"
+        },
+        "created_at": "2010-02-13T00:36:03+00:00",
+        "activity": []
+    },
+    {
+        "type": "checkin",
+        "message": "",
+        "user": {
+            "first_name": "Adam",
+            "image_url": "http://gowalla.com/images/default-user.jpg",
+            "url": "/users/102739",
+            "last_name": "LaRue"
+        },
+        "created_at": "2010-02-12T17:34:49+00:00",
+        "activity": []
+    }]
+}