bukin 0.1.0 → 0.2.0

data/bin/bukin

@@ -4,4 +4,4 @@ $LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
 
 require 'bukin'
 
-Bukin::CLI.start
+Bukin::with_friendly_errors { Bukin::CLI.start }

data/lib/bukin.rb

@@ -1,5 +1,6 @@
 require 'bukin/version'
 require 'bukin/cli'
+require 'bukin/friendly_errors'
 
 module Bukin
 end

data/lib/bukin/bukfile.rb

@@ -1,22 +1,36 @@
-
 class Bukin::Bukfile
-    NAME = 'Bukfile'
+  FILE_NAME = 'Bukfile'
 
-    attr_accessor :server_info, :plugins_info
+  attr_accessor :server_info, :plugins_info
 
-    def initialize
-        @plugins_info = []
-    end
+  def self.from_file(path = nil)
+    path ||= File.join(Dir.pwd, FILE_NAME)
+    from_code(File.read(path))
+  end
 
-    def server(name, version = 'latest-rb')
-        unless @server_info
-            @server_info = { name: name, version: version }
-        else
-            abort("Error: There is more than one server declared in your #{INSTALL_FILE}")
-        end
-    end
+  def self.from_block(&block)
+    from_code(&block)
+  end
 
-    def plugin(name, version = 'latest')
-        @plugins_info << { name: name, version: version }
+  def self.from_code(code)
+    bukfile = Bukin::Bukfile.new
+    bukfile.instance_eval(code)
+    bukfile
+  end
+
+  def initialize
+    @plugins_info = []
+  end
+
+  def server(name, version = 'latest-rb')
+    unless @server_info
+      @server_info = { name: name, version: version }
+    else
+      abort("Error: There is more than one server declared in your #{FILE_NAME}")
     end
+  end
+
+  def plugin(name, version = 'latest')
+    @plugins_info << { name: name, version: version }
+  end
 end

data/lib/bukin/cli.rb

@@ -1,77 +1,66 @@
 require 'thor'
-require 'bukin/lockfile'
+require 'bukin/installer'
 require 'bukin/bukfile'
 require 'bukin/providers/bukget'
 require 'bukin/providers/bukkit_dl'
 
-# Path to install plugins to
-PLUGINS_PATH = "plugins"
-
-# Path to install the server in
-SERVER_PATH = "."
-
 class Bukin::CLI < Thor
 
-    def initialize(*)
-        @lockfile = Bukin::Lockfile.new
-        @bukget = Bukin::Bukget.new
-        @bukkit_dl = Bukin::BukkitDl.new
-        super
+  desc 'install', "Download and install the resources specified in a Bukfile"
+  def install
+    # Parse in the Bukfile
+    bukfile = section 'Parsing Bukfile' do
+      Bukin::Bukfile.from_file
     end
 
-    desc 'install', "Download and install the resources specified in a Bukfile"
-    def install
-        say 'Parsing Bukfile... '
-        contents = File.read(Bukin::Bukfile::NAME)
-        bukfile = Bukin::Bukfile.new
-        bukfile.instance_eval(contents)
-        say 'Done', :green
+    server = bukfile.server_info
+    plugins = bukfile.plugins_info
 
-        server = bukfile.server_info
-        plugins = bukfile.plugins_info
+    # Grab information from the various providers
+    bukkit_dl = Bukin::BukkitDl.new
+    bukget = Bukin::Bukget.new
 
-        say "Fetching information from #{@bukkit_dl.api_url}... "
-        server[:download_version] = @bukkit_dl.resolve_version(
-            server[:name], 
-            server[:version]
-        )
-        server[:download_build] = @bukkit_dl.resolve_build(
-            server[:name],
-            server[:version]
-        )
-        say 'Done', :green
+    section "Fetching information from #{bukkit_dl.url}" do
+      info = bukkit_dl.info(server[:name], server[:version])
+      server[:download_version] = info['version']
+      server[:download_build] = "build-#{info['build_number']}"
+    end
 
-        say "Fetching information from #{@bukget.api_url}... "
-        plugins.each do |plugin|
-            plugin[:download_version] = @bukget.resolve_version(
-                plugin[:name], 
-                plugin[:version], 
-                server[:name]
-            )
-        end
-        say 'Done', :green
+    section "Fetching information from #{bukget.url}" do
+      plugins.each do |plugin|
+        info = bukget.info(plugin[:name], plugin[:version], server[:name])
+        plugin[:download_version] = info['versions'][0]['version']
+      end
+    end
 
-        say "Downloading #{server[:name]} (#{server[:download_version]})... "
-        data, file_name = @bukkit_dl.download(server[:name], server[:download_build])
-        save_download(data, file_name, SERVER_PATH)
-        @lockfile.set_server(server[:name], server[:download_build], file_name)
-        say 'Done', :green
+    # Download and install server and plugins
+    installer = Bukin::Installer.new(Dir.pwd, true)
 
-        plugins.each do |plugin|
-            say "Downloading #{plugin[:name]} (#{plugin[:download_version]})... "
-            data, file_name = @bukget.download(plugin[:name], plugin[:download_version], server[:name])
-            save_download(data, file_name, PLUGINS_PATH)
-            @lockfile.add_plugin(plugin[:name], plugin[:download_version], file_name)
-            say 'Done', :green
-        end
-    rescue Exception => ex
-        say('Error', :red)
-        raise ex
+    section "Downloading #{server[:name]} (#{server[:download_version]})" do
+      installer.install(:server, bukkit_dl, server[:name], server[:download_build])
     end
 
-    def help(*)
-        shell.say "Bukin is a plugin and server package manager for Minecraft."
-        shell.say
-        super
+    plugins.each do |plugin|
+      section "Downloading #{plugin[:name]} (#{plugin[:download_version]})" do
+        installer.install(:plugin, bukget, plugin[:name], plugin[:download_version], server[:name])
+      end
     end
+  end
+
+  def help(*)
+    shell.say "Bukin is a plugin and server package manager for Minecraft."
+    shell.say
+    super
+  end
+
+private
+  def section(message)
+    say "#{message}... "
+    value = yield
+    say 'Done', :green
+    value
+  rescue => ex
+    say 'Error', :red
+    raise ex
+  end
 end

data/lib/bukin/friendly_errors.rb

@@ -0,0 +1,20 @@
+require 'socket'
+
+module Bukin
+  def self.with_friendly_errors
+    yield
+  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/installer.rb

@@ -0,0 +1,22 @@
+require 'bukin/lockfile'
+
+class Bukin::Installer
+
+  def initialize(path, use_lockfile = false)
+    if use_lockfile
+      @lockfile = Bukin::Lockfile.new
+    end
+    @paths = { server: path, plugin: "#{path}/plugins" }
+  end
+
+  def install(type, provider, *args)
+    unless @paths.keys.include?(type)
+      raise(ArgumentError, "You must specify one of the following types to install: #{@paths.keys.to_s}")
+    end
+    data, file_name = provider.download(*args)
+    save_download(data, file_name, @paths[type])
+    if @lockfile
+      @lockfile.add(type, args[0], args[1], file_name)
+    end
+  end
+end

data/lib/bukin/lockfile.rb

@@ -4,52 +4,63 @@ LOCK_FILE = 'Bukfile.lock'
 
 class Bukin::Lockfile
 
-    def initialize(*)
-        if File.exist?(LOCK_FILE)
-            @lockfile = YAML::load_file(LOCK_FILE)
-        else
-            @lockfile = {
-                'server' => {},
-                'plugins' => {}
-            }
-        end
+  def initialize(*)
+    if File.exist?(LOCK_FILE)
+      @lockfile = YAML::load_file(LOCK_FILE)
+    else
+      @lockfile = {
+        'server' => {},
+        'plugins' => {}
+      }
     end
+  end
 
-    def set_server(name, version, file)
-        self.server = {
-            'name' => name,
-            'version' => version,
-            'file' => file
-        }
-    end
+  def set_server(name, version, file)
+    self.server = {
+      'name' => name,
+      'version' => version,
+      'file' => file
+    }
+  end
 
-    def add_plugin(name, version, *files)
-        self.plugins[name] = {
-            'version' => version,
-            'files' => files
-        }
-        save
-    end
+  def add_plugin(name, version, *files)
+    self.plugins[name] = {
+      'version' => version,
+      'files' => files
+    }
+    save
+  end
 
-    def remove_plugin(name)
-        plugins.delete(name)
-        save
+  def add(type, *args)
+    case type
+    when :server
+      set_server(*args)
+    when :plugin
+      add_plugin(*args)
+    else
+      raise(ArgumentError, "You must specify :server or :plugin as the type when adding to a lock file")
     end
+  end
 
-    def plugins
-        @lockfile['plugins']
-    end
+  def remove_plugin(name)
+    plugins.delete(name)
+    save
+  end
 
-    def server
-        @lockfile['server']
-    end
+  def plugins
+    @lockfile['plugins']
+  end
 
-    def server=(value)
-        @lockfile['server'] = value
-        save
-    end
+  def server
+    @lockfile['server']
+  end
 
-    def save
-        File.open(LOCK_FILE, "w") {|file| file.write @lockfile.to_yaml}
-    end
+  def server=(value)
+    @lockfile['server'] = value
+    save
+  end
+
+  def save
+    File.open(LOCK_FILE, "w") {|file| file.write @lockfile.to_yaml}
+  end
 end

data/lib/bukin/providers/bukget.rb

@@ -3,28 +3,26 @@ require 'json'
 
 # BukGet api
 # Docs: http://bukget.org/pages/docs/API3.html
-BUKGET_API = "http://api.bukget.org/3"
-
 class Bukin::Bukget
-    attr_accessor :api_url
+  attr_reader :url
 
-    def initialize(url = BUKGET_API)
-        @api_url = url
-    end
+  def initialize(url = 'http://api.bukget.org')
+    @url = url
+  end
 
-    def download(name, version, server)
-        server = 'bukkit' if server == 'craftbukkit'
-        url = "#{@api_url}/plugins/#{server}/#{name}/#{version}/download"
-        download_file(url, true)
-    end
+  def api_url
+    "#{url}/3"
+  end
 
-    def info(name, version, server)
-        server = 'bukkit' if server == 'craftbukkit'
-        url = "#{@api_url}/plugins/#{server}/#{name}/#{version}"
-        JSON.parse(open(url).read)
-    end
+  def download(name, version, server)
+    server = 'bukkit' if server == 'craftbukkit'
+    url = "#{api_url}/plugins/#{server}/#{name}/#{version}/download"
+    download_file(url, true)
+  end
 
-    def resolve_version(name, version, server)
-        info(name, version, server)['versions'][0]['version']
-    end
+  def info(name, version, server)
+    server = 'bukkit' if server == 'craftbukkit'
+    url = "#{api_url}/plugins/#{server}/#{name}/#{version}"
+    JSON.parse(open(url).read)
+  end
 end

data/lib/bukin/providers/bukkit_dl.rb

@@ -1,36 +1,30 @@
 require 'bukin/utils'
 require 'json'
 
-# Base url used for bukkit downloads
-BUKKIT_DL_BASE = "http://dl.bukkit.org"
-
 # Bukkit download api
 # Docs: http://dl.bukkit.org/about/
-BUKKIT_DL_API = "#{BUKKIT_DL_BASE}/api/1.0/downloads"
-
-
 class Bukin::BukkitDl
-    attr_accessor :api_url
+  attr_reader :url
 
-    def initialize(url = BUKKIT_DL_API)
-        @api_url = url
-    end
+  def initialize(url = 'http://dl.bukkit.org')
+    @url = url
+  end
 
-    def download(name, version)
-        url = BUKKIT_DL_BASE + info(name, version)['file']['url']
-        download_file(url)
-    end
+  def api_url
+    "#{url}/api/1.0/downloads"
+  end
 
-    def info(name, version)
-        url = "#{@api_url}/projects/#{name}/view/#{version}/"
-        JSON.parse(open(url).read)
-    end
+  def download_url
+    url
+  end
 
-    def resolve_build(name, version)
-        "build-#{info(name, version)['build_number']}"
-    end
+  def download(name, version)
+    url = download_url + info(name, version)['file']['url']
+    download_file(url)
+  end
 
-    def resolve_version(name, version)
-        info(name, version)['version']
-    end
+  def info(name, version)
+    url = "#{api_url}/projects/#{name}/view/#{version}/"
+    JSON.parse(open(url).read)
+  end
 end

data/lib/bukin/utils.rb

@@ -1,52 +1,51 @@
 require 'open-uri'
 
 def save_download(data, name, path)
-    FileUtils.mkdir_p(path)
-    open("#{path}/#{name}", "wb") do |file|
-        file.print data
-    end
+  FileUtils.mkdir_p(path)
+  open("#{path}/#{name}", "wb") do |file|
+    file.print data
+  end
 end
 
 def download_file(url, content_disposition = false)
-    open(url) do |download|
-        file_name = if content_disposition
-                        download.meta['content-disposition']
-                                .match(/filename=(\"?)(.+)\1/)[2]
-                                .force_encoding("UTF-8")
-                    else
-                        File.basename(url)
-                    end
-        data = download.read
-        return data, file_name
-    end
+  open(url) do |download|
+    file_name = if content_disposition
+                  download.meta['content-disposition']
+                          .match(/filename=(\"?)(.+)\1/)[2]
+                          .force_encoding("UTF-8")
+                else
+                  File.basename(url)
+                end
+    data = download.read
+    return data, file_name
+  end
 end
 
-
 def install_plugin(name, version, server)
-    return false if @lockfile.plugins.has_key?(name)
+  return false if @lockfile.plugins.has_key?(name)
 
-    download_version = @bukget.resolve_version(name, version, server)
-    data, file_name = @bukget.download(name, download_version, server)
-    save_download(data, file_name, PLUGINS_PATH)
-    @lockfile.add_plugin(name, download_version, file_name)
-    return file_name, download_version
+  download_version = @bukget.resolve_version(name, version, server)
+  data, file_name = @bukget.download(name, download_version, server)
+  save_download(data, file_name, PLUGINS_PATH)
+  @lockfile.add_plugin(name, download_version, file_name)
+  return file_name, download_version
 end
 
 def pretty_version(version)
-    case version
-    when 'latest'
-        "the latest version"
-    when 'latest-rb'
-        "the latest recommended build"
-    when 'latest-beta'
-        "the latest beta build"
-    when 'latest-dev'
-        "the latest development build"
-    when /^git-(.*)$/
-        "git commit #{$1}"
-    when /^build-(.*)$/
-        "build \##{$1}"
-    else
-       "version #{version}"
-    end
+  case version
+  when 'latest'
+    "the latest version"
+  when 'latest-rb'
+    "the latest recommended build"
+  when 'latest-beta'
+    "the latest beta build"
+  when 'latest-dev'
+    "the latest development build"
+  when /^git-(.*)$/
+    "git commit #{$1}"
+  when /^build-(.*)$/
+    "build \##{$1}"
+  else
+    "version #{version}"
+  end
 end