lapis-minecraft-versioning 0.5.0

data/lib/lapis/minecraft/versioning/meta_server.rb

@@ -0,0 +1,52 @@
+require_relative 'marshalling'
+
+module Lapis
+  module Minecraft
+    module Versioning
+
+      # Provides functionality for translating version information from a meta-data server.
+      # A meta-data server is a server that responds to requests about Minecraft versions.
+      # @todo Add more checks to response data.
+      class MetaServer
+
+        # Creates a reference to a Minecraft meta-data server.
+        # @param client [HTTPClient] Client used to connect to the meta-data server.
+        def initialize(client)
+          @client = client
+          @manifest_parser    = Marshalling::ManifestParser.new
+          @version_parser     = Marshalling::VersionParser.new
+          @asset_index_parser = Marshalling::AssetIndexParser.new
+        end
+
+        # Retrieves the manifest from the meta-data server.
+        # @param url [String] URL of the version manifest.
+        # @return [Manifest] Information about all Minecraft versions.
+        def get_manifest(url)
+          response = @client.get(url)
+          fail "Failed to retrieve manifest - #{response.status} (#{response.reason})" if response.status != 200
+          @manifest_parser.parse(response.content)
+        end
+
+        # Retrieves additional information about a Minecraft version.
+        # @param url [String] URL of the version document.
+        # @return [Detailed] Minecraft version information.
+        def get_details(url)
+          response = @client.get(url)
+          fail "Failed to retrieve version - #{response.status} (#{response.reason})" if response.status != 200
+          @version_parser.parse(response.content, url)
+        end
+
+        # Retrieves a listing of assets for a Minecraft version.
+        # @param url [String] URL of the asset index document.
+        # @return [Array<Asset>] List of assets in the index.
+        def get_assets(url)
+          response = @client.get(url)
+          fail "Failed to retrieve assets - #{response.status} (#{response.reason})" if response.status != 200
+          @asset_index_parser.parse(response.content)
+        end
+
+      end
+
+    end
+  end
+end

data/lib/lapis/minecraft/versioning/os_rule.rb

@@ -0,0 +1,45 @@
+require_relative 'rule'
+
+module Lapis
+  module Minecraft
+    module Versioning
+
+      # Description of how resources can be chosen for operating systems.
+      class OSRule < Rule
+
+        # Type of operating system this rule applies to.
+        # @return [Symbol] Can be one of: +:windows+, +:linux+, or +:osx+.
+        attr_reader :os_type
+
+        # Operating system version regex.
+        # This rule should apply if the OS version matches this regex.
+        # @return [Regexp]
+        attr_reader :os_version
+
+        # Creates an OS rule.
+        # @param is_allowed [Boolean] Indicates whether the resource should be included.
+        # @param os_type [Symbol] Type of OS this rule applies to.
+        #   Can be one of: +:windows+, +:linux+, or +:osx+.
+        # @param os_version [String, nil] OS version regex.
+        #   Can be +nil+ to apply to all versions of the OS.
+        def initialize(is_allowed, os_type, os_version = nil)
+          super(is_allowed)
+          @os_type = os_type
+          @os_version = os_version ? Regexp.new(os_version) : // # Use empty regex if no version specified.
+        end
+
+        # Compares one rule to another.
+        # @param other [OSRule] Rule to compare against.
+        # @return [true] The rules are the same.
+        # @return [false] The rules are different.
+        def ==(other)
+          super(other) &&
+              other.os_type == @os_type &&
+              other.os_version == @os_version
+        end
+
+      end
+
+    end
+  end
+end

data/lib/lapis/minecraft/versioning/resource.rb

@@ -0,0 +1,44 @@
+require_relative 'asset'
+
+module Lapis
+  module Minecraft
+    module Versioning
+
+      # Information about a resource (file) to download as part of the client or server.
+      class Resource < Asset
+
+        # URL where the resource can be found and downloaded from.
+        # @return [String] Download URL.
+        attr_reader :url
+
+        # Logical category the resource falls under.
+        # @return [String, nil] Name of the category or +nil+ if the resource doesn't have one.
+        attr_reader :classifier
+
+        # Creates information about a resource.
+        # @param url [String] URL where the resource can be found and downloaded from.
+        # @param size [Fixnum] Size of the resource in bytes.
+        # @param sha1 [String] SHA1 hash of the resource's contents in hexadecimal.
+        # @param path [String, nil] Path, relative to the installation directory, to store the resource.
+        # @param classifier [String, nil] Logical category the resource falls under.
+        def initialize(url, size, sha1, path = nil, classifier = nil)
+          super(size, sha1, path)
+          @url        = url.dup.freeze
+          @classifier = classifier.dup.freeze
+        end
+
+        # Compares one resource to another.
+        # @param other [Resource] Resource to compare against.
+        # @return [true] The resources are the same.
+        # @return [false] The resources are different.
+        def ==(other)
+          super(other) &&
+              other.url == @url &&
+              other.classifier == @classifier
+        end
+
+      end
+
+    end
+  end
+end

data/lib/lapis/minecraft/versioning/resource_set.rb

@@ -0,0 +1,61 @@
+module Lapis
+  module Minecraft
+    module Versioning
+
+      # Information about the archives and natives needed for a library.
+      # @see Resource
+      class ResourceSet
+
+        # Classifier for the Windows native.
+        # @return [String] Classifier for Windows.
+        # @return [nil] No Windows native for this library.
+        # @note This value can contain variables.
+        attr_reader :windows_classifier
+
+        # Classifier for the Linux native.
+        # @return [String] Classifier for Linux.
+        # @return [nil] No Linux native for this library.
+        # @note This value can contain variables.
+        attr_reader :linux_classifier
+
+        # Classifier for the OSX native.
+        # @return [String] Classifier for OSX.
+        # @return [nil] No OSX native for this library.
+        # @note This value can contain variables.
+        attr_reader :osx_classifier
+
+        # List of all resources (including natives) the library uses.
+        # @return [Array<Resource>]
+        attr_reader :resources
+
+        # Creates a new resource set.
+        # @param resources [Array<Resource>] List of all resources (including natives).
+        # @param windows_classifier [String, nil] Classifier for the Windows native.
+        #   Specify +nil+ if there is no native for Windows.
+        # @param linux_classifier [String, nil] Classifier for the Linux native.
+        #   Specify +nil+ if there is no native for Linux.
+        # @param osx_classifier [String, nil] Classifier for the OSX native.
+        #   Specify +nil+ if there is no native for OSX.
+        def initialize(resources, windows_classifier = nil, linux_classifier = nil, osx_classifier = nil)
+          @windows_classifier = windows_classifier ? windows_classifier.dup.freeze : nil
+          @linux_classifier   = linux_classifier   ? linux_classifier.dup.freeze   : nil
+          @osx_classifier     = osx_classifier     ? osx_classifier.dup.freeze     : nil
+          @resources          = resources.dup.freeze
+        end
+
+        # Compares one resource set to another.
+        # @param other [ResourceSet] Resource set to compare against.
+        # @return [true] The resource sets are the same.
+        # @return [false] The resource sets are different.
+        def ==(other)
+          other.windows_classifier == @windows_classifier &&
+              other.linux_classifier == @linux_classifier &&
+              other.osx_classifier == @osx_classifier &&
+              other.resources == @resources
+        end
+
+      end
+
+    end
+  end
+end

data/lib/lapis/minecraft/versioning/rule.rb

@@ -0,0 +1,32 @@
+module Lapis
+  module Minecraft
+    module Versioning
+
+      # Description of how resources can be chosen.
+      class Rule
+
+        # @!attribute [r] allowed?
+        # Indicates whether the resource should be included.
+        def allowed?
+          @is_allowed
+        end
+
+        # Creates a basic rule.
+        # @param is_allowed [Boolean] Indicates whether the resource should be included.
+        def initialize(is_allowed)
+          @is_allowed = !!is_allowed
+        end
+
+        # Compares one rule to another.
+        # @param other [Rule] Rule to compare against.
+        # @return [true] The rules are the same.
+        # @return [false] The rules are different.
+        def ==(other)
+          other.allowed? == @is_allowed
+        end
+
+      end
+
+    end
+  end
+end

data/lib/lapis/minecraft/versioning/version.rb

@@ -0,0 +1,7 @@
+module Lapis
+  module Minecraft
+    module Versioning
+      VERSION = '0.5.0'
+    end
+  end
+end

data/lib/lapis/minecraft/versioning/version_list.rb

@@ -0,0 +1,64 @@
+require 'httpclient'
+require_relative 'meta_server'
+require_relative '../version'
+
+module Lapis
+  module Minecraft
+    module Versioning
+
+      # Complete listing of Minecraft versions and detailed information about them.
+      class VersionList
+        include Enumerable
+
+        # URL of the official Mojang Minecraft version list.
+        OFFICIAL_MANIFEST_URL = 'https://launchermeta.mojang.com/mc/game/version_manifest.json'
+
+        # Singleton for retrieving information about official Minecraft versions.
+        # @return [VersionList] Access to official version information.
+        def self.official
+          @official ||= new(OFFICIAL_MANIFEST_URL)
+        end
+
+        # Creates a version list.
+        # @param manifest_url [String] URL of the document listing all versions.
+        def initialize(manifest_url)
+          @manifest_url = manifest_url.dup.freeze
+          @meta_server  = MetaServer.new(HTTPClient.new)
+        end
+
+        # Iterates over all versions.
+        # @yieldparam version [Version] Next version in the list.
+        # @return [void]
+        def each
+          return enum_for(:each) unless block_given?
+
+          manifest.each do |basic|
+            yield Version.new(basic, @meta_server)
+          end
+        end
+
+        # Retrieves the latest released version.
+        # @return [Version] Version information.
+        def latest_release
+          Version.new(manifest.latest_release, @meta_server)
+        end
+
+        # Information about the latest snapshot version.
+        # @return [Version] Version information.
+        def latest_snapshot
+          Version.new(manifest.latest_snapshot, @meta_server)
+        end
+
+        private
+
+        # Retrieves and caches the manifest data.
+        # @return [Manifest]
+        def manifest
+          @manifest ||= @meta_server.get_manifest(@manifest_url)
+        end
+
+      end
+
+    end
+  end
+end

data/spec/factories/asset_factory.rb

@@ -0,0 +1,11 @@
+FactoryGirl.define do
+  factory :asset, class: Lapis::Minecraft::Versioning::Asset do
+    transient do
+      sequence(:path) { |n| "foo/bar/baz/asset-#{n}" }
+      size { Random.rand(16777216).to_i }
+      sha1 { Digest::SHA1.hexdigest path.to_s }
+    end
+
+    initialize_with { new(size, sha1, path) }
+  end
+end

data/spec/factories/asset_index_document_factory.rb

@@ -0,0 +1,25 @@
+require 'json'
+
+FactoryGirl.define do
+  factory :asset_document_entry, class: Array do
+    transient do
+      asset { build(:asset) }
+    end
+
+    initialize_with { [asset.path, {:hash => asset.sha1, :size => asset.size}] }
+  end
+
+  IndexStruct = Struct.new(:assets, :document)
+
+  factory :asset_index_document, class: IndexStruct do
+    transient do
+      asset_count 10
+      assets { build_list(:asset, asset_count) }
+      asset_list { assets.map { |asset| build(:asset_document_entry, :asset => asset) } }
+      structure { { :objects => Hash[asset_list] } }
+      json { structure.to_json }
+    end
+
+    initialize_with { new(asset_list, json) }
+  end
+end

data/spec/factories/asset_index_factory.rb

@@ -0,0 +1,15 @@
+FactoryGirl.define do
+  factory :asset_index, class: Lapis::Minecraft::Versioning::AssetIndex do
+    transient do
+      sequence(:id) { |n| "Assets-#{n}" }
+      asset_count 20
+      assets { build_list(:asset, asset_count) }
+      size 500
+      url { "http://example.com/minecraft/assets/#{id}.json" }
+      total_size { assets.lazy.map { |asset| asset.size }.inject(:+) }
+      sha1 { Digest::SHA1.hexdigest assets.lazy.map { |asset| asset.path }.inject(:+) }
+    end
+
+    initialize_with { new(id, sha1, size, url, total_size) }
+  end
+end

data/spec/factories/basic_factory.rb

@@ -0,0 +1,28 @@
+FactoryGirl.define do
+  factory :basic, class: Lapis::Minecraft::Versioning::Basic do
+    transient do
+      sequence(:id) { |n| "Version-1.0.#{n}" }
+      sequence(:url) { |n| "https://example.com/minecraft/versions/1.0.#{n}.json" }
+      type :release
+      time { 10.days.ago.round }
+    end
+
+    trait :alpha do
+      type :alpha
+    end
+
+    trait :beta do
+      type :beta
+    end
+
+    trait :snapshot do
+      type :snapshot
+    end
+
+    trait :release do
+      type :release
+    end
+
+    initialize_with { new(id, type, time, url) }
+  end
+end

data/spec/factories/detailed_factory.rb

@@ -0,0 +1,16 @@
+FactoryGirl.define do
+  factory :detailed, parent: :basic, class: Lapis::Minecraft::Versioning::Detailed do
+    transient do
+      assets { build_list(:asset, 20) }
+      asset_index { build(:asset_index, :assets => assets) }
+      downloads { [build(:download, :client), build(:download, :server), build(:resource)] }
+      libraries { build_list(:library, 5) }
+      launcher_properties { build(:launcher) }
+    end
+
+    initialize_with do
+      basic = Lapis::Minecraft::Versioning::Basic.new(id, type, time, url)
+      new(basic, asset_index, downloads, libraries, launcher_properties)
+    end
+  end
+end

data/spec/factories/launcher_properties_factory.rb

@@ -0,0 +1,11 @@
+FactoryGirl.define do
+  factory :launcher, class: Lapis::Minecraft::Versioning::LauncherProperties do
+    transient do
+      main_class 'com.example.minecraft.client'
+      arguments %w(-user ${user} -key ${key})
+      minimum_version 7
+    end
+
+    initialize_with { new(main_class, arguments, minimum_version) }
+  end
+end

data/spec/factories/library_factory.rb

@@ -0,0 +1,21 @@
+FactoryGirl.define do
+  factory :library_path, class: String do
+    transient do
+      sequence(:path) { |n| "exclude-path-#{n}" }
+    end
+
+    initialize_with { path }
+  end
+
+  factory :library, class: Lapis::Minecraft::Versioning::Library do
+    transient do
+      sequence(:name) { |n| "mc-library-#{n}" }
+      exclude_path_count 1
+      resources { build(:resource_set) }
+      rules { [build(:rule), build(:os_rule)] }
+      paths { build_list(:library_path, exclude_path_count) }
+    end
+
+    initialize_with { new(name, resources, rules, paths) }
+  end
+end