lapis-yggdrasil 0.5.0

data/lib/lapis/yggdrasil/client.rb

@@ -0,0 +1,38 @@
+require 'httpclient'
+
+module Lapis
+  module Yggdrasil
+
+    # Provides low-level interaction with an REST-ful server.
+    # @abstract
+    class Client
+
+      private
+
+      # HTTP headers to send as part of requests.
+      HEADERS = {
+          'Content-Type' => 'application/json'
+      }.freeze
+
+      protected
+
+      # Creates a new interface to an authentication server.
+      # @param url [String] Base URL of the authentication server.
+      def initialize(url)
+        @url    = url.dup.freeze
+        @client = HTTPClient.new
+      end
+
+      # Sends a request to the server and waits for a response.
+      # @param message [Messaging::Request] Request to send.
+      # @return [HTTP::Message] Response received from the server.
+      def send_request(message)
+        url  = @url + message.endpoint
+        body = message.to_json
+        @client.post(url, :body => body, :header => HEADERS)
+      end
+
+    end
+
+  end
+end

data/lib/lapis/yggdrasil/error_codes.rb

@@ -0,0 +1,43 @@
+module Lapis
+  module Yggdrasil
+
+    # Constants describing a type of error.
+    # @see Error
+    module ErrorCodes
+
+      # The method specified in the request is not allowed for the resource identified by the request URI.
+      # Something other than a `POST` request was received.
+      METHOD_NOT_ALLOWED = :method_not_allowed
+
+      # The server has not found anything matches the request URI.
+      # Non-existing endpoint was called.
+      NOT_FOUND = :not_found
+
+      # Invalid credentials - account has migrated to Mojang account.
+      # Use e-mail as username.
+      ACCOUNT_MIGRATED = :account_migrated
+
+      # Invalid credentials - bad username or password.
+      INVALID_CREDENTIALS = :invalid_credentials
+
+      # Invalid credentials - too many login attempts with this username recently.
+      # @note Username and password may still be valid.
+      TOO_MANY_ATTEMPTS = :too_many_attempts
+
+      # Invalid token - provided access token is invalid.
+      INVALID_TOKEN = :invalid_token
+
+      # Access token already has a profile assigned.
+      # Selecting profiles isn't implemented yet.
+      PROFILE_NOT_SUPPORTED = :profile_not_supported
+
+      # Username and password was not provided.
+      NO_CREDENTIALS = :no_credentials
+
+      # The server received something other than a message body with JSON.
+      UNSUPPORTED_MEDIA_TYPE = :unsupported_media_type
+
+    end
+
+  end
+end

data/lib/lapis/yggdrasil/messaging.rb

@@ -0,0 +1,23 @@
+module Lapis
+  module Yggdrasil
+
+    # Representation of requests and responses sent to and from the authentication server.
+    module Messaging
+    end
+
+  end
+end
+
+require_relative 'messaging/request'
+require_relative 'messaging/token_request'
+require_relative 'messaging/authentication_request'
+require_relative 'messaging/refresh_request'
+require_relative 'messaging/validate_request'
+require_relative 'messaging/signout_request'
+require_relative 'messaging/invalidate_request'
+require_relative 'messaging/response'
+require_relative 'messaging/error_response'
+require_relative 'messaging/token_response'
+require_relative 'messaging/authentication_response'
+require_relative 'messaging/refresh_response'
+require_relative 'messaging/response_factory'

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

@@ -0,0 +1,50 @@
+require 'json'
+require_relative 'request'
+
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Message sent to attempt to authenticate.
+      # @see AuthenticationResponse
+      class AuthenticationRequest < Request
+
+        # Creates a new authentication request.
+        # @param username [String] Minecraft username or Mojang account email address.
+        # @param password [String] Password for the user.
+        # @param agent [Agent] Game information being requested.
+        # @param client_token [Uuid, nil] ID for the client instance.
+        #   Provide +nil+ to have the authentication server provide one.
+        def initialize(username, password, agent, client_token = nil)
+          @username     = username.dup.freeze
+          @password     = password.dup.freeze
+          @agent        = agent
+          @client_token = client_token
+        end
+
+        # Path on the server that handles the request.
+        # @return [String] Path to handler.
+        def endpoint
+          '/authenticate'
+        end
+
+        # Generates a JSON string that can be sent to an authentication server.
+        # @return [String] JSON string.
+        def to_json
+          hash = {
+              :agent => {
+                  :name    => @agent.name,
+                  :version => @agent.version
+              },
+              :username => @username,
+              :password => @password
+          }
+          hash[:clientToken] = @client_token.to_s(false) if @client_token
+          hash.to_json
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require 'json'
+require_relative 'token_response'
+require_relative '../profile'
+
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Response to a an authentication request.
+      # @see AuthenticationRequest
+      class AuthenticationResponse < TokenResponse
+
+        # List of profiles to choose from.
+        # @return [Array<Profile>]
+        attr_reader :available_profiles
+
+        # Currently active profile for the user's selected game.
+        # @return [Profile]
+        attr_reader :selected_profile
+
+        # Creates a new authentication response by parsing a message from the server.
+        # @param message [HTTP::Message] Authentication message from the server.
+        def initialize(message)
+          super(message)
+          hash = JSON.parse(message.body, :symbolize_names => true)
+          @available_profiles = hash[:availableProfiles].map do |properties|
+            Profile.from_properties(properties)
+          end.freeze
+          @selected_profile = Profile.from_properties(hash[:selectedProfile])
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+require 'json'
+require_relative 'response'
+require_relative '../authentication_error'
+require_relative '../error_codes'
+
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Response to a request indicating a problem occurred.
+      class ErrorResponse < Response
+
+        # Keywords describing the problem.
+        # @return [String]
+        attr_reader :error
+
+        # Brief description of the problem.
+        # @return [String]
+        attr_reader :message
+
+        # Additional information about the root of the problem.
+        # @return [String] Additional information.
+        # @return [nil] No additional information available.
+        attr_reader :cause
+
+        # Creates a new error response by parsing a message from the server.
+        # @param message [HTTP::Message] Error message from the server.
+        def initialize(message)
+          super(message)
+          hash     = JSON.parse(message.body)
+          @error   = hash['error']
+          @message = hash['errorMessage']
+          @cause   = hash['cause']
+        end
+
+        # Creates a throwable exception from the response information.
+        # @return [AuthenticationError]
+        def to_error
+          code = case @error
+                   when 'Method Not Allowed'
+                     ErrorCodes::METHOD_NOT_ALLOWED
+                   when 'Not Found'
+                     ErrorCodes::NOT_FOUND
+                   when 'ForbiddenOperationException'
+                     if @cause == 'UserMigratedException'
+                       ErrorCodes::ACCOUNT_MIGRATED
+                     else
+                       case @message
+                         when /username/
+                           ErrorCodes::INVALID_CREDENTIALS
+                         when /credentials/
+                           ErrorCodes::TOO_MANY_ATTEMPTS
+                         when /token/
+                           ErrorCodes::INVALID_TOKEN
+                       end
+                     end
+                   when 'IllegalArgumentException'
+                     case @message
+                       when /profile/
+                         ErrorCodes::PROFILE_NOT_SUPPORTED
+                       when /credentials/
+                         ErrorCodes::NO_CREDENTIALS
+                     end
+                   when 'Unsupported Media Type'
+                     ErrorCodes::UNSUPPORTED_MEDIA_TYPE
+                 end
+          AuthenticationError.new(code, @message)
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+require 'json'
+require_relative 'token_request'
+
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Request for ending a session.
+      class InvalidateRequest < TokenRequest
+
+        # Creates a new invalidate 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
+          '/invalidate'
+        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/messaging/refresh_request.rb

@@ -0,0 +1,47 @@
+require 'json'
+require_relative 'token_request'
+
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Request for renewing a previously used authentication session.
+      # @see RefreshResponse
+      class RefreshRequest < TokenRequest
+
+        # Creates a new refresh request.
+        # @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, nil] New profile to switch to.
+        #   Specify +nil+ to keep the same profile.
+        def initialize(client_token, access_token, profile = nil)
+          super(client_token, access_token)
+          @profile = profile
+        end
+
+        # Path on the server that handles the request.
+        # @return [String] Path to handler.
+        def endpoint
+          '/refresh'
+        end
+
+        # Generates a JSON string that can be sent to an authentication server.
+        # @return [String] JSON string.
+        def to_json
+          hash = structure
+          if @profile
+            profile_hash = {
+                :name => @profile.name,
+                :id   => @profile.id.to_s(false)
+            }
+            profile_hash[:legacy] = true if @profile.legacy?
+            hash[:selectedProfile] = profile_hash
+          end
+          hash.to_json
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+require 'json'
+require_relative 'token_response'
+require_relative '../profile'
+
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Response to a session renewal (refresh) request.
+      # @see RefreshRequest
+      class RefreshResponse < TokenResponse
+
+        # Profile selected for the user.
+        # @return [Profile]
+        attr_reader :profile
+
+        # Creates a new refresh response by parsing a message received from the server.
+        # @param message [HTTP::Message] Refresh response from the server.
+        def initialize(message)
+          super(message)
+          hash     = JSON.parse(message.body, :symbolize_names => true)
+          @profile = Profile.from_properties(hash[:selectedProfile])
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Base class for all request messages.
+      # @abstract
+      class Request
+
+        # Path on the server that handles the request.
+        # @return [String] Path to handler.
+        def endpoint
+          fail NotImplementedError, 'Sub-class must implement this method'
+        end
+
+        # Generates a JSON string that can be sent to an authentication server.
+        # @return [String] JSON string.
+        def to_json
+          fail NotImplementedError, 'Sub-class must implement this method'
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+module Lapis
+  module Yggdrasil
+    module Messaging
+
+      # Base class for all response messages received from the server.
+      # @abstract
+      class Response
+
+        # HTTP status code given in the response.
+        # @return [Fixnum] HTTP status code.
+        attr_reader :status
+
+        # Determines whether the result of the request was a success.
+        # @return [true] The result was a success.
+        # @return [false] The result was a failure.
+        def ok?
+          @is_ok
+        end
+
+        protected
+
+        # Creates the base of the response by parsing a response message.
+        # @param message [HTTP::Message] Message received from the server.
+        def initialize(message)
+          @status = message.status
+          @is_ok  = message.ok?
+        end
+
+      end
+
+    end
+  end
+end