tweethook 0.1.0

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jordan Glasner
+
+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.rdoc

@@ -0,0 +1,96 @@
+= tweethook
+
+A simple Ruby wrapper for accessing Tweethook's API.
+
+= required gems
+
+* tyhpoeus
+* json
+
+= required ENV variables
+
+* TWEETHOOK_API_USER
+* TWEETHOOK_API_PASS
+* TWEETHOOK_SIGNATURE
+
+See http://docs.heroku.com/config-vars for the how and why.
+
+= Usage
+
+There are three main classes 
+
+* Tweethook::Search
+* Tweethook::Post
+* Tweethook::Result
+
+
+= Creating a new search
+
+search = Tweethook::Search.create('my keyword', :webhook => 'http://mysite.com/callback')
+
+All the properties are accessible as instance methods
+
+search.id => 12560301
+search.search => 'my keyword'
+search.webhook => 'http://mysite.com/callback'
+search.format => 'json' # this lib only works w/ the JSON format
+
+= Receiving a new post
+
+Tweethook::Post is a subclass of Array that takes the raw JSON from Tweethook. The JSON is parsed into a hash and the results are mapped to Tweethook::Result. The results can be accessed as if it was just an array, i.e post[0] = first result
+
+# example JSON from post (accessible in request.body)
+json = '{
+    "status_count": 2,
+    "signature": "XXXXXXXXXXXXXXXXXXXXXXXX",
+    "time": 1253055217,
+    "results": [{
+        "user": "deputy5765",
+        "tweet": "@Lu_Guz You will have to install a Twitter application in Facebook. Log in, search Twitter, install the app, then enter the info #geeksquad",
+        "usrimg": "http:\/\/a3.twimg.com\/profile_images\/107659093\/0_normal.jpg",
+        "tid": 4015703048,
+        "tstamp": "Tue, 15 Sep 2009 22:53:12 +0000",
+        "unix_tstamp": 1253055192,
+        "is_reply": 1,
+        "is_retweet": 0,
+        "mentions": "Lu_Guz",
+        "source": "Tweetie",
+        "sourcelink": "http:\/\/www.atebits.com\/",
+        "search_query": "twitter"
+    },
+    {
+        "user": "heatherkentart",
+        "tweet": "@k8otomato - Thanks, I will definitely try later. I will also postpone any negative opinions of Twitter. :D",
+        "usrimg": "http:\/\/a3.twimg.com\/profile_images\/417128285\/me_normal.jpg",
+        "tid": 4015703318,
+        "tstamp": "Tue, 15 Sep 2009 22:53:11 +0000",
+        "unix_tstamp": 1253055191,
+        "is_reply": 1,
+        "is_retweet": 0,
+        "mentions": "k8otomato",
+        "source": "web",
+        "sourcelink": "http:\/\/twitter.com\/",
+        "search_query": "twitter"
+    }	
+}'
+
+post = Tweethook::Post.new(json)
+
+post.size => 2
+
+post.first.user => 'deputy5765'
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Jordan Glasner. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "tweethook"
+    gem.summary = "wrapper for the Tweethook API"
+    gem.description = "wrapper for the Tweethook API"
+    gem.email = "jordan@digitalignition.com"
+    gem.homepage = "http://github.com/glasner/tweethook"
+    gem.authors = ["Jordan Glasner"]
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "tweethook #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/tweethook/post.rb

@@ -0,0 +1,17 @@
+class Tweethook::Post < Array
+  
+  attr_accessor :signature, :time
+  
+  def initialize(json)
+    hash = json.is_a?(Hash) ? json : JSON.parse(json)
+    @signature = hash['signature']
+    @time = Time.at(hash['time'])
+    super(hash['results'].map { |result| Tweethook::Result.new(result) })
+  end
+  
+  def valid?
+    @signature.eql?(Tweethook.signature)
+  end
+  
+  
+end

data/lib/tweethook/result.rb

@@ -0,0 +1,15 @@
+class Tweethook::Result
+  
+  attr_accessor :user, :tweet, :usrimg, :tid, :tstamp, :unix_tstamp, :is_reply, :is_retweet, :mentions, :source, :sourcelink, :search_query
+  
+  def initialize(args)
+    args.each { |key,value| instance_variable_set("@#{key}",value)  }
+    change_boolean_values    
+  end
+  
+  def change_boolean_values
+    @is_reply = !@is_reply.zero?
+    @is_retweet = !@is_retweet.zero?
+  end
+  
+end

data/lib/tweethook/search.rb

@@ -0,0 +1,85 @@
+class Tweethook::Search
+  
+  # create a new search at Tweethook
+  # Tweethook::Search.create('monkey', :webhook => 'http://where.com/callback' )
+  def self.create(search,args)
+    args.merge!({:search => search})
+    search = new(args)
+    search.save
+  end
+  
+  def self.find(id)
+    response = Tweethook.get('/info.json', :id => id)
+    return nil if response.nil?
+    new(response.first)
+  end
+  
+  def self.list
+    response = Tweethook.get('/list.json')
+    return [] if response.nil?
+    response.map { |hash| Tweethook::Search.new(hash)  }    
+  end
+  
+  attr_accessor :id, :search, :webhook, :active
+  
+  def initialize(args)
+    # change string keys to symbols
+    if args.any? { |arg| arg.is_a?(String)  }
+      args = args.inject({}) { |output,array| key,value = array; output[key.to_sym] = value;output  }
+    end    
+    # setup instance variable for every arg
+    args.each { |key,value| instance_variable_set("@#{key}",value)  }
+    
+    @format ||= 'json'
+    
+    change_active_to_boolean
+  end 
+  
+  def change_active_to_boolean
+    # @active defaults to true
+    @active = true if @active.nil?      
+    # change @active to boolean value if it's an integer
+    @active = !@active.to_i.zero? if @active.is_a?(String)
+  end
+  
+  def save
+    return modify unless new_record?
+    response = Tweethook.post('/create.json',:search => @search, :webhook => @webhook, :active => @active)
+    return nil if response.nil?
+    @id = response.first['id']
+    self
+  end 
+  
+  def modify
+    response = Tweethook.post('/modify.json', :id => @id, :search => @search, :webhook => @webhook, :active => @active)
+    return nil if response.nil?
+    self
+  end
+  
+  def new_record?
+    not @id.nil?
+  end
+  
+  def start
+    response = Tweethook.post('/start.json', :id => @id)
+    return false if response.nil?
+    @active = true
+  end
+  alias :resume :start
+  
+  def stop
+    response = Tweethook.post('/stop.json', :id => @id)
+    return false if response.nil?
+    @active = false
+  end
+  alias :pause :stop
+  
+  
+  def destroy
+    response = Tweethook.post('/destroy.json',:id => @id)
+    return false if response.nil?
+    self.id = nil if response.first['id'].eql?(@id)    
+  end
+  
+  
+end

data/lib/tweethook.rb

@@ -0,0 +1,42 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'typhoeus'
+require 'json'
+
+class Tweethook
+  
+  autoload :Search, 'tweethook/search'
+  autoload :Post, 'tweethook/post'
+  autoload :Result, 'tweethook/result'
+  
+  def self.user
+    ENV['TWEETHOOK_API_USER']
+  end
+  
+  def self.password
+    ENV['TWEETHOOK_API_PASS']
+  end
+  
+  def self.signature
+    ENV['TWEETHOOK_SIGNATURE']
+  end
+  
+  def self.post(path,params)
+    response = Typhoeus::Request.post(Tweethook.url(path),
+      :params => params)
+    response.body.empty? ? nil : JSON.parse(response.body)
+  end
+  
+  def self.get(path,*params)
+    params = params.empty? ? nil : params.first
+    response = Typhoeus::Request.get(Tweethook.url(path), :params => params)
+    return nil if response.code.eql?(403)
+    result = JSON.parse(response.body)    
+  end
+  
+  
+  def self.url(path)
+    "https://#{Tweethook.user}:#{Tweethook.password}@api.tweethook.com#{path}"
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+# require 'active_support'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'tweethook'
+
+class Test::Unit::TestCase
+end

data/test/test_post.rb

@@ -0,0 +1,68 @@
+require 'helper'
+require 'time'
+
+class TestPost < Test::Unit::TestCase
+    context "instantiating TestPost with valid JSON" do
+      subject { @post }
+      setup do 
+        @json = '{
+          "status_count": 2,
+          "signature": "XXXXXXXXXXXXXXXXXXXXXXXX",
+          "time": 1253055217,
+          "results": [{
+              "user": "deputy5765",
+              "tweet": "@Lu_Guz You will have to install a Twitter application in Facebook. Log in, search Twitter, install the app, then enter the info #geeksquad",
+              "usrimg": "http:\/\/a3.twimg.com\/profile_images\/107659093\/0_normal.jpg",
+              "tid": 4015703048,
+              "tstamp": "Tue, 15 Sep 2009 22:53:12 +0000",
+              "unix_tstamp": 1253055192,
+              "is_reply": 1,
+              "is_retweet": 0,
+              "mentions": "Lu_Guz",
+              "source": "Tweetie",
+              "sourcelink": "http:\/\/www.atebits.com\/",
+              "search_query": "twitter"
+          },
+          {
+              "user": "heatherkentart",
+              "tweet": "@k8otomato - Thanks, I will definitely try later. I will also postpone any negative opinions of Twitter. :D",
+              "usrimg": "http:\/\/a3.twimg.com\/profile_images\/417128285\/me_normal.jpg",
+              "tid": 4015703318,
+              "tstamp": "Tue, 15 Sep 2009 22:53:11 +0000",
+              "unix_tstamp": 1253055191,
+              "is_reply": 1,
+              "is_retweet": 0,
+              "mentions": "k8otomato",
+              "source": "web",
+              "sourcelink": "http:\/\/twitter.com\/",
+              "search_query": "twitter"
+          }	
+        ]}'
+        @parsed_json = JSON.parse(@json)
+        @post = Tweethook::Post.new(@json)
+      end
+
+
+
+      should "take json payload" do
+        assert subject
+      end
+
+      should "have the same size as given json['results']" do
+        assert subject.size.eql?(@parsed_json['results'].size)
+      end
+
+      should "parse json['results'] into hash of Result objects" do
+        assert subject.all? { |element| element.is_a?(Tweethook::Result)  }
+      end
+
+      should "save post signature into accessible instance variable" do
+        assert subject.signature.eql?(@parsed_json['signature'])
+      end
+
+      should "save post time into accessible instance variable" do
+        assert subject.time.eql?(Time.at(@parsed_json['time']))
+      end
+    end
+
+end

data/test/test_search.rb

@@ -0,0 +1,97 @@
+require 'helper'
+
+class TestSearch < Test::Unit::TestCase
+    context "instantiating Search with parsed JSON from API" do
+      subject { @search }
+      setup do 
+        @json = '{
+                "id": 12560300,
+                "search": "\"hello world\"",
+                "webhook": "http:\/\/example.com\/webhook.php",
+                "active": "1",
+                "format": "post"
+            }'
+        @parsed_json = JSON.parse(@json)    
+        @search = Tweethook::Search.new(@parsed_json)
+      end
+      
+      should 'save id in accessible instance variable' do
+        assert @search.id.eql?(@parsed_json['id'])
+      end
+      
+      should 'save search in accessible instance variable' do
+        assert @search.search.eql?(@parsed_json['search'])
+      end
+      
+      should 'save webhook in accessible instance variable' do
+        assert @search.webhook.eql?(@parsed_json['webhook'])
+      end
+      
+      should 'save active in acessible instance variable as boolean value' do
+        assert @search.active.eql?(true)
+      end
+      
+    end
+    
+    context "instantiating Search with Hash with symbol keys" do
+      
+      subject { @search }
+      setup do 
+        @hash = {
+          :id => 1256033,
+          :search => 'hello world',
+          :webhook => 'http://somewhere.com',
+          :active => true,
+          :format => "post"
+        }
+        @search = Tweethook::Search.new(@hash)
+      end
+      
+      should 'save :id in accessible instance variable' do
+        assert @search.id.eql?(@hash[:id])
+      end
+      
+      should 'save :search in accessible instance variable' do
+        assert @search.search.eql?(@hash[:search])
+      end
+      
+      should 'save :webhook in accessible instance variable' do
+        assert @search.webhook.eql?(@hash[:webhook])
+      end
+      
+    end
+    
+    context "saving a new Search record" do
+      subject {@search}
+      setup do 
+        @args = {:search => 'monkey', :webhook => 'http://there.com'}
+        @search = Tweethook::Search.new(@args)
+        @search.save
+      end
+      
+      should "have an id" do
+        assert_not_nil @search.id
+        @search.destroy
+      end
+    end
+    
+    
+    context "creating a new Search record" do
+      
+      subject { @search }
+      
+      setup do 
+        @query = 'monkey'
+        @args = {:webhook => 'http://there.com'}
+        @search = Tweethook::Search.create(@query,@args)
+      end
+      
+      should "have an id" do
+        assert_not_nil @search.id
+        @search.destroy
+      end
+      
+      
+    end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: tweethook
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jordan Glasner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-31 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: wrapper for the Tweethook API
+email: jordan@digitalignition.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/tweethook.rb
+- lib/tweethook/post.rb
+- lib/tweethook/result.rb
+- lib/tweethook/search.rb
+- test/helper.rb
+- test/test_post.rb
+- test/test_search.rb
+has_rdoc: true
+homepage: http://github.com/glasner/tweethook
+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: wrapper for the Tweethook API
+test_files: 
+- test/helper.rb
+- test/test_post.rb
+- test/test_search.rb