Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dereknguyen269/threads_client_ruby
Unofficial, Reverse-Engineered Ruby client for Meta's Threads. Supports Read and Write.
https://github.com/dereknguyen269/threads_client_ruby
instagram instagram-api meta ruby ruby-gem threads threads-bridge threads-client threads-client-ruby
Last synced: 2 months ago
JSON representation
Unofficial, Reverse-Engineered Ruby client for Meta's Threads. Supports Read and Write.
- Host: GitHub
- URL: https://github.com/dereknguyen269/threads_client_ruby
- Owner: dereknguyen269
- License: mit
- Created: 2023-07-11T10:57:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-07-12T14:35:07.000Z (over 1 year ago)
- Last Synced: 2024-10-03T05:21:08.644Z (3 months ago)
- Topics: instagram, instagram-api, meta, ruby, ruby-gem, threads, threads-bridge, threads-client, threads-client-ruby
- Language: Ruby
- Homepage: https://rubygems.org/gems/threads_client_ruby
- Size: 416 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# [
](https://github.com/dereknguyen269) Threads Client Ruby
> Unofficial, Reverse-Engineered Ruby client for Meta's [Threads](https://threads.net).
# Getting Started
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'threads_client_ruby'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install threads_client_ruby
## Usage
#### 🌀 Config Threads
Using **username** and **password** (first time)
```ruby
credentials = {
username: "Instagram's username",
password: "Instagram's password"
}
ThreadsClientRuby.config do |config|
config.credentials = credentials
end
```
Using **usertoken** and **userid** (get from [here](#🤖-get-usertoken-and-userid))
```ruby
credentials = {
usertoken: "token received after login successfull",
userid: "Instagram's user id"
}
ThreadsClientRuby.config do |config|
config.credentials = credentials
end
```
>💡 TIP: Using **usertoken** and **userid** to avoid Theard rate limit and decrease response time.
#### 🤖 Get usertoken and userid
```ruby
userinfo = ThreadsClientRuby.get_userinfo
# {
# :usertoken=> "eyJkc191c2VyX2lkIjoiNTgzOTIyMTY....",
# :userid=>"583922..."
# }
```
#### 📌 Features
- [x] ✅ [Text Threads](#✨-threads-with-image)
- [x] ✅ [Threads with Image](#✨-threads-with-image)
- [x] ✅ [Threads with Link Attachment](#✨-threads-with-link-attachment)
- [x] ✅ [Get Post Id From URL](#✨-get-post-id-from-url)
- [x] ✅ [Reply to Other Threads](#✨-reply-to-other-threads)
- [ ] ✅ [Like/Unlike a Thread](#✨-likeunlike-a-thread)
- [ ] ✅ [Follow/Unfollow a User](#✨-followunfollow-a-user)
- [ ] ✅ [Delete a Post](#✨-delete-a-post)
**✨ Text Threads**
```ruby
ThreadsClientRuby.publish(text: 'Hello World!')
```
###### ✨ Threads with Image
```ruby
# Online image path
ThreadsClientRuby.publish(text: 'Hello World!', image: 'https://fastly.picsum.photos/id/654/536/354.jpg?hmac=Nqd_oi3EIiPJBAVPYhIUjaEvKpRqLjhtTHkxPmjjo7M')
# Or with local image path
ThreadsClientRuby.publish(text: 'Hello World!', image: '/Users/local-path/logo.jpg')
```
###### ✨ Threads with Link Attachment
```ruby
ThreadsClientRuby.publish(url: 'https://github.com/dereknguyen269/threads_client_ruby')
```
###### ✨ Get Post Id From URL
```ruby
post_id = ThreadsClientRuby.get_post_id('https://www.threads.net/t/CugF-EjhQ3r')
# => 3143538795635609067
```
###### ✨ Reply to Other Threads
```ruby
ThreadsClientRuby.publish(reply_id: post_id, text: "Reply to #{post_id}")
```
###### ✨ Like/Unlike a Thread
###### ✨ Follow/Unfollow a User
###### ✨ Delete a Post
## Development
After checking out the repo, run `bin/setup` to install dependencies. 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]/threads_client_ruby. 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]/threads_client_ruby/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 ThreadsClientRuby project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/threads_client_ruby/blob/master/CODE_OF_CONDUCT.md).