favebomb 0.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    favebomb (0.1.0)
+      colored
+      json
+      oauth
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    colored (1.2)
+    json (1.7.7)
+    oauth (0.4.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  favebomb!

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 Jonathan Vingiano
+
+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/bin/favebomb

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+
+require 'favebomb'
+
+begin
+  fave = Favebomb.new
+  fave.bomb ARGV[0]
+rescue Exception => e
+  puts e.message
+  puts e.backtrace.inspect
+end

data/favebomb.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/favebomb/version', __FILE__)
+
+Gem::Specification.new do |s|
+
+  s.name = "favebomb"
+  s.version = Favebomb::VERSION
+  s.author = "Jonathan Vingiano"
+  s.email = "jgv@jonathanvingiano.com"
+  s.homepage = "http://github.com/jgv/favebomb"
+  s.rubyforge_project = "favebomb"
+  s.summary = "Positive reinforcement"
+  s.description = "Favorite Tweets from the command line"
+  s.files = `git ls-files`.split("\n")
+  s.test_file = 'test/unit/favebomb.rb'
+  s.require_paths = ['lib', 'bin']
+  s.executables = ['favebomb']
+
+  s.add_dependency 'oauth'
+  s.add_dependency 'json'
+  s.add_dependency 'colored'
+
+end

data/lib/favebomb.rb

@@ -0,0 +1,94 @@
+require 'oauth'
+require 'optparse'
+require 'pp'
+require 'json'
+require 'colored'
+
+class Favebomb
+
+  attr_accessor :results, :faved, :options
+
+  def initialize(opts={})
+    @options = {
+      :lang => nil,
+      :type => nil,
+      :count => nil,
+      :until => nil,
+      :geocode => nil
+    }
+    @faved = []
+    @client = prepare_access_token(ENV["FAVEBOMB_ACCESS_TOKEN"], ENV["FAVEBOMB_ACCESS_SECRET"])
+  end
+
+  def bomb term
+    parse_options!
+    puts "looking for #{term}".bold.blue
+    query = generate_params term
+
+    search = @client.request(:get, "http://api.twitter.com/1.1/search/tweets.json?#{query}")
+    @results = JSON.parse(search.read_body)["statuses"]
+    puts "found #{@results.count} tweets"
+    results.each {|tweet| fave! tweet if tweet["favorited"] == false }
+    puts
+    puts "faved #{@faved.count} tweets"
+  end
+
+  private
+
+  def parse_options!
+    OptionParser.new do |opts|
+      opts.banner = "Usage: favebomb [command] [options]"
+      opts.on("-l", "--lang lang", "Restricts tweets to the given language, given by an ISO 639-1 code. Language detection is best-effort.") {|lang| @options[:lang] = lang }
+      opts.on("-t", "--type type", "Restrict tweets to a specific type. Choose between popular, recent, or mixed (the default).") {|type| @options[:type] = type }
+      opts.on("-c", "--count count", "Control the number of tweets to fave. Maximum is 100, default is 15.") {|count| @options[:count] = count }
+      opts.on("-u", "--until date", "Returns tweets generated before the given date. Date should be formatted as YYYY-MM-DD. Keep in mind that the search index may not go back as far as the date you specify here.") {|date| @options[:until] = date }
+      opts.on("-g", "--geocode code", "Returns tweets by users located within a given radius of the given latitude/longitude. The location is preferentially taking from the Geotagging API, but will fall back to their Twitter profile. The parameter value is specified by 'latitude,longitude,radius', where radius units must be specified as either 'mi' (miles) or 'km' (kilometers). Note that you cannot use the near operator via the API to geocode arbitrary locations; however you can use this geocode parameter to search near geocodes directly. A maximum of 1,000 distinct 'sub-regions' will be considered when using the radius modifier.") {|code|
+        @options[:geocode] = code }
+      opts.on_tail("-h", "--help", "Show this message") do
+        puts opts
+        Kernel.exit!
+      end
+    end.parse!
+  end
+
+  def generate_params term
+    params = ""
+    @options.each {|k,v| params += "&#{k}=#{URI.encode(v)}" if v != nil }
+    query = "q=#{URI.encode(term)}" + params
+    return query
+  end
+
+  def fave! tweet
+    puts
+    puts "faving..".yellow
+    puts tweet["text"]
+    fave = @client.request(:post, "https://api.twitter.com/1.1/favorites/create.json?id=#{tweet["id"]}")
+    if fave.response.code.to_i == 200
+      puts "faved!".bold.green
+      @faved << tweet
+    else
+      begin
+        json = JSON.parse(fave.read_body)["errors"]
+        puts json ["errors"]["message"].bold.red if json["errors"]
+      rescue Exception => e
+        puts "Error: ".bold.red + e.to_s.bold.red
+      end
+    end
+  end
+
+  def prepare_access_token oauth_token, oauth_token_secret
+    consumer = OAuth::Consumer.new(ENV["FAVEBOMB_CONSUMER_KEY"], ENV["FAVEBOMB_CONSUMER_SECRET"],
+      { :site => "http://api.twitter.com",
+        :scheme => :header
+      })
+
+    token_hash = {
+      :oauth_token => oauth_token,
+      :oauth_token_secret => oauth_token_secret
+    }
+
+    access_token = OAuth::AccessToken.from_hash(consumer, token_hash )
+    return access_token
+  end
+
+end

data/lib/favebomb/version.rb

@@ -0,0 +1,3 @@
+module Favebomb
+  VERSION = '0.1.0'
+end

data/readme.md

@@ -0,0 +1,73 @@
+# Favebomb
+
+Hello! Have you ever released a project on the "internet" and wanted to high five people who are tweeting about it. It's super annoying to fave each and every tweet. **Enter Favebomb** This little Ruby gem will take care of all your faving for you!
+
+## Installation
+
+Currently Favebomb requires that you [create a Twitter app](https://dev.twitter.com/apps/new) and have environment variables for the consumer and OAuth tokens. Add something like this to your config:
+
+``` bash
+export FAVEBOMB_CONSUMER_KEY=12345
+export FAVEBOMB_CONSUMER_SECRET=12345
+export FAVEBOMB_ACCESS_TOKEN=12345
+export FAVEBOMB_ACCESS_SECRET=12345
+```
+
+Then actually install Favebomb like so:
+
+``` bash
+$ gem install favebomb
+```
+or in your Gemfile: `gem 'favebomb'`
+
+## Usage
+
+```
+$ favebomb --help
+
+Usage: favebomb [command] [options]
+    -l, --lang lang                  Restricts tweets to the given language, given by an ISO 639-1 code.
+                                     Language detection is best-effort.
+    -t, --type type                  Restrict tweets to a specific type. Choose between popular, recent,
+                                     or mixed (the default).
+    -c, --count count                Control the number of tweets to fave. Maximum is 100, default is 15.
+    -u, --until date                 Returns tweets generated before the given date. Date should be
+                                     formatted as YYYY-MM-DD. Keep in mind that the search index may not
+                                     go back as far as the date you specify here.
+    -g, --geocode code               Returns tweets by users located within a given radius of the given
+                                     latitude/longitude. The location is preferentially taking from the
+                                     Geotagging API, but will fall back to their Twitter profile. The
+                                     parameter value is specified by 'latitude,longitude,radius', where
+                                     radius units must be specified as either 'mi' (miles) or 'km'
+                                     (kilometers). Note that you cannot use the near operator via the API
+                                     to geocode arbitrary locations; however you can use this geocode
+                                     parameter to search near geocodes directly. A maximum of 1,000
+                                     distinct 'sub-regions' will be considered when using the radius
+                                     modifier.
+    -h, --help                       Show this message
+
+```
+
+The [Twitter search docs](https://dev.twitter.com/docs/api/1.1/get/search/tweets) are also a good resource for option usage.
+
+Let's search Twitter for the term "bieber" and fave a bunch of Tweets.
+
+``` bash
+$ favebomb bieber
+```
+
+Or what about searching Twitter for "kawaii" from users located in Japan.
+
+``` bash
+$ favebomb --lang ja kawaii
+```
+
+## Tests
+
+Run tests with minitest.
+
+```
+$ ruby test/unit/favebomb.rb
+```
+
+**License: MIT**

data/test/unit/favebomb.rb

@@ -0,0 +1,20 @@
+require 'minitest/autorun'
+require 'minitest/unit'
+require 'minitest/pride'
+
+$:.unshift File.dirname(__FILE__) + '/../../lib'
+require 'favebomb'
+
+class TestFavebomb < MiniTest::Unit::TestCase
+
+  def setup
+    @favebomb = Favebomb.new
+    @favebomb.bomb "bieber"
+  end
+
+  def test_that_it_can_bomb_a_term
+    @favebomb.instance_variable_get("@faved").count.must_be_close_to @favebomb.instance_variable_get("@results").count, 1
+    @favebomb.instance_variable_get("@faved").must_be_kind_of Array
+  end
+
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: favebomb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Jonathan Vingiano
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: colored
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Favorite Tweets from the command line
+email: jgv@jonathanvingiano.com
+executables:
+- favebomb
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- bin/favebomb
+- favebomb.gemspec
+- lib/favebomb.rb
+- lib/favebomb/version.rb
+- readme.md
+- test/unit/favebomb.rb
+homepage: http://github.com/jgv/favebomb
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+- bin
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: favebomb
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Positive reinforcement
+test_files:
+- test/unit/favebomb.rb