belphanior-servant 0.0.3

data/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/lib/belphanior/servant/belphanior_servant_helper.rb

@@ -0,0 +1,5 @@
+module BelphaniorServantHelper
+  def self.text_out_as_json(text_representation, status=200)
+    [status, {"Content-Type" => "application/json"}, text_representation]
+  end
+end

data/lib/belphanior/servant/role_builder.rb

@@ -0,0 +1,146 @@
+# Copyright 2012 Mark T. Tomczak
+
+require 'json'
+require 'sinatra/base'
+require 'belphanior/servant/belphanior_servant_helper'
+
+module RoleBuilderUtils
+  # converts Belphanior-style "$(arg)" arguments to Sinatra-style
+  # ":arg" specifiers
+  def self.usage_string_to_sinatra_path(usage)
+    output = ""
+    usage.split("$").each { |substring|
+      if substring[0,1]=="("
+        substring[0]=":"
+        remainder_array = substring.split(")")
+
+        output += (substring.split(")").join)
+      else
+        output += substring
+      end
+    }
+    output
+  end
+  def self.arguments_and_path_to_sinatra_path(arguments, path)
+    arguments.each { |arg|
+      path = path.sub("$("+arg+")", ":"+identifier_to_url_component(arg))
+    }
+    path
+  end
+  def self.is_valid_identifier?(identifier)
+    identifier =~ /^[a-zA-Z][a-zA-Z0-9 ]*$/
+  end
+  def self.normalize_identifier(identifier)
+    identifier.downcase
+  end
+  def self.identifier_to_url_component(identifier)
+    identifier.gsub(/ /,"_").downcase
+  end
+end
+
+module Sinatra
+
+  module RoleDescriber
+    class BadParameterException < Exception
+    end
+
+    # Adds a new role description. Note: this is a VERY quick-and-dirty hack;
+    # the added description isn't vetted for format conformance at all.
+    def add_role_description(description)
+      if not RoleBuilderUtils::is_valid_identifier?(description["name"])
+        raise BadParameterException, "Role name was not a valid identifier."
+      end
+      name_as_identifier = RoleBuilderUtils::identifier_to_url_component(description["name"])
+      description_local_url = "/role_descriptions/" + name_as_identifier
+      description_as_json = JSON.generate description
+      get description_local_url do
+        BelphaniorServantHelper.text_out_as_json(description_as_json)
+      end
+      role_index = implementation["roles"].length
+      implementation["roles"] << {
+        "role_url" => "",
+        "handlers" => []
+      }
+
+      if implementation["roles"][role_index]["role_url"] == "" then
+        implementation["roles"][role_index]["role_url"] = (
+          "/role_descriptions/" + name_as_identifier)
+      end
+    end
+  end
+
+  register RoleDescriber
+
+  module RoleBuilder
+    class BadParameterException < Exception
+    end
+
+    def self.empty_handlers
+      {
+        "roles" => [
+        ]
+      }
+    end
+
+    def self.registered(app)
+      app.set :implementation, Sinatra::RoleBuilder.empty_handlers
+      app.get '/protocol' do
+        BelphaniorServantHelper.text_out_as_json(JSON.dump(app.implementation))
+      end
+
+    end
+
+    # Sets the implementation's URL
+    def set_role_url(url, role_index=0)
+        implementation["roles"][role_index]["role_url"]=url
+    end
+
+    # Adds a handler at the specified URL
+    #
+    # params are
+    # - command_name: The identifier for the command this handler implements.
+    # - argument_names: The identifiers for the arguments. The command block will receive the arguments in the same order.
+    # - http_method: HTTP access method, one of "GET", "POST", etc.
+    # - path: The path for the HTTP request (including arguments specified in $(argument name) format).
+    # - data: If a POST method, the data that should be sent (including arguments specified in $(argument name) format).
+    # - role_index: Which role this handler should be mapped into. Assumes the role already has a description.
+    def add_handler(command_name, argument_names, http_method, path, data, role_index=0, &blk)
+      # validate name, args, and method
+      if not RoleBuilderUtils::is_valid_identifier? command_name
+        raise BadParameterException, (command_name + " is not a valid command name.")
+      end
+      argument_names.each { |i|
+        if not RoleBuilderUtils::is_valid_identifier? i
+          raise BadParameterException, (i + " is not a valid argument name.")
+        end
+      }
+      if not ["GET", "POST", "PUT", "DELETE"].include? http_method
+        raise BadParameterException, (http_method + " is not a valid HTTP method (is it capitalized?)")
+      end
+
+      new_handler = {
+        "name" => RoleBuilderUtils::normalize_identifier(command_name),
+        "method" => http_method,
+        "path" => path,
+        "data" => data
+      }
+
+      implementation["roles"][role_index]["handlers"] << new_handler
+
+      # Add the method that will execute for this handler
+      sinatra_path = RoleBuilderUtils::arguments_and_path_to_sinatra_path(argument_names, path)
+      if http_method == "GET"
+        get(sinatra_path, &blk)
+      elsif http_method == "POST"
+        post(sinatra_path, &blk)
+      else
+        raise BadParameterException, ("Unknown HTTP method '" + http_method + "'.")
+      end
+      def clear_handlers
+        # Resets the handler list.
+        set :implementation, Sinatra::RoleBuilder.empty_handlers
+      end
+    end
+  end
+  register RoleBuilder
+end

data/lib/belphanior/servant/servant.rb

@@ -0,0 +1,59 @@
+require 'rubygems'
+require 'ftools'
+require 'optparse'
+require 'belphanior/servant/servant_config'
+require 'belphanior/servant/role_builder'
+require 'sinatra/base'
+
+module Sinatra
+  module Servant
+    def self.registered(app)
+      if ENV.has_key? "BELPHANIOR_CONFIG_FILE"
+        app.set :servant_config_file, ENV["BELPHANIOR_CONFIG_FILE"]
+      end
+    end
+
+    def servant_init
+      load_servant_config
+      # readonly because changing them involves rebooting the server, so the
+      # change cannot be honored.
+      servant_config.set_readonly "bind"
+      servant_config.set_readonly "port"
+
+      set :bind, servant_config.get("bind")
+      set :port, servant_config.get("port")
+
+      # To simplify functionality, we make every request handle synchronously.
+      enable :lock
+
+      # default handler for top-level index. A user-defined top-level index
+      # created before servant.init is called would override this.
+      get '/' do
+        server_name = servant_config.get("server_name") || "<TODO: set name>"
+        <<EOF
+<html>
+  <head>
+  <title>Belphanior Servant: #{server_name}</title>
+  </head>
+  <body>
+    <h1>Belphanior Servant Online</h1>
+    <h2>#{server_name}</h2>
+    <p>Hello! I am #{server_name}, and I am happy to serve you.</p>
+    <p>To learn more about what I can do, check my
+       <a href="/protocol">protocol</a>.</p>
+    <p>Want to know my settings? Check my <a href="/config">config</a>.
+  </body>
+EOF
+      end
+    end
+  end
+  register Servant
+end
+
+# To add commands, use the following style:
+# add_command(
+#            :name => "test",
+#            :description => "Test command.",
+#            :arguments => [["test arg 1"], ["test arg 2","test description"]],
+#            :return => "None.",
+#            :usage => ["GET", "/hi/everybody", ""])

data/lib/belphanior/servant/servant_config.rb

@@ -0,0 +1,68 @@
+require 'sinatra/base'
+require 'belphanior/servant/servant_config_db'
+require 'belphanior/servant/belphanior_servant_helper'
+
+module ServantConfigHelper
+  DEFAULT_CONFIG_PATH = "servant_config"
+  def self.prepare_config_file(file_path, config)
+    if File.exist? file_path
+      config_file = File.open(file_path, 'r')
+      new_config = ServantConfigDb.new(config_file.read)
+      config_file.close
+      return new_config
+    else
+      write_config_file(file_path, config)
+      return config
+    end
+  end
+  # Helper function: Tags a text object as a JSON-type
+  def self.write_config_file(file_path, config)
+    out = File.open(file_path, "w")
+    out.write(config.to_json)
+    out.close
+  end
+end
+
+module Sinatra
+  module ServantConfig
+    def self.registered(app)
+      app.set :servant_config_file, ServantConfigHelper::DEFAULT_CONFIG_PATH
+      app.set :servant_config_db, ServantConfigDb.new(
+<<EOF
+  {
+    "ip":"127.0.0.1",
+    "port": "80"
+  }
+EOF
+      )
+      
+      app.get '/config' do
+        BelphaniorServantHelper.text_out_as_json(settings.servant_config_db.to_json)
+      end
+
+      app.get '/config/:name' do
+        [200, settings.servant_config_db.get(params[:name])]
+      end
+
+      app.post '/config/:name' do
+        old_value = settings.servant_config_db.get(params[:name])
+        begin
+          settings.servant_config_db.set(params[:name], request.body.read)
+          ServantConfigHelper.write_config_file(
+            settings.servant_config_file, settings.servant_config_db)
+          return [200, old_value]
+        rescue ServantConfigException => e
+          return [500, "Could not write config: #{e}"]
+        end
+      end
+    end
+    def load_servant_config
+      set(:servant_config_db, ServantConfigHelper.prepare_config_file(
+        servant_config_file, servant_config_db))
+    end
+    def servant_config
+      servant_config_db
+    end
+  end
+  register ServantConfig
+end

data/lib/belphanior/servant/servant_config_db.rb

@@ -0,0 +1,58 @@
+# Configuration management library
+# Manages key-value pair configurations and their serialization to JSON
+# keys and values are strings
+
+require 'json'
+
+class ServantConfigException < RuntimeError
+end
+
+class ServantConfigDb
+  def initialize(json_string)
+    @config = JSON.parse(json_string)
+    # validation: @config is a hash, keys are strings, vals are strings
+    if (@config.class != {}.class)
+      raise ServantConfigException, 
+      "ServantConfig error: JSON string did not evaluate to an object",
+      caller
+    end
+    @config.each{|key, value|
+      if (value.class != "".class)
+        raise ServantConfigException,
+        ("ServantConfig error: JSON initialization string, "+
+         "value for key '#{key}' is type '#{value.class}'"),
+        caller
+      end
+    }
+    @config.default ""
+    @readonly = []
+  end
+
+  def to_json
+    JSON.dump(@config)
+  end
+
+  def get(key)
+    @config[key]
+  end
+
+  def set(key, value)
+    key = key.to_s
+    value = value.to_s
+    if @readonly.include? key
+      raise ServantConfigException,
+      "Attempted to change read-only property '#{key}'",
+      caller
+    end
+    @config[key]=value
+  end
+
+  def is_readonly(key)
+    @readonly.include? key
+  end
+
+  def set_readonly(key)
+    @readonly << key
+  end
+end
+

data/lib/belphanior/servant/test/tc_role_builder.rb

@@ -0,0 +1,170 @@
+require 'rubygems'
+require 'belphanior/servant/role_builder'
+require 'test/unit'
+require 'rack/test'
+require 'json'
+
+ENV['RACK_ENV'] = 'test'
+
+# Test helper function
+# Validates that two JSON-style objects are equivalent
+# Equivalence is defined as follows:
+#   Array type: each element equivalent
+#   Dict type: For each key |k| in reference, key in value
+#    exists and value for the key is equivalent.
+#    NOTE: This means that the input can contain
+#    additional data, and this is acceptable.
+#   All others: Simple ruby equivalence.
+def assert_equivalent_json_objects(reference, tested)
+  assert_equal(reference.class(), tested.class())
+  if reference.class() == [].class()
+    assert_equal(reference.length, tested.length)
+    for i in 0..reference.length
+      assert_equivalent_json_objects(
+        reference[i], tested[i])
+    end
+  elsif reference.class() == {}.class()
+    reference.each do |key, value|
+      assert_equal(true, tested.has_key?(key))
+      assert_equivalent_json_objects(value, tested[key])
+    end
+  else
+    # String or number (or other type): value compare
+    assert_equal(reference, tested)
+  end
+end
+
+
+class TestRoleBuilder < Test::Unit::TestCase
+  include Rack::Test::Methods
+
+  def app
+    Sinatra::Application
+  end
+
+  def setup
+    app.set :roles, []
+    @default_description = {
+      "name" => "test description",
+      "description" => "An example of a role description.",
+      "commands" => [
+        {
+          "name" => "test command",
+          "description" => "An example command.",
+          "arguments" => [
+            {
+              "name" => "test arg",
+              "description" => "An example argument."
+            }
+          ]
+        }
+      ]
+    }
+    @default_usage = [
+      "GET",
+      "/path",
+      "data"
+    ]
+  end
+
+  def teardown
+    app.clear_handlers
+  end
+
+  def test_role_describer_accepts_role_description
+    app.add_role_description @default_description
+    get '/role_descriptions/test_description'
+    assert last_response.ok?
+    assert_equal JSON.generate(@default_description), last_response.body
+  end
+
+  def test_add_handler_adds_handler
+    app.add_role_description @default_description
+    app.add_handler("test command", ["argument 1", "argument 2"],
+      "POST", "/test/$(argument 1)", "$(argument 2)") { |arg1|
+      "arg1 is "+arg1+" arg2 is "+(request.body.read)
+    }
+    post '/test/foo', 'bar'
+    assert last_response.ok?
+    assert_equal("arg1 is foo arg2 is bar", last_response.body)
+  end
+
+  def test_add_handler_updates_protocol
+    app.add_role_description @default_description
+    app.set_role_url("/test")
+    app.add_handler("test command", ["argument 1"], "GET", "/test/$(argument 1)", "") {|arg1|}
+    get '/protocol'
+    assert_equal(200, last_response.status)
+    assert_equivalent_json_objects(
+      {
+        "roles" => [{
+          "role_url" => "/test",
+          "handlers" => [{
+            "name" => "test command",
+            "method" => "GET",
+            "path" => "/test/$(argument 1)"}]
+      }]},
+      JSON.parse(last_response.body))
+  end
+
+  def test_role_builder_utils_usage_string_to_sinatra_path
+    assert_equal "/test/:value/test/:value2",
+    RoleBuilderUtils.usage_string_to_sinatra_path(
+      "/test/$(value)/test/$(value2)")
+  end
+
+  def test_identifier_case_insensitivity
+    app.add_role_description @default_description
+    app.set_role_url "/test"
+    app.add_handler("My command", ["Cap"], "GET", "path", "data") do end
+    get '/protocol'
+    assert_equal(200, last_response.status)
+    assert_equivalent_json_objects(
+      {
+        "roles" => [{
+          "role_url" => "/test",
+          "handlers" => [{
+            "name" => "my command",
+            "method" => "GET",
+            "path" => "path",
+            "data" => "data"}]
+      }]},
+      JSON.parse(last_response.body))
+  end
+  def test_multi_role
+    app.add_role_description @default_description
+    app.add_role_description({
+        "name" => "second role",
+        "description" => "An example of a role description.",
+        "commands" => [
+          {
+            "name" => "test command 2",
+            "description" => "An example command.",
+            "arguments" => [
+              {
+                "name" => "test arg b",
+                "description" => "An example argument."
+              }
+            ]
+          }
+        ]
+      }
+      )
+    app.add_handler("test command", ["test arg"],
+      "POST", "/test2/$(test arg)", "", 0) { |arg1|
+      "arg1 is " + arg1
+    }
+    app.add_handler("test command 2", ["test arg b"],
+      "GET", "/test3/$(test arg b)", "", 1) { |arg1|
+      "arg1b is " + arg1
+    }
+
+    post '/test2/foo', ""
+    assert last_response.ok?
+    assert_equal("arg1 is foo", last_response.body)
+
+    get '/test3/bar'
+    assert last_response.ok?
+    assert_equal("arg1b is bar", last_response.body)
+  end
+end

data/lib/belphanior/servant/test/tc_servant_config.rb

@@ -0,0 +1,77 @@
+require 'rubygems'
+require 'belphanior/servant/servant_config'
+require 'belphanior/servant/servant_config_db'
+require 'test/unit'
+require 'rack/test'
+require 'json'
+
+ENV['RACK_ENV'] = 'test'
+
+class TestServantConfig < Test::Unit::TestCase
+  include Rack::Test::Methods
+  SERVANT_CONFIG_FILE = Dir.tmpdir << "/tc_servant_config_out.json"
+  
+  def app
+    Sinatra::Application
+  end
+
+  def setup
+    app.set :servant_config_file, SERVANT_CONFIG_FILE
+    app.set :servant_config_db, ServantConfigDb.new(
+<<EOF
+  {
+    "ip":"127.0.0.1",
+    "port": "80"
+  }
+EOF
+    )
+    app.load_servant_config
+  end
+
+  def teardown
+    if File.exist? SERVANT_CONFIG_FILE
+      File.delete SERVANT_CONFIG_FILE
+    end
+  end
+
+  def test_config_initialize
+    validate = File.open(SERVANT_CONFIG_FILE, "r")
+    content = JSON.parse(validate.read)
+    validate.close
+    assert_equal "127.0.0.1", content["ip"]
+    assert_equal "80", content["port"]
+  end
+
+  def test_get_all_configs
+    get '/config'
+    assert_equal 200, last_response.status
+    result = JSON.parse(last_response.body)
+    assert_equal("127.0.0.1", result["ip"])
+    assert_equal("80", result["port"])
+  end
+
+  def test_get_specific_config
+    get '/config/port'
+    assert_equal 200, last_response.status
+    assert_equal "80", last_response.body
+  end
+
+  def test_write_config
+    post '/config/test', "hi"
+    assert_equal 200, last_response.status
+    get '/config/test'
+    assert_equal 200, last_response.status
+    assert_equal 'hi', last_response.body
+    assert(File.exist? SERVANT_CONFIG_FILE)
+    settings_file = File.open(app.servant_config_file, 'r')
+    result = JSON.parse(settings_file.read)
+    settings_file.close
+    assert_equal 'hi', result["test"]
+  end
+
+  def test_readonly_block
+    app.servant_config_db.set_readonly('port')
+    post '/config/port', '81'
+    assert_equal 500, last_response.status
+  end
+end

data/lib/belphanior/servant/test/tc_servant_config_db.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'json'
+require 'belphanior/servant/servant_config_db'
+require 'test/unit'
+
+class TestServantConfigDb < Test::Unit::TestCase
+  def setup
+    @config = ServantConfigDb.new(
+<<EOF
+  {
+    "ip":"127.0.0.1",
+    "port": "80"
+  }
+EOF
+    )
+  end
+  def test_initialization
+    assert_equal(@config.get("ip"),"127.0.0.1")
+    assert_equal(@config.get("port"), "80")
+  end
+  def test_serialization
+    out = JSON.parse(@config.to_json)
+    assert_equal(out.length, 2)
+    assert_equal(out["ip"],"127.0.0.1")
+    assert_equal(out["port"], "80")
+  end
+  def test_set
+    @config.set("bar","hi")
+    assert_equal(@config.get("bar"),"hi")
+    @config.set("number_of_pigs",3)
+    assert_equal(@config.get("number_of_pigs"),"3")
+  end
+  def test_readonly
+    @config.set_readonly("ip")
+    assert(@config.is_readonly("ip"), true)
+    assert_raises(ServantConfigException) {
+      @config.set("ip","127.0.0.10")
+    }
+  end
+end
+

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: belphanior-servant
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 3
+  version: 0.0.3
+platform: ruby
+authors: 
+- Mark T. Tomczak
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-10-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 6
+        - 1
+        version: 1.6.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 3
+        - 1
+        version: 1.3.1
+  type: :runtime
+  version_requirements: *id002
+description: "   Belphanior-servant is a library for creating servants using Sinatra. It is\n   a prerequesite for all such servants.\n\n   For an example of the basics of a servant, consult the examples/empty.rb file or view\n   the servants posted to GitHub (http://github.com/fixermark).\n"
+email: iam+belphanior-servant@fixermark.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- LICENSE
+- lib/belphanior/servant/belphanior_servant_helper.rb
+- lib/belphanior/servant/role_builder.rb
+- lib/belphanior/servant/servant.rb
+- lib/belphanior/servant/servant_config_db.rb
+- lib/belphanior/servant/servant_config.rb
+- lib/belphanior/servant/test/tc_servant_config.rb
+- lib/belphanior/servant/test/tc_role_builder.rb
+- lib/belphanior/servant/test/tc_servant_config_db.rb
+homepage: http://belphanior.net
+licenses: 
+- http://www.apache.org/licenses/LICENSE-2.0
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Support library for Belphanior servants written in Ruby using Sinatra.
+test_files: 
+- lib/belphanior/servant/test/tc_servant_config.rb
+- lib/belphanior/servant/test/tc_role_builder.rb
+- lib/belphanior/servant/test/tc_servant_config_db.rb