etwin 0.0.3 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69cc4a2279c94d413db0a4481a1370c9fc3f4e941c51742bff6398d19c76df74
-  data.tar.gz: c9c3e99a3f1242cb68adeb9b3edb8264855777698dc31df601e6845d5bc45e52
+  metadata.gz: 4c116defe51194b8f40c3496884b3a551fc0388c28a606a0dccfe2618b7700d8
+  data.tar.gz: 19151aa9323d4de434f1606d9943faedba65451d7b307bb8b302816bc4e366a6
 SHA512:
-  metadata.gz: d3d1d50d6109fa53d73b009cdf2e7bb866ad9eb7e70a92a4ee00663799111023c74cdaba9cfb4683bff2ba607f8bc54ab9c9b96609f6ee48ee5b8649a304c842
-  data.tar.gz: a24475b7fece1104fa8deca475d8de443a897c2c24c8908914094ed69dc5614c85f245575d86cccf5423c77f20c8a46cde7bcd9a0f434662cbd10ba994a05fba
+  metadata.gz: dbb9665963eb211d4ea1b1c271a48a747c62723614716a81ae100b6d7df9b6e39de8673128c95c1a96375fe3e14a1220305d7d0117c38638fb290c58dea29be7
+  data.tar.gz: 95a308a4d2ec53dfe51f189cb939b803b2f5adc8b9f18adbebae6455314067cebfe5844dd9330f73618f377cb6b7e3dc67959d5e722e9b1121259907f611d2de

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    etwin (0.0.2)
+    etwin (0.3.2)
       faraday (~> 1.1.0)
       sorbet-runtime (~> 0.5.6076)
 

data/README.md

@@ -33,6 +33,7 @@ bundle exec rubocop
 bundle exec rspec
 # bundle exec rake release
 # bundle exec rake install
+bundle exec srb rbi update
 bundle exec srb tc
 # gem build
 # gem push ...

data/lib/etwin.rb

@@ -21,6 +21,7 @@ require_relative './etwin/client'
 require_relative './etwin/core'
 require_relative './etwin/hammerfest'
 require_relative './etwin/link'
+require_relative './etwin/oauth'
 require_relative './etwin/twinoid'
 require_relative './etwin/user'
 require_relative './etwin/version'

data/lib/etwin/auth.rb

@@ -7,6 +7,7 @@ module Etwin
   end
 end
 
+require_relative './auth/access_token_auth_context'
 require_relative './auth/auth_context'
 require_relative './auth/auth_scope'
 require_relative './auth/auth_type'

data/lib/etwin/auth/_auth_context.rb

@@ -20,6 +20,7 @@ module Etwin
       def AuthContext.deserialize(raw)
         type = AuthType.deserialize(raw['type'])
         case type
+        when AuthType::AccessToken then AccessTokenAuthContext.deserialize(raw)
         when AuthType::Guest then GuestAuthContext.deserialize(raw)
         when AuthType::User then UserAuthContext.deserialize(raw)
         else T.absurd(type)

data/lib/etwin/auth/access_token_auth_context.rb

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

data/lib/etwin/auth/auth_type.rb

@@ -8,6 +8,7 @@ module Etwin
       extend T::Sig
 
       enums do
+        AccessToken = new('AccessToken')
         Guest = new('Guest')
         User = new('User')
       end

data/lib/etwin/client/auth.rb

@@ -51,7 +51,7 @@ module Etwin
         end
       end
 
-      Guest = new(nil)
+      Guest = T.let(new(nil), Auth)
 
       class << self
         extend T::Sig

data/lib/etwin/client/http_etwin_client.rb

@@ -36,7 +36,7 @@ module Etwin
 
       sig(:final) { params(segments: T::Array[String]).returns(URI::HTTP) }
       def resolve(segments)
-        @base_uri.merge("api/v1/#{ segments * '/'}")
+        T.cast(@base_uri.merge("api/v1/#{ segments * '/'}"), URI::HTTP)
       end
     end
   end

data/lib/etwin/oauth.rb

@@ -0,0 +1,13 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  # Oauth module
+  module Oauth
+  end
+end
+
+require_relative './oauth/oauth_client_display_name'
+require_relative './oauth/oauth_client_id'
+require_relative './oauth/oauth_client_key'
+require_relative './oauth/short_oauth_client'

data/lib/etwin/oauth/oauth_client_display_name.rb

@@ -0,0 +1,57 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Oauth
+    # A valid Eternal-Twin OAuth client display name
+    class OauthClientDisplayName
+      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 OauthClientDisplayName
+          @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
+        "OauthClientDisplayName(#{@inner})"
+      end
+    end
+  end
+end

data/lib/etwin/oauth/oauth_client_id.rb

@@ -0,0 +1,57 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Oauth
+    # A valid Eternal-Twin OAuth client id
+    class OauthClientId
+      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 OauthClientId
+          @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
+        "OauthClientId(#{@inner})"
+      end
+    end
+  end
+end

data/lib/etwin/oauth/oauth_client_key.rb

@@ -0,0 +1,57 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Oauth
+    # A valid Eternal-Twin OAuth client key
+    class OauthClientKey
+      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 OauthClientKey
+          @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
+        "OauthClientKey(#{@inner})"
+      end
+    end
+  end
+end

data/lib/etwin/oauth/short_oauth_client.rb

@@ -0,0 +1,104 @@
+# typed: strict
+# frozen_string_literal: true
+
+module Etwin
+  module Oauth
+    # OAuth client with minimum data to identify and display it
+    class ShortOauthClient
+      extend T::Helpers
+      extend T::Sig
+
+      final!
+
+      sig(:final) { returns(OauthClientId) }
+      attr_reader :id
+
+      sig(:final) { returns(T.nilable(OauthClientKey)) }
+      attr_reader :key
+
+      sig(:final) { returns(OauthClientDisplayName) }
+      attr_reader :display_name
+
+      sig(:final) { params(id: OauthClientId, key: T.nilable(OauthClientKey), display_name: OauthClientDisplayName).void }
+      def initialize(id, key, display_name)
+        @id = T.let(id, OauthClientId)
+        @key = T.let(key, T.nilable(OauthClientKey))
+        @display_name = T.let(display_name, OauthClientDisplayName)
+        freeze
+      end
+
+      sig(:final) { params(other: BasicObject).returns(T::Boolean) }
+      def ==(other)
+        case other
+        when ShortOauthClient
+          @id == other.id && @key == other.key && @display_name == other.display_name
+        else
+          false
+        end
+      end
+
+      sig(:final) { returns(Integer) }
+      def hash
+        [@id, @key, @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,
+          'key' => @key.nil? ? nil : @key.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 'key='
+            pp.pp @key
+            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 = OauthClientId.new(raw['id'])
+          raw_key = raw['key']
+          key = raw_key.nil? ? nil : OauthClientKey.new(raw_key)
+          display_name = OauthClientDisplayName.new(raw['display_name'])
+          new(id, key, display_name)
+        end
+      end
+    end
+  end
+end