nexus-invision 1.9.0 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 95a63c2f9c0f30b4ca2903261b487fe4d6b1eaeaeee31938941eaa9652440b7c
-  data.tar.gz: 1d2a7c409d4c9c75b6e2efc1b45dae3e7103f71e34324896c36a889ff57dcdbe
+  metadata.gz: a46bc47e73117d8aded28e0384362d5d6a6713749b388c296aa25846cea3b377
+  data.tar.gz: 0d9c2d3f30523f032d40dd3a8272cf0b6337377f8e32f1f50bf627a7425ffcc9
 SHA512:
-  metadata.gz: 6b3d92b24b3518061b198a6938fe54e2f5b5f1553e9383b004a923b063821c4bd2af2e36b8e4f44cdd9079c2d03eb61a256d52a63809e75c8e479a2aff65f875
-  data.tar.gz: 22339257c3459c92da57a65119bb4794206cbd1af89cbaf83bf5aa9a7c98309e231c8070cd0f75d0310e04cbe8ceca6369091c8fd927b1c32cf2adbc571890be
+  metadata.gz: d68fe5188416eb36310f6a3b0e4f7750c84a0182d54252981e7abf4f0799faa608128c4339c8dc78263d4e2c32fe439bbbe48051d970af49b73ba178a2348df6
+  data.tar.gz: 4a51d3057f44a7a84e770ce554d7802a5da51e16e6934415da92d294909322a6c44cdaf5073bf50d8aa1ecda6aa1b8624200770ea4d619995c80125209f867eb

data/lib/nexus/invision/client.rb

@@ -2,6 +2,7 @@
 # frozen_string_literal: true
 
 require "faraday"
+require "nexus/invision/client_interface"
 require "nexus/invision/errors/bad_request"
 require "nexus/invision/errors/unexpected_response"
 require "nexus/invision/requests/add_member_to_secondary_group"
@@ -41,11 +42,9 @@ module Nexus
 
     class Client
       extend T::Sig
+      extend T::Helpers
 
-      sig { params(connection: Faraday::Connection).void }
-      def initialize(connection)
-        @connection = connection
-      end
+      include ClientInterface
 
       class << self
         extend T::Sig
@@ -55,7 +54,7 @@ module Nexus
             base_url: URI::HTTP,
             api_key: String,
             block: T.nilable(T.proc.params(arg0: Faraday::Connection).void),
-          ).returns(Client)
+          ).returns(ClientInterface)
         end
         def build(base_url:, api_key:, &block)
           new(
@@ -69,7 +68,12 @@ module Nexus
         end
       end
 
-      sig { params(post_id: Integer).void }
+      sig { params(connection: Faraday::Connection).void }
+      def initialize(connection)
+        @connection = connection
+      end
+
+      sig { override.params(post_id: Integer).void }
       def delete_post(post_id)
         request(
           http_method: HTTPMethod::DELETE,
@@ -77,7 +81,7 @@ module Nexus
         )
       end
 
-      sig { params(topic_id: Integer).void }
+      sig { override.params(topic_id: Integer).void }
       def delete_topic(topic_id)
         request(
           http_method: HTTPMethod::DELETE,
@@ -85,7 +89,7 @@ module Nexus
         )
       end
 
-      sig { params(post_id: Integer).returns(Resources::Post) }
+      sig { override.params(post_id: Integer).returns(Resources::Post) }
       def get_post(post_id)
         response = request(
           http_method: HTTPMethod::GET,
@@ -95,7 +99,7 @@ module Nexus
         Resources::Post.from_hash(response.body)
       end
 
-      sig { params(request: Requests::ListForumTopics).returns(Resources::Page[Resources::Topic]) }
+      sig { override.params(request: Requests::ListForumTopics).returns(Resources::Page[Resources::Topic]) }
       def list_forum_topics(request)
         response = request(
           http_method: HTTPMethod::GET,
@@ -114,7 +118,7 @@ module Nexus
         )
       end
 
-      sig { params(request: Requests::CreateForumTopic).returns(Resources::Topic) }
+      sig { override.params(request: Requests::CreateForumTopic).returns(Resources::Topic) }
       def create_forum_topic(request)
         response = request(
           http_method: HTTPMethod::POST,
@@ -125,7 +129,7 @@ module Nexus
         Resources::Topic.from_hash(response.body)
       end
 
-      sig { params(request: Requests::CreateForumPost).returns(Resources::Post) }
+      sig { override.params(request: Requests::CreateForumPost).returns(Resources::Post) }
       def create_forum_post(request)
         response = request(
           http_method: HTTPMethod::POST,
@@ -136,7 +140,7 @@ module Nexus
         Resources::Post.from_hash(response.body)
       end
 
-      sig { params(nexusmods_member_id: Integer).returns(Resources::LoginLink) }
+      sig { override.params(nexusmods_member_id: Integer).returns(Resources::LoginLink) }
       def login_link(nexusmods_member_id)
         response = request(
           http_method: HTTPMethod::GET,
@@ -146,7 +150,7 @@ module Nexus
         Resources::LoginLink.from_hash(response.body)
       end
 
-      sig { params(nexusmods_member_id: Integer).returns(Resources::Member) }
+      sig { override.params(nexusmods_member_id: Integer).returns(Resources::Member) }
       def get_member(nexusmods_member_id)
         response = request(
           http_method: HTTPMethod::GET,
@@ -156,7 +160,7 @@ module Nexus
         Resources::Member.from_hash(response.body)
       end
 
-      sig { params(request: Requests::EnsureMember).returns(Resources::EnsureMember) }
+      sig { override.params(request: Requests::EnsureMember).returns(Resources::EnsureMember) }
       def ensure_member(request)
         response = request(
           http_method: HTTPMethod::POST,
@@ -167,7 +171,7 @@ module Nexus
         Resources::EnsureMember.from_hash(response.body)
       end
 
-      sig { params(request: Requests::CreateMessage).void }
+      sig { override.params(request: Requests::CreateMessage).void }
       def create_message(request)
         request(
           http_method: HTTPMethod::POST,
@@ -176,7 +180,7 @@ module Nexus
         )
       end
 
-      sig { params(request: Requests::UnreadCount).returns(Resources::UnreadCount) }
+      sig { override.params(request: Requests::UnreadCount).returns(Resources::UnreadCount) }
       def unread_count(request)
         response = request(
           http_method: HTTPMethod::GET,
@@ -186,7 +190,7 @@ module Nexus
         Resources::UnreadCount.from_hash(response.body)
       end
 
-      sig { params(request: Requests::EditMemberPrimaryGroup).returns(Resources::Member) }
+      sig { override.params(request: Requests::EditMemberPrimaryGroup).returns(Resources::Member) }
       def edit_member_primary_group(request)
         response = request(
           http_method: HTTPMethod::POST,
@@ -196,7 +200,7 @@ module Nexus
         Resources::Member.from_hash(response.body)
       end
 
-      sig { params(request: Requests::AddMemberToSecondaryGroup).returns(Resources::User) }
+      sig { override.params(request: Requests::AddMemberToSecondaryGroup).returns(Resources::User) }
       def add_member_to_secondary_group(request)
         response = request(
           http_method: HTTPMethod::POST,
@@ -206,7 +210,7 @@ module Nexus
         Resources::User.from_hash(response.body)
       end
 
-      sig { params(request: Requests::RemoveMemberFromSecondaryGroup).returns(Resources::User) }
+      sig { override.params(request: Requests::RemoveMemberFromSecondaryGroup).returns(Resources::User) }
       def remove_member_from_secondary_group(request)
         response = request(
           http_method: HTTPMethod::DELETE,
@@ -216,7 +220,7 @@ module Nexus
         Resources::User.from_hash(response.body)
       end
 
-      sig { params(request: Requests::CreateMemberWarning).returns(Resources::Warning) }
+      sig { override.params(request: Requests::CreateMemberWarning).returns(Resources::Warning) }
       def create_member_warning(request)
         response = request(
           http_method: HTTPMethod::POST,
@@ -227,7 +231,7 @@ module Nexus
         Resources::Warning.from_hash(response.body)
       end
 
-      sig { params(member_id: Integer).returns(Resources::User) }
+      sig { override.params(member_id: Integer).returns(Resources::User) }
       def ban_member(member_id)
         response = request(
           http_method: HTTPMethod::POST,
@@ -237,7 +241,7 @@ module Nexus
         Resources::User.from_hash(response.body)
       end
 
-      sig { params(member_id: Integer).returns(Resources::User) }
+      sig { override.params(member_id: Integer).returns(Resources::User) }
       def unban_member(member_id)
         response = request(
           http_method: HTTPMethod::DELETE,
@@ -247,7 +251,7 @@ module Nexus
         Resources::User.from_hash(response.body)
       end
 
-      sig { params(request: Requests::DeleteMember).void }
+      sig { override.params(request: Requests::DeleteMember).void }
       def delete_member(request)
         # 1 is keep member name, 0 is anonymize content
         values = request.serialize.except("member_id").merge({ "contentAnonymize" => request.keep_member_name ? 1 : 0 })
@@ -258,7 +262,7 @@ module Nexus
         )
       end
 
-      sig { params(request: Requests::EditMember).returns(Resources::User) }
+      sig { override.params(request: Requests::EditMember).returns(Resources::User) }
       def edit_member(request)
         response = request(
           http_method: HTTPMethod::POST,

data/lib/nexus/invision/client_interface.rb

@@ -0,0 +1,97 @@
+# typed: strict
+# frozen_string_literal: true
+
+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/create_message"
+require "nexus/invision/requests/delete_member"
+require "nexus/invision/requests/edit_member"
+require "nexus/invision/requests/list_forum_topics"
+require "nexus/invision/requests/remove_member_from_secondary_group"
+require "nexus/invision/requests/edit_member_primary_group"
+require "nexus/invision/requests/ensure_member"
+require "nexus/invision/requests/unread_count"
+require "nexus/invision/resources/group"
+require "nexus/invision/resources/login_link"
+require "nexus/invision/resources/member"
+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"
+require "nexus/invision/resources/ensure_member"
+require "nexus/invision/resources/unread_count"
+require "sorbet-runtime"
+require "uri"
+
+module Nexus
+  module Invision
+    module ClientInterface
+      extend T::Sig
+      extend T::Helpers
+      interface!
+
+      sig { abstract.params(post_id: Integer).void }
+      def delete_post(post_id) end
+
+      sig { abstract.params(topic_id: Integer).void }
+      def delete_topic(topic_id) end
+
+      sig { abstract.params(post_id: Integer).returns(Resources::Post) }
+      def get_post(post_id) end
+
+      sig { abstract.params(request: Requests::ListForumTopics).returns(Resources::Page[Resources::Topic]) }
+      def list_forum_topics(request) end
+
+      sig { abstract.params(request: Requests::CreateForumTopic).returns(Resources::Topic) }
+      def create_forum_topic(request) end
+
+      sig { abstract.params(request: Requests::CreateForumPost).returns(Resources::Post) }
+      def create_forum_post(request) end
+
+      sig { abstract.params(nexusmods_member_id: Integer).returns(Resources::LoginLink) }
+      def login_link(nexusmods_member_id) end
+
+      sig { abstract.params(nexusmods_member_id: Integer).returns(Resources::Member) }
+      def get_member(nexusmods_member_id) end
+
+      sig { abstract.params(request: Requests::EnsureMember).returns(Resources::EnsureMember) }
+      def ensure_member(request) end
+
+      sig { abstract.params(request: Requests::CreateMessage).void }
+      def create_message(request) end
+
+      sig { abstract.params(request: Requests::UnreadCount).returns(Resources::UnreadCount) }
+      def unread_count(request) end
+
+      sig { abstract.params(request: Requests::EditMemberPrimaryGroup).returns(Resources::Member) }
+      def edit_member_primary_group(request) end
+
+      sig { abstract.params(request: Requests::AddMemberToSecondaryGroup).returns(Resources::User) }
+      def add_member_to_secondary_group(request) end
+
+      sig { abstract.params(request: Requests::RemoveMemberFromSecondaryGroup).returns(Resources::User) }
+      def remove_member_from_secondary_group(request) end
+
+      sig { abstract.params(request: Requests::CreateMemberWarning).returns(Resources::Warning) }
+      def create_member_warning(request) end
+
+      sig { abstract.params(member_id: Integer).returns(Resources::User) }
+      def ban_member(member_id) end
+
+      sig { abstract.params(member_id: Integer).returns(Resources::User) }
+      def unban_member(member_id) end
+
+      sig { abstract.params(request: Requests::DeleteMember).void }
+      def delete_member(request) end
+
+      sig { abstract.params(request: Requests::EditMember).returns(Resources::User) }
+      def edit_member(request) end
+    end
+  end
+end

data/lib/nexus/invision/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: nexus-invision
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.10.0
 platform: ruby
 authors:
 - Jack Robertson
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-13 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -23,6 +23,7 @@ files:
 - README.md
 - Rakefile
 - lib/nexus/invision/client.rb
+- lib/nexus/invision/client_interface.rb
 - lib/nexus/invision/errors/bad_request.rb
 - lib/nexus/invision/errors/client_error.rb
 - lib/nexus/invision/errors/unexpected_response.rb