etwin 0.0.1

data/lib/etwin/link/versioned_twinoid_link.rb

@@ -0,0 +1,93 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Link
+    # Versioned Twinoid link
+    class VersionedTwinoidLink
+      extend T::Helpers
+      extend T::Sig
+
+      final!
+
+      sig(:final) { returns(T.nilable(TwinoidLink)) }
+      attr_reader :current
+
+      sig(:final) { returns(T::Array[TwinoidLink]) }
+      attr_reader :old
+
+      sig(:final) { params(current: T.nilable(TwinoidLink), old: T::Array[TwinoidLink]).void }
+      def initialize(current, old)
+        @current = T.let(current, T.nilable(TwinoidLink))
+        @old = T.let(old.freeze, T::Array[TwinoidLink])
+        freeze
+      end
+
+      sig(:final) { params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when VersionedTwinoidLink
+          @current == other.current && @old == other.old
+        else
+          false
+        end
+      end
+
+      sig(:final) { returns(Integer) }
+      def hash
+        [@current, @old].hash
+      end
+
+      # https://github.com/sorbet/sorbet/blob/master/rbi/stdlib/json.rbi#L194
+      sig(:final) { params(opts: T.untyped).returns(String) }
+      def to_json(opts = nil)
+        JSON.generate(as_json, opts)
+      end
+
+      sig(:final) { returns(T::Hash[String, T.untyped]) }
+      def as_json
+        {
+          'current' => @current.nil? ? nil : @current.as_json,
+          'old' => @old.map(&:as_json)
+        }
+      end
+
+      sig(:final) { returns(String) }
+      def inspect
+        PP.singleline_pp(self, String.new)
+      end
+
+      sig(:final) { params(pp: T.untyped).returns(T.untyped) }
+      def pretty_print(pp)  # rubocop:disable Metrics/MethodLength
+        pp.group(0, "#{self.class.name}(", ')') do
+          pp.nest 1 do
+            pp.breakable ''
+            pp.text 'current='
+            pp.pp @current
+            pp.text ','
+            pp.breakable ''
+            pp.text 'old='
+            pp.pp @old
+          end
+          pp.breakable ''
+        end
+      end
+
+      class << self
+        extend T::Sig
+
+        sig(:final) { params(json_str: String).returns(T.attached_class) }
+        def from_json(json_str)
+          deserialize JSON.parse(json_str)
+        end
+
+        sig(:final) { params(raw: T.untyped).returns(T.attached_class) }
+        def deserialize(raw)
+          raw_current = raw['current']
+          current = raw_current.nil? ? nil : TwinoidLink.deserialize(raw_current)
+          new(current, [])
+        end
+      end
+    end
+  end
+end

data/lib/etwin/twinoid.rb

@@ -0,0 +1,12 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  # Twinoid module
+  module Twinoid
+  end
+end
+
+require_relative './twinoid/twinoid_user_id'
+require_relative './twinoid/twinoid_user_display_name'
+require_relative './twinoid/short_twinoid_user'

data/lib/etwin/twinoid/short_twinoid_user.rb

@@ -0,0 +1,93 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Twinoid
+    # Twinoid user reference with enough data to display it
+    class ShortTwinoidUser
+      extend T::Helpers
+      extend T::Sig
+
+      final!
+
+      sig(:final) { returns(TwinoidUserId) }
+      attr_reader :id
+
+      sig(:final) { returns(TwinoidUserDisplayName) }
+      attr_reader :display_name
+
+      sig(:final) { params(id: TwinoidUserId, display_name: TwinoidUserDisplayName).void }
+      def initialize(id, display_name)
+        @id = T.let(id, TwinoidUserId)
+        @display_name = T.let(display_name, TwinoidUserDisplayName)
+        freeze
+      end
+
+      sig(:final) { params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when ShortTwinoidUser
+          @id == other.id && @display_name == other.display_name
+        else
+          false
+        end
+      end
+
+      sig(:final) { returns(Integer) }
+      def hash
+        [@id, @display_name].hash
+      end
+
+      # https://github.com/sorbet/sorbet/blob/master/rbi/stdlib/json.rbi#L194
+      sig(:final) { params(opts: T.untyped).returns(String) }
+      def to_json(opts = nil)
+        JSON.generate(as_json, opts)
+      end
+
+      sig(:final) { returns(T::Hash[String, T.untyped]) }
+      def as_json
+        {
+          'id' => @id.as_json,
+          'display_name' => @display_name.as_json
+        }
+      end
+
+      sig(:final) { returns(String) }
+      def inspect
+        PP.singleline_pp(self, String.new)
+      end
+
+      sig(:final) { params(pp: T.untyped).returns(T.untyped) }
+      def pretty_print(pp)  # rubocop:disable Metrics/MethodLength
+        pp.group(0, "#{self.class.name}(", ')') do
+          pp.nest 1 do
+            pp.breakable ''
+            pp.text 'id='
+            pp.pp @id
+            pp.text ','
+            pp.breakable ''
+            pp.text 'display_name='
+            pp.pp @display_name
+          end
+          pp.breakable ''
+        end
+      end
+
+      class << self
+        extend T::Sig
+
+        sig(:final) { params(json_str: String).returns(T.attached_class) }
+        def from_json(json_str)
+          deserialize JSON.parse(json_str)
+        end
+
+        sig(:final) { params(raw: T.untyped).returns(T.attached_class) }
+        def deserialize(raw)
+          id = TwinoidUserId.new(raw['id'])
+          display_name = TwinoidUserDisplayName.new(raw['display_name'])
+          new(id, display_name)
+        end
+      end
+    end
+  end
+end

data/lib/etwin/twinoid/twinoid_user_display_name.rb

@@ -0,0 +1,57 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Twinoid
+    # A valid Twinoid username
+    class TwinoidUserDisplayName
+      extend T::Helpers
+      extend T::Sig
+
+      final!
+
+      protected
+
+      sig(:final) { returns(String) }
+      attr_reader :inner
+
+      public
+
+      sig(:final) { params(inner: String).void }
+      def initialize(inner)
+        @inner = T.let(inner.freeze, String)
+        freeze
+      end
+
+      sig(:final) { params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when TwinoidUserDisplayName
+          @inner == other.inner
+        else
+          false
+        end
+      end
+
+      sig(:final) { returns(Integer) }
+      def hash
+        @inner.hash
+      end
+
+      sig(:final) { returns(String) }
+      def to_s
+        @inner
+      end
+
+      sig(:final) { returns(String) }
+      def as_json
+        @inner
+      end
+
+      sig(:final) { returns(String) }
+      def inspect
+        "TwinoidUserDisplayName(#{@inner})"
+      end
+    end
+  end
+end

data/lib/etwin/twinoid/twinoid_user_id.rb

@@ -0,0 +1,57 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Twinoid
+    # A valid Twinoid user id
+    class TwinoidUserId
+      extend T::Helpers
+      extend T::Sig
+
+      final!
+
+      protected
+
+      sig(:final) { returns(String) }
+      attr_reader :inner
+
+      public
+
+      sig(:final) { params(inner: String).void }
+      def initialize(inner)
+        @inner = T.let(inner.freeze, String)
+        freeze
+      end
+
+      sig(:final) { params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when TwinoidUserId
+          @inner == other.inner
+        else
+          false
+        end
+      end
+
+      sig(:final) { returns(Integer) }
+      def hash
+        @inner.hash
+      end
+
+      sig(:final) { returns(String) }
+      def to_s
+        @inner
+      end
+
+      sig(:final) { returns(String) }
+      def as_json
+        @inner
+      end
+
+      sig(:final) { returns(String) }
+      def inspect
+        "TwinoidUserId(#{@inner})"
+      end
+    end
+  end
+end

data/lib/etwin/user.rb

@@ -0,0 +1,15 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  # User module
+  module User
+  end
+end
+
+require_relative './user/short_user'
+require_relative './user/user'
+require_relative './user/user_display_name'
+require_relative './user/user_display_name_version'
+require_relative './user/user_display_name_versions'
+require_relative './user/user_id'

data/lib/etwin/user/short_user.rb

@@ -0,0 +1,93 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module User
+    # User with minimum data to identify and display them
+    class ShortUser
+      extend T::Helpers
+      extend T::Sig
+
+      final!
+
+      sig(:final) { returns(UserId) }
+      attr_reader :id
+
+      sig(:final) { returns(UserDisplayNameVersions) }
+      attr_reader :display_name
+
+      sig(:final) { params(id: UserId, display_name: UserDisplayNameVersions).void }
+      def initialize(id, display_name)
+        @id = T.let(id, UserId)
+        @display_name = T.let(display_name, UserDisplayNameVersions)
+        freeze
+      end
+
+      sig(:final) { params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when ShortUser
+          @id == other.id && @display_name == other.display_name
+        else
+          false
+        end
+      end
+
+      sig(:final) { returns(Integer) }
+      def hash
+        [@id, @display_name].hash
+      end
+
+      # https://github.com/sorbet/sorbet/blob/master/rbi/stdlib/json.rbi#L194
+      sig(:final) { params(opts: T.untyped).returns(String) }
+      def to_json(opts = nil)
+        JSON.generate(as_json, opts)
+      end
+
+      sig(:final) { returns(T::Hash[String, T.untyped]) }
+      def as_json
+        {
+          'id' => @id.as_json,
+          'display_name' => @display_name.as_json
+        }
+      end
+
+      sig(:final) { returns(String) }
+      def inspect
+        PP.singleline_pp(self, String.new)
+      end
+
+      sig(:final) { params(pp: T.untyped).returns(T.untyped) }
+      def pretty_print(pp)  # rubocop:disable Metrics/MethodLength
+        pp.group(0, "#{self.class.name}(", ')') do
+          pp.nest 1 do
+            pp.breakable ''
+            pp.text 'id='
+            pp.pp @id
+            pp.text ','
+            pp.breakable ''
+            pp.text 'display_name='
+            pp.pp @display_name
+          end
+          pp.breakable ''
+        end
+      end
+
+      class << self
+        extend T::Sig
+
+        sig(:final) { params(json_str: String).returns(T.attached_class) }
+        def from_json(json_str)
+          deserialize JSON.parse(json_str)
+        end
+
+        sig(:final) { params(raw: T.untyped).returns(T.attached_class) }
+        def deserialize(raw)
+          id = UserId.new(raw['id'])
+          display_name = UserDisplayNameVersions.deserialize(raw['display_name'])
+          new(id, display_name)
+        end
+      end
+    end
+  end
+end

data/lib/etwin/user/user.rb

@@ -0,0 +1,123 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module User
+    # Main user class
+    class User
+      extend T::Helpers
+      extend T::Sig
+
+      final!
+
+      sig(:final) { returns(UserId) }
+      attr_reader :id
+
+      sig(:final) { returns(UserDisplayNameVersions) }
+      attr_reader :display_name
+
+      sig(:final) { returns(T::Boolean) }
+      attr_reader :is_administrator
+
+      sig(:final) { returns(Etwin::Link::VersionedLinks) }
+      attr_reader :links
+
+      sig(:final) do
+        params(
+          id: UserId,
+          display_name: UserDisplayNameVersions,
+          is_administrator: T::Boolean,
+          links: Etwin::Link::VersionedLinks
+        ).void
+      end
+      def initialize(id, display_name, is_administrator, links)
+        @id = T.let(id, UserId)
+        @display_name = T.let(display_name, UserDisplayNameVersions)
+        @is_administrator = T.let(is_administrator, T::Boolean)
+        @links = T.let(links, Etwin::Link::VersionedLinks)
+        freeze
+      end
+
+      sig(:final) { params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when User
+          @id == other.id &&
+            @display_name == other.display_name &&
+            @is_administrator == other.is_administrator &&
+            @links == other.links
+        else
+          false
+        end
+      end
+
+      sig(:final) { returns(Integer) }
+      def hash
+        [@id, @display_name, @is_administrator, @links].hash
+      end
+
+      # https://github.com/sorbet/sorbet/blob/master/rbi/stdlib/json.rbi#L194
+      sig(:final) { params(opts: T.untyped).returns(String) }
+      def to_json(opts = nil)
+        JSON.generate(as_json, opts)
+      end
+
+      sig(:final) { returns(T::Hash[String, T.untyped]) }
+      def as_json
+        {
+          'id' => @id.as_json,
+          'display_name' => @display_name.as_json,
+          'is_administrator' => @is_administrator,
+          'links' => @links.as_json
+        }
+      end
+
+      sig(:final) { returns(String) }
+      def inspect
+        PP.singleline_pp(self, String.new)
+      end
+
+      sig(:final) { params(pp: T.untyped).returns(T.untyped) }
+      def pretty_print(pp)  # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+        pp.group(0, "#{self.class.name}(", ')') do
+          pp.nest 1 do
+            pp.breakable ''
+            pp.text 'id='
+            pp.pp @id
+            pp.text ','
+            pp.breakable ''
+            pp.text 'display_name='
+            pp.pp @display_name
+            pp.text ','
+            pp.breakable ''
+            pp.text 'is_administrator='
+            pp.pp @is_administrator
+            pp.text ','
+            pp.breakable ''
+            pp.text 'links='
+            pp.pp @links
+          end
+          pp.breakable ''
+        end
+      end
+
+      class << self
+        extend T::Sig
+
+        sig(:final) { params(json_str: String).returns(T.attached_class) }
+        def from_json(json_str)
+          deserialize JSON.parse(json_str)
+        end
+
+        sig(:final) { params(raw: T.untyped).returns(T.attached_class) }
+        def deserialize(raw)
+          id = UserId.new(raw['id'])
+          display_name = UserDisplayNameVersions.deserialize(raw['display_name'])
+          is_administrator = raw['is_administrator']
+          links = Etwin::Link::VersionedLinks.deserialize(raw['links'])
+          new(id, display_name, is_administrator, links)
+        end
+      end
+    end
+  end
+end