lapis-yggdrasil 0.5.0

data/lib/lapis/yggdrasil/messaging/response_factory.rb

@@ -0,0 +1,82 @@
+require_relative 'response'
+require_relative 'error_response'
+require_relative 'authentication_response'
+require_relative 'refresh_response'
+
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Parses messages from the server and builds responses from them.
+      class ResponseFactory
+
+        # Generates an instance from a response to an authentication request.
+        # @param message [HTTP::Message] Message received from the server.
+        # @return [AuthenticationResponse] Successful result from authentication.
+        # @return [ErrorResponse] Failure result from authentication.
+        # @see AuthenticationRequest
+        def parse_authentication_response(message)
+          if message.ok?
+            AuthenticationResponse.new(message)
+          else
+            ErrorResponse.new(message)
+          end
+        end
+
+        # Generates an instance from a response to a refresh request.
+        # @param message [HTTP::Message] Message received from the server.
+        # @return [RefreshResponse] Successful result from refresh.
+        # @return [ErrorResponse] Failure result from refresh.
+        # @see RefreshRequest
+        def parse_refresh_response(message)
+          if message.ok?
+            RefreshResponse.new(message)
+          else
+            ErrorResponse.new(message)
+          end
+        end
+
+        # Generates an instance from a response to a validation request.
+        # @param message [HTTP::Message] Message received from the server.
+        # @return [Response] Successful result from validation.
+        # @return [ErrorResponse] Failure result from validation.
+        # @see ValidateRequest
+        def parse_validate_response(message)
+          if message.ok?
+            Response.new(message)
+          else
+            ErrorResponse.new(message)
+          end
+        end
+
+        # Generates an instance from a response to an invalidation request.
+        # @param message [HTTP::Message] Message received from the server.
+        # @return [Response] Successful result from validation.
+        # @return [ErrorResponse] Failure result from validation.
+        # @see InvalidateRequest
+        def parse_invalidate_response(message)
+          if message.ok?
+            Response.new(message)
+          else
+            ErrorResponse.new(message)
+          end
+        end
+
+        # Generates an instance from a response to a signout request.
+        # @param message [HTTP::Message] Message received from the server.
+        # @return [Response] Successful result from signout.
+        # @return [ErrorResponse] Failure result from signout.
+        # @see SignoutRequest
+        def parse_signout_response(message)
+          if message.ok?
+            Response.new(message)
+          else
+            ErrorResponse.new(message)
+          end
+        end
+
+      end
+
+    end
+  end
+end

data/lib/lapis/yggdrasil/messaging/signout_request.rb

@@ -0,0 +1,38 @@
+require 'json'
+require_relative 'request'
+
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Request for invalidating sessions without access tokens.
+      class SignoutRequest < Request
+
+        # Creates a new signout request.
+        # @param username [String] Minecraft username or Mojang account email address.
+        # @param password [String] Password for the user.
+        def initialize(username, password)
+          @username = username.dup.freeze
+          @password = password.dup.freeze
+        end
+
+        # Path on the server that handles the request.
+        # @return [String] Path to handler.
+        def endpoint
+          '/signout'
+        end
+
+        # Generates a JSON string that can be sent to an authentication server.
+        # @return [String] JSON string.
+        def to_json
+          {
+              :username => @username,
+              :password => @password
+          }.to_json
+        end
+
+      end
+
+    end
+  end
+end

data/lib/lapis/yggdrasil/messaging/token_request.rb

@@ -0,0 +1,42 @@
+require_relative 'request'
+
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Type of request that includes access and client tokens.
+      # @abstract
+      class TokenRequest < Request
+
+        protected
+
+        # Unique ID of the client that performed the authentication.
+        # @return [Uuid]
+        attr_reader :client_token
+
+        # Unique ID of the authentication session.
+        # @return [Uuid]
+        attr_reader :access_token
+
+        # Creates a new token request.
+        # @param client_token [Uuid] Unique ID Of the client that performed the authentication.
+        # @param access_token [Uuid] Unique ID of the authentication session.
+        def initialize(client_token, access_token)
+          @client_token = client_token
+          @access_token = access_token
+        end
+
+        # Generates a structure that can be used for generating JSON.
+        # @return [Hash] Structure containing token information.
+        def structure
+          {
+              :accessToken => @access_token.to_s(false),
+              :clientToken => @client_token.to_s(false)
+          }
+        end
+
+      end
+
+    end
+  end
+end

data/lib/lapis/yggdrasil/messaging/token_response.rb

@@ -0,0 +1,36 @@
+require 'json'
+require 'lapis/uuid'
+require_relative 'response'
+
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Type of response that includes access and client tokens.
+      # @abstract
+      class TokenResponse < Response
+
+        # Unique ID of the client that performed the authentication.
+        # @return [Uuid]
+        attr_reader :client_token
+
+        # Unique ID of the authentication session.
+        # @return [Uuid]
+        attr_reader :access_token
+
+        protected
+
+        # Creates a token response by parsing a response message.
+        # @param message [HTTP::Message] Message received from the server.
+        def initialize(message)
+          super(message)
+          hash = JSON.parse(message.body)
+          @client_token = Uuid.parse(hash['clientToken'])
+          @access_token = Uuid.parse(hash['accessToken'])
+        end
+
+      end
+
+    end
+  end
+end

data/lib/lapis/yggdrasil/messaging/validate_request.rb

@@ -0,0 +1,34 @@
+require 'json'
+require_relative 'token_request'
+
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Request for checking if a session is still valid.
+      class ValidateRequest < TokenRequest
+
+        # Creates a new validate request.
+        # @param client_token [Uuid] Unique ID Of the client that performed the authentication.
+        # @param access_token [Uuid] Unique ID of the authentication session.
+        def initialize(client_token, access_token)
+          super(client_token, access_token)
+        end
+
+        # Path on the server that handles the request.
+        # @return [String] Path to handler.
+        def endpoint
+          '/validate'
+        end
+
+        # Generates a JSON string that can be sent to an authentication server.
+        # @return [String] JSON string.
+        def to_json
+          structure.to_json
+        end
+
+      end
+
+    end
+  end
+end

data/lib/lapis/yggdrasil/profile.rb

@@ -0,0 +1,65 @@
+require 'lapis/uuid'
+
+module Lapis
+  module Yggdrasil
+
+    # Player information associated with a game.
+    class Profile
+
+      # Unique ID of the profile.
+      # @return [Uuid]
+      attr_reader :id
+
+      # Displayed player name.
+      # @return [String]
+      attr_reader :name
+
+      # @!attribute [r] legacy?
+      #   Indicates whether the user hasn't migrated to a Mojang account.
+      #   @return [true] The profile has *not* been migrated to a Mojang account.
+      #   @return [false] The profile has been migrated to a Mojang account.
+      def legacy?
+        @is_legacy
+      end
+
+      # Creates a player profile.
+      # @param id [Uuid] Unique ID of the profile.
+      # @param name [String] Displayed player name.
+      # @param is_legacy [Boolean] +true+ if the profile hasn't been migrated to a Mojang account, or +false+ if it has.
+      def initialize(id, name, is_legacy = false)
+        @id        = id
+        @name      = name.dup.freeze
+        @is_legacy = !!is_legacy
+      end
+
+      # Compares the profile to another.
+      # @param other [Profile] Profile to compare against.
+      # @return [true] The profiles are the same.
+      # @return [false] The profiles are different.
+      def ==(other)
+        other.id == @id &&
+            other.name == @name &&
+            other.legacy? == @is_legacy
+      end
+
+      # Creates a profile from a set of properties in a response.
+      # @param properties [Hash<Symbol => String>] Set of properties.
+      # @option properties [String] :id Unique ID of the profile.
+      # @option properties [String] :name Displayed player name.
+      # @option properties [String] :legacy +true+ or +false+ indicating whether the user hasn't migrated to a Mojang account.
+      # @return [Profile]
+      # @raise [ArgumentError] The +:id+ or +:name+ property is missing.
+      def self.from_properties(properties)
+        fail ArgumentError, 'ID is required' unless properties.key?(:id)
+        fail ArgumentError, 'Name is required' unless properties.key?(:name)
+
+        id        = Lapis::Uuid.parse(properties[:id])
+        name      = properties[:name]
+        is_legacy = (properties.key?(:legacy) && properties[:legacy] == 'true')
+        new(id, name, is_legacy)
+      end
+
+    end
+
+  end
+end

data/lib/lapis/yggdrasil/session.rb

@@ -0,0 +1,60 @@
+module Lapis
+  module Yggdrasil
+
+    # Manages state information and transitioning for a session.
+    # @see SessionInfo
+    class Session
+
+      # Information about the current session.
+      # @return [SessionInfo]
+      attr_reader :info
+
+      # @!attribute [r] valid?
+      #   Indicates whether the session is still valid on the server.
+      #   @return [true] The session is valid.
+      #   @return [false] The session has expired and shouldn't be used.
+      def valid?
+        @is_valid &&= validate
+      end
+
+      # Creates a new session.
+      # The session still needs to be authenticated after initialization.
+      # @param info [SessionInfo] Information about the current session.
+      # @param client [AuthenticationClient] Client used to perform authentication actions.
+      def initialize(info, client)
+        @info     = info
+        @client   = client
+        @is_valid = true
+      end
+
+      # Refresh the session so it can be used again.
+      # @param profile [Profile, nil] Profile to switch to.
+      #   Set to +nil+ to keep the current profile.
+      # @return [SessionInfo] Updated session information.
+      # @note Setting +profile+ to anything other than +nil+ will result in an error.
+      #   In the current version of Yggdrasil, switching profiles is not supported.
+      # @raise [AuthenticationError] A problem occurred with authentication.
+      def refresh(profile = nil)
+        @info = @client.refresh(@info, profile)
+      end
+
+      # Checks that the session is still valid.
+      # @return [true] The session is still valid.
+      # @return [false] The session is no longer valid.
+      # @raise [AuthenticationError] A problem occurred with authentication.
+      def validate
+        @client.validate(@info)
+      end
+
+      # Marks the session as not valid.
+      # @return [void]
+      # @raise [AuthenticationError] A problem occurred with authentication.
+      def invalidate
+        @client.invalidate(@info)
+        @is_valid = false
+      end
+
+    end
+
+  end
+end

data/lib/lapis/yggdrasil/session_info.rb

@@ -0,0 +1,62 @@
+require 'lapis/uuid'
+require_relative 'profile'
+
+module Lapis
+  module Yggdrasil
+
+    # Token and profile information associated with an authentication session.
+    class SessionInfo
+
+      # Unique ID of the client that performed the authentication.
+      # @return [Uuid]
+      attr_reader :client_token
+
+      # Unique ID of the authentication session.
+      # @return [Uuid]
+      attr_reader :access_token
+
+      # Information about the currently selected player profile.
+      # @return [Profile]
+      attr_reader :profile
+
+      # Creates information about an authentication session.
+      # @param client_token [Uuid] Unique ID of the client that performed the authentication.
+      # @param access_token [Uuid] Unique ID of the authentication session.
+      # @param profile [Profile] Information about the currently selected player profile.
+      def initialize(client_token, access_token, profile)
+        @client_token = client_token
+        @access_token = access_token
+        @profile      = profile
+      end
+
+      # Compares this session information to another.
+      # @param other [SessionInfo] Session information to compare against.
+      # @return [true] The session information is identical.
+      # @return [false] The session information is different.
+      def ==(other)
+        other.client_token == @client_token &&
+            other.access_token == @access_token &&
+            other.profile == @profile
+      end
+
+      # Creates information about an authentication session from response properties.
+      # @param properties [Hash] Set of properties.
+      # @option properties [String] :clientToken Unique ID of the client that performed the authentication.
+      # @option properties [String] :accessToken Unique ID of the authentication session.
+      # @option properties [Hash] :selectedProfile Information about the currently selected player profile.
+      # @return [SessionInfo] Information about an authentication session pulled from a set of properties.
+      def self.from_properties(properties)
+        fail ArgumentError, 'Client token is required'     unless properties.key?(:clientToken)
+        fail ArgumentError, 'Access token is required'     unless properties.key?(:accessToken)
+        fail ArgumentError, 'Selected profile is required' unless properties.key?(:selectedProfile)
+
+        client_token = Uuid.parse(properties[:clientToken])
+        access_token = Uuid.parse(properties[:accessToken])
+        profile      = Profile.from_properties(properties[:selectedProfile])
+        new(client_token, access_token, profile)
+      end
+
+    end
+
+  end
+end

data/lib/lapis/yggdrasil/version.rb

@@ -0,0 +1,5 @@
+module Lapis
+  module Yggdrasil
+    VERSION = '0.5.0'
+  end
+end

data/spec/factories/agent_factory.rb

@@ -0,0 +1,10 @@
+FactoryGirl.define do
+  factory :agent, class: Lapis::Yggdrasil::Agent do
+    transient do
+      name 'Minecraft'
+      version 1
+    end
+
+    initialize_with { new(name, version) }
+  end
+end