replacer_bot 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3f27f98339571d3f2f02f50776049785f1d52bb
+  data.tar.gz: 36a8af3bc649a8d18f9d1e59d19f6d715220e466
+SHA512:
+  metadata.gz: 1f8edccc8fb420dc44c9d58e931e8117cb677092879541df343e229e3a556b0ca49a379c03132446ab6d18026a80ece5eddf6b4ff52e89ee04f8beb5322e14b2
+  data.tar.gz: 3133bd60c3169fb6478a8a1422a9bb1d2ff0dbd23624ef75ceab47800a836fbd0c5595d6f92c2b5c50fb71d9eb18354746fe6873c637ba80e4ea5b80d4b74e02

data/.gitignore

@@ -0,0 +1,17 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+.env
+last.tweet

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.2.0
+env:
+  global:
+  - secure: vZClOhjX33NL+SEWU72xyWcb9MHWPwZTp4YPgi5x3/hTRc8NB1IMBjicJu0KpxKzh7m7UfgbgVhHUwxkLn1oOBvTZteKvw4AcNpEdroLuxCfI1CpCUxwVOtyEacG369A3CZUCh+JaVc6JNtIXJeDYm+4gIv97g3xjw/kHMK/zwifZmo7LszrKluKfIvGe2JYImtXiGc/Lwn2F2JfxGwAx50oX3SPWXpte/uHhexG2q3nvUNhA7bAMO3tXLvSJDVv1Gs61q2rt3EkyaoUw9i7ZqI0/YSsOQzW40I1mNpSiEz0/SxzS9L/u7x9CwolRTJJ15SLajqzKT6Vr17ir3dMoM+jpYwxW4GyBotS9ScezFe6p/TBzVwFJclE2sAEE2DBUgSh9j0q4cTWnK3ff8RgkU+ECQaQPho/zp/eykgsr21pmKM3dxMrqtSoEBgF8TgGYYuPcR97NIbQv3g8XOJcwJhraqmgDgkV8KajuA6sx50KX8AxkaziD5eB2I8bqg3kev1BMd28OTvPEvAP0PF1/tIkp5oth9tgdVlGwJGncCLMZgtybjsYJEmDaGKtA0U+gOg/Cy9b3Irz0NgMVEeACN6wMetQYVJGAk7SN9AbCYMqK/gSMLR+vHd9I6ff/j0XsF8KXct9QpPMB6iZd+DFFt1ewq/+ECOsAcHvVQ1zv9Y=
+  - secure: Mbt5RWzZssdN7vOJ8XIvMKfb4WQlKaCcKJaIaRsT4dH33G7jd1nlifANx5MDW3SpqVa9lglzQ2uC8n1qWwY5l0va6uPZgm+FiInYnu+hQj0jsLb093K4kUZOGuqxYipXapITcgXGFmqlv75sABaFCFXKw9Pkn2XozeD2s4Hz6sh0J5TFnBAI5HrM4CUs8Zv2OSIQDEIjTi5PduYk91G5Tv/i6ihZsSJ9r9VloNoJak82rTeaL9JnUnZuZJwGF6ZsOLzYBRwInw/dI6ydhmSbkGosOTfl92q5NfBFeN0NroFiFVqkcDQInLhuNQZkwbvcdPs7/vOJzAOhuMlj8yPr8EYk2kS3HU7Zt0O853i8l3GehFsVthUQatriEeG0PBUmDl1Wj3srpaV8XQA6hMWHvDcD8afPRMAPYynoSkC06GVNDQjpEc1aZkSU8mdSyUcKtzjUiYhkOiwoRGoaPhnQwyHRg+7sE3SAQMVMqBukTlTnE6cCfcn0q/PGnD5dDuit7DkdSO6S96uVlC4VqxXPiHxtTNa/nThEQKetmt2cTJR9uA65HT/qlGQ4FVQcefXS3XIU7mIYzzw+g9cAzFz6j3wonKgHt6bKg0SmtqhZTxm6ZLbLvSx8jZzY6Hh/J9IRaLPskI/1iEZAeFCDkR5vYSalZCunWBz2r9UP0gmkJj0=
+  - secure: V2S0W5yqFmsMuTCQlObF23Aw5dGdv0ZFJRvNAVCAg8lx1sQFud43AZVqafzw0S/3NT63Cz9O+XskqOWZ5u8mBIZYmF9Gn0wX/2P1OFd4GxAJ9MXrG8T2dWWykHxachugibZXDIjedCRht4bWJ96GvitEt6tYbGr6yV0ziZgl/4U90bDvQ1XQzZkG637Gt/sFwAriGJ45V5H1ZzYHw7kaDFMhVzTk5sYjNoQD5rlcbZSBRV7MFK//wJA2pCNdwcS60LXpRyoqZXXrnD9vndFGEJoZM5DAPyNjlDk3nKvfkM/sAhJ4SRxEXqHDXMcpz3yoBTNHB0weJkczBS5VfeTcTIkEjWCYhZ0VVBdjXcDaxNRS1mj5Wb8O+3Dr5eSymZ98U3MT3k1MCZWyvmbFOJZnCbx4TbBHX4DjxMTjFPdG/RyFtCv+pFvSFTNl1jR/UP8VgcCDA+vg/YqNE5OxT2XXHYnmQHS2u0bHwsngI7cGVzKjgNN9lQKAehIVLy/2zWV49qK71RjqZlry1V8KsGxikVMEuqbLgP3szRdWTvBvO26uHv45+5i39nXU82ZT9DsPxH5jCqhblKPcT2CDp7ibVl3B1sURZ7YHIgfOWITjWU9H+XzzGLvtVPVcoMjBSP5uQft4Pgm6cRXC3SLiA8SpTQTS4hSzIPLJRhvcq420vxQ=
+  - secure: DP3Zj5bq5UXJQrVn+TBdQZp4U8JuQpKmw+KfVkphdL6NF/GLo7riNJdqRVMGpKI22WW9O3HWKV6Vnwq3jKkT+1ESdHUTBqkzgZc4jHOV36G3rIuhXj7hQbIcExJbxJ0LaePvDcxyVOB3oWTl0Kf2A7JN0Z9qb2ELshvB9pqV1KNJ2g4E9SNag5LM/TcZuQ7eGMIwFcT9+Ag83EszIBm/C1+qhFImMbbjrk5hA+mIogPtV9jQUtWAPPy0r7PHU+/1VPQhZWemtr8Ozlte2qELpyahyR6XzCF4Y7j3u4er3CfSWkb6B0u+bcKUJuaqavDi70ABP1UUGUzNOId4uDiXIgVG8JBFjPl4GUqe05xyq+4QYZMiqc1WTbIJJktntYpGV0Yq1q++osqFfbbt486L45+x/tyIk5E2f9TLNyn5fMNqh9LCQvq0KVdZMS2UrMzmOb3dwEre/NRAuvdeUwkusFaG0V6UVurhD+HN+yiqT//gy+YXI3uKtNCAGh4cpIZEqAyCaW4ehOjm3RvZNmCBbVr9F92WWfB8lVrHivHevGV4twVgapL0u0YAKDT66Dn2U5B3DmRBATw+OqitOddwQRO2h0lCzKdVhc9THDj5Boi/IWc/Y1PvKh/p74dp1PZab6zkitQ52KUOEPS/U6MrDOUKLZsDy8FtXSRL3rALj60=

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in replacer_bot.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,23 @@
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end
+
+guard "cucumber" do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$})          { "features" }
+
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "features"
+  end
+end

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2015 pikesley
+
+MIT License
+
+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,7 @@
+[![Build Status](http://img.shields.io/travis/pikesley/replacer_bot.svg)](https://travis-ci.org/pikesley/replacer_bot)
+[![Dependency Status](http://img.shields.io/gemnasium/pikesley/replacer_bot.svg)](https://gemnasium.com/pikesley/replacer_bot)
+[![Coverage Status](http://img.shields.io/coveralls/pikesley/replacer_bot.svg)](https://coveralls.io/r/pikesley/replacer_bot)
+[![Code Climate](http://img.shields.io/codeclimate/github/pikesley/replacer_bot.svg)](https://codeclimate.com/github/pikesley/replacer_bot)
+[![Gem Version](http://img.shields.io/gem/v/replacer_bot.svg)](https://rubygems.org/gems/replacer_bot)
+[![License](http://img.shields.io/:license-mit-blue.svg)](http://pikesley.mit-license.org)
+[![Badges](http://img.shields.io/:badges-7/7-ff6799.svg)](https://github.com/badges/badgerbadgerbadger)

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+require 'coveralls/rake/task'
+
+Coveralls::RakeTask.new
+RSpec::Core::RakeTask.new
+Cucumber::Rake::Task.new
+
+task :default => [:spec, 'coveralls:push']

data/bin/replacer

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'replacer_bot/cli'
+ReplacerBot::CLI.start

data/config/defaults.yml

@@ -0,0 +1,6 @@
+search_term: open data
+save_file: last.tweet
+replacements:
+  - open data: Taylor Swift
+  - opendata: TaylorSwift
+interval: 60 #seconds

data/features/replacer.feature

@@ -0,0 +1,5 @@
+Feature: Replacer
+
+  Scenario: Show version
+    When I successfully run `replacer version`
+    Then the output should contain "replacer version "

data/features/support/env.rb

@@ -0,0 +1,2 @@
+require 'aruba/cucumber'
+require 'cucumber/rspec/doubles'

data/lib/replacer_bot.rb

@@ -0,0 +1,16 @@
+require 'twitter'
+require 'dotenv'
+require 'uri'
+require 'singleton'
+require 'thor'
+require 'yaml'
+
+require 'replacer_bot/version'
+require 'replacer_bot/replacer'
+require 'replacer_bot/config'
+require 'replacer_bot/helpers'
+require 'replacer_bot/twitter_client'
+
+Dotenv.load
+
+TWITTER_LIMIT= 140

data/lib/replacer_bot/cli.rb

@@ -0,0 +1,17 @@
+require 'replacer_bot'
+
+module ReplacerBot
+  class CLI < Thor
+    desc 'version', 'Print replacer version'
+    def version
+      puts "replacer version #{VERSION}"
+    end
+    map %w(-v --version) => :version
+
+    desc 'tweet', 'find, munge and send tweets'
+    def tweet
+      r = Replacer.new
+      r.tweet
+    end
+  end
+end

data/lib/replacer_bot/config.rb

@@ -0,0 +1,31 @@
+module ReplacerBot
+  class Config
+    include Singleton
+
+    def initialize
+      reset!
+    end
+
+    def reset! # testing a singleton is hard
+      custom = fetch_yaml "#{ENV['HOME']}/.replacer_bot/config.yml"
+      defaults = fetch_yaml (File.join(File.dirname(__FILE__), '..', '..', 'config/defaults.yml'))
+      defaults.merge! custom
+
+      @config = OpenStruct.new defaults
+    end
+
+    def config
+      @config
+    end
+
+    private
+
+    def fetch_yaml file
+      begin
+        YAML.load File.open file
+      rescue
+        {}
+      end
+    end
+  end
+end

data/lib/replacer_bot/helpers.rb

@@ -0,0 +1,93 @@
+module ReplacerBot
+  def self.encode term
+    URI.encode "\"#{term}\""
+  end
+
+  def self.last_tweet
+    begin
+      Marshal.load File.read Config.instance.config.save_file
+    rescue ArgumentError
+      0
+    rescue Errno::ENOENT
+      0
+    end
+  end
+
+  def self.validate string, term = Config.instance.config.search_term, ignore_spaces = true
+    return false if string[0...2] == 'RT'
+    return false if string[0] == '@'
+
+    term = term.gsub ' ', ' ?' if ignore_spaces
+    return true if string.index /#{term}/i
+
+    false
+  end
+
+  def self.filter list
+    list.select { |i| self.validate i.text, Config.instance.config.search_term }.
+      select { |i| i.id > self.last_tweet}
+  end
+
+  def self.dehash word
+    if word[0] == '#'
+      return word[1..-1]
+    end
+
+    word
+  end
+
+  def self.despace string
+    string.gsub(/\n+/, ' ').gsub(/ +/, ' ').strip
+  end
+
+  def self.truncate text
+    return_text = ''
+    text.split.each do |word|
+      new_text = "#{return_text} #{word}".strip
+      if new_text.length > TWITTER_LIMIT
+        return return_text
+      else
+        return_text = new_text
+      end
+    end
+
+    return_text
+  end
+
+  def self.article string
+    string = self.dehash string
+    specials = [ 'hotel' ]
+
+    if specials.include? string.downcase
+      return 'an'
+    end
+
+    if 'aeiou'.include? string[0].downcase
+      return 'an'
+    end
+
+    'a'
+  end
+
+  def self.replacement_extender replacement
+    [
+      replacement.map { |k, v| {"#{self.article k} #{k}" => "#{self.article v} #{v}"} }[0],
+      replacement.map { |k, v| {"#{self.article k} ##{k}" => "#{self.article v} ##{v}"} }[0]
+    ]
+  end
+
+  def self.replace string, subs = Config.instance.config.replacements
+    # Something about a frozen string
+    our_string = string.dup
+    subs.each do |substitute|
+      (self.replacement_extender(substitute) << substitute).each do |s|
+        s.each do |search, replace|
+          our_string = self.despace our_string
+          our_string.gsub! /#{search}/i, replace
+        end
+      end
+    end
+
+    our_string
+  end
+end

data/lib/replacer_bot/replacer.rb

@@ -0,0 +1,40 @@
+module ReplacerBot
+  class Replacer
+    attr_reader :results, :config
+
+    def initialize
+      @config = Config.instance.config
+      @search_term = @config.search_term
+      @client = TwitterClient.client
+    end
+
+    def search count = 20
+      @results ||= begin
+        results = ReplacerBot.filter @client.search(ReplacerBot.encode(@search_term), result_type: 'recent').take(count)
+      end
+    end
+
+    def tweets
+      search.map { |r| ReplacerBot.truncate ReplacerBot.replace r.text }
+    end
+
+    def tweet
+      tweets.each do |tweet|
+        puts "Tweeting: #{tweet}"
+        @client.update tweet
+        puts "Sleeping #{@config.interval} seconds"
+        sleep @config.interval
+      end
+
+      save
+    end
+
+    def save
+      if search.first
+        File.open @config.save_file, 'w' do |file|
+          Marshal.dump search.first.id, file
+        end
+      end
+    end
+  end
+end

data/lib/replacer_bot/twitter_client.rb

@@ -0,0 +1,14 @@
+module ReplacerBot
+  class TwitterClient
+    def self.client
+      config = {
+        consumer_key:        ENV['CONSUMER_KEY'],
+        consumer_secret:     ENV['CONSUMER_SECRET'],
+        access_token:        ENV['TOKEN'],
+        access_token_secret: ENV['SECRET']
+      }
+
+      ::Twitter::REST::Client.new(config)
+    end
+  end
+end

data/lib/replacer_bot/version.rb

@@ -0,0 +1,3 @@
+module ReplacerBot
+  VERSION = "0.0.2"
+end

data/replacer_bot.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'replacer_bot/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'replacer_bot'
+  spec.version       = ReplacerBot::VERSION
+  spec.authors       = ['pikesley']
+  spec.email         = ['github@orgraphone.org']
+  spec.summary       = %q{Taylor Swift}
+  spec.description   = %q{Taylor Swift}
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'twitter', '~> 5.14'
+  spec.add_dependency 'dotenv', '~> 2.0'
+  spec.add_dependency 'thor', '~> 0.19'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.3'
+  spec.add_development_dependency 'guard-rspec', '~> 4.6'
+  spec.add_development_dependency 'guard-cucumber', '~> 1.6'
+  spec.add_development_dependency 'vcr', '~> 2.9'
+  spec.add_development_dependency 'webmock', '~> 1.21'
+  spec.add_development_dependency 'cucumber' , '~> 2.0'
+  spec.add_development_dependency 'aruba', '~> 0.8'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+end

data/spec/lib/replacer_bot/config_spec.rb

@@ -0,0 +1,9 @@
+module ReplacerBot
+  describe Config do
+    let(:conf) { ReplacerBot::Config.instance.config }
+
+    it 'has defaults' do
+      expect(conf['search_term']).to eq 'open data'
+    end
+  end
+end

data/spec/lib/replacer_bot/helpers_spec.rb

@@ -0,0 +1,88 @@
+module ReplacerBot
+  describe 'Helpers' do
+    context 'URLs' do
+      it 'URL-encodes a search term' do
+        expect(ReplacerBot.encode 'open data').to eq '%22open%20data%22'
+      end
+    end
+
+    context 'last tweet' do
+      it 'gets a default value for the last tweet' do
+        expect(ReplacerBot.last_tweet).to eq 0
+      end
+
+      it 'knows the ID of the last tweet' do
+        File.open 'last.tweet', 'w' do |f|
+          Marshal.dump 632586894455500800, f
+        end
+        expect(ReplacerBot.last_tweet).to eq 632586894455500800
+        FileUtils.rm 'last.tweet'
+      end
+    end
+
+    context 'filtering' do
+      it 'validates liberally' do
+        expect(ReplacerBot.validate 'opendata hulk', 'open data').to eq true
+      end
+
+      it 'validates more strictly' do
+        expect(ReplacerBot.validate 'open data ftw', 'open data', ignore_spaces = false).to eq true
+        expect(ReplacerBot.validate 'i love opendata', 'open data', ignore_spaces = false).to eq false
+      end
+
+      it 'validates away rubbish' do
+        expect(ReplacerBot.validate 'incredible hulk', 'open data').to eq false
+      end
+
+      it 'filters retweets' do
+        expect(ReplacerBot.validate 'RT @xyz This is about Open Data').to eq false
+      end
+      it 'filters direct replies' do
+        expect(ReplacerBot.validate '@abc This is a reply about Open Data').to eq false
+      end
+    end
+
+    context 'search and replace' do
+      it 'removes a hash from the start of a word' do
+        expect(ReplacerBot.dehash '#opendata').to eq 'opendata'
+        expect(ReplacerBot.dehash 'data').to eq 'data'
+      end
+
+      it 'squashes whitespace' do
+        expect(ReplacerBot.despace 'open  data').to eq 'open data'
+        expect(ReplacerBot.despace 'open    data  taylor    swift').to eq 'open data taylor swift'
+        expect(ReplacerBot.despace " open\n\ndata  ").to eq 'open data'
+      end
+
+      it 'trims to 140 characters nicely' do
+        expect(ReplacerBot.truncate 'FYI via @DBMph: The 2016 proposed budget is now in Taylor Swift format! You may access it on our website: http://t.co/EO6Lep3PeW #Transparency').
+          to eq 'FYI via @DBMph: The 2016 proposed budget is now in Taylor Swift format! You may access it on our website: http://t.co/EO6Lep3PeW'
+      end
+
+      it 'replaces text' do
+        expect(ReplacerBot.replace 'Something about Open Data goes here').to eq 'Something about Taylor Swift goes here'
+        expect(ReplacerBot.replace 'Something about #opendata http://foo.bar/').to eq 'Something about #TaylorSwift http://foo.bar/'
+      end
+
+      it 'does a/an correctly' do
+        expect(ReplacerBot.article 'Open Data').to eq 'an'
+        expect(ReplacerBot.article 'Taylor Swift').to eq 'a'
+      end
+
+      it 'extends replacements correctly' do
+        expect(ReplacerBot.replacement_extender 'open data' => 'Taylor Swift').
+          to eq(
+            [
+              {'an open data' => 'a Taylor Swift'},
+              {'an #open data' => 'a #Taylor Swift'}
+            ]
+          )
+      end
+
+      it 'uses the correct article in replacements' do
+        expect(ReplacerBot.replace 'This is an Open Data tweet').to eq 'This is a Taylor Swift tweet'
+        expect(ReplacerBot.replace 'This is an Open Data tweet about an #opendata story').to eq 'This is a Taylor Swift tweet about a #TaylorSwift story'
+      end
+    end
+  end
+end