totter 0.2.3 → 0.2.4

data/Readme.markdown

@@ -6,7 +6,9 @@ All networking is done with Net::HTTP so you don't have to worry about version c
 
 Read the [documentation](http://rubydoc.info/github/seesawco/totter-rb/master/frames) online.
 
-[![Build Status](https://travis-ci.org/seesawco/totter-rb.png?branch=master)](https://travis-ci.org/seesawco/totter-rb) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/seesawco/totter-rb)
+[![Build Status](https://travis-ci.org/seesawco/totter-rb.png?branch=master)](https://travis-ci.org/seesawco/totter-rb)
+
+[![Code Climate](https://codeclimate.com/github/seesawco/totter-rb.png)](https://codeclimate.com/github/seesawco/totter-rb)
 
 ## Installation
 

data/lib/totter/client/timelines.rb

@@ -2,17 +2,22 @@ module Totter
   class Client
     # Client methods for working with timelines
     module Timelines
+      # Default options sent with every timeline request unless otherwise specified.
+      DEFAULT_TIMELINE_OPTIONS = {
+        limit: 20
+      }
+
       # Get recent decisions from the global 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]
+      # @return [Array] An array of `Hashie::Mash` objects representing decisions
       # @example
       #   Seesaw.global_timeline(limit: 20, since: '1,15')
-      def global_timeline(options = default_options)
-        get "timelines/global", options
+      def global_timeline(options = DEFAULT_TIMELINE_OPTIONS)
+        get 'timelines/global', options
       end
 
       # Get recent decisions from a hashtag timeline
@@ -22,11 +27,11 @@ module Totter
       # @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]
+      # @return [Array] An array of `Hashie::Mash` objects representing decisions
       # @example
       #   Seesaw.global_timeline(limit: 20, since: '1,15')
-      def hashtag_timeline(hashtag, options = default_options)
-        get "timelines/global", options.merge({hashtag: hashtag})
+      def hashtag_timeline(hashtag, options = DEFAULT_TIMELINE_OPTIONS)
+        get 'timelines/global', options.merge({hashtag: hashtag})
       end
 
       # Get recent decisions from a sticker timeline
@@ -39,8 +44,8 @@ module Totter
       # @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})
+      def sticker_timeline(sticker, options = DEFAULT_TIMELINE_OPTIONS)
+        get 'timelines/global', options.merge({sticker: sticker})
       end
 
       # Search for published items
@@ -50,11 +55,11 @@ module Totter
       # @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]
+      # @return [Array] An array of `Hashie::Mash` objects representing decisions
       # @example
       #   Seesaw.global_timeline(limit: 20, since: '1,15')
-      def search_timeline(query, options = default_options)
-        get "timelines/search", options.merge({query: query})
+      def search_timeline(query, options = DEFAULT_TIMELINE_OPTIONS)
+        get 'timelines/search', options.merge({query: query})
       end
 
       # Get recent decisions from the flagged-for-review timeline
@@ -63,19 +68,25 @@ module Totter
       # @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]
+      # @return [Array] An array of `Hashie::Mash` objects representing decisions
       # @example
       #   Seesaw.global_timeline(limit: 20, since: '1,15')
-      def flagged_timeline(options = default_options)
-        get "timelines/flagged", options
+      def flagged_timeline(options = DEFAULT_TIMELINE_OPTIONS)
+        get 'timelines/flagged', options
       end
 
-      private
-
-      def default_options
-        {
-          limit: 20
-        }
+      # Get recent decisions from a given user.
+      #
+      # @param user_id [Fixnum] The user ID for the timeline you are trying to view.
+      # @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] An array of `Hashie::Mash` objects representing decisions
+      # @example
+      #   Seesaw.user_timeline(4, limit: 20, since: '1,15')
+      def user_timeline(user_id, options = DEFAULT_TIMELINE_OPTIONS)
+        get "users/#{user_id}/timelines/user", options
       end
     end
   end

data/lib/totter/client.rb

@@ -1,21 +1,10 @@
-require 'net/http'
-require 'net/https'
-require 'uri'
-require 'multi_json'
-require 'hashie'
-require 'addressable/uri'
-
-require 'totter/client/users'
-require 'totter/client/decisions'
-require 'totter/client/slugs'
-require 'totter/client/timelines'
-require 'totter/client/choices'
-require 'totter/client/votes'
-require 'totter/client/avatars'
+require 'totter/transport'
 
 module Totter
   # API client for interacting with the Seesaw API
   class Client
+    Dir[File.expand_path('../client/*.rb', __FILE__)].each { |f| require f }
+
     include Totter::Client::Decisions
     include Totter::Client::Users
     include Totter::Client::Slugs
@@ -28,10 +17,11 @@ module Totter
     attr_reader :api_scheme
     attr_reader :api_host
     attr_reader :api_version
+    attr_reader :transport
 
     # Initialize a new client.
     #
-    # @param options [Hash] optionally specify `:access_token`, `:api_scheme`, `:api_host`, `:api_version`, or `:client_token`
+    # @param options [Hash] optionally specify `:access_token`, `:api_scheme`, `:api_host`, `:api_version`, `:client_token`, or `:transport`.
     def initialize(options = {})
       options = { access_token: options } if options.is_a? String
 
@@ -40,6 +30,12 @@ module Totter
       @api_host = (options[:api_host] or 'api.seesaw.co')
       @api_version = (options[:api_version] or 1)
       @client_token = options[:client_token] if options[:client_token]
+      @transport = (options[:transport] or :http)
+
+      # Include transport
+      transport_module = Totter::Transport::TRANSPORT_MAP[@transport]
+      raise 'Invalid transport' unless transport_module
+      self.extend transport_module
     end
 
     # API base URL.
@@ -62,105 +58,5 @@ module Totter
     def ssl?
       @api_scheme == 'https'
     end
-
-  private
-
-    def http
-      return @http if @http
-
-      uri = URI.parse(self.base_url)
-      @http = Net::HTTP.new(uri.host, uri.port)
-      @http.use_ssl = self.ssl?
-      @http
-    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)
-
-      # Add headers
-      request['Authorization'] = "Bearer #{self.access_token}" if authenticated?
-      request['X-Seesaw-Client-Token'] = @client_token if @client_token
-      request['Content-Type'] = 'application/json'
-
-      # Add params as JSON if they exist
-      request.body = MultiJson.dump(params) if can_post_data?(method) and params
-
-      # Request
-      response = http.request(request)
-
-      # Check for errors
-      handle_error(response)
-
-      # Return the raw response object
-      response
-    end
-
-    def build_request(method, uri)
-      case method
-        when :get
-          Net::HTTP::Get.new(uri.request_uri)
-        when :post
-          Net::HTTP::Post.new(uri.request_uri)
-        when :put
-          Net::HTTP::Put.new(uri.request_uri)
-        when :delete
-          Net::HTTP::Delete.new(uri.request_uri)
-      end
-    end
-
-    def handle_error(response)
-      # Find error or return
-      return unless error = Totter::ERROR_MAP[response.code.to_i]
-
-      # Try to add a useful message
-      message = nil
-      begin
-        message = MultiJson.load(response.body)['error_description']
-      rescue MultiJson::DecodeError => e
-      end
-
-      # Raise error
-      raise error.new(message)
-    end
-
-    def json_request(*args)
-      # Preform request
-      response = request(*args)
-
-      # Parse JSON
-      object = MultiJson.load(response.body)
-
-      # Hash
-      return Hashie::Mash.new(object) if object.is_a? Hash
-
-      # Array
-      return object.map { |h| Hashie::Mash.new(h) } if object.is_a? Array
-
-      # Fallback incase it's not a hash or array
-      object
-    end
-
-    def boolean_from_response(*args)
-      response = request(*args)
-      (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)
-      end
-    end
   end
 end

data/lib/totter/transport/http.rb

@@ -0,0 +1,113 @@
+module Totter
+  module Transport
+    # Default HTTP API transport adapter
+    module HTTP
+      require 'net/http'
+      require 'net/https'
+      require 'uri'
+      require 'multi_json'
+      require 'hashie'
+
+    private
+
+      def http
+        return @http if @http
+
+        uri = URI.parse(self.base_url)
+        @http = Net::HTTP.new(uri.host, uri.port)
+        @http.use_ssl = self.ssl?
+        @http
+      end
+
+      def request(method, path, params = nil)
+        uri = 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)
+          query_values = uri.query ? URI.decode_www_form(uri.query).inject({}) {|h,(k,v)| h[k]=v; h} : {}
+          uri.query = URI.encode_www_form (query_values || {}).merge(params)
+        end
+
+        # Build request
+        request = build_request(method, uri)
+
+        # Add headers
+        request['Authorization'] = "Bearer #{self.access_token}" if authenticated?
+        request['X-Seesaw-Client-Token'] = @client_token if @client_token
+        request['Content-Type'] = 'application/json'
+
+        # Add params as JSON if they exist
+        request.body = MultiJson.dump(params) if can_post_data?(method) and params
+
+        # Request
+        response = http.request(request)
+
+        # Check for errors
+        handle_error(response)
+
+        # Return the raw response object
+        response
+      end
+
+      def build_request(method, uri)
+        case method
+          when :get
+            Net::HTTP::Get.new(uri.request_uri)
+          when :post
+            Net::HTTP::Post.new(uri.request_uri)
+          when :put
+            Net::HTTP::Put.new(uri.request_uri)
+          when :delete
+            Net::HTTP::Delete.new(uri.request_uri)
+        end
+      end
+
+      def handle_error(response)
+        # Find error or return
+        return unless error = Totter::ERROR_MAP[response.code.to_i]
+
+        # Try to add a useful message
+        message = nil
+        begin
+          message = MultiJson.load(response.body)['error_description']
+        rescue MultiJson::DecodeError => e
+        end
+
+        # Raise error
+        raise error.new(message)
+      end
+
+      def json_request(*args)
+        # Preform request
+        response = request(*args)
+
+        # Parse JSON
+        object = MultiJson.load(response.body)
+
+        # Hash
+        return Hashie::Mash.new(object) if object.is_a? Hash
+
+        # Array
+        return object.map { |h| Hashie::Mash.new(h) } if object.is_a? Array
+
+        # Fallback incase it's not a hash or array
+        object
+      end
+
+      def boolean_from_response(*args)
+        response = request(*args)
+        (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)
+        end
+      end
+    end
+  end
+end

data/lib/totter/transport.rb

@@ -0,0 +1,11 @@
+module Totter
+  # Transports are a way for the client to communicate with the API.
+  module Transport
+    Dir[File.expand_path('../transport/*.rb', __FILE__)].each { |f| require f }
+
+    # Transport adapter map
+    TRANSPORT_MAP = {
+      http: Totter::Transport::HTTP
+    }
+  end
+end

data/lib/totter/version.rb

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

data/test/cassettes/timelines/user.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: http://localhost:5000/v1/users/4/timelines/user?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-user-4
+      Content-Type:
+      - application/json; charset=utf-8
+      X-Ua-Compatible:
+      - IE=Edge
+      Etag:
+      - ! '"d751713988987e9331980363e24189ce"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Request-Id:
+      - aeaaf8b6b674667481f04ef39c7f0812
+      X-Runtime:
+      - '0.009301'
+      Connection:
+      - close
+      Server:
+      - thin 1.5.0 codename Knife
+    body:
+      encoding: US-ASCII
+      string: ! '[]'
+    http_version: 
+  recorded_at: Tue, 05 Feb 2013 16:21:27 GMT
+recorded_with: VCR 2.4.0

data/test/totter/client/timelines_test.rb

@@ -34,4 +34,11 @@ class TimelinesTest < Totter::TestCase
       assert_equal 1, local_client.flagged_timeline.length
     end
   end
+
+  def test_user
+    VCR.use_cassette 'timelines/user' do
+      client = local_client
+      assert_equal 0, local_client.user_timeline(4).length
+    end
+  end
 end

data/totter.gemspec

@@ -21,5 +21,4 @@ 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.3
+  version: 0.2.4
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-04 00:00:00.000000000 Z
+date: 2013-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -44,22 +44,6 @@ 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
@@ -85,6 +69,8 @@ files:
 - lib/totter/client/users.rb
 - lib/totter/client/votes.rb
 - lib/totter/error.rb
+- lib/totter/transport.rb
+- lib/totter/transport/http.rb
 - lib/totter/version.rb
 - test/cassettes/avatars/create.yml
 - test/cassettes/avatars/destroy.yml
@@ -107,6 +93,7 @@ files:
 - test/cassettes/timelines/hashtags.yml
 - test/cassettes/timelines/search.yml
 - test/cassettes/timelines/stickers.yml
+- test/cassettes/timelines/user.yml
 - test/cassettes/users/following.yml
 - test/cassettes/users/me.yml
 - test/cassettes/users/update.yml
@@ -143,6 +130,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3570192698254323384
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -171,6 +161,7 @@ test_files:
 - test/cassettes/timelines/hashtags.yml
 - test/cassettes/timelines/search.yml
 - test/cassettes/timelines/stickers.yml
+- test/cassettes/timelines/user.yml
 - test/cassettes/users/following.yml
 - test/cassettes/users/me.yml
 - test/cassettes/users/update.yml