twitter_labs_api 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d4b2bac3fd2da4e6171169403a9d0e98a59e6b85470f4858d38277a57516a17
-  data.tar.gz: 72b988ee36c5bfd84e7d09aedacb7f2efc4f894bdd775ec4f5d9a1b37910207e
+  metadata.gz: 308afe5c20914abca1ed575f09b1e5924206034eae405886944d495fb6e4d3da
+  data.tar.gz: 5b931944828a477b39d0360d492c2fb6215b13ec12f8b953ac01533bcf822b44
 SHA512:
-  metadata.gz: bbd9ec6ea62e02dc8f177889a0823b01534bf537284fb48a0b792f95a347ba08f34fe6951cea1e4bda277867432d0e344b541a70f79ad32db95dc89f61c0cec9
-  data.tar.gz: 4fe777c3670f8c437febcf7ace17f072a15fd533fd9debbe457bc2aaff2bb36b067af746615a885541c98d468e34cb13b3b3ecc637badd521229bfc37369459c
+  metadata.gz: 12be24ffd5dfbc7b81b5bba6665cd264c39a8d9cbe828977b569285093b37e00036950db0a1b94c50fb287847897a6d8ba356bcb8b950c33197c4bda888a2a5a
+  data.tar.gz: b44d15ee5acc7a147ea3c2208c242cd45b6d5966cfbac0a2c2946b85594f73263853c4b0b45d9125567d20ffb295e33c45ae6491a2d4a0a31535a94a00b77ef7

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+# 0.7.0 - 28 August 2020
+
+- Refactor interface for requesting custom response fields
+
+## Breaking Change
+
+Heads up, the argument to request fields was previously called `tweet_fields`; it is now called `fields`. 
+
+```ruby
+api.get_tweet(id: '123455683780', fields: requested_fields)
+```
+
+The `fields` parameter now supports multiple different data types (instead of just Tweet attributes). So for example, to request the URL of an embedded media item:
+
+```ruby
+requested_fields = { tweet: %w[id username], media: %w[url] }
+
+api.get_tweet(id: my_id, fields: requested_fields)
+```
+
 # 0.6.0 - 28 July 2020
 
 - Fix: broken dependency

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    twitter_labs_api (0.6.0)
+    twitter_labs_api (0.7.0)
       activesupport (~> 6.0)
       httplog (~> 1.4)
 
@@ -25,7 +25,7 @@ GEM
     cd (1.0.1)
     clipboard (1.0.6)
     coderay (1.1.3)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.7)
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     debugging (1.1.1)

data/README.md

@@ -32,14 +32,13 @@ api.get_tweet(id: '1234671272602193920')
 
 #### Specifying which fields to include in the response
 
-By default, the gem requests the 'default' fields for each entity. See the [API Reference](https://developer.twitter.com/en/docs/labs/tweets-and-users/api-reference) for available fields. One can customize the response payload like so:
+By default, the gem requests the 'default' fields for each entity. See the [API Reference](https://developer.twitter.com/en/docs/labs/tweets-and-users/api-reference) for available fields. One can customize the response payload, depending on the requested resource.
 
+For example, to request the URL of a Tweet's embedded media item:
 ```ruby
-my_fields = %w[id author_id created_at text]
+requested_fields = { tweet: %w[id username], media: %w[url] }
 
-api.get_tweet(id: '1235508591232090112', tweet_fields: my_fields)
-
->> {"author_id"=>"229708614", "created_at"=>"2020-03-05T10:12:57.000Z", "id"=>"1235508591232090112", "text"=>"Hot take: coronavirus will not boost remote work in the long run because spur-of-the-moment work-from-home for in-person companies is likely to be a shitshow."}
+api.get_tweet(id: my_id, fields: requested_fields)
 ```
 
 #### API Errors

data/lib/twitter_labs_api/resources/tweet.rb

@@ -2,30 +2,31 @@ module TwitterLabsAPI
   module Resources
     module Tweet
       DEFAULT_TWEET_FIELDS = %w[id author_id created_at lang public_metrics].freeze
+      DEFAULT_FIELDS = { tweet: DEFAULT_TWEET_FIELDS }.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
+      # @param [Hash] :fields a hash for fields to include in the response payload; 
+      #
+      #     e.g.: { tweet: %w[id username], media: %w[url] }
       # @return Hash an object with requested tweet fields
-      def get_tweet(id:, tweet_fields: DEFAULT_TWEET_FIELDS)
+      def get_tweet(id:, fields: DEFAULT_FIELDS)
         url = "https://api.twitter.com/labs/2/tweets/#{id}"
-        params = {
-          'tweet.fields' => tweet_fields.join(',')
-        }.compact
+        params = ParamsService.from_fields(fields)
 
         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
+      # @param [Hash] :fields a hash for fields to include in the response payload; 
+      #
+      #     e.g.: { tweet: %w[id username], media: %w[url] }
       # @return [Array<Hash>] of tweet objects with the requested tweet fields
-      def get_tweets(ids:, tweet_fields: DEFAULT_TWEET_FIELDS)
+      def get_tweets(ids:, fields: DEFAULT_FIELDS)
         url = 'https://api.twitter.com/labs/2/tweets'
-        params = {
-          'ids' => ids.join(','),
-          'tweet.fields' => tweet_fields.join(',')
-        }.compact
+        params = ParamsService.from_fields(fields)
+        params.merge!({ ids: ids.join(',') })
 
         make_request(url: url, params: params, is_collection: true)
       end
@@ -41,14 +42,14 @@ module TwitterLabsAPI
 
       # 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
+      # @param [Hash] :fields a hash for fields to include in the response payload; 
+      #
+      #     e.g.: { tweet: %w[id username], media: %w[url] }
+      # @return [Array<Hash>] of tweet objects with the requested tweet fields
+      def search(query:, fields: DEFAULT_FIELDS)
+        url = 'https://api.twitter.com/labs/2/tweets/search'
+        params = ParamsService.from_fields(fields)
+        params.merge!({ query: query })
 
         make_request(url: url, params: params, is_collection: true)
       end

data/lib/twitter_labs_api/resources/user.rb

@@ -2,44 +2,45 @@ module TwitterLabsAPI
   module Resources
     module User
       DEFAULT_USER_FIELDS = %w[id name username].freeze
+      DEFAULT_FIELDS = { user: DEFAULT_USER_FIELDS }.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
+      # @param [Hash] :fields  a hash for fields to include in the response payload; 
+      #
+      #  e.g.: { user: %w[id name username] }
       # @return Hash an object with requested user fields
-      def get_user(id:, user_fields: DEFAULT_USER_FIELDS)
+      def get_user(id:, fields: DEFAULT_FIELDS)
         url = "https://api.twitter.com/labs/2/users/#{id}"
-        params = {
-          'user.fields' => user_fields.join(',')
-        }.compact
+        params = ParamsService.from_fields(fields)
 
         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
+      # @param [Hash] :fields  a hash for fields to include in the response payload; 
+      #
+      #  e.g.: { user: %w[id name username] }
       # @return [Array<Hash>] of user objects with the requested user fields
-      def get_users(ids:, user_fields: DEFAULT_USER_FIELDS)
+      def get_users(ids:, fields: DEFAULT_FIELDS)
         url = 'https://api.twitter.com/labs/2/users'
-        params = {
-          'ids' => ids.join(','),
-          'user.fields' => user_fields.join(',')
-        }.compact
+        params = ParamsService.from_fields(fields)
+        params.merge!({ ids: ids.join(',') })
 
         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
+      # @param [Hash] :fields  a hash for fields to include in the response payload; 
+      #
+      #  e.g.: { user: %w[id name username] }
       # @return [Array<Hash>] of user objects with the requested user fields
-      def get_users_by_usernames(usernames:, user_fields: DEFAULT_USER_FIELDS)
+      def get_users_by_usernames(usernames:, fields: DEFAULT_FIELDS)
         url = 'https://api.twitter.com/labs/2/users/by'
-        params = {
-          'usernames' => usernames.join(','),
-          'user.fields' => user_fields.join(',')
-        }.compact
+        params = ParamsService.from_fields(fields)
+        params.merge!({ usernames: usernames.join(',') })
 
         make_request(url: url, params: params, is_collection: true)
       end

data/lib/twitter_labs_api/services/params_service.rb

@@ -0,0 +1,15 @@
+class ParamsService
+  # Convert user-passed fields hash to query params
+  # @param [Hash] :fields A hash of requested fields; see API Reference for details
+  # @return [Hash] A hash of query params for consumption by API client
+  # @example
+  #     input: { tweet: %w[id username], media: ['url'] }
+  #     output: { 'tweet.fields' => 'id,username', 'media.fields' => 'url }
+  def self.from_fields(fields)
+    fields.keys.inject({}) do |memo, key|
+      memo["#{key}.fields"] = fields[key].join(',')
+
+      memo
+    end
+  end
+end

data/lib/twitter_labs_api/version.rb

@@ -1,3 +1,3 @@
 module TwitterLabsAPI
-  VERSION = '0.6.0'.freeze
+  VERSION = '0.7.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: twitter_labs_api
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - tomholford
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-28 00:00:00.000000000 Z
+date: 2020-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -90,6 +90,7 @@ files:
 - lib/twitter_labs_api/client.rb
 - lib/twitter_labs_api/resources/tweet.rb
 - lib/twitter_labs_api/resources/user.rb
+- lib/twitter_labs_api/services/params_service.rb
 - lib/twitter_labs_api/version.rb
 - twitter-labs-api.gemspec
 homepage: https://github.com/tomholford/twitter-labs-api