icwot 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de385402f1226360527fe24047fdcdfa43e07a73
-  data.tar.gz: adc408b40362093aa3e0f84dca6cf197d220b25f
+  metadata.gz: 87d7b6e4a3a0b5d5f5310815f6d62dcbb8a7dc68
+  data.tar.gz: 5e45269940885f14aa76296bad21d25bb1834ddb
 SHA512:
-  metadata.gz: baaa83c802c66bae4cfd6f7c8634fe33f90612fa1b2d867d29aad973f9edc17b512562450b9d61b48dbec75d748fd910ed21f5ddc763924167db6823617a37ee
-  data.tar.gz: d464c39e9cab1905e59f923be7f5874a2960b264e014899530ffa34d67b4e22a57338cadb1ddb5a8eac8a626be3fc8441e31891d1cf675375df20f32db5a8b59
+  metadata.gz: 8dcc6a75b177ba34fc434cce1a795b9b323fca4131ae72d65ff2fc13138cc081ab6265d67d85e69750cc30e84b488583f6077be99fbcecf422c2ce173dd407aa
+  data.tar.gz: d564062c6af2afd3f34256e7320b0cdc407cb5821dc886be51c19b84cf191a0ef66c5f562111ce9e7a25334103424787ed26fb99ffe4546484b909f3ca5b48cb

data/bin/icwot

@@ -6,123 +6,26 @@ require 'socket'
 require 'timeout'
 require 'rest-client'
 require 'json'
+require 'icwot'
+require 'icwot/client'
+require 'icwot/console'
 
-# determine if a port is used or not
-# from http://stackoverflow.com/questions/517219/ruby-see-if-a-port-is-open
-def self.is_port_open?(ip, port)
-  begin
-    Timeout::timeout(1) do
-      begin
-        s = TCPSocket.new(ip, port)
-        s.close
-        return true
-      rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
-        return false
-      end
-    end
-  rescue Timeout::Error
-  end
-  return false
-end
-
-class Client
-  attr_accessor :uri, :content_type
-
-  def initialize
-    @content_type = 'application/json'
-  end
-
-  def to_xml
-    "<client xmlns=\"http://jaxb.xwot.first.ch.unifr.diuf\"><uri>#{uri}</uri></client>"
-  end
-
-  def to_hash
-    {uri: uri}
-  end
+console = Console.new
 
-  # inspired by http://stackoverflow.com/questions/11897269/get-own-ip-address
-  def get_ip
-    ip=Socket.ip_address_list.detect{|intf| intf.ipv4_private?}
-    ip ? ip.ip_address : '127.0.0.1'
-  end
-
-  def to_s
-    case content_type
-      when 'application/json'
-        to_hash.to_json
-      when 'application/xml'
-        to_xml
-    end
-  end
-end
-
-if ARGV.empty?
-  puts 'you need to provide at least one argument! See icwot -h'
+unless console.parse
+  puts console.errors
   exit 0
 end
-produces = 'application/json'
-accept = 'application/json'
-port = 4567
-host = ''
-protocol = 'http://'
-log_path = ''
-ARGV.each_with_index do |a, index|
-  case a
-    when '-h'
-      puts 'Usage : icwot <host>
-            -h print help
-            -l the host is localhost
-            -c the content-type value for the header application/json by default
-            -a the accept value for the header  text/plain by default
-            -p the port where to run the server
-            -t the protocol to use http:// by default
-            -l where to save the log. By default your-home-directory/log/icwot-{port}-msg.log
-            host is where to register for the service.
-            '
-      exit 0
-    when '-l'
-      host='localhost'
-    when '-c'
-      produces = ARGV.delete_at index + 1
-    when '-a'
-      accept = ARGV.delete_at index + 1
-    when '-p'
-      port = ARGV.delete_at(index + 1).to_i
-    when '-t'
-      unless (temp = ARGV.delete_at(index + 1)).nil?
-        protocol = temp
-      end
-    when '-l'
-      log_path = ARGV.delete_at index + 1
-    else
-      host += a
-  end
-end
 
-if host == ''
-  puts 'Host must be set !'
-  exit 0
-end
-
-if port == 0
-  puts 'The port must be bigger than 0'
-  exit 0
-end
-
-if is_port_open?('localhost', port)
+if Icwot.is_port_open?('localhost', console.port)
   puts 'Port already in use ! Try another one.'
   exit 0
 end
 
-client = Client.new
-client.uri = "http://#{client.get_ip}:#{port}/"
-client.content_type = produces
+client = Client.new(port: console.port, content_type: console.produces)
 
-response = RestClient.post protocol+host, client.to_s, accept: accept, content_type: produces
+RestClient.post console.url, client.to_s, console.header
 
-unless response.code == 200
-  puts 'Error. Connection not establish with the server.'
-  exit 0
-end
+#TODO handle exception from RestClient
 
-`sinatra_port=#{port} sinatra_log=#{log_path} bundle exec ruby lib/icwot.rb -e production -p #{port}`
+Icwot.run(console.port, console.log_path)

data/icwot.gemspec

@@ -5,7 +5,7 @@ require 'icwot/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "icwot"
-  spec.version       = Icwot::VERSION
+  spec.version       = Icwot::version
   spec.authors       = ["leo"]
   spec.email         = ["facenord.sud@gmail.com"]
   spec.description   = %q{icwot : RESTfull sinatra server providing inversion of control for logging messages from another web-server}

data/lib/icwot/client.rb

@@ -0,0 +1,38 @@
+class Client
+  attr_accessor :uri, :content_type, :port
+
+  def initialize(options = {})
+    @content_type = options[:content_type] || 'application/json'
+    @uri = options[:uri]
+    @port = options[:port]
+  end
+
+  def uri
+    @uri.nil? ? "http://#{get_ip}:#{port}" : @uri
+  end
+
+  def to_s
+    case content_type
+      when 'application/json'
+        to_hash.to_json
+      when 'application/xml'
+        to_xml
+    end
+  end
+
+  protected
+
+  def to_xml
+    "<client xmlns=\"http://jaxb.xwot.first.ch.unifr.diuf\"><uri>#{uri}</uri></client>"
+  end
+
+  def to_hash
+    {uri: uri}
+  end
+
+  # inspired by http://stackoverflow.com/questions/11897269/get-own-ip-address
+  def get_ip
+    ip=Socket.ip_address_list.detect{|intf| intf.ipv4_private?}
+    ip ? ip.ip_address : '127.0.0.1'
+  end
+end

data/lib/icwot/console.rb

@@ -0,0 +1,77 @@
+class Console
+
+  attr_reader :produces, :accept, :port, :host, :protocol, :log_path, :errors
+
+  def initialize
+    @produces = 'application/json'
+    @accept = 'application/json'
+    @port = 4567
+    @host = ''
+    @protocol = 'http://'
+    @log_path = ''
+    @errors = ''
+  end
+
+  def parse
+    if ARGV.empty?
+      @errors = 'you need to provide at least one argument! See icwot -h'
+      return false
+    end
+    ARGV.each_with_index do |a, index|
+      case a
+        when '-h'
+          puts 'Usage : icwot <host>
+              -h print help
+              -l the host is localhost
+              -c the content-type value for the header application/json by default
+              -a the accept value for the header  text/plain by default
+              -p the port where to run the server
+              -t the protocol to use http:// by default
+              -l where to save the log. By default your-home-directory/log/icwot-{port}-msg.log
+              host is where to register for the service.
+              '
+          exit 0
+        when '-l'
+          @host='localhost'
+        when '-c'
+          @produces = ARGV.delete_at index + 1
+        when '-a'
+          @accept = ARGV.delete_at index + 1
+        when '-p'
+          @port = ARGV.delete_at(index + 1).to_i
+        when '-t'
+          unless (temp = ARGV.delete_at(index + 1)).nil?
+            @protocol = temp
+          end
+        when '-l'
+          @log_path = ARGV.delete_at index + 1
+        else
+          @host += a
+      end
+    end
+    validate
+  end
+
+  def url
+    protocol+host
+  end
+
+  def header
+    {accept: accept, content_type: produces}
+  end
+
+  private
+
+  def validate
+    if @host == ''
+      @errors=('Host must be set !')
+      return false
+    end
+
+    if @port == 0
+      @errors = 'The port must be bigger than 0'
+      return false
+    end
+    true
+  end
+end

data/lib/icwot/server_client.rb

@@ -0,0 +1,56 @@
+require 'sinatra/base'
+
+class ServerClient < Sinatra::Base
+
+  # Si le fichier log/msg.log n'existe pas, on le créé, sinon on l'ouvre
+  def self.create_or_open_log
+    file_name = "icwot-#{settings.port}-msg.log"
+    directory_path = "#{Dir.home}/log/"
+    Dir.mkdir(directory_path) unless File.exists?(directory_path)
+    file = (settings.log_path.nil? || !File.exist?(settings.log_path) ? File.new(directory_path+file_name, 'a+') : File.new(settings.log_path))
+    file.sync = true
+    file
+  end
+
+  configure do
+    set :log_path, nil
+
+    set :environment, :production
+
+    enable :logging
+    # We put the log level to info
+    set :logger_level, :info
+    # The logger is at the location log/msg.log
+    set :logger_log_file, lambda { create_or_open_log }
+  end
+
+  # POST sur / avec le port par défaut 4567
+  post '/' do
+    content_type 'text/plain'
+    # On enregistre dans un log spécial le body de la requête
+    msg.info request.body.read
+    logger.info "message saved to #{self.class.logger_log_file.path}"
+    # On retourne le code http 200 avec le texte 'ok'
+    'ok'
+  end
+
+  helpers do
+    # logger personalisé pour enregistrer les réponses du body
+    def msg
+      @logger ||= begin
+        @logger = ::Logger.new(self.class.logger_log_file)
+        @logger.level = ::Logger.const_get((self.class.logger_level || :warn).to_s.upcase)
+        @logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+        @logger.formatter = proc do |serverity, time, progname, msg|
+          # le format est de la sorte:
+          #
+          # 2013-12-12 00:00:00
+          # "message body"
+
+          "#{time} :\n\"#{msg}\"\n\n"
+        end
+        @logger
+      end
+    end
+  end
+end

data/lib/icwot/version.rb

@@ -1,3 +1,5 @@
 module Icwot
-  VERSION = '0.1.1'
+  def self.version
+    '0.2.0'
+  end
 end

data/lib/icwot.rb

@@ -1,51 +1,31 @@
 require "icwot/version"
-require 'sinatra'
+require 'icwot/server_client'
 
-configure do
-  # We put the log level to info
-  set :logger_level, :info
-  # The logger is at the location log/msg.log
-  set :logger_log_file, lambda { create_or_open_log }
-end
-
-# POST sur / avec le port 4567
-post '/' do
-  content_type 'text/plain'
-  # On enregistre dans un log spécial le body de la requête
-  msg.info request.body.read
-  logger.info "message saved to #{self.class.logger_log_file.path}"
-  # On retourne le code http 200 avec le texte 'ok'
-  'ok'
-end
-
-helpers do
-  # logger personalisé pour enregistrer les réponses du body
-  def msg
-    @logger ||= begin
-      @logger = ::Logger.new(self.class.logger_log_file)
-      @logger.level = ::Logger.const_get((self.class.logger_level || :warn).to_s.upcase)
-      @logger.datetime_format = "%Y-%m-%d %H:%M:%S"
-      @logger.formatter = proc do |serverity, time, progname, msg|
-        # le format et de la sorte:
-        #
-        # 2013-12-12 00:00:00
-        # "message body"
+module Icwot
+  def self.run(port, log_path)
+    app = ServerClient.new
+    app.settings.port = port
+    app.settings.log_path = log_path
+    app.settings.run!
+  end
 
-        "#{time} :\n\"#{msg}\"\n\n"
+  # determine if a port is used or not
+  # from http://stackoverflow.com/questions/517219/ruby-see-if-a-port-is-open
+  def self.is_port_open?(ip, port)
+    begin
+      Timeout::timeout(1) do
+        begin
+          s = TCPSocket.new(ip, port)
+          s.close
+          return true
+        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+          return false
+        end
       end
-      @logger
+    rescue Timeout::Error
     end
+    return false
   end
 end
 
-private
 
-# Si le fichier log/msg.log n'existe pas, on le créé, sinon on l'ouvre
-def create_or_open_log
-  file_name = "icwot-#{ENV['sinatra_port']}-msg.log"
-  directory_path = "#{Dir.home}/log/"
-  Dir.mkdir(directory_path) unless File.exists?(directory_path)
-  file = ((log_path = ENV['sinatra_log']) == '' && !File.exist?(log_path) ? File.new(directory_path+file_name, 'a+') : File.new(ENV['sinatra_log']))
-  file.sync = true
-  file
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: icwot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - leo
@@ -107,10 +107,12 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/icwot
 - icwot.gemspec
 - lib/icwot.rb
+- lib/icwot/client.rb
+- lib/icwot/console.rb
+- lib/icwot/server_client.rb
 - lib/icwot/version.rb
 homepage: https://github.com/facenord-sud/icwot
 licenses:

data/Rakefile

@@ -1 +0,0 @@
-require "bundler/gem_tasks"