lapis-minecraft-versioning 0.5.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Gem dependencies and information defined in lapis-minecraft-versioning.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,16 @@
+The MIT License (MIT)
+=====================
+
+*Copyright (c) 2016 Lapis MC*
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,83 @@
+Minecraft Version Info
+======================
+
+[![Travis CI](https://travis-ci.org/lapis-mc/minecraft-versioning.svg)](https://travis-ci.org/lapis-mc/minecraft-versioning)
+[![Code Climate](https://codeclimate.com/github/lapis-mc/minecraft-versioning/badges/gpa.svg)](https://codeclimate.com/github/lapis-mc/minecraft-versioning)
+[![Test Coverage](https://codeclimate.com/github/lapis-mc/minecraft-versioning/badges/coverage.svg)](https://codeclimate.com/github/lapis-mc/minecraft-versioning/coverage)
+[![Issue Count](https://codeclimate.com/github/lapis-mc/minecraft-versioning/badges/issue_count.svg)](https://codeclimate.com/github/lapis-mc/minecraft-versioning)
+
+Retrieves and processes information about versions of Minecraft.
+Small library for getting version information from Mojang about Minecraft.
+Includes a command-line utility as well.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lapis-minecraft-versioning'
+```
+
+Or to your gemspec:
+
+```ruby
+spec.add_dependency 'lapis-minecraft-versioning'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lapis-minecraft-versioning
+
+Usage
+-----
+
+Include the gem by adding this to your scripts:
+
+```ruby
+require 'lapis/minecraft/versioning'
+```
+
+### Accessing Minecraft version data
+
+Retrieve the official Minecraft version list:
+
+```ruby
+list = Lapis::Minecraft::Versioning::VersionList.official
+```
+
+Display a list of all versions:
+
+```ruby
+list.each do |version|
+  puts version.id
+end
+```
+
+Get the client URL for the latest release:
+
+```ruby
+list.latest_release.client_download.url
+```
+
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bundle exec rake test` to run the tests.
+It's recommended that you run `bundle exec rake inspect` to run inspections.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+`bundle exec rake doc` will generate documentation.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `versioning/version.rb`, and then run `bundle exec rake release`.
+This will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Contributing
+------------
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/lapis-mc/minecraft-versioning).

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler/gem_tasks'
+require 'reek/rake/task'
+require 'rubocop/rake_task'
+require 'rubocop'
+require 'rspec/core/rake_task'
+require 'yard'
+
+task :default => [:build, :test]
+task :inspect => [:reek, :rubocop]
+
+RSpec::Core::RakeTask.new(:spec)
+task :test => :spec
+
+Reek::Rake::Task.new do |task| # :reek
+  task.name = :reek
+  task.source_files = 'lib/**/*.rb'
+  task.fail_on_error = false
+end
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  task.fail_on_error = false
+end
+
+YARD::Rake::YardocTask.new do |task| # :yard
+  task.files = %w(lib/**/*.rb - *.md)
+end
+task :doc => :yard

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'lapis/minecraft/versioning'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install --path=vendor/bundle
+
+# Do any other automated setup that you need to do here

data/lapis-minecraft-versioning.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lapis/minecraft/versioning/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lapis-minecraft-versioning'
+  spec.version       = Lapis::Minecraft::Versioning::VERSION
+  spec.authors       = ['Michael Miller']
+  spec.email         = ['bluepixelmike@gmail.com']
+
+  spec.summary       = %q{Retrieves and processes information about versions of Minecraft.}
+  spec.description   = %q{Small library for getting version information from Mojang about Minecraft.
+Includes a command-line utility as well.}
+  spec.homepage      = 'https://github.com/lapis-mc/minecraft-versioning'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'bin'
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(%r{^bin/(lapis|minecraft)-}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httpclient', '~> 2.1'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'factory_girl', '~> 4.0'
+  spec.add_development_dependency 'webmock', '~> 2.0'
+  spec.add_development_dependency 'reek', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.38.0'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'yard'
+end

data/lib/lapis/minecraft/version.rb

@@ -0,0 +1,89 @@
+require_relative 'versioning/basic'
+
+module Lapis
+  module Minecraft
+
+    # Complete information about a Minecraft version.
+    # @note This class uses lazy-loading to retrieve additional information only when it is needed.
+    class Version < Versioning::Basic
+
+      # Creates version information.
+      # @param basic_info [Versioning::Basic] Minimal information to extend from.
+      # @param meta_server [Versioning::MetaServer] Connection used to retrieve version information.
+      def initialize(basic_info, meta_server)
+        super(basic_info.id, basic_info.type, basic_info.time, basic_info.url)
+        @meta_server = meta_server
+      end
+
+      # List of assets needed for this version.
+      # @return [Array<Versioning::Asset>] Asset list.
+      def assets
+        @assets ||= @meta_server.get_assets(asset_index.url)
+      end
+
+      # Overview of assets included in this version.
+      # @return [Versioning::AssetIndex] Asset overview.
+      def asset_index
+        details.asset_index
+      end
+
+      # List of downloads available for this version.
+      # @return [Array<Versioning::Resource>] Download list.
+      def downloads
+        details.downloads
+      end
+
+      # Retrieves the client jar information for this version.
+      # @return [Versioning::Resource] Download information for the client.
+      # @return [nil] There is no client for this version.
+      def client_download
+        details.client_download
+      end
+
+      # Retrieves the server jar information for this version.
+      # @return [Versioning::Resource] Download information for the server.
+      # @return [nil] There is no server for this version.
+      def server_download
+        details.server_download
+      end
+
+      # List of libraries needed to run this version.
+      # @return [Array<Versioning::Library>] Library list.
+      def libraries
+        details.libraries
+      end
+
+      # Information about how to start the client in a launcher.
+      # @return [Versioning::LauncherProperties] Client launcher information.
+      def launcher_properties
+        details.launcher_properties
+      end
+
+      # Compares one version to another.
+      # @param other [Version] Version to compare against.
+      # @return [true] The versions are the same.
+      # @return [false] The versions are different.
+      def ==(other)
+        # Ordered by least expensive to most expensive.
+        super(other) &&
+            other.asset_index == asset_index &&
+            other.launcher_properties == launcher_properties &&
+            other.client_download == client_download &&
+            other.server_download == server_download &&
+            other.downloads == downloads &&
+            other.libraries == libraries &&
+            other.assets == assets
+      end
+
+      private
+
+      # Retrieves and caches detailed version information.
+      # @return [Versioning::Detailed] Detailed version information.
+      def details
+        @detailed ||= @meta_server.get_details(url)
+      end
+
+    end
+
+  end
+end

data/lib/lapis/minecraft/versioning.rb

@@ -0,0 +1,26 @@
+module Lapis
+  module Minecraft
+
+    # Brings in information for Minecraft versions.
+    module Versioning
+    end
+
+  end
+end
+
+require_relative 'versioning/version'
+require_relative 'versioning/basic'
+require_relative 'versioning/asset'
+require_relative 'versioning/asset_index'
+require_relative 'versioning/resource'
+require_relative 'versioning/resource_set'
+require_relative 'versioning/rule'
+require_relative 'versioning/os_rule'
+require_relative 'versioning/library'
+require_relative 'versioning/launcher_properties'
+require_relative 'versioning/detailed'
+require_relative 'version'
+require_relative 'versioning/manifest'
+require_relative 'versioning/meta_server'
+require_relative 'versioning/marshalling'
+require_relative 'versioning/version_list'

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

@@ -0,0 +1,44 @@
+module Lapis
+  module Minecraft
+    module Versioning
+
+      # Information about a content file needed for the client.
+      class Asset
+
+        # Size of the asset in bytes.
+        # @return [Fixnum]
+        attr_reader :size
+
+        # SHA1 hash of the asset's contents in hexadecimal.
+        # @return [String]
+        attr_reader :sha1
+
+        # Path, relative to the installation directory, to store the asset.
+        # @return [String, nil] Relative path or +nil+ if the asset can be placed anywhere.
+        attr_reader :path
+
+        # Creates information about an asset.
+        # @param size [Fixnum] Size of the asset in bytes.
+        # @param sha1 [String] SHA1 hash of the asset's contents in hexadecimal.
+        # @param path [String, nil] Path, relative to the installation directory, to store the asset.
+        def initialize(size, sha1, path)
+          @size = size
+          @sha1 = sha1.dup.freeze
+          @path = path ? path.dup.freeze : nil
+        end
+
+        # Compares one asset to another.
+        # @param other [Asset] Asset to compare against.
+        # @return [true] The assets are the same.
+        # @return [false] The assets are different.
+        def ==(other)
+          other.size == @size &&
+              other.sha1 == @sha1 &&
+              other.path == @path
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module Lapis
+  module Minecraft
+    module Versioning
+
+      # Container for tracking information about assets.
+      # @note This class isn't used directly for accessing asset instances.
+      #   It is used for retrieving information about assets.
+      # @see Asset
+      class AssetIndex
+
+        # Unique name of the collection of assets.
+        # @return [String]
+        attr_reader :id
+
+        # SHA1 hash of the asset list document in hexadecimal.
+        # @return [String]
+        attr_reader :sha1
+
+        # Size of the asset list document in bytes.
+        # @return [Fixnum]
+        attr_reader :size
+
+        # Location of where the asset list document can be found.
+        # @return [String]
+        attr_reader :url
+
+        # Total size of all the assets combined.
+        # @return [Fixnum]
+        attr_reader :total_size
+
+        # Creates an asset index.
+        # @param id [String] Unique name of the collection of assets.
+        # @param sha1 [String] SHA1 hash of the asset list document in hexadecimal.
+        # @param size [Fixnum] Size of the asset list document in bytes.
+        # @param url [String] Location of where the asset list document can be found.
+        # @param total_size [Fixnum] Total size of all the assets combined.
+        def initialize(id, sha1, size, url, total_size)
+          @id         = id.dup.freeze
+          @sha1       = sha1.dup.freeze
+          @size       = size
+          @url        = url.dup.freeze
+          @total_size = total_size
+        end
+
+        # Compares one asset index to another.
+        # @param other [AssetIndex] Asset index to compare against.
+        # @return [true] The asset indices are the same.
+        # @return [false] The asset indices are different.
+        def ==(other)
+          other.id == @id &&
+              other.sha1 == @sha1 &&
+              other.size == @size &&
+              other.url == @url &&
+              other.total_size == @total_size
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,56 @@
+module Lapis
+  module Minecraft
+    module Versioning
+
+      # Minimal information about a Minecraft version.
+      class Basic
+
+        # Unique identifier used to reference the version.
+        # @return [String] Unique identifier.
+        attr_reader :id
+
+        # Type of version.
+        # This can be one of:
+        # - +:release+ - Official release.
+        # - +:snapshot+ - Unstable, in development.
+        # - +:beta+ - Old beta.
+        # - +:alpha+ - Old alpha.
+        # @return [Symbol] +:release+, +:snapshot+, +:beta+, or +:alpha+.
+        attr_reader :type
+
+        # Date and time the version was made available to the public.
+        # @return [Time]
+        attr_reader :time
+
+        # URL pointing to detailed information about the version.
+        # @return [String] Version URL.
+        attr_reader :url
+
+        # Creates the basic information for a Minecraft version.
+        # @param id [String] Unique identifier used to reference the version.
+        # @param type [Symbol] +:release+, +:snapshot+, +:beta+, or +:alpha+.
+        # @param time [Time] Date and time the version was made available to the public.
+        # @param url [String] URL pointing to detailed information about the version.
+        def initialize(id, type, time, url)
+          @id   = id.dup.freeze
+          @type = type
+          @time = time
+          @url  = url.dup.freeze
+        end
+
+        # Compares one version to another.
+        # @param other [Basic] Version to compare against.
+        # @return [true] The versions are the same.
+        # @return [false] The versions are different.
+        def ==(other)
+          other.id == @id &&
+              other.type == @type &&
+              other.time == @time &&
+              other.url == @url
+        end
+
+      end
+
+    end
+  end
+end