gemstash 2.0.0 → 2.1.0

data/lib/gemstash/gem_fetcher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "gemstash"
 require "set"
 

data/lib/gemstash/gem_pusher.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "gemstash"
 require "rubygems/package"
 require "stringio"
@@ -56,9 +58,7 @@ module Gemstash
       resource_exist = storage.resource(full_name).exist?
       resource_is_indexed = storage.resource(full_name).properties[:indexed] if resource_exist
 
-      if resource_exist && resource_is_indexed
-        raise ExistingVersionError, "Cannot push to an existing version!"
-      end
+      raise ExistingVersionError, "Cannot push to an existing version!" if resource_exist && resource_is_indexed
 
       storage.resource(full_name).save({ gem: @content }, indexed: true)
     end
@@ -78,6 +78,7 @@ module Gemstash
         existing = Gemstash::DB::Version.find_by_spec(gem_id, spec)
         raise ExistingVersionError, "Cannot push to an existing version!" if existing && existing.indexed
         raise YankedVersionError, "Cannot push to a yanked version!" if existing && !existing.indexed
+
         version_id = Gemstash::DB::Version.insert_by_spec(gem_id, spec)
         Gemstash::DB::Dependency.insert_by_spec(version_id, spec)
       end
@@ -120,6 +121,7 @@ module Gemstash
 
       def cleanup
         return unless @tempfile
+
         @tempfile.close
         @tempfile.unlink
       end

data/lib/gemstash/gem_source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "gemstash"
 require "forwardable"
 

data/lib/gemstash/gem_source/dependency_caching.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gemstash
   module GemSource
     # Module for caching dependencies in a GemSource.
@@ -7,9 +9,7 @@ module Gemstash
       def serve_dependencies
         gems = gems_from_params
 
-        if gems.length > API_REQUEST_LIMIT
-          halt 422, "Too many gems (use --full-index instead)"
-        end
+        halt 422, "Too many gems (use --full-index instead)" if gems.length > API_REQUEST_LIMIT
 
         content_type "application/octet-stream"
         Marshal.dump dependencies.fetch(gems)
@@ -21,7 +21,7 @@ module Gemstash
         if gems.length > API_REQUEST_LIMIT
           halt 422, {
             "error" => "Too many gems (use --full-index instead)",
-            "code"  => 422
+            "code" => 422
           }.to_json
         end
 

data/lib/gemstash/gem_source/private_source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "gemstash"
 
 module Gemstash
@@ -15,6 +17,7 @@ module Gemstash
       def self.matches?(env)
         rewriter = rack_env_rewriter.for(env)
         return false unless rewriter.matches?
+
         rewriter.rewrite
         true
       end

data/lib/gemstash/gem_source/rack_middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "gemstash"
 
 module Gemstash
@@ -11,6 +13,7 @@ module Gemstash
       def call(env)
         Gemstash::GemSource.sources.each do |source|
           next unless source.matches?(env)
+
           env["gemstash.gem_source"] = source
           break
         end

data/lib/gemstash/gem_source/upstream_source.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "gemstash"
 require "cgi"
 
@@ -12,6 +14,7 @@ module Gemstash
       def self.matches?(env)
         rewriter = rack_env_rewriter.for(env)
         return false unless rewriter.matches?
+
         rewriter.rewrite
         env["gemstash.upstream"] = rewriter.captures["upstream_url"]
         capture_user_agent(env)
@@ -90,8 +93,10 @@ module Gemstash
     private
 
       def upstream
-        @upstream ||= Gemstash::Upstream.new(env["gemstash.upstream"],
-          user_agent: env["gemstash.user-agent"])
+        @upstream ||= Gemstash::Upstream.new(
+          env["gemstash.upstream"],
+          user_agent: env["gemstash.user-agent"]
+        )
       end
 
       def index_upstream
@@ -135,6 +140,7 @@ module Gemstash
 
       def set_gem_headers(gem, resource_type)
         return unless gem.property?(:headers, resource_type)
+
         gem_headers = gem.properties[:headers][resource_type]
         headers["Content-Type"] = gem_headers["content-type"] if gem_headers.include?("content-type")
         headers["Last-Modified"] = gem_headers["last-modified"] if gem_headers.include?("last-modified")
@@ -192,7 +198,7 @@ module Gemstash
     # default upstream).
     class RubygemsSource < Gemstash::GemSource::UpstreamSource
       def self.matches?(env)
-        env["gemstash.upstream"] = if env["HTTP_X_GEMFILE_SOURCE"].to_s.empty?
+        env["gemstash.upstream"] = if env["gemstash.env"].config[:ignore_gemfile_source] || env["HTTP_X_GEMFILE_SOURCE"].to_s.empty?
           env["gemstash.env"].config[:rubygems_url]
         else
           env["HTTP_X_GEMFILE_SOURCE"]

data/lib/gemstash/gem_yanker.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "gemstash"
 
 module Gemstash
@@ -52,9 +54,11 @@ module Gemstash
     def update_database
       gemstash_env.db.transaction do
         raise UnknownGemError, "Cannot yank an unknown gem!" unless Gemstash::DB::Rubygem[name: @gem_name]
+
         version = Gemstash::DB::Version.find_by_full_name(full_name)
         raise UnknownVersionError, "Cannot yank an unknown version!" unless version
         raise YankedVersionError, "Cannot yank an already yanked version!" unless version.indexed
+
         version.deindex
         storage.resource(version.storage_id).update_properties(indexed: false)
       end

data/lib/gemstash/health.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "gemstash"
 require "date"
 require "server_health_check_rack"

data/lib/gemstash/http_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "gemstash"
 require "faraday"
 require "faraday_middleware"
@@ -25,7 +27,7 @@ module Gemstash
     extend Gemstash::Env::Helper
     include Gemstash::Logging
 
-    DEFAULT_USER_AGENT = "Gemstash/#{Gemstash::VERSION}".freeze
+    DEFAULT_USER_AGENT = "Gemstash/#{Gemstash::VERSION}"
 
     def self.for(upstream)
       client = Faraday.new(upstream.to_s) do |config|
@@ -71,6 +73,7 @@ module Gemstash
         rescue Faraday::ConnectionFailed => e
           log_error("Connection failure", e)
           raise(ConnectionError, e.message) unless times > 0
+
           log.info "retrying... #{times} more times"
         end
       end

data/lib/gemstash/logging.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "logger"
 require "puma/events"
 

data/lib/gemstash/man/gemstash-authorize.1

@@ -0,0 +1,51 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "gemstash\-authorize" "1" "October 9, 2015" "" ""
+.hy
+.SH NAME
+.PP
+gemstash\-authorize \- Adds or removes authorization to interact with
+privately stored gems
+.SH SYNOPSIS
+.PP
+\f[C]gemstash authorize [permissions] [\-\-remove] [\-\-key SECURE_KEY] [\-\-config\-file FILE]\f[R]
+.SH DESCRIPTION
+.PP
+Adds or removes authorization to interact with privately stored gems.
+.PP
+Any arguments will be used as specific permissions.
+Valid permissions include \f[C]push\f[R], \f[C]yank\f[R], and
+\f[C]fetch\f[R].
+If no permissions are provided, then all permissions will be granted
+(including any that may be added in future versions of Gemstash).
+.SS USAGE
+.IP
+.nf
+\f[C]
+gemstash authorize
+gemstash authorize push yank
+gemstash authorize yank \-\-key <secure\-key>
+gemstash authorize \-\-remove \-\-key <secure\-key>
+\f[R]
+.fi
+.SH OPTIONS
+.IP \[bu] 2
+\f[C]\-\-config\-file FILE\f[R]: Specify the config file to use.
+If you aren\[cq]t using the default config file at
+\f[C]\[ti]/.gemstash/config.yml\f[R] or
+\f[C]\[ti]/.gemstash/config.yml.erb\f[R] (gemstash help customize.7),
+then you must specify the config file via this option.
+.IP \[bu] 2
+\f[C]\-\-key SECURE_KEY\f[R]: Specify the API key to affect.
+This should be the actual key value, not a name.
+This option is required when using \f[C]\-\-remove\f[R] 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.
+Note that a key can only have a maximum length of 255 chars.
+.IP \[bu] 2
+\f[C]\-\-remove\f[R]: Remove an authorization rather than add or update
+one.
+When removing, permission values are not allowed.
+The \f[C]\-\-key <secure\-key>\f[R] option is required.

data/lib/gemstash/man/gemstash-authorize.1.txt

@@ -1,66 +1,46 @@
+gemstash-authorize(1)					 gemstash-authorize(1)
 
 
 
+1mNAME0m
+       gemstash-authorize  -  Adds  or	removes authorization to interact with
+       privately stored gems
 
+1mSYNOPSIS0m
+       gemstash authorize [permissions] [--remove] [--key SECURE_KEY]  [--con-
+       fig-file FILE]
 
+1mDESCRIPTION0m
+       Adds or removes authorization to interact with privately stored gems.
 
+       Any  arguments will be used as specific permissions.  Valid permissions
+       include push, yank, and fetch.  If no permissions  are  provided,  then
+       all permissions will be granted (including any that may be added in fu-
+       ture versions of Gemstash).
 
+   1mUSAGE0m
+	      gemstash authorize
+	      gemstash authorize push yank
+	      gemstash authorize yank --key <secure-key>
+	      gemstash authorize --remove --key <secure-key>
 
+1mOPTIONS0m
+       o --config-file FILE: Specify the config file to use.   If  you	aren't
+	 using	the  default  config file at ~/.gemstash/config.yml or ~/.gem-
+	 stash/config.yml.erb (gemstash help customize.7), then you must spec-
+	 ify the config file via this option.
 
+       o --key	SECURE_KEY: 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, us-
+	 ing this will either create or update the permissions for the	speci-
+	 fied  API  key.   If missing, a new API key will always be generated.
+	 Note that a key can only have a maximum length of 255 chars.
 
+       o --remove: Remove an authorization rather  than	 add  or  update  one.
+	 When  removing,  permission  values  are not allowed.	The --key <se-
+	 cure-key> option is required.
 
 
 
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+				October 9, 2015		 gemstash-authorize(1)

data/lib/gemstash/man/gemstash-configuration.5

@@ -0,0 +1,229 @@
+.\" Automatically generated by Pandoc 2.5
+.\"
+.TH "gemstash\-configuration" "5" "October 13, 2015" "" ""
+.hy
+.SH NAME
+.PP
+gemstash\-configuration
+.SH SYNOPSIS
+.IP
+.nf
+\f[C]
+# \[ti]/.gemstash/config.yml
+\-\-\-
+:base_path: \[dq]/var/gemstash\[dq]
+:cache_type: memcached
+:memcached_servers: localhost:11211
+:db_adapter: postgres
+:db_url: postgres:///gemstash
+:db_connection_options:
+  :test: true
+  :pool_timeout: 2
+:rubygems_url: https://my.gem\-source.local
+:ignore_gemfile_source: false
+:puma_threads: 32
+:bind: tcp://0.0.0.0:4242
+:protected_fetch: true
+:fetch_timeout: 10
+:log_file: gemstash.log
+\f[R]
+.fi
+.SH BASE PATH
+.PP
+\f[C]:base_path\f[R]
+.PP
+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 \f[C]:base_path\f[R] via
+\f[C]gemstash setup\f[R] (gemstash help setup.1) will create the
+directory for you.
+.SS DEFAULT VALUE
+.PP
+\f[C]\[ti]/.gemstash\f[R]
+.SS VALID VALUES
+.PP
+Any valid path
+.SH CACHE TYPE
+.PP
+\f[C]:cache_type\f[R]
+.PP
+Specifies how to cache values other than gem files (such as gem
+dependencies).
+\f[C]memory\f[R] will use an in memory cache while \f[C]memcached\f[R]
+will point to 1 or more Memcached servers.
+Use the \f[C]:memcached_servers\f[R] configuration key for specifying
+where the Memcached server(s) are.
+.SS DEFAULT VALUE
+.PP
+\f[C]memory\f[R]
+.SS VALID VALUES
+.PP
+\f[C]memory\f[R], \f[C]memcached\f[R]
+.SH MEMCACHED SERVERS
+.PP
+\f[C]:memcached_servers\f[R]
+.PP
+Specifies the Memcached servers to connect to when using
+\f[C]memcached\f[R] for the \f[C]:cache_type\f[R].
+Only used when \f[C]memcached\f[R] is used for \f[C]:cache_type\f[R].
+.SS DEFAULT VALUE
+.PP
+\f[C]localhost:11211\f[R]
+.SS VALID VALUES
+.PP
+A comma delimited list of Memcached servers
+.SH DB ADAPTER
+.PP
+\f[C]:db_adapter\f[R]
+.PP
+Specifies what database adapter to use.
+When \f[C]sqlite3\f[R] is used, the database will be located at
+\f[C]gemstash.db\f[R] within the directory specified by
+\f[C]:base_path\f[R].
+The database will automatically be created when using \f[C]sqlite3\f[R].
+When \f[C]postgres\f[R], \f[C]mysql\f[R], or \f[C]mysql2\f[R] is used,
+the database to connect to must be specified in the \f[C]:db_url\f[R]
+configuration key.
+The database must already be created when using anything other than
+\f[C]sqlite3\f[R].
+.SS DEFAULT VALUE
+.PP
+\f[C]sqlite3\f[R]
+.SS VALID VALUES
+.PP
+\f[C]sqlite3\f[R], \f[C]postgres\f[R], \f[C]mysql\f[R], \f[C]mysql2\f[R]
+.SH DB URL
+.PP
+\f[C]:db_url\f[R]
+.PP
+Specifies the database to connect to when using \f[C]postgres\f[R],
+\f[C]mysql\f[R], or \f[C]mysql2\f[R] for the \f[C]:db_adapter\f[R].
+Only used when the \f[C]:db_adapter\f[R] is not \f[C]sqlite3\f[R].
+.SS DEFAULT VALUE
+.PP
+None
+.SS VALID VALUES
+.PP
+A valid database URL for the Sequel gem (http://sequel.jeremyevans.net/)
+.SH DB CONNECTION OPTIONS
+.PP
+\f[C]:db_connection_options\f[R]
+.PP
+Specifies additional \f[C]Sequel.connect\f[R] options to use.
+Note that any options here are merged in with the default options, so
+you need not specify the \f[C]max_connections\f[R] if you customize this
+option.
+.SS DEFAULT VALUE
+.PP
+\f[C]{ max_connections: 1 }\f[R] for \f[C]sqlite3\f[R] adapter,
+\f[C]{ max_connections: config[:puma_threads] + 1 }\f[R] for any other
+adapter.
+.SS VALID VALUES
+.PP
+A valid connection options Hash for the
+Sequel.connect (http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-General+connection+options)
+method.
+.SH RUBYGEMS URL
+.PP
+\f[C]:rubygems_url\f[R]
+.PP
+Specifies the default gem source URL.
+When any API endpoint is called without a \f[C]/private\f[R] or
+\f[C]/upstream/<url>\f[R] 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.
+.SS DEFAULT VALUE
+.PP
+\f[C]https://rubygems.org\f[R]
+.SS VALID VALUES
+.PP
+A valid gem source URL
+.SH IGNORE GEMFILE SOURCE
+.PP
+\f[C]:ignore_gemfile_source\f[R]
+.PP
+Ignore the source specified in Gemfile and always use
+\f[C]:rubygems_url\f[R] as gems upstream.
+.SS DEFAULT VALUE
+.PP
+\f[C]false\f[R]
+.SS VALID VALUES
+.PP
+Boolean: \f[C]true\f[R] or \f[C]false\f[R]
+.SH PUMA THREADS
+.PP
+\f[C]:puma_threads\f[R]
+.PP
+Specifies the number of threads used for the Gemstash server.
+.SS DEFAULT VALUE
+.PP
+\f[C]16\f[R]
+.SS VALID VALUES
+.PP
+Integer value with a minimum of \f[C]1\f[R]
+.SH BIND ADDRESS
+.PP
+\f[C]:bind\f[R]
+.PP
+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.
+.SS DEFAULT VALUE
+.PP
+\f[C]tcp://0.0.0.0:9292\f[R]
+.SS VALID VALUES
+.PP
+Any valid binding that is supported by
+Puma (https://github.com/puma/puma#binding-tcp--sockets)
+.SH PROTECTED FETCH
+.PP
+\f[C]:protected_fetch\f[R]
+.PP
+Tells Gemstash to authenticate via an API key before allowing the
+fetching of private gems and specs.
+The default behavior is to allow unauthenticated download of private
+gems and specs.
+.SS DEFAULT VALUE
+.PP
+\f[C]false\f[R]
+.SS VALID VALUES
+.PP
+Boolean values \f[C]true\f[R] or \f[C]false\f[R]
+.SH FETCH TIMEOUT
+.PP
+\f[C]:fetch_timeout\f[R]
+.PP
+The timeout setting for fetching gems.
+Fetching gems over a slow connection may cause timeout errors.
+If you experience timeout errors, you may want to increase this value.
+The default is \f[C]20\f[R] seconds.
+.SS DEFAULT VALUE
+.PP
+\f[C]20\f[R]
+.SS VALID VALUES
+.PP
+Integer value with a minimum of \f[C]1\f[R]
+.SH LOG FILE
+.PP
+\f[C]:log_file\f[R]
+.PP
+Indicates the name of the file to use for logging.
+The file will be placed in the base
+path (gemstash help configuration.5).
+.SS DEFAULT VALUE
+.PP
+\f[C]server.log\f[R]
+.SS VALID VALUES
+.PP
+Any valid file name, or \f[C]:stdout\f[R] to log to \f[C]$stdout\f[R]
+.PP
+\f[I]Note: Using \f[CI]:stdout\f[I] for the \f[CI]:log_file\f[I]
+requires running with
+\f[CI]\-\-no\-daemonize\f[I] (gemstash help start.1).\f[R]