puppet-library 0.10.0 → 0.11.0

data/lib/puppet_library/forge/multi.rb

@@ -15,7 +15,9 @@
 # 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 'puppet_library/forge/forge'
 require 'puppet_library/forge/search_result'
+require 'puppet_library/util/patches'
 
 module PuppetLibrary::Forge
 
@@ -35,11 +37,19 @@ module PuppetLibrary::Forge
     #     multi_forge = Multi.new
     #     multi_forge.add_forge(Directory.new("/var/modules"))
     #     multi_forge.add_forge(Proxy.new("http://forge.puppetlabs.com"))
-    class Multi
+    class Multi < Forge
         def initialize
             @forges = []
         end
 
+        def prime
+            @forges.each_in_parallel &:prime
+        end
+
+        def clear_cache
+            @forges.each_in_parallel &:clear_cache
+        end
+
         # Add another forge to delegate to.
         def add_forge(forge)
             @forges << forge

data/lib/puppet_library/forge/proxy.rb

@@ -15,9 +15,11 @@
 # 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 'puppet_library/forge/forge'
 require 'puppet_library/http/http_client'
 require 'puppet_library/http/cache/in_memory'
 require 'puppet_library/http/cache/noop'
+require 'puppet_library/util/config_api'
 
 module PuppetLibrary::Forge
 
@@ -29,16 +31,14 @@ module PuppetLibrary::Forge
     #        # The URL of the remote forge
     #        repo.url = "http://forge.example.com
     #    end
-    class Proxy
+    class Proxy < Forge
 
-        class Config
-            attr_accessor :url
-        end
-
-        def self.configure
-            config = Config.new
-            yield(config)
-            Proxy.new(config.url)
+        def self.configure(&block)
+            config_api = PuppetLibrary::Util::ConfigApi.for(Proxy) do
+                required :url, "URL"
+            end
+            config = config_api.configure(&block)
+            Proxy.new(config.get_url)
         end
 
         # * <tt>:url</tt> - The URL of the remote forge.
@@ -49,6 +49,11 @@ module PuppetLibrary::Forge
             @download_cache = download_cache
         end
 
+        def clear_cache
+            @query_cache.clear
+            @download_cache.clear
+        end
+
         def search_modules(query)
             query_parameter = query.nil? ? "" : "?q=#{query}"
             results = get("/modules.json#{query_parameter}")

data/lib/puppet_library/forge/source.rb

@@ -27,14 +27,14 @@ module PuppetLibrary::Forge
     # <b>Note:</b>
     # The module directory must have a +Modulefile+.
     class Source < PuppetLibrary::Forge::Abstract
-        class Config
-            attr_accessor :path
-        end
-
-        def self.configure
-            config = Config.new
-            yield(config)
-            Source.new(config.path)
+        def self.configure(&block)
+            config_api = PuppetLibrary::Util::ConfigApi.for(Source) do
+                required :path, "path to the module's source" do |path|
+                    Dir.new(File.expand_path(path))
+                end
+            end
+            config = config_api.configure(&block)
+            Source.new(config.get_path)
         end
 
         CACHE_TTL_MILLIS = 500
@@ -42,16 +42,15 @@ module PuppetLibrary::Forge
         # * <tt>:module_dir</tt> - The directory containing the module's source.
         def initialize(module_dir)
             super(self)
-            module_dir = File.expand_path(module_dir)
-            raise "Module directory '#{module_dir}' doesn't exist" unless File.directory? module_dir
-            raise "Module directory '#{module_dir}' isn't readable" unless File.executable? module_dir
+            raise "Module directory '#{module_dir.path}' doesn't exist" unless File.directory? module_dir.path
+            raise "Module directory '#{module_dir.path}' isn't readable" unless File.executable? module_dir.path
             @module_dir = module_dir
             @cache = PuppetLibrary::Http::Cache::InMemory.new(CACHE_TTL_MILLIS)
         end
 
         def get_module(author, name, version)
             return nil unless this_module?(author, name, version)
-            PuppetLibrary::Archive::Archiver.archive_dir(@module_dir, "#{author}-#{name}-#{version}") do |archive|
+            PuppetLibrary::Archive::Archiver.archive_dir(@module_dir.path, "#{author}-#{name}-#{version}") do |archive|
                 archive.add_file("metadata.json", 0644) do |entry|
                     entry.write modulefile.to_metadata.to_json
                 end
@@ -78,7 +77,7 @@ module PuppetLibrary::Forge
         end
 
         def modulefile
-            modulefile_path = File.join(@module_dir, "Modulefile")
+            modulefile_path = File.join(@module_dir.path, "Modulefile")
             @cache.get modulefile_path do
                 PuppetLibrary::PuppetModule::Modulefile.read(modulefile_path)
             end

data/lib/puppet_library/http/cache/disk.rb

@@ -15,14 +15,18 @@
 # 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 'monitor'
+
 module PuppetLibrary::Http
     module Cache
         class Disk
             def initialize(directory)
                 @directory = directory
+                @mutex = Monitor.new
             end
 
-            def get(path)
+            def get(path = "entry")
                 unless include? path
                     buffer = yield
                     save(path, buffer)
@@ -30,25 +34,39 @@ module PuppetLibrary::Http
                 retrieve(path)
             end
 
+            def clear
+                @mutex.synchronize do
+                    FileUtils.rm_rf @directory.path
+                end
+            end
+
             private
             def include?(path)
-                File.exist? entry_path(path)
+                @mutex.synchronize do
+                    File.exist? entry_path(path)
+                end
             end
 
             def save(path, buffer)
-                file_path = entry_path(path)
-                FileUtils.mkdir_p File.dirname(file_path)
-                File.open(file_path, "w") do |file|
-                    file.write buffer.read
+                @mutex.synchronize do
+                    file_path = entry_path(path)
+                    FileUtils.mkdir_p File.dirname(file_path)
+                    File.open(file_path, "w") do |file|
+                        file.write buffer.read
+                    end
                 end
             end
 
             def retrieve(path)
-                File.open(entry_path(path))
+                @mutex.synchronize do
+                    File.open(entry_path(path))
+                end
             end
 
             def entry_path(path)
-                File.join(@directory, path)
+                @mutex.synchronize do
+                    File.join(@directory.path, path)
+                end
             end
         end
     end

data/lib/puppet_library/http/cache/in_memory.rb

@@ -18,12 +18,12 @@
 module PuppetLibrary::Http
     module Cache
         class InMemory
-            ARBITRARY_CACHE_TTL_MILLIS = 10 * 1000
-            def initialize(millis_to_live = ARBITRARY_CACHE_TTL_MILLIS)
-                @reaper = Reaper.new(millis_to_live)
+            ARBITRARY_CACHE_TTL_SECONDS = 10
+            def initialize(seconds_to_live = ARBITRARY_CACHE_TTL_SECONDS)
+                @reaper = Reaper.new(seconds_to_live)
             end
 
-            def get(key)
+            def get(key = "entry")
                 entry = retrieve(key)
                 if entry
                     return entry.value unless @reaper.wants_to_kill? entry
@@ -42,6 +42,10 @@ module PuppetLibrary::Http
                 cache[key] = entry
             end
 
+            def clear
+                @cache.clear
+            end
+
             private
             def cache
                 @cache ||= {}
@@ -55,19 +59,18 @@ module PuppetLibrary::Http
                     @value = value
                 end
 
-                def age_millis
-                    age_seconds = Time.now - @birth
-                    age_seconds * 1000
+                def age
+                    Time.now - @birth
                 end
             end
 
             class Reaper
-                def initialize(millis_to_live)
-                    @millis_to_live = millis_to_live
+                def initialize(time_to_let_live)
+                    @time_to_let_live = time_to_let_live
                 end
 
                 def wants_to_kill?(entry)
-                    entry.age_millis > @millis_to_live
+                    entry.age > @time_to_let_live
                 end
             end
         end

data/lib/puppet_library/http/cache/noop.rb

@@ -20,9 +20,12 @@ require 'puppet_library/http/cache/in_memory'
 module PuppetLibrary::Http
     module Cache
         class NoOp
-            def get(path)
+            def get(path = "entry")
                 yield
             end
+
+            def clear
+            end
         end
     end
 end

data/lib/puppet_library/puppet_library.rb

@@ -15,6 +15,7 @@
 # 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 'optparse'
 require 'rack'
 require 'yaml'
 require 'puppet_library/forge/directory'
@@ -103,10 +104,9 @@ module PuppetLibrary
             load_defaults!(options)
             process_options!(options)
 
-            Server.configure do |server|
+            Server.configure do
                 options[:forges].each do |(forge_type, config)|
-                    subforge = forge_type.new(*config)
-                    server.forge subforge
+                    forge forge_type.new(*config)
                 end
             end
         end
@@ -161,11 +161,14 @@ module PuppetLibrary
 
         def process_options!(options)
             options[:forges].map! do |(forge_type, config)|
-                if forge_type == Forge::Proxy
-                end
-                if forge_type == Forge::Proxy && options[:cache_basedir]
+                if [ Forge::Directory, Forge::Source ].include? forge_type
+                    [ forge_type, [ Dir.new(sanitize_path(config)) ]]
+                elsif forge_type == Forge::Proxy && options[:cache_basedir]
                     cache_dir = File.join(options[:cache_basedir], url_hostname(config))
-                    [ Forge::Cache, [ config, sanitize_path(cache_dir) ] ]
+                    path = sanitize_path(cache_dir)
+                    FileUtils.mkdir_p path
+                    dir = Dir.new(path)
+                    [ Forge::Cache, [ config, dir ] ]
                 else
                     [ forge_type, config ]
                 end

data/lib/puppet_library/puppet_module/modulefile.rb

@@ -33,7 +33,7 @@ module PuppetLibrary::PuppetModule
                 end
 
                 def get_#{property}
-                    @#{property}
+                    @#{property} || ""
                 end
             EOF
         end
@@ -58,8 +58,12 @@ module PuppetLibrary::PuppetModule
             {
                 "name" => get_name,
                 "version" => get_version,
+                "source" => get_source,
                 "author" => get_author,
+                "license" => get_license,
+                "summary" => get_summary,
                 "description" => get_description,
+                "project_page" => get_project_page,
                 "dependencies" => get_dependencies
             }
         end

data/lib/puppet_library/server.rb

@@ -17,8 +17,10 @@
 
 require 'sinatra/base'
 require 'haml'
+require 'docile'
 
 require 'puppet_library/forge/multi'
+require 'puppet_library/util/patches'
 
 module PuppetLibrary
     # The Puppet Library server
@@ -41,28 +43,26 @@ module PuppetLibrary
             end
 
             def forge(forge, &block)
-                if forge.is_a? Class
-                    @forge.add_forge forge.configure(&block)
+                if forge.is_a? Symbol
+                    class_name = forge.to_s.snake_case_to_camel_case
+                    forge_type = Forge.module_eval(class_name)
+                    @forge.add_forge forge_type.configure(&block)
                 else
                     @forge.add_forge forge
                 end
             end
         end
 
-        def self.set_up(&config_block)
-            puts "PuppetLibrary::Server::set_up deprecated: use #configure instead"
-            self.configure(&config_block)
-        end
-
-        def self.configure
+        def self.configure(&block)
             forge = Forge::Multi.new
-            yield(Config.new(forge))
+            Docile.dsl_eval(Config.new(forge), &block)
             Server.new(forge)
         end
 
         def initialize(forge)
             super(nil)
             @forge = forge
+            @forge.prime
         end
 
         configure do
@@ -137,6 +137,10 @@ module PuppetLibrary
             end
         end
 
+        post "/api/forge/clear-cache" do
+            @forge.clear_cache
+        end
+
         private
         def download(buffer)
             if buffer.respond_to?(:size)

data/lib/puppet_library/util.rb

@@ -19,5 +19,6 @@ module PuppetLibrary::Util
 end
 
 require 'puppet_library/util/git'
+require 'puppet_library/util/logging'
 require 'puppet_library/util/patches'
 require 'puppet_library/util/temp_dir'

data/lib/puppet_library/util/config_api.rb

@@ -0,0 +1,115 @@
+# -*- encoding: utf-8 -*-
+# Puppet Library
+# Copyright (C) 2014 drrb
+#
+# 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 'docile'
+
+module PuppetLibrary::Util
+    class ConfigApi
+        def self.for(owner, &block)
+            Docile.dsl_eval(ConfigApi.new(owner), &block)
+        end
+
+        def initialize(owner)
+            @owner = owner
+            @params = []
+        end
+
+        def configure(&block)
+            config_api = config_class.new
+            Docile.dsl_eval(config_api, &block)
+            config_api.validate!
+            config_api
+        end
+
+        def required(name, description, &process)
+            param(name, description, true, process)
+        end
+
+        def param(name, description, required, process)
+            @params << Param.new(name, description, required, process)
+        end
+
+        private
+        def config_class
+            class_name = "#{@owner.to_s.split('::').last}Config"
+            if PuppetLibrary.const_defined?(class_name.intern)
+                PuppetLibrary.const_get(class_name)
+            else
+                define_config_class(class_name)
+            end
+        end
+
+        def define_config_class(class_name)
+            params = @params
+            config_class = Class.new(Config) do
+                define_method(:params) { params }
+                params.each do |param|
+                    define_method(param.name.to_sym) do |new_value|
+                        set(param, new_value)
+                    end
+
+                    define_method("get_#{param.name}".to_sym) do
+                        get(param)
+                    end
+                end
+            end
+            PuppetLibrary.const_set(class_name, config_class)
+        end
+
+        class Config
+            def initialize
+                @values = {}
+            end
+
+            def validate!
+                missing_params = params.select { |param| param.required? && @values[param].nil? }
+                unless missing_params.empty?
+                    param = missing_params.first
+                    raise "Config parameter '#{param.name}' is required (expected #{param.description}), but wasn't specified"
+                end
+            end
+
+            def get(param)
+                @values[param]
+            end
+
+            def set(param, new_value)
+                @values[param] = param.process(new_value)
+            rescue => validation_error
+                raise "Invalid value for config parameter '#{param.name}': #{validation_error.message} (was expecting #{param.description})"
+            end
+        end
+
+        class Param
+            attr_reader :name, :description
+
+            def initialize(name, description, required, process)
+                @name, @description, @required = name, description, required
+                do_nothing = lambda { |x| x }
+                @process = process || do_nothing
+            end
+
+            def required?
+                @required
+            end
+
+            def process(value)
+                @process.nil? || @process.call(value)
+            end
+        end
+    end
+end