puppet-forge-server 1.8.0 → 1.9.0

data/lib/puppet_forge_server/utils/option_parser.rb

@@ -28,9 +28,23 @@ module PuppetForgeServer::Utils
     @@DEFAULT_LOG_DIR = File.join(Dir.tmpdir.to_s, 'puppet-forge-server', 'log')
     @@DEFAULT_WEBUI_ROOT = File.expand_path('../app', File.dirname(__FILE__))
     @@DEFAULT_HOST = '0.0.0.0'
+    @@DEFAULT_RAM_CACHE_TTL = 60 * 30 # 30min
+    @@DEFAULT_RAM_CACHE_SIZE = 250
+
+    def self.DEFAULT_OPTIONS
+      {
+        :daemonize      => @@DEFAULT_DAEMONIZE,
+        :cache_basedir  => @@DEFAULT_CACHE_DIR,
+        :port           => @@DEFAULT_PORT,
+        :webui_root     => @@DEFAULT_WEBUI_ROOT,
+        :host           => @@DEFAULT_HOST,
+        :ram_cache_ttl  => @@DEFAULT_RAM_CACHE_TTL,
+        :ram_cache_size => @@DEFAULT_RAM_CACHE_SIZE
+      }
+    end
 
     def parse_options(args)
-      options = {:daemonize => @@DEFAULT_DAEMONIZE, :cache_basedir => @@DEFAULT_CACHE_DIR, :port => @@DEFAULT_PORT, :webui_root => @@DEFAULT_WEBUI_ROOT, :host => @@DEFAULT_HOST}
+      options = PuppetForgeServer::Utils::OptionParser.DEFAULT_OPTIONS
       option_parser = ::OptionParser.new do |opts|
         opts.banner = "Usage: #{File.basename $0} [options]"
         opts.version = PuppetForgeServer::VERSION
@@ -63,6 +77,14 @@ module PuppetForgeServer::Utils
           options[:cache_basedir] = cache_basedir
         end
 
+        opts.on('--ram-cache-ttl SECONDS', "The time to live in seconds for remote requests RAM cache (default: #{@@DEFAULT_RAM_CACHE_TTL})") do |ram_cache_ttl|
+          options[:ram_cache_ttl] = ram_cache_ttl
+        end
+
+        opts.on('--ram-cache-size ENTRIES', "The maximum number of enties in RAM cache for remote requests (default: #{@@DEFAULT_RAM_CACHE_SIZE})") do |ram_cache_size|
+          options[:ram_cache_size] = ram_cache_size
+        end
+
         opts.on('--log-dir DIR', "Log directory (default: #{@@DEFAULT_LOG_DIR})") do |log_dir|
           options[:log_dir] = log_dir
         end

data/lib/puppet_forge_server/version.rb

@@ -15,5 +15,5 @@
 # limitations under the License.
 
 module PuppetForgeServer
-    VERSION = '1.8.0'
+    VERSION = '1.9.0'
 end

data/puppet-forge-server.gemspec

@@ -44,10 +44,18 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'haml', '~> 4.0'
   spec.add_dependency 'deep_merge', '~> 1.0'
   spec.add_dependency 'multipart-post', '~> 2.0.0'
+  spec.add_dependency 'redcarpet', '~> 3.3.0'
+  spec.add_dependency 'lrucache', '~> 0.1.4'
+  spec.add_dependency 'iconv', '~> 1.0.4'
+  spec.add_dependency 'logger-colors', '~> 1.0'
 
   spec.add_development_dependency 'rake', '~> 10.3'
   spec.add_development_dependency 'rspec', '~> 3.1'
   spec.add_development_dependency 'rspec-core', '~> 3.1'
+  spec.add_development_dependency 'simplecov', '~> 0.11.0'
+  spec.add_development_dependency 'rspec-stopwatch', '~> 0.1.3'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug' if RUBY_VERSION > '2.0.0'
 
   spec.required_ruby_version = '>= 1.9.3'
 end

data/spec/spec_helper.rb

@@ -16,6 +16,7 @@
 
 require 'rack/test'
 require 'rspec'
+require 'rspec/stopwatch'
 require 'puppet_forge_server'
 
 ENV['RACK_ENV'] = 'test'
@@ -23,8 +24,47 @@ ENV['RACK_ENV'] = 'test'
 module RSpecMixin
   include Rack::Test::Methods
 end
+begin
+  gem 'simplecov'
+  require 'simplecov'
+  formatters = []
+  formatters << SimpleCov::Formatter::HTMLFormatter
+
+  begin
+    gem 'coveralls'
+    require 'coveralls'
+    formatters << Coveralls::SimpleCov::Formatter if ENV['TRAVIS']
+  rescue Gem::LoadError
+    # do nothing
+  end
+
+  begin
+    gem 'codeclimate-test-reporter'
+    require 'codeclimate-test-reporter'
+    formatters << CodeClimate::TestReporter::Formatter if (ENV['TRAVIS'] and ENV['CODECLIMATE_REPO_TOKEN'])
+  rescue Gem::LoadError
+    # do nothing
+  end
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter.new(*formatters)
+  SimpleCov.start do
+    add_filter "/spec/"
+    add_filter "/.vendor/"
+    add_filter "/vendor/"
+    add_filter "/gems/"
+    refuse_coverage_drop
+  end
+rescue Gem::LoadError
+  # do nothing
+end
+
+begin
+  gem 'pry'
+  require 'pry'
+rescue Gem::LoadError
+  # do nothing
+end
 
 RSpec.configure do |c|
   c.include RSpecMixin
   c.add_formatter(:documentation)
-end
+end

data/spec/unit/http/http_client_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+require 'puppet_forge_server'
+
+describe PuppetForgeServer::Http::HttpClient do
+  # Finding a free port to host mock server
+  let(:port) do
+    require 'socket'
+    server = TCPServer.new('127.0.0.1', 0)
+    port = server.addr[1]
+    server.close
+    port
+  end
+  let(:uri) { "http://localhost:#{port}/" }
+  before(:each) do
+    # Staring a mock server on free port to test network fetching performence
+    @server = TCPServer.new('localhost', port)
+    @thr = Thread.new do
+      loop do
+        socket = @server.accept
+        response = "Hello!"
+        socket.print "HTTP/1.1 200 OK\r\n" +
+                     "Content-Type: text/plain\r\n" +
+                     "Content-Length: #{response.bytesize}\r\n" +
+                     "Connection: close\r\n"
+        socket.print "\r\n"
+        # To simulate network lag
+        sleep 0.01
+        socket.print response
+        socket.close
+      end
+    end
+    @original_level = PuppetForgeServer::Logger.get.level.first
+    PuppetForgeServer::Logger.get.level = Logger::WARN
+  end
+  after(:each) do
+    @server.close
+    @thr.kill
+    PuppetForgeServer::Logger.get.level = @original_level
+  end
+  let(:instance) { described_class.new(cache) }
+  describe '#download' do
+    let(:load) do
+      Proc.new do
+        # To simulate multiple fetches
+        99.times { instance.download(uri) }
+        instance.download(uri)
+      end
+    end
+    subject do
+      load.call
+    end
+    context 'with 1sec LRU cache' do
+      let(:cache) do
+        require 'lrucache'
+        LRUCache.new(:ttl => 1)
+      end
+      it { expect { load.call }.to run_for < 0.01 }
+      it { expect(subject).not_to be_nil }
+      it { expect(subject).not_to be_closed }
+    end
+    context 'with default cache' do
+      let(:cache) { nil }
+      it { expect { load.call }.to run_for < 0.01 }
+      it { expect(subject).not_to be_nil }
+      it { expect(subject).not_to be_closed }
+    end
+  end
+  describe '#get' do
+    let(:load) do
+      Proc.new do
+        # To simulate multiple fetches
+        99.times { instance.get(uri) }
+        instance.get(uri)
+      end
+    end
+    subject do
+      load.call
+    end
+    context 'with 1sec LRU cache' do
+      let(:cache) do
+        require 'lrucache'
+        LRUCache.new(:ttl => 1)
+      end
+      it { expect(subject).to eq('Hello!') }
+      it { expect { load.call }.to run_for < 0.01 }
+    end
+    context 'with default cache' do
+      let(:cache) { nil }
+      it { expect(subject).to eq('Hello!') }
+      it { expect { load.call }.to run_for < 0.01 }
+    end
+  end
+end

data/spec/unit/utils/encoding_spec.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe 'PuppetForgeServer::Utils::Encoding' do
+  let(:dummy_class) { Class.new { include PuppetForgeServer::Utils::Encoding } }
+  let(:dummy) { dummy_class.new }
+  describe '#to_utf8' do
+    subject { dummy.to_utf8(input_text) }
+    context 'for nil' do
+      let(:input_text) { nil }
+      it { expect(subject).to be_nil }
+    end
+
+    context 'for valid ascii text' do
+      let(:input_text) { 'a simple ascii text!' }
+      it { expect(subject).to eq('a simple ascii text!') }
+    end
+
+    context 'for valid utf-8 text' do
+      let(:input_text) { 'Zażółć gęślą jażń' }
+      it { expect(subject).to eq('Zażółć gęślą jażń') }
+    end
+
+    context 'for text with ISO-8859-1 encoded as UTF-8' do
+      let(:input_text) { "Co\xE2te d'Azur" }
+      it { expect(subject).to eq('Cote d\'Azur') }
+    end
+
+    context 'for text with UTF-8 not replaced characters' do
+      let(:multidot) { [0xE2, 0x80, 0xA6].pack("c*") }
+      let(:input_text) { "Read more#{multidot}" }
+      it { expect(subject).to eq('Read more…') }
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: puppet-forge-server
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Ilja Bobkevic
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-02 00:00:00.000000000 Z
+date: 2016-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -150,6 +150,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: lrucache
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.4
+- !ruby/object:Gem::Dependency
+  name: iconv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+- !ruby/object:Gem::Dependency
+  name: logger-colors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -192,6 +248,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+- !ruby/object:Gem::Dependency
+  name: rspec-stopwatch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Private Puppet forge server supports local files, both v1 and v3 API
   proxies
 email: ilja.bobkevic@unibet.com
@@ -201,6 +299,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -222,6 +321,7 @@ files:
 - lib/puppet_forge_server/app/version3.rb
 - lib/puppet_forge_server/app/views/index.haml
 - lib/puppet_forge_server/app/views/layout.haml
+- lib/puppet_forge_server/app/views/module.haml
 - lib/puppet_forge_server/app/views/modules.haml
 - lib/puppet_forge_server/app/views/upload.haml
 - lib/puppet_forge_server/backends/directory.rb
@@ -239,7 +339,11 @@ files:
 - lib/puppet_forge_server/server.rb
 - lib/puppet_forge_server/utils/archiver.rb
 - lib/puppet_forge_server/utils/buffer.rb
+- lib/puppet_forge_server/utils/cache_provider.rb
+- lib/puppet_forge_server/utils/encoding.rb
+- lib/puppet_forge_server/utils/filtering_inspecter.rb
 - lib/puppet_forge_server/utils/http.rb
+- lib/puppet_forge_server/utils/md_renderer.rb
 - lib/puppet_forge_server/utils/option_parser.rb
 - lib/puppet_forge_server/version.rb
 - puppet-forge-server.gemspec
@@ -247,10 +351,12 @@ files:
 - spec/unit/app/version1_spec.rb
 - spec/unit/app/version2_spec.rb
 - spec/unit/backends/directory_spec.rb
+- spec/unit/http/http_client_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/models/dependency_spec.rb
 - spec/unit/models/metadata_spec.rb
 - spec/unit/server_spec.rb
+- spec/unit/utils/encoding_spec.rb
 homepage: https://github.com/unibet/puppet-forge-server
 licenses:
 - Apache 2
@@ -280,7 +386,9 @@ test_files:
 - spec/unit/app/version1_spec.rb
 - spec/unit/app/version2_spec.rb
 - spec/unit/backends/directory_spec.rb
+- spec/unit/http/http_client_spec.rb
 - spec/unit/logger_spec.rb
 - spec/unit/models/dependency_spec.rb
 - spec/unit/models/metadata_spec.rb
 - spec/unit/server_spec.rb
+- spec/unit/utils/encoding_spec.rb