birdsong 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '03486db7a9efbfce2f7d423f25e33506332bad5a7ceb481da98e68c81b0a75fa'
-  data.tar.gz: 7a46972f68f413a3d3e0cb81b06ece6b9a3a8f9593be5a68664ce0364ab366ec
+  metadata.gz: a632c977970e4e7b014373f08dc819091aece69e59292295711ddfce261ded9c
+  data.tar.gz: ee9d3a05780af53011a3f9018c512a2f6e6dfe733824c2a0401c873b9b529188
 SHA512:
-  metadata.gz: 68eb9d33bac12dc765b776ad32024992640b1363612f99b2cc0b500c6000fd3ef7351d8cc70218d2d21bb681ec40b233b24fdd7062694426891ce3fa22088e62
-  data.tar.gz: 8ceddb1eb88a57dec49116653f0be80be47d29d395894ea35a28aafa84eee72d5aa13deca419e569861f715f5cceff93732473fe5cc9e32ed29ed0cd4ae0eb4b
+  metadata.gz: 5ad9eff7a7a99201eed5821aa897dd232733510cb088e074c56a31102329a751766498800ca62a62c5327d05797e976114e173a685acc35743c82c0ca644d0cc
+  data.tar.gz: f930c1ff617cdfb255771510a1eb3fd4588dc84c0f513f8d74900c62bb7c7680047238c7ba31345f6ddbb8154fef90467be179e32db3f899d76fb335141aaa95

data/lib/birdsong/tweet.rb

@@ -9,16 +9,13 @@ module Birdsong
       # Check that the ids are at least real ids
       ids.each { |id| raise Birdsong::InvalidIdError if !/\A\d+\z/.match(id) }
 
-      response = self.retrieve_data_v2(ids)
-      raise Birdsong::AuthorizationError, "Invalid response code #{response.code}" unless response.code == 200
+      response = ids.map { |id| self.retrieve_data_v1(id) }
 
-      json_response = JSON.parse(response.body)
+      json_response = response.map { |r| JSON.parse(r.body) }
       check_for_errors(json_response)
 
-      return [] if json_response["data"].nil?
-
-      json_response["data"].map do |json_tweet|
-        Tweet.new(json_tweet, json_response["includes"])
+      json_response.map do |json_tweet|
+        Tweet.new(json_tweet)
       end
     end
 
@@ -38,23 +35,21 @@ module Birdsong
 
   private
 
-    def initialize(json_tweet, includes)
+    def initialize(json_tweet)
       @json = json_tweet
-      parse(json_tweet, includes)
+      parse(json_tweet)
     end
 
-    def parse(json_tweet, includes)
-      @id = json_tweet["id"]
+    def parse(json_tweet)
+      @id = json_tweet["id"].to_s
       @created_at = DateTime.parse(json_tweet["created_at"])
-      @text = json_tweet["text"]
+      @text = json_tweet["full_text"]
       @language = json_tweet["lang"]
-      @author_id = json_tweet["author_id"]
+      @author_id = json_tweet["user"]["id"]
 
       # A sanity check to make sure we have media in there correctly
-      if includes.has_key? "media"
-        media_items = includes["media"].filter do |media_item|
-          json_tweet["attachments"]["media_keys"].include? media_item["media_key"]
-        end
+      if json_tweet["extended_entities"]&.has_key?("media")
+        media_items = json_tweet["extended_entities"]["media"]
       else
         media_items = []
       end
@@ -69,8 +64,8 @@ module Birdsong
 
         # If the media is video we need to fall back to V1 of the API since V2 doesn't support
         # videos yet. This is dumb, but not a big deal.
-        media_url = get_media_url_from_extended_entities
-        media_preview_url = get_media_preview_url_from_extended_entities
+        media_url = get_largest_variant_url(media_items)
+        media_preview_url = media_items.first["media_url_https"]
         @video_file_type = media_item["type"]
 
         # We're returning an array because, in the case that someday more videos are available our
@@ -80,23 +75,7 @@ module Birdsong
 
       # Look up the author given the new id.
       # NOTE: This doesn't *seem* like the right place for this, but I"m not sure where else
-      @author = User.lookup(@author_id).first
-    end
-
-    # Used to extract a GIF or video URL from the extended entities object in the Twiter API response
-    # Assumes (as is the case right now) that a Tweet cannot have more than one GIF/video
-    def get_media_url_from_extended_entities
-      response = Tweet.retrieve_data_v1(@id)
-      response = JSON.parse(response.body)
-      get_largest_variant_url(response["extended_entities"]["media"])
-    end
-
-    # Used to extract a GIF or video preview URL from the extended entities object in the Twiter API response
-    # Assumes (as is the case right now) that a Tweet cannot have more than one GIF/video
-    def get_media_preview_url_from_extended_entities
-      response = Tweet.retrieve_data_v1(@id)
-      response = JSON.parse(response.body)
-      response["extended_entities"]["media"].first["media_url_https"]
+      @author = User.lookup(@author_id.to_s).first
     end
 
     def get_largest_variant_url(media_items)
@@ -118,55 +97,6 @@ module Birdsong
       largest_bitrate_variant["url"]
     end
 
-    def self.retrieve_data_v2(ids)
-      bearer_token = Birdsong.twitter_bearer_token
-
-      tweet_lookup_url = "https://api.twitter.com/2/tweets"
-
-      # Specify the Tweet IDs that you want to lookup below (to 100 per request)
-      tweet_ids = ids.join(",")
-
-      # Add or remove optional parameters values from the params object below. Full list of parameters and their values can be found in the docs:
-      # https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference
-      params = {
-        "ids": tweet_ids,
-        "expansions": "attachments.media_keys,author_id,referenced_tweets.id",
-        "tweet.fields": Birdsong.tweet_fields,
-        "user.fields": Birdsong.user_fields,
-        "media.fields": "duration_ms,height,media_key,preview_image_url,public_metrics,type,url,width",
-        "place.fields": "country_code",
-        "poll.fields": "options"
-      }
-
-      response = tweet_lookup_v2(tweet_lookup_url, bearer_token, params)
-      raise Birdsong::AuthorizationError, "Invalid response code #{response.code}" unless response.code === 200
-
-      response
-    end
-
-    def self.tweet_lookup_v2(url, bearer_token, params)
-      options = {
-        method: "get",
-        headers: {
-          "User-Agent": "v2TweetLookupRuby",
-          "Authorization": "Bearer #{bearer_token}"
-        },
-        params: params
-      }
-
-      request = Typhoeus::Request.new(url, options)
-      response = request.run
-
-      raise Birdsong::RateLimitExceeded.new(
-        response.headers["x-rate-limit-limit"],
-        response.headers["x-rate-limit-remaining"],
-        response.headers["x-rate-limit-reset"]
-      ) if response.code === 429
-      raise Birdsong::AuthorizationError, "Invalid response code #{response.code}" unless response.code === 200
-
-      response
-    end
-
     # Note that unlike the V2 this only supports one url at a time
     def self.retrieve_data_v1(id)
       bearer_token = Birdsong.twitter_bearer_token
@@ -204,6 +134,16 @@ module Birdsong
         response.headers["x-rate-limit-remaining"],
         response.headers["x-rate-limit-reset"]
       ) if response.code === 429
+
+      raise Birdsong::NoTweetFoundError, "Tweet with id #{url} not found" if response.code === 404
+      if response.code === 403
+        json = JSON.parse(response.body)
+        if json.has_key?("errors")
+          json["errors"].each do |error|
+            raise Birdsong::NoTweetFoundError, "User with id #{url} suspended" if error["code"] == 63
+          end
+        end
+      end
       raise Birdsong::AuthorizationError, "Invalid response code #{response.code}" unless response.code === 200
 
       response
@@ -211,13 +151,15 @@ module Birdsong
 
 
     def self.check_for_errors(parsed_json)
-      return false unless parsed_json.key?("errors")
-      return false if parsed_json["errors"].empty?
-
-      parsed_json["errors"].each do |error|
-        # If the tweet is removed, or if the user is suspended you get an Authorization Error
-        if error["title"] == "Not Found Error" || error["title"] == "Authorization Error"
-          raise Birdsong::NoTweetFoundError, "Tweet with id #{error["value"]} not found"
+      parsed_json.each do |json|
+        next unless json.key?("errors")
+        next if json["errors"].empty?
+
+        json["errors"].each do |error|
+          # If the tweet is removed, or if the user is suspended you get an Authorization Error
+          if error["title"] == "Not Found Error" || error["title"] == "Authorization Error"
+            raise Birdsong::NoTweetFoundError, "Tweet with id #{error["value"]} not found"
+          end
         end
       end
       false

data/lib/birdsong/user.rb

@@ -43,9 +43,9 @@ module Birdsong
     end
 
     def parse(json_user)
-      @id = json_user["id"]
+      @id = json_user["id"].to_s
       @name = json_user["name"]
-      @username = json_user["username"]
+      @username = json_user["screen_name"]
       @created_at = DateTime.parse(json_user["created_at"])
       @location = json_user["location"]
 
@@ -55,52 +55,48 @@ module Birdsong
       @description = json_user["description"]
       @url = json_user["url"]
       @url = "https://www.twitter.com/#{@username}" if @url.nil?
-      @followers_count = json_user["public_metrics"]["followers_count"]
-      @following_count = json_user["public_metrics"]["following_count"]
-      @tweet_count = json_user["public_metrics"]["tweet_count"]
-      @listed_count = json_user["public_metrics"]["listed_count"]
-      @verified = json_user["verified"]
+
+      @followers_count = json_user["followers_count"]
+      @following_count = json_user["friends_count"]
+      @tweet_count = json_user["statuses_count"]
+      @listed_count = json_user["listed_count"]
+      @verified = json_user["verified"] # this will always be `false` but we're keeping it here for compatibility
       @profile_image_file_name = Birdsong.retrieve_media(@profile_image_url)
     end
 
-    def self.lookup_primative(usernames: nil, ids: nil)
-      raise Birdsong::InvalidIdError if usernames.nil? && ids.nil? # can't pass in nothing
-      raise Birdsong::InvalidIdError if usernames.nil? == false && ids.nil? == false # don't pass in both
-
-      response = self.retrieve_data(ids: ids, usernames: usernames)
+    def self.lookup_primative(usernames: [], ids: [])
+      raise Birdsong::InvalidIdError if usernames.empty? && ids.empty? # can't pass in nothing
 
-      raise Birdsong::AuthorizationError, "Invalid response code #{response.code}" unless response.code == 200
+      if usernames.empty? == false
+        response = usernames.map { |username| self.retrieve_data(username: username) }
+      elsif ids.empty? == false
+        response = ids.map { |id| self.retrieve_data(id: id) }
+      else
+        raise Birdsong::InvalidIdError
+      end
 
-      json_response = JSON.parse(response.body)
-      return [] if json_response["data"].nil?
+      json_response = response.map { |r| JSON.parse(r.body) }
 
-      json_response["data"].map do |json_user|
+      json_response.map do |json_user|
         User.new(json_user)
       end
     end
 
-    def self.retrieve_data(usernames: nil, ids: nil)
+    def self.retrieve_data(username: nil, id: nil)
       bearer_token = Birdsong.twitter_bearer_token
 
-      raise Birdsong::InvalidIdError if usernames.nil? && ids.nil? # can't pass in nothing
-      raise Birdsong::InvalidIdError if usernames.nil? == false && ids.nil? == false # don't pass in both
+      raise Birdsong::InvalidIdError if username.nil? && id.nil? # can't pass in nothing
+      raise Birdsong::InvalidIdError if username.nil? == false && id.nil? == false # don't pass in both
 
-      # Add or remove optional parameters values from the params object below. Full list of parameters and their values can be found in the docs:
-      # https://developer.twitter.com/en/docs/twitter-api/tweets/lookup/api-reference
-      params = {
-        "expansions": "pinned_tweet_id",
-        "tweet.fields": Birdsong.tweet_fields,
-        "user.fields": Birdsong.user_fields,
-      }
+      user_lookup_url = "https://api.twitter.com/1.1/users/show.json"
 
-      if usernames.nil? == false
-        user_lookup_url = "https://api.twitter.com/2/users/by"
+      params = {}
+      if username.nil? == false
         # Specify the Usernames that you want to lookup below (to 100 per request)
-        params["usernames"] = usernames.join(",")
-      elsif ids.nil? == false
-        user_lookup_url = "https://api.twitter.com/2/users"
+        params["screen_name"] = username
+      elsif id.nil? == false
         # Specify the User IDs that you want to lookup below (to 100 per request)
-        params["ids"] = ids.join(",")
+        params["user_id"] = id
       end
 
       response = self.user_lookup(user_lookup_url, bearer_token, params)
@@ -110,6 +106,7 @@ module Birdsong
         response.headers["x-rate-limit-remaining"],
         response.headers["x-rate-limit-reset"]
       ) if response.code === 429
+      raise Birdsong::NoTweetFoundError, "User with id #{id} or username #{username} not found" if response.code === 404
       raise Birdsong::AuthorizationError, "Invalid response code #{response.code}" unless response.code == 200
 
       response

data/lib/birdsong/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Birdsong
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: birdsong
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Christopher Guess
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-23 00:00:00.000000000 Z
+date: 2023-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -197,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
 summary: A gem to interface with Twitter's API V2