joumae 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d5ab0c54854665d91ae1ba7c7638f325fc630dbe
-  data.tar.gz: 9721b41223c894b49004bd1f84ece6ad982ebbe3
+  metadata.gz: 5d1c747df9f623727c13160a5717d41f3aa0393d
+  data.tar.gz: 5a5a8885e10c261ff9a0c9bc7cfcedc1a00ae1f4
 SHA512:
-  metadata.gz: f3a9d53966637570389ec1812f4965e7c34cd4515dbd3eb1dda93109e0f53acdea497e41a07ed98fd7b5c7a79db83e3d6cd8de062889c6a08328a49eb7c5c3a5
-  data.tar.gz: 7a092e0fc7531f07d55d3ba81f8498ed3bd1d55735cade8fced13dd35f6e5e2ab41ec89c3778a91f4e7878c1f919248ca1b7725f9917f5a33048ae12bab78956
+  metadata.gz: 93c49e86d5d8c965a0092db4cfad1daf54308a4e7c822b5e2abc8a9fe0accdd2549d6f6f9a6a012b280fbe84462e757688d43f001234e95d5bd0efda30059033
+  data.tar.gz: 99491532511ca7b8c12e9ba2b9477fdf6fd50ee73b013d66dc8d014418d46acb3050f6a482629a98864fa4f0790209f9662d7e4ca452f7c95ec7ea3d76ed481c

data/.gitignore

@@ -1,2 +1,5 @@
 *~
 .env
+.envrc
+pkg/
+bin/

data/README.md

@@ -22,7 +22,22 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+### CLI
+
+The `joumae` command allows you to run arbitrary commands while locking a named resource:
+
+```
+$ joumae --resource-name your-app-servers run -- bash -c "\"echo Deployment started.; sleep 10; echo Deployment finished.\""
+```
+
+If you consecutively ran the command twice, the latter one fails because the resource is already locked.
+
+The `joumae` command requires two environment variables to be present:
+
+```
+export JOUMAE_API_ENDPOINT="https://yourid.execute-api.ap-northeast-1.amazonaws.com/yourstage/"
+export JOUMAE_API_KEY="eyJ0eXAiOiJKV1QiLCJhbGc..."
+```
 
 ## Development
 

data/exe/joumae

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'joumae/cli'
+Joumae::CLI.run!

data/integration_test.rb

@@ -7,14 +7,20 @@ client = Joumae::Client.create
 
 uuid = SecureRandom.uuid
 p client.create(uuid)
-p client.acquire(uuid, 'test')
-p client.renew(uuid, 'tet')
-p client.release(uuid, 'test')
+p client.acquire(uuid)
+p client.renew(uuid)
+p client.release(uuid)
 
-transaction = Joumae::Transaction.new(resource_name: uuid, owner: 'test', client: client)
+#Joumae::Command.new(resource_name: "app-development-deployment", owner: "kuoka", client: Joumae::Client.create)
+
+transaction = Joumae::Transaction.new(resource_name: uuid, client: client)
 
 transaction.start
 
 sleep 10
 
 transaction.finish
+
+command = Joumae::Command.new("sleep 10", resource_name: uuid, client: client)
+
+command.run!

data/lib/joumae/cli.rb

@@ -0,0 +1,50 @@
+require 'optparse'
+
+require 'joumae'
+require "joumae/logging"
+
+module Joumae
+  class CLI
+    include Logging
+
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def parse!
+      argv = @argv.dup
+
+      opt = OptionParser.new
+      opt.on('--resource-name VALUE') { |v| @resource_name = v }
+      opt.parse!(argv)
+      @sub, *@args= argv
+      debug [@sub, @args]
+    end
+
+    def run!
+      parse!
+
+      case @sub
+      when "run"
+        client = Joumae::Client.create
+        cmd = @args.join(" ")
+        command = Joumae::Command.new(cmd, resource_name: @resource_name, client: client)
+        begin
+          command.run!
+        rescue Joumae::CommandFailedError => e
+          $stderr.puts "#{e.message} Aborting."
+          exit e.status
+        rescue Joumae::Client::ResourceAlreadyLockedError => e
+          $stderr.puts "#{e.message} Aborting."
+          exit 1
+        end
+      else
+        fail "The sub-command #{@sub} does not exist."
+      end
+    end
+
+    def self.run!
+      new(ARGV).run!
+    end
+  end
+end

data/lib/joumae/client.rb

@@ -20,21 +20,21 @@ module Joumae
       post_json(resources_url, {api_key: api_key, name: name})
     end
 
-    def acquire(name, acquired_by)
-      post_json(acquire_resource_url, {api_key: api_key, name: name, acquiredBy: acquired_by})
+    def acquire(name)
+      post_json(acquire_resource_url(name), {api_key: api_key})
     end
 
-    def renew(name, acquired_by)
-      post_json(renew_resource_url, {api_key: api_key, name: name, acquired_by: acquired_by})
+    def renew(name)
+      post_json(renew_resource_url(name), {api_key: api_key})
     end
 
-    def release(name, acquired_by)
-      post_json(release_resource_url, {api_key: api_key, name: name, acquired_by: acquired_by})
+    def release(name)
+      post_json(release_resource_url(name), {api_key: api_key})
     end
 
     def post_json(url, params={})
       begin
-        logger.info "POST #{url} #{params.to_json}"
+        debug "POST #{url} #{params.to_json}"
         request = Net::HTTP::Post.new(url.path, {'Content-Type' =>'application/json'})
         request.body = params.to_json
         https = Net::HTTP.new(url.hostname, 443)
@@ -45,11 +45,17 @@ module Joumae
         # response = httpclient.post_content(url, params.to_json, header: {'Content-Type' => 'application/json'})
 
         if response.code == '404'
-          fail "Not found."
+          fail ResourceNotFoundError, "Not found."
+        elsif response.code == '423'
+          response_body_as_json = JSON.parse(response.body)
+          raise ResourceAlreadyLockedError, response_body_as_json["message"]
         elsif response.code != '200'
-          fail "Unexpected status: #{response.code}"
+          fail UnexpectedError, "Unexpected status: #{response.code}"
         end
 
+        debug "Code: #{response.code}"
+        debug "Result: #{response.body}"
+
         response_body = JSON.parse(response.body)
         response_body
       rescue => e
@@ -62,24 +68,44 @@ module Joumae
       URI.parse("#{api_endpoint}/resources")
     end
 
-    def acquire_resource_url
-      URI.parse("#{api_endpoint}/resources/acquire")
+    def acquire_resource_url(name)
+      URI.parse("#{api_endpoint}/resources/#{name}/lock/acquire")
+    end
+
+    def renew_resource_url(name)
+      URI.parse("#{api_endpoint}/resources/#{name}/lock/renew")
     end
 
-    def renew_resource_url
-      URI.parse("#{api_endpoint}/resources/renew")
+    def release_resource_url(name)
+      URI.parse("#{api_endpoint}/resources/#{name}/lock/release")
     end
 
-    def release_resource_url
-      URI.parse("#{api_endpoint}/resources/release")
+    protected
+
+    def debug(msg)
+      logger.debug msg
     end
 
+    private
+
     def httpclient
       @httpclient ||= HTTPClient.new
     end
 
     def logger
-      @logger ||= Logger.new(STDOUT)
+      @logger ||= Logger.new(STDOUT).tap do |logger|
+        log_level_from_env = ENV['JOUMAE_LOG_LEVEL'] || 'INFO'
+        logger.level = Logger.const_get(log_level_from_env)
+      end
+    end
+
+    class ResourceAlreadyLockedError < StandardError
+    end
+
+    class ResourceNotFoundError < StandardError
+    end
+
+    class UnexpectedError < StandardError
     end
   end
 end

data/lib/joumae/command.rb

@@ -0,0 +1,57 @@
+require 'joumae/transaction'
+require 'joumae/client'
+require "joumae/command_failed_error"
+require 'open3'
+
+module Joumae
+  class Command
+    attr_reader :cmd
+
+    def initialize(cmd, resource_name:, client:)
+      @cmd = cmd
+      @resource_name = resource_name
+      @client = client
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT).tap do |logger|
+        log_level_from_env = ENV['JOUMAE_LOG_LEVEL'] || 'INFO'
+        logger.level = Logger.const_get(log_level_from_env)
+        logger.formatter = proc do |severity, datetime, progname, msg|
+          date_format = datetime.strftime("%Y-%m-%d %H:%M:%S")
+          "#{cmd} (#{severity}): #{msg}\n"
+        end
+      end
+    end
+
+    def run!
+      status = Joumae::Transaction.run!(resource_name: @resource_name, client: @client) do
+        Open3.popen3("bash") do |i, o, e, w|
+          i.write cmd
+          i.close
+          o.each do |line| puts line end
+          e.each do |line| $stderr.puts line end
+
+          debug w.value
+
+          w.value.exitstatus
+        end
+      end
+      raise Joumae::CommandFailedError.new("Exit status(=#{status}) is non-zero.", status) if status != 0
+    end
+
+    private
+
+    def info(msg)
+      logger.info msg
+    end
+
+    def warn(msg)
+      logger.warn msg
+    end
+
+    def debug(msg)
+      logger.debug msg
+    end
+  end
+end

data/lib/joumae/command_failed_error.rb

@@ -0,0 +1,10 @@
+module Joumae
+  class CommandFailedError < StandardError
+    attr_reader :status
+
+    def initialize(msg, status)
+      super(msg)
+      @status = status
+    end
+  end
+end

data/lib/joumae/logging.rb

@@ -0,0 +1,24 @@
+module Joumae
+  module Logging
+    protected
+
+    def info(msg)
+      logger.info msg
+    end
+
+    def warn(msg)
+      logger.warn msg
+    end
+
+    def debug(msg)
+      logger.debug msg
+    end
+
+    def logger
+      @logger ||= Logger.new(STDOUT).tap do |logger|
+        log_level_from_env = ENV['JOUMAE_LOG_LEVEL'] || 'INFO'
+        logger.level = Logger.const_get(log_level_from_env)
+      end
+    end
+  end
+end

data/lib/joumae/transaction.rb

@@ -1,15 +1,14 @@
 module Joumae
   class Transaction
-    def initialize(resource_name:, owner:, client:, renew_interval: 1)
+    def initialize(resource_name:, client:, renew_interval: 1)
       @resource_name = resource_name
-      @owner = owner
       @client = client
       @renew_interval = renew_interval
       @finished = false
     end
 
     def start
-      @client.acquire(@resource_name, @owner)
+      @client.acquire(@resource_name)
 
       start_thread
     end
@@ -20,8 +19,8 @@ module Joumae
       @thread = Thread.start {
         loop do
           sleep @renew_interval
-          exit if finished?
-          @client.renew(@resource_name, @owner)
+          @thread.exit if finished?
+          @client.renew(@resource_name)
         end
       }
     end
@@ -34,11 +33,21 @@ module Joumae
 
     def finish
       stop_thread
-      @client.release(@resource_name, @owner)
+      @client.release(@resource_name)
     end
 
     def finished?
       @finished
     end
+
+    def self.run!(resource_name:, client:, &block)
+      t = new(resource_name: resource_name, client: client)
+      t.start
+      begin
+        block.call
+      ensure
+        t.finish
+      end
+    end
   end
 end

data/lib/joumae/version.rb

@@ -1,3 +1,3 @@
 module Joumae
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/lib/joumae.rb

@@ -1,6 +1,7 @@
 require "joumae/version"
 require "joumae/client"
 require "joumae/transaction"
+require "joumae/command"
 
 module Joumae
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: joumae
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Yusuke KUOKA
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-05 00:00:00.000000000 Z
+date: 2015-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -55,7 +55,8 @@ dependencies:
 description: A Ruby client library for the Joumae lock service.
 email:
 - yusuke.kuoka@crowdworks.co.jp
-executables: []
+executables:
+- joumae
 extensions: []
 extra_rdoc_files: []
 files:
@@ -68,10 +69,15 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- exe/joumae
 - integration_test.rb
 - joumae.gemspec
 - lib/joumae.rb
+- lib/joumae/cli.rb
 - lib/joumae/client.rb
+- lib/joumae/command.rb
+- lib/joumae/command_failed_error.rb
+- lib/joumae/logging.rb
 - lib/joumae/transaction.rb
 - lib/joumae/version.rb
 homepage: https://github.com/crowdworks/joumae-ruby