rct 0.3 → 0.5

data/bin/rct

@@ -1,6 +1,6 @@
-#!/usr/bin/env jruby
+#!/usr/bin/env ruby
 #
-#  Copyright 2012 Jyri J. Virkki <jyri@virkki.com>
+#  Copyright 2012-2013 Jyri J. Virkki <jyri@virkki.com>
 #
 #  This file is part of rct.
 #
@@ -26,16 +26,7 @@
 # 
 
 require 'rct'
-
-# A few globals:
-$HTTP = RCTHTTP.new()
-$STATE = State.new()
-
-# Set some defaults:
-RCT.sset(RCT_MODE, RCT_MODE_CLI)
-RCT.sset(SERVER_PROTOCOL, 'http')
-RCT.sset(SERVER_HOSTNAME, 'localhost')
-RCT.sset(SERVER_PORT, '80')
+require 'rct/rct_init'
 
 RCT.parse_global_options()
 

data/lib/rct/baseutils.rb

@@ -19,7 +19,7 @@
 
 
 #-----------------------------------------------------------------------------
-# Assorted utility methods. TODO: cleanup
+# Assorted utility methods of general interest. TODO: cleanup
 #
 class RCT
 
@@ -87,6 +87,12 @@ class RCT
   end
 
 
+  # define global options (from parse_global_options) so can do error chacking
+  $GLOBAL_OPTS = {
+    '-t' => 1, '--test' => 1, '--req' => 1, '-h' => 1, '--host' => 1,
+    '-p' => 1, '--port' => 1, '-v' => 1
+  }
+
   def self.parse_global_options
     pos = 0
 
@@ -138,6 +144,10 @@ class RCT
   def self.parse_options(opts, required)
     return if opts == nil
     opts.each { |key, info|
+      if ($GLOBAL_OPTS[info[0]] == 1 || $GLOBAL_OPTS[info[1]] == 1)
+        bad_invocation("Error in CLI definition: #{info[0]}|#{info[1]} " +
+                       "conflicts with global options!")
+      end
       value = get_opt(info)
       if (required && value == nil)
         bad_invocation("Required argument #{info[0]}|#{info[1]} has no value!")

data/lib/rct/constants.rb

@@ -17,7 +17,7 @@
 #  along with rct.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-RCT_VERSION = '0.3'
+RCT_VERSION = '0.5'
 
 RCT_MODE = '_mode'
 RCT_MODE_CLI = 'cli'
@@ -45,4 +45,5 @@ RESULT = 1
 INFO = 2
 DEBUG = 3
 
+CLI_OUTPUT = '_cli_output'
 

data/lib/rct/rct_cli.rb

@@ -25,6 +25,10 @@
 # 'cli' method which provides info about the CLI methods and their
 # arguments.
 #
+# Client methods can provide friendly output in CLI mode by setting
+# CLI_OUTPUT to the desired text. If it is not set, the raw response body
+# is shown.
+#
 class RCTCLI
 
 
@@ -63,7 +67,13 @@ class RCTCLI
     }
 
     RCT.log(INFO, response)
-    puts response.body
+    cli_output = RCT.sget(CLI_OUTPUT)
+    if (cli_output != nil)
+      puts cli_output
+    else
+      puts response
+      puts response.body
+    end
   end
 
 

data/lib/rct/rct_http.rb

@@ -19,6 +19,7 @@
 
 
 require 'httpclient'
+require 'base64'
 
 
 #------------------------------------------------------------------------------
@@ -104,7 +105,15 @@ class RCTHTTP
       if (auth == REQ_AUTH_TYPE_BASIC)
         name = RCT.sget(REQ_AUTH_NAME)
         pwd = RCT.sget(REQ_AUTH_PWD)
-        @http_client.set_auth(nil, name, pwd)
+
+        # This does not send the authorization header unless server
+        # first responds with 401, which some REST services won't do.
+        # So, instead, set header manually below.
+        # @http_client.set_auth(nil, name, pwd)
+
+        up = "#{name}:#{pwd}"
+        encoded = Base64.strict_encode64(up)
+        headers['Authorization'] = "Basic #{encoded}"
       else
         raise "Requested auth type '#{auth}' unknown"
       end
@@ -139,8 +148,8 @@ class RCTHTTP
       return response
     end
 
-    show_response(res)
     response = Response.new(res)
+    show_response(response)
     return response
   end
 
@@ -177,8 +186,9 @@ class RCTHTTP
     headers = res.headers
     if (headers != nil)
       headers.each { |k,v|
-        RCT.log(INFO, "XH: #{k}: #{v}")
+        RCT.log(INFO, "#{k}: #{v}")
       }
+      RCT.log(INFO, "")
     end
 
     RCT.log(INFO, res.body)

data/lib/rct/rct_init.rb

@@ -0,0 +1,29 @@
+#
+#  Copyright 2013 Jyri J. Virkki <jyri@virkki.com>
+#
+#  This file is part of rct.
+#
+#  rct is free software: you can redistribute it and/or modify it
+#  under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  rct is distributed in the hope that it will be useful, but
+#  WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with rct.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+
+# A few globals:
+$HTTP = RCTHTTP.new()
+$STATE = State.new()
+
+# Set some defaults:
+RCT.sset(RCT_MODE, RCT_MODE_CLI)
+RCT.sset(SERVER_PROTOCOL, 'http')
+RCT.sset(SERVER_HOSTNAME, 'localhost')
+RCT.sset(SERVER_PORT, '80')

data/lib/rct/response.rb

@@ -92,7 +92,7 @@ class Response
   #
   def headers
     return nil if @res == nil
-    return @res.header
+    return @res.headers
   end
 
 
@@ -112,7 +112,12 @@ class Response
   #
   def to_s
     return "error: #{@fail_msg}" if @res == nil
-    return "#{@res.status} #{@res.reason}"
+
+    rv = "#{@res.status} #{@res.reason}"
+    if (@fail_msg != nil)
+      rv += " (#{@fail_msg})"
+    end
+    return rv
   end
 
 

data/lib/rct_cli_app.rb

@@ -0,0 +1,24 @@
+#
+#  Copyright 2013 Jyri J. Virkki <jyri@virkki.com>
+#
+#  This file is part of rct.
+#
+#  rct is free software: you can redistribute it and/or modify it
+#  under the terms of the GNU General Public License as published by
+#  the Free Software Foundation, either version 3 of the License, or
+#  (at your option) any later version.
+#
+#  rct is distributed in the hope that it will be useful, but
+#  WITHOUT ANY WARRANTY; without even the implied warranty of
+#  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+#  General Public License for more details.
+#
+#  You should have received a copy of the GNU General Public License
+#  along with rct.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+
+# CLI scripts built on top of rct can require this file to initialize rct.
+
+require 'rct'
+require 'rct/rct_init'

data/lib/rct_client.rb

@@ -20,6 +20,7 @@
 
 require 'securerandom'
 require 'json'
+require 'cgi'
 
 
 #------------------------------------------------------------------------------
@@ -40,11 +41,12 @@ class RCTClient
       return params
     end
 
+    val = CGI.escape(value)
     if (params == nil || params.empty?)
-      return "?#{name}=#{value}"
+      return "?#{name}=#{val}"
     end
 
-    return "#{params}&#{name}=#{value}"
+    return "#{params}&#{name}=#{val}"
   end
 
 
@@ -121,4 +123,14 @@ class RCTClient
   end
 
 
+  #----------------------------------------------------------------------------
+  # Convenience function, returns true if we're running in CLI mode.
+  #
+  def is_cli
+    mode = sget(RCT_MODE)
+    return true if (mode == RCT_MODE_CLI)
+    false
+  end
+
+
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rct
 version: !ruby/object:Gem::Version
-  prerelease:
-  version: '0.3'
+  version: '0.5'
+  prerelease: 
 platform: ruby
 authors:
 - Jyri J. Virkki
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-11 00:00:00.000000000 Z
+date: 2013-12-28 00:00:00.000000000 Z
 dependencies: []
 description: wip
 email: jyri@virkki.com
@@ -18,40 +18,40 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/rct.rb
 - lib/rct/baseutils.rb
-- lib/rct/rct_cli.rb
-- lib/rct/constants.rb
-- lib/rct/state.rb
-- lib/rct/response.rb
+- lib/rct/rct_init.rb
 - lib/rct/rct_http.rb
+- lib/rct/response.rb
+- lib/rct/state.rb
+- lib/rct/constants.rb
+- lib/rct/rct_cli.rb
 - lib/rct_client.rb
-- lib/rct.rb
+- lib/rct_cli_app.rb
 - bin/rct
 homepage: https://github.com/jvirkki/rct
 licenses:
 - GPLv3
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 requirements: []
 rubyforge_project: nowarning
-rubygems_version: 1.8.24
-signing_key:
+rubygems_version: 1.8.23
+signing_key: 
 specification_version: 3
 summary: rct
 test_files: []