otter-rb 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jeff Smick
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,9 @@
+otter-rb
+========
+
+An EventMachine based library for the Topsy Otter API.
+
+Copyright
+---------
+
+Copyright (c) 2009 Jeff Smick. See LICENSE for details.

data/lib/otter-rb.rb

@@ -0,0 +1,28 @@
+%w[
+  em-http
+  yajl
+
+  otter/connection
+  otter/response
+  otter/error
+
+  otter/base
+  otter/author
+  otter/post
+  otter/link
+  otter/count
+  otter/tag
+  otter/trackback
+  otter/topic
+  otter/urlinfo
+].each { |r| require r }
+
+module Otter
+
+  def self.connect(identifier, &block)
+    EM.run {
+      yield Connection.new(identifier)
+    }
+  end
+
+end

data/lib/otter/author.rb

@@ -0,0 +1,45 @@
+# "name" : "Barack Obama",
+# "url" : "http://twitter.com/barackobama",
+# "type" : "twitter",
+# "nick" : "barackobama",
+# "description" : "44th President of the United States",
+# "topsy_author_url" : "http://topsy.com/twitter/barackobama",
+# "influence_level" : "5"
+module Otter
+
+  class Author < Base
+
+    def name
+      self.data['name']
+    end
+
+    def type
+      self.data['type']
+    end
+
+    def nick
+      self.data['nick']
+    end
+
+    def description
+      self.data['description']
+    end
+
+    def topsy_author_url
+      self.data['topsy_author_url']
+    end
+
+    def influence_level
+      self.data['influence_level']
+    end
+
+    def topsy_author_url
+      self.data['topsy_author_url']
+    end
+
+    def photo_url
+      self.data['photo_url']
+    end
+  end
+
+end

data/lib/otter/base.rb

@@ -0,0 +1,19 @@
+module Otter
+
+  class Base
+    attr_reader :data
+
+    def self.create(data)
+      if data['list'].is_a?(Array)
+        data['list'].map { |d| self.new(d) }
+      else
+        self.new(data)
+      end
+    end
+
+    def initialize(data)
+      @data = data
+    end
+  end
+
+end

data/lib/otter/connection.rb

@@ -0,0 +1,93 @@
+module Otter
+
+  class Connection
+    def initialize(identifier)
+      @identifier = identifier
+    end
+
+    def authorinfo(username, &block)
+      self.request('authorinfo', {:url => "http://twitter.com/#{username}"}, Author, block)
+    end
+
+    def authorsearch(query, window = 'a', page = nil, perpage = nil, &block)
+      self.request('authorsearch', {:q => query, :window => window}, Author, block, page, perpage)
+    end
+
+    def linkposts(url, contains = nil, page = nil, perpage = nil, &block)
+      self.request('linkposts', {:url => url, :contains => contains}, Post, block, page, perpage)
+    end
+
+    def linkpostcount(url, contains = nil, &block)
+      self.request('linkpostcount', {:url => url, :contains => contains}, Base, lambda { |response, base|
+        if response.is_a?(Error)
+          block.call response
+        else
+          block.call response, Integer(base.data['contains']), Integer(base.data['all'])
+        end
+      })
+    end
+
+    def profilesearch(query, page = nil, perpage = nil, &block)
+      self.request('profilesearch', {:q => query}, Author, block, page, perpage)
+    end
+
+    def related(url, page = nil, perpage = nil, &block)
+      self.request('related', {:url => url}, Link, block, page, perpage)
+    end
+
+    def search(query, window = 'a', page = nil, perpage = nil, &block)
+      self.request('search', {:q => query, :window => window}, Link, block, page, perpage)
+    end
+
+    def searchcount(query, &block)
+      self.request('searchcount', {:q => query}, Count, block)
+    end
+
+    def stats(url, contains = nil, &block)
+      self.request('stats', {:url => url, :contains => contains}, Base, lambda { |response, base|
+        if response.is_a?(Error)
+          block.call response
+        else
+          block.call( response,
+                      base.data['topsy_trackback_url'],
+                      Integer(base.data['contains']),
+                      Integer(base.data['influential']),
+                      Integer(base.data['all']))
+        end
+      })
+    end
+
+    def tags(url, page = nil, perpage = nil, &block)
+      self.request('tags', {:url => url}, Tag, block, page, perpage)
+    end
+
+    def trackbacks(url, contains = nil, infonly = nil, page = nil, perpage = nil, &block)
+      self.request('trackbacks', {:url => url, :contains => contains, :infonly => infonly}, Trackback, block, page, perpage)
+    end
+
+    def trending(page = nil, perpage = nil, &block)
+      self.request('trending', nil, Topic, block, page, perpage)
+    end
+
+    def urlinfo(url, &block)
+      self.request('urlinfo', {:url => url}, UrlInfo, block)
+    end
+
+  protected
+    def request(url, params, klass, callback, page = nil, perpage = nil)
+      params[:page] = page if page
+      params[:perpage] = perpage if perpage
+
+      http = EM::HttpRequest.new("http://otter.topsy.com/#{url}.json", {'X-Topsy-UA' => @identifier}).get :query => params
+      http.callback {
+        body = Yajl::Parser.new.parse(http.response)['response']
+        callback.call(Response.new(http.response_header, body), klass.create(body))
+      }
+
+      http.errback {
+        callback.call(Error.new(http.status))
+      }
+    end
+  end
+
+end

data/lib/otter/count.rb

@@ -0,0 +1,25 @@
+module Otter
+
+  class Count < Base
+    def hour
+      Integer(self.data['h'])
+    end
+
+    def day
+      Integer(self.data['d'])
+    end
+
+    def week
+      Integer(self.data['w'])
+    end
+
+    def month
+      Integer(self.data['m'])
+    end
+
+    def all
+      Integer(self.data['a'])
+    end
+  end
+
+end

data/lib/otter/error.rb

@@ -0,0 +1,22 @@
+module Otter
+
+  class Error
+    attr_reader :code
+
+    def initialize(code)
+      @code = code.to_i
+    end
+
+    def message
+      case self.code
+      when 400 then 'Parameter Check Failed'
+      when 403 then 'Forbidden'
+      when 404 then 'Action Not Supported'
+      when 500 then 'Unexpected Internal Error'
+      when 503 then 'Temporarily Unavailable'
+      else 'Unkown'
+      end
+    end
+  end
+
+end

data/lib/otter/link.rb

@@ -0,0 +1,37 @@
+module Otter
+
+  class Link < Base
+    def topsy_trackback_url
+      self.data['topsy_trackback_url']
+    end
+
+    def url
+      self.data['url']
+    end
+
+    def title
+      self.data['title']
+    end
+
+    def trackback_total
+      self.data['trackback_total']
+    end
+
+    def hits
+      Integer(self.data['hits'])
+    end
+    
+    def content
+      self.data['content']
+    end
+    
+    def score
+      Float(self.data['score'])
+    end
+    
+    def highlight
+      self.data['highlight']
+    end
+  end
+
+end

data/lib/otter/post.rb

@@ -0,0 +1,39 @@
+module Otter
+
+  class Post < Base
+    def permalink_url
+      self.data['permalink_url']
+    end
+
+    def target
+      @target ||= Target.new(self.data['target'])
+    end
+
+    def date
+      Time.at(Integer(self.data['date']))
+    end
+
+    def content
+      self.data['content']
+    end
+
+    def date_alpha
+      self.data['date_alpha']
+    end
+
+    class Target < Base
+      def topsy_trackback_url
+        self.data['topsy_trackback_url']
+      end
+
+      def url
+        self.data['url']
+      end
+
+      def trackback_total
+        Integer(self.data['trackback_total'])
+      end
+    end  # Target
+  end  # Post
+
+end  # Otter

data/lib/otter/response.rb

@@ -0,0 +1,47 @@
+module Otter
+
+  class Response
+    attr_reader :headers,
+                :response
+
+    def initialize(headers, response) # :nodoc:
+      @headers = headers
+      @response = response
+    end
+
+    # Total credits that can be allocated.
+    def rate_limit
+      Integer(self.headers['X_RATELIMIT_LIMIT'])
+    end
+
+    # Total credits available.
+    def rate_remaining
+      Integer(self.headers['X_RATELIMIT_REMAINING'])
+    end
+
+    # Time when the credits will be reset.
+    def rate_reset
+      Time.at(Integer(self.headers['X_RATELIMIT_RESET']))
+    end
+
+    # Total number of results
+    def total
+      Integer(self.response['page'])
+    end
+
+    # Current page
+    def page
+      Integer(self.response['total'])
+    end
+
+    # Number of results per page
+    def perpage
+      Integer(self.response['perpage'])
+    end
+
+    def window
+      self.response['window']
+    end
+  end
+
+end

data/lib/otter/tag.rb

@@ -0,0 +1,13 @@
+module Otter
+  
+  class Tag < Base
+    def url
+      self.data['url']
+    end
+    
+    def name
+      self.data['name']
+    end
+  end
+  
+end

data/lib/otter/topic.rb

@@ -0,0 +1,13 @@
+module Otter
+
+  class Topic < Base
+    def url
+      self.data['url']
+    end
+
+    def term
+      self.data['term']
+    end
+  end
+
+end

data/lib/otter/trackback.rb

@@ -0,0 +1,29 @@
+module Otter
+
+  class Trackback < Base
+    def permalink_url
+      self.data['permalink_url']
+    end
+
+    def date
+      Time.at(Integer(self.data['date']))
+    end
+
+    def content
+      self.data['content']
+    end
+
+    def type
+      self.data['type']
+    end
+
+    def date_alpha
+      self.data['date_alpha']
+    end
+
+    def author
+      @author ||= Author.new(self.data['author'])
+    end
+  end
+
+end

data/lib/otter/urlinfo.rb

@@ -0,0 +1,34 @@
+module Otter
+
+  class UrlInfo < Base
+    def topsy_trackback_url
+      self.data['topsy_trackback_url']
+    end
+
+
+    def oneforty
+      self.data['oneforty']
+    end
+
+    def url
+      self.data['url']
+    end
+
+    def title
+      self.data['title']
+    end
+
+    def trackback_total
+      Integer(self.data['trackback_total'])
+    end
+
+    def description
+      self.data['description']
+    end
+
+    def description_attribution
+      self.data['description_attribution']
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'minittest/spec'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'otter-rb'
+
+MiniTest::Unit.autorun

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification 
+name: otter-rb
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Jeff Smick
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-08 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: em-http-request
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yajl-ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: minitest
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: An EventMachine based library for the Topsy Otter API.
+email: sprsquish@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- lib/otter-rb.rb
+- lib/otter/author.rb
+- lib/otter/base.rb
+- lib/otter/connection.rb
+- lib/otter/count.rb
+- lib/otter/error.rb
+- lib/otter/link.rb
+- lib/otter/post.rb
+- lib/otter/response.rb
+- lib/otter/tag.rb
+- lib/otter/topic.rb
+- lib/otter/trackback.rb
+- lib/otter/urlinfo.rb
+- LICENSE
+- README.md
+has_rdoc: true
+homepage: http://github.com/sprsquish/collecta-rb
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An EventMachine based library for the Topsy Otter API.
+test_files: 
+- spec/spec_helper.rb