Prepare for gem push to rubygems.org

Author: Gopal Adhikari

README.md

@@ -1,38 +1,85 @@
-# Argonaut
+# Argonaut CLI
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/argonaut`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Use Argonaut from your command line!
 
 ## Installation
 
-Add this line to your application's Gemfile:
-
 ```ruby
-gem 'argonaut'
+gem install argonaut-cli
 ```
 
-And then execute:
+Create the config file `~/.argonaut.yml` and populate it with the sample config below:
+
+```yaml
+# The only required fields for the gem to run are api_token and url_root
 
-    $ bundle
+api_token: YOUR_TOKEN
+url_root: https://theargonaut-api.herokuapp.com
 
-Or install it yourself as:
+# Below are the optional settings to customize output
+
+options:
+  colorize_rows: true
+  time_format: '%d %b %Y %l:%M %p'
+  high_contrast_colors: true
+```
 
-    $ gem install argonaut
+Replace `YOUR_TOKEN` in the sample config above with your own token that can be found in the Profile page in the web app.
+
+You can also export environment variables `ARGONAUT_API_TOKEN` and `ARGONAUT_URL_ROOT` with the correct values without needing a config file.
 
 ## Usage
 
-TODO: Write usage instructions here
+By default, invoking `argonaut` lists all your environment reservations.
+
+**View all registered teams:**
+
+```
+argonaut -T
+```
+
+**View reservations table on a particular team's environments:**
+
+Using team id
+```
+argonaut -t 1
+```
+
+Using team name
+```
+argonaut -t EPA
+```
+
+**Make a reservation:**
+
+```
+argonaut -r pbm1:epamotron
+```
+
+**Release when you are done testing in that environment:**
+
+```
+argonaut -r pbm1:epamotron
+```
+**Clear all your reservations at once**
+
+```
+argonaut -c
+```
+
+Full list of options can be viewed by running `argonaut -h`. If you are using zsh, you can generate shell completion and add it to your `~/.zshrc` like so:
+
+```
+echo compdef _gnu_generic argonaut >> ~/.zshrc
+```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/argonaut. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/qubbit/argonaut-cli/issues. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

argonaut.gemspec

@@ -1,23 +1,28 @@
 # coding: utf-8
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'argonaut/version'
 
 EMAIL_DOMAIN = 'gmail.com'
 
 Gem::Specification.new do |spec|
-  spec.name          = "argonaut"
+  spec.name          = "argonaut-cli"
   spec.version       = Argonaut::VERSION
   spec.authors       = ["Gopal Adhikari"]
   spec.email         = ["nullgeo@#{EMAIL_DOMAIN}"]
-  spec.summary       = "Gem to access Argonaut using the command line interface"
-  spec.homepage      = "https://argonaut.herokuapp.com"
+  spec.summary       = "Command line tool for Argonaut"
+  spec.description   = "This gem lets users manipulate argonaut using the command line interface"
+  spec.homepage      = "https://github.com/qubbit/argonaut-cli"
   spec.license       = "MIT"
+  spec.post_install_message = %Q{
+⚓️  Please follow instructions at #{spec.homepage} to complete the setup.
+  }
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
@@ -34,8 +39,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "pry-byebug", "~> 3.4"
-  spec.add_development_dependency "webmock", "~> 3.0.1"
+  spec.add_development_dependency 'webmock', '~> 3.0', '>= 3.0.1'
 
-  spec.add_dependency "httparty"
-  spec.add_dependency "terminal-table"
+  spec.add_runtime_dependency 'httparty', '~> 0.15.6'
+  spec.add_runtime_dependency 'terminal-table', '~> 1.8', '>= 1.8.0'
 end

bin/argonaut exe/argonautbin/argonaut renamed to exe/argonaut

@@ -2,7 +2,6 @@
 
 THIS_FILE = File.symlink?(__FILE__) ? File.readlink(__FILE__) : __FILE__
 
-require 'pry'
 begin
   require File.dirname(THIS_FILE) + '/../lib/argonaut'
 rescue LoadError
@@ -13,7 +12,7 @@ require 'optparse'
 
 # By default show user's reservations if no arguments are supplied
 options = { action: 'list_reservations' }
-options.merge! Argonaut::Settings.config[:options]
+options.merge! Argonaut::Settings.config.fetch(:options, {})
 
 begin
   OptionParser.new do |opts|

lib/argonaut.rb

@@ -41,7 +41,7 @@ def self.exec(options)
   require 'terminal-table'
 
   def self.format_date_time(json_time)
-    Time.parse(json_time).strftime(@options.time_format || '%d %b %Y %l:%M %p')
+    Time.parse(json_time).getlocal.strftime(@options.time_format || '%d %b %Y %l:%M %p')
   end
 
   def self.print_teams(teams_hash)
@@ -109,11 +109,17 @@ def self.print_status(status_hash)
     puts table
   end
 
-  @colors               = [122, 141, 153, 163, 172, 178, 183, 186, 223]
-  @high_contrast_colors = [122, 141, 153, 163, 172, 178, 183, 186, 223]
+  def self.colors
+    @colors ||= if @options.high_contrast_colors
+      # high contrast colors are based on solarized: http://ethanschoonover.com/solarized
+      [136, 166, 160, 125, 61, 33, 37, 64]
+    else
+      [122, 141, 153, 163, 172, 178, 183, 186, 223]
+    end
+  end
 
   def self.color(index)
-    @colors[index % @colors.length]
+    colors[index % colors.length]
   end
 
   def self.colorize_row(row, index)

lib/argonaut/constants.rb

@@ -1,5 +1,10 @@
 module Argonaut
   class Constants
-    SETTINGS_FILE = "#{Dir.home}/.argonaut.yml"
+    SETTINGS_FILE             = "#{Dir.home}/.argonaut.yml".freeze
+    PROJECT_GITHUB_URL        = 'https://github.com/qubbit/argonaut-cli'.freeze
+    PROJECT_README            = "#{PROJECT_GITHUB_URL}/blob/master/README.md".freeze
+    NO_CONFIG_ERROR_MESSAGE   = 'Could not load settings file ~/.argonaut.yml'.freeze
+    NO_URL_ROOT_ERROR_MESSAGE = "URL root for Argonaut is not set. Refer to #{PROJECT_README} for instructions on how to set it up.".freeze
+    NO_API_TOKEN_ERROR_MESSAGE = "API token for Argonaut is not set. Refer to #{PROJECT_README} for instructions on how to set it up.".freeze
   end
 end

lib/argonaut/exceptions.rb

@@ -1,4 +1,4 @@
-require_relative './exceptions'
+require_relative './constants'
 require 'httparty'
 require 'uri'
 
@@ -7,7 +7,8 @@ class Gateway
 
     attr_reader :api_token
     attr_reader :url_root
-    ERROR_MESSAGE = 'Could not load settings file ~/.argonaut.yml'.freeze
+
+    C = Argonaut::Constants
 
     # Initializes the HTTP gateway to connect to argonaut's API endpoint
     # The consumer of this API can supply an API token and
@@ -27,6 +28,16 @@ def initialize(api_token:, url_root:)
       else
         @url_root = url_root
       end
+
+      if @url_root.nil?
+        $stderr.puts C::NO_URL_ROOT_ERROR_MESSAGE
+        exit(2)
+      end
+
+      if @api_token.nil?
+        $stderr.puts C::NO_API_TOKEN_ERROR_MESSAGE
+        exit(2)
+      end
     end
 
     def config
@@ -43,16 +54,10 @@ def config
         'url_root'  => ENV['ARGONAUT_URL_ROOT']
       }
 
-      if ENV['ARGONAUT_API_TOKEN'].nil?
-        raise Argonaut::Exceptions::InvalidConfigurationError.new ERROR_MESSAGE
-      end
-
-      if ENV['ARGONAUT_URL_ROOT'].nil?
-        raise Argonaut::Exceptions::InvalidConfigurationError.new ERROR_MESSAGE
+      if ENV['ARGONAUT_API_TOKEN'].nil? || ENV['ARGONAUT_URL_ROOT'].nil?
+        $stderr.puts C::NO_CONFIG_ERROR_MESSAGE
+        exit(2)
       end
-    rescue Argonaut::Exceptions::InvalidConfigurationError => ice
-      puts ice.message
-      exit(2)
     end
 
     def url_from_path(path)
@@ -105,7 +110,7 @@ def post(path:, data:)
     end
 
     def self.load_config_from_file
-      YAML.load_file("#{Dir.home}/.argonaut.yml")
+      YAML.load_file(C::SETTINGS_FILE)
     rescue
       nil
     end

lib/argonaut/gateway.rb

@@ -1,19 +1,29 @@
+require_relative './constants'
+
 module Argonaut
   class Settings
     def self.config
       @config ||= read_config
     end
 
-    private_class_method
+    class << self
 
-    def self.read_config
-      YAML.load_file("#{Dir.home}/.argonaut.yml").with_indifferent_access
-    rescue
-      { options: {
-          colorize_rows: true,
-          time_format: '%d %b %Y %l:%M %p'
+      def read_config
+        deep_symbolize(YAML.load_file(Argonaut::Constants::SETTINGS_FILE))
+      rescue Errno::ENOENT
+        { options: {
+            colorize_rows: true,
+            time_format: '%d %b %Y %l:%M %p'
+          }
         }
-      }
+      end
+
+      def deep_symbolize(obj)
+        return obj.inject({}){|memo,(k,v)| memo[k.to_sym] =  deep_symbolize(v); memo} if obj.is_a? Hash
+        return obj.inject([]){|memo,v| memo << deep_symbolize(v); memo} if obj.is_a? Array
+        return obj
+      end
+
     end
   end
 end

lib/argonaut/settings.rb

@@ -1,3 +1,3 @@
 module Argonaut
-  VERSION = "0.1.0"
+  VERSION = "0.1.6"
 end