resr 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 02dd19b9cdaacb6853c5b08314058dc6e718b9f2
-  data.tar.gz: a1ed6da592e72632ce23c6e691d47b2454092be4
+  metadata.gz: 9b314612ca9de094798f43a67f908a64675b460a
+  data.tar.gz: fc9c46d9e780bd68d6525c94e36e85bf8ba0ee9d
 SHA512:
-  metadata.gz: 17a40603be86d7716aa49493a057936fdbf791d09d4e7d09ca912a0afdc9602bcb1b88a17418e0f68ffa66c45d45d81928eedd543ddddc28a0e4b93448be0972
-  data.tar.gz: e2f467ae630937c97cf80770d4c6d8ce2e930faff01f839b998115d11e32833a416d8e3ce3cb946750abc51144d1cf18025184caded5096b56976f8a4cf3bfbf
+  metadata.gz: ebdea240a22f9f2e5220ff7349b3ac55d8b39722b46440b20e7c92644a348f29b4b227c59bfbea6e4e8bdbd6a2acd995134f7a735da040a0b8d8ae42ddd32344
+  data.tar.gz: db8fe21c8d39df309b95e848054ffe2a029416e5794c6e41b7c604dc74b1d8a65c8c81a7664e2819cdd41aae35fcf2f9adbad125c7cc2f91296b4217a84b7a86

data/.gitignore

@@ -13,3 +13,4 @@
 *.gem
 .rspec_status
 .tags
+.resr.yml

data/README.md

@@ -1,22 +1,28 @@
 # Resr
 
-A ridiculous way soft-managing ownership of staging servers, using Slack and channel topics for state.
+A ridiculously simple way of managing soft-ownership of staging servers using Slack and channel topics for state.
 
 ## Installation
 
     $ gem install resr
-    
+
 ## Setup
 
-Copy the following to `~/.resr.yml`, and adjust as necessary.
+### Generate a legacy token in Slack
+
+Visit the [Slack Legacy tokens](https://api.slack.com/custom-integrations/legacy-tokens) page and generate a token for your Workspace/User.
+
+### Configure resr
+
+Copy the following to `~/.resr.yml`, and add the token that was generated in the previous section.
 
 ```yml
-slack_token: [YOUR_OAUTH_SLACK_TOKEN]
+slack_token: 'YOUR_LEGACY_SLACK_TOKEN'
 
 channels:
-  dev-deploy-io:         # Your slack channel name
-    io: ':flag-io:'      # Mapping between the server console name and how 
-    cat: ':cat2:'        # it is represented in Slack. In this case, 
+  dev-deploy-io:         # Your Slack channel that manages state
+    io: ':flag-io:'      # Mapping between the server console name and how
+    cat: ':cat2:'        # it is represented in Slack. In this case,
     dog: ':trashdog:'    # as emoji.
 
   dev-deploys:
@@ -27,11 +33,12 @@ channels:
 ## Usage
 
     Commands:
-      resr free SERVER     # Free/release ownership of the SERVER
-      resr help [COMMAND]  # Describe available commands or one specific command
-      resr list            # List all servers and who owns them
-      resr take SERVER     # Take ownership of the SERVER
-      
+      resr --version, -v       # Display the current version
+      resr free SERVER         # Free/release ownership of the SERVER
+      resr help [COMMAND]      # Describe available commands or one specific command
+      resr list                # List all servers and who owns them
+      resr take SERVER [DESC]  # Take ownership of the SERVER and set an optional description
+
 The command options `free`, `list`, and `take` are aliased as `f`, `l`, and `t` respectively.
 
 ## Development

data/lib/resr.rb

@@ -4,6 +4,8 @@ require 'slack'
 require 'yaml'
 
 module Resr
+  DEFAULT_CONFIG = '.resr.yml'.freeze
+
   def self.list
     channels
   end
@@ -20,8 +22,34 @@ module Resr
     channel.save
   end
 
+  def self.config
+    @config ||= YAML::load_file(config_file_location)
+  end
+
   private
 
+  def self.config_file_location
+    if ENV['RESR_CONFIG']
+      expanded_file_location = File.absolute_path(ENV['RESR_CONFIG'])
+
+      if File.file?(expanded_file_location)
+        return expanded_file_location
+      else
+        raise "Resr config not found at #{expanded_file_location}"
+      end
+    end
+
+    config_file =
+      case
+      when File.file?(DEFAULT_CONFIG)
+        DEFAULT_CONFIG
+      when File.file?(File.join(Dir.home, DEFAULT_CONFIG))
+        File.join(Dir.home, DEFAULT_CONFIG)
+      else
+        raise 'Resr config has not been found.'
+      end
+  end
+
   def self.channels
     @channels ||= config.dig('channels').map { |name, mappings| State.new(name, mappings, slack_client) }
   end
@@ -30,9 +58,6 @@ module Resr
     config.fetch('slack_token')
   end
 
-  def self.config
-    @config ||= YAML::load_file(File.join(Dir.home, '.resr.yml'))
-  end
 
   def self.slack_client
     @slack_client ||=

data/lib/resr/cli.rb

@@ -3,18 +3,36 @@ require "resr"
 
 module Resr
   class CLI < Thor
+    map %w[--version -v] => :__print_version
 
-    desc 'take SERVER', 'Take ownership of the SERVER'
+    desc 'take SERVER [DESC]', 'Take ownership of the SERVER and set an optional description'
+    long_desc <<-LONGDESC
+      `resr free SERVER` will reserve SERVER using the current git branch name
+
+      `resr free SERVER 'custom desc'` will reserve SERVER using 'custom desc'
+    LONGDESC
     option aliases: :t
     def take(server, details = nil)
       details = `git rev-parse --abbrev-ref HEAD`.chomp if details.nil?
-      say Resr.take(server, details: details)
+      response = Resr.take(server, details: details)
+
+      if response.ok?
+        say "Reserved #{server}"
+      else
+        say "Reservation failed: #{response.error}"
+      end
     end
 
     desc 'free SERVER', 'Free/release ownership of the SERVER'
     option aliases: :f
     def free(server)
-      Resr.free server
+      response = Resr.free server
+
+      if response.ok?
+        say "Released #{server}"
+      else
+        say "Release failed: #{response.error}"
+      end
     end
 
     desc 'list', 'List all servers and who owns them'
@@ -32,5 +50,10 @@ module Resr
         end
       end
     end
+
+    desc "--version, -v", "Display the current version"
+    def __print_version
+      puts Resr::VERSION
+    end
   end
 end

data/lib/resr/version.rb

@@ -1,3 +1,3 @@
 module Resr
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Aaron Rustad
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-13 00:00:00.000000000 Z
+date: 2017-10-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler