birdsong 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '03486db7a9efbfce2f7d423f25e33506332bad5a7ceb481da98e68c81b0a75fa'
+  data.tar.gz: 7a46972f68f413a3d3e0cb81b06ece6b9a3a8f9593be5a68664ce0364ab366ec
+SHA512:
+  metadata.gz: 68eb9d33bac12dc765b776ad32024992640b1363612f99b2cc0b500c6000fd3ef7351d8cc70218d2d21bb681ec40b233b24fdd7062694426891ce3fa22088e62
+  data.tar.gz: 8ceddb1eb88a57dec49116653f0be80be47d29d395894ea35a28aafa84eee72d5aa13deca419e569861f715f5cceff93732473fe5cc9e32ed29ed0cd4ae0eb4b

data/.github/workflows/main.yml

@@ -0,0 +1,22 @@
+name: Ruby
+
+on: [push,pull_request]
+
+
+jobs:
+  build:
+    environment: CI
+    runs-on: ubuntu-latest
+    env:
+      TWITTER_BEARER_TOKEN: '${{ secrets.TWITTER_BEARER_TOKEN }}'
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.1.2
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.14
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+.byebug_history

data/.rubocop.yml

@@ -0,0 +1,67 @@
+require:
+  - rubocop-rails
+
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+
+AllCops:
+  Exclude:
+    - db/schema.rb
+    - 'node_modules/**/*'
+    - 'redis-stable/**/*'
+    - 'bin/**/*'
+    - 'vendor/**/*'
+  TargetRubyVersion: 3.0
+
+# Rails generates this file
+Style/BlockComments:
+  Exclude:
+    - 'db/seeds.rb'
+
+# This sets us to use the standard Rails format instead of Rubocop's
+# opinionated Ruby style.
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# This sets us to use the standard Rails format instead of Rubocop's
+# opinionated Ruby style.
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+# Rails generates this file
+Layout/IndentationStyle:
+  Exclude:
+    - 'db/seeds.rb'
+
+# Temporarily turn this off
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Lint/RescueException:
+  Enabled: true
+
+Lint/Debugger:
+  Enabled: true
+
+Rails/HasManyOrHasOneDependent:
+  Enabled: true
+
+Rails/HasAndBelongsToMany:
+  Enabled: true
+
+Style/NumericPredicate:
+  Enabled: true
+
+# This sets us to use the standard Rails format instead of Rubocop's
+# opinionated Ruby style.
+Layout/EmptyLinesAroundAccessModifier:
+  Enabled: true
+  EnforcedStyle: 'around'
+
+# We're not a Rails app, just using their style sheet
+Rails/AssertNot:
+  Enabled: false

data/.ruby-version

@@ -0,0 +1 @@
+3.1.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-04-27
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at cguess@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in birdsong.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,133 @@
+PATH
+  remote: .
+  specs:
+    birdsong (0.1.0)
+      oauth (~> 0.5.6)
+      typhoeus (~> 1.4.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.1)
+      actionview (= 7.0.1)
+      activesupport (= 7.0.1)
+      rack (~> 2.0, >= 2.2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (7.0.1)
+      activesupport (= 7.0.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (7.0.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    byebug (11.1.3)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    dotenv (2.7.6)
+    erubi (1.10.0)
+    ethon (0.15.0)
+      ffi (>= 1.15.0)
+    ffi (1.15.5)
+    i18n (1.9.1)
+      concurrent-ruby (~> 1.0)
+    loofah (2.13.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.15.0)
+    nokogiri (1.13.1-arm64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.1-x86_64-darwin)
+      racc (~> 1.4)
+    nokogiri (1.13.1-x86_64-linux)
+      racc (~> 1.4)
+    oauth (0.5.8)
+    parallel (1.21.0)
+    parser (3.1.0.0)
+      ast (~> 2.4.1)
+    racc (1.6.0)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (7.0.1)
+      actionpack (= 7.0.1)
+      activesupport (= 7.0.1)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
+    rubocop (1.25.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.15.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    rubocop-minitest (0.17.1)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-packaging (0.5.1)
+      rubocop (>= 0.89, < 2.0)
+    rubocop-performance (1.13.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rails (2.9.1)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 0.90.0, < 2.0)
+    rubocop-rails_config (1.8.1)
+      railties (>= 5.0)
+      rubocop (>= 1.19)
+      rubocop-ast (>= 1.0.1)
+      rubocop-minitest (~> 0.15)
+      rubocop-packaging (~> 0.5)
+      rubocop-performance (~> 1.11)
+      rubocop-rails (~> 2.0)
+    ruby-progressbar (1.11.0)
+    thor (1.2.1)
+    typhoeus (1.4.0)
+      ethon (>= 0.9.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.1.0)
+    zeitwerk (2.5.4)
+
+PLATFORMS
+  arm64-darwin-21
+  arm64-darwin-22
+  x86_64-darwin-20
+  x86_64-linux
+
+DEPENDENCIES
+  birdsong!
+  byebug
+  dotenv
+  minitest
+  rake
+  rubocop
+  rubocop-performance
+  rubocop-rails
+  rubocop-rails_config
+
+BUNDLED WITH
+   2.3.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Christopher Guess
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,43 @@
+# Birdsong
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/birdsong`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'birdsong'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install birdsong
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/birdsong. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/birdsong/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Birdsong project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/birdsong/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "birdsong"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/birdsong.gemspec

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "lib/birdsong/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "birdsong"
+  spec.version       = Birdsong::VERSION
+  spec.authors       = ["Christopher Guess"]
+  spec.email         = ["cguess@gmail.com"]
+
+  spec.summary       = "A gem to interface with Twitter's API V2"
+  # spec.description   = "TODO: Write a longer description or delete this line."
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Prod dependencies
+  spec.add_dependency "typhoeus", "~> 1.4.0"
+  spec.add_dependency "oauth", "~> 0.5.6"
+
+  # Dev dependencies
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-rails"
+  spec.add_development_dependency "rubocop-rails_config"
+  spec.add_development_dependency "rubocop-performance"
+  spec.add_development_dependency "dotenv"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/birdsong/tweet.rb

@@ -0,0 +1,226 @@
+# frozen_string_literal: true
+
+module Birdsong
+  class Tweet
+    def self.lookup(ids = [])
+      # If a single id is passed in we make it the appropriate array
+      ids = [ids] unless ids.kind_of?(Array)
+
+      # 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
+
+      json_response = JSON.parse(response.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"])
+      end
+    end
+
+    # Attributes for after the response is parsed from Twitter
+    attr_reader :json
+    attr_reader :id
+    attr_reader :created_at
+    attr_reader :text
+    attr_reader :language
+    attr_reader :author_id
+    attr_reader :author
+    attr_reader :image_file_names
+    attr_reader :video_file_names
+    attr_reader :video_file_type
+
+    alias_method :user, :author # Every other gem uses `user` so we can just alias it
+
+  private
+
+    def initialize(json_tweet, includes)
+      @json = json_tweet
+      parse(json_tweet, includes)
+    end
+
+    def parse(json_tweet, includes)
+      @id = json_tweet["id"]
+      @created_at = DateTime.parse(json_tweet["created_at"])
+      @text = json_tweet["text"]
+      @language = json_tweet["lang"]
+      @author_id = json_tweet["author_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
+      else
+        media_items = []
+      end
+
+      @image_file_names = media_items.filter_map do |media_item|
+        next unless media_item["type"] == "photo"
+        Birdsong.retrieve_media(media_item["url"])
+      end
+
+      @video_file_names = media_items.filter_map do |media_item|
+        next unless (media_item["type"] == "video") || (media_item["type"] == "animated_gif")
+
+        # 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
+        @video_file_type = media_item["type"]
+
+        # We're returning an array because, in the case that someday more videos are available our
+        # implementations won't breaks
+        [{ url: Birdsong.retrieve_media(media_url), preview_url: Birdsong.retrieve_media(media_preview_url) }]
+      end
+
+      # 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"]
+    end
+
+    def get_largest_variant_url(media_items)
+      # The API response is pretty deeply nested, but this handles that structure
+      largest_bitrate_variant = nil
+      media_items.each do |media_item|
+        # The API returns multiple different resolutions usually. Since we only want to archive
+        # the largest we'll run through and find it
+        media_item["video_info"]["variants"].each do |variant|
+          # Usually there's constant bitrate variants, and sometimes, a .m3u playlist which is for
+          # streaming. We want to ignore that one here.
+          next unless variant&.keys.include?("bitrate")
+
+          if largest_bitrate_variant.nil? || largest_bitrate_variant["bitrate"] < variant["bitrate"]
+            largest_bitrate_variant = variant
+          end
+        end
+      end
+      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
+
+      tweet_lookup_url = "https://api.twitter.com/1.1/statuses/show.json?tweet_mode=extended&id=#{id}"
+
+      response = tweet_lookup_v1(tweet_lookup_url, bearer_token)
+      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
+
+    # V2 of the Twitter API (which we use everywhere else) doesn't include videos or gifs yet,
+    # so we have to fall back to V1.
+    #
+    # There's a tracker for this at https://twittercommunity.com/t/where-would-i-find-the-direct-link-to-an-mp4-video-posted-in-v2/146933/2
+    def self.tweet_lookup_v1(url, bearer_token)
+      options = {
+        method: "get",
+        headers: {
+          "Authorization": "Bearer #{bearer_token}"
+        }
+      }
+
+      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
+
+
+    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"
+        end
+      end
+      false
+    end
+  end
+end

data/lib/birdsong/user.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Birdsong
+  class User
+    def self.lookup(ids = [])
+      # If a single id is passed in we make it the appropriate array
+      ids = [ids] unless ids.kind_of?(Array)
+
+      # Check that the ids are at least real ids
+      ids.each { |id| raise Birdsong::InvalidIdError if !/\A\d+\z/.match(id) }
+      self.lookup_primative(ids: ids)
+    end
+
+    def self.lookup_by_usernames(usernames = [])
+      # If a single id is passed in we make it the appropriate array
+      usernames = [usernames] unless usernames.kind_of?(Array)
+      self.lookup_primative(usernames: usernames)
+    end
+
+    # Attributes for after the response is parsed from Twitter
+    attr_reader :json
+    attr_reader :id
+    attr_reader :name
+    attr_reader :username
+    attr_reader :sign_up_date
+    attr_reader :location
+    attr_reader :profile_image_url
+    attr_reader :description
+    attr_reader :url
+    attr_reader :followers_count
+    attr_reader :following_count
+    attr_reader :tweet_count
+    attr_reader :listed_count
+    attr_reader :verified
+    attr_reader :created_at
+    attr_reader :profile_image_file_name
+
+  private
+
+    def initialize(json_user)
+      @json = json_user
+      parse(json_user)
+    end
+
+    def parse(json_user)
+      @id = json_user["id"]
+      @name = json_user["name"]
+      @username = json_user["username"]
+      @created_at = DateTime.parse(json_user["created_at"])
+      @location = json_user["location"]
+
+      # Removing the "normal" here gets us the full-sized image, instead of the 150x150 thumbnail
+      @profile_image_url = json_user["profile_image_url"].sub!("_normal", "")
+
+      @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"]
+      @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)
+
+      raise Birdsong::AuthorizationError, "Invalid response code #{response.code}" unless response.code == 200
+
+      json_response = JSON.parse(response.body)
+      return [] if json_response["data"].nil?
+
+      json_response["data"].map do |json_user|
+        User.new(json_user)
+      end
+    end
+
+    def self.retrieve_data(usernames: nil, ids: 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
+
+      # 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,
+      }
+
+      if usernames.nil? == false
+        user_lookup_url = "https://api.twitter.com/2/users/by"
+        # 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"
+        # Specify the User IDs that you want to lookup below (to 100 per request)
+        params["ids"] = ids.join(",")
+      end
+
+      response = self.user_lookup(user_lookup_url, bearer_token, params)
+
+      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
+
+    def self.user_lookup(url, bearer_token, params)
+      options = {
+        method: "get",
+        headers: {
+          "User-Agent": "v2UserLookupRuby",
+          "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
+  end
+end

data/lib/birdsong/version.rb

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

data/lib/birdsong.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "json"
+require "typhoeus"
+require "date"
+require "securerandom"
+require "helpers/configuration"
+require "fileutils"
+
+require_relative "birdsong/version"
+require_relative "birdsong/tweet"
+require_relative "birdsong/user"
+
+module Birdsong
+  extend Configuration
+
+  class Error < StandardError; end
+  class AuthorizationError < Error; end
+  class InvalidIdError < Error; end
+  class InvalidMediaTypeError < Error; end
+  class NoTweetFoundError < Error; end
+  class RateLimitExceeded < Error
+    attr_reader :rate_limit
+    attr_reader :rate_remaining
+    attr_reader :reset_time_left
+
+    def initialize(rate_limit, rate_remaining, reset_time)
+      @rate_limit = rate_limit
+      @rate_remaining = rate_remaining
+      @reset_time_left = reset_time.to_i - Time.now.to_i
+
+      super("Rate Limit Exceeded: Limit #{rate_limit}, Remaining #{rate_remaining}, Time Left #{reset_time_left}")
+    end
+  end
+
+  define_setting :temp_storage_location, "tmp/birdsong"
+  define_setting :twitter_bearer_token, ENV["TWITTER_BEARER_TOKEN"]
+  define_setting :save_media, true
+
+  # The general fields to always return for Users
+  def self.user_fields
+    "name,created_at,location,profile_image_url,protected,public_metrics,url,username,verified,withheld,description"
+  end
+
+  # The general fields to always return for Tweets
+  def self.tweet_fields
+    "attachments,author_id,conversation_id,created_at,entities,geo,id,in_reply_to_user_id,lang"
+  end
+
+  # Get media from a URL and save to a temp folder set in the configuration under
+  # temp_storage_location
+  def self.retrieve_media(url)
+    return "" if !Birdsong.save_media
+
+    response = Typhoeus.get(url)
+
+    # Get the file extension if it's in the file
+    extension = url.split(".").last
+
+    # Do some basic checks so we just empty out if there's something weird in the file extension
+    # that could do some harm.
+    if extension.length.positive?
+      extension = extension[0...extension.index("?")]
+      extension = nil unless /^[a-zA-Z0-9]+$/.match?(extension)
+      extension = ".#{extension}" unless extension.nil?
+    end
+
+    temp_file_name = "#{Birdsong.temp_storage_location}/#{SecureRandom.uuid}#{extension}"
+
+    # We do this in case the folder isn't created yet, since it's a temp folder we'll just do so
+    self.create_temp_storage_location
+    File.binwrite(temp_file_name, response.body)
+    temp_file_name
+  end
+
+private
+
+  def self.create_temp_storage_location
+    return if File.exist?(Birdsong.temp_storage_location) && File.directory?(Birdsong.temp_storage_location)
+    FileUtils.mkdir_p Birdsong.temp_storage_location
+  end
+end

data/lib/generators/birdsong.rb

@@ -0,0 +1,3 @@
+Birdsong.configuration do |config|
+  config.temp_storage_location = "tmp/birdsong"
+end

data/lib/generators/birdsong_generator.rb

@@ -0,0 +1,6 @@
+class BirdsongGenerator < Rails::Generators::Base
+  source_root(File.expand_path(File.dirname(__FILE__)))
+  def copy_initializer
+    copy_file "birdsong.rb", "config/initializers/birdsong.rb"
+  end
+end

data/lib/helpers/configuration.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# Borrowed with thanks from https://www.viget.com/articles/easy-gem-configuration-variables-with-defaults/
+module Configuration
+  def configuration
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+
+ private
+
+   def define_class_method(name, &block)
+     (class << self; self; end).instance_eval do
+       define_method name, &block
+     end
+   end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: birdsong
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Christopher Guess
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.6
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- cguess@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- birdsong.gemspec
+- lib/birdsong.rb
+- lib/birdsong/tweet.rb
+- lib/birdsong/user.rb
+- lib/birdsong/version.rb
+- lib/generators/birdsong.rb
+- lib/generators/birdsong_generator.rb
+- lib/helpers/configuration.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: A gem to interface with Twitter's API V2
+test_files: []