twitter_with_auto_pagination 0.6.2 → 0.7.0

data/spec/helper.rb

@@ -1,9 +1,68 @@
 require 'twitter_with_auto_pagination'
 require 'rspec'
+require 'stringio'
+require 'tempfile'
+require 'timecop'
+require 'webmock/rspec'
+
+require_relative 'support/media_object_examples'
 
 RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
-  config.order = 'random'
+end
+
+BASE_URL = 'https://api.twitter.com'.freeze
+
+def a_delete(path)
+  a_request(:delete, BASE_URL + path)
+end
+
+def a_get(path)
+  a_request(:get, BASE_URL + path)
+end
+
+def a_post(path)
+  a_request(:post, BASE_URL + path)
+end
+
+def a_put(path)
+  a_request(:put, BASE_URL + path)
+end
+
+def stub_delete(path)
+  stub_request(:delete, BASE_URL + path)
+end
+
+def stub_get(path)
+  stub_request(:get, BASE_URL + path)
+end
+
+def stub_post(path)
+  stub_request(:post, BASE_URL + path)
+end
+
+def stub_put(path)
+  stub_request(:put, BASE_URL + path)
+end
+
+def fixture_path
+  File.expand_path('../fixtures', __FILE__)
+end
+
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end
+
+def capture_warning
+  begin
+    old_stderr = $stderr
+    $stderr = StringIO.new
+    yield
+    result = $stderr.string
+  ensure
+    $stderr = old_stderr
+  end
+  result
 end

data/spec/twitter_with_auto_pagination/client_spec.rb

@@ -0,0 +1,150 @@
+require 'helper'
+
+describe TwitterWithAutoPagination::Client do
+  let(:config) {
+    {
+      consumer_key: 'CK',
+      consumer_secret: 'CS',
+      access_token: 'AT',
+      access_token_secret: 'ATS',
+    }
+  }
+  let(:client) { TwitterWithAutoPagination::Client.new(config) }
+
+  describe '#user?' do
+    before do
+      stub_get('/1.1/users/show.json').with(query: {screen_name: 'sferik'}).to_return(body: fixture('sferik.json'), headers: {content_type: 'application/json; charset=utf-8'})
+      stub_get('/1.1/users/show.json').with(query: {screen_name: 'pengwynn'}).to_return(body: fixture('not_found.json'), status: 404, headers: {content_type: 'application/json; charset=utf-8'})
+    end
+    it 'requests the correct resource' do
+      client.user?('sferik')
+      expect(a_get('/1.1/users/show.json').with(query: {screen_name: 'sferik'})).to have_been_made
+    end
+    it 'returns true if user exists' do
+      user = client.user?('sferik')
+      expect(user).to be true
+    end
+    it 'returns false if user does not exist' do
+      user = client.user?('pengwynn')
+      expect(user).to be false
+    end
+  end
+
+  # describe '#initialize' do
+  #   let(:default_call_count) { 0 }
+  #
+  #   it 'sets call_count to 0' do
+  #     expect(client.call_count).to eq(default_call_count)
+  #   end
+  #
+  #   context 'without params' do
+  #   end
+  #
+  #   context 'with params' do
+  #   end
+  # end
+  #
+  # describe '#logger' do
+  #   it 'has logger' do
+  #     expect(client.logger).to be_truthy
+  #   end
+  # end
+  #
+  # describe '#call_old_method' do
+  # end
+  #
+  # describe '#collect_with_max_id' do
+  # end
+  #
+  # describe '#collect_with_cursor' do
+  # end
+  #
+  # describe '#file_cache_key' do
+  # end
+  #
+  # describe '#namespaced_key' do
+  # end
+  #
+  # describe '#encode_json' do
+  # end
+  #
+  # describe '#decode_json' do
+  # end
+  #
+  # describe '#fetch_cache_or_call_api' do
+  # end
+  #
+  # describe '#user_timeline' do
+  #   it 'calls old_user_timeline' do
+  #     expect(client).to receive(:old_user_timeline)
+  #     client.user_timeline
+  #   end
+  #
+  #   it 'calls collect_with_max_id' do
+  #     expect(client).to receive(:collect_with_max_id)
+  #     client.user_timeline
+  #   end
+  # end
+  #
+  # describe '#user_photos' do
+  #   it 'calls user_timeline' do
+  #     expect(client).to receive(:user_timeline)
+  #     client.user_photos
+  #   end
+  # end
+  #
+  # describe '#friends' do
+  #   it 'calls old_friends' do
+  #     expect(client).to receive(:old_friends)
+  #     client.friends
+  #   end
+  #
+  #   it 'calls collect_with_cursor' do
+  #     expect(client).to receive(:collect_with_cursor)
+  #     client.friends
+  #   end
+  # end
+  #
+  # describe '#followers' do
+  #   it 'calls old_followers' do
+  #     expect(client).to receive(:old_followers)
+  #     client.followers
+  #   end
+  #
+  #   it 'calls collect_with_cursor' do
+  #     expect(client).to receive(:collect_with_cursor)
+  #     client.followers
+  #   end
+  # end
+  #
+  # describe '#friend_ids' do
+  #   it 'calls old_friend_ids' do
+  #     expect(client).to receive(:old_friend_ids)
+  #     client.friend_ids
+  #   end
+  #
+  #   it 'calls collect_with_cursor' do
+  #     expect(client).to receive(:collect_with_cursor)
+  #     client.friend_ids
+  #   end
+  # end
+  #
+  # describe '#follower_ids' do
+  #   it 'calls old_follower_ids' do
+  #     expect(client).to receive(:old_follower_ids)
+  #     client.follower_ids
+  #   end
+  #
+  #   it 'calls collect_with_cursor' do
+  #     expect(client).to receive(:collect_with_cursor)
+  #     client.follower_ids
+  #   end
+  # end
+  #
+  # describe '#users' do
+  #   it 'calls old_users' do
+  #     expect(client).to receive(:old_users)
+  #     client.users([1, 2, 3])
+  #   end
+  # end
+end

data/twitter_with_auto_pagination.gemspec

@@ -22,5 +22,5 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3'
   spec.summary = spec.description
   spec.test_files = Dir.glob('spec/**/*')
-  spec.version = '0.6.2'
+  spec.version = '0.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitter_with_auto_pagination
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Shinohara Teruki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-04 00:00:00.000000000 Z
+date: 2016-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: twitter
@@ -91,13 +91,22 @@ files:
 - README.md
 - Rakefile
 - lib/twitter_with_auto_pagination.rb
-- lib/twitter_with_auto_pagination/client.rb
-- lib/twitter_with_auto_pagination/existing_api.rb
 - lib/twitter_with_auto_pagination/log_subscriber.rb
-- lib/twitter_with_auto_pagination/new_api.rb
-- lib/twitter_with_auto_pagination/utils.rb
+- lib/twitter_with_auto_pagination/rest/api.rb
+- lib/twitter_with_auto_pagination/rest/extension/clusters.rb
+- lib/twitter_with_auto_pagination/rest/extension/favoriting.rb
+- lib/twitter_with_auto_pagination/rest/extension/friends_and_followers.rb
+- lib/twitter_with_auto_pagination/rest/extension/replying.rb
+- lib/twitter_with_auto_pagination/rest/extension/unfollowing.rb
+- lib/twitter_with_auto_pagination/rest/favorites.rb
+- lib/twitter_with_auto_pagination/rest/friends_and_followers.rb
+- lib/twitter_with_auto_pagination/rest/search.rb
+- lib/twitter_with_auto_pagination/rest/timelines.rb
+- lib/twitter_with_auto_pagination/rest/uncategorized.rb
+- lib/twitter_with_auto_pagination/rest/users.rb
+- lib/twitter_with_auto_pagination/rest/utils.rb
 - spec/helper.rb
-- spec/twitter_with_auto_pagination_spec.rb
+- spec/twitter_with_auto_pagination/client_spec.rb
 - twitter_with_auto_pagination.gemspec
 homepage: http://github.com/ts-3156/twitter_with_auto_pagination/
 licenses:
@@ -125,4 +134,4 @@ specification_version: 4
 summary: Add auto paginate feature to Twitter gem.
 test_files:
 - spec/helper.rb
-- spec/twitter_with_auto_pagination_spec.rb
+- spec/twitter_with_auto_pagination/client_spec.rb

data/lib/twitter_with_auto_pagination/client.rb

@@ -1,139 +0,0 @@
-require 'active_support'
-require 'active_support/cache'
-require 'active_support/core_ext/string'
-
-require 'twitter_with_auto_pagination/log_subscriber'
-require 'twitter_with_auto_pagination/utils'
-require 'twitter_with_auto_pagination/existing_api'
-require 'twitter_with_auto_pagination/new_api'
-
-require 'twitter'
-require 'hashie'
-require 'parallel'
-
-module TwitterWithAutoPagination
-  class Client < Twitter::REST::Client
-    def initialize(options = {})
-      @cache = ActiveSupport::Cache::FileStore.new(File.join('tmp', 'api_cache'))
-      @call_count = 0
-
-      @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 =
-        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
-
-    def self.logger
-      @@logger
-    end
-
-    attr_accessor :call_count
-    attr_reader :cache, :authenticated_user, :logger
-
-    INDENT = 4
-
-    include TwitterWithAutoPagination::Utils
-
-    alias :old_verify_credentials :verify_credentials
-    alias :old_friendship? :friendship?
-    alias :old_user? :user?
-    alias :old_user :user
-    alias :old_friend_ids :friend_ids
-    alias :old_follower_ids :follower_ids
-    alias :old_friends :friends
-    alias :old_followers :followers
-    alias :old_users :users
-    alias :old_home_timeline :home_timeline
-    alias :old_user_timeline :user_timeline
-    alias :old_mentions_timeline :mentions_timeline
-    alias :old_favorites :favorites
-    alias :old_search :search
-
-    include TwitterWithAutoPagination::ExistingApi
-    include TwitterWithAutoPagination::NewApi
-
-    def usage_stats_wday_series_data(times)
-      wday_count = times.each_with_object((0..6).map { |n| [n, 0] }.to_h) do |time, memo|
-        memo[time.wday] += 1
-      end
-      wday_count.map { |k, v| [I18n.t('date.abbr_day_names')[k], v] }.map do |key, value|
-        {name: key, y: value, drilldown: key}
-      end
-    end
-
-    def usage_stats_wday_drilldown_series(times)
-      hour_count =
-        (0..6).each_with_object((0..6).map { |n| [n, nil] }.to_h) do |wday, wday_memo|
-          wday_memo[wday] =
-            times.select { |t| t.wday == wday }.map { |t| t.hour }.each_with_object((0..23).map { |n| [n, 0] }.to_h) do |hour, hour_memo|
-              hour_memo[hour] += 1
-            end
-        end
-      hour_count.map { |k, v| [I18n.t('date.abbr_day_names')[k], v] }.map do |key, value|
-        {name: key, id: key, data: value.to_a.map{|a| [a[0].to_s, a[1]] }}
-      end
-    end
-
-    def usage_stats_hour_series_data(times)
-      hour_count = times.each_with_object((0..23).map { |n| [n, 0] }.to_h) do |time, memo|
-        memo[time.hour] += 1
-      end
-      hour_count.map do |key, value|
-        {name: key.to_s, y: value, drilldown: key.to_s}
-      end
-    end
-
-    def usage_stats_hour_drilldown_series(times)
-      wday_count =
-        (0..23).each_with_object((0..23).map { |n| [n, nil] }.to_h) do |hour, hour_memo|
-          hour_memo[hour] =
-            times.select { |t| t.hour == hour }.map { |t| t.wday }.each_with_object((0..6).map { |n| [n, 0] }.to_h) do |wday, wday_memo|
-              wday_memo[wday] += 1
-            end
-        end
-      wday_count.map do |key, value|
-        {name: key.to_s, id: key.to_s, data: value.to_a.map{|a| [I18n.t('date.abbr_day_names')[a[0]], a[1]] }}
-      end
-    end
-
-    def twitter_addiction_series(times)
-      five_mins = 5.minutes
-      wday_expended_seconds =
-        (0..6).each_with_object((0..6).map { |n| [n, nil] }.to_h) do |wday, wday_memo|
-          target_times = times.select { |t| t.wday == wday }
-          wday_memo[wday] = target_times.empty? ? nil : target_times.each_cons(2).map {|a, b| (a - b) < five_mins ? a - b : five_mins }.sum
-        end
-      days = times.map{|t| t.to_date.to_s(:long) }.uniq.size
-      weeks = (days > 7) ? days / 7.0 : 1.0
-      wday_expended_seconds.map { |k, v| [I18n.t('date.abbr_day_names')[k], (v.nil? ? nil : v / weeks / 60)] }.map do |key, value|
-        {name: key, y: value}
-      end
-    end
-
-    def usage_stats(user, options = {})
-      n_days_ago = options.has_key?(:days) ? options[:days].days.ago : 100.years.ago
-      tweets = options.has_key?(:tweets) ? options.delete(:tweets) : user_timeline(user)
-      times =
-        # TODO Use user specific time zone
-        tweets.map { |t| ActiveSupport::TimeZone['Tokyo'].parse(t.created_at.to_s) }.
-          select { |t| t > n_days_ago }
-      [
-        usage_stats_wday_series_data(times),
-        usage_stats_wday_drilldown_series(times),
-        usage_stats_hour_series_data(times),
-        usage_stats_hour_drilldown_series(times),
-        twitter_addiction_series(times)
-      ]
-    end
-  end
-end

data/lib/twitter_with_auto_pagination/existing_api.rb

@@ -1,127 +0,0 @@
-module TwitterWithAutoPagination
-  module ExistingApi
-    def verify_credentials(*args)
-      options = {skip_status: true}.merge(args.extract_options!)
-      fetch_cache_or_call_api(__method__, args) {
-        call_old_method("old_#{__method__}", *args, options)
-      }
-    end
-
-    def friendship?(*args)
-      options = args.extract_options!
-      fetch_cache_or_call_api(__method__, args) {
-        call_old_method("old_#{__method__}", *args, options)
-      }
-    end
-
-    def user?(*args)
-      options = args.extract_options!
-      args[0] = verify_credentials(skip_status: true).id if args.empty?
-      fetch_cache_or_call_api(__method__, args[0], options) {
-        call_old_method("old_#{__method__}", args[0], options)
-      }
-    end
-
-    def user(*args)
-      options = args.extract_options!
-      args[0] = verify_credentials(skip_status: true).id if args.empty?
-      fetch_cache_or_call_api(__method__, args[0], options) {
-        call_old_method("old_#{__method__}", args[0], options)
-      }
-    end
-
-    def friend_ids(*args)
-      options = {count: 5000, cursor: -1}.merge(args.extract_options!)
-      args[0] = verify_credentials(skip_status: true).id if args.empty?
-      fetch_cache_or_call_api(__method__, args[0], options) {
-        collect_with_cursor("old_#{__method__}", *args, options)
-      }
-    end
-
-    def follower_ids(*args)
-      options = {count: 5000, cursor: -1}.merge(args.extract_options!)
-      args[0] = verify_credentials(skip_status: true).id if args.empty?
-      fetch_cache_or_call_api(__method__, args[0], options) {
-        collect_with_cursor("old_#{__method__}", *args, options)
-      }
-    end
-
-    # specify reduce: false to use tweet for inactive_*
-    def friends(*args)
-      options = {count: 200, include_user_entities: true, cursor: -1}.merge(args.extract_options!)
-      options[:reduce] = false unless options.has_key?(:reduce)
-      args[0] = verify_credentials(skip_status: true).id if args.empty?
-      fetch_cache_or_call_api(__method__, args[0], options) {
-        collect_with_cursor("old_#{__method__}", *args, options)
-      }
-    end
-
-    # specify reduce: false to use tweet for inactive_*
-    def followers(*args)
-      options = {count: 200, include_user_entities: true, cursor: -1}.merge(args.extract_options!)
-      options[:reduce] = false unless options.has_key?(:reduce)
-      args[0] = verify_credentials(skip_status: true).id if args.empty?
-      fetch_cache_or_call_api(__method__, args[0], options) {
-        collect_with_cursor("old_#{__method__}", *args, options)
-      }
-    end
-
-    # use compact, not use sort and uniq
-    # specify reduce: false to use tweet for inactive_*
-    # TODO Perhaps `old_users` automatically merges result...
-    def users(*args)
-      options = args.extract_options!
-      options[:reduce] = false
-      users_per_workers = args.first.compact.each_slice(100).to_a
-      processed_users = []
-
-      Parallel.each_with_index(users_per_workers, in_threads: [users_per_workers.size, 10].min) do |users_per_worker, i|
-        _users = fetch_cache_or_call_api(__method__, users_per_worker, options) {
-          call_old_method("old_#{__method__}", users_per_worker, options)
-        }
-
-        processed_users << {i: i, users: _users}
-      end
-
-      processed_users.sort_by{|p| p[:i] }.map{|p| p[:users] }.flatten.compact
-    end
-
-    def home_timeline(*args)
-      options = {count: 200, include_rts: true, call_limit: 3}.merge(args.extract_options!)
-      fetch_cache_or_call_api(__method__, user.id, options) {
-        collect_with_max_id("old_#{__method__}", options)
-      }
-    end
-
-    def user_timeline(*args)
-      options = {count: 200, include_rts: true, call_limit: 3}.merge(args.extract_options!)
-      args[0] = verify_credentials(skip_status: true).id if args.empty?
-      fetch_cache_or_call_api(__method__, args[0], options) {
-        collect_with_max_id("old_#{__method__}", *args, options)
-      }
-    end
-
-    def mentions_timeline(*args)
-      options = {count: 200, include_rts: true, call_limit: 1}.merge(args.extract_options!)
-      fetch_cache_or_call_api(__method__, user.id, options) {
-        collect_with_max_id("old_#{__method__}", options)
-      }
-    end
-
-    def favorites(*args)
-      options = {count: 100, call_count: 1}.merge(args.extract_options!)
-      args[0] = verify_credentials(skip_status: true).id if args.empty?
-      fetch_cache_or_call_api(__method__, args[0], options) {
-        collect_with_max_id("old_#{__method__}", *args, options)
-      }
-    end
-
-    def search(*args)
-      options = {count: 100, result_type: :recent, call_limit: 1}.merge(args.extract_options!)
-      options[:reduce] = false
-      fetch_cache_or_call_api(__method__, args[0], options) {
-        collect_with_max_id("old_#{__method__}", *args, options) { |response| response.attrs[:statuses] }
-      }
-    end
-  end
-end