threads-api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7bc7d9996e4a119f65407f455788ff761710855ceb5e8d01eae7853a0d5c8022
-  data.tar.gz: d13d7280d9f19a53cc3acca6d58bb7871e5f1faa5e93767adfb4e3a2f8a9a83c
+  metadata.gz: 422f4c1e70e0a2d5402d70646e6afd8fc095ff070b65e59f0acbf0afe4e66127
+  data.tar.gz: 421de26fc580b70c9bb76b4ef08adf040c97f94e92a7666acde6c42cbf9b1098
 SHA512:
-  metadata.gz: a51396bdc11e60e5a853a1a04bbce0cf35ba3b4a1685ce81da34a8e230c1b5f647dd4f27dc2bf0985e835d6ff75db9c68c926c73d46c197feef55096b1555672
-  data.tar.gz: 580e44a8a236e33b4489e55db83b58d04d5a2450639bda7960c24ee55ef9db5fdfdab1f60352af504b215cae499c688cdb80e45c6dfc829b8c83a073ed8df7fa
+  metadata.gz: 56d8bc23aa227e36406e1446159b13ea22317ea763dadb22aa25e07b17d7ae40eed568b16c614544035d33be72bb747af512a9ede63ad7fe4a03955fe7aab894
+  data.tar.gz: 6d1350e527061f18955d7cf4744a97e27ca5fcf65b3fc9515bdce8d7a18fe65e59f400a950e1023f251b295c8d2e68d986b6193e257a235e89d960c01c8316c9

data/README.md

@@ -76,7 +76,7 @@ thread = client.get_thread("18050206876707110", user_id: "7770386109746442")
 `Threads::API::Client#list_threads` accepts the following options:
 
 * `user_id` - The ID of the user whose threads you want to read. Defaults to `"me"`, the authenticated user.
-* `fields` - An Array (or comma-separated String) of fields to include in the response. By default, only `id` is requested. See the [Threads API documentation](https://developers.facebook.com/docs/threads/threads-media#fields) for a list of available fields.
+* `fields` - An Array (or comma-separated String) of fields to include in the response. By default, all documented fields are requested. See the [Threads API documentation](https://developers.facebook.com/docs/threads/threads-media#fields) for a list of available fields.
 * `since` - An ISO 8601 date string. Only threads published after this date will be returned.
 * `until` - An ISO 8601 date string. Only threads published before this date will be returned.
 * `before` - A cursor string returned by a previous request for pagination.
@@ -85,6 +85,16 @@ thread = client.get_thread("18050206876707110", user_id: "7770386109746442")
 
 `Threads::API::Client#get_thread` accepts only the `user_id` and `fields` options.
 
+## Reading profiles
+
+To get a user's profile:
+
+```ruby
+profile = client.get_profile("7770386109746442")
+```
+
+`Threads::API::Client#get_profile` accepts a `fields` option, which is an Array (or comma-separated String) of fields to include in the response. By default, all documented fields are requested. See the [Threads API documentation](https://developers.facebook.com/docs/threads/threads-profiles#fields) for a list of available fields.
+
 ## Posting to Threads
 
 Posting to Threads is, at the very least, a two-step process. Threads requires that you first create a container for the media you want to post, then explicitly publishing that container as a thread. However, more steps are involved if you want to post multiple media items in a single thread.

data/lib/threads/api/client.rb

@@ -1,17 +1,49 @@
+require_relative "profile"
 require_relative "thread"
 
 module Threads
   module API
     class Client
+      PROFILE_FIELDS = %w[id username threads_profile_picture_url threads_biography]
+      POST_FIELDS = %w[
+        id
+        media_product_type
+        media_type
+        media_url
+        permalink
+        owner
+        username
+        text
+        timestamp
+        shortcode
+        thumbnail_url
+        children
+        is_quote_post
+      ]
+
       def initialize(access_token)
         @access_token = access_token
       end
 
+      def get_profile(user_id = "me", fields: PROFILE_FIELDS)
+        params = {access_token: @access_token}
+        params[:fields] = Array(fields).join(",") if fields
+
+        response = connection.get(user_id, params)
+
+        Threads::API::Profile.new(response.body)
+      end
+
       def list_threads(user_id: "me", **options)
         params = options.slice(:since, :until, :before, :after, :limit).compact
         params[:access_token] = @access_token
 
-        fields = Array(options[:fields]).join(",")
+        fields = if options.key?(:fields)
+          Array(options[:fields]).join(",")
+        else
+          POST_FIELDS.join(",")
+        end
+
         params[:fields] = fields unless fields.empty?
 
         response = connection.get("#{user_id}/threads", params)
@@ -19,7 +51,7 @@ module Threads
         Threads::API::Thread::List.new(response.body)
       end
 
-      def get_thread(thread_id, fields: nil)
+      def get_thread(thread_id, fields: POST_FIELDS)
         params = {access_token: @access_token}
         params[:fields] = Array(fields).join(",") if fields
 
@@ -75,9 +107,11 @@ module Threads
         Threads::API::UnpublishedThread.new(response.body)
       end
 
-      def create_carousel_thread(children:, text: nil)
+      def create_carousel_thread(children:, text: nil, reply_to_id: nil, reply_control: nil)
         params = {access_token: @access_token, media_type: "CAROUSEL", text: text}
         params[:children] = Array(children).join(",")
+        params[:reply_to_id] = reply_to_id if reply_to_id
+        params[:reply_control] = reply_control if reply_control
 
         raise ArgumentError, "At least one item must be present in the `:children` option" if params[:children].empty?
 

data/lib/threads/api/profile.rb

@@ -0,0 +1,18 @@
+require "time"
+
+module Threads
+  module API
+    class Profile
+      attr_reader :id, :username, :profile_picture_url, :biography
+
+      def initialize(json)
+        @id = json["id"]
+        @username = json["username"]
+        @profile_picture_url = json["profile_picture_url"]
+        @biography = json["biography"]
+      end
+
+      alias_method :bio, :biography
+    end
+  end
+end

data/lib/threads/api/version.rb

@@ -2,6 +2,6 @@
 
 module Threads
   module API
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: threads-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - David Celis
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-19 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -39,6 +39,7 @@ files:
 - lib/threads/api.rb
 - lib/threads/api/client.rb
 - lib/threads/api/oauth2/client.rb
+- lib/threads/api/profile.rb
 - lib/threads/api/thread.rb
 - lib/threads/api/version.rb
 homepage: https://github.com/davidcelis/threads-api