gemstash 1.0.0.pre.1-java → 2.5.0-java

data/docs/reference.md

@@ -1,308 +0,0 @@
-
-Table of Contents
-=================
-
-  * [Reference](#reference)
-    * [Configuration](#configuration)
-      * [:base_path](#base_path)
-      * [:cache_type](#cache_type)
-      * [:memcached_servers](#memcached_servers)
-      * [:db_adapter](#db_adapter)
-      * [:db_url](#db_url)
-      * [:rubygems_url](#rubygems_url)
-      * [:bind](#bind)
-    * [Authorize](#authorize)
-      * [Usage](#usage)
-      * [Arguments](#arguments)
-      * [Options](#options)
-        * [--config-file](#--config-file)
-        * [--key](#--key)
-        * [--remove](#--remove)
-    * [Start](#start)
-      * [Usage](#usage-1)
-      * [Options](#options-1)
-        * [--config-file](#--config-file-1)
-        * [--no-daemonize](#--no-daemonize)
-    * [Stop](#stop)
-      * [Usage](#usage-2)
-      * [Options](#options-2)
-        * [--config-file](#--config-file-2)
-    * [Status](#status)
-      * [Usage](#usage-3)
-      * [Options](#options-3)
-        * [--config-file](#--config-file-3)
-    * [Setup](#setup)
-      * [Usage](#usage-4)
-      * [Options](#options-4)
-        * [--redo](#--redo)
-        * [--debug](#--debug)
-        * [--config-file](#--config-file-4)
-
-
-
----
-
-# Reference
-
-## Configuration
-
-**Example:**
-```yaml
-# ~/.gemstash/config.yml
----
-:base_path: "/var/gemstash"
-:cache_type: memcached
-:memcached_servers: localhost:11211
-:db_adapter: postgres
-:db_url: postgres:///gemstash
-:rubygems_url: https://my.gem-source.local
-:bind: tcp://0.0.0.0:4242
-```
-
-### :base_path
-
-**Default value:** `~/.gemstash`
-
-**Valid values:** Any valid path
-
-**Description**<br />
-Specifies where to store local files like the server log, cached gem files, and
-the database (when using SQLite). If the default is being used, the directory
-will be created if it does not exist. Any other directory needs to be created
-ahead of time and be writable to the Gemstash server process. Specifying the
-`:base_path` via [`gemstash setup`](reference.md#setup) will create the
-directory for you.
-
-### :cache_type
-
-**Default value:** `memory`
-
-**Valid values:** `memory`, `memcached`
-
-**Description**<br />
-Specifies how to cache values other than gem files (such as gem dependencies).
-`memory` will use an in memory cache while `memcached` will point to 1 or more
-Memcached servers. Use the `:memcached_servers` configuration key for specifying
-where the Memcached server(s) are.
-
-### :memcached_servers
-
-**Default value:** `localhost:11211`
-
-**Valid values:** A comma delimited list of Memcached servers
-
-**Description**<br />
-Specifies the Memcached servers to connect to when using `memcached` for the
-`:cache_type`. Only used when `memcached` is used for `:cache_type`.
-
-### :db_adapter
-
-**Default value:** `sqlite3`
-
-**Valid values:** `sqlite3`, `postgres`
-
-**Description**<br />
-Specifies what database adapter to use. When `sqlite3` is used, the database
-will be located at `gemstash.db` within the directory specified by `:base_path`.
-The database will automatically be created when using `sqlite3`. When `postgres`
-is used, the database to connect to must be specified in the `:db_url`
-configuration key. The database must already be created when using `postgres`.
-
-### :db_url
-
-**Default value:** None
-
-**Valid values:** A valid database URL for the [Sequel
-gem](http://sequel.jeremyevans.net/)
-
-**Description**<br />
-Specifies the database to connect to when using `postgres` for the
-`:db_adapter`. Only used when `postgres` is used for `:db_adapter`.
-
-### :rubygems_url
-
-**Default value:** `https://www.rubygems.org`
-
-**Valid values:** A valid gem source URL
-
-**Description**<br />
-Specifies the default gem source URL. When any API endpoint is called without a
-`/private` or `/upstream/<url>` prefix, this URL will be used to fetch the
-result. This value can be safely changed even if there are already gems stashed
-for the previous value.
-
-### :bind
-
-**Default value:** `tcp://0.0.0.0:9292`
-
-**Valid values:** Any valid binding that [is supported by
-Puma](https://github.com/puma/puma#binding-tcp--sockets)
-
-**Description**<br />
-Specifies the binding used to start the Gemstash server. Keep in mind the user
-starting Gemstash needs to have access to bind in this manner. For example, if
-you use a port below 1024, you will need to run Gemstash as the root user.
-
-## Authorize
-
-Adds or removes authorization to interact with privately stored gems.
-
-### Usage
-
-```
-gemstash authorize
-gemstash authorize push yank
-gemstash authorize yank unyank --key <secure-key>
-gemstash authorize --remove --key <secure-key>
-```
-
-### Arguments
-
-Any arguments will be used as specific permissions. Valid permissions include
-`push`, `yank`, and `unyank`. If no permissions are provided, then all
-permissions will be granted (including any that may be added in future versions
-of Gemstash).
-
-### Options
-
-#### --config-file
-
-**Usage:** `--config-file <file>`
-
-**Description**<br />
-Specify the config file to use. If you aren't using the default config file at
-`~/.gemstash/config.yml`, then you must specify the config file via this option.
-
-#### --key
-
-**Usage:** `--key <secure-key>`
-
-**Description**<br />
-Specify the API key to affect. This should be the actual key value, not a name.
-This option is required when using `--remove` but is optional otherwise. If
-adding an authorization, using this will either create or update the permissions
-for the specified API key. If missing, a new API key will always be generated.
-
-#### --remove
-
-**Usage:** `--remove`
-
-**Description**<br />
-Remove an authorization rather than add or update one. When removing, permission
-values are not allowed. The `--key <secure-key>` option is required.
-
-## Start
-
-Starts the Gemstash server.
-
-### Usage
-
-```
-gemstash start
-gemstash start --no-daemonize
-```
-
-### Options
-
-#### --config-file
-
-**Usage:** `--config-file <file>`
-
-**Description**<br />
-Specify the config file to use. If you aren't using the default config file at
-`~/.gemstash/config.yml`, then you must specify the config file via this option.
-
-#### --no-daemonize
-
-**Usage:** `--no-daemonize`
-
-**Description**<br />
-The Gemstash server daemonizes itself by default. Provide this option to instead
-run the server until `Ctrl-C` is typed. When not daemonized, the log will be
-output to standard out.
-
-## Stop
-
-Stops the Gemstash server.
-
-### Usage
-
-```
-gemstash stop
-```
-
-### Options
-
-#### --config-file
-
-**Usage:** `--config-file <file>`
-
-**Description**<br />
-Specify the config file to use. If you aren't using the default config file at
-`~/.gemstash/config.yml`, then you must specify the config file via this option.
-
-## Status
-
-Checks status of the Gemstash server.
-
-### Usage
-
-```
-gemstash status
-```
-
-### Options
-
-#### --config-file
-
-**Usage:** `--config-file <file>`
-
-**Description**<br />
-Specify the config file to use. If you aren't using the default config file at
-`~/.gemstash/config.yml`, then you must specify the config file via this option.
-
-## Setup
-
-Customize your Gemstash configuration interactively. This will save your config
-file, but only if a few checks pass after you've provided your answers.
-
-### Usage
-
-```
-gemstash setup
-gemstash setup --redo
-gemstash setup --config-file <file>
-```
-
-### Options
-
-#### --redo
-
-**Usage:** `--redo`
-
-**Description**<br />
-Redo the configuration. This does nothing the first time `gemstash setup` is
-run. If you want to change your configuration using `gemstash setup` after
-you've run it before, you must provide this option, otherwise Gemstash will
-simply indicate your setup is complete.
-
-#### --debug
-
-**Usage:** `--debug`
-
-**Description**<br />
-Output additional information if one of the checks at the end of setup fails.
-This will do nothing if all checks pass.
-
-#### --config-file
-
-**Usage:** `--config-file <file>`
-
-**Description**<br />
-Specify the config file to write to. Without this option, your configuration
-will be written to `~/.gemstash/config.yml`. If you write to a custom location,
-you will need to pass the `--config-file` option to all Gemstash commands.
-
----
-
-Table of contents thanks to [gh-md-toc](https://github.com/ekalinin/github-markdown-toc).

data/gemstash.gemspec

@@ -1,47 +0,0 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "gemstash/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "gemstash"
-  spec.version       = Gemstash::VERSION
-  spec.authors       = ["Andre Arko"]
-  spec.email         = ["andre@arko.net"]
-  spec.platform      = "java" if RUBY_PLATFORM == "java"
-
-  spec.summary       = "A place to stash gems you'll need"
-  spec.description   = "Gemstash acts as a local RubyGems server, caching \
-copies of gems from RubyGems.org automatically, and eventually letting \
-you push your own private gems as well."
-  spec.homepage      = "https://github.com/bundler/gemstash"
-  spec.license       = "MIT"
-
-  spec.files         = `git ls-files -z`.split("\x0").reject {|f|
-    f.match(%r{^(test|spec|features)/})
-  }
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_runtime_dependency "dalli", "~> 2.7"
-  spec.add_runtime_dependency "lru_redux", "~> 1.1"
-  spec.add_runtime_dependency "puma", "~> 2.14"
-  spec.add_runtime_dependency "sequel", "~> 4.26"
-  spec.add_runtime_dependency "sinatra", "~> 1.4"
-  spec.add_runtime_dependency "thor", "~> 0.19"
-  spec.add_runtime_dependency "faraday", "~> 0.9"
-  spec.add_runtime_dependency "faraday_middleware", "~> 0.10"
-
-  if RUBY_PLATFORM == "java"
-    spec.add_runtime_dependency "jdbc-sqlite3", "~> 3.8"
-  else
-    spec.add_runtime_dependency "sqlite3", "~> 1.3"
-  end
-
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rack-test", "~> 0.6"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.3"
-  spec.add_development_dependency "rubocop", "~> 0.34"
-end

data/lib/gemstash/gem_unyanker.rb

@@ -1,61 +0,0 @@
-require "gemstash"
-
-module Gemstash
-  # Class that supports unyanking a gem from the private repository of gems.
-  class GemUnyanker
-    include Gemstash::Env::Helper
-
-    # This error is thrown when unyanking a non-existing gem name.
-    class UnknownGemError < StandardError
-    end
-
-    # This error is thrown when unyanking a non-existing gem version.
-    class UnknownVersionError < StandardError
-    end
-
-    # This error is thrown when unyanking a non-yanked gem version.
-    class NotYankedVersionError < StandardError
-    end
-
-    def initialize(auth_key, gem_name, slug)
-      @auth_key = auth_key
-      @gem_name = gem_name
-      @slug = slug
-    end
-
-    def unyank
-      check_auth
-      update_database
-      invalidate_cache
-    end
-
-  private
-
-    def storage
-      @storage ||= Gemstash::Storage.for("private").for("gems")
-    end
-
-    def full_name
-      @full_name ||= "#{@gem_name}-#{@slug}"
-    end
-
-    def check_auth
-      Gemstash::Authorization.check(@auth_key, "unyank")
-    end
-
-    def update_database
-      gemstash_env.db.transaction do
-        raise UnknownGemError, "Cannot unyank an unknown gem!" unless Gemstash::DB::Rubygem[name: @gem_name]
-        version = Gemstash::DB::Version.find_by_full_name(full_name)
-        raise UnknownVersionError, "Cannot unyank an unknown version!" unless version
-        raise NotYankedVersionError, "Cannot unyank a non-yanked version!" if version.indexed
-        version.reindex
-        storage.resource(version.storage_id).update_properties(indexed: true)
-      end
-    end
-
-    def invalidate_cache
-      gemstash_env.cache.invalidate_gem("private", @gem_name)
-    end
-  end
-end