twitter_labs_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b280e642f8468d372684da3c0a04ce2effffd652b244e53a50e1925ade66d3fc
+  data.tar.gz: e1f1513a92468bc7fdb3e538bbc70b44ab15be2251f203485258f701b8c6b629
+SHA512:
+  metadata.gz: 7166032d4689b43fd696fc5f627dfe00af89eec532b3f36a652d6b22d3c74732c75b60e36be3a18caa9683b68c3b4629abad0d9319985ad56ef01ee19264ad94
+  data.tar.gz: 259cb764a4c6f15ed5efb335bc46da7117fa447da3c19fd7754e931e40616bd2464847b547a9a17a7d5094f43195f717f196da6733ec47bfbf7d9c8470aa3e19

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.1.0 - 5 March 2020
+
+Initial gem commit

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'activesupport'
+gem 'httplog'

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    twitter_labs_api (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
+    concurrent-ruby (1.1.6)
+    httplog (1.3.2)
+      rack (>= 1.0)
+      rainbow (>= 2.0.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    minitest (5.14.0)
+    rack (2.2.2)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.9)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport
+  bundler (~> 2.0)
+  httplog
+  rake (~> 10.0)
+  twitter_labs_api!
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 tomholford
+
+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,51 @@
+# twitter-labs-api
+
+A basic implementation of a Twitter Labs API client in Ruby. This project uses the v2 endpoints announced [here](https://twittercommunity.com/t/releasing-a-new-version-of-labs-endpoints/134219/3).
+
+## 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.
+
+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.
+
+### Example
+
+```ruby
+requre `labs_api`
+
+api = TwitterLabsAPI.new(bearer_token: 'YOUR-BEARER-TOKEN')
+
+api.get_tweet(id: '1234671272602193920')
+
+>> {"data"=>{"author_id"=>"44196397", "created_at"=>"2020-03-03T02:45:45.000Z", "id"=>"1234671272602193920", "lang"=>"und", "public_metrics"=>{"retweet_count"=>4534, "reply_count"=>1036, "like_count"=>43489, "quote_count"=>224}, "text"=>"✌️ bro https://t.co/nJ7CUyhr2j"}}
+```
+
+### Status
+Currently, the following endpoints are implemented:
+
+- `TwitterLabsAPI#get_tweet` - Retrieve a single Tweet object with an `id`
+- `TwitterLabsAPI#get_tweets` - Retrieve multiple Tweets with a collection of `ids`
+- `TwitterLabsAPI#get_user`, - Retrieve a single user object with an `id`
+- `TwitterLabsAPI#get_users`, - Retrieve multiple user objects with a collection of `ids`
+
+## Roadmap
+
+Since this project is initially driven by my own usage of the API, I will focus on implementing and refinining 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 :)
+
+## Dependencies
+
+This lib uses Ruby's built-in `URI` and `net/http` libs to communicate with Twitter's Labs API.
+
+For ease of manipulating responses, this lib depends on `Hash::WithIndifferentAccess` from the Rails `activesupport` project ([docs](https://api.rubyonrails.org/classes/ActiveSupport/HashWithIndifferentAccess.html)).
+
+Thus, one can access the data from a response like so:
+```ruby
+response = api.get_tweet(id: '1234671272602193920')
+
+puts response[:data][:public_metrics][:like_count]
+>> 43489
+
+puts response['data']['public_metrics']['like_count']
+>> 43489
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'twitter_labs_api'
+require 'irb'
+
+token = File.open(File.expand_path('~/.secrets/twitter/test.token', __dir__)).read.strip
+api = TwitterLabsAPI.new(bearer_token: token, debug: true)
+
+binding.irb

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/lib/twitter_labs_api.rb

@@ -0,0 +1,92 @@
+require 'json'
+require 'net/http'
+require 'uri'
+require 'active_support/core_ext/hash/indifferent_access'
+
+DEFAULT_TWEET_FIELDS = %w[id author_id created_at lang public_metrics].join(',').freeze
+DEFAULT_USER_FIELDS = %w[name username].join(',').freeze
+
+class TwitterLabsAPIError < StandardError; end
+
+class TwitterLabsAPI
+  attr_accessor :bearer_token, :debug
+
+  def initialize(bearer_token:, debug: false)
+    @bearer_token = bearer_token
+    @debug = debug
+    require 'httplog' if debug
+  end
+
+  def get_tweet(id:, tweet_fields: DEFAULT_TWEET_FIELDS)
+    url = "https://api.twitter.com/labs/2/tweets/#{id}"
+    params = {
+      'tweet.fields' => tweet_fields
+    }.compact
+
+    make_request(url: url, params: params)
+  end
+
+  def get_tweets(ids:, tweet_fields: DEFAULT_TWEET_FIELDS)
+    url = 'https://api.twitter.com/labs/2/tweets'
+    params = {
+      'ids' => ids.join(','),
+      'tweet.fields' => tweet_fields
+    }.compact
+
+    make_request(url: url, params: params, is_collection: true)
+  end
+
+  def get_user(id:, user_fields: DEFAULT_USER_FIELDS)
+    url = "https://api.twitter.com/labs/2/users/#{id}"
+    params = {
+      'user.fields' => user_fields
+    }.compact
+
+    make_request(url: url, params: params)
+  end
+
+  def get_users(ids:, user_fields: DEFAULT_USER_FIELDS)
+    url = 'https://api.twitter.com/labs/2/users'
+    params = {
+      'ids' => ids.join(','),
+      'user.fields' => user_fields
+    }.compact
+
+    make_request(url: url, params: params, is_collection: true)
+  end
+
+  private
+
+  def make_request(url:, params: {}, is_collection: false)
+    uri = URI.parse(url)
+    uri.query = URI.encode_www_form(params)
+    request = Net::HTTP::Get.new(uri)
+    request['Authorization'] = "Bearer #{bearer_token}"
+    req_options = { use_ssl: uri.scheme == 'https' }
+
+    response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+      http.request(request)
+    end
+
+    is_collection ? handle_collection(response) : handle_single(response)
+  end
+
+  # TODO: handle non-api errs (e.g., timeouts)
+  def handle_single(response)
+    return JSON.parse(response.body)['data'].with_indifferent_access if response.is_a?(Net::HTTPSuccess)
+
+    handle_api_error(response)
+  end
+
+  def handle_collection(response)
+    return JSON.parse(response.body)['data'].map(&:with_indifferent_access) if response.is_a?(Net::HTTPSuccess)
+
+    handle_api_error(response)
+  end
+
+  def handle_api_error(response)
+    error = JSON.parse(response.body)
+
+    raise TwitterLabsAPIError, "#{error['title']}: #{error['detail']} #{error['type']}"
+  end
+end

data/lib/twitter_labs_api/version.rb

@@ -0,0 +1,3 @@
+class TwitterLabsAPI
+  VERSION = '0.1.0'.freeze
+end

data/twitter-labs-api.gemspec

@@ -0,0 +1,30 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'twitter_labs_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'twitter_labs_api'
+  spec.version       = TwitterLabsAPI::VERSION
+  spec.authors       = ['tomholford']
+  spec.email         = ['tomholford@users.noreply.github.com']
+
+  spec.summary       = 'A basic implementation of a Twitter Labs API client in Ruby'
+  spec.homepage      = 'https://github.com/tomholford/twitter-labs-api'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/tomholford/twitter-labs-api'
+  spec.metadata['changelog_uri'] = 'https://github.com/tomholford/twitter-labs-api/blob/master/CHANGELOG.md'
+
+  # 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('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: twitter_labs_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tomholford
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- tomholford@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/twitter_labs_api.rb
+- lib/twitter_labs_api/version.rb
+- twitter-labs-api.gemspec
+homepage: https://github.com/tomholford/twitter-labs-api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tomholford/twitter-labs-api
+  source_code_uri: https://github.com/tomholford/twitter-labs-api
+  changelog_uri: https://github.com/tomholford/twitter-labs-api/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: A basic implementation of a Twitter Labs API client in Ruby
+test_files: []