backtyper 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+gem "httparty", ">= 0.6.0"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+  gem "rcov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,24 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.8)
+    git (1.2.5)
+    httparty (0.7.3)
+      crack (= 0.1.8)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rcov (0.9.9)
+    shoulda (2.11.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  httparty (>= 0.6.0)
+  jeweler (~> 1.5.2)
+  rcov
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Justin Britten
+
+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,75 @@
+# BackType API
+
+A simple Ruby wrapper for the [BackType API](http://www.backtype.com/developers).
+
+## Warning, Warning, Warning
+
+This is a work-in-progress.  The entire BackType API is not yet supported.  There is little error handling in place.  Tests are non-existent.  A gem has not yet been compiled and pushed to a repository.
+
+## Installation
+
+To install as a Gem:
+
+    sudo gem install backtyper
+
+## Authentication
+
+Authentication is necessary for all actions.
+
+    BackTyper.authenticate "api_key"
+
+---
+
+## Tweet examples
+
+* Documentation - {BackTyper::Tweets}
+
+---
+
+    # Authenticate with BackType
+    BackTyper.authenticate "ABC123"
+    
+    # Retrieve the number of tweets that link to a particular URL.
+    BackTyper::Tweets.count('http://www.google.com')    
+
+    # Retrieve filtered tweets that link to a given URL with both shortened and unshortened links.
+    # This returns a subset of Tweets by URL, but it filters tweets linking to a URL for quality.
+    # This skips all the tweets that only contain the page title, etc.
+    BackTyper::Tweets.good('http://www.google.com')    
+
+---
+
+## Comment examples
+
+* Documentation - {BackTyper::Comments}
+
+---
+
+    # Authenticate with BackType
+    BackTyper.authenticate "ABC123"
+    
+    # Retrieve all conversations related to a given URL.
+    BackTyper::Comments.connect('http://www.google.com')    
+
+    # Retrieve statistics on the conversations related to a given URL.
+    BackTyper::Comments.connect_stats('http://www.google.com')    
+
+---
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+* Send me a pull request. Bonus points for topic branches.
+
+## Author & Contributors
+
+* [Justin Britten](http://www.justinbritten.com)
+
+## Copyright
+
+Copyright (c) 2011 Justin Britten. See LICENSE.txt for details.

data/Rakefile

@@ -0,0 +1,52 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "backtyper"
+  gem.homepage = "http://github.com/jbritten/backtyper"
+  gem.license = "MIT"
+  gem.summary = %Q{A Ruby wrapper for the BackType API}
+  gem.description = %Q{A Ruby wrapper for the BackType API}
+  gem.email = "justinbritten@gmail.com"
+  gem.authors = ["Justin Britten"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  gem.add_runtime_dependency "httparty", ">= 0.6.0"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "backtyper #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/backtyper.gemspec

@@ -0,0 +1,73 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{backtyper}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Justin Britten"]
+  s.date = %q{2011-02-16}
+  s.description = %q{A Ruby wrapper for the BackType API}
+  s.email = %q{justinbritten@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "backtyper.gemspec",
+    "lib/backtyper.rb",
+    "lib/backtyper/client.rb",
+    "lib/backtyper/comments.rb",
+    "lib/backtyper/tweets.rb",
+    "test/helper.rb",
+    "test/test_backtyper.rb"
+  ]
+  s.homepage = %q{http://github.com/jbritten/backtyper}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{A Ruby wrapper for the BackType API}
+  s.test_files = [
+    "test/helper.rb",
+    "test/test_backtyper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.6.0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<httparty>, [">= 0.6.0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.6.0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<httparty>, [">= 0.6.0"])
+  end
+end
+

data/lib/backtyper/client.rb

@@ -0,0 +1,33 @@
+module BackTyper
+
+  class Client
+
+    include HTTParty
+    base_uri 'api.backtype.com'
+    format :json
+
+    def self.authenticate(key)
+      default_params :key => key
+    end
+
+    protected
+
+    def self.handle_response(response)
+      case response.code.to_i
+      when 403 then raise BadApiKeyError
+      when 200 then return response
+      when 400 then handle_bad_request(response.body)
+      else raise "Don't know how to handle code #{response.code.inspect}"
+      end
+    end
+
+    def self.handle_bad_request(body)
+      case body
+      when "No Such Object Exists" then raise NotFoundError
+      else raise "Don't know how to handle #{body.inspect}"
+      end
+    end
+    
+  end # class Client
+  
+end # module BackTyper

data/lib/backtyper/comments.rb

@@ -0,0 +1,38 @@
+module BackTyper
+
+  class Comments < Client
+    # 
+    # Retrieve excerpts of comments published on a particular page.
+    # 
+    #   url = The post url to return comments for
+    # 
+    def self.by_url(url, options={})
+      response = get('/post/comments.json', :query => {:url => url}.merge(options))
+      handle_response(response)
+    end
+
+    # 
+    # Retrieve all conversations related to a given URL.
+    # 
+    #   url = The URL you want related conversations for
+    #   sources = Comma delimited list of source titles (native, blog, digg, reddit, yc, friendfeed, twitter) or blog ID.
+    #   sort = If set to 1, results will be ordered by the date they were found by BackType.
+    # 
+    def self.connect(url, options={})
+      response = get('/connect.json', :query => {:url => url}.merge(options))
+      handle_response(response)
+    end
+
+    # 
+    # Retrieve statistics on the conversations related to a given URL.
+    # 
+    #   url = The URL you want related conversations for
+    # 
+    def self.connect_stats(url, options={})
+      response = get('/comments/connect/stats.json', :query => {:url => url}.merge(options))
+      handle_response(response)
+    end
+    
+  end # class Comments
+  
+end # module BackTyper

data/lib/backtyper/tweets.rb

@@ -0,0 +1,38 @@
+module BackTyper
+
+  class Tweets < Client
+    # 
+    # Retrieve the number of tweets that link to a particular URL.
+    # 
+    #   q = The url to return number of tweets for
+    # 
+    def self.count(q, options={})
+      response = get('/tweetcount.json', :query => {:q => q}.merge(options))
+      handle_response(response)
+    end
+
+    # 
+    # Retrieve tweets that link to a given URL, whether the links are shortened or unshortened.
+    # 
+    #   q = The url to return number of tweets for
+    # 
+    def self.by_url(q, options={})
+      response = get('/tweets/search/links.json', :query => {:q => q}.merge(options))
+      handle_response(response)
+    end
+    
+    # 
+    # Retrieve filtered tweets that link to a given URL with both shortened and unshortened links.
+    # This returns a subset of Tweets by URL, but it filters tweets linking to a URL for quality.
+    # This skips all the tweets that only contain the page title, etc.
+    # 
+    #   q = The url to return number of tweets for
+    # 
+    def self.good(q, options={})
+      response = get('/goodtweets.json', :query => {:q => q}.merge(options))
+      handle_response(response)
+    end
+    
+  end # class Tweets
+  
+end # module BackTyper

data/lib/backtyper.rb

@@ -0,0 +1,21 @@
+module BackTyper
+
+  def BackTyper.authenticate(key)
+    Client.authenticate(key)
+  end
+  
+  class BadApiKeyError < StandardError
+  end
+
+  class NotFoundError < StandardError
+  end
+    
+end # module BackTyper
+
+$:.unshift File.dirname(__FILE__)
+
+require "httparty"
+
+require 'backtyper/client'
+require 'backtyper/tweets'
+require 'backtyper/comments'

data/test/helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'backtyper'
+
+class Test::Unit::TestCase
+end

data/test/test_backtyper.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestBacktyper < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,173 @@
+--- !ruby/object:Gem::Specification 
+name: backtyper
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Justin Britten
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-16 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  name: httparty
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: shoulda
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  name: bundler
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  type: :development
+  name: jeweler
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  name: rcov
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 0
+        - 6
+        - 0
+        version: 0.6.0
+  type: :runtime
+  name: httparty
+  prerelease: false
+  version_requirements: *id006
+description: A Ruby wrapper for the BackType API
+email: justinbritten@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.md
+files: 
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- backtyper.gemspec
+- lib/backtyper.rb
+- lib/backtyper/client.rb
+- lib/backtyper/comments.rb
+- lib/backtyper/tweets.rb
+- test/helper.rb
+- test/test_backtyper.rb
+has_rdoc: true
+homepage: http://github.com/jbritten/backtyper
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A Ruby wrapper for the BackType API
+test_files: 
+- test/helper.rb
+- test/test_backtyper.rb