nexus-invision 1.0.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 065f4b649c4cb38fd6e74ee2553e765d54aeac82c87ee1a0228bde20d67ee5ba
-  data.tar.gz: be4eef47364841e72cbe4e3a4d6a30ffcd40da45473cba3da0071c255c51bdee
+  metadata.gz: 0d4f567b2a4319ba9f7370165b9f88461134e1a6265f18effcdcb35339c16e32
+  data.tar.gz: 6bb7205017fe2d53d1030da35b1679dc2404b6b269a6e82415b542a591ce1448
 SHA512:
-  metadata.gz: 9c4b65c458d3b1223ad798d26abcfce4dd7573fdc0a4373dceb351662edddf78430a8faa8fc2dbb0ce7acace4f719d6eebb8c3e46abe17eb979c73a49f819fca
-  data.tar.gz: 5ec905d67b971c2478405b90f684a86f4e116dea933cc3eb5f4b08fb985a6abd5c239fb45fee0985b336cc7ae880c9a137062c87ccd1af9429cc23b8f5ae7206
+  metadata.gz: c97adf9ba3d36c361ab8c1674ed7935dc09fb6ef281f2d1ff34382293e8d74ef0edcedbc2099aef8a1bdf28ac100c8388b3a090a598a861684916ca15be9535d
+  data.tar.gz: f3010a5fe7410a594456f45c3d95700ca6fc6e2ef9f70770c1c6370fd194747d94f6867dbacdc395f0f9655f25841c21f9b5299da2f6194d8ef621375533176e

data/lib/nexus/invision/client.rb

@@ -5,10 +5,14 @@ require "faraday"
 require "nexus/invision/errors/bad_request"
 require "nexus/invision/errors/unexpected_response"
 require "nexus/invision/requests/add_member_to_secondary_group"
+require "nexus/invision/requests/create_forum_post"
 require "nexus/invision/requests/create_forum_topic"
 require "nexus/invision/requests/create_member_warning"
+require "nexus/invision/requests/list_forum_topics"
 require "nexus/invision/requests/remove_member_from_secondary_group"
 require "nexus/invision/resources/login_link"
+require "nexus/invision/resources/page"
+require "nexus/invision/resources/post"
 require "nexus/invision/resources/topic"
 require "nexus/invision/resources/user"
 require "nexus/invision/resources/warning"
@@ -55,6 +59,25 @@ module Nexus
         end
       end
 
+      sig { params(request: Requests::ListForumTopics).returns(Resources::Page[Resources::Topic]) }
+      def list_forum_topics(request)
+        response = request(
+          http_method: HTTPMethod::GET,
+          endpoint: URI("forums/topics"),
+          params: request.serialize,
+        )
+
+        body = response.body
+
+        Resources::Page[Resources::Topic].new(
+          page: body.fetch("page"),
+          per_page: body.fetch("perPage"),
+          total_results: body.fetch("totalResults"),
+          total_pages: body.fetch("totalPages"),
+          results: body.fetch("results").map { |result| Resources::Topic.from_hash(result) },
+        )
+      end
+
       sig { params(request: Requests::CreateForumTopic).returns(Resources::Topic) }
       def create_forum_topic(request)
         response = request(
@@ -66,6 +89,17 @@ module Nexus
         Resources::Topic.from_hash(response.body)
       end
 
+      sig { params(request: Requests::CreateForumPost).returns(Resources::Post) }
+      def create_forum_post(request)
+        response = request(
+          http_method: HTTPMethod::POST,
+          endpoint: URI("forums/posts"),
+          params: request.serialize,
+        )
+
+        Resources::Post.from_hash(response.body)
+      end
+
       sig { params(nexusmods_member_id: Integer).returns(Resources::LoginLink) }
       def login_link(nexusmods_member_id)
         response = request(

data/lib/nexus/invision/requests/create_forum_post.rb

@@ -0,0 +1,19 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/value_object"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Requests
+      class CreateForumPost < T::Struct
+        include ValueObject
+
+        const :topic, Integer
+        const :author, Integer
+        const :post, String
+      end
+    end
+  end
+end

data/lib/nexus/invision/requests/create_forum_topic.rb

@@ -10,7 +10,7 @@ module Nexus
       class CreateForumTopic < T::Struct
         include ValueObject
 
-        const :forum_id, Integer
+        const :forum, Integer
         const :title, String
         const :post, String
         const :author, T.nilable(Integer)

data/lib/nexus/invision/requests/list_forum_topics.rb

@@ -0,0 +1,24 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/value_object"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Requests
+      class ListForumTopics < T::Struct
+        include ValueObject
+
+        const :forums, String # A comma delimited list of forum IDs
+        const :sort_by, String, name: "sortBy", default: "updated"
+        const :sort_dir, String, name: "sortDir", default: "desc"
+        const :per_page, Integer, name: "perPage", default: 100
+        const :has_poll, T::Boolean, name: "hasPoll", default: false
+        const :hidden, Integer, default: 0
+        const :archived, Integer, default: 0
+        const :locked, Integer, default: 0
+      end
+    end
+  end
+end

data/lib/nexus/invision/resources/page.rb

@@ -0,0 +1,48 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/value_object"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Resources
+      class Page
+        extend T::Sig
+        extend T::Generic
+
+        include ValueObject
+
+        TResource = type_member { { upper: T::Struct } }
+
+        sig do
+          params(
+            page: Integer,
+            per_page: Integer,
+            total_results: Integer,
+            total_pages: Integer,
+            results: T::Array[TResource],
+          ).void
+        end
+        def initialize(page:, per_page:, total_results:, total_pages:, results:)
+          @page = page
+          @per_page = per_page
+          @total_results = total_results
+          @total_pages = total_pages
+          @results = results
+        end
+
+        sig { override.returns(T::Hash[String, T.untyped]) }
+        def serialize
+          {
+            "page" => @page,
+            "perPage" => @per_page,
+            "totalResults" => @total_results,
+            "totalPages" => @total_pages,
+            "results" => @results.map(&:serialize),
+          }
+        end
+      end
+    end
+  end
+end

data/lib/nexus/invision/resources/post.rb

@@ -0,0 +1,18 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "nexus/invision/value_object"
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Resources
+      class Post < T::Struct
+        include ValueObject
+
+        const :id, Integer
+        const :item_id, Integer
+      end
+    end
+  end
+end

data/lib/nexus/invision/resources/topic.rb

@@ -11,6 +11,7 @@ module Nexus
         include ValueObject
 
         const :id, Integer
+        const :title, String
       end
     end
   end

data/lib/nexus/invision/version.rb

@@ -3,7 +3,7 @@
 
 module Nexus
   module Invision
-    # Leave this as 1.0.1 in order for CI process to replace with the tagged version.
-    VERSION = "1.0.1"
+    # Leave this as 1.2.0 in order for CI process to replace with the tagged version.
+    VERSION = "1.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus-invision
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Jack Robertson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-06 00:00:00.000000000 Z
+date: 2023-11-08 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -27,10 +27,14 @@ files:
 - lib/nexus/invision/errors/client_error.rb
 - lib/nexus/invision/errors/unexpected_response.rb
 - lib/nexus/invision/requests/add_member_to_secondary_group.rb
+- lib/nexus/invision/requests/create_forum_post.rb
 - lib/nexus/invision/requests/create_forum_topic.rb
 - lib/nexus/invision/requests/create_member_warning.rb
+- lib/nexus/invision/requests/list_forum_topics.rb
 - lib/nexus/invision/requests/remove_member_from_secondary_group.rb
 - lib/nexus/invision/resources/login_link.rb
+- lib/nexus/invision/resources/page.rb
+- lib/nexus/invision/resources/post.rb
 - lib/nexus/invision/resources/topic.rb
 - lib/nexus/invision/resources/user.rb
 - lib/nexus/invision/resources/warning.rb