omniauth-threads-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1c548d8814dc5e198659b2a8f855fbc1b3ff91bb722cf4bbba19c139c2c918b6
+  data.tar.gz: c4c5db3a7b70b3956a794aad0c81042e2e3db8f61f83b034e69219585394a150
+SHA512:
+  metadata.gz: 8be47623829b7776374574e56a7af563fa12162d07a4e6404bd3bd838b5f43119f87b5324a001a71a9e5e3d35cdb9c6ff4c20137fd5f3b6aa12811aa695581e8
+  data.tar.gz: 176d90df43bcd0d89aafe4836485000794d49ef2590cb90984e2915336228cf45d2d311d8dd9d9b36e1d14f76c9b986f3ea1453326f2e6931a439b99e2135e98

data/.standard.yml

@@ -0,0 +1 @@
+ruby_version: 3.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Giacomo Guiulfo Knell
+
+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,90 @@
+# Omniauth::ThreadsAPI
+
+[![Gem Version](https://badge.fury.io/rb/omniauth-threads-api.svg)](https://badge.fury.io/rb/omniauth-threads-api)
+[![Build Status](https://github.com/giacomoguiulfo/omniauth-threads-api/actions/workflows/main.yml/badge.svg)](https://github.com/giacomoguiulfo/omniauth-threads-api/actions)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
+
+An OmniAuth strategy for authenticating with the [Threads API](https://developers.facebook.com/docs/threads) via OAuth.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'omniauth-threads-api'
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+## Usage
+
+Here's an example of using it in a Rails application:
+
+```ruby
+# config/initializers/omniauth.rb
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :threads, ENV['THREADS_CLIENT_ID'], ENV['THREADS_CLIENT_SECRET']
+end
+```
+
+Make sure to set `THREADS_CLIENT_ID` and `THREADS_CLIENT_SECRET` environment variables to your actual credentials or use [Rails encrypted credentials](https://guides.rubyonrails.org/security.html#custom-credentials) (e.g. `Rails.application.credentials.threads`).
+
+
+## Scopes
+
+The default scope for this strategy is `threads_basic`. To add more scopes simply specify them after your credentials:
+
+```ruby
+# config/initializers/omniauth.rb
+Rails.application.config.middleware.use OmniAuth::Builder do
+  provider :threads, ENV['THREADS_CLIENT_ID'], ENV['THREADS_CLIENT_SECRET'],
+    scope: [
+        'threads_basic',
+        'threads_content_publish',
+        'threads_read_replies',
+        'threads_manage_replies',
+        'threads_manage_insights',
+    ].join(",")
+end
+```
+
+## Auth Hash
+
+This is an example of what the [Auth Hash](https://github.com/omniauth/omniauth/wiki/Auth-Hash-Schema) available in `request.env['omniauth.auth']` would look like:
+
+```ruby
+{
+  provider: 'threads',
+  uid: '123456789',
+  info: {
+    name: 'John Doe',
+    nickname: 'johndoe',
+    description: "I'm just a tech",
+    image: 'https://scontent-nrt1-1.cdninstagram.com/v/...',
+  },
+  credentials: {
+    token: 'qwertyuiopasdfghjklzxcvbnm',
+    expires: true,
+    expires_at: 1733097115,
+  },
+  extra: {
+    raw_info: {
+      id: "123456789",
+      name: "John Doe",
+      username: "johndoe":
+      threads_biography: "I'm just a tech",
+      threads_profile_picture_url: "https://scontent-nrt1-1.cdninstagram.com/v/..."
+    }
+  }
+}
+```
+
+The tokens stored in the `credentials` are last for 60 days and can be [refreshed](https://developers.facebook.com/docs/threads/get-started/long-lived-tokens).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/omniauth/strategies/threads.rb

@@ -0,0 +1,60 @@
+require "omniauth-oauth2"
+
+module OmniAuth
+  module Strategies
+    class Threads < OmniAuth::Strategies::OAuth2
+      DEFAULT_SCOPE = "threads_basic"
+      DEFAULT_FIELDS = "id,username,name,threads_profile_picture_url,threads_biography"
+
+      option :name, "threads"
+
+      option :client_options, {
+        site: "https://graph.threads.net/v1.0",
+        authorize_url: "https://threads.net/oauth/authorize",
+        token_url: "oauth/access_token"
+      }
+
+      option :scope, DEFAULT_SCOPE
+
+      uid { raw_info["id"] }
+
+      info do
+        {
+          name: raw_info["name"],
+          nickname: raw_info["username"],
+          description: raw_info["threads_biography"],
+          image: raw_info["threads_profile_picture_url"]
+        }
+      end
+
+      credentials do
+        {
+          token: long_lived_token.token,
+          expires_at: long_lived_token.expires_at,
+          expires: true
+        }
+      end
+
+      extra { {raw_info: raw_info} }
+
+      def token_params
+        super.tap do |params|
+          params[:client_id] = options.client_id
+          params[:client_secret] = options.client_secret
+        end
+      end
+
+      def callback_url
+        full_host + callback_path
+      end
+
+      def raw_info
+        @raw_info ||= long_lived_token.get("/me", params: {fields: DEFAULT_FIELDS}).parsed
+      end
+
+      def long_lived_token
+        @long_lived_token ||= ::OAuth2::AccessToken.from_hash(client, access_token.get("/access_token", params: {grant_type: "th_exchange_token", client_secret: options.client_secret, access_token: access_token.token}).parsed)
+      end
+    end
+  end
+end

data/lib/omniauth-threads-api/version.rb

@@ -0,0 +1,5 @@
+module OmniAuth
+  module ThreadsAPI
+    VERSION = "0.1.0"
+  end
+end

data/lib/omniauth-threads-api.rb

@@ -0,0 +1,2 @@
+require "omniauth-threads-api/version"
+require "omniauth/strategies/threads"

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: omniauth-threads-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Giacomo Guiulfo Knell
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: omniauth-oauth2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: An OmniAuth strategy for authenticating with the Threads API (https://developers.facebook.com/docs/threads/)
+email:
+- giaco@hey.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/omniauth-threads-api.rb
+- lib/omniauth-threads-api/version.rb
+- lib/omniauth/strategies/threads.rb
+homepage: https://github.com/giacomoguiulfo/omniauth-threads-api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/giacomoguiulfo/omniauth-threads-api
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: An OmniAuth strategy for the Threads API
+test_files: []