twitter 5.6.0 → 5.7.0

data/lib/twitter/rest/utils.rb

@@ -0,0 +1,205 @@
+require 'addressable/uri'
+require 'twitter/arguments'
+require 'twitter/request'
+require 'twitter/user'
+require 'twitter/utils'
+
+module Twitter
+  module REST
+    module Utils
+      include Twitter::Utils
+      URI_SUBSTRING = '://'
+      DEFAULT_CURSOR = -1
+
+    private
+
+      # Take a URI string or Twitter::Identity object and return its ID
+      #
+      # @param object [Integer, String, URI, Twitter::Identity] An ID, URI, or object.
+      # @return [Integer]
+      def extract_id(object)
+        case object
+        when ::Integer
+          object
+        when ::String
+          object.split('/').last.to_i
+        when URI
+          object.path.split('/').last.to_i
+        when Twitter::Identity
+          object.id
+        end
+      end
+
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_with_object(request_method, path, options, klass)
+        request = Twitter::Request.new(self, request_method, path, options)
+        request.perform_with_object(klass)
+      end
+
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_with_objects(request_method, path, options, klass)
+        request = Twitter::Request.new(self, request_method, path, options)
+        request.perform_with_objects(klass)
+      end
+
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param options [Hash]
+      # @param klass [Class]
+      def perform_with_cursor(request_method, path, options, collection_name, klass = nil) # rubocop:disable ParameterLists
+        merge_default_cursor!(options)
+        request = Twitter::Request.new(self, request_method, path, options)
+        request.perform_with_cursor(collection_name.to_sym, klass)
+      end
+
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param args [Array]
+      # @return [Array<Twitter::User>]
+      def parallel_user_objects_from_response(request_method, path, args)
+        arguments = Twitter::Arguments.new(args)
+        parallel_map(arguments) do |user|
+          perform_with_object(request_method, path, merge_user(arguments.options, user), Twitter::User)
+        end
+      end
+
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param args [Array]
+      # @return [Array<Twitter::User>]
+      def user_objects_from_response(request_method, path, args)
+        arguments = Twitter::Arguments.new(args)
+        merge_user!(arguments.options, arguments.pop || screen_name) unless arguments.options[:user_id] || arguments.options[:screen_name]
+        perform_with_objects(request_method, path, arguments.options, Twitter::User)
+      end
+
+      # @param klass [Class]
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param args [Array]
+      # @return [Array]
+      def objects_from_response_with_user(klass, request_method, path, args)
+        arguments = Twitter::Arguments.new(args)
+        merge_user!(arguments.options, arguments.pop)
+        perform_with_objects(request_method, path, arguments.options, klass)
+      end
+
+      # @param klass [Class]
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param args [Array]
+      # @return [Array]
+      def parallel_objects_from_response(klass, request_method, path, args)
+        arguments = Twitter::Arguments.new(args)
+        parallel_map(arguments) do |object|
+          perform_with_object(request_method, path, arguments.options.merge(:id => extract_id(object)), klass)
+        end
+      end
+
+      # @param collection_name [Symbol]
+      # @param klass [Class]
+      # @param request_method [Symbol]
+      # @param path [String]
+      # @param args [Array]
+      # @return [Twitter::Cursor]
+      def cursor_from_response_with_user(collection_name, klass, request_method, path, args) # rubocop:disable ParameterLists
+        arguments = Twitter::Arguments.new(args)
+        merge_user!(arguments.options, arguments.pop || screen_name) unless arguments.options[:user_id] || arguments.options[:screen_name]
+        perform_with_cursor(request_method, path, arguments.options, collection_name, klass)
+      end
+
+      def screen_name
+        @screen_name ||= verify_credentials.screen_name
+      end
+
+      def merge_default_cursor!(options)
+        options[:cursor] = DEFAULT_CURSOR unless options[:cursor]
+      end
+
+      # Take a user and merge it into the hash with the correct key
+      #
+      # @param hash [Hash]
+      # @param user [Integer, String, Twitter::User] A Twitter user ID, screen name, URI, or object.
+      # @return [Hash]
+      def merge_user(hash, user, prefix = nil)
+        merge_user!(hash.dup, user, prefix)
+      end
+
+      # Take a user and merge it into the hash with the correct key
+      #
+      # @param hash [Hash]
+      # @param user [Integer, String, URI, Twitter::User] A Twitter user ID, screen name, URI, or object.
+      # @return [Hash]
+      def merge_user!(hash, user, prefix = nil)
+        case user
+        when Integer
+          set_compound_key('user_id', user, hash, prefix)
+        when String
+          if user[URI_SUBSTRING]
+            set_compound_key('screen_name', user.split('/').last, hash, prefix)
+          else
+            set_compound_key('screen_name', user, hash, prefix)
+          end
+        when URI, Addressable::URI
+          set_compound_key('screen_name', user.path.split('/').last, hash, prefix)
+        when Twitter::User
+          set_compound_key('user_id', user.id, hash, prefix)
+        end
+      end
+
+      def set_compound_key(key, value, hash, prefix = nil)
+        compound_key = [prefix, key].compact.join('_').to_sym
+        hash[compound_key] = value
+        hash
+      end
+
+      # Take a multiple users and merge them into the hash with the correct keys
+      #
+      # @param hash [Hash]
+      # @param users [Enumerable<Integer, String, Twitter::User>] A collection of Twitter user IDs, screen_names, or objects.
+      # @return [Hash]
+      def merge_users(hash, users)
+        merge_users!(hash.dup, users)
+      end
+
+      # Take a multiple users and merge them into the hash with the correct keys
+      #
+      # @param hash [Hash]
+      # @param users [Enumerable<Integer, String, URI, Twitter::User>] A collection of Twitter user IDs, screen_names, URIs, or objects.
+      # @return [Hash]
+      def merge_users!(hash, users)
+        user_ids, screen_names = collect_user_ids_and_screen_names(users)
+        hash[:user_id] = user_ids.join(',') unless user_ids.empty?
+        hash[:screen_name] = screen_names.join(',') unless screen_names.empty?
+        hash
+      end
+
+      def collect_user_ids_and_screen_names(users) # rubocop:disable MethodLength
+        user_ids, screen_names = [], []
+        users.flatten.each do |user|
+          case user
+          when Integer
+            user_ids << user
+          when String
+            if user[URI_SUBSTRING]
+              screen_names << user.split('/').last
+            else
+              screen_names << user
+            end
+          when URI
+            screen_names << user.path.split('/').last
+          when Twitter::User
+            user_ids << user.id
+          end
+        end
+        [user_ids, screen_names]
+      end
+    end
+  end
+end

data/lib/twitter/search_results.rb

@@ -12,17 +12,6 @@ module Twitter
     deprecate_alias :to_hash, :to_h
     deprecate_alias :to_hsh, :to_h
 
-    class << self
-      # Construct a new SearchResults object from a response hash
-      #
-      # @param response [Hash]
-      # @param request [Twitter::Request]
-      # @return [Twitter::SearchResults]
-      def from_response(response, request)
-        new(response[:body], request)
-      end
-    end
-
     # Initializes a new SearchResults object
     #
     # @param attrs [Hash]
@@ -61,8 +50,8 @@ module Twitter
 
     # @return [Hash]
     def fetch_next_page
-      response = @client.send(@request_method, @path, next_page)
-      self.attrs = response[:body]
+      response = @client.send(@request_method, @path, next_page).body
+      self.attrs = response
     end
 
     # @param attrs [Hash]

data/lib/twitter/trend_results.rb

@@ -15,16 +15,6 @@ module Twitter
     deprecate_alias :to_hash, :to_h
     deprecate_alias :to_hsh, :to_h
 
-    class << self
-      # Construct a new TrendResults object from a response hash
-      #
-      # @param response [Hash]
-      # @return [Twitter::Base]
-      def from_response(response = {})
-        new(response[:body].first)
-      end
-    end
-
     # Initializes a new TrendResults object
     #
     # @param attrs [Hash]

data/lib/twitter/version.rb

@@ -1,7 +1,7 @@
 module Twitter
   class Version
     MAJOR = 5
-    MINOR = 6
+    MINOR = 7
     PATCH = 0
     PRE = nil
 

data/spec/helper.rb

@@ -8,7 +8,7 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
 
 SimpleCov.start do
   add_filter '/spec/'
-  minimum_coverage(99.42)
+  minimum_coverage(99.39)
 end
 
 require 'twitter'

data/spec/twitter/error_spec.rb

@@ -6,63 +6,47 @@ describe Twitter::Error do
     @client = Twitter::REST::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS', :access_token => 'AT', :access_token_secret => 'AS')
   end
 
+  describe '#code' do
+    it 'returns the error code' do
+      error = Twitter::Error.new('execution expired', {}, 123)
+      expect(error.code).to eq(123)
+    end
+  end
+
   describe '#message' do
-    it 'returns the message of the cause' do
-      error = Twitter::Error.new(Faraday::Error::ClientError.new('Oops'))
-      expect(error.message).to eq('Oops')
+    it 'returns the error message' do
+      error = Twitter::Error.new('execution expired')
+      expect(error.message).to eq('execution expired')
     end
   end
 
   describe '#rate_limit' do
-    it 'returns the cause' do
-      error = Twitter::Error.new(Faraday::Error::ClientError.new('Oops'))
+    it 'returns a rate limit object' do
+      error = Twitter::Error.new('execution expired')
       expect(error.rate_limit).to be_a Twitter::RateLimit
     end
   end
 
-  describe '#cause' do
-    it 'returns the cause' do
-      error = Twitter::Error.new(Faraday::Error::ClientError.new('Oops'))
-      expect(error.cause.class).to eq(Faraday::Error::ClientError)
+  [nil, 'error', 'errors'].each do |key|
+    context "when JSON body contains #{key.inspect}" do
+      before do
+        body = "{\"#{key}\":\"Internal Server Error\"}" unless body.nil?
+        stub_get('/1.1/statuses/user_timeline.json').with(:query => {:screen_name => 'sferik'}).to_return(:status => 500, :body => body)
+      end
+      it 'raises an exception with the proper message' do
+        expect { @client.user_timeline('sferik') }.to raise_error(Twitter::Error::InternalServerError)
+      end
     end
   end
 
   Twitter::Error.errors.each do |status, exception|
-
-    [nil, 'error', 'errors'].each do |body|
-      context "when HTTP status is #{status} and body is #{body.inspect}" do
-        before do
-          body_message = '{"' + body + '":"Client Error"}' unless body.nil?
-          stub_get('/1.1/statuses/user_timeline.json').with(:query => {:screen_name => 'sferik'}).to_return(:status => status, :body => body_message)
-        end
-        it "raises #{exception.name}" do
-          expect { @client.user_timeline('sferik') }.to raise_error(exception)
-        end
+    context "when HTTP status is #{status}" do
+      before do
+        stub_get('/1.1/statuses/user_timeline.json').with(:query => {:screen_name => 'sferik'}).to_return(:status => status, :body => '{}')
       end
-    end
-
-    context "when HTTP status is #{status} and body is errors" do
-      context 'when errors is an array of hashes' do
-        context 'when error code is nil' do
-          before do
-            body_message = '{"errors":[{"message":"Client Error"}]}'
-            stub_get('/1.1/statuses/user_timeline.json').with(:query => {:screen_name => 'sferik'}).to_return(:status => status, :body => body_message)
-          end
-          it "raises #{exception.name}" do
-            expect { @client.user_timeline('sferik') }.to raise_error { |error| expect(error.code).to be_nil }
-          end
-          context 'when error code is 187' do
-            before do
-              body_message = '{"errors":[{"message":"Client Error","code":187}]}'
-              stub_get('/1.1/statuses/user_timeline.json').with(:query => {:screen_name => 'sferik'}).to_return(:status => status, :body => body_message)
-            end
-            it "raises #{exception.name}" do
-              expect { @client.user_timeline('sferik') }.to raise_error { |error| expect(error.code).to eq(187) }
-            end
-          end
-        end
+      it "raises #{exception}" do
+        expect { @client.user_timeline('sferik') }.to raise_error(exception)
       end
     end
-
   end
 end

data/spec/twitter/rest/{api/direct_messages_spec.rb → direct_messages_spec.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-describe Twitter::REST::API::DirectMessages do
+describe Twitter::REST::DirectMessages do
 
   before do
     @client = Twitter::REST::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS', :access_token => 'AT', :access_token_secret => 'AS')

data/spec/twitter/rest/{api/favorites_spec.rb → favorites_spec.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-describe Twitter::REST::API::Favorites do
+describe Twitter::REST::Favorites do
 
   before do
     @client = Twitter::REST::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS', :access_token => 'AT', :access_token_secret => 'AS')

data/spec/twitter/rest/{api/friends_and_followers_spec.rb → friends_and_followers_spec.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-describe Twitter::REST::API::FriendsAndFollowers do
+describe Twitter::REST::FriendsAndFollowers do
 
   before do
     @client = Twitter::REST::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS', :access_token => 'AT', :access_token_secret => 'AS')

data/spec/twitter/rest/{api/geo_spec.rb → geo_spec.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-describe Twitter::REST::API::PlacesAndGeo do
+describe Twitter::REST::PlacesAndGeo do
 
   before do
     @client = Twitter::REST::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS', :access_token => 'AT', :access_token_secret => 'AS')

data/spec/twitter/rest/{api/help_spec.rb → help_spec.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-describe Twitter::REST::API::Help do
+describe Twitter::REST::Help do
 
   before do
     @client = Twitter::REST::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS', :access_token => 'AT', :access_token_secret => 'AS')

data/spec/twitter/rest/{api/lists_spec.rb → lists_spec.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-describe Twitter::REST::API::Lists do
+describe Twitter::REST::Lists do
 
   before do
     @client = Twitter::REST::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS', :access_token => 'AT', :access_token_secret => 'AS')

data/spec/twitter/rest/{api/oauth_spec.rb → oauth_spec.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-describe Twitter::REST::API::OAuth do
+describe Twitter::REST::OAuth do
 
   before do
     @client = Twitter::REST::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS')
@@ -8,17 +8,13 @@ describe Twitter::REST::API::OAuth do
 
   describe '#token' do
     before do
-      # WebMock treats Basic Auth differently so we have to chack against the full URL with credentials.
+      # Faraday treats Basic Auth differently so we have to use the full URL with credentials
       @oauth2_token_url = 'https://CK:CS@api.twitter.com/oauth2/token'
-      stub_request(:post, @oauth2_token_url).with(:body => 'grant_type=client_credentials').to_return(:body => fixture('bearer_token.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
+      stub_request(:post, @oauth2_token_url).with(:body => {'grant_type' => 'client_credentials'}).to_return(:body => fixture('bearer_token.json'), :headers => {:content_type => 'application/json; charset=utf-8'})
     end
     it 'requests the correct resource' do
       @client.token
-      expect(a_request(:post, @oauth2_token_url).with(:body => {:grant_type => 'client_credentials'})).to have_been_made
-    end
-    it 'requests with the correct headers' do
-      @client.token
-      expect(a_request(:post, @oauth2_token_url).with(:headers => {:content_type => 'application/x-www-form-urlencoded; charset=UTF-8', :accept => '*/*'})).to have_been_made
+      expect(a_request(:post, @oauth2_token_url).with(:body => {:grant_type => 'client_credentials'}, :headers => {:content_type => 'application/x-www-form-urlencoded; charset=UTF-8', :accept => '*/*'})).to have_been_made
     end
     it 'returns the bearer token' do
       bearer_token = @client.token

data/spec/twitter/rest/{api/saved_searches_spec.rb → saved_searches_spec.rb}

@@ -1,6 +1,6 @@
 require 'helper'
 
-describe Twitter::REST::API::SavedSearches do
+describe Twitter::REST::SavedSearches do
 
   before do
     @client = Twitter::REST::Client.new(:consumer_key => 'CK', :consumer_secret => 'CS', :access_token => 'AT', :access_token_secret => 'AS')