twitter_filter 0.0.1

data/LICENSE.txt

@@ -0,0 +1,340 @@
+		    GNU GENERAL PUBLIC LICENSE
+		       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.
+                       51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+			    Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Library General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+		    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+			    NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+		     END OF TERMS AND CONDITIONS
+
+	    How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License
+    along with this program; if not, write to the Free Software
+    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Ty Coon>, 1 April 1989
+  Ty Coon, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Library General
+Public License instead of this License.

data/README.markdown

@@ -0,0 +1,37 @@
+# TwitterFilter
+
+## DESCRIPTION
+
+TwitterFilter helps you access all the Tweets you want and nothing but those Tweets.
+
+## REQUIREMENTS
+
+TwitterFilter is a Ruby gem, so you will need to install it and its dependencies.
+
+You must also save your Twitter OAuth credentials in a YAML file with contents like this fake example:
+
+    ---
+    consumer_key: Id254ZAzQJtF7ltUerYPw
+    consumer_secret: fSuNNvlairlesqGDnasde58zib3hApHMTUnZ0J94jmw
+    oauth_token: 938572174-ByY7Plbe1J4Dp5JSwZjmPowBwOr2VVjLA2Juxeqp
+    oauth_token_secret: PrRwQVOgO2Sg0r4IOJPwQq95IqHieZeEnemxkiHKw
+
+See [Twitter's GET oauth/authenticate page](https://dev.twitter.com/docs/api/1/get/oauth/authenticate) for instructions on getting your own credentials.
+
+## USAGE
+
+You create a GetTweets object by passing in the path to your Twitter OAuth credentials YAML file:
+
+    gt = GetTweets.new(config_file_path)
+
+You can then use your GetTweets object to get a random array of Tweets. To get an array with 30 Tweets:
+
+    tweets = gt.sample(30)
+
+If you just wish to get the array without also seeing each one, you can pass `{display: false}`:
+
+    tweets = gt.sample(30, display: false)
+
+## LEGAL DISCLAIMER
+
+You use TwitterFilter at your own risk. I make no warrantees about anything relating to TwitterFilter.

data/lib/twitter_filter/get_tweets.rb

@@ -0,0 +1,103 @@
+# encoding: UTF-8
+
+require 'tweetstream'
+require 'yaml'
+require 'date'
+require 'fileutils'
+require 'time'
+require_relative 'tweets'
+require_relative 'tweet'
+
+class GetTweets
+
+  class NoOauthFileException < Exception; end
+  class InvalidOauthFileException < Exception; end
+
+  attr_accessor :display
+  attr_writer :tweets, :more_tweets
+
+  def initialize(oauth_file = nil)
+    raise_no_oauth_file_exception unless oauth_file && File.exists?(File.expand_path(oauth_file))
+    configure_tweetstream(File.expand_path(oauth_file))
+  end
+
+  def tweets
+    @tweets ||= Tweets.new
+  end
+
+  def more_tweets
+    @more_tweets ||= nil
+  end
+
+  def display_oauth_file_explanation
+    puts "You must call #{self.class.name}.new() with the location of your OAuth credentials YAML file"
+    puts "The file should look like this (but with valid values):\n"
+    puts "---"
+    puts "consumer_key: Id254ZAzQJtF7ltUerYPw"
+    puts "consumer_secret: fSuNNvlairlesqGDnasde58zib3hApHMTUnZ0J94jmw"
+    puts "oauth_token: 938572174-ByY7Plbe1J4Dp5JSwZjmPowBwOr2VVjLA2Juxeqp"
+    puts "oauth_token_secret: PrRwQVOgO2Sg0r4IOJPwQq95IqHieZeEnemxkiHKw"
+  end
+
+  def raise_no_oauth_file_exception
+    display_oauth_file_explanation
+    raise NoOauthFileException
+  end
+
+  def raise_invalid_oauth_file_exception(msg)
+    display_oauth_file_explanation
+    raise InvalidOauthFileException, msg
+  end
+
+  def get_settings(oauth_file)
+    YAML.load_file oauth_file
+  rescue
+    raise_invalid_oauth_file_exception("Cannot read file as valid YAML file")
+  end
+
+  def configure_tweetstream(oauth_file)
+    TweetStream.configure do |c|
+      settings = get_settings(oauth_file)
+      ['consumer_key', 'consumer_secret', 'oauth_token', 'oauth_token_secret'].each do |twitk|
+        raise_invalid_oauth_file_exception("#{oauth_file} must have a valid #{twitk} value") unless settings[twitk]
+        c.public_send(twitk + '=', settings[twitk])
+      end
+      c.public_send('auth_method=', :oauth)
+    end
+  end
+
+  def handle_tweet(tweet)
+    tweet.display if display
+    if more_tweets
+      self.more_tweets = more_tweets - 1
+      self.tweets << tweet
+      p "Tweets count: " + tweets.size.to_s
+    end
+  rescue Exception => e
+    puts "***Error saving tweet***: #{e.message}\n"
+  end
+
+  def sample(num = nil, config = {})
+    self.more_tweets = num if num
+    self.display = (config[:display] && config[:display] == false) ? false : true
+    tsc = TweetStream::Client.new
+    tsc.sample do |status, client|
+      handle_tweet(status)
+      client.stop if more_tweets == 0
+    end
+    (sleep 0.1 until more_tweets == 0) if num
+    tweets
+  end
+
+  def track_term(term, num = nil, config = {})
+    self.more_tweets = num if num
+    self.display = config[:display] || true
+    tsc = TweetStream::Client.new
+    tsc.track(term) do |status, client|
+      handle_tweet(status)
+      client.stop if more_tweets == 0
+    end
+    (sleep 0.1 until more_tweets == 0) if num
+    tweets
+  end
+end

data/lib/twitter_filter/tweet.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+
+require 'tweetstream'
+require 'json'
+
+class Twitter::Tweet
+
+  def display_time_ago
+    seconds_ago = Time.now - created_at
+    if seconds_ago < 60
+      return "less than a minute ago"
+    elsif seconds_ago < 60*2
+      return "about a minute ago"
+    elsif seconds_ago < 60*60
+      return "about #{(seconds_ago/60).round} minutes ago"
+    elsif seconds_ago < 60*60*2
+      return "about an hour ago"
+    elsif seconds_ago < 60*60*24
+      return "about #{(seconds_ago/(60*60)).round} hours ago"
+    else
+      return "about #{(seconds_ago/(60*60*24)).round} days ago"
+    end
+  end
+
+  def display(format="string")
+    puts self.send("display_" + format)
+  end
+
+  def display_string
+    'User: ' + user.screen_name + "\n" +
+    'User img: ' + user.profile_image_url + "\n" +
+    'Text: ' + full_text + "\n" +
+    "from " + source + "\n" +
+    created_at.to_s + "\n" +
+    display_time_ago + "\n" +
+    "#{user.screen_name} [#{created_at.to_s}]: #{text}"
+  end
+  
+  def to_json
+    tweet_hash =
+      {"full_text" => full_text,
+       "text" => text,
+       "source" => source,
+       "created_at" => created_at.to_s,
+       "display_time_ago" => display_time_ago,
+       "user" => {"screen_name" => user.screen_name, "profile_image_url" => user.profile_image_url}}
+    tweet_hash["in_reply_to_screen_name"] = in_reply_to_screen_name if in_reply_to_screen_name
+    tweet_hash.to_json
+  end
+end

data/lib/twitter_filter/tweets.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+
+require 'tweetstream'
+require 'yaml'
+require 'date'
+require 'fileutils'
+require 'time'
+require 'forwardable'
+
+class Tweets
+
+  attr_accessor :tweets
+
+  include Enumerable
+  extend Forwardable
+
+  def_delegators :@tweets, :each, :<<, :[], :[]=, :concat, :size, :length, :first, :last
+
+  def initialize(config={})
+    @tweets = config[:tweets] || []
+  end
+
+  def serialize(save_name)
+    File.open(save_name, 'w') do |f|
+      f.write YAML.dump(tweets)
+    end
+  end
+
+  def deserialize(save_name)
+    tweets = YAML.load(File.read(save_name))
+  end
+
+  def to_json
+    json_string = "["
+    tweets.each do |tweet|
+      json_string += tweet.to_json
+      json_string += ','
+    end
+    json_string.gsub!(/,$/,"]")
+  end
+end

data/lib/twitter_filter/version.rb

@@ -0,0 +1,6 @@
+# encoding: UTF-8
+
+module TwitterFilter
+  VERSION = '0.0.1'
+  DATE = '2013-03-07'
+end

data/lib/twitter_filter.rb

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+
+require 'twitter_filter/tweet'
+require 'twitter_filter/tweets'
+require 'twitter_filter/get_tweets'
+
+

data/spec/get_tweets_spec.rb

@@ -0,0 +1,111 @@
+# encoding: UTF-8
+
+require_relative "../lib/twitter_filter/get_tweets.rb"
+require 'fileutils'
+require 'fakefs/spec_helpers'
+
+describe GetTweets do
+
+  describe "#new" do
+    include FakeFS::SpecHelpers
+
+    context "non-existent configuration" do
+
+      it "raises a NoOauthFileException" do
+      
+        expect { GetTweets.new }.to raise_error(GetTweets::NoOauthFileException)
+
+      end
+
+    end
+
+    context "configuration file exists" do
+
+      let(:config_file_path) { File.expand_path("~/get_tweets/config.yml") }
+
+      before do
+        FileUtils.mkdir_p config_file_path
+      end
+
+      context "but is not YAML" do
+
+        let(:config_file_path) { File.expand_path("~/get_tweets/config.yml") }
+
+        before do
+          GetTweets.any_instance.stub(:get_settings).and_return("")
+        end
+
+        it "raises an InvalidOauthFileException" do
+        
+          expect { GetTweets.new(config_file_path) }.to raise_error(GetTweets::InvalidOauthFileException)
+
+        end
+
+      end
+
+      context "but lacks values" do
+
+        let(:oauth_yaml_lacking_values) { "---\n" }
+
+        before do
+          GetTweets.any_instance.stub(:get_settings).and_return({}.to_yaml)
+        end
+
+        it "raises an InvalidOauthFileException" do
+        
+          expect { GetTweets.new(config_file_path) }.to raise_error(GetTweets::InvalidOauthFileException)
+
+        end
+
+      end
+
+      context "and is valid" do
+
+        let(:valid_oauth_yaml) { "---\n" +
+          "consumer_key: Id254ZAzQJtF7ltUerYPw\n" +
+          "consumer_secret: fSuNNvlairlesqGDnasde58zib3hApHMTUnZ0J94jmw\n" +
+          "oauth_token: 938572174-ByY7Plbe1J4Dp5JSwZjmPowBwOr2VVjLA2Juxeqp\n" +
+          "oauth_token_secret: PrRwQVOgO2Sg0r4IOJPwQq95IqHieZeEnemxkiHKw"}
+
+        before do
+          GetTweets.any_instance.stub(:get_settings).and_return(YAML.load(valid_oauth_yaml))
+        end
+
+        it "returns a GetTweet object" do
+          gt = GetTweets.new(config_file_path)
+        end
+
+      end
+
+    end
+
+  end
+
+  describe "#sample" do
+  
+    let(:gt) { GetTweets.new(File.expand_path("~/.backup_my_tweets")) }
+
+    it "gets and saves the correct number of tweets" do
+     
+      twenty_tweets = gt.sample(20, {display: false})
+      twenty_tweets.size.should == 20
+
+    end
+
+  end
+
+  describe "#track_term" do
+  
+    before do
+      let(:gt) { GetTweets.new(File.expand_path("~/.backup_my_tweets")) }
+    end
+
+    xit "gets tweets for the term" do
+     
+      gt.track_term('NFL')
+
+    end
+
+  end
+
+end

data/spec/tweet_spec.rb

@@ -0,0 +1,32 @@
+# encoding: UTF-8
+
+require_relative "../lib/twitter_filter/tweet.rb"
+require_relative "../lib/twitter_filter/tweets.rb"
+require "fileutils"
+
+describe Twitter::Tweet do
+
+  let(:yaml_file) { File.expand_path("../../fixtures/tweets/twenty_tweets_1.yml", __FILE__) }
+  let(:tweets) { Tweets.new.deserialize(yaml_file).tweets }
+
+  describe "#display_string" do
+
+    it "should display correctly" do
+      # can't test time part of string because time_ago is time-dependent
+      tweets.first.display_string.should include "User: bixychick\nUser img: http://si0.twimg.com/profile_images/2966510754/b784ea6be31b4e6ba7cc7eb4c52218e8_normal.jpeg\nText: @Great_Big_Sea @alanthomasdoyle @greatbigsean @bobhallett 1st show 11 yrs ago, good times, I'd do it all again. Thx http://t.co/stNcCt1zco\nfrom <a href=\"http://twitter.com/download/iphone\" rel=\"nofollow\">Twitter for iPhone</a>\n2013-03-07 13:47:13 -0500\nabout "
+      tweets.first.display_string.should include " ago\nbixychick [2013-03-07 13:47:13 -0500]: @Great_Big_Sea @alanthomasdoyle @greatbigsean @bobhallett 1st show 11 yrs ago, good times, I'd do it all again. Thx http://t.co/stNcCt1zco"
+    end
+
+  end
+
+  describe "#to_json" do
+
+    it "should return the tweet formatted as JSON" do
+      # can't test time part of string because time_ago is time-dependent
+      tweets[4].to_json.should include "{\"full_text\":\"RT @yougotmeven: (151618) @jbcerveja teu fc é a+ amei tudo\",\"text\":\"RT @yougotmeven: (151618) @jbcerveja teu fc é a+ amei tudo\",\"source\":\"web\",\"created_at\":\"2013-03-07 13:47:14 -0500\",\"display_time_ago\":\""
+      tweets[4].to_json.should include "\",\"user\":{\"screen_name\":\"jbcerveja\",\"profile_image_url\":\"http://si0.twimg.com/profile_images/3347243926/04b8b10d6e9928c6c9ca083bbb25e339_normal.png\"}}"
+    end
+
+  end
+
+end

data/spec/tweets_spec.rb

@@ -0,0 +1,51 @@
+# encoding: UTF-8
+
+require_relative "../lib/twitter_filter/tweet.rb"
+require_relative "../lib/twitter_filter/tweets.rb"
+require "fileutils"
+
+describe Tweets do
+  let(:in_yaml_file) { File.expand_path("../../fixtures/tweets/twenty_tweets_1.yml", __FILE__) }
+  let(:out_yaml_file) { File.expand_path("../../fixtures/tweets/twenty_tweets_6.yml", __FILE__) }
+
+  describe "#new" do
+
+    it "should have no tweets" do
+      Tweets.new.tweets.should == []
+    end
+  end
+
+  describe "#deserialize" do
+
+    it "should deserialize correctly" do
+      Tweets.new.deserialize(in_yaml_file).tweets.length.should == 20
+    end
+  end
+
+  describe "#serialize" do
+  
+    it "should serialize correctly" do
+      twenty_tweets = Tweets.new.deserialize(in_yaml_file)
+      twenty_tweets.serialize(File.expand_path(out_yaml_file))
+      loaded_tweets = Tweets.new.deserialize(out_yaml_file)
+      twenty_tweets.length.should == loaded_tweets.length
+      twenty_tweets.first.user.screen_name.should == loaded_tweets.first.user.screen_name
+      twenty_tweets.last.user.screen_name.should == loaded_tweets.last.user.screen_name
+      twenty_tweets[12].full_text.should == loaded_tweets[12].full_text
+    end
+  end
+
+  describe "#to_json" do
+
+    it "should return the tweets formatted as JSON" do
+      # can't test time part of string because time_ago is time-dependent
+      tweets = Tweets.new.deserialize(in_yaml_file)
+      tweets.to_json.should match /\A\[/
+      tweets.to_json.should match /]\Z/
+      tweets.to_json.should include "{\"full_text\":\"RT @yougotmeven: (151618) @jbcerveja teu fc é a+ amei tudo\",\"text\":\"RT @yougotmeven: (151618) @jbcerveja teu fc é a+ amei tudo\",\"source\":\"web\",\"created_at\":\"2013-03-07 13:47:14 -0500\",\"display_time_ago\":\""
+      tweets.to_json.should include "\",\"user\":{\"screen_name\":\"jbcerveja\",\"profile_image_url\":\"http://si0.twimg.com/profile_images/3347243926/04b8b10d6e9928c6c9ca083bbb25e339_normal.png\"}}"
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,138 @@
+--- !ruby/object:Gem::Specification
+name: twitter_filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- James Lavin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-core
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-expectations
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fakefs
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: lets you find the Tweets you want
+email: james@jameslavin.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.markdown
+- LICENSE.txt
+- lib/twitter_filter/tweets.rb
+- lib/twitter_filter/version.rb
+- lib/twitter_filter/get_tweets.rb
+- lib/twitter_filter/tweet.rb
+- lib/twitter_filter.rb
+- spec/get_tweets_spec.rb
+- spec/tweets_spec.rb
+- spec/tweet_spec.rb
+homepage: https://github.com/JamesLavin/twitter_filter
+licenses: []
+post_install_message: I hope you find this gem useful!
+rdoc_options: []
+require_paths:
+- lib
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: lets you find the Tweets you want
+test_files:
+- spec/get_tweets_spec.rb
+- spec/tweets_spec.rb
+- spec/tweet_spec.rb
+has_rdoc: