twttr 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2fe60301d1d17eb4a2904de32bbd649364bb864e13cbe9c56c5151d987c34ec4
-  data.tar.gz: c7c28b855390fe720ce157d49e8d6f7525ae14ad797bc1a1fbdda77ed4efabfb
+  metadata.gz: e199840acca6799e8d3e0e5624510cf9f1a0ba060177dad0b24d9b37b57fb0d9
+  data.tar.gz: 29a188421066cf6de970656874f8cc36d238f5aba1b51430c7d6a019618597bf
 SHA512:
-  metadata.gz: aa537df933312dea3e75e86dcf6828b7d8ca2cc81138ec46f7b3e867b81dcaa01c542c601306f26f8c8d68590762071bb80d04dd88ef155c5df0798abf568e3d
-  data.tar.gz: fe96a4b38af080331a25a6be5a31d9e5cfc98d0b95b54faabfd1b45dce89bdb1e16e37635eace45bb7a8ef9c63983f295024ebe1fd82c4e7ad15a14c9b823795
+  metadata.gz: 4bd17869256489e6c5878173cab9251b10bdce1332442cc4d35da4cbc566a8948171ae4bfcc953e368dc85180afe36753468ffa2ec808b25ec34b8e3f51aee2d
+  data.tar.gz: e291aa2e6bdbfe2fd7b350e092e729c33f0e342eb4f2091f62b1ce2ac51cec35fb3b7467e2b57b3fdd5b658a740c31a0debae7b750d84c9c8166d2aef1a8cb69

data/lib/twttr/client/endpoint/v2/users/follows.rb

@@ -13,13 +13,15 @@ module Twttr
             # GET /2/users/:id/following
             # https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following
             #
+            # Returns paginated list of users followed by user_id.
+            #
             # @param user_id [String] The user ID whose following you would like to retrieve.
             # @param max_results [Integer] Max number of results per peage.
             # @param pagination_token [String] Initial page pagination token.
             # @yield [Array<Twttr::Model::User>] Users followed by page.
+            # @yield [String,NilClass] Pagination token.
             # @return [Array<Twttr::Model::User>] Users followed.
-            # @return [String,NilClass] Pagination token.
-            def following(user_id, max_results: nil, pagination_token: nil, &block) # rubocop:disable Metrics/MethodLength
+            def following(user_id, max_results: nil, pagination_token: nil, &block) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
               response = get(FOLLOWING_PATH, params: { user_id: user_id },
                                              query_params: {
                                                'user.fields': config.user_fields,
@@ -33,11 +35,11 @@ module Twttr
 
               pagination_token = response['meta']['pagination_token']
 
-              return users, pagination_token unless block_given?
+              yield users, pagination_token if block_given?
 
-              yield users, pagination_token
+              return users if pagination_token.nil?
 
-              following(user_id, pagination_token, &block) unless pagination_token.nil?
+              users + following(user_id, pagination_token: pagination_token, &block)
             end
           end
         end

data/lib/twttr/client/endpoint/v2/users.rb

@@ -12,23 +12,62 @@ module Twttr
           USER_BY_USERNAME_PATH = "#{V2::V2_PATH}/users/by/username/%<username>s"
           USER_PATH = "#{V2::V2_PATH}/users/%<user_id>s"
 
+          # GET /2/users/:id/following
+          # https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following
+          #
+          # Returns paginated list of users followed by user_id.
+          #
+          # @param user_id [String] The user ID whose following you would like to retrieve.
+          # @param max_results [Integer] Max number of results per peage.
+          # @param pagination_token [String] Initial page pagination token.
+          # @yield [Array<Twttr::Model::User>] Users followed by page.
+          # @yield [String,NilClass] Pagination token.
+          # @return [Array<Twttr::Model::User>] Users followed.
+
+          # GET /2/users/me
+          # https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-me
+          #
+          # Returns current authenticated user
+          #
+          # @return [Twttr::Model::User] Current user.
           def me
             response = get(ME_PATH, query_params: { 'user.fields': config.user_fields })
             Model::User.new(response['data'], self)
           end
 
+          # GET /2/users/:id
+          # https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-id
+          #
+          # Returns target user by id
+          #
+          # @param user_id [String] Traget user id.
+          # @return [Twttr::Model::User] Target user.
           def user(user_id)
             response = get(USER_PATH, params: { user_id: user_id },
                                       query_params: { 'user.fields': config.user_fields })
             Model::User.new(response['data'], self)
           end
 
+          # GET /2/users/by/username/:username
+          # https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users-by-username-username
+          #
+          # Returns target user by username
+          #
+          # @param username [String] Traget username.
+          # @return [Twttr::Model::User] Target user.
           def user_by_username(username)
             response = get(USER_BY_USERNAME_PATH, params: { username: username },
                                                   query_params: { 'user.fields': config.user_fields })
             Model::User.new(response['data'], self)
           end
 
+          # GET /2/users
+          # https://developer.twitter.com/en/docs/twitter-api/users/lookup/api-reference/get-users
+          #
+          # Returns target users by id
+          #
+          # @param user_ids [Array<String>] Traget user ids.
+          # @return [Array<Twttr::Model::User>] Target users.
           def users(user_ids)
             response = get(USERS_PATH,
                            query_params: { ids: user_ids.join(','), 'user.fields': config.user_fields })

data/lib/twttr/model/user.rb

@@ -15,6 +15,18 @@ module Twttr
         @client = client
       end
 
+      # Forwards to Follows#following setting user_id to current user's id.
+      #
+      # GET /2/users/:id/following
+      # https://developer.twitter.com/en/docs/twitter-api/users/follows/api-reference/get-users-id-following
+      #
+      # Returns paginated list of users followed by user_id.
+      #
+      # @param max_results [Integer] Max number of results per peage.
+      # @param pagination_token [String] Initial page pagination token.
+      # @yield [Array<Twttr::Model::User>] Users followed by page.
+      # @yield [String,NilClass] Pagination token.
+      # @return [Array<Twttr::Model::User>] Users followed.
       def following(max_results: nil, pagination_token: nil, &block)
         client.following(id, max_results: max_results, pagination_token: pagination_token, &block)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twttr
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Roberto Decurnex
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-01-08 00:00:00.000000000 Z
+date: 2022-01-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oauth