smc-get 0.1.0 → 0.2.0.beta1

data/HISTORY.rdoc

@@ -0,0 +1,31 @@
+This file documents the the changes that have been made
+to smc-get between versions. It's *not* intended to serve
+as a full-blown changelog, for this you have to install git
+and issue a <tt>git log</tt> command in the project directory.
+
+Bugfixes are written in <i>italic</i>, mayor changes in <b>bold</b> font.
+
+== 0.2.0-beta1
+
+* <b>Added a completely new SMC package format: smcpak. These are XZ-compressed
+  tarballs allowing for easy deployment of packages. See the smcpak.rdoc file
+  for further information.</b>
+* <b>Rewrote nearly the full API. This release is 100%
+  incompatible with anything released so far.</b>
+* <b>New classes LocalRepository and RemoteRepository for
+  managing downloads and installations.</b>
+* <b><tt>smc-get list</tt> without arguments works a little different now. 
+  Instead of showing the installation time of a package it now shows the
+  time of the last update, which allows you to better keep track of
+  what is out of date.</b>
+* <b>Added <tt>smc-get update</tt> for a fully automated update of all (or
+  selected) installed packages.</b>
+* <b>Added <tt>smc-get build</tt> to automatically build SMC packages either
+  interactively or as an automated process.</b>
+* Added modification detection via SHA1 checksums.
+* New dependency on the {ruby-xz gem}[http://rubygems.org/gems/ruby-xz].
+* New dependency on the {minitar gem}[http://rubygems.org/gems/minitar].
+* New dependency on liblzma[http://tukaani.org/xz/].
+* Official bugtracker is now at GitHub: https://github.com/Luiji/smc-get/issues.
+* Added this file (HISTORY.rdoc) for collecting change information.
+

data/README.rdoc

@@ -1,148 +1,163 @@
-= SMC-GET -- level repository manager for Secret Maryo Chronicles
-smc-get - Library and command-line for managing SMC level packages.
-
-Author::      Luiji Maryo (mailto:luiji@users.sourceforge.net)
-Contributor:: Marvin Gülker (mailto:sutniuq@gmx.net)
-Copyright::   Copyright (C) 2010-2011 Entertaining Software, Inc.
-Copyright::   Copyright (C) 2011 Marvin Gülker
-License::     GNU General Public License (see COPYING)
-
-= Synopsis for use as a command-line tool
-  smc-get install mypackage
-  smc-get uninstall mypackage
-  smc-get help
-
-= Synopsis for use as a library
-  require 'smc_get'
-  #Initialize the library
-  SmcGet.setup(
-    #From where to download packages
-    "https://github.com/Luiji/Secret-Maryo-Chronicles-Contributed-Levels/raw/master/",
-    #Where to install packages (your SMC installation)
-    "/usr/local/share/smc"
-  )
-  #Get a package
-  pkg = SmcGet::Package.new("mypackage")
-  #Install it!
-  pkg.install
-  #...or remove it.
-  pkg.uninstall
-
-= Description
-smc-get is a library and command-line tool for installing, uninstalling, etc.
-level packages from the Secret Maryo Chronicles Contributed Levels Repository.
-
-== Prototype Notice
-
-This program is a prototype for functionality that will eventually be merged
-with Secret Maryo Chronicles. It is subject to change and should not be used
-for anything other then testing.
-
-= Usage
-
-== Using it as a command-line
-smc-get's main purpose is to be used as a command-line utility.  It should be
-executed in the syntax:
- smc-get COMMAND [PARAMETERS...]
-Where <tt>COMMAND</tt> is the command and <tt>PARAMATERS...</tt> are the
-parameters for that command.
-
-To get help on the various commands, use the help command.
- smc-get help [COMMAND]
-Ommit the +COMMAND+ if you want general usage information.
-
-=== Configuration file
-smc-get requires a configuration file when used as a commandline tool.
-By default it searches for <tt>smc-get.yml</tt> in the <b>config/</b>
-subdirectory of your smc-get installation, then for <tt>smc-get-conf.yml</tt>
-in the user's home directory and then for the file specified via the <tt>-c</tt>
-commandline switch, if existant. Values set in later evaluated configuration
-files override those in prevously evaluated ones; see
-  smc-get help
-for more explanation. If you want to use the CUI from your scripts, you
-can specify a config file via <tt>-c</tt>, but make sure it contains all
-possible options, otherwise those in the global or user-level config files
-may affect your program. See below for an example.
-
-Be careful when using +sudo+, because it changes the environment variables.
-smc-get may not find your user-level configuration file when using sudo,
-because it derives the path from the +USER+ environment variable which may
-get set to +root+ when using +sudo+.
-
-In the configuration file you can set some general options, look into
-the file which is quite self-explanatory. A sample configuration may
-look like this:
-  data_directory: "/usr/local/share/smc"
-  repo_url: "https://github.com/Luiji/Secret-Maryo-Chronicles-Contributed-Levels/raw/master/"
-
-== Using it as a library
-smc-get, although mainly targetted at being a command-line utility, may also be
-used as a library.  This is useful when, for instance, creating a GUI front-end.
-
-To initialize the library, indicate which repository you are using and
-where you want smc-get to install the packages to (which is usually your
-SMC installation path)
-  SmcGet.setup(
-    "https://github.com/Luiji/Secret-Maryo-Chronicles-Contributed-Levels/raw/master/",
-    "/usr/local/share/smc"
-  )
-
-For interacting with the SMC repository, smc-get exposes an object-oriented API
-centered around the SmcGet::Package class. After you initialized the library
-as explained above, you can query, install and uninstall packages.
-  pkg = SmcGet::Package.new("mypackage")
-  pkg.install
-
-If the function fails, it will raise various exceptions.  When creating a GUI,
-you should catch these exceptions and present them as message boxes.
- begin
-   Package.new("mypackage").install
- rescue SmcGet::Errors::NoSuchPackageError
-   alert 'No such package "mypackage"!'
- end
-
-All errors smc-get raises are subclasses of SmcGet::Errors::SmcGetError. That
-means, if you rescue from this exception, you can handle all package-related
-errors at once:
-  begin
-    Package.new("mypackage").install
-  rescue SmcGet::Errors::SmcGetError => e
-    alert e.message
-  end
-
-Furhtermore, these error messages should have a pretty informative message set,
-so unless you want to localize the error messages you can just reach them
-through (the messages, not the whole exceptions, of course).
-
-The configuration file only contains settings for the commandline user
-interface, so you don't need it here. If you want to use the CUI from
-your scripts, do
-  require "smc_get"
-  require "smc_get/cui"
-  
-  cui = SmcGet::CUI.new(ARGV)
-  cui.start
-The configuration file from the <b>config/</b> directory will automatically
-be loaded as well as the user-level configuration file; you may specify another
-configuration file by placing the appropriate option in ARGV:
-  ARGV.unshift("-c")
-  ARGV.unshift("YOURCONFIGFILE.yml")
-  
-  cui = SmcGet::CUI.new(ARGV)
-  cui.start
-
-= License
-
-smc-get is licensed under the GNU General Public License. For more information,
-see COPYING.
-
-= Website
-
-This software was written by Entertaining Software, Inc. Visit us at
-http://www.entertainingsoftware.com.
-
-This software is hosted at GitHub. The project page can be found at
-http://github.com/Luiji/smc-get.
-
-This software was written for Secret Maryo Chronicles. Visit them at
-http://www.secretmaryo.org.
+= SMC-GET -- level repository manager for Secret Maryo Chronicles
+smc-get - Library and command-line for managing SMC level packages.
+
+Author::      Luiji Maryo (mailto:luiji@users.sourceforge.net)
+Contributor:: Marvin Gülker (mailto:sutniuq@gmx.net)
+Copyright::   Copyright (C) 2010-2011 Entertaining Software, Inc.
+Copyright::   Copyright (C) 2011 Marvin Gülker
+License::     GNU General Public License (see COPYING)
+
+= Synopsis for use as a command-line tool
+  smc-get install mypackage
+  smc-get uninstall mypackage
+  smc-get help
+
+= Synopsis for use as a library
+  require 'smc_get'
+  # Initialize the library
+  SmcGet.setup
+  
+  # Bind to local and remote repositories
+  rr = SmcGet::RemoteRepository.new("http://example.org/smc-repo")
+  lr = SmcGet::LocalRepository.new("/usr/share/smc")
+  
+  # Get a package
+  path = rr.fetch_package("mypackage")
+  pkg = SmcGet::Package.from_file(pkg)
+  
+  # Install it!
+  lr.install(pkg)
+  
+  #...or remove it.
+  lr.uninstall("mypackage")
+
+= Description
+smc-get is a library and command-line tool for installing, uninstalling, etc.
+level packages from the Secret Maryo Chronicles Contributed Levels Repository.
+
+== Prototype Notice
+
+This program is a prototype for functionality that will eventually be merged
+with Secret Maryo Chronicles. It is subject to change and should not be used
+for anything other then testing.
+
+= Usage
+
+== Using it as a command-line
+smc-get's main purpose is to be used as a command-line utility.  It should be
+executed in the syntax:
+ smc-get COMMAND [PARAMETERS...]
+Where <tt>COMMAND</tt> is the command and <tt>PARAMATERS...</tt> are the
+parameters for that command.
+
+To get help on the various commands, use the help command.
+  smc-get help [COMMAND]
+Ommit the +COMMAND+ if you want general usage information.
+
+=== Configuration file
+smc-get requires a configuration file when used as a commandline tool.
+By default it searches for <tt>smc-get.yml</tt> in the <b>config/</b>
+subdirectory of your smc-get installation, then for <tt>smc-get-conf.yml</tt>
+in the user's home directory and then for the file specified via the <tt>-c</tt>
+commandline switch, if existant. Values set in later evaluated configuration
+files override those in prevously evaluated ones; see
+  smc-get help
+for more explanation. If you want to use the CUI from your scripts, you
+can specify a config file via <tt>-c</tt>, but make sure it contains all
+possible options, otherwise those in the global or user-level config files
+may affect your program. See below for an example.
+
+Be careful when using +sudo+, because it changes the environment variables.
+smc-get may not find your user-level configuration file when using sudo,
+because it derives the path from the +USER+ environment variable which may
+get set to +root+ when using +sudo+.
+
+In the configuration file you can set some general options, look into
+the file which is quite self-explanatory. A sample configuration may
+look like this:
+  data_directory: "/usr/local/share/smc"
+  repo_url: "ftp://ftp.example.org/smc
+
+== Using it as a library
+smc-get, although mainly targetted at being a command-line utility, may also be
+used as a library.  This is useful when, for instance, creating a GUI front-end.
+
+To initialize the library, call SmcGet.setup which will do some basic initialization
+needed for use of the library.
+  SmcGet.setup
+For interacting with the SMC repository, smc-get exposes an object-oriented API
+centered around the Package and repository classes. Before you can do anything,
+you have to "establish" connections to a remote and a local repository, where
+remote repositories are repositories where <tt>smc-get</tt> downloads from,
+and local repositories are repositories where <tt>smc-get</tt> installs
+into, i.e. usually your SMC installation. You can use multiple repositories
+if you know how to manage it.
+
+  rr = SmcGet::RemoteRepository.new("http://example.org/smc-repo")
+  lr = SmcGet::LocalRepository.new("/usr/local/share/smc")
+
+After you initialized the library
+as explained above, you can query, install and uninstall packages.
+
+  path = rr.fetch_package("mypackage")
+  pkg = SmcGet::Package.from_file(path)
+  lr.install(pkg)
+
+If any of the methods fails, it will raise various exceptions.  When creating a GUI,
+you should catch these exceptions and present them as message boxes.
+
+  begin
+    rr.fetch_package("mypackage")
+  rescue SmcGet::Errors::NoSuchPackageError => e
+    alert "No such package: #{e.package_name}!"
+  end
+
+All errors smc-get raises are subclasses of SmcGet::Errors::SmcGetError. That
+means, if you rescue from this exception, you can handle all package-related
+errors at once:
+
+  begin
+    lr.install(pkg)
+  rescue SmcGet::Errors::SmcGetError => e
+    alert e.message
+  end
+
+Furthermore, these error messages should have a pretty informative message set,
+so unless you want to localize the error messages you can just reach them
+through (the messages, not the whole exceptions, of course).
+
+The configuration file only contains settings for the commandline user
+interface, so you don't need it here. If you want to use the CUI from
+your scripts, do
+  require "smc_get"
+  require "smc_get/cui"
+  
+  cui = SmcGet::CUI.new(ARGV)
+  cui.start
+The configuration file from the <b>config/</b> directory will automatically
+be loaded as well as the user-level configuration file; you may specify another
+configuration file by placing the appropriate option in ARGV:
+  ARGV.unshift("-c")
+  ARGV.unshift("YOURCONFIGFILE.yml")
+  
+  cui = SmcGet::CUI.new(ARGV)
+  cui.start
+
+= License
+
+smc-get is licensed under the GNU General Public License version 3 or later. For
+more information, see COPYING.
+
+= Website
+
+This software was written by Entertaining Software, Inc. Visit us at
+http://www.entertainingsoftware.com.
+
+This software is hosted at GitHub. The project page can be found at
+https://github.com/Luiji/smc-get.
+
+This software was written for Secret Maryo Chronicles. Visit them at
+http://www.secretmaryo.org.
+
+Bugs related to this software may be reported at 
+https://github.com/Luiji/smc-get/issues.

data/VERSION.txt

@@ -1 +1 @@
-0.1.0
+0.2.0-beta1

data/bin/smc-checksum

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+#Encoding: UTF-8
+
+require "pathname"
+require "digest/sha1"
+
+PROG = File.basename($0)
+
+if ARGV.include?("-h") or ARGV.include?("--help")
+  puts(<<HELP)
+USAGE:
+  #{PROG} [FILES...]
+
+Prints out all SHA1 checksums of the FILES given at the commandline.
+FILES that are directories are listed recursively. If no FILES
+are given, recursively lists the current directory.
+HELP
+exit
+end
+
+Signal.trap("SIGINT"){exit}
+Signal.trap("SIGTERM"){exit}
+
+ARGV.unshift(".") if ARGV.empty?
+
+ARGV.each do |arg|
+  begin
+    path = Pathname.new(arg)
+    
+    if path.file?
+      puts "#{path}: #{Digest::SHA1.hexdigest(File.read(path))}"
+    else
+      path.find do |sub_path|
+        puts "#{sub_path}: #{Digest::SHA1.hexdigest(File.read(sub_path))}" if sub_path.file?
+      end
+    end
+  rescue Errno::ENOENT => e
+    $stderr.puts("WARNING: Not found: #{arg}.")
+    $stderr.puts("Skipping.")
+  rescue Errno::EACCES => e
+    $stderr.puts("WARNING: Permission denied: #{arg}.")
+    $stderr.puts("Skipping.")
+  end
+end

data/bin/smc-get

@@ -1,31 +1,31 @@
-#!/usr/bin/env ruby
-#Encoding: UTF-8
-################################################################################
-# This file is part of smc-get.
-# Copyright (C) 2010-2011 Entertaining Software, Inc.
-# Copyright (C) 2011 Marvin Gülker
-#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# This program is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
-# GNU General Public License for more details.
-#
-# You should have received a copy of the GNU General Public License
-# along with this program. If not, see <http://www.gnu.org/licenses/>.
-################################################################################
-
-if RUBY_VERSION =~ /^1.8/ #1.8 doesn't have require_relative
-  require File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib", "smc_get", "smc_get")
-  require File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib", "smc_get", "cui")
-else
-  require_relative "../lib/smc_get/smc_get"
-  require_relative "../lib/smc_get/cui"
-end
-
-cui = SmcGet::CUI.new(ARGV)
-cui.start
+#!/usr/bin/env ruby
+#Encoding: UTF-8
+################################################################################
+# This file is part of smc-get.
+# Copyright (C) 2010-2011 Entertaining Software, Inc.
+# Copyright (C) 2011 Marvin Gülker
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program. If not, see <http://www.gnu.org/licenses/>.
+################################################################################
+
+if RUBY_VERSION =~ /^1.8/ #1.8 doesn't have require_relative
+  require File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib", "smc_get", "smc_get")
+  require File.join(File.expand_path(File.dirname(__FILE__)), "..", "lib", "smc_get", "cui")
+else
+  require_relative "../lib/smc_get/smc_get"
+  require_relative "../lib/smc_get/cui"
+end
+
+cui = SmcGet::CUI.new(ARGV)
+cui.start