twords 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 201fe822e2fdd8c1ec5168fd73deb7cfb8dd29db
-  data.tar.gz: e3b057e402b2b3f1c5f47235de4f687836322c55
+  metadata.gz: 5c34c3b4415dc5107328e127712381efc0a84562
+  data.tar.gz: d90029ae4175a52dd886ac459d7023ac5aa1cd9a
 SHA512:
-  metadata.gz: 0b55531d7030c0fce27b3cd0e54c82f739c7cc3ff5b90596d087a7a8cf73d2ec3b5434c21daed60423b3fb3fcf55f724f6a3bf0dd65f8460348eab92f0a0f8d9
-  data.tar.gz: 85ebd69ab5677bf649cb618ae491f9bba4b3868c2030dd6254891bde8939f5509a3ac0e9d6ea2e3530a1cc0834e833d4a4e448d17dd6788cec442b30fd1bc506
+  metadata.gz: f7eada355aa2b6c1aaf30fcff26ca51bab3626ef05ed6dea0d40ca5431426787308cc04050290564f0efc29b31b740eb348edd212e04c71d0f2f5201b83b3480
+  data.tar.gz: 6b42cffee275451b7cf64d73003ca4d418b7bb9ba4a970de833407450c6f9076bceefb1d264990420054e3fd9cffd44737872e002e6ee256247dfb66fa4aedde

data/README.md

@@ -1,5 +1,9 @@
 ![twords](http://msimonborg.com/twords/twords.png)
 
+[![Gem Version](https://badge.fury.io/rb/twords.svg)](https://badge.fury.io/rb/twords)
+[![Code Climate](https://codeclimate.com/github/msimonborg/twords/badges/gpa.svg)](https://codeclimate.com/github/msimonborg/twords)
+[![Inline docs](http://inch-ci.org/github/msimonborg/twords.svg?branch=master)](http://inch-ci.org/github/msimonborg/twords)
+
 ## Twitter word clouds
 
 Count the occurrences of words in a tweeter's tweets.

data/lib/twords.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'twords/follower_bot_cop'
 require 'twords/configuration'
 require 'twords/instance_methods'
 require 'twords/version'

data/lib/twords/configuration.rb

@@ -121,7 +121,8 @@ class Twords
     end
     alias include_urls= include_uris=
 
-    # Set whether @-mentions should be counted. If true, any word beginning with "@" will be ignored.
+    # Set whether @-mentions should be counted.
+    # If true, any word beginning with "@" will be ignored.
     #
     # @param boolean [true, false] will raise an error if the value is not a Boolean value
     def include_mentions=(boolean)
@@ -129,16 +130,17 @@ class Twords
       @include_mentions = boolean
     end
 
-    # Takes a block and stores for lazy evaluation to define the end of the time range being checked.
-    # The return value of the block must respond to #to_time and return a Time object when called.
+    # Takes a block and stores for lazy evaluation to define the end of the
+    # time range being checked. The return value of the block must respond
+    # to #to_time and return a Time object when called.
     #
     # @return [Proc]
     def up_to(&time_block)
       @up_to_block = time_block
     end
 
-    # Calls the Proc value of #up_to_block and calls #to_time on the return value. Expects a Time object
-    # to be returned.
+    # Calls the Proc value of #up_to_block and calls #to_time on the return value.
+    # Expects a Time object to be returned.
     #
     # @return [Time]
     def up_to_time

data/lib/twords/follower_bot_cop.rb

@@ -0,0 +1,67 @@
+require 'csv'
+require 'pry'
+require 'twords/config_accessible'
+
+class Twords
+  class FollowerBotCop
+    include ConfigAccessible
+
+    attr_reader :screen_name, :followers, :follower_bots
+
+    def initialize(screen_name)
+      @screen_name   = screen_name
+      @followers     = []
+      @follower_bots = []
+    end
+
+    def client
+      config.client.client
+    end
+
+    def detect_bots(cursor: nil)
+      response = client.followers(screen_name, count: 200, cursor: cursor)
+      count_followers_and_bots(response)
+      next_cursor = response.attrs[:next_cursor]
+      return if next_cursor == 0
+      detect_bots(cursor: next_cursor)
+    rescue Twitter::Error::TooManyRequests => error
+      wait_out_rate_limit_error(error)
+      retry
+    end
+
+    def count_followers_and_bots(response)
+      response.attrs[:users].each do |user|
+        @followers << user
+        @follower_bots << user if a_bot?(user)
+      end
+    end
+
+    def wait_out_rate_limit_error(error)
+      reset_time = error.rate_limit.reset_in + 1
+      puts "Out of #{followers.count} followers, #{follower_bots.count} bots detected."
+      puts "That's a rate of #{percentage} out of 100."
+      puts "Hit rate limit, waiting #{reset_time} seconds.  "
+      sleep reset_time
+    end
+
+    def a_bot?(user)
+      if user[:statuses_count] <= 10
+        user[:default_profile_image] == true ||
+        user[:followers_count].zero? ||
+        bot_like_timeline?(user)
+      end
+    end
+
+    def bot_like_timeline?(user)
+      return true if user[:statuses_count].zero?
+      return false if user[:protected] == true
+      timeline = client.user_timeline(user[:screen_name])
+      timeline.all? { |tweet| tweet.reply? || tweet.retweet? }
+    end
+
+    def percentage
+      return 0.0 if followers.count.zero?
+      (follower_bots.count / followers.count.to_f * 100).round(2)
+    end
+  end
+end

data/lib/twords/instance_methods.rb

@@ -71,6 +71,7 @@ class Twords
   # @api public
   # @return [Array<Array<String, Integer>>]
   def sort_words
+    audit
     @_sort_words ||= words.sort { |a, b| b.last <=> a.last }
   end
   alias words_forward sort_words

data/lib/twords/version.rb

@@ -2,5 +2,5 @@
 
 class Twords
   # The current gem version
-  VERSION = '0.2.2'.freeze
+  VERSION = '0.2.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twords
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - M. Simon Borg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-06-23 00:00:00.000000000 Z
+date: 2017-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter
@@ -69,6 +69,7 @@ files:
 - lib/twords.rb
 - lib/twords/config_accessible.rb
 - lib/twords/configuration.rb
+- lib/twords/follower_bot_cop.rb
 - lib/twords/instance_methods.rb
 - lib/twords/twitter_client.rb
 - lib/twords/version.rb