socialstats-ruby-sdk 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9913c6eb0102ad42654410100eb2a33fe967ee4d99d0e831b9d34e34b7a02c95
-  data.tar.gz: 6585f4e2b0bae1eee06e6e8a6aba82124efb9f10495f92a00fc8635f2055f707
+  metadata.gz: 9110554befa10042946b632009958a70d7a5829342e7fff405422e12b66c1a1b
+  data.tar.gz: 38bb25ee6c5a81a18f8156578212d0bbb09464d150cc5246ca31ec6d4361472d
 SHA512:
-  metadata.gz: ca3e3dc6d29ac228a25383015048592efed8a66591e864670cd967f4e16ab340c639552b4c39c53b9250199ec6ff4b9ba401de8f470fcd4368d8a5b33adf869c
-  data.tar.gz: df8cf7c971eec6f6225d6ae5a4dd896a9256e7ace3fef6e75654f7cee6a5aba8b186157758421f916e04f7c9dbbb31fe550ea1d514797b17b02ee9fc4cd910f2
+  metadata.gz: 9baa01b98d81eb46e5dd335f8772a4752489cd059ac1fe68aef98b8739682bea5dd84b4539bc11749e8e540cc890538c0cb95e421f7a65ff893e550cfdd8f075
+  data.tar.gz: 4a1def55dfbe45ba7122792a64ab75768679440ae16ec15104419464e3a012e87168f09c2e94eb3ad1683e6798e583308210727d1cb0153e758e9e3ab32a9d04

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project are documented in this file.
 
+## [0.2.0] - 2026-09-08
+
+### Added
+
+- OAuth authorization lifecycle resource coverage
+- Authorized creator and post resource methods
+- Platform-specific creator ID and username selectors
+
 ## [0.1.0] - 2026-06-25
 
 ### Added

data/README.md

@@ -3,7 +3,7 @@
 Official Ruby client for the **Socialstats Enterprise API**.
 
 RubyGems: https://rubygems.org/gems/socialstats-ruby-sdk  
-API Documentation: https://docs.socialstats.com  
+API Documentation: https://developers.stats.company/socialstats<br>
 API Key Access: Please contact api@socialstats.com
 
 ---
@@ -59,6 +59,14 @@ Or install directly via RubyGems:
       post_id: "7654234001833610518"
     )
 
+    # Start and poll a creator authorization
+    authorization = client.oauth.create(
+      socialstats_creator_id: "d3rvjgk2",
+      source_id: "youtube",
+      return_url: "https://customer.example.com/socialstats/oauth-return"
+    )
+    authorization_status = client.oauth.attempt_status(authorization["state_token"])
+
 ---
 
 ## Authentication
@@ -78,10 +86,14 @@ We recommend storing your key securely in environment variables:
 - `client.info`
 - `client.creators`
 - `client.posts`
+- `client.oauth`
+
+Creator-scoped methods accept `socialstats_creator_id`, `instagram_creator_id`, `facebook_creator_id`, `youtube_creator_id`, or `tiktok_creator_id`. Platform-specific identifiers may be either the platform's internal ID or its username.
 
 Info endpoints:
 - `client.info.sources` -> `/sources`
 - `client.info.status` -> `/status`
+- `client.info.uptime_check` -> `/uptime_check`
 - `client.info.definitions` -> `/definitions`
 
 Creator endpoints:
@@ -92,6 +104,10 @@ Creator endpoints:
 - `client.creators.audience_details(country_code: ..., ...)` -> `/creators/audience/details`
 - `client.creators.activities(...)` -> `/creators/activities`
 - `client.creators.content(...)` -> `/creators/content`
+- `client.creators.authorized_stats(...)` -> `/creators/authorized/stats`
+- `client.creators.authorized_historic_stats(...)` -> `/creators/authorized/historic_stats`
+- `client.creators.authorized_audience(...)` -> `/creators/authorized/audience`
+- `client.creators.authorized_content(...)` -> `/creators/authorized/content`
 - `client.creators.top_posts(...)` -> `/creators/top_posts`
 - `client.creators.search(q: ..., ...)` -> `/creators/search`
 - `client.creators.add_link_request(link: ..., ...)` -> `/creators/link_request`
@@ -100,6 +116,15 @@ Creator endpoints:
 Post endpoints:
 - `client.posts.stats(...)` -> `/posts/stats`
 - `client.posts.historic_stats(...)` -> `/posts/historic_stats`
+- `client.posts.authorized_stats(...)` -> `/posts/authorized/{source_id}/stats`
+- `client.posts.authorized_historic_stats(...)` -> `/posts/authorized/{source_id}/historic_stats`
+
+OAuth endpoints:
+- `client.oauth.create(...)` -> `POST /oauth`
+- `client.oauth.list(...)` -> `GET /oauth`
+- `client.oauth.get(...)` -> `GET /oauth/{id}`
+- `client.oauth.revoke(...)` -> `DELETE /oauth/{id}`
+- `client.oauth.attempt_status(...)` -> `GET /oauth-attempts/{state_token}`
 
 ---
 

data/docs/enterprise_routes_audit.md

@@ -30,14 +30,34 @@ Authentication observed in Rails: `apikey` request header.
 | GET    | `/audience/details` | `client.creators.audience_details(country_code: ..., ...)` |
 | GET    | `/activities`       | `client.creators.activities(...)`                          |
 | GET    | `/content`          | `client.creators.content(...)`                             |
+| GET    | `/authorized/stats` | `client.creators.authorized_stats(...)`                    |
+| GET    | `/authorized/historic_stats` | `client.creators.authorized_historic_stats(...)`    |
+| GET    | `/authorized/audience` | `client.creators.authorized_audience(...)`              |
+| GET    | `/authorized/content` | `client.creators.authorized_content(...)`                |
 | GET    | `/top_posts`        | `client.creators.top_posts(...)`                           |
 | GET    | `/search`           | `client.creators.search(q: ..., ...)`                      |
 | POST   | `/link_request`     | `client.creators.add_link_request(link: ..., ...)`         |
 | DELETE | `/link_request`     | `client.creators.remove_link_request(link: ..., ...)`      |
 
+Creator-scoped methods require one creator identifier: `socialstats_creator_id`, `instagram_creator_id`, `facebook_creator_id`, `youtube_creator_id`, or `tiktok_creator_id`.
+
 ## `/enterprise/v1/posts`
 
 | HTTP | Route             | SDK Method                         |
 | ---- | ----------------- | ---------------------------------- |
 | GET  | `/stats`          | `client.posts.stats(...)`          |
 | GET  | `/historic_stats` | `client.posts.historic_stats(...)` |
+| GET  | `/authorized/:source_id/stats` | `client.posts.authorized_stats(...)` |
+| GET  | `/authorized/:source_id/historic_stats` | `client.posts.authorized_historic_stats(...)` |
+
+Post methods require one creator identifier, `source_id`, and one of `post_id`, `id_unique`, or `external_id`.
+
+## `/enterprise/v1/oauth`
+
+| HTTP   | Route                          | SDK Method                                  |
+| ------ | ------------------------------ | ------------------------------------------- |
+| POST   | `/oauth`                       | `client.oauth.create(...)`                  |
+| GET    | `/oauth`                       | `client.oauth.list(...)`                    |
+| GET    | `/oauth/:id`                   | `client.oauth.get(id)`                      |
+| DELETE | `/oauth/:id`                   | `client.oauth.revoke(id)`                   |
+| GET    | `/oauth-attempts/:state_token` | `client.oauth.attempt_status(state_token)`  |

data/lib/socialstats_sdk/client.rb

@@ -2,7 +2,7 @@
 
 module SocialstatsSDK
   class Client
-    attr_reader :info, :creators, :posts
+    attr_reader :info, :creators, :posts, :oauth
 
     def initialize(api_key:, base_url: HTTPClient::DEFAULT_BASE_URL, timeout: HTTPClient::DEFAULT_TIMEOUT_SECONDS,
       max_retries: 2, http_adapter: nil, user_agent: nil)
@@ -18,6 +18,7 @@ module SocialstatsSDK
       @info = Resources::Info.new(@http)
       @creators = Resources::Creators.new(@http)
       @posts = Resources::Posts.new(@http)
+      @oauth = Resources::OAuth.new(@http)
     end
 
     def close

data/lib/socialstats_sdk/resources/base.rb

@@ -3,6 +3,14 @@
 module SocialstatsSDK
   module Resources
     class Base
+      CREATOR_IDENTIFIER_KEYS = %i[
+        socialstats_creator_id
+        instagram_creator_id
+        facebook_creator_id
+        youtube_creator_id
+        tiktok_creator_id
+      ].freeze
+
       def initialize(http_client)
         @http = http_client
       end
@@ -12,6 +20,7 @@ module SocialstatsSDK
       def get(path, params: nil)
         @http.request(:get, path, params: normalize_params(params))
       end
+      alias request_get get
 
       def post(path, params: nil, json: nil)
         @http.request(:post, path, params: normalize_params(params), json: normalize_params(json))

data/lib/socialstats_sdk/resources/creators.rb

@@ -3,8 +3,6 @@
 module SocialstatsSDK
   module Resources
     class Creators < Base
-      IDENTIFIER_KEYS = %i[socialstats_creator_id].freeze
-
       def info(**params)
         get("creators/info", params: with_identifier(params))
       end
@@ -37,6 +35,22 @@ module SocialstatsSDK
         get("creators/content", params: with_identifier(params))
       end
 
+      def authorized_stats(**params)
+        get("creators/authorized/stats", params: with_identifier(params))
+      end
+
+      def authorized_historic_stats(**params)
+        get("creators/authorized/historic_stats", params: with_identifier(params))
+      end
+
+      def authorized_audience(**params)
+        get("creators/authorized/audience", params: with_identifier(params))
+      end
+
+      def authorized_content(**params)
+        get("creators/authorized/content", params: with_identifier(params))
+      end
+
       def top_posts(**params)
         get("creators/top_posts", params: with_identifier(params))
       end
@@ -67,7 +81,7 @@ module SocialstatsSDK
 
       def with_identifier(params)
         query = params.dup
-        require_any_identifier!(query, IDENTIFIER_KEYS)
+        require_any_identifier!(query, CREATOR_IDENTIFIER_KEYS)
         query
       end
     end

data/lib/socialstats_sdk/resources/oauth.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module SocialstatsSDK
+  module Resources
+    class OAuth < Base
+      def create(source_id:, **params)
+        raise ArgumentError, "source_id is required" if source_id.to_s.empty?
+
+        query = params.merge(source_id: source_id)
+        require_any_identifier!(query, CREATOR_IDENTIFIER_KEYS)
+        post("oauth", params: query)
+      end
+
+      def list(**params)
+        request_get("oauth", params: params)
+      end
+
+      def get(authorization_id)
+        raise ArgumentError, "authorization_id is required" if authorization_id.to_s.empty?
+
+        request_get("oauth/#{escape(authorization_id)}")
+      end
+
+      def revoke(authorization_id)
+        raise ArgumentError, "authorization_id is required" if authorization_id.to_s.empty?
+
+        delete("oauth/#{escape(authorization_id)}")
+      end
+
+      def attempt_status(state_token)
+        raise ArgumentError, "state_token is required" if state_token.to_s.empty?
+
+        request_get("oauth-attempts/#{escape(state_token)}")
+      end
+
+      private
+
+      def escape(value)
+        URI.encode_uri_component(value.to_s)
+      end
+    end
+  end
+end

data/lib/socialstats_sdk/resources/posts.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
+require "uri"
+
 module SocialstatsSDK
   module Resources
     class Posts < Base
-      CREATOR_IDENTIFIER_KEYS = %i[socialstats_creator_id].freeze
       POST_IDENTIFIER_KEYS = %i[post_id id_unique external_id].freeze
 
       def stats(source_id:, **params)
@@ -14,6 +15,16 @@ module SocialstatsSDK
         get("posts/historic_stats", params: with_post_identifier(params.merge(source_id: source_id)))
       end
 
+      def authorized_stats(source_id:, **params)
+        query = with_post_identifier(params.merge(source_id: source_id))
+        get("posts/authorized/#{URI.encode_uri_component(source_id.to_s)}/stats", params: query)
+      end
+
+      def authorized_historic_stats(source_id:, **params)
+        query = with_post_identifier(params.merge(source_id: source_id))
+        get("posts/authorized/#{URI.encode_uri_component(source_id.to_s)}/historic_stats", params: query)
+      end
+
       private
 
       def with_post_identifier(params)

data/lib/socialstats_sdk/resources.rb

@@ -4,3 +4,4 @@ require_relative "resources/base"
 require_relative "resources/info"
 require_relative "resources/creators"
 require_relative "resources/posts"
+require_relative "resources/oauth"

data/lib/socialstats_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SocialstatsSDK
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: socialstats-ruby-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Songstats
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-06-25 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -49,6 +48,7 @@ files:
 - lib/socialstats_sdk/resources/base.rb
 - lib/socialstats_sdk/resources/creators.rb
 - lib/socialstats_sdk/resources/info.rb
+- lib/socialstats_sdk/resources/oauth.rb
 - lib/socialstats_sdk/resources/posts.rb
 - lib/socialstats_sdk/version.rb
 homepage: https://socialstats.com
@@ -60,7 +60,6 @@ metadata:
   bug_tracker_uri: https://github.com/songstats/socialstats-ruby-sdk/issues
   allowed_push_host: https://rubygems.org
   rubygems_mfa_required: 'true'
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -75,8 +74,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
-signing_key:
+rubygems_version: 4.0.16
 specification_version: 4
 summary: Ruby SDK for the Socialstats Enterprise API.
 test_files: []