postproxy-sdk 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 86174e66ca792b05a9f36bff9b881c65c3fdaaeb360e8a4fb49e94014d984839
-  data.tar.gz: ebe347a97de89a5af6697087252156b044a26f5c8eae11c3e2129c4594a6cb46
+  metadata.gz: 0aea2892ef3d3256dfd1cc9ce790da283df1d6edb83a2cfcaa76c0aa8a8194ae
+  data.tar.gz: a9f008666d47832963cc7119d0db1b53d53c7ddd3dc690fa13acebc05c72f5f6
 SHA512:
-  metadata.gz: 73dc2f50e0d720cd4048b23db241a17ea81cec2010bb06ae0f6a42a4edbb4d26f2b074be9e3a71ac4e24b9d09fa31651365727aefd88346e416284de4a4a6424
-  data.tar.gz: ae13c32ba3db5b1bb1e07bfd3ae63cc7d977215a834e1b4ce42b3298a3e6e790240b5a6dc251c41561489238cdbfdbab816ef22f221dc7ab3886db7e3f837669
+  metadata.gz: c9f6cf9ec0d398081c84c21c41824bd590fa9d57b7e8eea423512bcc899b82d3df93c4532edf307e2f949a0d72217e6677743b36434a4384e9b9d801030b4aa4
+  data.tar.gz: 325923dc017d840f212edac1941f2f2aa8d8821594f2418e40dee1e1b56a8f103627ab1f8cb9adb07f576afcc8fe5a6b431fcc408a50c4ac6887948bf80426d6

data/README.md

@@ -105,6 +105,18 @@ post.thread.each { |child| puts "#{child.id}: #{child.body}" }
 
 # Delete a post
 client.posts.delete("post-id")
+
+# Delete a post and also remove it from social platforms
+client.posts.delete("post-id", delete_on_platform: true)
+
+# Delete from platforms only (keeps DB record). Defaults to all platforms.
+client.posts.delete_on_platform("post-id")
+# Target a single network
+client.posts.delete_on_platform("post-id", network: "twitter")
+# Target a specific profile
+client.posts.delete_on_platform("post-id", profile_id: "prof-abc")
+# Target a specific post profile (covers entire thread for that profile)
+client.posts.delete_on_platform("post-id", post_profile_id: "pp-abc")
 ```
 
 ## Post Stats
@@ -248,6 +260,43 @@ PostProxy::WebhookSignature.verify(
 )
 ```
 
+## Comments
+
+```ruby
+# List comments on a post (paginated)
+comments = client.comments.list("post-id", profile_id: "profile-id")
+comments.data.each do |comment|
+  puts "#{comment.author_username}: #{comment.body}"
+  comment.replies.each do |reply|
+    puts "  #{reply.author_username}: #{reply.body}"
+  end
+end
+
+# List with pagination
+comments = client.comments.list("post-id", profile_id: "profile-id", page: 2, per_page: 10)
+
+# Get a single comment
+comment = client.comments.get("post-id", "comment-id", profile_id: "profile-id")
+
+# Create a comment
+comment = client.comments.create("post-id", profile_id: "profile-id", text: "Great post!")
+
+# Reply to a comment
+reply = client.comments.create("post-id", profile_id: "profile-id", text: "Thanks!", parent_id: "comment-id")
+
+# Delete a comment
+result = client.comments.delete("post-id", "comment-id", profile_id: "profile-id")
+puts result.accepted  # true
+
+# Hide / unhide a comment
+client.comments.hide("post-id", "comment-id", profile_id: "profile-id")
+client.comments.unhide("post-id", "comment-id", profile_id: "profile-id")
+
+# Like / unlike a comment
+client.comments.like("post-id", "comment-id", profile_id: "profile-id")
+client.comments.unlike("post-id", "comment-id", profile_id: "profile-id")
+```
+
 ## Profiles
 
 ```ruby

data/lib/postproxy/client.rb

@@ -6,6 +6,7 @@ require_relative "resources/profiles"
 require_relative "resources/profile_groups"
 require_relative "resources/webhooks"
 require_relative "resources/queues"
+require_relative "resources/comments"
 
 module PostProxy
   class Client
@@ -21,6 +22,7 @@ module PostProxy
       @profile_groups = nil
       @webhooks = nil
       @queues = nil
+      @comments = nil
     end
 
     def posts
@@ -43,6 +45,10 @@ module PostProxy
       @queues ||= Resources::Queues.new(self)
     end
 
+    def comments
+      @comments ||= Resources::Comments.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/resources/comments.rb

@@ -0,0 +1,62 @@
+module PostProxy
+  module Resources
+    class Comments
+      def initialize(client)
+        @client = client
+      end
+
+      def list(post_id, profile_id:, page: nil, per_page: nil)
+        params = { profile_id: profile_id }
+        params[:page] = page if page
+        params[:per_page] = per_page if per_page
+
+        result = @client.request(:get, "/posts/#{post_id}/comments", params: params)
+        comments = (result[:data] || []).map { |c| Comment.new(**c) }
+        PaginatedResponse.new(
+          data: comments,
+          total: result[:total],
+          page: result[:page],
+          per_page: result[:per_page]
+        )
+      end
+
+      def get(post_id, comment_id, profile_id:)
+        result = @client.request(:get, "/posts/#{post_id}/comments/#{comment_id}", params: { profile_id: profile_id })
+        Comment.new(**result)
+      end
+
+      def create(post_id, text, profile_id:, parent_id: nil)
+        json_body = { text: text }
+        json_body[:parent_id] = parent_id if parent_id
+
+        result = @client.request(:post, "/posts/#{post_id}/comments", params: { profile_id: profile_id }, json: json_body)
+        Comment.new(**result)
+      end
+
+      def delete(post_id, comment_id, profile_id:)
+        result = @client.request(:delete, "/posts/#{post_id}/comments/#{comment_id}", params: { profile_id: profile_id })
+        AcceptedResponse.new(**result)
+      end
+
+      def hide(post_id, comment_id, profile_id:)
+        result = @client.request(:post, "/posts/#{post_id}/comments/#{comment_id}/hide", params: { profile_id: profile_id })
+        AcceptedResponse.new(**result)
+      end
+
+      def unhide(post_id, comment_id, profile_id:)
+        result = @client.request(:post, "/posts/#{post_id}/comments/#{comment_id}/unhide", params: { profile_id: profile_id })
+        AcceptedResponse.new(**result)
+      end
+
+      def like(post_id, comment_id, profile_id:)
+        result = @client.request(:post, "/posts/#{post_id}/comments/#{comment_id}/like", params: { profile_id: profile_id })
+        AcceptedResponse.new(**result)
+      end
+
+      def unlike(post_id, comment_id, profile_id:)
+        result = @client.request(:post, "/posts/#{post_id}/comments/#{comment_id}/unlike", params: { profile_id: profile_id })
+        AcceptedResponse.new(**result)
+      end
+    end
+  end
+end

data/lib/postproxy/resources/posts.rb

@@ -38,6 +38,8 @@ module PostProxy
           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?
+          form_data["queue_id"] = queue_id if queue_id
+          form_data["queue_priority"] = queue_priority if queue_priority
 
           files = []
 
@@ -116,6 +118,8 @@ module PostProxy
           form_data["post[body]"] = body if body
           form_data["post[scheduled_at]"] = format_time(scheduled_at) if scheduled_at
           form_data["post[draft]"] = draft.to_s if !draft.nil?
+          form_data["queue_id"] = queue_id if queue_id
+          form_data["queue_priority"] = queue_priority if queue_priority
 
           files = []
 
@@ -205,11 +209,28 @@ module PostProxy
         StatsResponse.new(data: posts)
       end
 
-      def delete(id, profile_group_id: nil)
-        result = @client.request(:delete, "/posts/#{id}", profile_group_id: profile_group_id)
+      def delete(id, delete_on_platform: nil, profile_group_id: nil)
+        params = {}
+        params[:delete_on_platform] = delete_on_platform unless delete_on_platform.nil?
+        result = @client.request(:delete, "/posts/#{id}",
+          params: params.empty? ? nil : params,
+          profile_group_id: profile_group_id
+        )
         DeleteResponse.new(**result)
       end
 
+      def delete_on_platform(id, post_profile_id: nil, profile_id: nil, network: nil, profile_group_id: nil)
+        json_body = {}
+        json_body[:post_profile_id] = post_profile_id if post_profile_id
+        json_body[:profile_id] = profile_id if profile_id
+        json_body[:network] = network if network
+        result = @client.request(:post, "/posts/#{id}/delete_on_platform",
+          json: json_body.empty? ? nil : json_body,
+          profile_group_id: profile_group_id
+        )
+        DeleteOnPlatformResponse.new(**result)
+      end
+
       private
 
       def format_time(value)

data/lib/postproxy/types.rb

@@ -63,17 +63,31 @@ module PostProxy
     end
   end
 
+  class ErrorDetails < Model
+    attr_accessor :platform_error_code, :platform_error_subcode, :platform_error_message, :postproxy_note
+
+    def initialize(**attrs)
+      @platform_error_code = nil
+      @platform_error_subcode = nil
+      @platform_error_message = nil
+      @postproxy_note = nil
+      super
+    end
+  end
+
   class PlatformResult < Model
-    attr_accessor :platform, :status, :params, :error, :attempted_at, :insights
+    attr_accessor :platform, :status, :params, :error, :error_details, :attempted_at, :insights
 
     def initialize(**attrs)
       @params = nil
       @error = nil
+      @error_details = nil
       @attempted_at = nil
       @insights = nil
       super
       @attempted_at = parse_time(@attempted_at)
       @insights = Insights.new(**@insights) if @insights.is_a?(Hash)
+      @error_details = ErrorDetails.new(**@error_details.transform_keys(&:to_sym)) if @error_details.is_a?(Hash)
     end
 
     private
@@ -276,10 +290,62 @@ module PostProxy
     end
   end
 
+  class Comment < Model
+    attr_accessor :id, :external_id, :body, :status, :author_username,
+                  :author_avatar_url, :author_external_id, :parent_external_id,
+                  :like_count, :is_hidden, :permalink, :platform_data,
+                  :posted_at, :created_at, :replies
+
+    def initialize(**attrs)
+      @external_id = nil
+      @author_avatar_url = nil
+      @author_external_id = nil
+      @parent_external_id = nil
+      @like_count = 0
+      @is_hidden = false
+      @permalink = nil
+      @platform_data = nil
+      @replies = []
+      super
+      @posted_at = parse_time(@posted_at)
+      @created_at = parse_time(@created_at)
+      @replies = (@replies || []).map do |r|
+        r.is_a?(Comment) ? r : Comment.new(**r.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 AcceptedResponse < Model
+    attr_accessor :accepted
+  end
+
   class DeleteResponse < Model
     attr_accessor :deleted
   end
 
+  class DeletingPlatform < Model
+    attr_accessor :post_profile_id, :platform
+  end
+
+  class DeleteOnPlatformResponse < Model
+    attr_accessor :success, :deleting
+
+    def initialize(**attrs)
+      @deleting = []
+      super
+      @deleting = (@deleting || []).map do |entry|
+        entry.is_a?(DeletingPlatform) ? entry : DeletingPlatform.new(**entry)
+      end
+    end
+  end
+
   class SuccessResponse < Model
     attr_accessor :success
   end
@@ -310,7 +376,8 @@ module PostProxy
   end
 
   class YouTubeParams < Model
-    attr_accessor :format, :title, :privacy_status, :cover_url, :made_for_kids
+    attr_accessor :format, :title, :privacy_status, :cover_url, :made_for_kids,
+                  :tags, :category_id, :contains_synthetic_media
   end
 
   class PinterestParams < Model

data/lib/postproxy/version.rb

@@ -1,3 +1,3 @@
 module PostProxy
-  VERSION = "1.5.0"
+  VERSION = "1.7.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: postproxy-sdk
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.7.0
 platform: ruby
 authors:
 - PostProxy
@@ -78,6 +78,7 @@ files:
 - lib/postproxy/client.rb
 - lib/postproxy/constants.rb
 - lib/postproxy/errors.rb
+- lib/postproxy/resources/comments.rb
 - lib/postproxy/resources/posts.rb
 - lib/postproxy/resources/profile_groups.rb
 - lib/postproxy/resources/profiles.rb