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

data/lib/gemstash/health.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "gemstash"
+require "date"
+require "server_health_check_rack"
+require "sequel"
+
+module Gemstash
+  # This module contains the logic used to supply a health monitor for
+  # Gemstash. You can access the health monitor at the /health endpoint.
+  module Health
+    # This check can be used if you don't want to read or write content during a
+    # health check.
+    def self.heartbeat
+      true
+    end
+
+    def self.check_storage_read
+      if check_storage_write
+        content = Gemstash::Storage.for("health").resource("test").content(:example)
+        content =~ /\Acontent-\d+\z/
+      end
+    end
+
+    def self.check_storage_write
+      resource = Gemstash::Storage.for("health").resource("test")
+      resource.save(example: "content-#{Time.now.to_i}")
+      true
+    end
+
+    def self.check_db_read
+      result = Gemstash::Env.current.db[:rubygems].where(name: "testing_db_read").count
+      result.is_a?(Numeric)
+    end
+
+    def self.check_db_write
+      Gemstash::Env.current.db.transaction do
+        health_tests = Gemstash::Env.current.db[:health_tests]
+        health_tests.truncate
+        health_tests.insert(string: "test_string")
+        # We don't want to actually write to the database
+        raise Sequel::Rollback
+      end
+
+      true
+    end
+
+    ServerHealthCheckRack::Checks.check("heartbeat") { Gemstash::Health.heartbeat }
+    ServerHealthCheckRack::Checks.check("storage_read") { Gemstash::Health.check_storage_read }
+    ServerHealthCheckRack::Checks.check("storage_write") { Gemstash::Health.check_storage_write }
+    ServerHealthCheckRack::Checks.check("db_read") { Gemstash::Health.check_db_read }
+    ServerHealthCheckRack::Checks.check("db_write") { Gemstash::Health.check_db_write }
+    RackMiddleware = ServerHealthCheckRack::Middleware
+  end
+end

data/lib/gemstash/http_client.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require "gemstash"
 require "faraday"
 require "faraday_middleware"
 
 module Gemstash
-  #:nodoc:
+  # :nodoc:
   class WebError < StandardError
     attr_reader :code
 
@@ -13,15 +15,16 @@ module Gemstash
     end
   end
 
-  #:nodoc:
+  # :nodoc:
   class ConnectionError < WebError
     def initialize(message)
       super(message, 502) # Bad Gateway
     end
   end
 
-  #:nodoc:
+  # :nodoc:
   class HTTPClient
+    extend Gemstash::Env::Helper
     include Gemstash::Logging
 
     DEFAULT_USER_AGENT = "Gemstash/#{Gemstash::VERSION}"
@@ -30,13 +33,19 @@ module Gemstash
       client = Faraday.new(upstream.to_s) do |config|
         config.use FaradayMiddleware::FollowRedirects
         config.adapter :net_http
+        config.options.timeout = gemstash_env.config[:fetch_timeout]
       end
+
+      client.basic_auth(upstream.user, upstream.password) if upstream.auth?
+
       user_agent = "#{upstream.user_agent} " unless upstream.user_agent.to_s.empty?
       user_agent = user_agent.to_s + DEFAULT_USER_AGENT
 
       new(client, user_agent: user_agent)
     end
 
+    attr_reader :client
+
     def initialize(client = nil, user_agent: nil)
       @client = client
       @user_agent = user_agent || DEFAULT_USER_AGENT
@@ -61,14 +70,15 @@ module Gemstash
 
   private
 
-    def with_retries(times: 3, &block)
+    def with_retries(times: 3)
       loop do
         times -= 1
         begin
-          return block.call
+          return yield
         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,8 +1,16 @@
+# frozen_string_literal: true
+
 require "logger"
-require "puma/events"
+
+begin
+  require "puma/detect"
+  require "puma/log_writer" # Puma 6
+rescue LoadError
+  require "puma/events"
+end
 
 module Gemstash
-  #:nodoc:
+  # :nodoc:
   module Logging
     LEVELS = {
       debug: Logger::DEBUG,
@@ -10,7 +18,7 @@ module Gemstash
       warn: Logger::WARN,
       error: Logger::ERROR,
       fatal: Logger::FATAL
-    }
+    }.freeze
 
     def log
       Gemstash::Logging.logger
@@ -60,7 +68,9 @@ module Gemstash
     # Logger that looks like a stream, for Puma and Rack to log to.
     class StreamLogger
       def self.puma_events
-        Puma::Events.new(for_stdout, for_stderr)
+        # Puma 6 removed logging from Events and placed it in LogWriter
+        klass = Puma.const_defined?(:LogWriter) ? Puma::LogWriter : Puma::Events
+        klass.new(for_stdout, for_stderr)
       end
 
       def self.for_stdout
@@ -75,10 +85,12 @@ module Gemstash
         @level = level
       end
 
-      def flush
-      end
+      def flush; end
+
+      def sync=(_value); end
 
-      def sync=(_value)
+      def sync
+        false
       end
 
       def write(message)

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

@@ -0,0 +1,54 @@
+<!-- Automatically generated by Pandoc -->
+.\" Automatically generated by Pandoc 3.1.8
+.\"
+.TH "gemstash-authorize" "1" "October 9, 2015" "" ""
+.SH Name
+gemstash-authorize - Adds or removes authorization to interact with
+privately stored gems
+.SH Synopsis
+\f[CR]gemstash authorize [permissions] [--remove] [--list] [--key SECURE_KEY] [--name NAME] [--config-file FILE]\f[R]
+.SH Description
+Adds or removes authorization to interact with privately stored gems.
+.PP
+Any arguments will be used as specific permissions.
+Valid permissions include \f[CR]push\f[R], \f[CR]yank\f[R], and
+\f[CR]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
+.EX
+gemstash authorize
+gemstash authorize push yank
+gemstash authorize push --name my-auth
+gemstash authorize yank --key <secure-key>
+gemstash authorize --remove --key <secure-key>
+gemstash authorize --list
+.EE
+.SH Options
+.IP \[bu] 2
+\f[CR]--config-file FILE\f[R]: Specify the config file to use.
+If you aren\[cq]t using the default config file at
+\f[CR]\[ti]/.gemstash/config.yml\f[R] or
+\f[CR]\[ti]/.gemstash/config.yml.erb\f[R], then you must specify the
+config file via this option.
+.IP \[bu] 2
+\f[CR]--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[CR]--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[CR]--name\f[R]: Name of the authorization.
+Purely for ease of identification, not required.
+.IP \[bu] 2
+\f[CR]--remove\f[R]: Remove an authorization rather than add or update
+one.
+When removing, permission values are not allowed.
+The \f[CR]--key <secure-key>\f[R] option is required.
+.IP \[bu] 2
+\f[CR]--list\f[R]: List current authorizations.
+Provide \f[CR]--name\f[R] or \f[CR]--key\f[R] to show only one result.

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

@@ -0,0 +1,52 @@
+4mgemstash-authorize24m(1)				      4mgemstash-authorize24m(1)
+
+<!-- Automatically generated by Pandoc -->
+
+1mName0m
+       gemstash-authorize  -  Adds  or	removes authorization to interact with
+       privately stored gems
+
+1mSynopsis0m
+       gemstash authorize [permissions] [--remove] [--list] [--key SECURE_KEY]
+       [--name NAME] [--config-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 push --name my-auth
+	      gemstash authorize yank --key <secure-key>
+	      gemstash authorize --remove --key <secure-key>
+	      gemstash authorize --list
+
+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, then you must specify 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 --name: Name of the authorization.  Purely for  ease  of  identifica-
+	 tion, not required.
+
+       o --remove:  Remove  an	authorization  rather  than add or update one.
+	 When removing, permission values are not allowed.  The --key <secure-
+	 key> option is required.
+
+       o --list: List current authorizations.  Provide --name or --key to show
+	 only one result.
+
+				October 9, 2015 	 4mgemstash-authorize24m(1)

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

@@ -0,0 +1,186 @@
+<!-- Automatically generated by Pandoc -->
+.\" Automatically generated by Pandoc 3.1.8
+.\"
+.TH "gemstash-configuration" "5" "October 13, 2015" "" ""
+.SH Name
+gemstash-configuration
+.SH Synopsis
+.IP
+.EX
+# \[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
+.EE
+.SH Base Path
+\f[CR]: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[CR]:base_path\f[R] via \f[CR]gemstash setup\f[R] will
+create the directory for you.
+.SS Default value
+\f[CR]\[ti]/.gemstash\f[R]
+.SS Valid values
+Any valid path
+.SH Cache Type
+\f[CR]:cache_type\f[R]
+.PP
+Specifies how to cache values other than gem files (such as gem
+dependencies).
+\f[CR]memory\f[R] will use an in memory cache while \f[CR]memcached\f[R]
+will point to 1 or more Memcached servers.
+Use the \f[CR]:memcached_servers\f[R] configuration key for specifying
+where the Memcached server(s) are.
+.SS Default value
+\f[CR]memory\f[R]
+.SS Valid values
+\f[CR]memory\f[R], \f[CR]memcached\f[R]
+.SH Memcached Servers
+\f[CR]:memcached_servers\f[R]
+.PP
+Specifies the Memcached servers to connect to when using
+\f[CR]memcached\f[R] for the \f[CR]:cache_type\f[R].
+Only used when \f[CR]memcached\f[R] is used for \f[CR]:cache_type\f[R].
+.SS Default value
+\f[CR]localhost:11211\f[R]
+.SS Valid values
+A comma delimited list of Memcached servers
+.SH DB Adapter
+\f[CR]:db_adapter\f[R]
+.PP
+Specifies what database adapter to use.
+When \f[CR]sqlite3\f[R] is used, the database will be located at
+\f[CR]gemstash.db\f[R] within the directory specified by
+\f[CR]:base_path\f[R].
+The database will automatically be created when using
+\f[CR]sqlite3\f[R].
+When \f[CR]postgres\f[R], \f[CR]mysql\f[R], or \f[CR]mysql2\f[R] is
+used, the database to connect to must be specified in the
+\f[CR]:db_url\f[R] configuration key.
+The database must already be created when using anything other than
+\f[CR]sqlite3\f[R].
+.SS Default value
+\f[CR]sqlite3\f[R]
+.SS Valid values
+\f[CR]sqlite3\f[R], \f[CR]postgres\f[R], \f[CR]mysql\f[R],
+\f[CR]mysql2\f[R]
+.SH DB URL
+\f[CR]:db_url\f[R]
+.PP
+Specifies the database to connect to when using \f[CR]postgres\f[R],
+\f[CR]mysql\f[R], or \f[CR]mysql2\f[R] for the \f[CR]:db_adapter\f[R].
+Only used when the \f[CR]:db_adapter\f[R] is not \f[CR]sqlite3\f[R].
+.SS Default value
+None
+.SS Valid values
+A valid database URL for the Sequel gem (http://sequel.jeremyevans.net/)
+.SH DB Connection Options
+\f[CR]:db_connection_options\f[R]
+.PP
+Specifies additional \f[CR]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[CR]max_connections\f[R] if you customize
+this option.
+.SS Default value
+\f[CR]{ max_connections: 1 }\f[R] for \f[CR]sqlite3\f[R] adapter,
+\f[CR]{ max_connections: config[:puma_threads] + 1 }\f[R] for any other
+adapter.
+.SS Valid values
+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
+\f[CR]:rubygems_url\f[R]
+.PP
+Specifies the default gem source URL.
+When any API endpoint is called without a \f[CR]/private\f[R] or
+\f[CR]/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
+\f[CR]https://rubygems.org\f[R]
+.SS Valid values
+A valid gem source URL
+.SH Ignore Gemfile source
+\f[CR]:ignore_gemfile_source\f[R]
+.PP
+Ignore the source specified in Gemfile and always use
+\f[CR]:rubygems_url\f[R] as gems upstream.
+.SS Default value
+\f[CR]false\f[R]
+.SS Valid values
+Boolean: \f[CR]true\f[R] or \f[CR]false\f[R]
+.SH Puma Threads
+\f[CR]:puma_threads\f[R]
+.PP
+Specifies the number of threads used for the Gemstash server.
+.SS Default value
+\f[CR]16\f[R]
+.SS Valid values
+Integer value with a minimum of \f[CR]1\f[R]
+.SH Bind Address
+\f[CR]: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
+\f[CR]tcp://0.0.0.0:9292\f[R]
+.SS Valid values
+Any valid binding that is supported by
+Puma (https://github.com/puma/puma#binding-tcp--sockets)
+.SH Protected Fetch
+\f[CR]: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
+\f[CR]false\f[R]
+.SS Valid values
+Boolean values \f[CR]true\f[R] or \f[CR]false\f[R]
+.SH Fetch Timeout
+\f[CR]: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[CR]20\f[R] seconds.
+.SS Default value
+\f[CR]20\f[R]
+.SS Valid values
+Integer value with a minimum of \f[CR]1\f[R]
+.SH Log File
+\f[CR]:log_file\f[R]
+.PP
+Indicates the name of the file to use for logging.
+The file will be placed in the base path.
+.SS Default value
+\f[CR]server.log\f[R]
+.SS Valid values
+Any valid file name, or \f[CR]:stdout\f[R] to log to \f[CR]$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].\f[R]

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

@@ -0,0 +1,208 @@
+4mgemstash-configuration24m(5)				  4mgemstash-configuration24m(5)
+
+<!-- Automatically generated by Pandoc -->
+
+1mName0m
+       gemstash-configuration
+
+1mSynopsis0m
+	      # ~/.gemstash/config.yml
+	      ---
+	      :base_path: "/var/gemstash"
+	      :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
+
+1mBase Path0m
+       :base_path
+
+       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 Gem-
+       stash server process.  Specifying the  :base_path  via  gemstash  setup
+       will create the directory for you.
+
+   1mDefault value0m
+       ~/.gemstash
+
+   1mValid values0m
+       Any valid path
+
+1mCache Type0m
+       :cache_type
+
+       Specifies  how to cache values other than gem files (such as gem depen-
+       dencies).  memory will use an in  memory  cache	while  memcached  will
+       point  to 1 or more Memcached servers.  Use the :memcached_servers con-
+       figuration key for specifying where the Memcached server(s) are.
+
+   1mDefault value0m
+       memory
+
+   1mValid values0m
+       memory, memcached
+
+1mMemcached Servers0m
+       :memcached_servers
+
+       Specifies the Memcached servers to connect to when using memcached  for
+       the :cache_type.  Only used when memcached is used for :cache_type.
+
+   1mDefault value0m
+       localhost:11211
+
+   1mValid values0m
+       A comma delimited list of Memcached servers
+
+1mDB Adapter0m
+       :db_adapter
+
+       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, mysql, or mysql2 is used, the database to con-
+       nect to must be specified in the :db_url configuration key.  The  data-
+       base must already be created when using anything other than sqlite3.
+
+   1mDefault value0m
+       sqlite3
+
+   1mValid values0m
+       sqlite3, postgres, mysql, mysql2
+
+1mDB URL0m
+       :db_url
+
+       Specifies  the  database  to  connect to when using postgres, mysql, or
+       mysql2 for the :db_adapter.  Only used  when  the  :db_adapter  is  not
+       sqlite3.
+
+   1mDefault value0m
+       None
+
+   1mValid values0m
+       A  valid  database  URL	for  the  Sequel  gem  (http://sequel.jeremye-
+       vans.net/)
+
+1mDB Connection Options0m
+       :db_connection_options
+
+       Specifies additional Sequel.connect options to use.  Note that any  op-
+       tions  here  are  merged  in  with the default options, so you need not
+       specify the max_connections if you customize this option.
+
+   1mDefault value0m
+       { max_connections: 1 } for sqlite3  adapter,  {	max_connections:  con-
+       fig[:puma_threads] + 1 } for any other adapter.
+
+   1mValid values0m
+       A  valid  connection  options  Hash  for the Sequel.connect (http://se-
+       quel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html#label-
+       General+connection+options) method.
+
+1mRubygems URL0m
+       :rubygems_url
+
+       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.
+
+   1mDefault value0m
+       https://rubygems.org
+
+   1mValid values0m
+       A valid gem source URL
+
+1mIgnore Gemfile source0m
+       :ignore_gemfile_source
+
+       Ignore  the source specified in Gemfile and always use :rubygems_url as
+       gems upstream.
+
+   1mDefault value0m
+       false
+
+   1mValid values0m
+       Boolean: true or false
+
+1mPuma Threads0m
+       :puma_threads
+
+       Specifies the number of threads used for the Gemstash server.
+
+   1mDefault value0m
+       16
+
+   1mValid values0m
+       Integer value with a minimum of 1
+
+1mBind Address0m
+       :bind
+
+       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 Gem-
+       stash as the root user.
+
+   1mDefault value0m
+       tcp://0.0.0.0:9292
+
+   1mValid values0m
+       Any     valid	 binding     that     is     supported	   by	  Puma
+       (https://github.com/puma/puma#binding-tcp--sockets)
+
+1mProtected Fetch0m
+       :protected_fetch
+
+       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.
+
+   1mDefault value0m
+       false
+
+   1mValid values0m
+       Boolean values true or false
+
+1mFetch Timeout0m
+       :fetch_timeout
+
+       The  timeout setting for fetching gems.	Fetching gems over a slow con-
+       nection may cause timeout errors.  If you  experience  timeout  errors,
+       you may want to increase this value.  The default is 20 seconds.
+
+   1mDefault value0m
+       20
+
+   1mValid values0m
+       Integer value with a minimum of 1
+
+1mLog File0m
+       :log_file
+
+       Indicates  the  name  of the file to use for logging.  The file will be
+       placed in the base path.
+
+   1mDefault value0m
+       server.log
+
+   1mValid values0m
+       Any valid file name, or :stdout to log to $stdout
+
+       4mNote:24m 4mUsing24m 4m:stdout24m 4mfor24m 4mthe24m 4m:log_file24m 4mrequires24m 4mrunning24m 4mwith24m 4m--no-daemo-0m
+       4mnize.0m
+
+			       October 13, 2015      4mgemstash-configuration24m(5)