gemstash 1.0.2 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe7e58da58c18944e118fc19063e7f4c730b8d9d
-  data.tar.gz: ed5e51504ea2fe809bbc01a6305351d9e73a6811
+  metadata.gz: f2451a88f1b59b66d8df49dba624068ad21ca4e6
+  data.tar.gz: 2f2d390c425b0aee89919a81674c594cb70f9920
 SHA512:
-  metadata.gz: 87f204c3e9f05fc452889a42a16063553c77abe937fed20a71646e3eea3740c960ecb3949c634e181ad5709b7288664f80db7f72d9ba9e41f4fcc6c6c1097f25
-  data.tar.gz: 305da0681b3c5b7bfd6be10534c490a7dfde10f55ac30add6cbdfd816c66f6cc49ae1c897cd42a53aa863fd4141300510e988ad28a52f99fb8c4029dc13be1ee
+  metadata.gz: 2d9c38f14d52a88929ec6ef2bf4079bffdd73ff72f8c3874ed14ff71d0b55635f0d8a101591a42a5aec27163da5f5efcc8397c69a75746e3501d5024921bd15f
+  data.tar.gz: e39d920de294e31bf55b161c9283bdd0b46910429d42a21dc4d2eb99749e1568cd8dd4ce107ea08bb6e797b7034bbc1d471d6ca584b66e872eeb14b00fe5751d

data/CHANGELOG.md

@@ -1,3 +1,14 @@
+## 1.0.3 (2016-10-15)
+
+### Bugfixes
+
+  - Fix JRuby build ([#110](https://github.com/bundler/gemstash/pull/110), [@smellsblue](https://github.com/smellsblue))
+  - Fix nil error when gems are fetched for the first time concurrently ([#111](https://github.com/bundler/gemstash/pull/111), [@smellsblue](https://github.com/smellsblue))
+
+### Features
+
+  - Embedded documentation via `gemstash help` ([#109](https://github.com/bundler/gemstash/pull/109), [@smellsblue](https://github.com/smellsblue))
+
 ## 1.0.2 (2016-07-07)
 
 ### Bugfixes

data/lib/gemstash/cli.rb

@@ -23,6 +23,29 @@ module Gemstash
       true
     end
 
+    def self.start(args = ARGV)
+      help_flags = %w(-h --help)
+
+      if args.any? {|a| help_flags.include?(a) }
+        super(%w(help) + args.reject {|a| help_flags.include?(a) })
+      else
+        super
+      end
+    end
+
+    def help(command = nil)
+      command ||= "readme"
+      page = manpage(command)
+
+      if page && which("man")
+        exec "man", page
+      elsif page
+        puts File.read("#{page}.txt")
+      else
+        super
+      end
+    end
+
     desc "authorize [PERMISSIONS...]", "Add authorizations to push/yank/unyank private gems"
     method_option :remove, :type => :boolean, :default => false, :desc =>
       "Remove an authorization key"
@@ -73,5 +96,28 @@ module Gemstash
       say "Gemstash version #{Gemstash::VERSION}"
     end
     map %w(-v --version) => :version
+
+  private
+
+    def manpage(command)
+      page = File.expand_path("../man/gemstash-#{command}", __FILE__)
+      return page if File.file?(page)
+
+      1.upto(8) do |section|
+        page = File.expand_path("../man/gemstash-#{command}.#{section}", __FILE__)
+        return page if File.file?(page)
+      end
+
+      nil
+    end
+
+    def which(executable)
+      ENV["PATH"].split(File::PATH_SEPARATOR).each do |path|
+        exe_path = File.join(path, executable)
+        return exe_path if File.file?(exe_path) && File.executable?(exe_path)
+      end
+
+      nil
+    end
   end
 end

data/lib/gemstash/cli/setup.rb

@@ -143,7 +143,7 @@ module Gemstash
       def store_config
         config_dir = File.dirname(config_file)
         FileUtils.mkpath(config_dir) unless Dir.exist?(config_dir)
-        File.write(config_file, YAML.dump(@config))
+        gemstash_env.atomic_write(config_file) {|f| f.write(YAML.dump(@config)) }
       end
 
       def save_metadata

data/lib/gemstash/env.rb

@@ -1,4 +1,5 @@
 require "gemstash"
+require "active_support/core_ext/file/atomic"
 require "dalli"
 require "fileutils"
 require "sequel"
@@ -98,6 +99,10 @@ module Gemstash
       File.join(base_path, path)
     end
 
+    def atomic_write(file, &block)
+      File.atomic_write(file, File.dirname(file), &block)
+    end
+
     def rackup
       File.expand_path("../config.ru", __FILE__)
     end

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

@@ -0,0 +1,50 @@
+.\" Automatically generated by Pandoc 1.16.0.2
+.\"
+.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[]
+.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[], \f[C]yank\f[], and
+\f[C]unyank\f[].
+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\ unyank\ \-\-key\ <secure\-key>
+gemstash\ authorize\ \-\-remove\ \-\-key\ <secure\-key>
+\f[]
+.fi
+.SH OPTIONS
+.IP \[bu] 2
+\f[C]\-\-config\-file\ FILE\f[]: Specify the config file to use.
+If you aren\[aq]t using the default config file at
+\f[C]~/.gemstash/config.yml\f[], then you must specify the config file
+via this option.
+.IP \[bu] 2
+\f[C]\-\-key\ SECURE_KEY\f[]: 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[] 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[]: Remove an authorization rather than add or update
+one.
+When removing, permission values are not allowed.
+The \f[C]\-\-key\ <secure\-key>\f[] option is required.

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

@@ -0,0 +1,45 @@
+gemstash-authorize(1)					 gemstash-authorize(1)
+
+
+
+NAME
+       gemstash-authorize  -  Adds  or	removes authorization to interact with
+       privately stored gems
+
+SYNOPSIS
+       gemstash authorize [permissions] [--remove] [--key SECURE_KEY] [--con-
+       fig-file FILE]
+
+DESCRIPTION
+       Adds or removes authorization to interact with privately stored gems.
+
+       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 fu-
+       ture versions of Gemstash).
+
+   USAGE
+	      gemstash authorize
+	      gemstash authorize push yank
+	      gemstash authorize yank unyank --key <secure-key>
+	      gemstash authorize --remove --key <secure-key>
+
+OPTIONS
+       o --config-file FILE: 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.
+
+       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,133 @@
+.\" Automatically generated by Pandoc 1.16.0.2
+.\"
+.TH "gemstash\-configuration" "5" "October 13, 2015" "" ""
+.hy
+.SH NAME
+.PP
+gemstash\-configuration
+.SH SYNOPSIS
+.IP
+.nf
+\f[C]
+#\ ~/.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
+\f[]
+.fi
+.SH BASE PATH
+.PP
+\f[C]:base_path\f[]
+.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[] via
+\f[C]gemstash\ setup\f[] (gemstash help setup.1) will create the
+directory for you.
+.SS DEFAULT VALUE
+.PP
+\f[C]~/.gemstash\f[]
+.SS VALID VALUES
+.PP
+Any valid path
+.SH CACHE TYPE
+.PP
+\f[C]:cache_type\f[]
+.PP
+Specifies how to cache values other than gem files (such as gem
+dependencies).
+\f[C]memory\f[] will use an in memory cache while \f[C]memcached\f[]
+will point to 1 or more Memcached servers.
+Use the \f[C]:memcached_servers\f[] configuration key for specifying
+where the Memcached server(s) are.
+.SS DEFAULT VALUE
+.PP
+\f[C]memory\f[]
+.SS VALID VALUES
+.PP
+\f[C]memory\f[], \f[C]memcached\f[]
+.SH MEMCACHED SERVERS
+.PP
+\f[C]:memcached_servers\f[]
+.PP
+Specifies the Memcached servers to connect to when using
+\f[C]memcached\f[] for the \f[C]:cache_type\f[].
+Only used when \f[C]memcached\f[] is used for \f[C]:cache_type\f[].
+.SS DEFAULT VALUE
+.PP
+\f[C]localhost:11211\f[]
+.SS VALID VALUES
+.PP
+A comma delimited list of Memcached servers
+.SH DB ADAPTER
+.PP
+\f[C]:db_adapter\f[]
+.PP
+Specifies what database adapter to use.
+When \f[C]sqlite3\f[] is used, the database will be located at
+\f[C]gemstash.db\f[] within the directory specified by
+\f[C]:base_path\f[].
+The database will automatically be created when using \f[C]sqlite3\f[].
+When \f[C]postgres\f[] is used, the database to connect to must be
+specified in the \f[C]:db_url\f[] configuration key.
+The database must already be created when using \f[C]postgres\f[].
+.SS DEFAULT VALUE
+.PP
+\f[C]sqlite3\f[]
+.SS VALID VALUES
+.PP
+\f[C]sqlite3\f[], \f[C]postgres\f[]
+.SH DB URL
+.PP
+\f[C]:db_url\f[]
+.PP
+Specifies the database to connect to when using \f[C]postgres\f[] for
+the \f[C]:db_adapter\f[].
+Only used when \f[C]postgres\f[] is used for \f[C]:db_adapter\f[].
+.SS DEFAULT VALUE
+.PP
+None
+.SS VALID VALUES
+.PP
+A valid database URL for the Sequel gem (http://sequel.jeremyevans.net/)
+.SH RUBYGEMS URL
+.PP
+\f[C]:rubygems_url\f[]
+.PP
+Specifies the default gem source URL.
+When any API endpoint is called without a \f[C]/private\f[] or
+\f[C]/upstream/<url>\f[] 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[]
+.SS VALID VALUES
+.PP
+A valid gem source URL
+.SH BIND ADDRESS
+.PP
+\f[C]:bind\f[]
+.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[]
+.SS VALID VALUES
+.PP
+Any valid binding that is supported by
+Puma (https://github.com/puma/puma#binding-tcp--sockets)

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

@@ -0,0 +1,121 @@
+gemstash-configuration(5)			     gemstash-configuration(5)
+
+
+
+NAME
+       gemstash-configuration
+
+SYNOPSIS
+	      # ~/.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
+       :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
+       (gemstash help setup.1) will create the directory for you.
+
+   DEFAULT VALUE
+       ~/.gemstash
+
+   VALID VALUES
+       Any valid path
+
+CACHE TYPE
+       :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.
+
+   DEFAULT VALUE
+       memory
+
+   VALID VALUES
+       memory, memcached
+
+MEMCACHED SERVERS
+       :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.
+
+   DEFAULT VALUE
+       localhost:11211
+
+   VALID VALUES
+       A comma delimited list of Memcached servers
+
+DB ADAPTER
+       :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  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.
+
+   DEFAULT VALUE
+       sqlite3
+
+   VALID VALUES
+       sqlite3, postgres
+
+DB URL
+       :db_url
+
+       Specifies  the  database  to  connect  to  when	using postgres for the
+       :db_adapter.  Only used when postgres is used for :db_adapter.
+
+   DEFAULT VALUE
+       None
+
+   VALID VALUES
+       A  valid  database  URL	for  the  Sequel  gem  (http://sequel.jeremye-
+       vans.net/)
+
+RUBYGEMS URL
+       :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.
+
+   DEFAULT VALUE
+       https://rubygems.org
+
+   VALID VALUES
+       A valid gem source URL
+
+BIND ADDRESS
+       :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.
+
+   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)
+
+
+
+			       October 13, 2015      gemstash-configuration(5)