suppository 0.0.2

data/README.md

@@ -0,0 +1,103 @@
+# Super Simple Apt Repository
+[![Build Status](https://travis-ci.org/TheBookPeople/suppository.svg?branch=develop)](https://travis-ci.org/TheBookPeople/suppository) [![Code Climate](https://codeclimate.com/github/TheBookPeople/suppository/badges/gpa.svg)](https://codeclimate.com/github/TheBookPeople/suppository) [![Test Coverage](https://codeclimate.com/github/TheBookPeople/suppository/badges/coverage.svg)](https://codeclimate.com/github/TheBookPeople/suppository) 
+
+Based on the ideas from Super Simple Apt Repository https://github.com/lukepfarrar/suppository.
+
+A RubyGem that can be used to manage a simple apt repository.
+
+## Installation
+
+    $ gem install suppository
+	
+## Usage
+
+### Help
+
+    $ suppository help
+
+### Version
+
+    $ suppository version
+
+### Create new repository
+
+    $ suppository create REPOSITORY_PATH
+
+### Add Deb to existing repository
+
+    $ suppository add REPOSITORY_PATH DIST_NAME COMPONENT_NAME DEB_FILE
+
+## Build
+
+### Prerequisites
+
+Tested on Ruby 1.9.3, 2.0.0, 2.1.5 and 2.2.0
+
+Bundler
+
+RubyGems
+
+#### OSX
+
+If you are developing on a Mac the you will need to install dpkg and gpg for the tests to pass. The simplest way to install it is with 
+Homebrew (see http://brew.sh/ on how to install Homebrew)
+
+    $ brew install dpkg
+	$ brew install gpg
+
+#### Ubuntu / Debian 
+
+dpkg will already be installed but you might need to install gpg.
+ 
+
+### Run tests
+The default rake task will run code quality checks and all the tests.
+ 
+    $ bundle install
+    $ bundle exec rake
+
+If you want to automatically run the tests during development, you can use Guard. Guard will watch for file changes
+and run the appropriate tests. See https://github.com/guard/guard for more information on guard
+
+    $ bundle exec guard	
+
+### Create Gem
+
+    $ bundle exec rake build	
+
+This will run all the tests and then create a gem file. NOTE: Only files tracked by Git will be included in the gem.
+
+### Release
+
+Check everything build and the tests pass
+
+    $ bundle exec build
+
+Create release using GitFlow (http://danielkummer.github.io/git-flow-cheatsheet/)
+
+    $ git flow release start [version]
+
+Update the version number and commit changes
+
+    $ vi lib/suppository/version.rb
+
+Finish release
+
+    $ git flow release finish [version]
+
+Push changes
+
+    $ git push
+    $ git checkout develop
+	$ git push
+    $ git push --tags
+
+Travis will now build and deploy to RubyGems.org
+
+## Contributing
+
+1. Fork it ( https://github.com/TheBookPeople/suppository/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,34 @@
+require 'rake'
+require 'rake/clean'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+require 'suppository/version'
+
+desc "Run Code quality checks and tests "
+task :default => [:clean,:rubocop,:test]
+
+desc "Run Code quality checks, tests and then create Gem File"
+task :build => [:clean,:rubocop,:test,:gem]
+
+CLEAN.include("suppository-#{Suppository::VERSION}.gem")
+CLEAN.include('coverage')
+
+task :test do
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+    t.verbose = false
+  end
+  
+  Rake::Task["spec"].execute
+end
+
+task :rubocop do
+  RuboCop::RakeTask.new(:rubocop) do |task|
+    task.patterns = ['lib/**/*.rb']
+    task.fail_on_error = true
+  end
+end
+
+task :gem do
+  system "gem build suppository.gemspec"
+end

data/bin/suppository

@@ -0,0 +1,36 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# -*- mode: ruby -*-
+require_relative '../lib/suppository/cli'
+require_relative '../lib/suppository/logger'
+require_relative '../lib/suppository/help'
+
+std_trap = trap("INT") { exit! 130 } # no backtrace thanks
+
+begin
+  trap("INT", std_trap) # restore default CTRL-C handler
+  Suppository::CLI.run(ARGV)
+rescue UsageError
+  Suppository::Logger.log_error "Invalid usage"
+  abort Suppository.help
+rescue SystemExit
+  puts "Kernel.exit" if ARGV.verbose?
+  raise
+rescue Interrupt => e
+  puts # seemingly a newline is typical
+  exit 130
+rescue RuntimeError, SystemCallError => e
+  raise if e.message.empty?
+  Suppository::Logger.log_error(e)
+  exit 1
+rescue Exception => e
+  Suppository::Logger.log_error(e)
+  puts "#{Suppository::Tty.white}Please report this bug:"
+  puts "    #{Suppository::Tty.em}https://github.com/TheBookPeople/suppository/issues#{Suppository::Tty.reset}"
+  puts e.backtrace
+  exit 1
+end
+
+
+
+

data/lib/suppository/add_command.rb

@@ -0,0 +1,116 @@
+
+require 'suppository/master_deb'
+require 'suppository/repository'
+require 'suppository/exceptions'
+require 'suppository/package'
+require 'suppository/release'
+require 'suppository/logger'
+require 'suppository/checksummed'
+require 'suppository/gzip'
+require 'fileutils'
+
+module Suppository
+  class AddCommand
+    include Suppository::Logger
+
+    def initialize(args)
+      @unsigned = parse_params(args)
+      @repository = Suppository::Repository.new(args[0])
+      @dist = args[1]
+      @component = args[2]
+      @debs = Dir.glob(args[3])
+    end
+
+    def run
+      assert_repository_exists
+      assert_dist_exists
+      assert_component_exists
+
+      @debs.each { |deb| add_deb Suppository::Checksummed.new(deb) }
+
+      Suppository::Release.new(@repository.path, @dist, @unsigned).create
+    end
+
+    private
+
+    def parse_params(args)
+      fail UsageError if args.nil? || args.length < 4 || args.length > 5
+      fail UsageError if args.length == 5 && args[4] != '--unsigned'
+      args.length == 5
+    end
+
+    def add_deb(deb)
+      create_suppository_file(deb)
+      create_dist_file(suppository_file(deb), deb)
+      f = File.basename(deb.path)
+      message = "#{f} added to repository #{@repository.path}, #{@dist} #{@component}"
+      log_success message
+    end
+
+    def assert_repository_exists
+      message = "#{@repository.path} is not a valid repository.\n"
+      message << "You can create a new repository by running the following command\n\n"
+      message << "   suppository create #{@repository.path}"
+      fail InvalidRepositoryError, message  unless @repository.exist?
+    end
+
+    def assert_dist_exists
+      supported_dist = @repository.dists.join(', ')
+      message = "#{@dist} does not exist, try one of the following #{supported_dist}"
+      fail InvalidDistribution, message  unless File.exist?("#{dist_path}")
+    end
+
+    def assert_component_exists
+      message = "#{@component} does not exist, try internal instead"
+      fail InvalidComponent, message unless File.exist?("#{component_path}")
+    end
+
+    def create_suppository_file(deb)
+      FileUtils.copy_file(deb.path, suppository_file(deb), true)
+    end
+
+    def create_dist_file(master_file, deb)
+      @repository.archs.each do |arch|
+        FileUtils.ln_s master_file, dist_file(arch, deb), force: true
+        update_packages master_file, arch
+      end
+    end
+
+    def update_packages(master_file, arch)
+      deb = Suppository::MasterDeb.new(master_file)
+      file = package_file(arch)
+      package_info = Suppository::Package.new(internal_path(arch), deb).content
+      open(file, 'a') { |f| f.puts package_info }
+      Suppository::Gzip.compress file
+    end
+
+    def dist_file(arch, deb)
+      filename = Suppository::MasterDeb.new(suppository_file(deb)).filename
+      "#{component_path}/binary-#{arch}/#{filename}"
+    end
+
+    def package_file(arch)
+      "#{component_path}/binary-#{arch}/Packages"
+    end
+
+    def internal_path(arch)
+      "dists/#{@dist}/#{@component}/binary-#{arch}"
+    end
+
+    def suppository_file(deb)
+      "#{suppository}/#{deb.md5}_#{deb.sha1}_#{deb.sha2}.deb"
+    end
+
+    def dist_path
+      "#{@repository.path}/dists/#{@dist}"
+    end
+
+    def component_path
+      "#{dist_path}/#{@component}"
+    end
+
+    def suppository
+      @repository.suppository
+    end
+  end
+end

data/lib/suppository/checksummed.rb

@@ -0,0 +1,24 @@
+
+require 'digest'
+
+module Suppository
+  class Checksummed
+    attr_reader :path
+
+    def initialize(path)
+      @path = File.expand_path(path)
+    end
+
+    def md5
+      @md5 ||= Digest::MD5.file(@path).hexdigest
+    end
+
+    def sha1
+      @sha1 ||= Digest::SHA1.file(@path).hexdigest
+    end
+
+    def sha2
+      @sha2 ||= Digest::SHA2.file(@path).hexdigest
+    end
+  end
+end

data/lib/suppository/cli.rb

@@ -0,0 +1,26 @@
+
+require 'suppository/exceptions'
+
+module Suppository
+  class CLI
+    def self.run(args)
+      fail UsageError if args.empty?
+      cmd = args.delete_at(0)
+
+      begin
+        clazz(cmd).new(args).run
+      rescue LoadError
+        raise UsageError
+      end
+    end
+
+    def self.clazz(cmd)
+      require "suppository/#{cmd}_command"
+      clazz_name(cmd).split('::').inject(Object) { |a, e| a.const_get e }
+    end
+
+    def self.clazz_name(cmd)
+      "Suppository::#{cmd.capitalize}Command"
+    end
+  end
+end

data/lib/suppository/command_runner.rb

@@ -0,0 +1,30 @@
+
+require 'suppository/exceptions'
+
+module Suppository
+  class CommandRunner
+    def initialize(command, arguments = '')
+      @command = command
+      @arguments = arguments
+    end
+
+    def run
+      assert_exists
+      run_command
+    end
+
+    private
+
+    def assert_exists
+      `which "#{@command}"`
+      message =  "'#{@command}' was not found."
+      fail(CommandMissingError, message) unless $CHILD_STATUS.success?
+    end
+
+    def run_command
+      output = `#{@command} #{@arguments} 2>&1`
+      fail(CommandError, output) unless $CHILD_STATUS.success?
+      output
+    end
+  end
+end

data/lib/suppository/create_command.rb

@@ -0,0 +1,75 @@
+
+require 'fileutils'
+require 'suppository/logger'
+require 'suppository/repository'
+require 'suppository/exceptions'
+require 'suppository/gzip'
+
+module Suppository
+  class CreateCommand
+    include Suppository::Logger
+
+    def initialize(args)
+      assert_arguments args
+      @repository = repository(args[0])
+    end
+
+    def run
+      assert_not_created
+      create_repository
+    end
+
+    private
+
+    def assert_arguments(args)
+      message = 'Create command needs one argument, the path to the new repository'
+      fail UsageError, message if args.nil? || args.length != 1
+    end
+
+    def repository(path)
+      Suppository::Repository.new(path)
+    end
+
+    def assert_not_created
+      @repository.exist? ? fail("#{path} is already a repository") : ''
+    end
+
+    def create_repository
+      FileUtils.mkdir_p "#{suppository}"
+      create_dists_folders
+      log_success "Created new Repository - #{path}"
+    end
+
+    def create_dists_folders
+      @repository.dists.each do |dist|
+        create_archs_folders dist
+      end
+    end
+
+    def create_archs_folders(dist)
+      @repository.archs.each do |arch|
+        create_folder(path, dist, arch)
+      end
+    end
+
+    def create_folder(path, dist, arch)
+      dir_path = "#{path}/dists/#{dist}/internal/binary-#{arch}"
+      FileUtils.mkdir_p dir_path
+      create_packages_file(dir_path)
+    end
+
+    def create_packages_file(path)
+      packages_file = "#{path}/Packages"
+      FileUtils.touch packages_file
+      Suppository::Gzip.compress packages_file
+    end
+
+    def suppository
+      @repository.suppository
+    end
+
+    def path
+      @repository.path
+    end
+  end
+end

data/lib/suppository/dpkg_deb.rb

@@ -0,0 +1,29 @@
+
+require 'suppository/dpkg_deb_line'
+require 'suppository/command_runner'
+
+module Suppository
+  class DpkgDeb
+    attr_reader :attibutes
+
+    def initialize(deb_path)
+      command = CommandRunner.new('dpkg-deb', "-f #{deb_path}")
+      @attibutes = parser(command.run)
+    end
+
+    private
+
+    def parser(output)
+      attibutes = {}
+      output.each_line do |line|
+        attibute = parser_line(line)
+        attibutes = attibutes.merge(attibute) { |_, first, second| first + second }
+      end
+      attibutes
+    end
+
+    def parser_line(output_line)
+      DpkgDebLine.new(output_line).attributes
+    end
+  end
+end

data/lib/suppository/dpkg_deb_line.rb

@@ -0,0 +1,28 @@
+module Suppository
+  class DpkgDebLine
+    DESCRIPTION_FIELD = 'Description'
+
+    attr_reader :attributes
+
+    def initialize(line)
+      field = split_line(line)
+      if description?(line)
+        @attributes = { DESCRIPTION_FIELD => line }
+      elsif field
+        @attributes = { field['fieldname'] => field['fieldvalue'] }
+      else
+        fail "can't parse line - '#{line}'"
+      end
+    end
+
+    private
+
+    def split_line(line)
+      /^(?<fieldname>[^:]+): (?<fieldvalue>.+)$/.match(line)
+    end
+
+    def description?(line)
+      /^ .+$/.match(line)
+    end
+  end
+end

data/lib/suppository/exceptions.rb

@@ -0,0 +1,20 @@
+class UsageError < RuntimeError
+end
+
+class InvalidDistribution < RuntimeError
+end
+
+class InvalidComponent < RuntimeError
+end
+
+class CommandMissingError < RuntimeError
+end
+
+class InvalidMasterDeb < RuntimeError
+end
+
+class InvalidRepositoryError < RuntimeError
+end
+
+class CommandError < RuntimeError
+end

data/lib/suppository/gzip.rb

@@ -0,0 +1,14 @@
+
+require 'zlib'
+
+module Suppository
+  module Gzip
+    def self.compress(file)
+      Zlib::GzipWriter.open("#{file}.gz") do |gz|
+        gz.mtime = File.mtime(file)
+        gz.orig_name = file
+        gz.write IO.read(file)
+      end
+    end
+  end
+end

data/lib/suppository/help.rb

@@ -0,0 +1,22 @@
+HELP = <<-EOS
+Example usage:
+
+  suppository help
+    - Display this Help message
+
+  suppository version
+    - Display version
+
+  suppository create <REPOSITORY_PATH>
+    - Create new empty repository in REPOSITORY_PATH
+
+  suppository add <REPOSITORY_PATH> <DIST> <COMPONENT> <DEB_FILE> [--unsigned]
+    - Add DEB_FILE to DIST and COMPONENT of repository at REPOSITORY_PATH
+
+EOS
+
+module Suppository
+  def self.help
+    HELP
+  end
+end

data/lib/suppository/help_command.rb

@@ -0,0 +1,13 @@
+
+require 'suppository/help'
+
+module Suppository
+  class HelpCommand
+    def initialize(_)
+    end
+
+    def run
+      puts Suppository.help
+    end
+  end
+end

data/lib/suppository/logger.rb

@@ -0,0 +1,24 @@
+
+require 'suppository/tty'
+
+module Suppository
+  module Logger
+    def log_info(message)
+      puts message
+    end
+
+    def log_verbose(message)
+      puts "#{Tty.gray}#{message}#{Tty.reset}"
+    end
+
+    def log_error(error)
+      $stderr.puts "#{Tty.red}Error#{Tty.reset}: #{error}"
+    end
+
+    def log_success(message)
+      puts "#{Tty.green}==>#{Tty.white} #{message}#{Tty.reset}"
+    end
+
+    module_function :log_info, :log_error, :log_success, :log_verbose
+  end
+end

data/lib/suppository/master_deb.rb

@@ -0,0 +1,62 @@
+require 'suppository/exceptions'
+require 'suppository/dpkg_deb'
+
+module Suppository
+  class MasterDeb
+    attr_reader :md5sum, :sha256, :sha1, :dirname
+
+    def initialize(path)
+      @path = path
+
+      assert_in_suppository
+      checksums = checksums_from_name
+
+      @md5sum = checksums['md5']
+      @sha1 = checksums['sha1']
+      @sha256 = checksums['sha256']
+
+      @dirname = File.dirname(path)
+      @attr = Suppository::DpkgDeb.new(path).attibutes
+    end
+
+    def filename
+      "#{@attr['Package']}_#{@attr['Version']}_#{@attr['Architecture']}.deb"
+    end
+
+    def full_attr
+      full_attrs = @attr
+      full_attrs['Size'] = size
+      full_attrs['MD5Sum'] = @md5sum
+      full_attrs['SHA1'] = @sha1
+      full_attrs['SHA256'] = @sha256
+      full_attrs
+    end
+
+    def size
+      File.size(@path)
+    end
+
+    private
+
+    def assert_in_suppository
+      message = 'Master deb must be in the .suppository folder'
+      fail InvalidMasterDeb, message unless suppository_file?
+    end
+
+    def suppository_file?
+      File.dirname(@path).end_with?('.suppository')
+    end
+
+    def checksums_from_name
+      file_name = File.basename(@path)
+      matches = filename_regex.match(file_name)
+      message = 'Master deb must have the following name {md5}_{sha1}_{sha256}.deb'
+      fail InvalidMasterDeb, message unless matches
+      matches
+    end
+
+    def filename_regex
+      /^(?<md5>[a-f0-9]{32})_(?<sha1>[a-f0-9]{40})_(?<sha256>[a-f0-9]{64})\.deb$/
+    end
+  end
+end

data/lib/suppository/package.rb

@@ -0,0 +1,23 @@
+
+module Suppository
+  class Package
+    def initialize(parent_folder, deb)
+      @deb = deb
+      @parent_folder = parent_folder
+    end
+
+    def content
+      full_attrs = @deb.full_attr
+      full_attrs[:Filename] = filename
+      full_attrs.sort_by { |k, _v| k == 'Description' ? 1 : 0 }
+        .to_a.map { |kv_pair| kv_pair.join(': ') }
+        .join("\n") << "\n\n"
+    end
+
+    private
+
+    def filename
+      "#{@parent_folder}/#{@deb.filename}"
+    end
+  end
+end