dancroak-ruby-summize 0.4

data/README.markdown

@@ -0,0 +1,70 @@
+# A simple Summize client for Ruby.
+
+Access the Summize API from your Ruby code.
+
+## Usage
+
+Require the gem.
+
+    require 'summize'
+
+Set up a Summize::Client. Name your client (a.k.a. 'user agent') to something meaningful, such as your app's name. This helps Summize answer any questions about your use of the API.
+
+	@client = Summize::Client.new 'politweets'
+	
+Request tweets by calling the query method of your client. It takes either a String or a Hash of arguments.
+
+    @tweets = @client.query 'twitter search'
+
+The String form uses the default Summize behavior, which in this example finds tweets containing both "twitter" and "search". It is identical to the more verbose, explicit version:
+
+    @tweets = @client.query :q => 'twitter search'
+    
+Use Summize's query operators with the :q key to access the following behavior:
+
+<table>
+		<tr><th>Operator</th><th>Finds tweets...</th></tr>
+    
+		<tr><td><a href="http://summize.com/search?q=twitter+search">:q => 'twitter search'</a></td><td>containing both "twitter" and "search". This is the default operator.</td></tr>
+		<tr><td><a href="http://summize.com/search?q=%22happy+hour%22">:q => '<b>"</b>happy hour<b>"</b>'</a></td><td>containing the exact phrase "happy hour".</td></tr>
+		<tr><td><a href="http://summize.com/search?q=obama+OR+hillary">:q => 'obama <b>OR</b> hillary'</a></td><td>containing either "obama" or "hillary" (or both).</td></tr>
+    
+		<tr><td><a href="http://summize.com/search?q=beer+-root">:q => 'beer <b>-</b>root'</a></td><td>containing "beer" but not "root".</td></tr>
+		<tr><td><a href="http://summize.com/search?q=%23haiku">:q => '<b>#</b>haiku</a>'</td><td>containing the hashtag "haiku".</td></tr>	
+		<tr><td><a href="http://summize.com/search?q=from%3Aalexiskold">:q => '<b>from:</b>alexiskold'</a></td><td>sent from person "alexiskold".</td></tr>	
+		<tr><td><a href="http://summize.com/search?q=to%3Atechcrunch">:q => '<b>to:</b>techcrunch</a>'</td><td>sent to person "techcrunch".</td></tr>	
+		<tr><td><a href="http://summize.com/search?q=%40mashable">:q => '<b>@</b>mashable</a>'</td><td>referencing person "mashable".</td></tr>
+    
+		<tr><td><a href="http://summize.com/search?q=superhero+since%3A2008-05-01">:q => 'superhero <b>since:</b>2008-05-01'</a></td><td>containing "superhero" and sent since date "2008-05-01" (year-month-day).</td></tr>
+    
+		<tr><td><a href="http://summize.com/search?q=ftw+until%3A2008-05-03">:q => 'ftw <b>until:</b>2008-05-03'</a></td><td>containing "ftw" and sent up to date "2008-05-03".</td></tr>
+		<tr><td><a href="http://summize.com/search?q=movie+-scary+%3A%29">:q => 'movie -scary <b>:)</b>'</a></td><td>containing "movie", but not "scary", and with a positive attitude.</td></tr>
+		<tr><td><a href="http://summize.com/search?q=flight+%3A%28">:q => 'flight <b>:(</b>'</a></td><td>containing "flight" and with a negative attitude.</td></tr>
+		<tr><td><a href="http://summize.com/search?q=traffic+%3F">:q => 'traffic <b>?</b>'</a></td><td>containing "traffic" and asking a question.</td></tr>
+    
+		<tr><td><a href="http://summize.com/search?q=hilarious+filter%3Alinks">:q => 'hilarious <b>filter:links</b>'</a></td><td>containing "hilarious" and linking to URLs.</td></tr>
+</table>
+
+### Foreign Languages
+
+The Summize API supports foreign languages, accessible via the :lang key. Use the [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) codes as the value:
+
+    @tweets = @client.query :q => 'programmé', :lang => 'fr'
+
+## Gotchas
+
+* Searches are case-insenstive.
+* The "near" operator available in the Summize web interface is not available via the API. You must geocode before making your Summize API call.
+* Searching for a positive attitude :) returns tweets containing the text :), =), :D, and :-)
+
+## Authors
+
+Written by Dustin Sallings (dustin@spy.net), forked by Dan Croak (dcroak@thoughtbot.com).
+
+## Resources
+
+* [Official Summize API](http://summize.com/api)
+
+## License
+
+MIT License, same terms as Ruby.

data/lib/summize.rb

@@ -0,0 +1,65 @@
+require 'rubygems'
+require 'net/http'
+require 'json'
+require 'cgi'
+
+module Summize
+
+  class Tweet
+    VARS = [:text, :from_user, :created_at, :id]
+    attr_reader *VARS
+    attr_reader :language
+    
+    def initialize(h)
+      @language = h['iso_language_code']
+      VARS.each { |v| instance_variable_set "@#{v}", h[v.to_s] }
+    end
+  end
+
+  class Tweets
+    VARS = [:since_id, :max_id, :results_per_page, :page, :query, :next_page]
+    attr_reader *VARS
+
+    include Enumerable
+
+    def initialize(h)
+      @results = h['results'].map { |tweet| Tweet.new tweet }
+      VARS.each { |v| instance_variable_set "@#{v}", h[v.to_s] }
+    end
+
+    def each(&block)
+      @results.each(&block)
+    end
+
+    def size
+      @results.size
+    end
+  end
+
+  class Client
+    def initialize(agent = 'ruby-summize')
+      @agent = agent
+    end
+
+    def query(opts = {})
+      url = URI.parse 'http://search.twitter.com/search.json'
+      url.query = sanitize_query opts
+      Tweets.new JSON.parse(Net::HTTP.get(url))
+    end
+
+    private
+
+      def sanitize_query(opts)
+        if opts.is_a? String
+          "q=#{CGI.escape(opts)}" 
+        elsif opts.is_a? Hash
+          "#{sanitize_query_hash(opts)}"
+        end
+      end
+
+      def sanitize_query_hash(query_hash)
+        query_hash.map{ |k,v| "#{CGI.escape(k.to_s)}=#{CGI.escape(v.to_s)}" }.join('&')
+      end
+  end
+
+end

data/ruby-summize.gemspec

@@ -0,0 +1,15 @@
+Gem::Specification.new do |s|
+  s.name             = "ruby-summize"
+  s.version          = "0.4"
+  s.date             = "2008-07-13"
+  s.summary          = "Ruby client for Summize."
+  s.email            = "dustin@spy.net"
+  s.homepage         = "http://github.com/dancroak/ruby-summize"
+  s.description      = "A Ruby client for the Summize conversational search engine."
+  s.has_rdoc         = true
+  s.authors          = ["Dustin Sallings", "Dan Croak"]
+  s.files            = ["README.markdown", "ruby-summize.gemspec", "lib/summize.rb"]
+  s.rdoc_options     = ["--main", "README.markdown"]
+  s.extra_rdoc_files = ["README.markdown"]
+  s.add_dependency('json', '>= 1.1.2')
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification 
+name: dancroak-ruby-summize
+version: !ruby/object:Gem::Version 
+  version: "0.4"
+platform: ruby
+authors: 
+- Dustin Sallings
+- Dan Croak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-13 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+description: A Ruby client for the Summize conversational search engine.
+email: dustin@spy.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.markdown
+files: 
+- README.markdown
+- ruby-summize.gemspec
+- lib/summize.rb
+has_rdoc: true
+homepage: http://github.com/dancroak/ruby-summize
+post_install_message: 
+rdoc_options: 
+- --main
+- README.markdown
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby client for Summize.
+test_files: []
+