etwin 0.0.1

data/lib/etwin/auth/user_auth_context.rb

@@ -0,0 +1,83 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Auth
+    # User authentication context
+    class UserAuthContext
+      extend T::Helpers
+      extend T::Sig
+
+      final!
+
+      sig(:final) { returns(AuthScope) }
+      attr_reader :scope
+
+      sig(:final) { returns(Etwin::User::ShortUser) }
+      attr_reader :user
+
+      sig(:final) { returns(T::Boolean) }
+      attr_reader :is_administrator
+
+      sig(:final) { params(scope: AuthScope, user: Etwin::User::ShortUser, is_administrator: T::Boolean).void }
+      def initialize(scope, user, is_administrator)
+        @scope = T.let(scope, AuthScope)
+        @user = T.let(user, Etwin::User::ShortUser)
+        @is_administrator = T.let(is_administrator, T::Boolean)
+        freeze
+      end
+
+      sig(:final) { params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when UserAuthContext
+          @scope == other.scope && @user == other.user && @is_administrator == other.is_administrator
+        else
+          false
+        end
+      end
+
+      sig(:final) { returns(Integer) }
+      def hash
+        [@scope, @user, @is_administrator].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
+        {
+          'scope' => @scope.serialize,
+          'user' => @user.as_json,
+          'is_administrator' => @is_administrator
+        }
+      end
+
+      sig(:final) { returns(String) }
+      def inspect
+        "UserAuthContext(scope=#{@scope.inspect},user=#{@user.inspect},is_administrator=#{@is_administrator.inspect})"
+      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)
+          scope = AuthScope.deserialize(raw['scope'])
+          user = Etwin::User::ShortUser.deserialize(raw['user'])
+          is_administrator = raw['is_administrator']
+          new(scope, user, is_administrator)
+        end
+      end
+    end
+  end
+end

data/lib/etwin/client.rb

@@ -0,0 +1,11 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  # Eternal-Twin API client
+  module Client
+  end
+end
+
+require_relative './client/auth'
+require_relative './client/etwin_client'

data/lib/etwin/client/auth.rb

@@ -0,0 +1,66 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Client
+    # Eternal-Twin client authentication data
+    class Auth
+      extend T::Helpers
+      extend T::Sig
+
+      final!
+
+      sig(:final) { returns(T.nilable(String)) }
+      attr_reader :authorization_header
+
+      sig(:final) { params(authorization_header: T.nilable(String)).void }
+      def initialize(authorization_header)
+        @authorization_header = T.let(authorization_header, T.nilable(String))
+        freeze
+      end
+
+      sig(:final) { params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when Auth
+          @authorization_header == other.authorization_header
+        else
+          false
+        end
+      end
+
+      sig(:final) { returns(Integer) }
+      def hash
+        [@authorization_header].hash
+      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)
+        pp.group(0, "#{self.class.name}(", ')') do
+          pp.nest 1 do
+            pp.breakable ''
+            pp.text 'authorization_header='
+            pp.pp @authorization_header
+          end
+          pp.breakable ''
+        end
+      end
+
+      Guest = new(nil)
+
+      class << self
+        extend T::Sig
+
+        sig(:final) { params(key: String).returns(T.attached_class) }
+        def from_token(key)
+          new("Bearer #{key}")
+        end
+      end
+    end
+  end
+end

data/lib/etwin/client/etwin_client.rb

@@ -0,0 +1,17 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Client
+    # Etwin client interface
+    class EtwinClient
+      extend T::Helpers
+      extend T::Sig
+
+      interface!
+
+      sig { abstract.params(auth: Auth, user_id: UserId).returns(User) }
+      def get_user(auth, user_id); end
+    end
+  end
+end

data/lib/etwin/client/http_etwin_client.rb

@@ -0,0 +1,36 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Client
+    # HTTP Etwin client interface
+    class HttpEtwinClient
+      extend T::Helpers
+      extend T::Sig
+
+      include EtwinClient
+
+      final!
+
+      sig(:final) { params(base_uri: URI::HTTP).void }
+      def initialize(base_uri)
+        @base_uri = T.let(base_uri.freeze, URI::HTTP)
+        freeze
+      end
+
+      sig(:final) { params(auth: Auth, user_id: UserId).returns(User) }
+      def get_user(auth, user_id)
+        uri = resolve(['users', user_id.to_s])
+        res = Faraday.get uri
+        pp res
+      end
+
+      private
+
+      sig(:final) { params(segments: T::Array[String]).returns(URI::HTTP) }
+      def resolve(segments)
+        @base_uri.merge("api/v1/#{ segments * '/'}")
+      end
+    end
+  end
+end

data/lib/etwin/core.rb

@@ -0,0 +1,10 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  # Core Eternal-Twin types
+  module Core
+  end
+end
+
+require_relative './core/object_type'

data/lib/etwin/core/object_type.rb

@@ -0,0 +1,35 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Core
+    # Object type enum
+    class ObjectType < T::Enum
+      extend T::Sig
+
+      enums do
+        ClientForumActor = new('ClientForumActor')
+        ForumPost = new('ForumPost')
+        ForumPostRevision = new('ForumPostRevision')
+        ForumSection = new('ForumSection')
+        ForumThread = new('ForumThread')
+        HammerfestUser = new('HammerfestUser')
+        OauthClient = new('OauthClient')
+        RoleForumActor = new('RoleForumActor')
+        TwinoidUser = new('TwinoidUser')
+        User = new('User')
+        UserForumActor = new('UserForumActor')
+      end
+
+      sig { returns(String) }
+      def to_s
+        T.cast(serialize, String)
+      end
+
+      sig { returns(String) }
+      def inspect
+        "ObjectType(#{self})"
+      end
+    end
+  end
+end

data/lib/etwin/hammerfest.rb

@@ -0,0 +1,13 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  # Hammerfest module
+  module Hammerfest
+  end
+end
+
+require_relative './hammerfest/hammerfest_server'
+require_relative './hammerfest/hammerfest_user_id'
+require_relative './hammerfest/hammerfest_username'
+require_relative './hammerfest/short_hammerfest_user'

data/lib/etwin/hammerfest/hammerfest_server.rb

@@ -0,0 +1,27 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Hammerfest
+    # A valid Hammerfest server
+    class HammerfestServer < T::Enum
+      extend T::Sig
+
+      enums do
+        HammerfestEs = new('hammerfest.es')
+        HammerfestFr = new('hammerfest.fr')
+        HfestNet = new('hfest.net')
+      end
+
+      sig { returns(String) }
+      def to_s
+        T.cast(serialize, String)
+      end
+
+      sig { returns(String) }
+      def inspect
+        "HammerfestServer(#{self})"
+      end
+    end
+  end
+end

data/lib/etwin/hammerfest/hammerfest_user_id.rb

@@ -0,0 +1,57 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Hammerfest
+    # A valid Hammerfest user id
+    class HammerfestUserId
+      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 HammerfestUserId
+          @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
+        "HammerfestUserId(#{@inner})"
+      end
+    end
+  end
+end

data/lib/etwin/hammerfest/hammerfest_username.rb

@@ -0,0 +1,57 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Hammerfest
+    # A valid Hammerfest username
+    class HammerfestUsername
+      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 HammerfestUsername
+          @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
+        "HammerfestUsername(#{@inner})"
+      end
+    end
+  end
+end

data/lib/etwin/hammerfest/short_hammerfest_user.rb

@@ -0,0 +1,103 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Hammerfest
+    # Hammerfest user reference with username
+    class ShortHammerfestUser
+      extend T::Helpers
+      extend T::Sig
+
+      final!
+
+      sig(:final) { returns(HammerfestServer) }
+      attr_reader :server
+
+      sig(:final) { returns(HammerfestUserId) }
+      attr_reader :id
+
+      sig(:final) { returns(HammerfestUsername) }
+      attr_reader :username
+
+      sig(:final) { params(server: HammerfestServer, id: HammerfestUserId, username: HammerfestUsername).void }
+      def initialize(server, id, username)
+        @server = T.let(server, HammerfestServer)
+        @id = T.let(id, HammerfestUserId)
+        @username = T.let(username, HammerfestUsername)
+        freeze
+      end
+
+      sig(:final) { params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when ShortHammerfestUser
+          @server == other.server && @id == other.id && @username == other.username
+        else
+          false
+        end
+      end
+
+      sig(:final) { returns(Integer) }
+      def hash
+        [@server, @id, @username].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
+        {
+          'server' => @server.serialize,
+          'id' => @id.as_json,
+          'username' => @username.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 'server='
+            pp.pp @server
+            pp.text ','
+            pp.breakable ''
+            pp.text 'id='
+            pp.pp @id
+            pp.text ','
+            pp.breakable ''
+            pp.text 'username='
+            pp.pp @username
+          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)
+          server = HammerfestServer.deserialize(raw['server'])
+          id = HammerfestUserId.new(raw['id'])
+          username = HammerfestUsername.new(raw['username'])
+          new(server, id, username)
+        end
+      end
+    end
+  end
+end