gemstash 2.1.0 → 2.2.0

data/lib/gemstash/man/gemstash-readme.7.txt

@@ -1,182 +1 @@
-gemstash-readme(7)					    gemstash-readme(7)
 
-
-
-1mGEMSTASH0m
-   1mWHAT IS GEMSTASH?0m
-       Gemstash	   is	 both	a   cache   for	  remote   servers   such   as
-       https://rubygems.org, and a private gem source.
-
-       If you are using bundler (http://bundler.io/) across many machines that
-       have access to a server within your control, you might want to use Gem-
-       stash.
-
-       If you produce gems that you don't want everyone in the world  to  have
-       access to, you might want to use Gemstash.
-
-       If you frequently bundle the same set of gems across multiple projects,
-       you might want to use Gemstash.
-
-       Are you only using gems from https://rubygems.org, and don't bundle the
-       same gems frequently?  Well, maybe you don't need Gemstash... yet.
-
-       Gemstash	 is maintained by Ruby Together (https://rubytogether.org/), a
-       grassroots initiative committed to supporting the critical Ruby	infra-
-       structure   you	 rely	on.    Contribute   today   as	an  individual
-       (https://rubytogether.org/developers) or	 even  better,	as  a  company
-       (https://rubytogether.org/companies),	and   ensure   that   Bundler,
-       RubyGems, Gemstash, and other shared tooling is	around	for  years  to
-       come.
-
-   1mQUICKSTART GUIDE0m
-   1mSETUP0m
-       Gemstash	 is  designed  to be quick and painless to get set up.	By the
-       end of this Quickstart Guide, you will be able to bundle	 stashed  gems
-       from public sources against a Gemstash server running on your machine.
-
-       Install Gemstash to get started:
-
-	      $ gem install gemstash
-
-       After  it is installed, starting Gemstash requires no additional steps.
-       Simply start the Gemstash server with the gemstash command:
-
-	      $ gemstash start
-
-       You may have noticed that the command finished quickly.	 This  is  be-
-       cause  Gemstash	will run the server in the background by default.  The
-       server runs on port 9292.
-
-   1mBUNDLING0m
-       With the server running, you can bundle against it.  Tell Bundler  that
-       you want to use Gemstash to find gems from RubyGems.org:
-
-	      $ bundle config mirror.https://rubygems.org http://localhost:9292
-
-       Now you can create a Gemfile and install gems through Gemstash:
-
-	      # ./Gemfile
-	      source "https://rubygems.org"
-	      gem "rubywarrior"
-
-       The  gems you include should be gems you don't yet have installed, oth-
-       erwise Gemstash will have nothing to stash.  Now bundle:
-
-	      $ bundle install --path .bundle
-
-       Your Gemstash server has fetched the gems from https://rubygems.org and
-       cached  them for you! To prove this, you can disable your Internet con-
-       nection and try again.  Gem files (*.gem) are cached indefinitely.  Gem
-       dependencies metadata are cached for 30 minutes, so if you bundle again
-       before that, you can successfully bundle without	 an  Internet  connec-
-       tion:
-
-	      $ # Disable your Internet first!
-	      $ rm -rf Gemfile.lock .bundle
-	      $ bundle
-
-   1mFALLING BACK TO RUBYGEMS.ORG0m
-       If  you	want to make sure that your bundling from https://rubygems.org
-       still works as expected when the Gemstash server is  not	 running,  you
-       can easily configure Bundler to fallback to https://rubygems.org.
-
-	      $ bundle config mirror.https://rubygems.org.fallback_timeout true
-
-       You can also configure this fallback as a number of seconds in case the
-       Gemstash server is simply unresponsive.	This example uses a  3	second
-       timeout:
-
-	      $ bundle config mirror.https://rubygems.org.fallback_timeout 3
-
-   1mSTOPPING THE SERVER0m
-       Once  you've finish using your Gemstash server, you can stop it just as
-       easily as you started it:
-
-	      $ gemstash stop
-
-       You'll also want to tell Bundler that it can go back  to	 getting  gems
-       from RubyGems.org directly, instead of going through Gemstash:
-
-	      $ bundle config --delete mirror.https://rubygems.org
-
-   1mUNDER THE HOOD0m
-       You might wonder where the gems are stored.  After running the commands
-       above, you will find a new directory at	~/.gemstash.   This  directory
-       holds  all  the cached and private gems.	 It also has a server log, the
-       database, and configuration for Gemstash.  If you prefer, you can point
-       to a different directory (gemstash help customize.7).
-
-       Gemstash	 uses  SQLite (https://www.sqlite.org/) to store details about
-       private gems.  The database will be located in ~/.gemstash, however you
-       won't  see  the database appear until you start using private gems.  If
-       you prefer, you can use a different  database  (gemstash	 help  custom-
-       ize.7).
-
-       Gemstash	 temporarily  caches  things  like gem dependencies in memory.
-       Anything cached in memory will last for 30  minutes  before  being  re-
-       trieved	again.	 You can use memcached (gemstash help customize.7) in-
-       stead of caching in memory.  Gem files are always  cached  permanently,
-       so  bundling  with  a Gemfile.lock with all gems cached will never call
-       out to https://rubygems.org.
-
-       The server you ran is provided  via  Puma  (http://puma.io/)  and  Rack
-       (http://rack.github.io/),  however  they	 are  not customizable at this
-       point.
-
-   1mDEEP DIVE0m
-       Deep dive into more subjects:
-
-       o Private gems (gemstash help private-gems.7)
-
-       o Multiple gem sources (gemstash help multiple-sources.7)
-
-       o Using Gemstash as a mirror (gemstash help mirror.7)
-
-       o Customizing the server (database, storage, caching, and  more)	 (gem-
-	 stash help customize.7)
-
-       o Deploying Gemstash (gemstash help deploy.7)
-
-       o Debugging Gemstash (gemstash help debugging.7)
-
-   1mREFERENCE0m
-       An anatomy of various configuration and commands:
-
-       o Configuration (gemstash help configuration.5)
-
-       o Authorize (gemstash help authorize.1)
-
-       o Start (gemstash help start.1)
-
-       o Stop (gemstash help stop.1)
-
-       o Status (gemstash help status.1)
-
-       o Setup (gemstash help setup.1)
-
-       o Version (gemstash help version.1)
-
-       To  see	what  has  changed  in	recent	versions  of Gemstash, see the
-       CHANGELOG    (https://github.com/rubygems/gemstash/blob/master/CHANGEL-
-       OG.md).
-
-   1mDEVELOPMENT0m
-       After  checking	out  the  repo, run bin/setup to install dependencies.
-       Then, run rake to run RuboCop and the tests.  While developing, you can
-       run  bin/gemstash to run Gemstash.  You can also run bin/console for an
-       interactive prompt that will allow you to experiment.
-
-   1mCONTRIBUTING0m
-       Bug  reports   and   pull   requests   are   welcome   on   GitHub   at
-       https://github.com/rubygems/gemstash.  This project is intended to be a
-       safe, welcoming space for collaboration, and contributors are  expected
-       to adhere to the Contributor Covenant (https://github.com/rubygems/gem-
-       stash/blob/master/CODE_OF_CONDUCT.md) code of conduct.
-
-   1mLICENSE0m
-       The gem is available as open source under the terms of the MIT  License
-       (http://opensource.org/licenses/MIT).
-
-
-
-			       November 30, 2015	    gemstash-readme(7)

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

@@ -1,40 +1 @@
-gemstash-setup(1)					     gemstash-setup(1)
 
-
-
-1mNAME0m
-       gemstash-setup - Customize your Gemstash configuration interactively
-
-1mSYNOPSIS0m
-       gemstash setup [--redo] [--debug] [--config-file FILE]
-
-1mDESCRIPTION0m
-       Customize  your	Gemstash  configuration interactively.	This will save
-       your config file, but only if a few checks pass after  you've  provided
-       your answers.
-
-   1mUSAGE0m
-	      gemstash setup
-	      gemstash setup --redo
-	      gemstash setup --config-file <file>
-
-1mOPTIONS0m
-       o --redo:  Redo	the  configuration.   This does nothing the first time
-	 gemstash setup is run.	 If you want to change your configuration  us-
-	 ing  gemstash setup after you've run it before, you must provide this
-	 option, otherwise Gemstash will simply indicate your  setup  is  com-
-	 plete.
-
-       o --debug:  Output  additional  information if one of the checks at the
-	 end of setup fails.  This will do nothing if all checks pass.
-
-       o --config-file FILE: Specify the config file  to  write	 to.   Without
-	 this  option,	your configuration will be written to ~/.gemstash/con-
-	 fig.yml.  If you write to a custom location, you will	need  to  pass
-	 the  --config-file  option  to all Gemstash commands.	If you plan to
-	 use ERB in your config file (gemstash help  customize.7),  you	 might
-	 want to use ~/.gemstash/config.yml.erb.
-
-
-
-				October 9, 2015		     gemstash-setup(1)

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

@@ -1,26 +1 @@
-gemstash-start(1)					     gemstash-start(1)
 
-
-
-1mNAME0m
-       gemstash-start - Starts the Gemstash server
-
-1mSYNOPSIS0m
-       gemstash start [--no-daemonize] [--config-file FILE]
-
-1mDESCRIPTION0m
-       Starts the Gemstash server.
-
-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 --no-daemonize: 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.
-
-
-
-				October 9, 2015		     gemstash-start(1)

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

@@ -1,22 +1 @@
-gemstash-status(1)					    gemstash-status(1)
 
-
-
-1mNAME0m
-       gemstash-status - Checks status of the Gemstash server
-
-1mSYNOPSIS0m
-       gemstash status [--config-file FILE]
-
-1mDESCRIPTION0m
-       Checks status of the Gemstash server.
-
-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.
-
-
-
-			       October 28, 2015		    gemstash-status(1)

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

@@ -1,22 +1 @@
-gemstash-stop(1)					      gemstash-stop(1)
 
-
-
-1mNAME0m
-       gemstash-stop - Stops the Gemstash server
-
-1mSYNOPSIS0m
-       gemstash stop [--config-file FILE]
-
-1mDESCRIPTION0m
-       Stops the Gemstash server.
-
-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.
-
-
-
-				October 9, 2015		      gemstash-stop(1)

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

@@ -1,21 +1 @@
-gemstash-version(1)					   gemstash-version(1)
 
-
-
-1mNAME0m
-       gemstash-version - Show what version of Gemstash you are using
-
-1mSYNOPSIS0m
-       gemstash version
-
-1mDESCRIPTION0m
-       Show what version of Gemstash you are using.
-
-   1mUSAGE0m
-	      gemstash version
-	      gemstash --version
-	      gemstash -v
-
-
-
-			       December 14, 2015	   gemstash-version(1)

data/lib/gemstash/storage.rb

@@ -68,7 +68,7 @@ module Gemstash
         end
       end
 
-      YAML.load_file(file)
+      YAML.safe_load_file(file, permitted_classes: [Symbol])
     end
 
   private
@@ -94,6 +94,7 @@ module Gemstash
     include Gemstash::Env::Helper
     include Gemstash::Logging
     attr_reader :name, :folder
+
     VERSION = 1
 
     # If the storage engine detects a resource was originally saved from a newer
@@ -195,7 +196,7 @@ module Gemstash
     # @param props [Hash] the properties to add
     # @return [Gemstash::Resource] self for chaining purposes
     def update_properties(props)
-      load_properties(true)
+      load_properties(force: true)
 
       deep_merge = proc do |_, old_value, new_value|
         if old_value.is_a?(Hash) && new_value.is_a?(Hash)
@@ -276,11 +277,11 @@ module Gemstash
       @content[key] = read_file(content_filename(key))
     end
 
-    def load_properties(force = false)
+    def load_properties(force: false)
       return if @properties && !force
       return unless File.exist?(properties_filename)
 
-      @properties = YAML.load_file(properties_filename) || {}
+      @properties = YAML.safe_load_file(properties_filename, permitted_classes: [Symbol]) || {}
       check_resource_version
     end
 

data/lib/gemstash/upstream.rb

@@ -1,10 +1,11 @@
 # frozen_string_literal: true
 
 require "digest"
+require "forwardable"
 require "uri"
 
 module Gemstash
-  #:nodoc:
+  # :nodoc:
   class Upstream
     extend Forwardable
 
@@ -15,7 +16,7 @@ module Gemstash
     def initialize(upstream, user_agent: nil)
       @uri = URI(CGI.unescape(upstream.to_s))
       @user_agent = user_agent
-      raise "URL '#{@uri}' is not valid!" unless @uri.to_s =~ URI::DEFAULT_PARSER.make_regexp
+      raise "URL '#{@uri}' is not valid!" unless @uri.to_s&.match?(URI::DEFAULT_PARSER.make_regexp)
     end
 
     def url(path = nil, params = nil)
@@ -23,7 +24,7 @@ module Gemstash
 
       unless path.to_s.empty?
         base = "#{base}/" unless base.end_with?("/")
-        path = path[1..-1] if path.to_s.start_with?("/")
+        path = path[1..] if path.to_s.start_with?("/")
       end
 
       params = "?#{params}" if !params.nil? && !params.empty?
@@ -31,7 +32,7 @@ module Gemstash
     end
 
     def auth?
-      !user.to_s.empty? && !password.to_s.empty?
+      !user.to_s.empty? || !password.to_s.empty?
     end
 
     # Utilized as the parent directory for cached gems
@@ -45,7 +46,7 @@ module Gemstash
       Digest::MD5.hexdigest(to_s)
     end
 
-    #:nodoc:
+    # :nodoc:
     class GemName
       def initialize(upstream, gem_name)
         @upstream = upstream

data/lib/gemstash/version.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-#:nodoc:
+# :nodoc:
 module Gemstash
-  VERSION = "2.1.0"
+  VERSION = "2.2.0"
 end

data/lib/gemstash/web.rb

@@ -5,11 +5,13 @@ require "json"
 require "gemstash"
 
 module Gemstash
-  #:nodoc:
+  # :nodoc:
   class Web < Sinatra::Base
-    def initialize(gemstash_env: nil, http_client_builder: nil)
-      @gemstash_env = gemstash_env || Gemstash::Env.new
-      @http_client_builder = http_client_builder || Gemstash::HTTPClient
+    ruby2_keywords def initialize(options = {})
+      raise ArgumentError unless options.is_a?(Hash)
+
+      @gemstash_env = options[:gemstash_env] || Gemstash::Env.new
+      @http_client_builder = options[:http_client_builder] || Gemstash::HTTPClient
       Gemstash::Env.current = @gemstash_env
       super()
     end

data/lib/gemstash.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-#:nodoc:
+# :nodoc:
 module Gemstash
   autoload :ApiKeyAuthorization, "gemstash/api_key_authorization"
   autoload :Authorization,       "gemstash/authorization"