twitter_with_auto_pagination 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a766fdb1cdee5bb05a9a5a075d2249637284338
-  data.tar.gz: a493b330a56148deb5abf3408b3252c492d56be9
+  metadata.gz: c3b148014f092aee0b2daa1893c109dbb8ae1b00
+  data.tar.gz: 5e1f994fa4185d4d6db93e81aef1c014aa1ae21a
 SHA512:
-  metadata.gz: 8238fe4d1f500572e1993891ecd861f1cb6f90526732bf37defe460fd5e130b1605fded19fd951dc68901c62eead6d69325b71790b9cb552393203ceb402e355
-  data.tar.gz: 9fd76e42c73f82b200ce110eb9efeba3097150e29fd6bbb273d84da4a0d267698bb7d2bba2e6e6b65f5a78880b65b523febde6841a9d51a29a45bbd8dee76573
+  metadata.gz: c5852ccf3eed3bf1848abff90fecc408d157fce3d896b7e938b2a98f5289e4407fa79cc0372d15cad9989cc088864786d4d6dd8b2c3cc1d523eff0928a338d79
+  data.tar.gz: bb4230a5ae87e4cc12450febefa4c76d207f99def578cd49a164536f55e76512b73f4f6ec34a900270025d5201d453cada3b35b1f923956f2fe43a8b73abedc9

data/README.md

@@ -1,52 +1,151 @@
-ex-twitter
-==========
+twitter-with-auto-pagination
+============================
 
-[![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)
+[![Gem Version](https://badge.fury.io/rb/ex_twitter.png)](https://badge.fury.io/rb/twitter_with_auto_pagination)
+[![Build Status](https://travis-ci.org/ts-3156/ex-twitter.svg?branch=master)](https://travis-ci.org/ts-3156/twitter-with-auto-pagination)
 
-Add auto paginate feature to Twitter gem.
+Add auto pagination, auto caching and parallelly fetching features to Twitter gem.
 
 ## Installation
 
 ### Gem
 
 ```
-gem install ex_twitter
+gem install twitter_with_auto_pagination
 ```
 
 ### Rails
 
-Add ex_twitter to your Gemfile, and bundle.
+Add `twitter_with_auto_pagination` to your Gemfile, and bundle.
 
 ## Features
 
-* Auto paginate feature
+* Auto pagination
+* Auto caching
+* Parallelly fetching
 
 ## Configuration
 
-You can pass configuration options as a block to `ExTwitter.new` just like `Twitter::REST::Client.new`.
+You can pass configuration options as a block to `TwitterWithAutoPagination::Client.new` just like `Twitter::REST::Client.new`.
 
 ```
-client = ExTwitter.new do |config|
+client = TwitterWithAutoPagination::Client.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"
+  config.log_level           = :debug             # optional
+  config.logger              = Logger.new(STDOUT) # optional
 end
 ```
 
-You can pass advanced configuration options as a block to `ExTwitter.new`.
+## Usage Examples
+
+After configuring a `client`, you can do the following things.
+
+### Pre-existing and enhanced APIs
+
+Fetch the timeline of Tweets (by screen name or user ID, or by implicit authenticated user)
 
 ```
-client = ExTwitter.new do |config|
-  config.auto_paginate = true
-  config.max_retries   = 1
-  config.max_paginates = 3
-end
+client.user_timeline('gem')
+client.user_timeline(213747670)
+client.user_timeline
+
+result.size
+# => 588
+
+result.first.text
+# => "Your tweet text..."
+
+result.first.user.screen_name
+# => "your_screen_name"
 ```
 
-## Usage Examples
+Fetch the timeline of Tweets from the authenticated user's home page
 
 ```
-client.user_timeline
+client.home_timeline
+```
+
+Fetch the timeline of Tweets mentioning the authenticated user
+
+```
+client.mentions_timeline
+```
+
+Fetch all friends's user IDs (by screen name or user ID, or by implicit authenticated user)
+
+```
+client.friend_ids('gem')
+client.friend_ids(213747670)
+client.friend_ids
+```
+
+Fetch all followers's user IDs (by screen name or user ID, or by implicit authenticated user)
+
+```
+client.follower_ids('gem')
+client.follower_ids(213747670)
+client.follower_ids
+```
+
+Fetch all friends with profile details (by screen name or user ID, or by implicit authenticated user)
+
+```
+client.friends('gem')
+client.friends(213747670)
+client.friends
+```
+
+Fetch all followers with profile details (by screen name or user ID, or by implicit authenticated user)
+
+```
+client.followers('gem')
+client.followers(213747670)
+client.followers
+```
+
+Other APIs(e.g. `favorites`, `search`) also have auto pagination feature. 
+
+### New APIs
+
+```
+client.mutual_friends
+```
+
+```
+client.one_sided_friends
+```
+
+```
+client.one_sided_followers
+```
+
+```
+client.common_friends(me, you)
+```
+
+```
+client.common_followers(me, you)
+```
+
+```
+client.close_friends
+```
+
+```
+client.removed(pre_me, cur_me)
+```
+
+```
+client.removed_by(pre_me, cur_me)
+```
+
+```
+client.replied
+```
+
+```
+client.replied_by
 ```

data/lib/twitter_with_auto_pagination/client.rb

@@ -20,13 +20,15 @@ module TwitterWithAutoPagination
       @uid = options.has_key?(:uid) ? options.delete(:uid).to_i : nil
       @screen_name = options.has_key?(:screen_name) ? options.delete(:screen_name).to_s : nil
 
-      @@logger = @logger =
-        if options[:logger]
+      logger =
+        if options.has_key?(:logger)
           options.delete(:logger)
         else
           Dir.mkdir('log') unless File.exists?('log')
           Logger.new('log/twitter_with_auto_pagination.log')
         end
+      logger.level = options.has_key?(:log_level) ? options.delete(:log_level) : :debug
+      @@logger = @logger = logger
 
       super
     end

data/lib/twitter_with_auto_pagination/new_api.rb

@@ -37,8 +37,10 @@ module TwitterWithAutoPagination
           {method: :user_timeline, args: args}])
     end
 
-    def one_sided_following(me)
-      if uid_or_screen_name?(me)
+    def one_sided_friends(me = nil)
+      if me.nil?
+        friends_parallelly.to_a - followers_parallelly.to_a
+      elsif uid_or_screen_name?(me)
         # TODO use friends_and_followers
         friends_parallelly(me).to_a - followers_parallelly(me).to_a
       elsif me.respond_to?(:friends) && me.respond_to?(:followers)
@@ -48,8 +50,10 @@ module TwitterWithAutoPagination
       end
     end
 
-    def one_sided_followers(me)
-      if uid_or_screen_name?(me)
+    def one_sided_followers(me = nil)
+      if me.nil?
+        followers_parallelly.to_a - friends_parallelly.to_a
+      elsif uid_or_screen_name?(me)
         # TODO use friends_and_followers
         followers_parallelly(me).to_a - friends_parallelly(me).to_a
       elsif me.respond_to?(:friends) && me.respond_to?(:followers)
@@ -59,8 +63,10 @@ module TwitterWithAutoPagination
       end
     end
 
-    def mutual_friends(me)
-      if uid_or_screen_name?(me)
+    def mutual_friends(me = nil)
+      if me.nil?
+        friends_parallelly.to_a & followers_parallelly.to_a
+      elsif uid_or_screen_name?(me)
         # TODO use friends_and_followers
         friends_parallelly(me).to_a & followers_parallelly(me).to_a
       elsif me.respond_to?(:friends) && me.respond_to?(:followers)
@@ -90,7 +96,7 @@ module TwitterWithAutoPagination
       end
     end
 
-    def removing(pre_me, cur_me)
+    def removed(pre_me, cur_me)
       if uid_or_screen_name?(pre_me) && uid_or_screen_name?(cur_me)
         friends_parallelly(pre_me).to_a - friends_parallelly(cur_me).to_a
       elsif pre_me.respond_to?(:friends) && cur_me.respond_to?(:friends)
@@ -100,7 +106,7 @@ module TwitterWithAutoPagination
       end
     end
 
-    def removed(pre_me, cur_me)
+    def removed_by(pre_me, cur_me)
       if uid_or_screen_name?(pre_me) && uid_or_screen_name?(cur_me)
         followers_parallelly(pre_me).to_a - followers_parallelly(cur_me).to_a
       elsif pre_me.respond_to?(:followers) && cur_me.respond_to?(:followers)
@@ -118,7 +124,7 @@ module TwitterWithAutoPagination
 
     # users which specified user is replying
     # in_reply_to_user_id and in_reply_to_status_id is not used because of distinguishing mentions from replies
-    def replying(*args)
+    def replied(*args)
       options = args.extract_options!
       tweets =
         if args.empty?
@@ -157,7 +163,7 @@ module TwitterWithAutoPagination
 
     # users which specified user is replied
     # when user is login you had better to call mentions_timeline
-    def replied(*args)
+    def replied_by(*args)
       options = args.extract_options!
 
       result =
@@ -192,7 +198,7 @@ module TwitterWithAutoPagination
       end.flatten
     end
 
-    def favoriting(*args)
+    def users_you_faved(*args)
       options = args.extract_options!
 
       favs =
@@ -229,7 +235,7 @@ module TwitterWithAutoPagination
       end
     end
 
-    def favorited_by(*args)
+    def users_fav_you(*args)
     end
 
     def close_friends(*args)

data/lib/twitter_with_auto_pagination/utils.rb

@@ -7,14 +7,14 @@ module TwitterWithAutoPagination
 
     def __uid
       ActiveSupport::Deprecation.warn(<<-MESSAGE.strip_heredoc)
-        `TwitterWithAutoPagination::Utils#__uid` is deprecated.
+        `TwitterWithAutoPagination::Utils##{__method__}` is deprecated.
       MESSAGE
       uid
     end
 
     def __uid_i
       ActiveSupport::Deprecation.warn(<<-MESSAGE.strip_heredoc)
-        `TwitterWithAutoPagination::Utils#__uid_i` is deprecated.
+        `TwitterWithAutoPagination::Utils##{__method__}` is deprecated.
       MESSAGE
       uid
     end
@@ -26,7 +26,7 @@ module TwitterWithAutoPagination
 
     def __screen_name
       ActiveSupport::Deprecation.warn(<<-MESSAGE.strip_heredoc)
-        `TwitterWithAutoPagination::Utils#__screen_name` is deprecated.
+        `TwitterWithAutoPagination::Utils##{__method__}` is deprecated.
       MESSAGE
       screen_name
     end

data/twitter_with_auto_pagination.gemspec

@@ -21,5 +21,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w[lib]
   spec.summary = spec.description
   spec.test_files = Dir.glob('spec/**/*')
-  spec.version = '0.4.0'
+  spec.version = '0.5.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitter_with_auto_pagination
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Shinohara Teruki