twitter_labs_api 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f31f636cbf46ed53a3d35e61c3376b9f47184220db4b23277f4f7c504f4be251
-  data.tar.gz: be3ae4940e263fe6bf33661686072c62c807236f9c2814488661efc8da8799a8
+  metadata.gz: ec82ff15b22f8a14b4dc1ad25721f80f2b24b3765015a57153b23cd08682eee8
+  data.tar.gz: d4b233244f69b5f8c32de63f80b5ad3f1e78c126b4cf7d6cd45331f7dcab8eb4
 SHA512:
-  metadata.gz: 6062719f695c9979a327d94396795df7365559e92598fe08e727d2e87dc2e4a987a4f6bf689954cd2efc2b6c20f0ad5ae3003f651e0e45fc0caea12f46a57688
-  data.tar.gz: 7c1616a9f97582a2dda4061f2a0c540b7967d4d525c0bd344141643723450d91a4208357d919b8acf4d0d89a17d2046e0f6fba75a5c3eb6e9a10d9f6caa4df31
+  metadata.gz: b3b8f6f74db6c566164f33694844f8b06a49d50cd4a2d6707cb3896ef7243eddd771cfef300b9028599f5c817283829ec3731241296de203edb32a75f89ba9ca
+  data.tar.gz: e039b095549909701d0a8fd9dfff4e622c398de4111718acbf0327e247d8e3cb449d45689b36cc7e939ece61c54b490e6b85664c473fa3ba6c665fbcfee93590

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.5.1 - 28 July 2020
+
+- Add `User-Agent` request header
+- Add `hide_reply`
+
 # 0.5.0 - 27 July 2020
 
 - Refactor structure to prepare for adding additional API endpoints

data/Gemfile.lock

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

data/README.md

@@ -5,9 +5,9 @@ A basic implementation of a Twitter Labs API client as a handy Ruby [gem](https:
 ## Usage
 
 ### Prerequisite
-All one needs is a Twitter [bearer token](https://developer.twitter.com/en/docs/basics/authentication/oauth-2-0/bearer-tokens) to get started.
+All one needs is a Twitter [bearer token](https://developer.twitter.com/en/docs/basics/authentication/oauth-2-0/bearer-tokens) to get started. The bearer token is available on the 'Tokens and Keys' page within your app's dashboard on the [Twitter for Developers](https://developer.twitter.com/) site.
 
-One easy way to get a bearer token is to use [this method](https://www.rubydoc.info/gems/twitter/Twitter/REST/Client#bearer_token%3F-instance_method) from https://github.com/sferik/twitter.
+Alternatively, one can get a bearer token using [this method](https://www.rubydoc.info/gems/twitter/Twitter/REST/Client#bearer_token%3F-instance_method) from https://github.com/sferik/twitter.
 
 ### Setup
 
@@ -62,6 +62,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
 
 #### Users
 
@@ -71,7 +72,9 @@ Currently, the following endpoints are implemented:
 
 ## Roadmap
 
-Since this project is initially driven by my own usage of the API, I will focus on implementing and refining the Tweets, Users, and Metrics endpoints. If this repo gets enough interest, I might implement the other endpoints and create a proper `.gemspec`. And of course, contributions are welcome :)
+Currently focused on implementing support for all v2 endpoints; if there is enough interest, I will add v1 endpoint support as well.
+
+And of course, contributions are welcome :)
 
 ## Dependencies
 

data/lib/twitter_labs_api/client.rb

@@ -17,13 +17,14 @@ module TwitterLabsAPI
 
     private
 
-    def make_request(url:, params: {}, is_collection: false)
+    def make_request(url:, params: {}, is_collection: false, method: :get)
       uri = URI.parse(url)
       uri.query = URI.encode_www_form(params)
-      request = Net::HTTP::Get.new(uri)
+      request = http_adapter(method).new(uri)
       request['Authorization'] = "Bearer #{bearer_token}"
+      request['User-Agent'] = "twitter_labs_api gem #{TwitterLabsAPI::VERSION}"
       req_options = { use_ssl: uri.scheme == 'https' }
-  
+
       self.api_response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
         http.request(request)
       end
@@ -36,7 +37,16 @@ module TwitterLabsAPI
   
       is_collection ? handle_collection : handle_single
     end
-  
+
+    def http_adapter(method)
+      case method
+      when :put
+        Net::HTTP::Put
+      else
+        Net::HTTP::Get
+      end
+    end
+
     def error_response?
       parsed_response.key?('errors')
     end

data/lib/twitter_labs_api/resources/tweet.rb

@@ -5,6 +5,7 @@ module TwitterLabsAPI
 
       # @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
       def get_tweet(id:, tweet_fields: DEFAULT_TWEET_FIELDS)
         url = "https://api.twitter.com/labs/2/tweets/#{id}"
         params = {
@@ -16,6 +17,7 @@ module TwitterLabsAPI
 
       # @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
       def get_tweets(ids:, tweet_fields: DEFAULT_TWEET_FIELDS)
         url = 'https://api.twitter.com/labs/2/tweets'
         params = {
@@ -25,6 +27,14 @@ module TwitterLabsAPI
 
         make_request(url: url, params: params, is_collection: true)
       end
+
+      # @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:)
+        url = "https://api.twitter.com/labs/2/tweets/#{id}/hidden"
+
+        make_request(url: url, method: :put)[:hidden]
+      end
     end
   end
 end

data/lib/twitter_labs_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitter_labs_api
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - tomholford
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-27 00:00:00.000000000 Z
+date: 2020-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport