whatser 0.3.2 → 0.4.0

data/README.rdoc

@@ -9,6 +9,7 @@ The 'Whatser API' Gem is a simple Ruby / Rails wrapper for interacting with What
 * network connectivity (using httparty)
 * simple DSL for API resource classes (spots, media, reviews, check ins, etc.)
 * user spot collection management
+* check-in aggregation
 * social network integration (facebook, twitter, foursquare, gowalla)
 * photo uploads
 
@@ -267,6 +268,20 @@ A data source represents a free or purchasable content stream of collected spots
     <Whatser::DataSource @review_count=405, @poi_count=0, @price=0.0, @collection_count=0, @name="Rough Guides - Barcelona", @media_count=0, @id=9, @users=[{"name": "premium user", "id": 33}]>
 
 
+=== Comments
+
+A comment is just a short user note that can be associated with other resources. At the moment, you can comment on a POI, Media, or an Activity Feed. Users can also delete their own comments.
+
+    Whatser.client.comments.poi( poi_id, :page => 1, :per_page => 10 )
+    Whatser.client.comments.media( media_id, :page => 1, :per_page => 10 )
+    Whatser.client.comments.create( 'activity_feed', feed_id, 'This is a comment. Interesting activity!' )
+    Whatser.client.comments.create( 'media', media_id, 'This is a comment on a media. Stunning photo!' )
+    m = Whatser.client.comments.create( 'poi', spot_id, 'This is a comment on a spot. Nice spot!' )
+    m.delete
+
+    <Whatser::Comment @body="This is a comment.", @id=101, @user_id=101, @activity_feed_id=null, @user_avatar="http://example.com/images/thumb/4394.jpg", @subject_id=33, @user_name='Whaster User', @created_at="2010-12-24T16:31:38Z", @subject_type='poi', @subject_name="Some Spot">
+
+
 === Activity Feeds
 
 User activity is recorded by the API, for example when a user adds or tags a POI, befriends another user, or uploads a photo. This activity is recorded in a user's activity feed, a collection of short messages detailing that user's activity. You can view feeds either by user, by spot, or globally.

data/VERSION

@@ -1 +1 @@
-0.3.2
+0.4.0

data/lib/whatser/client.rb

@@ -36,6 +36,7 @@ module Whatser
     def reviews; Whatser::Review.set(self); end
     def subscriptions; Whatser::Subscription.set(self); end
     def tags; Whatser::Tag.set(self); end
+    def comments; Whatser::Comment.set(self); end
     def cities; Whatser::City.set(self); end
     def feeds; Whatser::ActivityFeed.set(self); end    
     

data/lib/whatser/resources/comment.rb

@@ -0,0 +1,28 @@
+module Whatser
+  class Comment < Whatser::Resource
+    attr_accessor :id,:user_id,:activity_feed_id,:subject_id,:created_at
+    attr_accessor :user_name,:user_avatar,:subject_type,:subject_name,:body
+    
+    class << self
+      def poi(poi_id, opts={})
+        api_request :get, "/api/poi/#{poi_id}/comments", {:query => opts}
+      end
+
+      def media(media_id, opts={})
+        api_request :get, "/api/media/#{media_id}/comments", {:query => opts}
+      end
+      
+      def delete(id)
+        api_request :delete, "/api/comments/#{id}"
+      end
+      
+      def create(resource_name, resource_id, body)
+        api_request :post, "/api/#{resource_name}/#{resource_id}/tags", {:body => {'comment' => {'body' => body}} }
+      end      
+    end
+    
+    def delete
+      self.class.delete(id)
+    end     
+  end
+end

data/lib/whatser/resources/poi.rb

@@ -62,6 +62,10 @@ module Whatser
       Whatser::ActivityFeed.set(self.class.client).spot( self.id, opts )
     end
     
+    def comments(opts={})
+      Whatser::Comment.set(self.class.client).poi(id, opts)
+    end
+        
     def foursquare_connected?
       !foursquare_id.blank?
     end

data/lib/whatser.rb

@@ -21,6 +21,7 @@ require File.expand_path('../whatser/resources/subscription', __FILE__)
 require File.expand_path('../whatser/resources/tag', __FILE__)
 require File.expand_path('../whatser/resources/user', __FILE__)
 require File.expand_path('../whatser/resources/follow', __FILE__)
+require File.expand_path('../whatser/resources/comment', __FILE__)
 require File.expand_path('../whatser/resources/activity_feed', __FILE__)
 
 require File.expand_path('../whatser/api/service', __FILE__)

data/test/test_comment.rb

@@ -0,0 +1,27 @@
+require 'helper'
+
+class TestComment < Test::Unit::TestCase
+  def setup
+    @client = Whatser::Client.new
+    @poi_id = 1
+    @media_id = 1    
+    @comment = Whatser::Comment.new(:poi_id => @poi_id, :body => 'test')
+  end
+  
+  def test_poi_list
+    assert @client.comments.poi(@poi_id, :page => 1).is_a?(Whatser::Response)
+  end
+  
+  def test_media_list
+    assert @client.comments.media(@media_id, :page => 1).is_a?(Whatser::Response)
+  end  
+  
+  def test_create
+    assert @client.comments.create('poi', @poi_id, 'testing.').is_a?(Whatser::Response)
+  end
+  
+  def test_delete
+    assert @client.comments.delete(@poi_id).is_a?(Whatser::Response)
+    assert @comment.delete.is_a?(Whatser::Response)
+  end  
+end

data/test/test_poi.rb

@@ -77,6 +77,10 @@ class TestPoi < Test::Unit::TestCase
     assert @poi.activity(:opt => 'test').is_a?(Whatser::Response)
   end
   
+  def test_comments
+    assert @poi.comments(:opt => 'test').is_a?(Whatser::Response)
+  end  
+  
   def test_details
     assert @poi.details(:page => 1).is_a?(Whatser::Response)
   end

data/whatser.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whatser}
-  s.version = "0.3.2"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Travis Dunn"]
-  s.date = %q{2011-01-28}
+  s.date = %q{2011-02-03}
   s.description = %q{The 'Whatser API' Gem is a simple Ruby / Rails wrapper for interacting with Whatser's location-based web services (see http://docs.sogeoapi.com for more details).}
   s.email = %q{cmd@travisdunn.com}
   s.extra_rdoc_files = [
@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
     "lib/whatser/resources/check_in.rb",
     "lib/whatser/resources/city.rb",
     "lib/whatser/resources/collection.rb",
+    "lib/whatser/resources/comment.rb",
     "lib/whatser/resources/data_source.rb",
     "lib/whatser/resources/detail.rb",
     "lib/whatser/resources/follow.rb",
@@ -57,6 +58,7 @@ Gem::Specification.new do |s|
     "test/test_city.rb",
     "test/test_client.rb",
     "test/test_collection.rb",
+    "test/test_comment.rb",
     "test/test_configuration.rb",
     "test/test_data_source.rb",
     "test/test_detail.rb",
@@ -90,6 +92,7 @@ Gem::Specification.new do |s|
     "test/test_city.rb",
     "test/test_client.rb",
     "test/test_collection.rb",
+    "test/test_comment.rb",
     "test/test_configuration.rb",
     "test/test_data_source.rb",
     "test/test_detail.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: whatser
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 15
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 2
-  version: 0.3.2
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Travis Dunn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-28 00:00:00 +01:00
+date: 2011-02-03 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -140,6 +140,7 @@ files:
 - lib/whatser/resources/check_in.rb
 - lib/whatser/resources/city.rb
 - lib/whatser/resources/collection.rb
+- lib/whatser/resources/comment.rb
 - lib/whatser/resources/data_source.rb
 - lib/whatser/resources/detail.rb
 - lib/whatser/resources/follow.rb
@@ -156,6 +157,7 @@ files:
 - test/test_city.rb
 - test/test_client.rb
 - test/test_collection.rb
+- test/test_comment.rb
 - test/test_configuration.rb
 - test/test_data_source.rb
 - test/test_detail.rb
@@ -217,6 +219,7 @@ test_files:
 - test/test_city.rb
 - test/test_client.rb
 - test/test_collection.rb
+- test/test_comment.rb
 - test/test_configuration.rb
 - test/test_data_source.rb
 - test/test_detail.rb