twords 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14f8d19e5e919775262f1711702693d2d9c1bd04
+  data.tar.gz: 997c565ad48498bac50db80fde8e56ed2a1d4ff8
+SHA512:
+  metadata.gz: 535d6f11f585e85465fd42f03e068f126935678b597c1f689e37149e797c5149718f629bb0cdaa448dfe9b397b3a2f84ab66d5c02452c5d8981c8cca59ceed8e
+  data.tar.gz: 5c6eb12f69e02413868c931b8f85bb8d74b58846e1ba0d02c91b2d72d3014bca115c443bbcac5eeb28c6f4f3d1b570294eaa19264806e8dd7810d3444073e86e

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 M. Simon Borg
+
+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.md

@@ -0,0 +1,62 @@
+# Twords
+
+## Twitter word clouds
+
+Count the occurrences of words in a tweeter's tweets.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'twords'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install twords
+
+## Usage
+
+```ruby
+Twords.config do |config|
+  config.throw_aways  = %w[the for and a i of if]
+  config.range        = 14
+  config.up_to { Time.now } # A time object to be lazy evaluated. The range is counted backward from here.
+  
+  config.twitter_client do |twitter|
+    twitter.consumer_key        = YOUR_TWITTER_CONSUMER_KEY
+    twitter.consumer_secret     = YOUR_TWITTER_CONSUMER_SECRET
+    twitter.access_token        = YOUR_TWITTER_ACCESS_TOKEN
+    twitter.access_token_secret = YOUR_TWITTER_ACCESS_TOKEN_SECRET
+  end
+end
+
+twords = Twords.new 'user_one', 'user_two'
+
+twords.audit
+# => true
+
+twords.words
+# => { "butts"=>35, "poo"=>32, "pups"=>28, ... }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/msimonborg/twords.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/lib/twords.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'twitter'
+
+require 'twords/version'
+
+# Twords.config do |config|
+#   config.throw_aways = %w[the for and a i of if]
+#   config.max_age     = 14
+#   config.up_to { Time.now }
+#
+#   config.twitter_client do |twitter|
+#     twitter.consumer_key        = YOUR_TWITTER_CONSUMER_KEY
+#     twitter.consumer_secret     = YOUR_TWITTER_CONSUMER_SECRET
+#     twitter.access_token        = YOUR_TWITTER_ACCESS_TOKEN
+#     twitter.access_token_secret = YOUR_TWITTER_ACCESS_TOKEN_SECRET
+#   end
+# end
+#
+# twords = Twords.new 'user_one', 'user_two'
+#
+# twords.audit
+# # => true
+#
+# twords.words
+# # => { "butts"=>35, "poo"=>32, "pups"=>28, ... }
+class Twords
+  class << self
+    attr_reader :throw_aways, :range, :client, :up_to_block
+
+    def config(&block)
+      class_eval(&block)
+    end
+
+    def twitter_client(&block)
+      @client = Twitter::REST::Client.new(&block)
+    end
+
+    def throw_aways=(*args)
+      @throw_aways = args.flatten
+    end
+
+    def range=(integer)
+      @range = integer
+    end
+
+    def up_to(&time_block)
+      raise ArgumentError, 'object must respond to #call' unless time_block.respond_to?(:call)
+      @up_to_block = time_block
+    end
+  end
+
+  attr_reader :screen_names, :words, :requests, :client
+
+  def initialize(*screen_names)
+    @screen_names = screen_names
+    @words        = {}
+    @requests     = 0
+  end
+
+  def client
+    @_client ||= self.class.client
+  end
+
+  def range
+    @_range ||= self.class.range
+  end
+
+  def audited?
+    @audited
+  end
+
+  def sort_words
+    words.sort { |a, b| b.last <=> a.last }
+  end
+
+  def timeline
+    @_timeline ||= screen_names.map { |name| fetch_timeline(name) }.flatten
+  end
+
+  # Make two cursored API calls to fetch the 400 most recent tweets
+  def fetch_timeline(screen_name)
+    return [] if screen_name.to_s.empty?
+    @requests += 1
+    timeline = client.user_timeline(screen_name, count: 200)
+    return timeline if timeline.empty?
+    fetch_older_tweets(timeline, screen_name)
+  end
+
+  def fetch_older_tweets(timeline, screen_name)
+    return timeline if age_of_tweet_in_days(timeline.last) > range
+    @requests += 1
+    timeline += client.user_timeline(
+        screen_name,
+        max_id: timeline.last.id - 1,
+        count: 200
+    )
+    fetch_older_tweets(timeline, screen_name)
+  end
+
+  def recent_tweets
+    @_recent_tweets ||= timeline.each_with_object([]) do |tweet, memo|
+      memo << tweet if age_of_tweet_in_days(tweet) <= range
+    end.sort { |a, b| b.created_at <=> a.created_at }
+  end
+
+  def age_of_tweet_in_days(tweet)
+    (self.class.up_to_block.call - tweet.created_at) / 60 / 60 / 24
+  end
+
+  def count_words
+    recent_tweets.each do |tweet|
+      tweet_with_full_text = fetch_tweet_with_full_text(tweet)
+      words_array = tweet_with_full_text.attrs[:full_text].downcase.split(' ')
+      words_array.each do |word|
+        next if self.class.throw_aways.include?(word)
+        if words.has_key?(word)
+          words[word] += 1
+        else
+          words[word] = 1
+        end
+      end
+    end
+  end
+
+  def fetch_tweet_with_full_text(tweet)
+    @requests += 1
+    client.status(tweet.id, tweet_mode: 'extended')
+  end
+
+  def audit
+    count_words unless audited?
+    @audited = true
+  end
+
+  def recent_tweets_count
+    @_recent_tweets_count ||= recent_tweets.count
+  end
+end

data/lib/twords/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class Twords
+  VERSION = '0.1.0'
+end

data/twords.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twords/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'twords'
+  spec.version       = Twords::VERSION
+  spec.authors       = ['M. Simon Borg']
+  spec.email         = ['msimonborg@gmail.com']
+
+  spec.summary       = 'Twitter word clouds'
+  spec.description   = 'Twitter word clouds'
+  spec.homepage      = 'https://github.com/msimonborg/twords'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z lib LICENSE.txt README.md twords.gemspec`.split("\0")
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'twitter', '~> 6.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: twords
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- M. Simon Borg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Twitter word clouds
+email:
+- msimonborg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/twords.rb
+- lib/twords/version.rb
+- twords.gemspec
+homepage: https://github.com/msimonborg/twords
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Twitter word clouds
+test_files: []