twitter_labs_api 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ec82ff15b22f8a14b4dc1ad25721f80f2b24b3765015a57153b23cd08682eee8
-  data.tar.gz: d4b233244f69b5f8c32de63f80b5ad3f1e78c126b4cf7d6cd45331f7dcab8eb4
+  metadata.gz: 697a03319c55056717774438db0f412e52df2337e52452bfecc0c9f5f00c99f2
+  data.tar.gz: d841c0f5c73763593663180cae40f1528b21037708fbc9b05f0c4fcc89d83720
 SHA512:
-  metadata.gz: b3b8f6f74db6c566164f33694844f8b06a49d50cd4a2d6707cb3896ef7243eddd771cfef300b9028599f5c817283829ec3731241296de203edb32a75f89ba9ca
-  data.tar.gz: e039b095549909701d0a8fd9dfff4e622c398de4111718acbf0327e247d8e3cb449d45689b36cc7e939ece61c54b490e6b85664c473fa3ba6c665fbcfee93590
+  metadata.gz: d4f956e69a646de92cd9c79139bae452091603630da9e6596e004d0a6f084c8be362bb083a01aa2ccb66cb4385dcfdc099d35dd8f2b91c291f9a19b93395f774
+  data.tar.gz: 88bb52e555879a7c003f4006f3d4f10c34bd509dfd083ac06856006a3e2a9d2f3b57dcd1a0e5d5e93df3c15a92bd8b723c0b362a40b0a287c639cfe234b68aa1

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.5.2 - 28 July 2020
+
+- Add `search`
+- Finish `rdoc` coverage
+
 # 0.5.1 - 28 July 2020
 
 - Add `User-Agent` request header

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twitter_labs_api (0.5.1)
+    twitter_labs_api (0.5.2)
       activesupport (~> 6.0)
       httplog (~> 1.4)
 

data/README.md

@@ -63,6 +63,7 @@ Currently, the following endpoints are implemented:
 - `TwitterLabsAPI#get_tweet` ([docs](https://developer.twitter.com/en/docs/labs/tweets-and-users/api-reference/get-tweets-id)) - Retrieve a single Tweet object with an `id`
 - `TwitterLabsAPI#get_tweets` ([docs](https://developer.twitter.com/en/docs/labs/tweets-and-users/api-reference/get-tweets)) - Retrieve multiple Tweets with a collection of `ids`
 - `TwitterLabsAPI#hide_reply` ([docs](https://developer.twitter.com/en/docs/labs/hide-replies/api-reference/put-hidden)) - Hide a reply by referencing it's `id`; must be in a conversation belonging to the authenticating user
+- `TwitterLabsAPI#search` ([docs](https://developer.twitter.com/en/docs/labs/recent-search/api-reference/get-recent-search)) - Returns Tweets from the last 7 days that match a search query.
 
 #### Users
 

data/lib/twitter_labs_api/resources/tweet.rb

@@ -3,6 +3,7 @@ module TwitterLabsAPI
     module Tweet
       DEFAULT_TWEET_FIELDS = %w[id author_id created_at lang public_metrics].freeze
 
+      # Returns a variety of information about a single Tweet specified by the requested ID.
       # @param [String] :id the ID of the requested Tweet
       # @param [Array<String>] :tweet_fields (["id", "author_id", "created_at", "lang", "public_metrics"]) the list of fields to retrieve for the given tweet
       # @return Hash an object with requested tweet fields
@@ -15,6 +16,7 @@ module TwitterLabsAPI
         make_request(url: url, params: params)
       end
 
+      # Returns a variety of information about the Tweet specified by the requested ID or list of IDs.
       # @param [Array<String>] :ids the collection of requested Tweet IDs
       # @param [Array<String>] :tweet_fields (["id", "author_id", "created_at", "lang", "public_metrics"]) the list of fields to retrieve for the given tweet
       # @return [Array<Hash>] of tweet objects with the requested tweet fields
@@ -28,6 +30,7 @@ module TwitterLabsAPI
         make_request(url: url, params: params, is_collection: true)
       end
 
+      # Hides or unhides a reply to a Tweet.
       # @param [String] :id the ID of the requested Tweet; must belong to a conversation by the authenticated user
       # @return boolean indicating the hidden status of the requested tweet
       def hide_reply(id:)
@@ -35,6 +38,20 @@ module TwitterLabsAPI
 
         make_request(url: url, method: :put)[:hidden]
       end
+
+      # The Labs recent search endpoint returns Tweets from the last 7 days that match a search query.
+      # @param [String] :query the search query
+      # @param [Array<String>] :tweet_fields (["id", "author_id", "created_at", "lang", "public_metrics"]) the list of fields to retrieve for the given tweet
+      # @param [Array<String>] :tweet_fields (["id", "author_id", "created_at", "lang", "public_metrics"]) the list of fields to retrieve for the given tweet
+      def search(query:, tweet_fields: DEFAULT_TWEET_FIELDS)
+        url = "https://api.twitter.com/labs/2/tweets/search"
+        params = {
+          'query' => query,
+          'tweet.fields' => tweet_fields.join(',')
+        }.compact
+
+        make_request(url: url, params: params, is_collection: true)
+      end
     end
   end
 end

data/lib/twitter_labs_api/resources/user.rb

@@ -3,8 +3,10 @@ module TwitterLabsAPI
     module User
       DEFAULT_USER_FIELDS = %w[id name username].freeze
 
+      # Returns a variety of information about a single more user specified by the requested ID.
       # @param [String] :id the ID of the requested User
       # @param [Array<String>] :user_fields (["name", "username"]) the list of fields to retrieve for the given User
+      # @return Hash an object with requested user fields
       def get_user(id:, user_fields: DEFAULT_USER_FIELDS)
         url = "https://api.twitter.com/labs/2/users/#{id}"
         params = {
@@ -14,8 +16,10 @@ module TwitterLabsAPI
         make_request(url: url, params: params)
       end
 
+      # Returns a variety of information about one or more Users specified by the requested IDs.
       # @param [Array<String>] :ids the collection of requested User IDs
       # @param [Array<String>] :user_fields (["name", "username"]) the list of fields to retrieve for the given User
+      # @return [Array<Hash>] of user objects with the requested user fields
       def get_users(ids:, user_fields: DEFAULT_USER_FIELDS)
         url = 'https://api.twitter.com/labs/2/users'
         params = {
@@ -26,8 +30,10 @@ module TwitterLabsAPI
         make_request(url: url, params: params, is_collection: true)
       end
 
+      # Returns a variety of information about one or more Users specified by the requested usernames.
       # @param [Array<String>] :usernames the collection of requested Usernames
       # @param [Array<String>] :user_fields (["name", "username"]) the list of fields to retrieve for the given User
+      # @return [Array<Hash>] of user objects with the requested user fields
       def get_users_by_usernames(usernames:, user_fields: DEFAULT_USER_FIELDS)
         url = 'https://api.twitter.com/labs/2/users/by'
         params = {

data/lib/twitter_labs_api/version.rb

@@ -1,3 +1,3 @@
 module TwitterLabsAPI
-  VERSION = '0.5.1'.freeze
+  VERSION = '0.5.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: twitter_labs_api
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - tomholford