Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/robertodecurnex/twttr
Twitter API v2 Interface
https://github.com/robertodecurnex/twttr
Last synced: 3 months ago
JSON representation
Twitter API v2 Interface
- Host: GitHub
- URL: https://github.com/robertodecurnex/twttr
- Owner: robertodecurnex
- Created: 2021-12-21T15:37:38.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-04-24T10:12:18.000Z (7 months ago)
- Last Synced: 2024-05-13T07:33:34.403Z (6 months ago)
- Language: Ruby
- Size: 31.3 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Twttr
Twitter API v2 Interface
[](https://github.com/robertodecurnex/twttr/actions/workflows/test.yml)
[](https://rubygems.org/gems/twttr)
[](https://coveralls.io/github/robertodecurnex/twttr?branch=master)
[](https://codeclimate.com/github/robertodecurnex/twttr/maintainability)
-----
## Summery
Modular Twitter API interface, initially targeting Twitter API v2
## Examples
### Config
```ruby
# Creating a Client using OAuth 1.0a User context
client = Twttr::Client.new(user_id) do |config|
# App credentials
config.consumer_key = "consumer_key"
config.consumer_secret = "consumer_secret"
# User credentials
config.access_token = "access_token"
config.access_token_secret = "access_secret"
# Default user fields
# https://developer.twitter.com/en/docs/twitter-api/data-dictionary/object-model/user
config.user_fields = %w(id, name, username)
end #=> #
```
### Client
```ruby
# Twttr::Client#me
client.me #=> #
#Twttr::Client#user(:user_id)
client.user("user_id") #=> #
#Twttr::Client#user_by_username(:username)
client.user_by_username("username") #=> #
#Twttr::Client#users(:user_ids)
client.users(["user_id_1", "user_id_2"]) #=> [#]
# Twttr::Client#Followers
client.followers("user_id") == client.user("user_id").followers
# Twttr::Client#Following
client.following("user_id") == client.user("user_id").following
```
### User
```ruby
# Twttr::Model::User#followers
#
# Yields each page of users
user.followers do |users, pagination_token|
users #=> [#]
end #=> [#]
# Follower users
user.followers #=> [#]
# Twttr::Model::User#following
#
# Yields each page of users
user.following do |users, pagination_token|
users #=> [#]
end #=> [#]
# Followed users
user.following #=> [#]
```
## Implemented Endpoints
### Authentication
|Type |Initial Release |Implemented? |
|:--- |:---: |:---: |
|OAuth 1.0a |v0.0.5 |:white_check_mark: |
|OAuth 2.0 |- |- |
### Users
#### Users Lookup
|Endpoint |Initial Release |Implemented? |
|:--- |:---: |:---: |
|GET /2/users |v0.0.5 |:white_check_mark: |
|GET /2/users/:id |v0.0.5 |:white_check_mark: |
|GET /2/users/by |v0.0.6 |:white_check_mark: |
|GET /2/users/by/username/:username |v0.0.5 |:white_check_mark: |
|GET /2/users/me |v0.0.5 |:white_check_mark: |
#### Follows
|Endpoint |Initial Release |Implemented? |
|:--- |:---: |:---: |
|GET /2/users/:id/following |v0.0.5 |:white_check_mark: |
|GET /2/users/:id/followers |v0.0.6 |:white_check_mark: |
|POST /2/users/:id/following |- |- |
|DELETE /2/users/:source_user_id/following/:target_user_id |- |- |