ex_twitter 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4bd5d8eb5590d0a1eebb86ac2a6d3098c1272467
-  data.tar.gz: 5c8b5655e88e08dce94069e5850d6c682c7a810a
+  metadata.gz: b9fda73eb287f6236f329fc5fb989b8bf5d92a47
+  data.tar.gz: 6cb1aba39cd22832b8cc1bdab2ded68dc2fa83a4
 SHA512:
-  metadata.gz: 7e7b2026369bc3308a1982d513aff1f2fda23005054220a6bb0fbb791b903a367bc6a2fa0366e5026b12ef6f5e06e7d12ff6c64338e084d39f8625eb2c80b945
-  data.tar.gz: f7c0d73420daa1ae4d7121f982f1bbf3e6aca81d799bd8ed703504fc94a3a5009a4e47544082a39126af9a20814c7dba9e2823c4577985ddec94afd4db4ae91e
+  metadata.gz: dc8aef3495f721143296c30b661562eb5edf45a04e0c9d116809213ef1808626f19aa1c6c57e720422a11bd0af74c8bb4796551fb520509a16acf6a7c96c4ec1
+  data.tar.gz: 0be798a390977de38e5cea7cc525c53d8971b8c7f1f498ec86642f72f7dbe4b0a0907e37b44236123381fcc4c4eac4803a07e4ed9ffabbe871e323d108d7011a

data/README.md

@@ -1,7 +1,10 @@
 ex-twitter
 ==========
 
-A Ruby wrapper to the Twitter gem.
+[![Gem Version](https://badge.fury.io/rb/ex_twitter.png)](https://badge.fury.io/rb/ex_twitter)
+[![Build Status](https://travis-ci.org/ts-3156/ex-twitter.svg?branch=master)](https://travis-ci.org/ts-3156/ex-twitter)
+
+Add auto paginate feature to Twitter gem.
 
 ## Installation
 
@@ -17,23 +20,34 @@ 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.
+* Auto paginate feature
+
+## Configuration
 
-## Examples
+You can pass configuration options as a block to `ExTwitter.new` just like `Twitter::REST::Client.new`.
 
 ```
-require 'ex_twitter'
-client = ExTwitter.new(config)
+client = ExTwitter.new do |config|
+  config.consumer_key        = "YOUR_CONSUMER_KEY"
+  config.consumer_secret     = "YOUR_CONSUMER_SECRET"
+  config.access_token        = "YOUR_ACCESS_TOKEN"
+  config.access_token_secret = "YOUR_ACCESS_SECRET"
+end
+```
 
-# get all tweets
-client.get_all_tweets
+You can pass advanced configuration options as a block to `ExTwitter.new`.
 
-# get all friend ids
-client.get_all_friends_ids
+```
+client = ExTwitter.new do |config|
+  config.auto_paginate = true
+  config.max_retries   = 1
+  config.max_paginates = 3
+end
+```
+
+## Usage Examples
 
-# get all friends in parallel
-client.get_users(friend_ids)
+```
+client.user_timeline
 ```
 

data/Rakefile

@@ -6,4 +6,4 @@ RSpec::Core::RakeTask.new(:spec)
 
 task :test => :spec
 
-
+task default: [:spec]

data/ex_twitter.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
 
   spec.authors = ['Shinohara Teruki']
-  spec.description = %q(A wrapper to the Twitter gem.)
+  spec.description = %q(Add auto paginate feature to 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')
@@ -20,5 +20,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
   spec.summary = spec.description
   spec.test_files = Dir.glob('spec/**/*')
-  spec.version = '0.0.2'
+  spec.version = '0.0.3'
 end

data/lib/ex_twitter.rb

@@ -1,3 +1,5 @@
+require 'active_support'
+require 'active_support/core_ext'
 require 'twitter'
 require 'yaml'
 require 'active_support'
@@ -6,58 +8,44 @@ require 'logger'
 
 # extended twitter
 class ExTwitter < Twitter::REST::Client
-  attr_accessor :cache, :cache_expires_in, :max_attempts, :wait, :auto_paginate, :logger
+  attr_accessor :cache, :cache_expires_in, :max_retries, :wait, :auto_paginate, :max_paginates, :logger
 
-  MAX_ATTEMPTS = 1
+  MAX_RETRIES = 1
   WAIT = false
-  CACHE_EXPIRES_IN = 300
-
-  def self.get_config_value(config)
-    return {} if config.nil?
-    {
-      consumer_key: config['consumer_key'],
-      consumer_secret: config['consumer_secret'],
-      access_token: config['access_token'],
-      access_token_secret: config['access_token_secret']
-    }
-  end
-
-  def initialize(config={})
-    if config.empty?
-      yml_config = if File.exists?(File.expand_path('./', 'config.yml'))
-        YAML.load_file('config.yml')
-      elsif File.exists?(File.expand_path('./config/', 'config.yml'))
-        YAML.load_file('config/config.yml')
-      end
-      config = self.class.get_config_value(yml_config)
-    end
-
-    self.auto_paginate = (config[:auto_paginate] || true)
-    self.max_attempts = (config[:max_attempts] || MAX_ATTEMPTS)
-    self.wait = (config[:wait] || WAIT)
-    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})
+  # CACHE_EXPIRES_IN = 300
+  AUTO_PAGINATE = true
+  MAX_PAGINATES = 3
 
+  def initialize(options = {})
     self.logger = Logger.new(STDOUT)
     self.logger.level = Logger::DEBUG
-    super
-  end
 
-  def read(key)
-    self.cache.read(key)
-  rescue => e
-    logger.warn "in read #{key} #{e.inspect}"
-    nil
-  end
+    self.auto_paginate = AUTO_PAGINATE
+    self.max_retries = MAX_RETRIES
+    self.wait = WAIT
+    self.max_paginates = MAX_PAGINATES
+
+    # 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})
 
-  def write(key, value)
-    self.cache.write(key, value)
-  rescue => e
-    logger.warn "in write #{key} #{value} #{e.inspect}"
-    false
+    super
   end
 
+  # def read(key)
+  #   self.cache.read(key)
+  # rescue => e
+  #   logger.warn "in read #{key} #{e.inspect}"
+  #   nil
+  # end
+  #
+  # def write(key, value)
+  #   self.cache.write(key, value)
+  # rescue => e
+  #   logger.warn "in write #{key} #{value} #{e.inspect}"
+  #   false
+  # end
+
   # githubでは、レスポンスが次のエンドポイントを知っているため、ブロックをデータの結合のみに使っている。引数ではAPI名を渡している。
   # 一方、twitterでは、レスポンスが次のエンドポイントを知らないため、ブロック内にAPI名を持ち、再帰的にブロックを呼び出している。
   # また、再帰を使うため、引数をコレクションの引き渡しに使ってしまっている。(この問題については通常のループを使えば解決する)
@@ -72,15 +60,18 @@ class ExTwitter < Twitter::REST::Client
   #
   # twitterで再帰方式がとられている理由は、おそらく、一般ユーザー向けのサンプルでメソッド名を渡すようなリフレクションを避けるため、
   # なのかもしれない。
+
+  # max_idを使って自動ページングを行う
   def collect_with_max_id(method_name, *args, &block)
-    options = args.last.is_a?(Hash) ? args.pop : {}
-    max_calls = options.delete(:max_calls) || 3
-    data = last_response = send(method_name, *args, options)
+    options = args.extract_options!
     logger.info "#{method_name}, #{args.inspect} #{options.inspect}"
 
+    max_paginates = options.delete(:max_paginates) || MAX_PAGINATES
+    data = last_response = send(method_name, *args, options)
+
     if auto_paginate
-      num_attempts = 0
-      (max_calls - 1).times do
+      num_retries = 0
+      (max_paginates - 1).times do
         break unless last_response.any?
 
         options[:max_id] = last_response.last.id - 1
@@ -89,24 +80,24 @@ class ExTwitter < Twitter::REST::Client
           last_response = send(method_name, *args, options)
           logger.info "#{method_name}, #{args.inspect} #{options.inspect}"
         rescue Twitter::Error::TooManyRequests => e
-          if num_attempts <= MAX_ATTEMPTS
+          if num_retries <= MAX_RETRIES
             if WAIT
               sleep e.rate_limit.reset_in
-              num_attempts += 1
+              num_retries += 1
               retry
             else
               logger.warn "retry #{e.rate_limit.reset_in} seconds later, #{e.inspect}"
             end
           else
-            logger.warn "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), #{e.inspect}"
+            logger.warn "fail. num_retries > MAX_RETRIES(=#{MAX_RETRIES}), #{e.inspect}"
           end
         rescue => e
-          if num_attempts <= MAX_ATTEMPTS
-            logger.warn "retry till num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), #{e.inspect}"
-            num_attempts += 1
+          if num_retries <= MAX_RETRIES
+            logger.warn "retry till num_retries > MAX_RETRIES(=#{MAX_RETRIES}), #{e.inspect}"
+            num_retries += 1
             retry
           else
-            logger.warn "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), something error #{e.inspect}"
+            logger.warn "fail. num_retries > MAX_RETRIES(=#{MAX_RETRIES}), something error #{e.inspect}"
           end
         end
 
@@ -121,16 +112,18 @@ class ExTwitter < Twitter::REST::Client
     data
   end
 
+  # cursorを使って自動ページングを行う
   def collect_with_cursor(method_name, *args, &block)
-    options = args.last.is_a?(Hash) ? args.pop : {}
-    max_calls = options.delete(:max_calls) || 3
-    last_response = send(method_name, *args, options).attrs
+    options = args.extract_options!
     logger.info "#{method_name}, #{args.inspect} #{options.inspect}"
+
+    max_paginates = options.delete(:max_paginates) || MAX_PAGINATES
+    last_response = send(method_name, *args, options).attrs
     data = last_response[:users] || last_response[:ids]
 
     if auto_paginate
-      num_attempts = 0
-      (max_calls - 1).times do
+      num_retries = 0
+      (max_paginates - 1).times do
         next_cursor = last_response[:next_cursor]
         break if !next_cursor || next_cursor == 0
 
@@ -140,24 +133,24 @@ class ExTwitter < Twitter::REST::Client
           last_response = send(method_name, *args, options).attrs
           logger.info "#{method_name}, #{args.inspect} #{options.inspect}"
         rescue Twitter::Error::TooManyRequests => e
-          if num_attempts <= MAX_ATTEMPTS
+          if num_retries <= MAX_RETRIES
             if WAIT
               sleep e.rate_limit.reset_in
-              num_attempts += 1
+              num_retries += 1
               retry
             else
               logger.warn "retry #{e.rate_limit.reset_in} seconds later, #{e.inspect}"
             end
           else
-            logger.warn "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), #{e.inspect}"
+            logger.warn "fail. num_retries > MAX_RETRIES(=#{MAX_RETRIES}), #{e.inspect}"
           end
         rescue => e
-          if num_attempts <= MAX_ATTEMPTS
-            logger.warn "retry till num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), #{e.inspect}"
-            num_attempts += 1
+          if num_retries <= MAX_RETRIES
+            logger.warn "retry till num_retries > MAX_RETRIES(=#{MAX_RETRIES}), #{e.inspect}"
+            num_retries += 1
             retry
           else
-            logger.warn "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), something error #{e.inspect}"
+            logger.warn "fail. num_retries > MAX_RETRIES(=#{MAX_RETRIES}), something error #{e.inspect}"
           end
         end
 
@@ -174,33 +167,38 @@ class ExTwitter < Twitter::REST::Client
   end
 
   alias :old_user_timeline :user_timeline
-  def user_timeline(user = nil, options = {})
-    options = options.merge({count: 200, include_rts: true})
-    collect_with_max_id(:old_user_timeline, user, options)
+  def user_timeline(*args)
+    options = {count: 200, include_rts: true}.merge(args.extract_options!)
+    collect_with_max_id(:old_user_timeline, *args, options)
+  end
+
+  def user_photos(*args)
+    tweets = user_timeline(*args)
+    tweets.select{|t| t.media? }.map{|t| t.media }.flatten
   end
 
   alias :old_friends :friends
-  def friends(user = nil, options = {})
-    options = options.merge({count: 200, include_user_entities: true})
-    collect_with_cursor(:old_friends, user, options)
+  def friends(*args)
+    options = {count: 200, include_user_entities: true}.merge(args.extract_options!)
+    collect_with_cursor(:old_friends, *args, options)
   end
 
   alias :old_followers :followers
-  def followers(user = nil, options = {})
-    options = options.merge({count: 200, include_user_entities: true})
-    collect_with_cursor(:old_followers, user, options)
+  def followers(*args)
+    options = {count: 200, include_user_entities: true}.merge(args.extract_options!)
+    collect_with_cursor(:old_followers, *args, options)
   end
 
   alias :old_friend_ids :friend_ids
-  def friend_ids(user = nil, options = {})
-    options = options.merge({count: 5000})
-    collect_with_cursor(:old_friend_ids, user, options)
+  def friend_ids(*args)
+    options = {count: 5000}.merge(args.extract_options!)
+    collect_with_cursor(:old_friend_ids, *args, options)
   end
 
   alias :old_follower_ids :follower_ids
-  def follower_ids(user = nil, options = {})
-    options = options.merge({count: 5000})
-    collect_with_cursor(:old_follower_ids, user, options)
+  def follower_ids(*args)
+    options = {count: 5000}.merge(args.extract_options!)
+    collect_with_cursor(:old_follower_ids, *args, options)
   end
 
   alias :old_users :users
@@ -216,6 +214,10 @@ class ExTwitter < Twitter::REST::Client
     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)
@@ -231,13 +233,13 @@ class ExTwitter < Twitter::REST::Client
   end
 
   def search_tweets(str, options)
-    num_attempts = 0
+    num_retries = 0
     begin
-      num_attempts += 1
+      num_retries += 1
       result = search(str, options)
       [result.take(100), nil]
     rescue Twitter::Error::TooManyRequests => e
-      if num_attempts <= MAX_ATTEMPTS
+      if num_retries <= MAX_RETRIES
         if WAIT
           sleep e.rate_limit.reset_in
           retry
@@ -246,14 +248,14 @@ class ExTwitter < Twitter::REST::Client
           [[], e]
         end
       else
-        puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS})"
+        puts "fail. num_retries > MAX_RETRIES(=#{MAX_RETRIES})"
         [[], e]
       end
     rescue => e
-      if num_attempts <= MAX_ATTEMPTS
+      if num_retries <= MAX_RETRIES
         retry
       else
-        puts "fail. num_attempts > MAX_ATTEMPTS(=#{MAX_ATTEMPTS}), something error #{e.inspect}"
+        puts "fail. num_retries > MAX_RETRIES(=#{MAX_RETRIES}), something error #{e.inspect}"
         [[], e]
       end
     end

data/spec/ex_twitter_spec.rb

@@ -12,59 +12,79 @@ describe ExTwitter do
   let(:client) { ExTwitter.new(config) }
 
   describe '#initialize' do
-  end
-
-  describe '#read' do
-  end
-
-  describe '#write' do
-  end
-
-  describe '#collect_with_max_id' do
-  end
+    let(:default_value) { 3 }
+    let(:value) { 100 }
 
-  describe '#collect_with_cursor' do
-  end
+    context 'without params' do
+      it "doesn't set max_paginates" do
+        expect(ExTwitter.new.max_paginates).to eq(default_value)
+      end
+    end
 
-  describe '#user_timeline' do
-    it 'call collect_with_max_id' do
-      expect(client).to receive(:collect_with_max_id)
-      client.user_timeline
+    context 'with params' do
+      it 'set max_paginates' do
+        expect(ExTwitter.new(max_paginates: value).max_paginates).to eq(value)
+      end
     end
-  end
 
-  describe '#friends' do
-    it 'call collect_with_cursor' do
-      expect(client).to receive(:collect_with_cursor)
-      client.friends
+    context 'with block' do
+      it 'set max_paginates' do
+        expect(ExTwitter.new {|config| config.max_paginates = value }.max_paginates).to eq(value)
+      end
     end
   end
 
-  describe '#followers' do
-    it 'call collect_with_cursor' do
-      expect(client).to receive(:collect_with_cursor)
-      client.followers
-    end
+  describe '#read' do
   end
 
-  describe '#friend_ids' do
-    it 'call collect_with_cursor' do
-      expect(client).to receive(:collect_with_cursor)
-      client.friend_ids
-    end
+  describe '#write' do
   end
 
-  describe '#follower_ids' do
-    it 'call collect_with_cursor' do
-      expect(client).to receive(:collect_with_cursor)
-      client.follower_ids
-    end
+  describe '#collect_with_max_id' do
   end
 
-  describe '#users' do
-    it 'call old_users' do
-      expect(client).to receive(:old_users)
-      client.users([1, 2, 3])
-    end
+  describe '#collect_with_cursor' do
   end
+
+  # describe '#user_timeline' do
+  #   it 'call collect_with_max_id' do
+  #     expect(client).to receive(:collect_with_max_id)
+  #     client.user_timeline
+  #   end
+  # end
+  #
+  # describe '#friends' do
+  #   it 'call collect_with_cursor' do
+  #     expect(client).to receive(:collect_with_cursor)
+  #     client.friends
+  #   end
+  # end
+  #
+  # describe '#followers' do
+  #   it 'call collect_with_cursor' do
+  #     expect(client).to receive(:collect_with_cursor)
+  #     client.followers
+  #   end
+  # end
+  #
+  # describe '#friend_ids' do
+  #   it 'call collect_with_cursor' do
+  #     expect(client).to receive(:collect_with_cursor)
+  #     client.friend_ids
+  #   end
+  # end
+  #
+  # describe '#follower_ids' do
+  #   it 'call collect_with_cursor' do
+  #     expect(client).to receive(:collect_with_cursor)
+  #     client.follower_ids
+  #   end
+  # end
+  #
+  # describe '#users' do
+  #   it 'call old_users' do
+  #     expect(client).to receive(:old_users)
+  #     client.users([1, 2, 3])
+  #   end
+  # end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ex_twitter
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Shinohara Teruki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-16 00:00:00.000000000 Z
+date: 2015-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter
@@ -66,7 +66,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A wrapper to the Twitter gem.
+description: Add auto paginate feature to Twitter gem.
 email:
 - ts_3156@yahoo.co.jp
 executables: []
@@ -104,7 +104,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: A wrapper to the Twitter gem.
+summary: Add auto paginate feature to Twitter gem.
 test_files:
 - spec/ex_twitter_spec.rb
 - spec/helper.rb