smc-get 0.1.0

data/lib/smc_get/smc_get.rb

@@ -0,0 +1,139 @@
+#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/>.
+################################################################################
+
+require "pathname"
+require 'tempfile'
+require "fileutils"
+begin
+  require "psych"
+  YAML = Psych
+rescue LoadError
+  require 'yaml'
+end
+require 'uri'
+require 'net/https'
+
+require_relative "./errors"
+require_relative "./package"
+
+#This is the main module of smc-get and it's namespace.
+module SmcGet
+  
+  #Root directory of the smc-get program and libraries.
+  ROOT_DIR = Pathname.new(__FILE__).dirname.parent.parent
+  #Subdirectory for executable files.
+  BIN_DIR = ROOT_DIR + "bin"
+  #Subdirectory for library files.
+  LIB_DIR = ROOT_DIR + "lib"
+  #Subdirectory for configuration files.
+  CONFIG_DIR = ROOT_DIR + "config"
+  
+  #Directory where the package specifications are saved to. Relative to the
+  #data directory in SmcGet.datadir.
+  PACKAGE_SPECS_DIR = "packages".freeze
+  #Directory where a package's music files are saved to. Relative to the
+  #data directory in SmcGet.datadir.
+  PACKAGE_MUSIC_DIR = "music/contrib-music".freeze
+  #Directory where a package's graphics files are saved to. Relative to the
+  #data directory given in SmcGet.datadir
+  PACKAGE_GRAPHICS_DIR = "pixmaps/contrib-graphics".freeze
+  #Directory where a package's level files are saved to. Relative to the
+  #data directory given in SmcGet.datadir.
+  PACKAGE_LEVELS_DIR = "levels".freeze
+  #The name of the file containing the list of all levels in the
+  #repository.
+  PACKAGE_LIST_FILE = "#{PACKAGE_SPECS_DIR}/packages.lst".freeze
+  #The version of smc-get.
+  VERSION = Pathname.new(__FILE__).dirname.expand_path.join("..", "..", "VERSION.txt").read.chomp
+  
+  class << self
+    
+    #The URL of the repository.
+    attr_reader :repo_url
+    #The directory where SMC is installed.
+    attr_reader :datadir
+    
+    @repo_url = nil
+    @datadir = nil
+    
+    #Initializes the library. Pass in the URL from which you want
+    #to downloaded packages (most likely Luiji's contributed level
+    #repository at <tt>https://github.com/Luiji/Secret-Maryo-Chronicles-Contributed-Levels/raw/master/</tt>)
+    #and the directory where SMC is installed (something along the lines of
+    #<b>/usr/share/smc</b>). Note you *have* to call this method before
+    #you can make use of the smc-get library; otherwise you'll get bombed
+    #by SmcGet::Errors::LibraryNotInitialized exceptions.
+    #
+    #You may call this method more than once if you want to reinitialize
+    #the library to use other resources.
+    def setup(repo_url, datadir)
+      @repo_url = repo_url
+      @datadir = Pathname.new(datadir)
+    end
+    
+    # Download the specified raw file from the repository to the specified
+    # output file.  URL should be everything in the URL after
+    # SmcGet.repo_url.
+    # Yields the currently downloaded file and how many percent of that file have
+    # already been downloaded if a block is given.
+    def download(url, output) # :nodoc:
+      Errors::LibraryNotInitialized.throw_if_needed!
+      # Make url friendly.
+      url = URI::Parser.new.escape(url)
+      # Create directories if needed.
+      FileUtils.mkdir_p(File.dirname(output))
+      # Download file.
+      File.open(output, "w") do |outputfile|
+        uri = URI.parse(@repo_url + url)
+        
+        request = Net::HTTP.new(uri.host, uri.port)
+        request.use_ssl = true #GitHub uses SSL
+        
+        begin
+          request.start do
+            #1. Establish connection
+            request.request_get(uri.path) do |response|
+              raise(Errors::DownloadFailedError.new(url), "ERROR: Received HTTP error code #{response.code}.") unless response.code == "200"
+              #2. Get what size the file is
+              final_size = response.content_length
+              current_size = 0
+              #Ensure the first value the user sees are 0%
+              yield(url, 0) if block_given?
+              #3. Get the actual file in parts and report percent done.
+              response.read_body do |part|
+                outputfile.write(part)
+                
+                current_size += part.size
+                percent = (current_size.to_f / final_size.to_f) * 100
+                yield(url, percent) if block_given?
+              end
+            end
+            #Ensure the last value the user sees are 100%
+            yield(url, 100) if block_given?
+          end
+        rescue Timeout::Error
+          raise(Errors::ConnectionTimedOutError.new(url), "ERROR: Connection timed out.")
+        end
+      end
+    end
+    
+  end
+  
+end

data/test/test_smc-get-cui.rb

@@ -0,0 +1,121 @@
+#!/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/>.
+################################################################################
+
+require "fileutils"
+require "test/unit"
+
+if RUBY_VERSION =~ /^1.9/
+  require_relative "../lib/smc_get/smc_get"
+else #For 1.8 fans
+  require File.join(File.expand_path(File.dirname(__FILE__)), "..", "smc_get")
+end
+
+class SmcGetCUITest < Test::Unit::TestCase
+  #Directory from which packages are downloaded for the test.
+  TEST_REPO = "https://github.com/Luiji/Secret-Maryo-Chronicles-Contributed-Levels/raw/master/"
+  #Directory where we will download everything into. It's "testdir" right in this directory.
+  TEST_DIR = File.join(File.expand_path(File.dirname(__FILE__)), "testdir")
+  TEST_PACKAGES_DIR = File.join(TEST_DIR, "packages")
+  TEST_PACKAGES_MUSIC_DIR = File.join(TEST_PACKAGES_DIR, "contrib-music")
+  TEST_PACKAGES_GRAPHICS_DIR = File.join(TEST_PACKAGES_DIR, "contrib-graphics")
+  TEST_PACKAGES_LEVELS_DIR = File.join(TEST_PACKAGES_DIR, "levels")
+  #Test configuration file's location. Inside the test dir, so we're able to
+  #delete it together with everything else.
+  TEST_CONFIG_FILE = File.join(TEST_DIR, "testconf.yml")
+  
+  #The configuration file we use for this tests.
+  TEST_CONFIG =<<CONFIG
+---
+data_directory: #{TEST_DIR}
+repo_url: "https://github.com/Luiji/Secret-Maryo-Chronicles-Contributed-Levels/raw/master/"
+CONFIG
+  
+  #List of pacakges to install and inspect wheather they
+  #are correctly installed or not.
+  TEST_PACKAGES = %w[icy-mountain christmas-2010]
+  #To test wheather smc-get does know what to do in case of non-existing packages.
+  TEST_INVALID_PACKAGES = %w[sdhrfg jhjjjj]
+  
+  TEST_SEARCH_TERMS = ["icy", "chr.stmas"]
+  TEST_SEARCH_TERMS_NOT_FOUND = ["dfgd", "^icy$"]
+  
+  #The command to run smc-get
+  SMC_GET = File.join(File.expand_path(File.dirname(__FILE__)), "..", "bin", "smc-get")
+  
+  #Test initialization. Write the config file and ensure the directory we
+  #want to download into is available. Run before EACH test.
+  def setup
+    FileUtils.mkdir_p(TEST_DIR)
+    File.open(TEST_CONFIG_FILE, "w"){|f| f.write(TEST_CONFIG)}
+  end
+  
+  #Cleanup afterwards. Delete our testing directory. Run after EACH test.
+  def teardown
+    FileUtils.rm_rf(TEST_DIR)
+  end
+  
+  #Executes <tt>smc-get str</tt> and returns true on success, false
+  #otherwise. Ensures the test configuration file is loaded.
+  def smc_get(str)
+    system("#{SMC_GET} -c #{TEST_CONFIG_FILE} #{str}")
+  end
+  
+  def test_install
+    TEST_PACKAGES.each do |pkg|
+      smc_get "install #{pkg}"
+      assert(File.file?(File.join(TEST_PACKAGES_DIR, "#{pkg}.yml")), "Package file not found: #{pkg}.yml.")
+    end
+    TEST_INVALID_PACKAGES.each do |pkg|
+      assert(!smc_get("install #{pkg}"), "Command completed on invalid packages without error.")
+    end
+  end
+  
+  def test_uninstall
+    TEST_PACKAGES.each do |pkg|
+      assert(!smc_get("uninstall #{pkg}"), "Uninstalled a noninstalled package successfully.")
+      smc_get "install #{pkg}"
+      smc_get "uninstall #{pkg}"
+      assert(!File.exists?(File.join(TEST_PACKAGES_DIR, "#{pkg}.yml")), "Found after uninstalling: #{pkg}.yml")
+    end
+    TEST_INVALID_PACKAGES.each do |pkg|
+      assert(!smc_get("uninstall #{pkg}"), "Uninstalled an invalid package successfully.")
+    end
+  end
+  
+  def test_getinfo
+    TEST_PACKAGES.each do |pkg|
+      assert(smc_get("getinfo #{pkg}"), "Couldn't retrieve info for #{pkg}.")
+    end
+    TEST_INVALID_PACKAGES.each do |pkg|
+      assert(!smc_get("getinfo #{pkg}"), "Retrieved info for broken package sucessfully.")
+    end
+  end
+  
+  def test_search
+    TEST_SEARCH_TERMS.each do |query|
+      assert(smc_get("search #{query}"), "Did not find packages it ought to find.")
+    end
+    TEST_SEARCH_TERMS_NOT_FOUND.each do |query|
+      assert(!smc_get("search #{query}"), "Did find packages for invalid query.")
+    end
+  end
+  
+end

data/test/test_smc-get-lib.rb

@@ -0,0 +1,170 @@
+#!/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/>.
+################################################################################
+
+require "fileutils"
+require "test/unit"
+
+if RUBY_VERSION =~ /^1.9/
+  require_relative "../lib/smc_get/smc_get"
+else #For 1.8 fans
+  require File.join(File.expand_path(File.dirname(__FILE__)), "..", "smc_get")
+end
+
+#Test case for SmcGet. If the tests defined here don't fail, everything
+#works well.
+class SmcGetLibraryTest < Test::Unit::TestCase
+  
+  #Directory from which packages are downloaded for the test.
+  TEST_REPO = "https://github.com/Luiji/Secret-Maryo-Chronicles-Contributed-Levels/raw/master/"
+  #Directory where we will download everything into. It's "testdir" right in this directory.
+  TEST_DIR = File.join(File.expand_path(File.dirname(__FILE__)), "testdir")
+  TEST_PACKAGES_DIR = File.join(TEST_DIR, "packages")
+  TEST_PACKAGES_MUSIC_DIR = File.join(TEST_PACKAGES_DIR, "contrib-music")
+  TEST_PACKAGES_GRAPHICS_DIR = File.join(TEST_PACKAGES_DIR, "contrib-graphics")
+  TEST_PACKAGES_LEVELS_DIR = File.join(TEST_PACKAGES_DIR, "levels")
+  #Test configuration file's location. Inside the test dir, so we're able to
+  #delete it together with everything else.
+  TEST_CONFIG_FILE = File.join(TEST_DIR, "testconf.yml")
+  
+  #The configuration file we use for this tests.
+  TEST_CONFIG =<<CONFIG
+---
+data-directory: #{TEST_DIR}
+CONFIG
+  
+  #List of pacakges to install and inspect wheather they
+  #are correctly installed or not.
+  TEST_PACKAGES = %w[icy-mountain christmas-2010]
+  #To test wheather smc-get does know what to do in case of non-existing packages.
+  TEST_INVALID_PACKAGES = %w[sdhrfg jhjjjj]
+  
+  TEST_SEARCH_TERMS = ["icy", /icy/]
+  TEST_SEARCH_TERMS_NOT_FOUND = ["dfgd", /^nonexistant$/]
+  
+  #Test initialization. Write the config file and ensure the directory we
+  #want to download into is available. Run before EACH test.
+  def setup
+    FileUtils.mkdir_p(TEST_DIR)
+    File.open(TEST_CONFIG_FILE, "w"){|f| f.write(TEST_CONFIG)}
+    SmcGet.setup(TEST_REPO, TEST_DIR)
+  end
+  
+  #Cleanup afterwards. Delete our testing directory. Run after EACH test.
+  def teardown
+    FileUtils.rm_rf(TEST_DIR)
+  end
+  
+  #Tests the library's install routine.
+  def test_install
+    TEST_PACKAGES.each do |pkg|
+      puts "Test installing #{pkg}"
+      package = SmcGet::Package.new(pkg)
+      package.install
+          
+      assert(package.spec_file.file?, "Package config file for #{pkg} not found.")
+      
+      pkg_config = YAML.load_file(package.spec_file.to_s)
+      
+      Dir.chdir(TEST_DIR) do
+        [%w[levels levels], %w[music music/contrib-music], %w[graphics pixmaps/contrib-graphics]].each do |part, dir|
+          next unless pkg_config.has_key?(part)
+          pkg_config[part].each do |file|
+            assert(File.file?(File.join(dir, file)), "File not found after installing: #{file}.")
+          end
+        end
+      end
+    end
+    
+    TEST_INVALID_PACKAGES.each do |pkg|
+      assert_raises(SmcGet::Errors::NoSuchPackageError){SmcGet::Package.new(pkg).install}
+    end
+    assert_equal(TEST_PACKAGES.count, SmcGet::Package.installed_packages.count)
+  end
+  
+  #def test_incorrect_install
+  # #Maybe installed twice?
+  #end
+  
+  def test_uninstall
+    TEST_PACKAGES.each do |pkg|
+      puts "Test uninstalling #{pkg}"
+      package = SmcGet::Package.new(pkg)
+      package.install #We can't uninstall a package that is not installed
+            
+      pkg_config = YAML.load_file(package.spec_file)
+  
+      package.uninstall
+      assert(!package.spec_file.exist?, "File found after uninstalling: #{package.spec_file}.")
+      
+      Dir.chdir(TEST_DIR) do
+        [%w[levels levels], %w[music music/contrib-music], %w[graphics pixmaps/contrib-graphics]].each do |part, dir|
+          next unless pkg_config.has_key?(part)
+          pkg_config[part].each do |file|
+            assert(!File.exists?(File.join(dir, file)), "File found after uninstalling: #{file}.")
+          end
+        end
+      end
+    end
+  
+    TEST_INVALID_PACKAGES.each do |pkg|
+      assert_raises(SmcGet::Errors::NoSuchPackageError){SmcGet::Package.new(pkg).uninstall}
+    end
+    assert_equal(0, SmcGet::Package.installed_packages.count)
+  end
+  
+  def test_getinfo
+    TEST_PACKAGES.each do |pkg|
+      puts "Test getting info about #{pkg}"
+      package = SmcGet::Package.new(pkg)
+      package.install #We can't check specs from packages not installed
+        
+      pkg_config = YAML.load_file(package.spec_file)
+  
+      assert_equal(pkg_config, package.getinfo)
+    end
+  
+    TEST_INVALID_PACKAGES.each do |pkg|
+      assert_raises(SmcGet::Errors::NoSuchPackageError){SmcGet::Package.new(pkg).getinfo}
+    end
+  end
+  
+  def test_search
+    TEST_SEARCH_TERMS.each do |query|
+      ary = SmcGet::Package.search(query)
+      pkg = ary[0]
+      assert_not_equal(0, ary.size)
+      
+      pkg.install
+      
+      ary = SmcGet::Package.search(query, [:pkgname], true)
+      assert_not_equal(0, ary.size)
+      
+      pkg.uninstall
+      
+      ary = SmcGet::Package.search(query, [:pkgname], true)
+      assert_equal(0, ary.size)
+    end
+    TEST_SEARCH_TERMS_NOT_FOUND.each do |query|
+      assert_equal(0, SmcGet::Package.search(query).size)
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: smc-get
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Luiji Maryo
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-06 00:00:00 -05:00
+default_executable: 
+dependencies: []
+
+description: |
+  smc-get is a apt-get like tool to manage levels that have
+  been uploaded to the Secret Maryo Chronicles contributed
+  levels repository. You can install, remove and list the
+  levels you have installed and search for new ones that
+  are available online.
+
+email: luiji@users.sourceforge.net
+executables: 
+- smc-get
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- COPYING
+files: 
+- bin/smc-get
+- lib/smc_get/smc_get.rb
+- lib/smc_get/gui.rb
+- lib/smc_get/cui_commands/uninstall.rb
+- lib/smc_get/cui_commands/getinfo.rb
+- lib/smc_get/cui_commands/command.rb
+- lib/smc_get/cui_commands/install.rb
+- lib/smc_get/cui_commands/version.rb
+- lib/smc_get/cui_commands/list.rb
+- lib/smc_get/cui_commands/help.rb
+- lib/smc_get/cui_commands/search.rb
+- lib/smc_get/cui.rb
+- lib/smc_get/errors.rb
+- lib/smc_get/package.rb
+- lib/smc_get.rb
+- test/test_smc-get-cui.rb
+- test/test_smc-get-lib.rb
+- config/smc-get.yml
+- COPYING
+- README.rdoc
+- VERSION.txt
+has_rdoc: true
+homepage: https://github.com/Luiji/smc-get
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- -t
+- smc-get RDocs
+- -m
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: 
+- Secret Maryo Chronicles
+rubyforge_project: 
+rubygems_version: 1.5.0
+signing_key: 
+specification_version: 3
+summary: Manages Secret Maryo Chronicles levels.
+test_files: 
+- test/test_smc-get-cui.rb
+- test/test_smc-get-lib.rb