gemstash 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 41416a39e4dabbc11e7f8f1ad812dc34ffce3fbfa47c6f997feec01c083bf483
-  data.tar.gz: c274c1eac63e99d2001f946b117c020dd1fe5c25bdcaf1c31dd28e0668603b2d
+  metadata.gz: cb52dab0226e577b3119d1eccead8bcb09bd66226832824e53a8511860996c13
+  data.tar.gz: b13d821c0d1baa930c4107fd455be21b735c72f480a151d57640de20b134073a
 SHA512:
-  metadata.gz: 94941045dd2f8232b5c55a79e775df4e89243d62ce88f22bd737d9dda3bf718a9d30b184b790677beba415c98243b3190c362cab800333993e6d89677592d398
-  data.tar.gz: 3f771fae6b0a388dd730978ec0721c83514d3479fd30f9211def6d7bad2ce5f9a83239bbfde091b450f32c053d0f763799e61aa9a9f95b947802dc2c1533275a
+  metadata.gz: 2b91f27500a36a8f8e412c992b026c4419f1bb63493f9325e8b1743ff28becba13648b16cbe93250e07ee4d42a1081c224928ba6269bdf4955c13259f47c82a7
+  data.tar.gz: 51bf8238974a3963719f38388d73a0ac1a480d5de67d3948df692a5823af56f70c632563db8c46e60ed28eaa70e4debb646aa8bc73bb2f291a19e07175619cfd

data/lib/gemstash/cache.rb

@@ -97,7 +97,7 @@ module Gemstash
 
     def get(key)
       val = @cache.get(key)
-      YAML.load(val) unless val.nil?
+      YAML.load(val, permitted_classes: [Gemstash::Authorization, Set]) unless val.nil?
     end
 
     def get_multi(keys)

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

@@ -0,0 +1,66 @@
+<!-- Automatically generated by Pandoc -->
+.\" Automatically generated by Pandoc 3.0.1
+.\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.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[V]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[V]push\f[R], \f[V]yank\f[R], and
+\f[V]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[V]--config-file FILE\f[R]: Specify the config file to use.
+If you aren\[cq]t using the default config file at
+\f[V]\[ti]/.gemstash/config.yml\f[R] or
+\f[V]\[ti]/.gemstash/config.yml.erb\f[R], then you must specify the
+config file via this option.
+.IP \[bu] 2
+\f[V]--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[V]--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[V]--remove\f[R]: Remove an authorization rather than add or update
+one.
+When removing, permission values are not allowed.
+The \f[V]--key <secure-key>\f[R] option is required.

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

@@ -1 +1,48 @@
+gemstash-authorize(1)					 gemstash-authorize(1)
 
+
+
+<!-- Automatically generated by Pandoc -->
+
+1mName0m
+       gemstash-authorize  -  Adds  or	removes authorization to interact with
+       privately stored gems
+
+1mSynopsis0m
+       1mgemstash authorize [permissions] [--remove] [--key SECURE_KEY]  [--con-0m
+       1mfig-file FILE]0m
+
+1mDescription0m
+       Adds or removes authorization to interact with privately stored gems.
+
+       Any  arguments will be used as specific permissions.  Valid permissions
+       include 1mpush22m, 1myank22m, and 1mfetch22m.  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 1m--config-file FILE22m: Specify the config file to use.   If	you  aren't
+	 using	the  default  config file at 1m~/.gemstash/config.yml 22mor 1m~/.gem-0m
+	 1mstash/config.yml.erb22m, then you must specify the config file via  this
+	 option.
+
+       o 1m--key  SECURE_KEY22m: Specify the API key to affect.  This should be the
+	 actual key value, not a name.	This option  is  required  when  using
+	 1m--remove  22mbut 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 1m--remove22m: Remove an authorization rather	than  add  or  update  one.
+	 When removing, permission values are not allowed.  The 1m--key <secure-0m
+	 1mkey> 22moption is required.
+
+
+
+				October 9, 2015 	 gemstash-authorize(1)

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

@@ -0,0 +1,241 @@
+<!-- Automatically generated by Pandoc -->
+.\" Automatically generated by Pandoc 3.0.1
+.\"
+.\" Define V font for inline verbatim, using C font in formats
+.\" that render this, and otherwise B font.
+.ie "\f[CB]x\f[]"x" \{\
+. ftr V B
+. ftr VI BI
+. ftr VB B
+. ftr VBI BI
+.\}
+.el \{\
+. ftr V CR
+. ftr VI CI
+. ftr VB CB
+. ftr VBI CBI
+.\}
+.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[V]: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[V]:base_path\f[R] via \f[V]gemstash setup\f[R] will
+create the directory for you.
+.SS Default value
+.PP
+\f[V]\[ti]/.gemstash\f[R]
+.SS Valid values
+.PP
+Any valid path
+.SH Cache Type
+.PP
+\f[V]:cache_type\f[R]
+.PP
+Specifies how to cache values other than gem files (such as gem
+dependencies).
+\f[V]memory\f[R] will use an in memory cache while \f[V]memcached\f[R]
+will point to 1 or more Memcached servers.
+Use the \f[V]:memcached_servers\f[R] configuration key for specifying
+where the Memcached server(s) are.
+.SS Default value
+.PP
+\f[V]memory\f[R]
+.SS Valid values
+.PP
+\f[V]memory\f[R], \f[V]memcached\f[R]
+.SH Memcached Servers
+.PP
+\f[V]:memcached_servers\f[R]
+.PP
+Specifies the Memcached servers to connect to when using
+\f[V]memcached\f[R] for the \f[V]:cache_type\f[R].
+Only used when \f[V]memcached\f[R] is used for \f[V]:cache_type\f[R].
+.SS Default value
+.PP
+\f[V]localhost:11211\f[R]
+.SS Valid values
+.PP
+A comma delimited list of Memcached servers
+.SH DB Adapter
+.PP
+\f[V]:db_adapter\f[R]
+.PP
+Specifies what database adapter to use.
+When \f[V]sqlite3\f[R] is used, the database will be located at
+\f[V]gemstash.db\f[R] within the directory specified by
+\f[V]:base_path\f[R].
+The database will automatically be created when using \f[V]sqlite3\f[R].
+When \f[V]postgres\f[R], \f[V]mysql\f[R], or \f[V]mysql2\f[R] is used,
+the database to connect to must be specified in the \f[V]:db_url\f[R]
+configuration key.
+The database must already be created when using anything other than
+\f[V]sqlite3\f[R].
+.SS Default value
+.PP
+\f[V]sqlite3\f[R]
+.SS Valid values
+.PP
+\f[V]sqlite3\f[R], \f[V]postgres\f[R], \f[V]mysql\f[R], \f[V]mysql2\f[R]
+.SH DB URL
+.PP
+\f[V]:db_url\f[R]
+.PP
+Specifies the database to connect to when using \f[V]postgres\f[R],
+\f[V]mysql\f[R], or \f[V]mysql2\f[R] for the \f[V]:db_adapter\f[R].
+Only used when the \f[V]:db_adapter\f[R] is not \f[V]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[V]:db_connection_options\f[R]
+.PP
+Specifies additional \f[V]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[V]max_connections\f[R] if you customize this
+option.
+.SS Default value
+.PP
+\f[V]{ max_connections: 1 }\f[R] for \f[V]sqlite3\f[R] adapter,
+\f[V]{ 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[V]:rubygems_url\f[R]
+.PP
+Specifies the default gem source URL.
+When any API endpoint is called without a \f[V]/private\f[R] or
+\f[V]/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[V]https://rubygems.org\f[R]
+.SS Valid values
+.PP
+A valid gem source URL
+.SH Ignore Gemfile source
+.PP
+\f[V]:ignore_gemfile_source\f[R]
+.PP
+Ignore the source specified in Gemfile and always use
+\f[V]:rubygems_url\f[R] as gems upstream.
+.SS Default value
+.PP
+\f[V]false\f[R]
+.SS Valid values
+.PP
+Boolean: \f[V]true\f[R] or \f[V]false\f[R]
+.SH Puma Threads
+.PP
+\f[V]:puma_threads\f[R]
+.PP
+Specifies the number of threads used for the Gemstash server.
+.SS Default value
+.PP
+\f[V]16\f[R]
+.SS Valid values
+.PP
+Integer value with a minimum of \f[V]1\f[R]
+.SH Bind Address
+.PP
+\f[V]: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[V]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[V]: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[V]false\f[R]
+.SS Valid values
+.PP
+Boolean values \f[V]true\f[R] or \f[V]false\f[R]
+.SH Fetch Timeout
+.PP
+\f[V]: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[V]20\f[R] seconds.
+.SS Default value
+.PP
+\f[V]20\f[R]
+.SS Valid values
+.PP
+Integer value with a minimum of \f[V]1\f[R]
+.SH Log File
+.PP
+\f[V]: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
+.PP
+\f[V]server.log\f[R]
+.SS Valid values
+.PP
+Any valid file name, or \f[V]:stdout\f[R] to log to \f[V]$stdout\f[R]
+.PP
+\f[I]Note: Using \f[VI]:stdout\f[I] for the \f[VI]:log_file\f[I]
+requires running with \f[VI]--no-daemonize\f[I].\f[R]

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

@@ -1 +1,212 @@
+gemstash-configuration(5)			     gemstash-configuration(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
+       1m:base_path0m
+
+       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 1m:base_path 22mvia 1mgemstash setup0m
+       will create the directory for you.
+
+   1mDefault value0m
+       1m~/.gemstash0m
+
+   1mValid values0m
+       Any valid path
+
+1mCache Type0m
+       1m:cache_type0m
+
+       Specifies how to cache values other than gem files (such as gem	depen-
+       dencies).   1mmemory  22mwill  use  an  in memory cache while 1mmemcached 22mwill
+       point to 1 or more Memcached servers.  Use the 1m:memcached_servers  22mcon-
+       figuration key for specifying where the Memcached server(s) are.
+
+   1mDefault value0m
+       1mmemory0m
+
+   1mValid values0m
+       1mmemory22m, 1mmemcached0m
+
+1mMemcached Servers0m
+       1m:memcached_servers0m
+
+       Specifies  the Memcached servers to connect to when using 1mmemcached 22mfor
+       the 1m:cache_type22m.  Only used when 1mmemcached 22mis used for 1m:cache_type22m.
+
+   1mDefault value0m
+       1mlocalhost:112110m
+
+   1mValid values0m
+       A comma delimited list of Memcached servers
+
+1mDB Adapter0m
+       1m:db_adapter0m
+
+       Specifies what database adapter to use.	 When  1msqlite3  22mis  used,	the
+       database  will be located at 1mgemstash.db 22mwithin the directory specified
+       by 1m:base_path22m.  The database will automatically be created	when  using
+       1msqlite322m.  When 1mpostgres22m, 1mmysql22m, or 1mmysql2 22mis used, the database to con-
+       nect to must be specified in the 1m:db_url 22mconfiguration key.  The  data-
+       base must already be created when using anything other than 1msqlite322m.
+
+   1mDefault value0m
+       1msqlite30m
+
+   1mValid values0m
+       1msqlite322m, 1mpostgres22m, 1mmysql22m, 1mmysql20m
+
+1mDB URL0m
+       1m:db_url0m
+
+       Specifies  the  database  to  connect to when using 1mpostgres22m, 1mmysql22m, or
+       1mmysql2 22mfor the 1m:db_adapter22m.  Only used  when  the  1m:db_adapter  22mis  not
+       1msqlite322m.
+
+   1mDefault value0m
+       None
+
+   1mValid values0m
+       A  valid  database  URL	for  the  Sequel  gem  (http://sequel.jeremye-
+       vans.net/)
+
+1mDB Connection Options0m
+       1m:db_connection_options0m
+
+       Specifies additional 1mSequel.connect 22moptions to use.  Note that any	op-
+       tions  here  are  merged  in  with the default options, so you need not
+       specify the 1mmax_connections 22mif you customize this option.
+
+   1mDefault value0m
+       1m{ max_connections: 1 } 22mfor 1msqlite3  22madapter,  1m{  max_connections:  con-0m
+       1mfig[:puma_threads] + 1 } 22mfor 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
+       1m:rubygems_url0m
+
+       Specifies  the default gem source URL.  When any API endpoint is called
+       without a 1m/private 22mor 1m/upstream/<url> 22mprefix, 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
+       1mhttps://rubygems.org0m
+
+   1mValid values0m
+       A valid gem source URL
+
+1mIgnore Gemfile source0m
+       1m:ignore_gemfile_source0m
+
+       Ignore the source specified in Gemfile and always use 1m:rubygems_url  22mas
+       gems upstream.
+
+   1mDefault value0m
+       1mfalse0m
+
+   1mValid values0m
+       Boolean: 1mtrue 22mor 1mfalse0m
+
+1mPuma Threads0m
+       1m:puma_threads0m
+
+       Specifies the number of threads used for the Gemstash server.
+
+   1mDefault value0m
+       1m160m
+
+   1mValid values0m
+       Integer value with a minimum of 1m10m
+
+1mBind Address0m
+       1m:bind0m
+
+       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
+       1mtcp://0.0.0.0:92920m
+
+   1mValid values0m
+       Any     valid	 binding     that     is     supported	   by	  Puma
+       (https://github.com/puma/puma#binding-tcp--sockets)
+
+1mProtected Fetch0m
+       1m:protected_fetch0m
+
+       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
+       1mfalse0m
+
+   1mValid values0m
+       Boolean values 1mtrue 22mor 1mfalse0m
+
+1mFetch Timeout0m
+       1m:fetch_timeout0m
+
+       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 1m20 22mseconds.
+
+   1mDefault value0m
+       1m200m
+
+   1mValid values0m
+       Integer value with a minimum of 1m10m
+
+1mLog File0m
+       1m:log_file0m
+
+       Indicates  the  name  of the file to use for logging.  The file will be
+       placed in the base path.
+
+   1mDefault value0m
+       1mserver.log0m
+
+   1mValid values0m
+       Any valid file name, or 1m:stdout 22mto log to 1m$stdout0m
+
+       4mNote:24m 4mUsing24m 4m1m:stdout24m 4m22mfor24m 4mthe24m 4m1m:log_file24m 4m22mrequires24m 4mrunning24m 4mwith24m 4m1m--no-daemo-0m
+       4m1mnize22m.0m
+
+
+
+			       October 13, 2015      gemstash-configuration(5)