private-gem-server 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8eb42e9887adca8308761d745ca5e321a10ff98c
+  data.tar.gz: 0107f405a92edf81010969e4f9204da0577c2d1b
+SHA512:
+  metadata.gz: 7eee56925860a2eadfdd5dde4d89deb3b30ce9ca5f8b13ffe422de6a21fbc4291dd587697915d606c48a2d5dba598f8beb688cd70e99ab71939980ea7d0328c6
+  data.tar.gz: 15349afaf202a32b69d9ad6351298d3b95e5e53a9cf9a3641d1ab967fc07023e7d10c7d7b5c801e12caaacbdc9495d3283ddeae2dcb1963fd28d6a6ee53a4fcf

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Neil E. Pearson
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# Private Gem Server
+
+This gem provides a [Gem in a Box](https://github.com/geminabox/geminabox) implementation that pulls gems from git sources, and builds them, whenever a client requests a list of gems.
+
+## Installation
+
+    gem install private-gem-server
+    
+## Usage
+
+The gem comes with the `private-gem-server` executable, which wraps the `thin` executable. It takes exactly the same command-line arguments as the [Thin web server](http://code.macournoyer.com/thin/). Run `thin -h` to see them.
+
+    sudo private-gem-server -p 80 start
+    
+## Configuration
+
+Customize this gem using environment variables:
+
+#### GEM_STORE
+
+The directory in which gems (and other working files) should be stored.
+
+#### GEM_SERVER_LOG
+
+Path of a log file to which the server should write.
+
+#### GEM_SOURCES
+
+Path of a YAML file containing a list of gems to be served.
+
+## Sources
+
+Here's an example sources file:
+
+```yaml
+keys:
+  my_private_key: |
+    -----BEGIN RSA PRIVATE KEY-----
+    MIIEpAIBAAKCAQEA1Wdr4g6o62CwrNFcyVc4dQi3mrQbffhceXHD6NtnfjtrFZ7K
+    XKNh33X1c42D/THIS/WOULD/BE/MUCH/LONGER/IF/IT/WERE/REAL/dynzKCoLb
+    JwyMC+KerlXfxDSCWzE6z7bcA38dXn3hwnbokowZro40mo/NTwqY6Q==
+    -----END RSA PRIVATE KEY-----
+    
+gems:
+  "secret-component":
+    type: git
+    url: git@github.com:hx/secret-component
+    key: my_private_key
+  
+  "very-secret-component":
+    type: git
+    url: git@github.com:hx/very-secret-component
+    key: my_private_key
+```
+
+For now, `git` is the only supported source. Others will come.
+
+## Notes
+
+- This is a premature gem with no test coverage. Don't use it.

data/lib/private-gem-server.rb

@@ -0,0 +1 @@
+require_relative 'private_gem_server'

data/lib/private_gem_server/sanity.rb

@@ -0,0 +1,46 @@
+require 'pathname'
+
+module PrivateGemServer
+  module Sanity
+    def self.check!
+
+      # Make sure we have a valid config file
+      begin
+        config = YAML.load_file ENV['GEM_SOURCES']
+      rescue
+        fail! 'Please supply a path to your gem sources YAML file in the GEM_SOURCES environment variable.'
+      end
+
+      # Make sure config has a hash of gems
+      fail! 'Config file includes no gems' unless Hash === config && Hash === config['gems'] && !config['gems'].empty?
+
+      # Make sure we can write to our working dir
+      store = ENV['GEM_STORE']
+      fail! 'Please set GEM_STORE to a readable/writable directory' unless store &&
+          File.directory?(store) &&
+          File.readable?(store) &&
+          File.writable?(store) &&
+          File.executable?(store)
+
+      # Make sure the log is writable
+      log_path = ENV['GEM_SERVER_LOG']
+      if log_path
+        log_path = Pathname(log_path)
+        if log_path.exist?
+          fail! "Server log (#{log_path}) is not writable" unless log_path.writable?
+        else
+          log_path.parent.mkpath rescue fail! "Cannot create server log directory (#{log_path.parent})"
+          log_path.write '' rescue fail! "Cannot create server log (#{log_path})"
+        end
+      end
+
+    end
+
+    private
+
+    def self.fail!(reason)
+      STDERR << reason << "\n"
+      exit 1
+    end
+  end
+end

data/lib/private_gem_server/scanner.rb

@@ -0,0 +1,21 @@
+module PrivateGemServer
+  class Scanner
+
+    def initialize(app, sources_path, temp_path)
+      @app = app
+      @sources = Sources.new YAML.load_file(sources_path), temp_path
+    end
+
+    def call(env)
+      scan! if env['REQUEST_METHOD'] == 'GET' && env['PATH_INFO'] !~ %r{^/gems/}
+      @app.call env
+    end
+
+    def scan!
+      @sources.values.map do |source|
+        Thread.new { source.refresh! }.tap { |thread| thread.abort_on_exception = true }
+      end.each(&:join)
+    end
+
+  end
+end

data/lib/private_gem_server/server.rb

@@ -0,0 +1,7 @@
+require 'geminabox'
+
+module PrivateGemServer
+  class Server < Geminabox::Server
+
+  end
+end

data/lib/private_gem_server/source/git.rb

@@ -0,0 +1,101 @@
+require 'fileutils'
+require 'shellwords'
+
+module PrivateGemServer
+  class Source
+    class Git < self
+
+      DEBOUNCE = 10 # Minimum number of seconds between refreshes
+
+      def refresh!
+        return if @last_refresh && (Time.now - @last_refresh) < DEBOUNCE
+        prepare_git_files!
+        check_out_or_fetch!
+        find_new_versions!
+        @last_refresh = Time.now
+      end
+
+      private
+
+      def check_out_or_fetch!
+        if repo_path.join('.git').exist?
+          git 'git fetch', cwd: repo_path
+        else
+          repo_path.mkpath
+          git "git clone #{e url} #{e repo_path}"
+        end
+      end
+
+      def key
+        @key ||= @sources.keys[@properties['key']]
+      end
+
+      def url
+        @url ||= @properties['url']
+      end
+
+      def temp_path
+        @temp_path ||= @sources.temp_path + 'git' + name
+      end
+
+      def repo_path
+        @repo_path = temp_path + 'repo'
+      end
+
+      def git(cmd, **opts)
+        (opts[:env] = (opts[:env] || {}).dup)['GIT_SSH'] = git_ssh_path
+        opts[:output] ||= logger
+        opts[:error] ||= logger
+        run!(cmd, **opts) == 0
+      end
+
+      def ssh_template
+        "#!/bin/bash\n" <<
+        'ssh -oStrictHostKeyChecking=no -i %s "$@"'
+      end
+
+      def prepare_git_files!
+        unless git_key_path.exist?
+          git_key_path.parent.mkpath
+          git_key_path.binwrite key
+          git_key_path.chmod 0400
+        end
+        unless git_ssh_path.exist?
+          git_ssh_path.parent.mkpath
+          git_ssh_path.write ssh_template % e(git_key_path)
+          git_ssh_path.chmod 0700
+        end
+      end
+
+      def git_key_path
+        @git_key_path ||= temp_path + 'git.key'
+      end
+
+      def git_ssh_path
+        @git_ssh_path ||= temp_path + 'git_ssh'
+      end
+
+      def find_new_versions!
+        available_versions.each do |version|
+          build_version! version unless PrivateGemServer.has name, version[/\d.*/]
+        end
+      end
+
+      def available_versions
+        list = ''
+        run! 'git tag -l', cwd: repo_path, output: list, error: logger
+        list.split("\n").select { |tag| tag =~ /^v?\d+(\.\d+)*$/ }
+      end
+
+      def build_version!(version)
+        run! "git checkout tags/#{e version} && gem build #{e name}.gemspec", cwd: repo_path, output: logger, error: logger
+        PrivateGemServer.add "#{repo_path}/#{name}-#{version[/\d.*/]}.gem"
+      end
+
+      def e(arg)
+        Shellwords.escape arg
+      end
+
+    end
+  end
+end

data/lib/private_gem_server/source.rb

@@ -0,0 +1,60 @@
+require 'open3'
+require 'shellwords'
+
+require_relative 'source/git'
+
+module PrivateGemServer
+  class Source
+
+    SUBCLASSES = {
+        git: Git
+    }
+
+    attr_reader :name
+
+    def self.create(name, properties, sources)
+      SUBCLASSES[properties['type'].to_sym].new name, properties, sources
+    end
+
+    def initialize(name, properties, sources)
+      @name = name
+      @properties = properties
+      @sources = sources
+    end
+
+    def refresh!
+      raise 'Not implemented'
+    end
+
+    protected
+
+    def logger
+      PrivateGemServer.logger
+    end
+
+    def run!(path, args: [], env: {}, cwd: nil, input: nil, output: nil, error: nil)
+      cmd = ([path] + args.map { |arg| e arg }).join ' '
+      opts = {}
+      opts[:chdir] = cwd.to_s if cwd
+      env = env.map { |k, v| [k.to_s, v.to_s] }.to_h
+      msg = env.map { |k, v| "#{e k}=#{e v}" }
+      msg << "cd #{e cwd};" if cwd
+      msg << cmd
+      logger.debug msg.join(' ')
+      Open3.popen3 env, cmd, opts do |i, o, e, t|
+        i << input if input; i.close
+        {o => output, e => error}.each do |source, target|
+          result = source.read
+          target << result if target
+          source.close
+        end
+        t.value.exitstatus
+      end
+    end
+
+    def e(text)
+      Shellwords.escape text
+    end
+
+  end
+end

data/lib/private_gem_server/sources.rb

@@ -0,0 +1,17 @@
+require_relative 'source'
+require 'pathname'
+
+module PrivateGemServer
+  class Sources < Hash
+
+    attr_reader :keys
+    attr_reader :temp_path
+
+    def initialize(config, temp_path)
+      @keys = config['keys'] || {}
+      @temp_path = Pathname(temp_path).tap(&:mkpath).realpath
+      merge! (config['gems'] || {}).map { |k, v| [k, Source.create(k, v, self)] }.to_h
+    end
+
+  end
+end

data/lib/private_gem_server/version.rb

@@ -0,0 +1,3 @@
+module PrivateGemServer
+  VERSION = '0.1.0'
+end

data/lib/private_gem_server.rb

@@ -0,0 +1,34 @@
+require 'logger'
+
+require_relative 'private_gem_server/version'
+require_relative 'private_gem_server/server'
+require_relative 'private_gem_server/scanner'
+require_relative 'private_gem_server/sources'
+require_relative 'private_gem_server/sanity'
+
+module PrivateGemServer
+
+  class << self
+
+    attr_writer :logger
+
+    def has(name, version)
+      gem = gems[name]
+      gem.include? version if gem
+    end
+
+    def add(file)
+      @gems = nil
+      Geminabox::GemStore.create Geminabox::IncomingGem.new File.open(file, 'rb')
+    end
+
+    def gems
+      @gems ||= Dir["#{Geminabox.data}/gems/*.gem"].group_by { |x| x[%r{(\w+(-\D\w*)*)[^/]+$}, 1] }.map { |k, v| [k, v.map { |z| z[/(\d+[\.\d+]*)\.gem$/, 1] }] }.to_h
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT)
+    end
+
+  end
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: private-gem-server
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Neil E. Pearson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: thin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: geminabox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Serve private gems for deployment in cloud environments.
+email:
+- neil@helium.net.au
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/private-gem-server.rb
+- lib/private_gem_server.rb
+- lib/private_gem_server/sanity.rb
+- lib/private_gem_server/scanner.rb
+- lib/private_gem_server/server.rb
+- lib/private_gem_server/source.rb
+- lib/private_gem_server/source/git.rb
+- lib/private_gem_server/sources.rb
+- lib/private_gem_server/version.rb
+homepage: https://github.com/hx/private-gem-server
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Private Gem Server base on Geminabox
+test_files: []
+has_rdoc: