twitter_with_auto_pagination 0.8.12 → 0.9.0

data/spec/helper.rb

@@ -1,68 +1,199 @@
+require 'dotenv/load'
 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.before(:suite) do
+    $fetch_count = $request_count = 0
+
+    set_trace_func proc { |event, file, line, id, binding, klass|
+      if klass == TwitterWithAutoPagination::Cache && id == :fetch && event == 'call'
+        $fetch_called = true
+        $fetch_count += 1
+      end
+      if klass == Twitter::REST::Request && id == :perform && event == 'call'
+        $request_called = true
+        $request_count += 1
+      end
+    }
+  end
+
+  config.define_derived_metadata do |meta|
+    meta[:aggregate_failures] = true unless meta.key?(:aggregate_failures)
+  end
+
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
 end
 
-BASE_URL = 'https://api.twitter.com'.freeze
+RSpec::Matchers.define_negated_matcher :not_change, :change
+
+RSpec::Matchers.define :fetch do
+  match do |actual|
+    before = $fetch_called
+    actual.call
+    @count = 1 if @count.nil?
+    @actual_count = $fetch_count
+    result = !before && $fetch_called && @actual_count == @count
+
+    $fetch_called = false
+    $fetch_count = 0
+
+    result
+  end
+
+  chain(:once) { @count = 1 }
+  chain(:twice) { @count = 2 }
+  chain(:exactly) { |count| @count = count }
+  chain(:times) {}
+
+  failure_message do |actual|
+    "expected to call #fetch #{@count} times but called #{@actual_count} times"
+  end
+
+  supports_block_expectations
+end
+
+RSpec::Matchers.define :request do
+  match do |actual|
+    before = $request_called
+    actual.call
+    @count = 1 if @count.nil?
+    @actual_count = $request_count
+    result = !before && $request_called && @actual_count == @count
+
+    $request_called = false
+    $request_count = 0
+
+    result
+  end
+
+  chain(:once) { @count = 1 }
+  chain(:twice) { @count = 2 }
+  chain(:exactly) { |count| @count = count }
+  chain(:times) {}
+
+  failure_message do |actual|
+    "expected to call #request #{@count} times but called #{@actual_count} times"
+  end
+
+  supports_block_expectations
+end
+
+RSpec::Matchers.define :not_fetch do
+  match do |actual|
+    before = $fetch_called
+    actual.call
+    after = $fetch_called
+    $fetch_called = false
+    !before && !after
+  end
 
-def a_delete(path)
-  a_request(:delete, BASE_URL + path)
+  failure_message { |actual| 'expected not to fetch' }
+  supports_block_expectations
 end
 
-def a_get(path)
-  a_request(:get, BASE_URL + path)
+RSpec::Matchers.define :not_request do
+  match do |actual|
+    before = $request_called
+    actual.call
+    after = $request_called
+    $request_called = false
+    !before && !after
+  end
+
+  failure_message { |actual| 'expected not to request' }
+  supports_block_expectations
 end
 
-def a_post(path)
-  a_request(:post, BASE_URL + path)
+RSpec::Matchers.define :match_twitter do |expected|
+  match do |actual|
+    if expected.is_a?(Array)
+      if expected[0].is_a?(Integer)
+        actual == expected
+      else
+        actual.map { |r| r[:id] } == expected.map { |r| r[:id] }
+      end
+    elsif expected.is_a?(Hash)
+      actual[:id] == expected[:id]
+    else
+      actual == expected
+    end
+  end
 end
 
-def a_put(path)
-  a_request(:put, BASE_URL + path)
+RSpec.shared_examples 'continuous calls' do
+  it 'fetches the result from a cache for the second time' do
+    result1 = result2 = nil
+    expect { result1 = client.send(name, *params) }.to fetch & request
+    expect { result2 = client.send(name, *params) }.to fetch & not_request
+    expect(result1).to match_twitter(result2)
+  end
 end
 
-def stub_delete(path)
-  stub_request(:delete, BASE_URL + path)
+RSpec.shared_examples 'cache: false is specified' do
+  it 'sends http requests' do
+    expect { client.send(name, *params) }.to fetch & request
+    expect { client.send(name, *params, cache: false) }.to not_fetch & request
+  end
 end
 
-def stub_get(path)
-  stub_request(:get, BASE_URL + path)
+RSpec.shared_examples 'when a value is changed' do
+  it 'sends http requests' do
+    expect { client.send(name, *params) }.to fetch & request
+    expect { client.send(name, *params2) }.to fetch & request
+  end
 end
 
-def stub_post(path)
-  stub_request(:post, BASE_URL + path)
+RSpec.shared_examples 'when options are changed' do
+  it 'sends http requests' do
+    expect { client.send(name, *params) }.to fetch & request
+    expect { client.send(name, *params, hello: :world) }.to fetch & request
+  end
+end
+
+RSpec.shared_examples 'when a client is changed, it shares a cache' do
+  it 'shares a cache' do
+    expect { client.send(name, *params) }.to fetch & request
+    expect { client2.send(name, *params) }.to fetch & not_request
+  end
+end
+
+RSpec.shared_examples 'when a client is changed, it does not share a cache' do
+  it 'does not share a cache' do
+    expect { client.send(name, *params) }.to fetch & request
+    expect { client2.send(name, *params) }.to fetch & request
+  end
 end
 
-def stub_put(path)
-  stub_request(:put, BASE_URL + path)
+RSpec.shared_examples 'when one param is specified, it raises an exception' do
+  it 'raises an exception' do
+    expect { client.send(name, id) }.to raise_error(ArgumentError)
+  end
 end
 
-def fixture_path
-  File.expand_path('../fixtures', __FILE__)
+RSpec.shared_examples 'when any params is not specified, it raises an exception' do
+  it 'raises an exception' do
+    expect { client.send(name) }.to raise_error(ArgumentError)
+  end
 end
 
-def fixture(file)
-  File.new(fixture_path + '/' + file)
+RSpec.shared_examples 'when any params is not specified, it returns a same result as a result with one param' do
+  it 'returns a same result as a result with one param' do
+    result1 = result2 = nil
+    expect { result1 = client.send(name) }.to fetch & request
+    expect { result2 = client.send(name, id) }.to fetch & request
+    expect(result1).to match_twitter(result2)
+  end
 end
 
-def capture_warning
-  begin
-    old_stderr = $stderr
-    $stderr = StringIO.new
-    yield
-    result = $stderr.string
-  ensure
-    $stderr = old_stderr
+RSpec.shared_examples 'when count is specified' do |count|
+  it 'requests twice' do
+    result1 = result2 = nil
+    expect { result1 = client.send(name, *params, count: count) }.to fetch & request.twice
+    expect { result2 = client.send(name, *params, count: count) }.to fetch & not_request
+    expect(result1.size).to be > (count / 2)
+    expect(result1).to match_twitter(result2)
   end
-  result
 end

data/spec/twitter_with_auto_pagination/cache_spec.rb

@@ -0,0 +1,71 @@
+require 'helper'
+
+describe TwitterWithAutoPagination::Cache do
+  let(:cache) { TwitterWithAutoPagination::Cache.new }
+
+  # describe '#fetch' do
+  #
+  #   before do
+  #     cache.client.clear
+  #   end
+  #
+  #   context 'with a stored value' do
+  #     before do
+  #       cache.client.write('key', 1)
+  #       allow(cache).to receive(:normalize_key).and_return('key')
+  #     end
+  #     it 'calls a block' do
+  #       expect { |b| cache.fetch('anything', 'user', &b)}.to yield_control
+  #     end
+  #   end
+  #
+  #   context 'without any value' do
+  #     before do
+  #       allow(cache).to receive(:normalize_key).and_return('key')
+  #     end
+  #     it 'does not call a block' do
+  #       expect { |b| cache.fetch('anything', 'user', &b)}.to_not yield_control
+  #     end
+  #   end
+  # end
+
+  describe '#normalize_key' do
+    it 'returns a key' do
+      expect(cache.send(:normalize_key, :search, 'a')).to match(/\Asearch:query:a/)
+      expect(cache.send(:normalize_key, :friendship?, %w(a b))).to match(/\Afriendship\?:from:a:to:b/)
+      expect(cache.send(:normalize_key, :anything, 1)).to match(/\Aanything:id:/)
+      expect(cache.send(:normalize_key, :anything, 'a')).to match(/\Aanything:screen_name:a:options:empty\z/)
+      expect(cache.send(:normalize_key, :anything, 'a', {count: 10})).to match(/\Aanything:screen_name:a:options:count:10\z/)
+      expect {cache.send(:normalize_key, :anything, nil)}.to raise_error(RuntimeError)
+    end
+
+  end
+
+  describe '#user_identifier' do
+    it 'returns a serialized string' do
+      expect(cache.send(:user_identifier, 1)).to eq('id:1')
+      expect(cache.send(:user_identifier, 'abc')).to eq('screen_name:abc')
+      expect(cache.send(:user_identifier, [1, 2])).to match(/\Aids:2-\w+\z/)
+      expect(cache.send(:user_identifier, %w(abc cde fgh))).to match(/\Ascreen_names:3-\w+\z/)
+      expect { cache.send(:user_identifier, nil) }.to raise_error(RuntimeError)
+    end
+  end
+
+  describe '#options_identifier' do
+    it 'returns serialized string' do
+      expect(cache.send(:options_identifier, a: 1, b: 2)).to match(/\Aoptions:a:1,b:2\z/)
+    end
+
+    context 'empty options' do
+      it 'returns serialized string ends with "empty"' do
+        expect(cache.send(:options_identifier, {})).to eq("options:empty")
+      end
+    end
+  end
+
+  describe '#hexdigest' do
+    it 'returns hexdigest' do
+      expect(cache.send(:hexdigest, 'hello')).to eq(Digest::MD5.hexdigest('hello'))
+    end
+  end
+end

data/spec/twitter_with_auto_pagination/client_spec.rb

@@ -1,150 +1,12 @@
 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
+  let(:client) do
+    described_class.new(
+      consumer_key: ENV['CK'],
+      consumer_secret: ENV['CS'],
+      access_token: ENV['AT'],
+      access_token_secret: ENV['ATS']
+    )
   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/spec/twitter_with_auto_pagination/parallel_spec.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+describe TwitterWithAutoPagination::Parallel do
+  let(:client) do
+    TwitterWithAutoPagination::Client.new(
+      consumer_key: ENV['CK'],
+      consumer_secret: ENV['CS'],
+      access_token: ENV['AT'],
+      access_token_secret: ENV['ATS']
+    )
+  end
+
+  let(:id) { 58135830 }
+
+  describe '#parallel' do
+    it 'calls #users' do
+      expect(client).to receive(:users).with([id], any_args)
+      client.parallel do |batch|
+        batch.users([id])
+      end
+    end
+  end
+end

data/spec/twitter_with_auto_pagination/rest/favorites_spec.rb

@@ -0,0 +1,58 @@
+require 'helper'
+
+describe TwitterWithAutoPagination::REST::Favorites do
+  let(:client) do
+    TwitterWithAutoPagination::Client.new(
+      consumer_key: ENV['CK'],
+      consumer_secret: ENV['CS'],
+      access_token: ENV['AT'],
+      access_token_secret: ENV['ATS']
+    )
+  end
+
+  let(:client2) do
+    TwitterWithAutoPagination::Client.new(
+      consumer_key: ENV['CK2'],
+      consumer_secret: ENV['CS2'],
+      access_token: ENV['AT2'],
+      access_token_secret: ENV['ATS2']
+    )
+  end
+
+  let(:id) { 58135830 }
+  let(:id2) { 22356250 }
+
+  before do
+    client.cache.clear
+    $fetch_called = $request_called = false
+    $fetch_count = $request_count = 0
+  end
+
+  describe '#favorites' do
+    let(:name) { :favorites }
+
+    context 'with one param' do
+      let(:params) { [id] }
+      let(:params2) { [id2] }
+
+      it_behaves_like 'continuous calls'
+      it_behaves_like 'cache: false is specified'
+      it_behaves_like 'when a value is changed'
+      it_behaves_like 'when options are changed'
+      it_behaves_like 'when a client is changed, it shares a cache'
+      it_behaves_like 'when count is specified', 200
+    end
+
+    context 'with no params' do
+      let(:params) { [] }
+
+      it_behaves_like 'continuous calls'
+      it_behaves_like 'cache: false is specified'
+      it_behaves_like 'when options are changed'
+      it_behaves_like 'when a client is changed, it does not share a cache'
+      it_behaves_like 'when count is specified', 200
+    end
+
+    it_behaves_like 'when any params is not specified, it returns a same result as a result with one param'
+  end
+end