tweet_watch 0.2.3.pre → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e73e51822890ec3d5333a74fd2dcd25cb433394
-  data.tar.gz: 0255ff95f17eef5ae53c56c156646a98134997f6
+  metadata.gz: 6e2731e4ea154dedfaed9d038118fbac7939ba4e
+  data.tar.gz: aaeacce0feb3eb9c3922a6ecd2cb15b8b55bdc1b
 SHA512:
-  metadata.gz: f811bbb8d2c24a4b53c93ed7d3d2e517fee9e8e966b85562fdbf17c6d514ac5cc2699923ca11fe404aca6a4caa9b2cdbbd5496480d7bd76fe14f763b99c1ad93
-  data.tar.gz: feb5ef50129e4dd00ab490ac032143d76619a78662de7ad80567df0d0679b81aa54a0deb24ce22c295add93690e76aab599705c4f88fe732f8b0ada5a452da77
+  metadata.gz: 5ce5575437568cc6aca41db94cf1283428224a518b6dec77737254e88f232d77a6bae70dcec5d442b61f731941e6c80a77f572a2b623655dc2216a9d1fa3318d
+  data.tar.gz: 860e0c79ebc831b113afa7aa945f54d8ce5da8db08541d1c857509f813c03d99ab6fdd8c5c2aaed970c94c346dc877cc3314c7746ab9542d19a657a7bcb657c7

data/README.md

@@ -1,8 +1,10 @@
-# TweetBan
+# TweetWatch
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/tweet_watch`. To experiment with that code, run `bin/console` for an interactive prompt.
+TweetWatch can be used to collect timeline data from several accounts and from specific twitter users.  The primary motivation for creating this gem was to track the home timeline of several accounts and study how and when tweets appear in an accounts timeline.  Is shadow banning real?
 
-TODO: Delete this and the text above, and describe your gem
+This gem is designed to be used as CLI tool but is not a full fledged alternative to the [twitter CLI](https://github.com/sferik/t).  The primary goal of this gem is to collect twitter data perodically.
+
+![Image of TweetWatch timeline streaming](https://raw.githubusercontent.com/ajoabraham/tweet_watch/master/timeline_streaming.png)
 
 ## Installation
 
@@ -20,9 +22,55 @@ Or install it yourself as:
 
     $ gem install tweet_watch
 
+## Configuration
+
+All CLI commands require a configuration file.  The config file has two major sections **accounts** and **tweeters**.  Tweeters are the accounts you want to track.  This is optional and will cause the csv output to only contain tweets from one of these users.  Accounts is where you define access to a twitter account. More on that below.
+
+See example [config.yml](config.yml). 
+
+## Account Authorization
+
+To give TweetWatch access to your home timeline, register a twitter app and enter the accounts credentials in your config file. 
+1. Go to [Twitter Apps Site](https://apps.twitter.com/)
+2. Click on "Create a New App", if you don't already have one. (You can have more than one)
+3. In your App, click on the "Keys and Access Tokens" tab
+4. Scroll down and generate access token and secret
+5. Add an account to your config file as shown in the [example](config.yml).  For each account enter the screen name, consumer key, consumer secret, access token, access secret
+
+Now you're ready to use tweet_watch
+
 ## Usage
 
-TODO: Write usage instructions here
+Get the last 50 tweets in an accounts home timeline:
+
+```sh
+tweet_watch timeline -c config.yml
+```
+
+Get the last 100 twets for a specfic account in your config file:
+
+```sh
+tweet_watch timeline -c config.yml -n 100 -u ajoabraham
+```
+
+Instead of printing out a timeline stream it:
+
+```sh
+tweet_watch timeline -c config.yml -s
+```
+
+Stream a timeline and record to a CSV file tweets from specific users.  Tweeters list can be provided from the command line or read in from the Config file:
+
+```sh
+tweet_watch watch -c config.yml -t user1 user2 user3
+```
+
+Monitor the home timeline of configured accounts while also recording the tweets sent by the provided list of tweeters:
+```sh
+tweet_watch monitor -c config.yml
+```
+
+The monitor command by default will run every 15 minutes but you can provide a different interval by passing _-i_ command with your desired time in seconds.  This will create a tweeter_tweets.csv and account_timeline.csv file.  Comparing the data in these files we should be able to determine how and when tweets will get propagated into home timelines of target accounts.
 
 ## Development
 
@@ -32,7 +80,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tweet_ban. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ajoabraham/tweet_watch. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/config.yml

@@ -27,7 +27,3 @@ tweeters:
  - jaketapper
  - lodr_io
  - newsycombinator
-
-monitor:
- interval: 10
- account_timeline_history: 100

data/lib/tweet_watch/cli.rb

@@ -95,15 +95,16 @@ module TweetWatch
         elsif obj.class == Twitter::Streaming::StallWarning
           warn "Falling behind!"
         else
-          puts "untracked tweet obj #{obj.class}".colorize(color: :black, background: :light_white)
+          # do nothing for now
+          #puts "untracked tweet obj #{obj.class}".colorize(color: :black, background: :light_white)
         end
       
       end
     end
     
     desc "monitor", "Monitors target tweeters tweets and provided account timelines."
-    option :interval, aliases: "-i", desc: "Time delay between each monitoring run. Default = 15 mins."
-    option :initial_tweet_history, aliases: "-hn", desc: "When started Monitor will collect 200 tweets by defaul for each tweeter."
+    option :interval, aliases: "-i", desc: "Time delay in seconds between each monitoring run. Default = 15 mins."
+    option :initial_tweet_history, aliases: "-h", desc: "When started Monitor will collect 200 tweets by defaul for each tweeter."
     option :timeline_count, aliases: "-n", desc: "For each monitor run, how many tweets should be collected. 200 by default is also the max."
     def monitor      
       load_config(options)

data/lib/tweet_watch/config.rb

@@ -12,7 +12,7 @@ module TweetWatch
     end
     
     def load_from_path(path)
-      unless File.exists?(path)
+      unless File.exist?(path)
         raise ArgumentError.new("The provided config file could not be located: #{path}")
       end
       

data/lib/tweet_watch/monitor.rb

@@ -12,8 +12,10 @@ module TweetWatch
     def initialize(options = {})
       @options = {interval: (15*60), 
                   initial_tweet_history: 200,
-                  timeline_count: 200}.merge(options)
-                  
+                  timeline_count: 200}
+      @options.merge!(Hash[options.map{ |k, v| [k.to_sym, v] }])      
+      @options[:interval] = @options[:interval].to_i
+      
       @new_tweeter_tweets = 0
       
       if TweetWatch.config.tweeters.empty?

data/lib/tweet_watch/version.rb

@@ -1,3 +1,3 @@
 module TweetWatch
-  VERSION = "0.2.3.pre"
+  VERSION = "0.2.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tweet_watch
 version: !ruby/object:Gem::Version
-  version: 0.2.3.pre
+  version: 0.2.3
 platform: ruby
 authors:
 - Ajo Abraham
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-21 00:00:00.000000000 Z
+date: 2017-03-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,6 +121,7 @@ files:
 - lib/tweet_watch/monitor.rb
 - lib/tweet_watch/utils.rb
 - lib/tweet_watch/version.rb
+- timeline_streaming.png
 - tweet_watch.gemspec
 homepage: http://rubygems.org/gems/tweet_watch
 licenses:
@@ -137,9 +138,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1