bukin 0.6.0 → 0.7.0

data/.travis.yml

@@ -2,5 +2,4 @@ language: ruby
 rvm:
   - 2.0.0
   - 1.9.3
-  - 1.8.7
 

data/Gemfile

@@ -8,4 +8,6 @@ group :development, :test do
   gem 'rake', '~> 10.1.0'
   gem 'coveralls', :require => false
   gem 'fakefs', '~> 0.4.2', :require => 'fakefs/safe'
+  gem 'webmock', '~> 1.15.2'
+  gem 'vcr', '~> 2.7.0'
 end

data/README.md

@@ -38,13 +38,13 @@ You can specify specific versions of a plugin or server to install.  Craftbukkit
 
 By default, bukin will try to download jar files from bukkit dev.  If only zip files are available, it will automatically extract all jar files from it.  If you want to specify what files are extracted from a zip file, use the `extract` option.  It takes a string or [ruby regular expression](http://ruby-doc.org/core-1.9.3/Regexp.html) used to match file names in the zip file.
 
-    plugin 'permissionsex', '1.19.5', :extract => /PermissionsEx.*\.jar/
+    plugin 'permissionsex', '1.19.5', extract: /PermissionsEx.*\.jar/
 
 Plugins or servers can also be downloaded from Jenkins. Just specify the base url for Jenkins and a [ruby regular expression](http://ruby-doc.org/core-1.9.3/Regexp.html) matching the file you want to download.  If no file is specified, bukin will download the first one listed.
 
-    server 'spigot', 'build-844', :jenkins => 'http://ci.md-5.net', :file => /spigot\.jar/
+    server 'spigot', 'build-844', jenkins: 'http://ci.md-5.net', file: /spigot\.jar/
 
 Need something custom?  Use the `download` option.  Version is optional but will display when the plugin is downloading.
 
-    plugin 'mycustomplugin', '2.4', :download => 'http://example.com/My-Custom-Plugin.jar'
+    plugin 'mycustomplugin', '2.4', download: 'http://example.com/My-Custom-Plugin.jar'
 

data/bukin.gemspec

@@ -17,7 +17,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
+  gem.required_ruby_version = '>= 1.9.1'
   gem.add_dependency('thor', '~> 0.18.1')
-  gem.add_dependency('json', '~> 1.8.0')
-  gem.add_dependency('rubyzip', '~> 0.9.9')
+  gem.add_dependency('rubyzip', '~> 1.1.0')
 end

data/docs/process.md

@@ -0,0 +1,24 @@
+Bukin Process
+=============
+
+Getting from a fresh Bukfile to having all plugins installed is a rather complex process.  This file tries to document it as much as possible.
+
+Parse Bukfile
+-------------
+
+The Bukfile is evaluated and any errors are presented to the user.  Each resource present is constructed into a list of `Resource` objects that will be passed to future steps.
+
+Resolve Dependencies
+--------------------
+
+All resources are checked for any dependancies that will also need to be installed.  At this point, the final version for each `Resource` is recoreded.  Any conflicts are reported to the user.  During this time, many webservice calls are made to the various sites to confirm information.  If the correct version of a resource is already installed, it's excluded from installation.
+
+Download Resources
+------------------
+
+All required files from the previous step are downloaded to a temporary folder.  If installation is cancelled at this point, no changes will be made to the system.  Any compressed files are also extracted.
+
+Install Resources
+-----------------
+
+All previously downloaded files are copied to the locations specified for installation.  All information about installed version is updated in Bukfile.lock and the locations of installed files is stored.

data/lib/bukin.rb

@@ -1,7 +1,59 @@
 require 'bukin/version'
 require 'bukin/cli'
-require 'bukin/friendly_errors'
-require 'bukin/exceptions'
+require 'socket'
 
 module Bukin
+  class BukinError < StandardError; end
+  class BukfileError < BukinError; end
+  class InstallError < BukinError; end
+
+  class VersionError < BukinError
+    def initialize(name, bad_version, good_version)
+      super("The resource #{name} (#{bad_version}) has an improper version. "\
+            "It should be in the form of #{good_version}")
+    end
+  end
+
+  class NoDownloadError < BukinError
+    def initialize(name, version)
+      super("The resource '#{name}' has no available downloads listed with "\
+            "the version '#{version}'")
+    end
+  end
+
+  class MissingProviderError < BukinError
+    def initialize(resource)
+      super("The #{resource[:type].to_s} '#{resource[:name]}' "\
+            "is missing a provider")
+    end
+  end
+
+  def self.get_json(url)
+    JSON.parse(open(url).read)
+  end
+
+  def self.try_get_json(url)
+    get_json(url)
+  rescue OpenURI::HTTPError
+    nil
+  end
+
+  def self.with_friendly_errors
+    yield
+  rescue Bukin::BukinError => error
+    abort error.message
+  rescue SocketError => error
+    abort "#{error.message}\nCheck that you have a stable connection and the service is online"
+  rescue Errno::ENOENT => error
+    abort error.message
+  rescue Interrupt
+    abort ''
+  rescue Exception => error
+    puts %Q(
+      Oops, Bukin just crashed.  Please report this at http://bit.ly/bukin-issues
+      Be sure to include as much information as possible such as your Bukfile,
+      Bukfile.lock and the stack trace below.
+    )
+    raise error
+  end
 end

data/lib/bukin/bukfile.rb

@@ -1,60 +1,58 @@
-class Bukin::Bukfile
-  FILE_NAME = 'Bukfile'
-  PROVIDERS = [:download, :jenkins, :bukkit_dl, :bukget]
-
-  attr_reader :path, :resources
-
-  def initialize(path = nil, &block)
-    @resources = []
-    @path = path || File.join(Dir.pwd, FILE_NAME)
-    if block
-     instance_eval(&block)
-    else
-      instance_eval(File.read(@path))
+module Bukin
+  class Bukfile
+    FILE_NAME = 'Bukfile'
+    attr_reader :path, :resources
+
+    def initialize(path = nil, &block)
+      @resources = []
+      @path = path || File.join(Dir.pwd, FILE_NAME)
+      if block
+       instance_eval(&block)
+      else
+        instance_eval(File.read(@path))
+      end
     end
-  end
 
-  def server(name, *args)
-    add_resource name, :server, args do |resource|
-      resource[:bukkit_dl] = Bukin::BukkitDl::DEFAULT_URL
+    def server(name, *args)
+      add_resource name, :server, args
     end
-  end
 
-  def plugin(name, *args)
-    add_resource name, :plugin, args do |resource|
-      resource[:bukget] = Bukin::Bukget::DEFAULT_URL
+    def plugin(name, *args)
+      add_resource name, :plugin, args
     end
+
+  def to_s
+    @reources.map do |resource|
+      result = "#{resource[:name]}"
+      result << " (#{resource[:version]})" if resource[:version]
+      result
+    end.join('\n')
   end
 
-private
-  def add_resource(name, type, args)
-    raise(
-      Bukin::BukinError,
-      "Error: The #{type} '#{name}' is declared "\
-      "more than once in your #{FILE_NAME}"
-    ) if resource_exists?(name, type)
-
-    options = args.last.is_a?(Hash) ? args.pop : {}
-    version = args.pop || nil
-
-    resource = {
-      :name => name,
-      :type => type,
-      :version => version
-    }.merge(options)
-
-    # Already have a specific provider assigned?
-    # If not, yield so that one can be set.
-    unless PROVIDERS.any? {|key| resource.key?(key)}
-      yield resource
-    end
+  private
+    def add_resource(name, type, args)
+      raise(
+        Bukin::BukinError,
+        "Error: The #{type} '#{name}' is declared "\
+        "more than once in your #{FILE_NAME}"
+      ) if resource_exists?(name, type)
 
-    @resources << resource
-  end
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      version = args.pop || nil
+
+      resource = {
+        :name => name,
+        :type => type,
+        :version => version
+      }.merge(options)
+
+      @resources << resource
+    end
 
-  def resource_exists?(name, type)
-    @resources.any? do |resource|
-      resource[:name] == name && resource[:type] == type
+    def resource_exists?(name, type)
+      @resources.any? do |resource|
+        resource[:name] == name && resource[:type] == type
+      end
     end
   end
 end

data/lib/bukin/bukget.rb

@@ -0,0 +1,63 @@
+require 'json'
+require 'cgi'
+require 'bukin/file_match'
+require 'bukin/resource'
+
+module Bukin
+  # BukGet api
+  # Docs: http://bukget.org/pages/docs/API3.html
+  class Bukget
+    attr_reader :url, :server
+
+    VERSION = 'release'
+    URL = 'http://api.bukget.org'
+    SERVER = 'bukkit'
+
+    def initialize(url = URL, server = SERVER)
+      @url = url
+      @server = server
+    end
+
+    def find(data)
+      name = data[:name]
+      version = data[:version] || VERSION
+      match = data[:file] ? FileMatch.new(data[:file]) : FileMatch.any
+
+      info = Bukin.try_get_json("#{@url}/3/plugins/#{CGI.escape(@server)}/"\
+                            "#{CGI.escape(name)}/#{CGI.escape(version)}")
+
+      raise NoDownloadError.new(name, version) unless info
+
+      versions = info['versions']
+
+      if versions.nil? || versions.empty?
+        # A couple of plugins don't update the 'version' field correctly but
+        # do update the 'dbo_version' field.  This attempts to find a
+        # downloadable version with the correct 'dbo_version' field
+        info = Bukin.get_json("#{@url}/3/plugins/#{CGI.escape(@server)}/"\
+                              "#{CGI.escape(name)}")
+        versions = info['versions'].select do |data|
+          data['dbo_version'] == version
+        end
+
+        raise NoDownloadError.new(name, version) if versions.empty?
+      end
+
+      # Filter out any plugins that don't match our file name
+      versions = versions.select{|data| match =~ data['filename']}
+
+      # Some people release two of the same version on bukkit dev,
+      # one as a zip package and one with the jar only.
+      # This downloads the jar only version by default.
+      version_data = versions.find {|data| jar_filename(data)} || versions.first
+      raise NoDownloadError.new(name, version) unless version_data
+
+      return version_data['version'], version_data['download']
+    end
+
+  private
+    def jar_filename(data)
+        File.extname(data['filename']) == '.jar'
+    end
+  end
+end

data/lib/bukin/bukkit_dl.rb

@@ -0,0 +1,45 @@
+require 'json'
+require 'cgi'
+
+module Bukin
+  # Bukkit download api
+  # Docs: http://dl.bukkit.org/about/
+  class BukkitDl
+    attr_reader :url
+
+    VERSION = 'latest-rb'
+    URL = 'http://dl.bukkit.org'
+    GOOD_VERSIONS = "'latest', 'latest-rb', 'latest-beta', 'latest-dev', "\
+                    "'git-0fd25c4' or 'build-2912'"
+
+    def initialize(url = URL)
+      @url = url
+    end
+
+    def find(data)
+      name = data[:name]
+      version = data[:version] || VERSION
+
+      unless correct_version_format?(version)
+        raise VersionError.new(name, version, GOOD_VERSIONS)
+      end
+
+      info = Bukin.try_get_json(
+        "#{@url}/api/1.0/downloads/projects/"\
+        "#{CGI.escape(name)}/view/#{CGI.escape(version)}/")
+
+      raise NoDownloadError.new(name, version) unless info
+
+      download = @url + info['file']['url']
+
+      return "build-#{info['build_number']}", download
+    end
+
+    def correct_version_format?(version)
+      'latest' == version ||
+      /^latest-(rb|beta|dev)$/ =~ version ||
+      /^git-[0-9a-f]{7,40}$/ =~ version ||
+      /^build-[0-9]+$/ =~ version
+    end
+  end
+end

data/lib/bukin/cli.rb

@@ -1,71 +1,85 @@
 require 'thor'
 require 'open-uri'
+require 'bukin'
 require 'bukin/installer'
 require 'bukin/bukfile'
-require 'bukin/providers/bukget'
-require 'bukin/providers/bukkit_dl'
-require 'bukin/providers/jenkins'
-
-class Bukin::CLI < Thor
-  PROVIDERS = {
-    :bukkit_dl => Bukin::BukkitDl,
-    :bukget => Bukin::Bukget,
-    :jenkins => Bukin::Jenkins
-  }
-
-  desc 'install [NAMES]', "Download and install the resources specified in a "\
-                          "Bukfile.\nOptionally specify the names of specific "\
-                          "plugins to install."
-  def install(*names)
-    # Parse in the Bukfile
-    raw_resources = parse_resources(names)
-
-    # Get all the informatin needed to install
-    resources = prepare_resources(raw_resources)
-
-    # Download and install all resources
-    install_resources(resources)
-  end
+require 'bukin/bukget'
+require 'bukin/bukkit_dl'
+require 'bukin/jenkins'
+require 'bukin/download'
+
+module Bukin
+  class CLI < Thor
+    desc 'install [NAMES]', "Download and install the resources specified in a "\
+                            "Bukfile.\nOptionally specify the names of specific "\
+                            "plugins to install."
+    def install(*names) # Parse in the Bukfile
+      raw_resources = parse_resources(names)
+
+      # Get all the informatin needed to install
+      resources = prepare_resources(raw_resources)
+
+      # Download and install all resources
+      install_resources(resources)
+    end
 
-  def help(*)
-    shell.say "Bukin is a plugin and server package manager for Minecraft.\n"
-    super
-  end
+    def help(*)
+      shell.say "Bukin is a plugin and server package manager for Minecraft.\n"
+      super
+    end
 
-private
-  def parse_resources(names)
-    resources = section('Parsing Bukfile') {Bukin::Bukfile.new.resources}
+  private
+    def parse_resources(names)
+      resources = section('Parsing Bukfile') {Bukin::Bukfile.new.resources}
 
-    # If name are specified, only install resources with those names
-    resources.select! {|resource| names.include?(resource[:name])} if names.any?
-    raise Bukin::BukinError, "Nothing to install" if resources.empty?
+      # If name are specified, only install resources with those names
+      resources.select! {|resource| names.include?(resource[:name])} if names.any?
+      raise Bukin::BukinError, "Nothing to install" if resources.empty?
 
-    resources
-  end
+      resources
+    end
 
-  def prepare_resources(raw_resources)
-    downloads = {}
-    final_resources = []
+    def prepare_resources(raw_resources)
+      downloads = {}
+      final_resources = []
 
-    raw_resources.each do |resource|
-      name, provider = PROVIDERS.find {|name, p| resource[name]}
-      next unless name
+      raw_resources.group_by {|data| get_provider(data)}.each do |name, datas|
+        datas.group_by {|data| data[name]}.each do |url, data|
+          downloads[PROVIDERS[name].new(url)] = data
+        end
+      end
+
+      downloads.each do |provider, datas|
+        fetching provider do
+          datas.each do |data|
+            begin
+              version, download = provider.find(data)
+              final_resources << Resource.new(data, version, download)
+            rescue OpenURI::HTTPError => ex
+              raise Bukin::BukinError,
+                "There was an error fetching information about "\
+                "'#{data[:name]} (#{data[:version]})'.\n"\
+                "#{ex.message}"
+            end
+          end
+        end
+      end
 
-      url = resource[name]
-      downloads[url] ||= []
-      downloads[url] << provider.new(resource)
+      final_resources
     end
 
-    downloads.each do |url, resources|
-      section "Fetching information from #{url}" do
-        resources.each do |resource|
+    def install_resources(resources)
+      installer = Bukin::Installer.new(Dir.pwd, true)
+
+      resources.each do |resource|
+        downloading resource.name, resource.version do
           begin
-            final_resources << resource.resolve_info
+            installer.install(resource)
           rescue OpenURI::HTTPError => ex
             raise(
               Bukin::BukinError,
-              "There was an error fetching information about "\
-              "'#{resource.data[:name]} (#{resource.data[:version]})'.\n"\
+              "There was an error installing "\
+              "'#{resource[:name]} (#{resource[:version]})'.\n"\
               "#{ex.message}"
             )
           end
@@ -73,41 +87,53 @@ private
       end
     end
 
-    final_resources
-  end
-
-  def install_resources(resources)
-    installer = Bukin::Installer.new(Dir.pwd, true)
-
-    resources.each do |resource|
-      downloading resource[:name], resource[:version] do
-        begin
-          installer.install(resource)
-        rescue OpenURI::HTTPError => ex
-          raise(
-            Bukin::BukinError,
-            "There was an error installing "\
-            "'#{resource[:name]} (#{resource[:version]})'.\n"\
-            "#{ex.message}"
-          )
-        end
+    PROVIDERS = {
+      download: Download,
+      jenkins: Jenkins,
+      bukget: Bukget,
+      bukkit_dl: BukkitDl
+    }
+
+    DEFAULTS = {
+      server: :bukkit_dl,
+      plugin: :bukget
+    }
+
+    def get_provider(data)
+      name = PROVIDERS.keys.find {|n| data[n]}
+
+      # If this resource doesn't have a provider, we assign a default
+      unless name
+        name = DEFAULTS[data[:type]]
+        raise MissingProviderError.new(data) unless name
+        data[name] = PROVIDERS[name]::URL
       end
+
+      name
     end
-  end
 
-  def section(message)
-    say "#{message}... "
-    value = yield
-    say 'Done', :green
-    value
-  rescue => ex
-    say 'Error', :red
-    raise ex
-  end
+    def section(message)
+      say "#{message}... "
+      value = yield
+      say 'Done', :green
+      value
+    rescue => ex
+      say 'Error', :red
+      raise ex
+    end
+
+    def downloading(name, version, &block)
+      msg = "Downloading #{name}"
+      msg << " (#{version})" if version
+      section(msg, &block)
+    end
 
-  def downloading(name, version, &block)
-    msg = "Downloading #{name}"
-    msg << " (#{version})" if version
-    section(msg, &block)
+    def fetching(provider, &block)
+      if provider.is_a?(Download)
+        yield
+      else
+        section("Fetching information from #{provider.url}", &block)
+      end
+    end
   end
 end