nexus-invision 1.10.1 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf10a8da5ec2072130dbedb0d765bcbc9c24acd4400f06ab97e5bf63fbae1d76
-  data.tar.gz: 924f770f88d420759088e00832205ff55d687b41c4dc1afb8a9064681a5c1fde
+  metadata.gz: c0b337b979579f1c60c832c5c26a537d53677e6f656af941079a083f3916849d
+  data.tar.gz: a845ba2c6b4ac3f1513ae9da46098893e64cd04e506c04435ed0ca52d9c0cc8f
 SHA512:
-  metadata.gz: b421b755ce1379a81ea8ee231d9b1e2a4374edb073d32066f2395e187da6dc512448183ae967adf3cea7f92c8f596db5c17b403ab30705df7f7b17df68639c8f
-  data.tar.gz: 79e1642bdab18d0a217d2d35dd4adfee945377acfce144f5ca2ee1491bac2ba5096866772e919f4452c131038470d50072e57fff2a43a666745f34a0889d9d9b
+  metadata.gz: c143cb42c3a74a32bafaa18d48eb7290e6509c63b650873d3774942561c0172a2e112c7bb9c07ee7dec48997e2df57f60afc4d2707cd187f2d18ace388c8fa31
+  data.tar.gz: 4b96b0d6bc5e1b4a55cccc0609354e9f7ea89f6da2ea0582b201d9009ddc04da78e12ec5b72f2242b415b4ab07293033dfceeba0e7ff56d09a64193427f21da0

data/Gemfile

@@ -18,4 +18,5 @@ end
 
 group :test do
   gem "rspec", "~> 3.12"
+  gem "vcr"
 end

data/Gemfile.lock

@@ -87,6 +87,7 @@ GEM
       yard-sorbet
     thor (1.3.0)
     unicode-display_width (2.5.0)
+    vcr (6.2.0)
     yard (0.9.34)
     yard-sorbet (0.8.1)
       sorbet-runtime (>= 0.5)
@@ -105,6 +106,7 @@ DEPENDENCIES
   sorbet
   sorbet-runtime
   tapioca
+  vcr
 
 BUNDLED WITH
    2.4.13

data/lib/nexus/invision/client.rb

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 require "faraday"
+require "sorbet-runtime"
+require "uri"
+
 require "nexus/invision/client_interface"
 require "nexus/invision/errors/bad_request"
 require "nexus/invision/errors/unexpected_response"
@@ -12,23 +15,25 @@ 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/requests/list_forum_topics"
+require "nexus/invision/requests/remove_member_from_secondary_group"
+require "nexus/invision/resources/ensure_member"
+require "nexus/invision/resources/field"
+require "nexus/invision/resources/field_group"
+require "nexus/invision/resources/forum"
 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/poll"
 require "nexus/invision/resources/post"
+require "nexus/invision/resources/question"
+require "nexus/invision/resources/rank"
 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
@@ -96,7 +101,7 @@ module Nexus
           endpoint: URI("forums/posts/#{post_id}"),
         )
 
-        Resources::Post.from_hash(response.body)
+        Resources::Post.from_response(response.body)
       end
 
       sig { override.params(request: Requests::ListForumTopics).returns(Resources::Page[Resources::Topic]) }
@@ -114,7 +119,9 @@ module Nexus
           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) },
+          results: body.fetch("results").map do |result|
+            Resources::Topic.from_response(result)
+          end,
         )
       end
 
@@ -126,7 +133,7 @@ module Nexus
           params: request.serialize,
         )
 
-        Resources::Topic.from_hash(response.body)
+        Resources::Topic.from_response(response.body)
       end
 
       sig { override.params(request: Requests::CreateForumPost).returns(Resources::Post) }
@@ -137,7 +144,7 @@ module Nexus
           params: request.serialize,
         )
 
-        Resources::Post.from_hash(response.body)
+        Resources::Post.from_response(response.body)
       end
 
       sig { override.params(nexusmods_member_id: Integer).returns(Resources::LoginLink) }
@@ -147,7 +154,7 @@ module Nexus
           endpoint: URI("core/loginlinks/#{nexusmods_member_id}"),
         )
 
-        Resources::LoginLink.from_hash(response.body)
+        Resources::LoginLink.from_response(response.body)
       end
 
       sig { override.params(nexusmods_member_id: Integer).returns(Resources::Member) }
@@ -157,7 +164,7 @@ module Nexus
           endpoint: URI("core/members/#{nexusmods_member_id}"),
         )
 
-        Resources::Member.from_hash(response.body)
+        Resources::Member.from_response(response.body)
       end
 
       sig { override.params(request: Requests::EnsureMember).returns(Resources::EnsureMember) }
@@ -168,7 +175,7 @@ module Nexus
           params: request.serialize.except("id"),
         )
 
-        Resources::EnsureMember.from_hash(response.body)
+        Resources::EnsureMember.from_response(response.body)
       end
 
       sig { override.params(request: Requests::CreateMessage).void }
@@ -180,16 +187,6 @@ module Nexus
         )
       end
 
-      sig { override.params(request: Requests::UnreadCount).returns(Resources::UnreadCount) }
-      def unread_count(request)
-        response = request(
-          http_method: HTTPMethod::GET,
-          endpoint: URI("core/unreadcount/#{request.id}"),
-        )
-
-        Resources::UnreadCount.from_hash(response.body)
-      end
-
       sig { override.params(request: Requests::EditMemberPrimaryGroup).returns(Resources::Member) }
       def edit_member_primary_group(request)
         response = request(
@@ -197,7 +194,7 @@ module Nexus
           endpoint: URI("core/members/#{request.member_id}"),
           params: request.serialize.except("member_id"),
         )
-        Resources::Member.from_hash(response.body)
+        Resources::Member.from_response(response.body)
       end
 
       sig { override.params(request: Requests::AddMemberToSecondaryGroup).returns(Resources::User) }
@@ -207,7 +204,7 @@ module Nexus
           endpoint: URI("core/members/#{request.member_id}/secgroup/#{request.group_id}"),
         )
 
-        Resources::User.from_hash(response.body)
+        Resources::User.from_response(response.body)
       end
 
       sig { override.params(request: Requests::RemoveMemberFromSecondaryGroup).returns(Resources::User) }
@@ -217,7 +214,7 @@ module Nexus
           endpoint: URI("core/members/#{request.member_id}/secgroup/#{request.group_id}"),
         )
 
-        Resources::User.from_hash(response.body)
+        Resources::User.from_response(response.body)
       end
 
       sig { override.params(request: Requests::CreateMemberWarning).returns(Resources::Warning) }
@@ -228,7 +225,7 @@ module Nexus
           params: request.serialize.except("member_id"),
         )
 
-        Resources::Warning.from_hash(response.body)
+        Resources::Warning.from_response(response.body)
       end
 
       sig { override.params(member_id: Integer).returns(Resources::User) }
@@ -238,7 +235,7 @@ module Nexus
           endpoint: URI("core/bans/#{member_id}"),
         )
 
-        Resources::User.from_hash(response.body)
+        Resources::User.from_response(response.body)
       end
 
       sig { override.params(member_id: Integer).returns(Resources::User) }
@@ -248,7 +245,7 @@ module Nexus
           endpoint: URI("core/bans/#{member_id}"),
         )
 
-        Resources::User.from_hash(response.body)
+        Resources::User.from_response(response.body)
       end
 
       sig { override.params(request: Requests::DeleteMember).void }
@@ -269,7 +266,7 @@ module Nexus
           endpoint: URI("core/members/#{request.member_id}"),
           params: request.serialize.except("member_id"),
         )
-        Resources::User.from_hash(response.body)
+        Resources::User.from_response(response.body)
       end
 
       private

data/lib/nexus/invision/client_interface.rb

@@ -15,7 +15,6 @@ 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"
@@ -25,7 +24,6 @@ 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"
 
@@ -66,9 +64,6 @@ module Nexus
       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
 

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

@@ -12,6 +12,18 @@ module Nexus
 
         const :id, Integer
         const :created, T::Boolean
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(EnsureMember) }
+          def from_response(response)
+            EnsureMember.new(
+              id: response["id"],
+              created: response["created"],
+            )
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,31 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+require "nexus/invision/value_object"
+
+module Nexus
+  module Invision
+    module Resources
+      class Field < T::Struct
+        include ValueObject
+
+        const :name, String
+        const :value, String
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(Field) }
+          def from_response(response)
+            Field.new(
+              name: response["name"],
+              value: response["value"],
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+require "nexus/invision/value_object"
+require "nexus/invision/resources/field"
+
+module Nexus
+  module Invision
+    module Resources
+      class FieldGroup < T::Struct
+        include ValueObject
+
+        const :name, Integer
+        const :fields, T::Hash[String, Field]
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(FieldGroup) }
+          def from_response(response)
+            FieldGroup.new(
+              name: response["name"],
+              fields: response["fields"].map { |f| Field.from_response(f) },
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+require "nexus/invision/value_object"
+
+module Nexus
+  module Invision
+    module Resources
+      class Forum < T::Struct
+        include ValueObject
+
+        const :id, Integer
+        const :name, String
+        const :path, String
+        const :type, String
+        const :topics, Integer
+        const :url, String
+        const :parentId, T.nilable(Integer)
+        const :permissions, T.nilable(T::Hash[T.untyped, T.untyped])
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(Forum) }
+          def from_response(response)
+            Forum.new(
+              id: response["id"],
+              name: response["name"],
+              path: response["path"],
+              type: response["type"],
+              topics: response["topics"],
+              url: response["url"],
+              parentId: response["parentId"],
+              permissions: response["permissions"],
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -12,6 +12,18 @@ module Nexus
 
         const :id, Integer
         const :name, String
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(Group) }
+          def from_response(response)
+            Group.new(
+              id: response["id"],
+              name: response["name"],
+            )
+          end
+        end
       end
     end
   end

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

@@ -11,6 +11,17 @@ module Nexus
         include ValueObject
 
         const :id, Integer
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(LoginLink) }
+          def from_response(response)
+            LoginLink.new(
+              id: response["id"],
+            )
+          end
+        end
       end
     end
   end

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

@@ -1,9 +1,12 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "nexus/invision/value_object"
 require "sorbet-runtime"
 
+require "nexus/invision/value_object"
+require "nexus/invision/resources/rank"
+require "nexus/invision/resources/field_group"
+
 module Nexus
   module Invision
     module Resources
@@ -12,7 +15,44 @@ module Nexus
         include ValueObject
 
         const :id, Integer
+        # const :name, String
+        # const :title, T.nilable(String)
+        # const :timeZone, String
+        # const :formattedName, String
         const :primaryGroup, Group
+        # const :secondaryGroups, T::Array[Group]
+        # const :email, String
+        # const :joined, Time
+        # const :registrationIpAddress, String
+        # const :warningPoints, Integer
+        # const :reputationPoints, Integer
+        # const :photoUrl, String
+        # const :photoUrlIsDefault, T::Boolean
+        # const :coverPhotoUrl, String
+        # const :profileUrl, T.nilable(String)
+        # const :validating, T::Boolean
+        # const :posts, Integer
+        # const :lastActivity, Time
+        # const :lastVisit, Time
+        # const :birthday, Date
+        # const :profileViews, Integer
+        # const :customFields, T::Hash[String, FieldGroup]
+        # const :rank, Rank
+        # const :achievements_points, Integer
+        # const :allowAdminEmails, T::Boolean
+        # const :completed, T::Boolean
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(Member) }
+          def from_response(response)
+            Member.new(
+              id: response["id"],
+              primaryGroup: Group.from_response(response["primaryGroup"]),
+            )
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,38 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+require "nexus/invision/resources/question"
+require "nexus/invision/value_object"
+
+module Nexus
+  module Invision
+    module Resources
+      # Member is a User with additional information about their membership.
+      class Poll < T::Struct
+        include ValueObject
+
+        const :id, Integer
+        # const :title, String
+        # const :start_date, DateTime
+        # const :closed, T::Boolean
+        # const :closedDate, String
+        # const :public, T::Boolean
+        # const :votes, Integer
+        # const :questions, T::Array[Question]
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(Poll) }
+          def from_response(response)
+            Poll.new(
+              id: response["id"],
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,9 +1,11 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "nexus/invision/value_object"
 require "sorbet-runtime"
 
+require "nexus/invision/value_object"
+require "nexus/invision/resources/member"
+
 module Nexus
   module Invision
     module Resources
@@ -12,6 +14,24 @@ module Nexus
 
         const :id, Integer
         const :item_id, Integer
+        # const :author, Member
+        # const :date, Time
+        # const :content, String
+        # const :hidden, T::Boolean
+        # const :url, String
+        # const :reactions, T::Hash[String, T::Array[String]]
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(Post) }
+          def from_response(response)
+            Post.new(
+              id: response["id"],
+              item_id: response["item_id"],
+            )
+          end
+        end
       end
     end
   end

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

@@ -0,0 +1,32 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+require "nexus/invision/value_object"
+
+module Nexus
+  module Invision
+    module Resources
+      # Member is a User with additional information about their membership.
+      class Question < T::Struct
+        include ValueObject
+
+        const :question, String
+        const :options, T::Hash[String, T.untyped]
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(Question) }
+          def from_response(response)
+            Question.new(
+              question: response["question"],
+              options: response["options"],
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# typed: strict
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+module Nexus
+  module Invision
+    module Resources
+      class Rank < T::Struct
+        include ValueObject
+
+        const :id, Integer
+        const :name, String
+        const :icon, String
+        const :points, Integer
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(Rank) }
+          def from_response(response)
+            Rank.new(
+              id: response["id"],
+              name: response["name"],
+              icon: response["icon"],
+              points: response["points"],
+            )
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -2,6 +2,9 @@
 # frozen_string_literal: true
 
 require "nexus/invision/value_object"
+require "nexus/invision/resources/forum"
+require "nexus/invision/resources/post"
+require "nexus/invision/resources/poll"
 require "sorbet-runtime"
 
 module Nexus
@@ -12,6 +15,40 @@ module Nexus
 
         const :id, Integer
         const :title, String
+        # const :forum, Forum
+        # const :posts, Integer
+        # const :views, Integer
+        # const :prefix, String
+        # const :tags, T::Array[String]
+        const :first_post, T.nilable(Post), default: nil
+        const :last_post, T.nilable(Post), default: nil
+        # const :best_answer, T.nilable(Post)
+        # const :locked, T::Boolean
+        # const :hidden, T::Boolean
+        # const :pinned, T::Boolean
+        # const :featured, T::Boolean
+        # const :archived, T::Boolean
+        # const :poll, Poll
+        # const :url, String
+        # const :rating, Float
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(Topic) }
+          def from_response(response)
+            Resources::Topic.new(
+              id: response["id"],
+              title: response["title"],
+              first_post: response["firstPost"]&.then do |fp|
+                Resources::Post.from_response(fp)
+              end,
+              last_post: response["lastPost"]&.then do |lp|
+                Resources::Post.from_response(lp)
+              end,
+            )
+          end
+        end
       end
     end
   end

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

@@ -11,6 +11,17 @@ module Nexus
         include ValueObject
 
         const :id, Integer
+
+        class << self
+          extend T::Sig
+
+          sig { params(response: T::Hash[String, T.untyped]).returns(User) }
+          def from_response(response)
+            User.new(
+              id: Integer(response["id"]),
+            )
+          end
+        end
       end
     end
   end