ex_twitter 0.0.1

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2014 Shinohara Teruki
+
+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,39 @@
+ex-twitter
+==========
+
+A Ruby wrapper to the Twitter gem.
+
+## Installation
+
+### Gem
+
+```
+gem install ex_twitter
+```
+
+### Rails
+
+Add ex_twitter to your Gemfile, and bundle.
+
+## Features
+
+This gem is a thin wrapper of Twitter gem.  
+Twitter gem has twitter API like methods.  
+This gem has high functionality methods and don't raise exceptions.
+
+## Examples
+
+```
+require 'ex_twitter'
+client = ExTwitter.new(config)
+
+# get all tweets
+client.get_all_tweets
+
+# get all friend ids
+client.get_all_friends_ids
+
+# get all friends in parallel
+client.get_users(friend_ids)
+```
+

data/ex_twitter.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.add_dependency 'twitter'
+  spec.add_dependency 'activesupport'
+  spec.add_dependency 'parallel'
+  spec.add_development_dependency 'bundler'
+  spec.authors = ['Shinohara Teruki']
+  spec.description = %q(A wrapper to the Twitter gem.)
+  spec.email = %w[ts_3156@yahoo.co.jp]
+  spec.files = %w[LICENSE.md README.md Rakefile ex_twitter.gemspec]
+  spec.files += Dir.glob('lib/**/*.rb')
+  spec.files += Dir.glob('spec/**/*')
+  spec.homepage = 'http://github.com/ts-3156/ex-twitter/'
+  spec.licenses = %w[MIT]
+  spec.name = 'ex_twitter'
+  spec.require_paths = %w[lib]
+  spec.summary = spec.description
+  spec.test_files = Dir.glob('spec/**/*')
+  spec.version = '0.0.1'
+end

data/lib/ex_stream.rb

@@ -0,0 +1,68 @@
+# -*- coding: utf-8 -*-
+require 'twitter'
+require 'yaml'
+require 'active_support'
+require 'parallel'
+
+# extended twitter
+class ExStream < Twitter::Streaming::Client
+  attr_accessor :cache, :cache_expires_in
+
+  MAX_ATTEMPTS = 1
+  WAIT = false
+  CACHE_EXPIRES_IN = 300
+
+  def initialize(config={})
+    self.cache_expires_in = (config[:cache_expires_in] || CACHE_EXPIRES_IN)
+    self.cache = ActiveSupport::Cache::FileStore.new(File.join(Dir::pwd, 'ex_twitter_cache'),
+      {expires_in: self.cache_expires_in, race_condition_ttl: self.cache_expires_in})
+    super
+  end
+
+  def print_filter_stream(topics)
+    filter(track: topics.join(",")) do |object|
+      puts object.text if object.is_a?(Twitter::Tweet)
+    end
+  end
+
+  def print_sample_stream
+    sample do |object|
+      puts object.text if object.is_a?(Twitter::Tweet)
+    end
+  end
+
+  # An object may be one of the following:
+  #   Twitter::DirectMessage
+  #   Twitter::Streaming::DeletedTweet
+  #   Twitter::Streaming::Event
+  #   Twitter::Streaming::FriendList
+  #   Twitter::Streaming::StallWarning
+  #   Twitter::Tweet
+  def print_user_stream
+    user do |object|
+      case object
+      when Twitter::Tweet
+        puts "It's a tweet!"
+      when Twitter::DirectMessage
+        puts "It's a direct message!"
+      when Twitter::Streaming::StallWarning
+        warn "Falling behind!"
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  puts '--start--'
+  yml_config = YAML.load_file('config.yml')
+  config = {
+    consumer_key: yml_config['consumer_key'],
+    consumer_secret: yml_config['consumer_secret'],
+    access_token: yml_config['access_token'],
+    access_token_secret: yml_config['access_token_secret']
+  }
+  client = ExStream.new(config)
+  client.print_sample_stream
+end
+
+

data/lib/ex_twitter.rb

@@ -0,0 +1,378 @@
+# -*- coding: utf-8 -*-
+require 'twitter'
+require 'yaml'
+require 'active_support'
+require 'parallel'
+
+# extended twitter
+class ExTwitter < Twitter::REST::Client
+  attr_accessor :cache, :cache_expires_in
+
+  MAX_ATTEMPTS = 1
+  WAIT = false
+  CACHE_EXPIRES_IN = 300
+
+  def initialize(config={})
+    self.cache_expires_in = (config[:cache_expires_in] || CACHE_EXPIRES_IN)
+    self.cache = ActiveSupport::Cache::FileStore.new(File.join(Dir::pwd, 'ex_twitter_cache'),
+      {expires_in: self.cache_expires_in, race_condition_ttl: self.cache_expires_in})
+    super
+  end
+
+  def read(key)
+    self.cache.read(key)
+  rescue => e
+    puts "in read #{key} #{e.inspect}"
+    nil
+  end
+
+  def write(key, value)
+    self.cache.write(key, value)
+  rescue => e
+    puts "in write #{key} #{value} #{e.inspect}"
+    false
+  end
+
+  def collect_with_max_id(collection=[], max_id=nil, &block)
+    response = yield(max_id)
+    return response unless response[1].nil?
+
+    collection += response[0]
+    response[0].empty? ? [collection.flatten, nil] : collect_with_max_id(collection, response[0].last.id - 1, &block)
+  end
+
+  def collect_with_cursor(collection=[], cursor=-1, &block)
+    response = yield(cursor)
+    return response unless response[1].nil?
+
+    collection += (response[0][:users] || response[0][:ids])
+    next_cursor = response[0][:next_cursor]
+    next_cursor == 0 ? [collection.flatten, nil] : collect_with_cursor(collection, next_cursor, &block)
+  end
+
+  def get_latest_200_tweets(user=nil)
+    num_attempts = 0
+    options = {count: 200, include_rts: true}
+    begin
+      num_attempts += 1
+      [user_timeline(user, options), nil]
+    rescue Twitter::Error::TooManyRequests => e
+      if num_attempts <= MAX_ATTEMPTS
+        if WAIT
+          sleep e.rate_limit.reset_in
+          retry
+        else
+          puts "retry #{e.rate_limit.reset_in} seconds later"
+          [[], e]
+        end
+      else
+        puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS})"
+        [[], e]
+      end
+    rescue => e
+      if num_attempts <= MAX_ATTEMPTS
+        retry
+      else
+        puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), something error #{e.inspect}"
+        [[], e]
+      end
+    end
+  end
+
+  def get_all_tweets(user=nil)
+    num_attempts = 0
+    collect_with_max_id do |max_id|
+      options = {count: 200, include_rts: true}
+      options[:max_id] = max_id unless max_id.nil?
+      begin
+        num_attempts += 1
+        [user_timeline(user, options), nil]
+      rescue Twitter::Error::TooManyRequests => e
+        if num_attempts <= MAX_ATTEMPTS
+          if WAIT
+            sleep e.rate_limit.reset_in
+            retry
+          else
+            puts "retry #{e.rate_limit.reset_in} seconds later"
+            [[], e]
+          end
+        else
+          puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS})"
+          [[], e]
+        end
+      rescue => e
+        if num_attempts <= MAX_ATTEMPTS
+          retry
+        else
+          puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), something error #{e.inspect}"
+          [[], e]
+        end
+      end
+    end
+  end
+
+  def get_all_friends(user=nil)
+    num_attempts = 0
+    collect_with_cursor do |cursor|
+      options = {count: 200, include_user_entities: true}
+      options[:cursor] = cursor unless cursor.nil?
+      cache_key = "#{self.class.name}:#{__callee__}:#{user}:#{options}"
+
+      cache = self.read(cache_key)
+      next [cache, nil] unless cache.nil?
+      begin
+        num_attempts += 1
+        object = friends(user, options)
+        self.write(cache_key, object.attrs)
+        [object.attrs, nil]
+      rescue Twitter::Error::TooManyRequests => e
+        if num_attempts <= MAX_ATTEMPTS
+          if WAIT
+            sleep e.rate_limit.reset_in
+            retry
+          else
+            puts "retry #{e.rate_limit.reset_in} seconds later"
+            [{}, e]
+          end
+        else
+          puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS})"
+          [{}, e]
+        end
+      rescue => e
+        if num_attempts <= MAX_ATTEMPTS
+          retry
+        else
+          puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), something error #{e.inspect}"
+          [{}, e]
+        end
+      end
+    end
+  end
+
+  def get_all_followers(user=nil)
+    num_attempts = 0
+    collect_with_cursor do |cursor|
+      options = {count: 200, include_user_entities: true}
+      options[:cursor] = cursor unless cursor.nil?
+      cache_key = "#{self.class.name}:#{__callee__}:#{user}:#{options}"
+
+      cache = self.read(cache_key)
+      next [cache, nil] unless cache.nil?
+      begin
+        num_attempts += 1
+        object = followers(user, options)
+        self.write(cache_key, object.attrs)
+        [object.attrs, nil]
+      rescue Twitter::Error::TooManyRequests => e
+        if num_attempts <= MAX_ATTEMPTS
+          if WAIT
+            sleep e.rate_limit.reset_in
+            retry
+          else
+            puts "retry #{e.rate_limit.reset_in} seconds later"
+            [{}, e]
+          end
+        else
+          puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS})"
+          [{}, e]
+        end
+      rescue => e
+        if num_attempts <= MAX_ATTEMPTS
+          retry
+        else
+          puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), something error #{e.inspect}"
+          [{}, e]
+        end
+      end
+    end
+  end
+
+  def get_all_friend_ids(user=nil)
+    num_attempts = 0
+    collect_with_cursor do |cursor|
+      options = {count: 5000}
+      options[:cursor] = cursor unless cursor.nil?
+      cache_key = "#{self.class.name}:#{__callee__}:#{user}:#{options}"
+
+      cache = self.read(cache_key)
+      next [cache, nil] unless cache.nil?
+      begin
+        num_attempts += 1
+        object = friend_ids(user, options)
+        self.write(cache_key, object.attrs)
+        [object.attrs, nil]
+      rescue Twitter::Error::TooManyRequests => e
+        if num_attempts <= MAX_ATTEMPTS
+          if WAIT
+            sleep e.rate_limit.reset_in
+            retry
+          else
+            puts "retry #{e.rate_limit.reset_in} seconds later"
+            [{}, e]
+          end
+        else
+          puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS})"
+          [{}, e]
+        end
+      rescue => e
+        if num_attempts <= MAX_ATTEMPTS
+          retry
+        else
+          puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), something error #{e.inspect}"
+          [{}, e]
+        end
+      end
+    end
+  end
+
+  def get_all_follower_ids(user=nil)
+    num_attempts = 0
+    collect_with_cursor do |cursor|
+      options = {count: 5000}
+      options[:cursor] = cursor unless cursor.nil?
+      cache_key = "#{self.class.name}:#{__callee__}:#{user}:#{options}"
+
+      cache = self.read(cache_key)
+      next [cache, nil] unless cache.nil?
+      begin
+        num_attempts += 1
+        object = follower_ids(user, options)
+        self.write(cache_key, object.attrs)
+        [object.attrs, nil]
+      rescue Twitter::Error::TooManyRequests => e
+        if num_attempts <= MAX_ATTEMPTS
+          if WAIT
+            sleep e.rate_limit.reset_in
+            retry
+          else
+            puts "retry #{e.rate_limit.reset_in} seconds later"
+            [{}, e]
+          end
+        else
+          puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS})"
+          [{}, e]
+        end
+      rescue => e
+        if num_attempts <= MAX_ATTEMPTS
+          retry
+        else
+          puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), something error #{e.inspect}"
+          [{}, e]
+        end
+      end
+    end
+  end
+
+  def get_users(ids)
+    ids_per_worker = []
+    while(ids.size > 0)
+      ids_per_worker << ids.slice!(0, [100, ids.size].min)
+    end
+
+    num_attempts = 0
+    processed_users = []
+    Parallel.each_with_index(ids_per_worker, in_threads: ids_per_worker.size) do |ids, i|
+      cache_key = "#{self.class.name}:#{__callee__}:#{i}:#{ids}"
+      cache = self.read(cache_key)
+      if cache.nil?
+        begin
+          num_attempts += 1
+          object = {i: i, users: users(ids)}
+          self.write(cache_key, object)
+          processed_users << object
+        rescue Twitter::Error::TooManyRequests => e
+          if num_attempts <= MAX_ATTEMPTS
+            if WAIT
+              sleep e.rate_limit.reset_in
+              retry
+            else
+              puts "retry #{e.rate_limit.reset_in} seconds later"
+              {i: i, users: [], e: e}
+            end
+          else
+            puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS})"
+            {i: i, users: [], e: e}
+          end
+        rescue => e
+          if num_attempts <= MAX_ATTEMPTS
+            retry
+          else
+            puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), something error #{e.inspect}"
+            {i: i, users: [], e: e}
+          end
+        end
+      else
+        processed_users << cache
+      end
+    end
+    # TODO remove if users have error, or raise
+    processed_users.sort_by{|p|p[:i]}.map{|p|p[:users]}.flatten
+  end
+
+  # mentions_timeline is to fetch the timeline of Tweets mentioning the authenticated user
+  # get_mentions is to fetch the Tweets mentioning the screen_name's user
+  def get_mentions(screen_name)
+    search_tweets("to:#{screen_name}", {result_type: 'recent', count: 100})
+  end
+
+  def search_japanese_tweets(str)
+    search_tweets(str, {result_type: 'recent', count: 100, lang: 'ja'})
+  end
+
+  def search_tweets_except_rt(str)
+    search_tweets("#{str} -rt", {result_type: 'recent', count: 100})
+  end
+
+  def search_tweets(str, options)
+    num_attempts = 0
+    begin
+      num_attempts += 1
+      result = search(str, options)
+      [result.take(100), nil]
+    rescue Twitter::Error::TooManyRequests => e
+      if num_attempts <= MAX_ATTEMPTS
+        if WAIT
+          sleep e.rate_limit.reset_in
+          retry
+        else
+          puts "retry #{e.rate_limit.reset_in} seconds later"
+          [[], e]
+        end
+      else
+        puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS})"
+        [[], e]
+      end
+    rescue => e
+      if num_attempts <= MAX_ATTEMPTS
+        retry
+      else
+        puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), something error #{e.inspect}"
+        [[], e]
+      end
+    end
+  end
+end
+
+if __FILE__ == $0
+  puts '--start--'
+  yml_config = YAML.load_file('config.yml')
+  config = {
+    consumer_key: yml_config['consumer_key'],
+    consumer_secret: yml_config['consumer_secret'],
+    access_token: yml_config['access_token'],
+    access_token_secret: yml_config['access_token_secret']
+  }
+  client = ExTwitter.new(config)
+  #followers, error = client.get_all_followers
+  #puts "#{followers.size} #{error.inspect}"
+  tweets, error = client.search_tweets_except_rt('#グラドル自画撮り部')
+  puts tweets.size
+  tweets.each do |t|
+    next if !t.media?
+    puts t.text
+    puts t.media[0].attrs
+    puts '----'
+  end
+end
+
+

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: ex_twitter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Shinohara Teruki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: twitter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: parallel
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A wrapper to the Twitter gem.
+email:
+- ts_3156@yahoo.co.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.md
+- README.md
+- Rakefile
+- ex_twitter.gemspec
+- lib/ex_twitter.rb
+- lib/ex_stream.rb
+homepage: http://github.com/ts-3156/ex-twitter/
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A wrapper to the Twitter gem.
+test_files: []