whatser 0.2.0 → 0.3.0

data/README.rdoc

@@ -28,13 +28,14 @@ Declare Whatser in your Gemfile:
 
 And instantiate a Whatser client as need:
 
-    client = Whatser::Client.new(:api_key => 'key', :api_secret => 'secret', :oauth_token => '123abc')
+    client = Whatser::Client.new(:api_key => 'key', :api_secret => 'secret', :oauth_token => '123abc', :logger => Rails.logger)
 
 or...
 
     Whatser::Client.configure do |config|
       config.api_key = 'key'
       config.api_secret = 'secret'
+      config.logger = Rails.logger
     end
     client1 = Whatser::Client.new( :oauth_token => '123abc' )
     client2 = Whatser::Client.new( :oauth_token => '789xyz' )
@@ -150,6 +151,10 @@ As a convenience you can also iterate over a collection's spot data:
     collection = Whatser::Collection.new( [spot1, spot2, spot3] )
     collection.each { |c| puts c.name }
 
+If a user somehow discovers a spot due to another user's recommendation or similar, you can explicitly thank them for the recommendation, slightly increasing the user's Whatser reputation and influence as an opinion leader.
+
+    user.thanks( spot_id, :message => 'thanks, this spot looks great', :facebook => true, :twitter => true)
+
 === Cities
 
 A user's cities represent the cities in which they have collected spots.
@@ -258,6 +263,17 @@ 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}]>
 
 
+=== 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, or globally.
+
+    Whatser.client.feed.user( user_id, :page => 1, :per_page => 10 )
+    Whatser.client.feed.mine( :page => 1, :per_page => 10 )
+    Whatser.client.feed.global( :page => 1, :per_page => 10 )
+
+    <Whatser::ActivityFeed @message="you uploaded a photo.", @poi_id=101, @object_avatar=nil, @user_avatar="http://example.com/avatars/imgs/1.jpg", @user_id=33, @object_name="Something", @user_name="This User", @object_id=1001, @poi_name="Some Spot", @city="Amsterdam">
+
+
 === Social Networks
 
 The API integrates with several social networks (Facebook, Foursquare, Gowalla, and Twitter), allowing users from those networks to login from or connect their accounts with Whatser. All four networks are supported for connecting a user account (via the OAuth 2 web authorization flow), and disconnecting a user account. In addition, the API provides access to other select parts of these networks to support social media and location-based user activity.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/lib/whatser/api/service.rb

@@ -1,15 +1,35 @@
+require 'cgi'
+
 module Whatser
   class Service < Whatser::Resource
-    def key
-      self.class.name.split('::').last.downcase
+    class << self
+      def key
+        self.name.split('::').last.downcase
+      end
+          
+      def connection_url(params={})
+        "#{client.api_uri}/oauth/services/#{key}/authorize?#{connection_querystring(params)}"
+      end  
+      
+      def disconnection_url(params={})
+        "#{client.api_uri}/oauth/services/#{key}/disconnect"
+      end
+      
+      def connection_querystring(params={})
+        auth_params( params ).map{|k,v| "#{CGI.escape( (k || '').to_s )}=#{CGI.escape( (v || '').to_s )}"}.join('&')
+      end
+
+      def auth_params(params={})
+        { 
+          :client_id => client.api_key, 
+          :redirect_uri => client.redirect_uri
+        }.merge( params )
+      end
     end
     
-    def connection_url
-      "#{client.api_uri}/oauth/services/#{key}/authorize"
-    end
+    def key; self.class.key; end
     
-    def disconnection_url
-      "#{client.api_uri}/oauth/services/#{key}/disconnect"
-    end      
+    def connection_url(params={}); self.class.connection_url(params) end
+    def disconnection_url(params={}); self.class.disconnection_url(params) end
   end
 end

data/lib/whatser/client.rb

@@ -13,6 +13,7 @@ module Whatser
       end
     end
     
+    attr_accessor :logger
     attr_accessor  *Whatser::Configuration::VALID_OPTIONS_KEYS
     def initialize(options={})
       Whatser::Configuration::VALID_OPTIONS_KEYS.each do |key|
@@ -50,5 +51,10 @@ module Whatser
     def authorized?
       !oauth_token.blank?
     end
+    
+    def log(msg,level=:info)
+      return if logger.blank?
+      logger.send(level, msg)
+    end
   end   
 end

data/lib/whatser/configuration.rb

@@ -1,6 +1,6 @@
 module Whatser
   module Configuration
-    VALID_OPTIONS_KEYS = [:api_key,:api_secret,:username,:password,:oauth_token,:api_uri,:redirect_uri]
+    VALID_OPTIONS_KEYS = [:api_key,:api_secret,:username,:password,:oauth_token,:api_uri,:redirect_uri,:logger]
     
     DEFAULT_API_URI = 'https://production-2.sogeoapi.com'.freeze
 
@@ -9,6 +9,7 @@ module Whatser
       base.api_secret    = nil
       base.oauth_token   = nil
       base.redirect_uri  = nil
+      base.logger        = nil
       base.api_uri       = DEFAULT_API_URI
     end
   end

data/lib/whatser/net/http.rb

@@ -7,7 +7,10 @@ module Whatser
     end
     
     def request(verb, path, params={}, options={})
+      log("Whatser API Request: #{verb} @ #{path} with : #{params.to_s}")
       response = HTTParty.send( verb, compose_url(path), request_options( params ) )
+      log("Whatser API Response: #{response.code} with : #{response.body.to_s}")
+      
       Whatser::Response.new( response.body, {:code => response.code}.merge(options) ) 
     end
     
@@ -17,10 +20,14 @@ module Whatser
       "#{api_uri}#{path}"
     end
 
-    def request_options(params={})
+    def request_options(params={}, options={})
       params ||= {}
-      return { :query => {:oauth_token => oauth_token}.merge(params[:query] || {}), 
-               :body => params[:body] }
+      return { :query => query_options(params[:query], options), :body => params[:body] }
+    end
+    
+    def query_options(params, options={})
+      base = options[:auth] == :key ? {:client_id => api_key} : {:oauth_token => oauth_token}
+      base.merge( params || {} )
     end
   end
 end

data/lib/whatser/resources/activity_feed.rb

@@ -1,7 +1,7 @@
 module Whatser
   class ActivityFeed < Whatser::Resource
     attr_accessor :user_id,:user_name,:user_avatar,:poi_id,:poi_name,:object_id,:object_name,:object_avatar
-    attr_accessor :city,:message,:created_At
+    attr_accessor :city,:message,:created_at
     
     class << self
       def mine(params={})

data/lib/whatser/resources/user.rb

@@ -32,7 +32,7 @@ module Whatser
       end
 
       def invite(emails)
-        api_request :post, "/api/invites", {:query => emails}
+        api_request :post, "/api/invites", {:query => {'emails' => emails} }
       end
     end      
 
@@ -45,9 +45,13 @@ module Whatser
     end
           
     def connection
-      Whatser::Follow.connection(id)
+      Whatser::Follow.set(self.class.client).connection(id)
     end 
     
+    def thanks(poi_id,params={})
+      api_request :post, "/api/users/#{id}/poi/#{poi_id}/thanks", {:query => params}
+    end
+    
     def oauth_token
       if access_tokens.blank? 
         nil

data/test/test_client.rb

@@ -1,10 +1,20 @@
 require 'helper'
+require 'logger'
 
 class TestClient < Test::Unit::TestCase
+  def setup
+    @client = Whatser::Client.new
+  end
+
+  def reset_config_defaults
+    Whatser::Client.configure do |config|
+      config.logger = nil
+    end
+  end  
+  
   def test_attr_accessor
-    client = Whatser::Client.new
     Whatser::Configuration::VALID_OPTIONS_KEYS.each do |a|
-      assert client.respond_to?(a)
+      assert @client.respond_to?(a)
     end
   end
   
@@ -39,6 +49,18 @@ class TestClient < Test::Unit::TestCase
     assert_equal 'key', client.api_key
     assert_equal 'secret', client.api_secret
     assert_equal '123abc', client.oauth_token
+    reset_config_defaults
+  end
+  
+  def test_initialize_with_logger
+    logger = Logger.new('test-logger.txt')
+    Whatser::Client.configure do |config|
+      config.logger = logger
+    end
+    client = Whatser::Client.new  
+    assert_equal logger, client.logger
+    reset_config_defaults
+    File.delete('test-logger.txt') if File::exists?( 'test-logger.txt' )
   end
   
   def test_resources
@@ -75,10 +97,28 @@ class TestClient < Test::Unit::TestCase
   end
   
   def test_authorized
-    client = Whatser::Client.new
-    assert_equal false, client.authorized?
+    assert_equal false, @client.authorized?
+    
+    @client.oauth_token = 'test'
+    assert_equal true, @client.authorized?
+  end
+  
+  def test_log
+    @client.logger = Logger.new('test-logger.txt')
+    
+    assert_equal true, @client.log('test123')
+    assert_equal true, @client.log('test456', :error)
+    
+    log = File.open('test-logger.txt') {|f| f.read}
+    assert log.include?('INFO -- : test123')
+    assert log.include?('ERROR -- : test456')
     
-    client.oauth_token = 'test'
-    assert_equal true, client.authorized?
+    File.delete('test-logger.txt') if File::exists?( 'test-logger.txt' )
+    @client.logger = nil
+  end  
+  
+  def test_log_without_logger
+    @client.logger = nil
+    assert_nil @client.log('test')
   end
 end

data/test/test_configuration.rb

@@ -6,11 +6,12 @@ class TestConfiguration < Test::Unit::TestCase
       config.api_key = nil
       config.api_secret = nil
       config.oauth_token = nil
-    end    
+      config.logger = nil
+    end
   end
   
   def test_valid_options_keys
-    expected = [:api_key,:api_secret,:username,:password,:oauth_token,:api_uri,:redirect_uri]
+    expected = [:api_key,:api_secret,:username,:password,:oauth_token,:api_uri,:redirect_uri,:logger]
     assert_equal expected, Whatser::Configuration::VALID_OPTIONS_KEYS
   end
   
@@ -21,6 +22,7 @@ class TestConfiguration < Test::Unit::TestCase
     assert_equal nil, client.api_secret
     assert_equal nil, client.oauth_token
     assert_equal nil, client.redirect_uri
+    assert_equal nil, client.logger
     assert_equal Whatser::Configuration::DEFAULT_API_URI, client.api_uri
   end
 end

data/test/test_facebook.rb

@@ -1,7 +1,16 @@
 require 'helper'
 
 class TestFacebook < Test::Unit::TestCase
+  def setup
+    @client = Whatser::Client.new(:oauth_token => '1234')
+  end
+  
   def test_key
     assert_equal 'facebook', Whatser::Facebook.new.key
   end
+  
+  def test_connection_url
+    expected = "#{@client.api_uri}/oauth/services/facebook/authorize"
+    assert_equal expected, @client.facebook.connection_url
+  end
 end

data/test/test_foursquare.rb

@@ -1,7 +1,16 @@
 require 'helper'
 
 class TestFoursquare < Test::Unit::TestCase
+  def setup
+    @client = Whatser::Client.new(:oauth_token => '1234')
+  end
+
   def test_key
     assert_equal 'foursquare', Whatser::Foursquare.new.key
   end
+
+  def test_connection_url
+    expected = "#{@client.api_uri}/oauth/services/foursquare/authorize"
+    assert_equal expected, @client.foursquare.connection_url
+  end
 end

data/test/test_gowalla.rb

@@ -1,7 +1,16 @@
 require 'helper'
 
 class TestGowalla < Test::Unit::TestCase
+  def setup
+    @client = Whatser::Client.new(:oauth_token => '1234')
+  end
+  
   def test_key
     assert_equal 'gowalla', Whatser::Gowalla.new.key
   end
+
+  def test_connection_url
+    expected = "#{@client.api_uri}/oauth/services/gowalla/authorize"
+    assert_equal expected, @client.gowalla.connection_url
+  end  
 end

data/test/test_http.rb

@@ -23,6 +23,12 @@ class TestHttp < Test::Unit::TestCase
     assert_equal expected, @client.send(:request_options, {:body => {:extra => 1} })
   end  
   
+  def test_request_options_with_client_auth
+    @client.api_key = '123'
+    expected = {:query => {:client_id => '123'}, :body => nil}
+    assert_equal expected, @client.send(:request_options, {}, {:auth => :key})
+  end
+  
   def test_base_uri_on_included
     assert_equal @client.api_uri, Whatser::Http.base_uri
   end

data/test/test_resource.rb

@@ -66,6 +66,11 @@ class TestResource < Test::Unit::TestCase
     assert mod.is_a?(Whatser::Poi)
   end  
   
+  def test_from_hash_to_model_with_string
+    mod = Whatser::Resource.from_hash_to_model('freetextstringtest')
+    assert mod.is_a?(Whatser::Resource)
+  end
+  
   def test_from_hash_to_model_empty
     mod = Whatser::Resource.from_hash_to_model(nil)
     assert mod.is_a?(Whatser::Resource)

data/test/test_service.rb

@@ -0,0 +1,45 @@
+require 'helper'
+
+class TestService < Test::Unit::TestCase
+  def setup
+    @client = Whatser::Client.new(:api_key => '123', :redirect_uri => 'http://example.com')
+    @service = Whatser::Service.set(@client).new
+  end
+  
+  def test_key
+    assert_equal 'service', Whatser::Service.key
+    assert_equal 'service', @service.key
+  end
+
+  def test_connection_url
+    expected = "#{@client.api_uri}/oauth/services/service/authorize?"
+    expected = expected + "client_id=#{@client.api_key}&redirect_uri=#{ CGI.escape(@client.redirect_uri) }"
+    assert_equal expected, @service.connection_url
+  end  
+  
+  def test_disconnection_url
+    expected = "#{@client.api_uri}/oauth/services/service/disconnect"
+    assert_equal expected, @service.disconnection_url
+  end  
+  
+  def test_auth_params
+    expected = {:client_id => @client.api_key, :redirect_uri => @client.redirect_uri}
+    assert_equal expected, Whatser::Service.auth_params
+  end
+  
+  def test_auth_params_with_params
+    override_url = 'http://sub.example.com'
+    expected = {:client_id => @client.api_key, :redirect_uri => override_url}
+    assert_equal expected, Whatser::Service.auth_params(:redirect_uri => override_url)
+  end
+  
+  def test_connection_querystring
+    expected = "client_id=#{@client.api_key}&redirect_uri=#{ CGI.escape(@client.redirect_uri) }"
+    assert_equal expected, Whatser::Service.connection_querystring
+  end
+  
+  def test_connection_querystring_with_params
+    expected = "display=wap&client_id=#{@client.api_key}&redirect_uri=#{ CGI.escape(@client.redirect_uri) }"
+    assert_equal expected, Whatser::Service.connection_querystring(:display => 'wap')
+  end  
+end

data/test/test_twitter.rb

@@ -1,7 +1,16 @@
 require 'helper'
 
 class TestTwitter < Test::Unit::TestCase
+  def setup
+    @client = Whatser::Client.new(:oauth_token => '1234')
+  end
+  
   def test_key
     assert_equal 'twitter', Whatser::Twitter.new.key
   end
+
+  def test_connection_url
+    expected = "#{@client.api_uri}/oauth/services/twitter/authorize"
+    assert_equal expected, @client.twitter.connection_url
+  end  
 end

data/test/test_user.rb

@@ -42,6 +42,14 @@ class TestUser < Test::Unit::TestCase
     assert @client.users.create(:name => 'test', :email => 'test@example.com', :password => '123pass').is_a?(Whatser::Response)
   end
   
+  def test_connection
+    assert @user.connection.is_a?(Whatser::Response)
+  end  
+
+  def test_thanks
+    assert @user.thanks(1, :opt => 'test').is_a?(Whatser::Response)
+  end  
+  
   def test_save
     assert @user.save.is_a?(Whatser::Response)
   end  

data/whatser.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{whatser}
-  s.version = "0.2.0"
+  s.version = "0.3.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-12}
+  s.date = %q{2011-01-20}
   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 = [
@@ -71,6 +71,7 @@ Gem::Specification.new do |s|
     "test/test_resource.rb",
     "test/test_response.rb",
     "test/test_review.rb",
+    "test/test_service.rb",
     "test/test_subscription.rb",
     "test/test_tag.rb",
     "test/test_twitter.rb",
@@ -103,6 +104,7 @@ Gem::Specification.new do |s|
     "test/test_resource.rb",
     "test/test_response.rb",
     "test/test_review.rb",
+    "test/test_service.rb",
     "test/test_subscription.rb",
     "test/test_tag.rb",
     "test/test_twitter.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: whatser
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: false
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - Travis Dunn
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-12 00:00:00 +01:00
+date: 2011-01-20 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -170,6 +170,7 @@ files:
 - test/test_resource.rb
 - test/test_response.rb
 - test/test_review.rb
+- test/test_service.rb
 - test/test_subscription.rb
 - test/test_tag.rb
 - test/test_twitter.rb
@@ -230,6 +231,7 @@ test_files:
 - test/test_resource.rb
 - test/test_response.rb
 - test/test_review.rb
+- test/test_service.rb
 - test/test_subscription.rb
 - test/test_tag.rb
 - test/test_twitter.rb