postproxy-sdk 1.1.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9a60fab0c383896df7be59f688fb8692ab12eb60725d031fac50e76d7acc507
-  data.tar.gz: 38cc6ceda7bb03d4adb4e2bdfe7a27155ee0d4ef20b39d6d2b82d8e115284201
+  metadata.gz: 8aa3207765c712cdc5887c3c94ae33010ec0e01f8487c867641929f84d8f08e7
+  data.tar.gz: 1f40051ca925f4eda94ce0883af44f456c564666afd4f4e766ef9040ff48e6db
 SHA512:
-  metadata.gz: b314e1009d278281897233d3059b3a04c29d2729a86d9f06299113d11cb973788b01a29bb9393e5ac8e9bf62a08f63e9de35eabcc8a033e943350d774236c24c
-  data.tar.gz: c2142242f1ee28e96152c6de5869aca4821de27f6eb7b756c05034d2546d80a941fa0fd530ec823b6d6b1fde5e9b77f88aecc6503998d5bd143dbdc54e8fca09
+  metadata.gz: a035631e203fdefda661eda488dd7384b4690e8dd490b430d35ed73d421e49a11927a7282ee489e197a16975a0874e8d95ec0337b347ef5b141c30c570f69301
+  data.tar.gz: 36e967ff4467ee46f261489cfc770ac09e3e0d2a092dc8faa6e6186585fd8b4df3cc9f3abc7db5cd2607befd3603715f835da647c1aa5213eebe63ab920fcfec

data/README.md

@@ -92,6 +92,17 @@ post = client.posts.create(
   scheduled_at: (Time.now + 3600).iso8601
 )
 
+# Create a thread post
+post = client.posts.create(
+  "Thread starts here",
+  profiles: ["prof-1"],
+  thread: [
+    { body: "Second post in the thread" },
+    { body: "Third with media", media: ["https://example.com/img.jpg"] },
+  ]
+)
+post.thread.each { |child| puts "#{child.id}: #{child.body}" }
+
 # Delete a post
 client.posts.delete("post-id")
 ```
@@ -146,6 +157,97 @@ Stats vary by platform:
 | TikTok | `impressions`, `likes`, `comments`, `shares` |
 | Pinterest | `impressions`, `likes`, `comments`, `saved`, `outbound_clicks` |
 
+## Queues
+
+```ruby
+# List all queues
+queues = client.queues.list.data
+
+# Get a queue
+queue = client.queues.get("queue-id")
+
+# Get next available slot
+next_slot = client.queues.next_slot("queue-id")
+puts next_slot.next_slot
+
+# Create a queue with timeslots
+queue = client.queues.create(
+  "Morning Posts",
+  profile_group_id: "pg-abc",
+  description: "Weekday morning content",
+  timezone: "America/New_York",
+  jitter: 10,
+  timeslots: [
+    { day: 1, time: "09:00" },
+    { day: 2, time: "09:00" },
+    { day: 3, time: "09:00" },
+  ]
+)
+
+# Update a queue
+queue = client.queues.update("queue-id",
+  jitter: 15,
+  timeslots: [
+    { day: 6, time: "10:00" },        # add new timeslot
+    { id: 1, _destroy: true },         # remove existing timeslot
+  ]
+)
+
+# Pause/unpause a queue
+client.queues.update("queue-id", enabled: false)
+
+# Delete a queue
+client.queues.delete("queue-id")
+
+# Add a post to a queue
+post = client.posts.create(
+  "This post will be scheduled by the queue",
+  profiles: ["prof-1"],
+  queue_id: "queue-id",
+  queue_priority: "high"
+)
+```
+
+## Webhooks
+
+```ruby
+# List webhooks
+webhooks = client.webhooks.list.data
+
+# Get a webhook
+webhook = client.webhooks.get("wh-id")
+
+# Create a webhook
+webhook = client.webhooks.create(
+  "https://example.com/webhook",
+  events: ["post.published", "post.failed"],
+  description: "My webhook"
+)
+puts webhook.id, webhook.secret
+
+# Update a webhook
+webhook = client.webhooks.update("wh-id", events: ["post.published"], enabled: false)
+
+# Delete a webhook
+client.webhooks.delete("wh-id")
+
+# List deliveries
+deliveries = client.webhooks.deliveries("wh-id", page: 1, per_page: 10)
+deliveries.data.each { |d| puts "#{d.event_type}: #{d.success}" }
+```
+
+### Signature verification
+
+Verify incoming webhook signatures using HMAC-SHA256:
+
+```ruby
+PostProxy::WebhookSignature.verify(
+  payload: request.body.read,
+  signature_header: request.headers["X-PostProxy-Signature"],
+  secret: "whsec_..."
+)
+```
+
 ## Profiles
 
 ```ruby

data/lib/postproxy/client.rb

@@ -4,6 +4,8 @@ require "json"
 require_relative "resources/posts"
 require_relative "resources/profiles"
 require_relative "resources/profile_groups"
+require_relative "resources/webhooks"
+require_relative "resources/queues"
 
 module PostProxy
   class Client
@@ -17,6 +19,8 @@ module PostProxy
       @posts = nil
       @profiles = nil
       @profile_groups = nil
+      @webhooks = nil
+      @queues = nil
     end
 
     def posts
@@ -31,6 +35,14 @@ module PostProxy
       @profile_groups ||= Resources::ProfileGroups.new(self)
     end
 
+    def webhooks
+      @webhooks ||= Resources::Webhooks.new(self)
+    end
+
+    def queues
+      @queues ||= Resources::Queues.new(self)
+    end
+
     def request(method, path, params: nil, json: nil, data: nil, files: nil, profile_group_id: nil)
       url = "/api#{path}"
 

data/lib/postproxy/constants.rb

@@ -7,7 +7,9 @@ module PostProxy
 
   PROFILE_STATUSES = %w[active expired inactive].freeze
 
-  POST_STATUSES = %w[pending draft processing processed scheduled].freeze
+  POST_STATUSES = %w[pending draft processing processed scheduled media_processing_failed].freeze
+
+  MEDIA_STATUSES = %w[pending processed failed].freeze
 
   PLATFORM_POST_STATUSES = %w[pending processing published failed deleted].freeze
 

data/lib/postproxy/resources/posts.rb

@@ -29,8 +29,12 @@ module PostProxy
       end
 
       def create(body, profiles:, media: nil, media_files: nil, platforms: nil,
-                 scheduled_at: nil, draft: nil, profile_group_id: nil)
-        if media_files && !media_files.empty?
+                 thread: nil, scheduled_at: nil, draft: nil, queue_id: nil,
+                 queue_priority: nil, profile_group_id: nil)
+        has_files = media_files && !media_files.empty?
+        has_thread_files = thread&.any? { |t| t[:media_files]&.any? }
+
+        if has_files || has_thread_files
           form_data = { "post[body]" => body }
           form_data["post[scheduled_at]"] = format_time(scheduled_at) if scheduled_at
           form_data["post[draft]"] = draft.to_s if !draft.nil?
@@ -54,7 +58,7 @@ module PostProxy
             end
           end
 
-          media_files.each do |path|
+          media_files&.each do |path|
             path = path.to_s
             filename = File.basename(path)
             content_type = mime_type_for(filename)
@@ -62,6 +66,22 @@ module PostProxy
             files << ["media[]", filename, io, content_type]
           end
 
+          thread&.each_with_index do |t, i|
+            form_data["thread[#{i}][body]"] = t[:body] if t[:body]
+
+            t[:media]&.each do |m|
+              files << ["thread[#{i}][media][]", nil, m, "text/plain"]
+            end
+
+            t[:media_files]&.each do |path|
+              path = path.to_s
+              filename = File.basename(path)
+              content_type = mime_type_for(filename)
+              io = File.open(path, "rb")
+              files << ["thread[#{i}][media][]", filename, io, content_type]
+            end
+          end
+
           result = @client.request(:post, "/posts",
             data: form_data,
             files: files,
@@ -75,6 +95,9 @@ module PostProxy
           json_body = { post: post_payload, profiles: profiles }
           json_body[:platforms] = platforms.is_a?(PlatformParams) ? platforms.to_h : platforms if platforms
           json_body[:media] = media if media
+          json_body[:thread] = thread if thread
+          json_body[:queue_id] = queue_id if queue_id
+          json_body[:queue_priority] = queue_priority if queue_priority
 
           result = @client.request(:post, "/posts", json: json_body, profile_group_id: profile_group_id)
         end

data/lib/postproxy/resources/queues.rb

@@ -0,0 +1,61 @@
+module PostProxy
+  module Resources
+    class Queues
+      def initialize(client)
+        @client = client
+      end
+
+      def list(profile_group_id: nil)
+        result = @client.request(:get, "/post_queues", profile_group_id: profile_group_id)
+        queues = (result[:data] || []).map { |q| Queue.new(**q) }
+        ListResponse.new(data: queues)
+      end
+
+      def get(id)
+        result = @client.request(:get, "/post_queues/#{id}")
+        Queue.new(**result)
+      end
+
+      def next_slot(id)
+        result = @client.request(:get, "/post_queues/#{id}/next_slot")
+        NextSlotResponse.new(**result)
+      end
+
+      def create(name, profile_group_id:, description: nil, timezone: nil, jitter: nil, timeslots: nil)
+        post_queue = { name: name }
+        post_queue[:description] = description if description
+        post_queue[:timezone] = timezone if timezone
+        post_queue[:jitter] = jitter unless jitter.nil?
+        post_queue[:queue_timeslots_attributes] = timeslots if timeslots
+
+        json_body = {
+          profile_group_id: profile_group_id,
+          post_queue: post_queue,
+        }
+
+        result = @client.request(:post, "/post_queues", json: json_body)
+        Queue.new(**result)
+      end
+
+      def update(id, name: nil, description: nil, timezone: nil, enabled: nil, jitter: nil, timeslots: nil)
+        post_queue = {}
+        post_queue[:name] = name unless name.nil?
+        post_queue[:description] = description unless description.nil?
+        post_queue[:timezone] = timezone unless timezone.nil?
+        post_queue[:enabled] = enabled unless enabled.nil?
+        post_queue[:jitter] = jitter unless jitter.nil?
+        post_queue[:queue_timeslots_attributes] = timeslots if timeslots
+
+        json_body = { post_queue: post_queue }
+
+        result = @client.request(:patch, "/post_queues/#{id}", json: json_body)
+        Queue.new(**result)
+      end
+
+      def delete(id)
+        result = @client.request(:delete, "/post_queues/#{id}")
+        DeleteResponse.new(**result)
+      end
+    end
+  end
+end

data/lib/postproxy/resources/webhooks.rb

@@ -0,0 +1,59 @@
+module PostProxy
+  module Resources
+    class Webhooks
+      def initialize(client)
+        @client = client
+      end
+
+      def list
+        result = @client.request(:get, "/webhooks")
+        webhooks = (result[:data] || []).map { |w| Webhook.new(**w) }
+        ListResponse.new(data: webhooks)
+      end
+
+      def get(id)
+        result = @client.request(:get, "/webhooks/#{id}")
+        Webhook.new(**result)
+      end
+
+      def create(url, events:, description: nil)
+        json_body = { url: url, events: events }
+        json_body[:description] = description if description
+
+        result = @client.request(:post, "/webhooks", json: json_body)
+        Webhook.new(**result)
+      end
+
+      def update(id, url: nil, events: nil, enabled: nil, description: nil)
+        json_body = {}
+        json_body[:url] = url unless url.nil?
+        json_body[:events] = events unless events.nil?
+        json_body[:enabled] = enabled unless enabled.nil?
+        json_body[:description] = description unless description.nil?
+
+        result = @client.request(:patch, "/webhooks/#{id}", json: json_body)
+        Webhook.new(**result)
+      end
+
+      def delete(id)
+        result = @client.request(:delete, "/webhooks/#{id}")
+        DeleteResponse.new(**result)
+      end
+
+      def deliveries(id, page: nil, per_page: nil)
+        params = {}
+        params[:page] = page if page
+        params[:per_page] = per_page if per_page
+
+        result = @client.request(:get, "/webhooks/#{id}/deliveries", params: params)
+        deliveries = (result[:data] || []).map { |d| WebhookDelivery.new(**d) }
+        PaginatedResponse.new(
+          data: deliveries,
+          total: result[:total],
+          page: result[:page],
+          per_page: result[:per_page]
+        )
+      end
+    end
+  end
+end

data/lib/postproxy/types.rb

@@ -84,18 +84,115 @@ module PostProxy
     end
   end
 
+  class Media < Model
+    attr_accessor :id, :status, :error_message, :content_type, :source_url, :url
+
+    def initialize(**attrs)
+      @error_message = nil
+      @source_url = nil
+      @url = nil
+      super
+    end
+  end
+
+  class ThreadChild < Model
+    attr_accessor :id, :body, :media
+
+    def initialize(**attrs)
+      @media = []
+      super
+      @media = (@media || []).map do |m|
+        m.is_a?(Media) ? m : Media.new(**m.transform_keys(&:to_sym))
+      end
+    end
+  end
+
+  class Timeslot < Model
+    attr_accessor :id, :day, :time
+  end
+
+  class Queue < Model
+    attr_accessor :id, :name, :description, :timezone, :enabled, :jitter,
+                  :profile_group_id, :timeslots, :posts_count
+
+    def initialize(**attrs)
+      @description = nil
+      @timeslots = []
+      @posts_count = 0
+      super
+      @timeslots = (@timeslots || []).map do |t|
+        t.is_a?(Timeslot) ? t : Timeslot.new(**t.transform_keys(&:to_sym))
+      end
+    end
+  end
+
+  class NextSlotResponse < Model
+    attr_accessor :next_slot
+  end
+
   class Post < Model
-    attr_accessor :id, :body, :status, :scheduled_at, :created_at, :platforms
+    attr_accessor :id, :body, :status, :scheduled_at, :created_at, :media, :platforms, :thread,
+                  :queue_id, :queue_priority
 
     def initialize(**attrs)
       @scheduled_at = nil
+      @media = []
       @platforms = []
+      @thread = []
+      @queue_id = nil
+      @queue_priority = nil
       super
       @scheduled_at = parse_time(@scheduled_at)
       @created_at = parse_time(@created_at)
+      @media = (@media || []).map do |m|
+        m.is_a?(Media) ? m : Media.new(**m.transform_keys(&:to_sym))
+      end
       @platforms = (@platforms || []).map do |p|
         p.is_a?(PlatformResult) ? p : PlatformResult.new(**p.transform_keys(&:to_sym))
       end
+      @thread = (@thread || []).map do |t|
+        t.is_a?(ThreadChild) ? t : ThreadChild.new(**t.transform_keys(&:to_sym))
+      end
+    end
+
+    private
+
+    def parse_time(value)
+      return nil if value.nil?
+      value.is_a?(Time) ? value : Time.parse(value.to_s)
+    end
+  end
+
+  class Webhook < Model
+    attr_accessor :id, :url, :events, :enabled, :description, :secret,
+                  :created_at, :updated_at
+
+    def initialize(**attrs)
+      @events = []
+      @description = nil
+      @secret = nil
+      super
+      @created_at = parse_time(@created_at)
+      @updated_at = parse_time(@updated_at)
+    end
+
+    private
+
+    def parse_time(value)
+      return nil if value.nil?
+      value.is_a?(Time) ? value : Time.parse(value.to_s)
+    end
+  end
+
+  class WebhookDelivery < Model
+    attr_accessor :id, :event_id, :event_type, :response_status,
+                  :attempt_number, :success, :attempted_at, :created_at
+
+    def initialize(**attrs)
+      @response_status = nil
+      super
+      @attempted_at = parse_time(@attempted_at)
+      @created_at = parse_time(@created_at)
     end
 
     private
@@ -213,7 +310,7 @@ module PostProxy
   end
 
   class YouTubeParams < Model
-    attr_accessor :format, :title, :privacy_status, :cover_url
+    attr_accessor :format, :title, :privacy_status, :cover_url, :made_for_kids
   end
 
   class PinterestParams < Model

data/lib/postproxy/version.rb

@@ -1,3 +1,3 @@
 module PostProxy
-  VERSION = "1.1.0"
+  VERSION = "1.4.0"
 end

data/lib/postproxy/webhook_signature.rb

@@ -0,0 +1,28 @@
+require "openssl"
+
+module PostProxy
+  module WebhookSignature
+    def self.verify(payload, signature_header, secret)
+      parts = signature_header.split(",").map { |p| p.split("=", 2) }.to_h
+      timestamp = parts["t"]
+      expected = parts["v1"]
+
+      return false if timestamp.nil? || expected.nil?
+
+      signed_payload = "#{timestamp}.#{payload}"
+      computed = OpenSSL::HMAC.hexdigest("SHA256", secret, signed_payload)
+
+      secure_compare(computed, expected)
+    end
+
+    private_class_method def self.secure_compare(a, b)
+      return false unless a.bytesize == b.bytesize
+
+      l = a.unpack("C*")
+      r = b.unpack("C*")
+      result = 0
+      l.zip(r) { |x, y| result |= x ^ y }
+      result.zero?
+    end
+  end
+end

data/lib/postproxy.rb

@@ -3,6 +3,7 @@ require_relative "postproxy/constants"
 require_relative "postproxy/errors"
 require_relative "postproxy/types"
 require_relative "postproxy/client"
+require_relative "postproxy/webhook_signature"
 
 module PostProxy
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postproxy-sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.4.0
 platform: ruby
 authors:
 - PostProxy
@@ -81,8 +81,11 @@ files:
 - lib/postproxy/resources/posts.rb
 - lib/postproxy/resources/profile_groups.rb
 - lib/postproxy/resources/profiles.rb
+- lib/postproxy/resources/queues.rb
+- lib/postproxy/resources/webhooks.rb
 - lib/postproxy/types.rb
 - lib/postproxy/version.rb
+- lib/postproxy/webhook_signature.rb
 homepage: https://postproxy.dev
 licenses:
 - MIT