totter 0.2.2 → 0.2.3

data/lib/totter/client/timelines.rb

@@ -4,12 +4,78 @@ module Totter
     module Timelines
       # Get recent decisions from the global timeline.
       #
-      # @param limit [Fixnum] Number of decisions to return.
+      # @param options [Hash] Parameters for returning selected items
+      # @option options [Numeric] :limit Number of items to return. Default is 20
+      # @option options [String] :since A user_id/decision_id pair in the format '1,15' when paging forward
+      # @option options [String] :until A user_id/decision_id pair in the format '1,15' when paging backwards
       # @return [Array]
       # @example
-      #   Seesaw.recent_decisions
-      def global_timeline(limit = 10)
-        get "timelines/global?limit=#{limit}"
+      #   Seesaw.global_timeline(limit: 20, since: '1,15')
+      def global_timeline(options = default_options)
+        get "timelines/global", options
+      end
+
+      # Get recent decisions from a hashtag timeline
+      #
+      # @param hashtag [String] The hashtag to return
+      # @param options [Hash] Parameters for returning selected items
+      # @option options [Numeric] :limit Number of items to return. Default is 20
+      # @option options [String] :since A user_id/decision_id pair in the format '1,15' when paging forward
+      # @option options [String] :until A user_id/decision_id pair in the format '1,15' when paging backwards
+      # @return [Array]
+      # @example
+      #   Seesaw.global_timeline(limit: 20, since: '1,15')
+      def hashtag_timeline(hashtag, options = default_options)
+        get "timelines/global", options.merge({hashtag: hashtag})
+      end
+
+      # Get recent decisions from a sticker timeline
+      #
+      # @param sticker [String] The sticker to return
+      # @param options [Hash] Parameters for returning selected items
+      # @option options [Numeric] :limit Number of items to return. Default is 20
+      # @option options [String] :since A user_id/decision_id pair in the format '1,15' when paging forward
+      # @option options [String] :until A user_id/decision_id pair in the format '1,15' when paging backwards
+      # @return [Array]
+      # @example
+      #   Seesaw.global_timeline(limit: 20, since: '1,15')
+      def sticker_timeline(sticker, options = default_options)
+        get "timelines/global", options.merge({sticker: sticker})
+      end
+
+      # Search for published items
+      #
+      # @param query [String] The query to search for
+      # @param options [Hash] Parameters for returning selected items
+      # @option options [Numeric] :limit Number of items to return. Default is 20
+      # @option options [String] :since A user_id/decision_id pair in the format '1,15' when paging forward
+      # @option options [String] :until A user_id/decision_id pair in the format '1,15' when paging backwards
+      # @return [Array]
+      # @example
+      #   Seesaw.global_timeline(limit: 20, since: '1,15')
+      def search_timeline(query, options = default_options)
+        get "timelines/search", options.merge({query: query})
+      end
+
+      # Get recent decisions from the flagged-for-review timeline
+      #
+      # @param options [Hash] Parameters for returning selected items
+      # @option options [Numeric] :limit Number of items to return. Default is 20
+      # @option options [String] :since A user_id/decision_id pair in the format '1,15' when paging forward
+      # @option options [String] :until A user_id/decision_id pair in the format '1,15' when paging backwards
+      # @return [Array]
+      # @example
+      #   Seesaw.global_timeline(limit: 20, since: '1,15')
+      def flagged_timeline(options = default_options)
+        get "timelines/flagged", options
+      end
+
+      private
+
+      def default_options
+        {
+          limit: 20
+        }
       end
     end
   end

data/lib/totter/client/users.rb

@@ -24,9 +24,8 @@ module Totter
         get "users/#{user}"
       end
 
-      # Updates a given user
+      # Updates the authenticating user
       #
-      # @param user_id [Numeric] A Seesaw user ID.
       # @param options [Hash] Properties to be updated
       # @option options [String] :given_name The given name of the user
       # @option options [String] :family_name The Family name of the user

data/lib/totter/client.rb

@@ -3,6 +3,7 @@ require 'net/https'
 require 'uri'
 require 'multi_json'
 require 'hashie'
+require 'addressable/uri'
 
 require 'totter/client/users'
 require 'totter/client/decisions'
@@ -74,8 +75,15 @@ module Totter
     end
 
     def request(method, path, params = nil)
+      uri = Addressable::URI.parse("#{self.base_url}#{path}")
+
+      # if the request requires parameters in the query string, merge them in
+      if params and !can_post_data?(method)
+        uri.query_values = (uri.query_values || {}).merge(params)
+      end
+
       # Build request
-      request = build_request(method, URI.parse("#{self.base_url}#{path}"))
+      request = build_request(method, uri)
 
       # Add headers
       request['Authorization'] = "Bearer #{self.access_token}" if authenticated?
@@ -83,7 +91,7 @@ module Totter
       request['Content-Type'] = 'application/json'
 
       # Add params as JSON if they exist
-      request.body = MultiJson.dump(params) if [:post, :put].include?(method) and params
+      request.body = MultiJson.dump(params) if can_post_data?(method) and params
 
       # Request
       response = http.request(request)
@@ -145,6 +153,10 @@ module Totter
       (200..299).include? response.code.to_i
     end
 
+    def can_post_data?(method)
+      [:post, :put].include?(method)
+    end
+
     [:get, :post, :put, :delete].each do |method|
       define_method method do |*args|
         json_request(method, *args)

data/lib/totter/version.rb

@@ -1,4 +1,4 @@
 module Totter
   # Verion of the Totter gem
-  VERSION = '0.2.2'
+  VERSION = '0.2.3'
 end

data/test/cassettes/timelines/flagged.yml

@@ -0,0 +1,51 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:5000/v1/timelines/flagged?limit=20
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+      Authorization:
+      - Bearer 9774e653f7b3c1de5f21b61adc08ba24
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Pusher-Channel:
+      - timeline-flagged
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - ! '"0acd8cac74006491b795cea4a88fd4eb"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 61a5061aaaceb232be0ca641b6035677
+      X-Runtime:
+      - '0.266770'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: US-ASCII
+      string: ! '[{"created_at":"2013-01-30T21:12:28Z","final_vote_id":null,"flag_count":1,"id":18,"is_private":false,"meta":{"is_binary":true,"question_display_text":"Is
+        bacon delicious?","question_display_html":"Is bacon delicious?","question_entities":[]},"published_at":"2013-01-30T21:12:28Z","question":"Is
+        bacon delicious?","updated_at":"2013-02-04T19:18:57Z","user_id":1,"pusher_channel":"decision-1-18","timeline_key":"1,18","analytics":{"views":0,"unique_viewers":0,"referrers":{},"votes":{},"total_votes":0},"user_vote":null,"choices":[{"created_at":"2013-01-30T21:12:28Z","decision_id":18,"decision_user_id":1,"id":5,"meta":{"link_url":"http://seesaw.co","link_title":"Seesaw"},"position":1,"subject":"Test
+        Image","type":"ImageChoice","updated_at":"2013-01-30T21:12:28Z","image_uri":"https://recess-dev.s3.amazonaws.com/gotwalt-pro.sf.gotwalt.com/decisions/18/5/1359580348/photo.png"},{"created_at":"2013-01-30T21:12:28Z","decision_id":18,"decision_user_id":1,"id":6,"meta":null,"position":2,"subject":null,"type":"NoChoice","updated_at":"2013-01-30T21:12:28Z"}],"invitations":[],"user":{"biography":null,"created_at":"2013-01-23T03:22:06Z","family_name":"Gotwalt","given_name":"Aaron","id":1,"meta":null,"moderated_decisions_count":null,"updated_at":"2013-02-04T19:29:42Z","username":null,"website":null,"avatar_url":"https://recess-dev.s3.amazonaws.com/default_avatars/v1/photo_1.png","full_name":"Aaron
+        Gotwalt","short_name":"Aaron G","display_name":"Aaron Gotwalt","short_display_name":"Aaron
+        G","analytics":{"votes":0,"decisions":0,"followers":0,"following":0}},"slug":"d/3I1H0y"}]'
+    http_version: 
+  recorded_at: Mon, 04 Feb 2013 19:29:56 GMT
+recorded_with: VCR 2.4.0

data/test/cassettes/timelines/hashtags.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:5000/v1/timelines/global?hashtag=test&limit=20
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+      Authorization:
+      - Bearer 9774e653f7b3c1de5f21b61adc08ba24
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Pusher-Channel:
+      - timeline-hashtag-test
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - ! '"c1d0337dfe70d635647580d02353f205"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - a83418585d2c5d07038bcef9cb0d0486
+      X-Runtime:
+      - '0.337964'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: US-ASCII
+      string: ! '[{"created_at":"2013-01-30T21:12:28Z","final_vote_id":null,"flag_count":null,"id":18,"is_private":false,"meta":{"is_binary":true},"published_at":"2013-01-30T21:12:28Z","question":null,"updated_at":"2013-01-30T21:12:28Z","user_id":1,"pusher_channel":"decision-1-18","timeline_key":"1,18","analytics":{"views":0,"unique_viewers":0,"referrers":{},"votes":{},"total_votes":0},"user_vote":null,"choices":[{"created_at":"2013-01-30T21:12:28Z","decision_id":18,"decision_user_id":1,"id":5,"meta":{"link_url":"http://seesaw.co","link_title":"Seesaw"},"position":1,"subject":"Test
+        Image","type":"ImageChoice","updated_at":"2013-01-30T21:12:28Z","image_uri":"https://recess-dev.s3.amazonaws.com/gotwalt-pro.sf.gotwalt.com/decisions/18/5/1359580348/photo.png"},{"created_at":"2013-01-30T21:12:28Z","decision_id":18,"decision_user_id":1,"id":6,"meta":null,"position":2,"subject":null,"type":"NoChoice","updated_at":"2013-01-30T21:12:28Z"}],"invitations":[],"user":{"biography":null,"created_at":"2013-01-23T03:22:06Z","family_name":"Gotwalt","given_name":"Aaron","id":1,"meta":null,"moderated_decisions_count":null,"updated_at":"2013-02-03T06:41:56Z","username":null,"website":null,"avatar_url":"https://recess-dev.s3.amazonaws.com/default_avatars/v1/photo_1.png","full_name":"Aaron
+        Gotwalt","short_name":"Aaron G","display_name":"Aaron Gotwalt","short_display_name":"Aaron
+        G","analytics":{"votes":0,"decisions":0,"followers":0,"following":0}},"slug":"d/3I1H0y"}]'
+    http_version: 
+  recorded_at: Mon, 04 Feb 2013 19:07:15 GMT
+recorded_with: VCR 2.4.0

data/test/cassettes/timelines/search.yml

@@ -0,0 +1,54 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:5000/v1/timelines/search?limit=20&query=bacon
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+      Authorization:
+      - Bearer 9774e653f7b3c1de5f21b61adc08ba24
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - ! '"9740321d7584c33d22f5bf297e767267"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - 8f9f928e84450131f026d85998866d15
+      X-Runtime:
+      - '0.053194'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: US-ASCII
+      string: ! '[{"created_at":"2013-01-30T21:14:26Z","final_vote_id":null,"flag_count":null,"id":19,"is_private":false,"meta":{"is_binary":true,"question_display_text":"Should
+        I add more bacon?","question_display_html":"Should I add more bacon?","question_entities":[]},"published_at":"2013-01-30T21:14:26Z","question":"Should
+        I add more bacon?","updated_at":"2013-02-04T19:17:43Z","user_id":1,"pusher_channel":"decision-1-19","timeline_key":"1,19","analytics":{"views":0,"unique_viewers":0,"referrers":{},"votes":{},"total_votes":0},"user_vote":null,"choices":[{"created_at":"2013-01-30T21:14:26Z","decision_id":19,"decision_user_id":1,"id":7,"meta":{"link_url":"http://seesaw.co","link_title":"Seesaw"},"position":1,"subject":"Test
+        Image","type":"ImageChoice","updated_at":"2013-01-30T21:14:26Z","image_uri":"https://recess-dev.s3.amazonaws.com/gotwalt-pro.sf.gotwalt.com/decisions/19/7/1359580466/photo.png"},{"created_at":"2013-01-30T21:14:26Z","decision_id":19,"decision_user_id":1,"id":8,"meta":null,"position":2,"subject":null,"type":"NoChoice","updated_at":"2013-01-30T21:14:26Z"}],"invitations":[],"user":{"biography":null,"created_at":"2013-01-23T03:22:06Z","family_name":"Gotwalt","given_name":"Aaron","id":1,"meta":null,"moderated_decisions_count":null,"updated_at":"2013-02-03T06:41:56Z","username":null,"website":null,"avatar_url":"https://recess-dev.s3.amazonaws.com/default_avatars/v1/photo_1.png","full_name":"Aaron
+        Gotwalt","short_name":"Aaron G","display_name":"Aaron Gotwalt","short_display_name":"Aaron
+        G","analytics":{"votes":0,"decisions":0,"followers":0,"following":0}},"slug":"d/0P082U"},{"created_at":"2013-01-30T21:12:28Z","final_vote_id":null,"flag_count":null,"id":18,"is_private":false,"meta":{"is_binary":true,"question_display_text":"Is
+        bacon delicious?","question_display_html":"Is bacon delicious?","question_entities":[]},"published_at":"2013-01-30T21:12:28Z","question":"Is
+        bacon delicious?","updated_at":"2013-02-04T19:17:31Z","user_id":1,"pusher_channel":"decision-1-18","timeline_key":"1,18","analytics":{"views":0,"unique_viewers":0,"referrers":{},"votes":{},"total_votes":0},"user_vote":null,"choices":[{"created_at":"2013-01-30T21:12:28Z","decision_id":18,"decision_user_id":1,"id":5,"meta":{"link_url":"http://seesaw.co","link_title":"Seesaw"},"position":1,"subject":"Test
+        Image","type":"ImageChoice","updated_at":"2013-01-30T21:12:28Z","image_uri":"https://recess-dev.s3.amazonaws.com/gotwalt-pro.sf.gotwalt.com/decisions/18/5/1359580348/photo.png"},{"created_at":"2013-01-30T21:12:28Z","decision_id":18,"decision_user_id":1,"id":6,"meta":null,"position":2,"subject":null,"type":"NoChoice","updated_at":"2013-01-30T21:12:28Z"}],"invitations":[],"user":{"biography":null,"created_at":"2013-01-23T03:22:06Z","family_name":"Gotwalt","given_name":"Aaron","id":1,"meta":null,"moderated_decisions_count":null,"updated_at":"2013-02-03T06:41:56Z","username":null,"website":null,"avatar_url":"https://recess-dev.s3.amazonaws.com/default_avatars/v1/photo_1.png","full_name":"Aaron
+        Gotwalt","short_name":"Aaron G","display_name":"Aaron Gotwalt","short_display_name":"Aaron
+        G","analytics":{"votes":0,"decisions":0,"followers":0,"following":0}},"slug":"d/3I1H0y"}]'
+    http_version: 
+  recorded_at: Mon, 04 Feb 2013 19:18:03 GMT
+recorded_with: VCR 2.4.0

data/test/cassettes/timelines/stickers.yml

@@ -0,0 +1,49 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:5000/v1/timelines/global?limit=20&sticker=test
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - ! '*/*'
+      User-Agent:
+      - Ruby
+      Authorization:
+      - Bearer 9774e653f7b3c1de5f21b61adc08ba24
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      X-Pusher-Channel:
+      - timeline-hashtag-test
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - ! '"c1d0337dfe70d635647580d02353f205"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - a83418585d2c5d07038bcef9cb0d0486
+      X-Runtime:
+      - '0.337964'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: US-ASCII
+      string: ! '[{"created_at":"2013-01-30T21:12:28Z","final_vote_id":null,"flag_count":null,"id":18,"is_private":false,"meta":{"is_binary":true},"published_at":"2013-01-30T21:12:28Z","question":null,"updated_at":"2013-01-30T21:12:28Z","user_id":1,"pusher_channel":"decision-1-18","timeline_key":"1,18","analytics":{"views":0,"unique_viewers":0,"referrers":{},"votes":{},"total_votes":0},"user_vote":null,"choices":[{"created_at":"2013-01-30T21:12:28Z","decision_id":18,"decision_user_id":1,"id":5,"meta":{"link_url":"http://seesaw.co","link_title":"Seesaw"},"position":1,"subject":"Test
+        Image","type":"ImageChoice","updated_at":"2013-01-30T21:12:28Z","image_uri":"https://recess-dev.s3.amazonaws.com/gotwalt-pro.sf.gotwalt.com/decisions/18/5/1359580348/photo.png"},{"created_at":"2013-01-30T21:12:28Z","decision_id":18,"decision_user_id":1,"id":6,"meta":null,"position":2,"subject":null,"type":"NoChoice","updated_at":"2013-01-30T21:12:28Z"}],"invitations":[],"user":{"biography":null,"created_at":"2013-01-23T03:22:06Z","family_name":"Gotwalt","given_name":"Aaron","id":1,"meta":null,"moderated_decisions_count":null,"updated_at":"2013-02-03T06:41:56Z","username":null,"website":null,"avatar_url":"https://recess-dev.s3.amazonaws.com/default_avatars/v1/photo_1.png","full_name":"Aaron
+        Gotwalt","short_name":"Aaron G","display_name":"Aaron Gotwalt","short_display_name":"Aaron
+        G","analytics":{"votes":0,"decisions":0,"followers":0,"following":0}},"slug":"d/3I1H0y"}]'
+    http_version:
+  recorded_at: Mon, 04 Feb 2013 19:07:15 GMT
+recorded_with: VCR 2.4.0

data/test/totter/client/timelines_test.rb

@@ -3,7 +3,35 @@ require 'test_helper'
 class TimelinesTest < Totter::TestCase
   def test_global
     VCR.use_cassette 'timelines/global' do
-      assert_equal 15, Totter.global_timeline(15).length
+      assert_equal 15, Totter.global_timeline(limit: 15).length
+    end
+  end
+
+  def test_hashtags
+    VCR.use_cassette 'timelines/hashtags' do
+      client = local_client
+      assert_equal 1, local_client.hashtag_timeline('test').length
+    end
+  end
+
+  def test_stickers
+    VCR.use_cassette 'timelines/stickers' do
+      client = local_client
+      assert_equal 1, local_client.sticker_timeline('test').length
+    end
+  end
+
+  def test_search
+    VCR.use_cassette 'timelines/search' do
+      client = local_client
+      assert_equal 2, local_client.search_timeline('bacon').length
+    end
+  end
+
+  def test_flagged
+    VCR.use_cassette 'timelines/flagged' do
+      client = local_client
+      assert_equal 1, local_client.flagged_timeline.length
     end
   end
 end

data/totter.gemspec

@@ -21,4 +21,5 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9.2'
   gem.add_dependency 'multi_json', '~> 1.5.0'
   gem.add_dependency 'hashie', '~> 1.2.0'
+  gem.add_dependency 'addressable', '~> 2.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: totter
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-03 00:00:00.000000000 Z
+date: 2013-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -44,6 +44,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 description: Ruby gem for working with the Seesaw API.
 email:
 - sam@soff.es
@@ -86,7 +102,11 @@ files:
 - test/cassettes/decisions/show.yml
 - test/cassettes/decisions/unflag.yml
 - test/cassettes/slugs/show.yml
+- test/cassettes/timelines/flagged.yml
 - test/cassettes/timelines/global.yml
+- test/cassettes/timelines/hashtags.yml
+- test/cassettes/timelines/search.yml
+- test/cassettes/timelines/stickers.yml
 - test/cassettes/users/following.yml
 - test/cassettes/users/me.yml
 - test/cassettes/users/update.yml
@@ -146,7 +166,11 @@ test_files:
 - test/cassettes/decisions/show.yml
 - test/cassettes/decisions/unflag.yml
 - test/cassettes/slugs/show.yml
+- test/cassettes/timelines/flagged.yml
 - test/cassettes/timelines/global.yml
+- test/cassettes/timelines/hashtags.yml
+- test/cassettes/timelines/search.yml
+- test/cassettes/timelines/stickers.yml
 - test/cassettes/users/following.yml
 - test/cassettes/users/me.yml
 - test/cassettes/users/update.yml