retrobot 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f45da0e3a0e9809a79c0989c34e46a3d830fbbc
+  data.tar.gz: 8a8395194a7dc0399e061d1e9246def6dc1df8ce
+SHA512:
+  metadata.gz: f8bd439b243ac2f7c2c750331aa804cf18ed5391367c84b6ce1b78c91b9cd5fb2ef26aa37a3f3338d07f22fec34d21bf953ac52d043ef2b56c7ddfb051da095a
+  data.tar.gz: e940b57b01287d7a92c07bc9e28ad838604e4ad70cac0e285d2b77eaf3585ec63d47bb2c85177407db3431768a6f76c8fb82bd58e64703f757603273cf28c56e

data/.gitignore

@@ -0,0 +1,6 @@
+tweets/
+*.env
+log/
+tmp/
+.bundle
+retrobot.yml

data/ChangeLog.md

@@ -0,0 +1,7 @@
+# ChangeLog
+## 0.2.0
+- Gemify, and YAML style configuration (Thanks @sorah)
+- Remove .env
+
+## 0.0.1
+- First release

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    retrobot (0.0.1)
+      activesupport (~> 4.0)
+      daemons
+      get-twitter-oauth-token
+      retryable
+      twitter (~> 4.8.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.16)
+    awesome_print (1.2.0)
+    daemons (1.1.9)
+    diff-lcs (1.2.5)
+    faraday (0.9.0)
+      multipart-post (>= 1.2, < 3)
+    get-twitter-oauth-token (1.1.0)
+      oauth
+    i18n (0.6.9)
+    json (1.8.1)
+    minitest (4.7.5)
+    multi_json (1.9.2)
+    multipart-post (2.0.0)
+    oauth (0.4.7)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    retryable (1.3.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-json_matcher (0.0.6)
+      awesome_print
+      json
+    rspec-mocks (2.13.1)
+    simple_oauth (0.2.0)
+    thread_safe (0.3.1)
+      atomic (>= 1.1.7, < 2)
+    twitter (4.8.1)
+      faraday (~> 0.8, < 0.10)
+      multi_json (~> 1.0)
+      simple_oauth (~> 0.2)
+    tzinfo (0.3.39)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-test (~> 0.6.2)
+  retrobot!
+  rspec (~> 2.13.0)
+  rspec-json_matcher (~> 0.0.4)

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Issei Naruta
+
+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,70 @@
+retrobot
+=============
+Retrobot is a twitter-bot engine that working at [mirakui_retro](https://twitter.com/mirakui_retro).
+
+Retrobot tweets a word that you've tweeted just 1 year ago!
+
+## Requirements
+
+- Ruby 1.9+
+- Your [tweets.zip](https://blog.twitter.com/2012/your-twitter-archive)
+
+## Installation
+
+### Rubygems command
+
+```
+$ git clone https://github.com/mirakui/retrobot.git
+$ cd retrobot
+$ bundle install
+```
+
+### Using bundler 
+
+This way may be useful for deploying using capistrano or heroku.
+
+(This way separates repository by your deployment and application itself)
+
+```
+$ bundle init
+$ echo 'gem "retrobot"' >> Gemfile
+$ bundle install
+```
+
+## Configuration
+
+```
+$ bundle exec get-twitter-oauth-token
+(follow shown instruction to earn required credentials)
+
+$ unzip ~/tweets.zip -d tweets
+$ cp retrobot.example.yml retrobot.yml
+$ vi retrobot.yml
+(write your oauth credentials)
+```
+
+### Detail
+
+Config file is set to `./retrobot.yml` from `Dir.pwd` in default.
+You can give another file by using `--config` command line option.
+
+- `consumer_key`, `consumer_secret`: Your OAuth consumer key/secret given from Twitter.
+- `access_token`, `access_secret`: Your OAuth access key/secret of your Twitter account where you want to run retrobot.
+- `tweets_csv`: Path to your tweets.csv (default to `./tweets/tweets.csv` in pwd)
+
+## Running retrobot
+
+```
+$ bin/retrobot
+(or, )
+$ bin/retrobot -c /path/to/retrobot.yml
+```
+
+or you can run it as a daemon as follows:
+
+```
+$ bin/retrobotctl [start|stop]
+```
+
+## License
+Copyright (c) 2013 Issei Naruta. Retrobot is released under the MIT License.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/retrobot

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+retried = false
+begin
+  require 'retrobot'
+rescue LoadError
+  raise if retried
+  retried = true
+  $:.unshift "#{__dir__}/../lib"
+  retry
+end
+
+Retrobot.new(ARGV).main

data/bin/retrobotctl

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+require 'daemons'
+require 'pathname'
+
+base_dir = Pathname('../../').expand_path(__FILE__)
+Daemons.run(
+  base_dir.join('bin/retrobot'),
+  app_name: 'retrobot',
+  dir_mode: :normal,
+  dir: base_dir.join('tmp'),
+  log_dir: base_dir.join('log'),
+  log_output: true
+)

data/lib/retrobot.rb

@@ -0,0 +1,154 @@
+require 'retrobot/version'
+require 'retrobot/config'
+
+require 'active_support/core_ext'
+require 'twitter'
+require 'retryable'
+require 'logger'
+require 'csv'
+require 'pathname'
+require 'time'
+require 'optparse'
+require 'cgi'
+
+class Retrobot
+
+  GEM_ROOT = Pathname.new('..').expand_path(__dir__)
+
+  def initialize(argv)
+    @argv = argv
+  end
+
+  def client
+    @client ||= Twitter::Client.new(
+                  consumer_key: @config.consumer_key,
+                  consumer_secret: @config.consumer_secret,
+                  oauth_token: @config.access_token,
+                  oauth_token_secret: @config.access_secret
+                )
+  end
+
+  def logger
+    @logger ||= begin
+                  l = Logger.new($stdout)
+                  l.level = @config.debug ? Logger::DEBUG : Logger::INFO
+                  l
+                end
+  end
+
+  def csv
+    @csv ||= begin
+               tweets_csv = file_from_candidates(
+                 @config.tweets_csv,
+                 GEM_ROOT.join('tweets', 'tweets.csv'),
+               )
+               CSV.parse File.read(tweets_csv)
+             end
+  end
+
+  def init_csv
+    csv.slice! 0
+    last_index = nil
+    csv.each_with_index.each do |line, i|
+      time = Time.parse line[3]
+      if time < @config.retro_days.ago
+        last_index = i
+        break;
+      end
+    end
+    csv.slice! last_index..-1
+    logger.info "Next update: \"#{csv.last[5]}\" at #{@config.retro_days.since(Time.parse(csv.last[3]))}"
+  end
+
+  def tweet_loop
+    logger.info 'start'
+    loop do
+      line = csv.last
+      if process_line(line)
+        csv.pop
+      end
+      sleep @config.loop_interval
+      logger.debug '.'
+    end
+  end
+
+  def process_line(line)
+    tweet_id, in_reply_to_status_id, in_reply_to_user_id,
+    timestamp, source, text,
+    retweeted_status_id, retweeted_status_user_id, retweeted_status_timestamp,
+    *expanded_urls = line
+
+    timestamp = Time.parse(timestamp).localtime
+    return false if timestamp > @config.retro_days.ago
+
+    if retweeted_status_id.present?
+      retweet retweeted_status_id.to_i, text
+      return true
+    end
+
+    tweet CGI.unescape_html(text.gsub('@', ''))
+    true
+  rescue Twitter::Error
+    logger.error "#{$!} (#{$!.class})\n  #{$@.join("\n  ")}"
+    true
+  end
+
+  def retweet(status_id, text=nil)
+    logger.info "retweet: #{status_id} \"#{text}\""
+    return if @config.dryrun
+    retryable(tries: @config.retry_count, sleep: @config.retry_interval) do
+      client.retweet status_id
+    end
+  end
+
+  def tweet(text)
+    logger.info "tweet: #{text}"
+    return if @config.dryrun
+    retryable(tries: @config.retry_count, sleep: @config.retry_interval) do
+      client.update text
+    end
+  end
+
+  def init_configuration
+    options = parse_options()
+    @config = Config.new
+
+    config_yml = file_from_candidates(
+      options[:config], './retrobot.yml',
+      GEM_ROOT.join('retrobot.yml')
+    )
+    @config.load_yaml_file!(config_yml) if config_yml
+
+    @config.merge!(options)
+
+    client.current_user # for faster fail (e.g. wrong credentials given)
+  end
+
+  def parse_options
+    options = {}
+
+    opt = OptionParser.new @argv
+    opt.banner = "Usage: #{$0} [OPTIONS]"
+    opt.on('--debug') { options[:debug] =  true }
+    opt.on('--dryrun') { options[:dryrun] = true }
+    opt.on('--config file') {|v| options[:config] = v }
+    opt.on('--retro-days days') {|v| options[:retro_days] = v }
+    opt.on('--tweets-csv path') {|v| options[:tweets_csv] = v }
+    opt.parse!
+
+    options
+  end
+
+  def main
+    init_configuration
+    init_csv
+    tweet_loop
+  end
+
+  private
+
+  def file_from_candidates(*candidates)
+    path = candidates.find { |f| f && File.exists?(f.to_s) }
+    path && path.to_s
+  end
+end

data/lib/retrobot/config.rb

@@ -0,0 +1,58 @@
+require 'active_support/core_ext'
+require 'psych'
+
+class Retrobot
+  class Config
+    KEYS = %i(
+      tweets_csv
+      consumer_key
+      consumer_secret
+      access_token
+      access_secret
+      retro_days
+      debug
+      dryrun
+      loop_interval
+      retry_interval
+      retry_count
+    )
+
+    DEFAULTS = {
+      tweets_csv: './tweets/tweets.csv',
+      retro_days: 365,
+      debug: false,
+      dryrun: false,
+      loop_interval: 3,
+      retry_interval: 3,
+      retry_count: 5
+    }
+
+    def initialize(options={})
+      @options = DEFAULTS.merge(options.symbolize_keys)
+    end
+
+    def merge!(hash)
+      @options.merge!(hash)
+    end
+
+    KEYS.each do |k|
+      define_method(k) { @options[k] }
+    end
+
+    def retro_days
+      @options[:retro_days].to_i.days
+    end
+
+    def tweets_csv
+      Pathname.new(@options[:tweets_csv])
+    end
+
+    def loop_interval;  @options[:loop_interval].to_i; end
+    def retry_interval; @options[:retry_interval].to_i; end
+    def retry_count;    @options[:retry_count].to_i; end
+
+    def load_yaml_file!(path)
+      @options.merge! Psych.load_file(path.to_s).symbolize_keys
+    end
+  end
+end

data/lib/retrobot/version.rb

@@ -0,0 +1,3 @@
+class Retrobot
+  VERSION = '0.2.0'
+end

data/retrobot.example.yml

@@ -0,0 +1,8 @@
+# tweets_csv: tweets/tweets.csv (default)
+consumer_key: your_consumer_key
+consumer_secret: your_consumer_secret
+access_token: your_access_token
+access_secret: your_access_secret
+# retro_days: 365 (default=365 / how days long ago do you want to see? / in N days ago)
+# debug: false (default)
+# dryrun: false (default)

data/retrobot.gemspec

@@ -0,0 +1,30 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'retrobot/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "retrobot"
+  gem.version       = Retrobot::VERSION
+  gem.authors     = ["Issei Naruta"]
+  gem.email       = ["mimitako@gmail.com"]
+  gem.description   = %q{Bot for twitter, which tweets a word that you've tweeted just 1 year ago}
+  gem.summary       = %q{Retrobot tweets a word that you've tweeted just 1 year ago. (example: @mirakui_retro)}
+  gem.homepage      = "https://github.com/mirakui/retrobot"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'twitter', '~> 4.8.1'
+  gem.add_dependency 'activesupport', '~> 4.0'
+  gem.add_dependency 'retryable'
+  gem.add_dependency 'daemons'
+
+  gem.add_runtime_dependency 'get-twitter-oauth-token'
+
+  gem.add_development_dependency "rspec", "~> 2.13.0"
+  gem.add_development_dependency "rspec-json_matcher", "~> 0.0.4"
+  gem.add_development_dependency "rack-test", "~> 0.6.2"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: retrobot
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Issei Naruta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.8.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: retryable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: daemons
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: get-twitter-oauth-token
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: rspec-json_matcher
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.4
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.2
+description: Bot for twitter, which tweets a word that you've tweeted just 1 year
+  ago
+email:
+- mimitako@gmail.com
+executables:
+- retrobot
+- retrobotctl
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ChangeLog.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/retrobot
+- bin/retrobotctl
+- lib/retrobot.rb
+- lib/retrobot/config.rb
+- lib/retrobot/version.rb
+- log/.keep
+- retrobot.example.yml
+- retrobot.gemspec
+- tmp/.keep
+homepage: https://github.com/mirakui/retrobot
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: 'Retrobot tweets a word that you''ve tweeted just 1 year ago. (example: @mirakui_retro)'
+test_files: []