wadling 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8488952190da41b994a7b5599c984e2c9ac27a2a
+  data.tar.gz: 9bbd3bc4792a0ac1bbe9f3ff4fb748e85532a0bf
+SHA512:
+  metadata.gz: 556bf91c7e4d880a2eaaa9190fdb767fc7ba4e6b3e7488fa9058b3caa805b36d61cbedead37566876a7184fd9c7d60ab8af4b9ac54448ec9ed82b8c627aec7c5
+  data.tar.gz: 587803d1dc850756bdabb2c05fa913466f46604b97612c323d46bdb72887d3b8125511d76cc636f82ba9d5b2af5d27626d8562579896afec65173a2108095eff

data/.gitignore

@@ -0,0 +1,7 @@
+coverage
+Gemfile.lock
+*swp
+*gem
+backup
+doc
+prototype

data/.ruby-gemset

@@ -0,0 +1 @@
+smaak

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.0.0-p451

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in wadling.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ernst van Graan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,23 @@
+# Wadling
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'wadling'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install wadling
+
+## Contributing
+
+  Please send feedback and comments to the author at:
+
+  Ernst van Graan <ernst.van.graan@hetzner.co.za>
+
+  This gem is sponsored by Hetzner (Pty) Ltd - http://hetzner.co.za

data/Rakefile

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

data/lib/wadling/version.rb

@@ -0,0 +1,3 @@
+module Wadling
+  VERSION = "0.1.0"
+end

data/lib/wadling.rb

@@ -0,0 +1,123 @@
+require "wadling/version"
+require 'byebug'
+
+module Wadling
+  class LexiconTranslator
+    def translate_resources_into_wadl(resources)
+      return empty_wadl if no_resources?(resources)
+      raise ArgumentError.new("A resource dictionary is expected") if resources_invalid?(resources)
+      header + resources_base + translate_resources(resources) + resources_close + footer
+    end
+
+    def header
+      "<application xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""\
+      " xsi:schemaLocation=\"http://wadl.dev.java.net/2009/02 wadl.xsd\"" \
+      " xmlns=\"http://wadl.dev.java.net/2009/02\">"
+    end
+
+    def resources_base
+      "<resources base=\"/\">"
+    end
+
+    def resources_close
+      "</resources>"
+    end
+
+    def footer
+      "</application>"
+    end
+
+    private
+
+    def resources_invalid?(resources)
+      not resources.is_a? Hash
+    end
+
+    def translate_resources(resources)
+      entries = ""
+      resources.each do |r, v|
+        entries = translate_and_append_resource(entries, r, v)
+      end
+      entries
+    end
+
+    def translate_and_append_resource(entries, r, v)
+      entries, required = append_resource_header(entries, r, v)
+      v['params'].each do |p, vv|
+        entries = append_param(entries, required, p, vv)
+      end
+      entries = append_resource_footer(entries)
+    end
+
+    def append_resource_header(entries, r, v)
+      method, required = parse_resource(r, v)
+      entries = entries + "<resource path=\"#{r}\">"
+      entries = entries + "  <method name=\"#{method}\" id=\"#{v['id']}\">"
+      entries = entries + "    <request>"
+      entries = entries + "      <doc>"
+      entries = entries + "        #{v['doc']}"
+      entries = entries + "      </doc>"
+      return entries, required
+    end
+
+    def append_resource_footer(entries)
+      entries = entries + "    </request>"
+      entries = entries + "  </method>"
+      entries = entries + "</resource>"
+    end
+
+    def append_param(entries, required, p, vv)
+      type = parse_param(required, p, vv)
+      entries = entries + "      <param name=\"#{p}\" type=\"xsd:#{type}\" required=\"#{vv['required']}\" style=\"query\""
+      entries = entries + " default=\"#{vv['default']}\"" if vv['default']
+      entries = entries + ">      </param>"
+    end
+
+    def parse_resource(r, v)
+      raise ArgumentError.new("Invalid resource path") if r.nil?
+      raise ArgumentError.new("Resource definition invalid") if (v.nil?) or (not v.is_a?(Hash))
+      method = translate_method(v['method'])
+      raise ArgumentError.new("Resource documentation invalid") if v['doc'].nil? or not v['doc'].is_a? String
+      raise ArgumentError.new("Resource id invalid") if v['id'].nil?
+      required = translate_required(v['required'])
+      return method, required
+    end
+
+    def parse_param(required, p, vv)
+      type = translate_type(vv['type'])
+      raise ArgumentError.new("parameter should not have a default value when required") if required and not vv['default'].nil?
+      type
+    end
+
+    def no_resources?(resources)
+      (resources.nil?) or (resources == {})
+    end
+
+    def empty_wadl
+      header + resources_base + resources_close + footer
+    end
+
+    def translate_method(method)
+      raise ArgumentError.new("Invalid method") if method.nil? or method.strip == ""
+      return "GET" if (method.strip().casecmp("GET") == 0)
+      return "POST" if (method.strip().casecmp("POST") == 0)
+      return "PUT" if (method.strip().casecmp("PUT") == 0)
+      return "DELETE" if (method.strip().casecmp("DELETE") == 0)
+      raise ArgumentError.new("Invalid method")
+    end
+
+    def translate_type(type)
+      raise ArgumentError.new("Parameter type invalid") if type.nil? or not type.is_a? String
+      return "string" if type.strip.downcase == "string"
+      raise ArgumentError.new("Parameter type invalid")
+    end
+
+    def translate_required(required)
+      return nil if required.nil?
+      return 'true' if required == true or required.downcase.strip == 'true'
+      return 'false' if required == false or required.downcase.strip == 'false'
+      raise ArgumentError.new("Parameter presence indicator invalid")
+    end
+  end
+end
+

data/spec/lib/wadling/wadling_spec.rb

@@ -0,0 +1,152 @@
+require './spec/spec_helper.rb'
+
+describe Wadling do
+  def copy_hash(hash)
+    Marshal.load(Marshal.dump(hash))
+  end
+
+  before :all do
+    @iut = Wadling::LexiconTranslator.new
+    @wadl_header = "<application xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\""\
+                   " xsi:schemaLocation=\"http://wadl.dev.java.net/2009/02 wadl.xsd\"" \
+                   " xmlns=\"http://wadl.dev.java.net/2009/02\">" \
+                   "<resources base=\"/\">"
+    @wadl_footer = "</resources>" \
+                   "</application>"
+    @empty_wadl = @wadl_header + @wadl_footer
+    @resource1 = { '/resource1' => {
+                     'doc' => 'This returns resource1 for the identifier provided',
+                     'method' => 'GET',
+                     'id' => 'resource1',
+                     'params' => {
+                       'identifier' => {
+                         'required' => 'false',
+                         'type' => 'string',
+                         'default' => '123' }}}}
+    @resource2 = { '/resource2' => {
+                     'doc' => 'This sets resource2 for the identifier provided to the value provided',
+                     'method' => 'POST',
+                     'id' => 'resource2',
+                     'params' => { 
+                       'identifier' => {
+                         'required' => 'false',
+                         'type' => 'string',
+                         'default' => '123' },
+                       'field2' => {
+                         'required' => 'true',
+                         'type' => 'string' }}}}
+    @resource1_wadl = "<resource path=\"/resource1\">" \
+                      "  <method name=\"GET\" id=\"resource1\">" \
+                      "    <request>" \
+                      "      <doc>" \
+                      "        This returns resource1 for the identifier provided" \
+                      "      </doc>" \
+                      "      <param name=\"identifier\" type=\"xsd:string\" required=\"false\" style=\"query\" default=\"123\">" \
+                      "      </param>" \
+                      "    </request>" \
+                      "  </method>" \
+                      "</resource>"
+    @resource2_wadl = "<resource path=\"/resource2\">" \
+                      "  <method name=\"POST\" id=\"resource2\">" \
+                      "    <request>" \
+                      "      <doc>" \
+                      "        This sets resource2 for the identifier provided to the value provided" \
+                      "      </doc>" \
+                      "      <param name=\"identifier\" type=\"xsd:string\" required=\"false\" style=\"query\" default=\"123\">" \
+                      "      </param>" \
+                      "      <param name=\"field2\" type=\"xsd:string\" required=\"true\" style=\"query\">" \
+                      "      </param>" \
+                      "    </request>" \
+                      "  </method>" \
+                      "</resource>"
+    @wadl1 = @wadl_header + @resource1_wadl + @wadl_footer
+    @wadl2 = @wadl_header + @resource1_wadl + @resource2_wadl + @wadl_footer
+  end
+
+  context "when given nil" do
+    it "should return an empty WADL descriptor" do
+      expect(@iut.translate_resources_into_wadl(nil)).to eq(@empty_wadl)
+    end
+  end
+
+  context "when given an empty dictionary" do
+    it "should return an empty WADL descriptor" do
+      expect(@iut.translate_resources_into_wadl(nil)).to eq(@empty_wadl)
+    end
+  end
+
+  context "when given a non-dictionary" do
+    it "should raise an ArgumentError indicating a dictionary is required" do
+      expect {
+        @iut.translate_resources_into_wadl([])
+      }.to raise_error ArgumentError, "A resource dictionary is expected"
+    end
+  end
+
+  context "when given a dictionary with resources" do
+    context "when given one resource" do
+      it "should return a WADL definition for that resource" do
+        expect(@iut.translate_resources_into_wadl(@resource1)).to eq(@wadl1)
+      end
+    end
+
+    context "when given multiple resources" do
+      it "should return a WADL definition for all resources" do
+        test = {}
+        test = test.merge(@resource1)
+        test = test.merge(@resource2)
+        expect(@iut.translate_resources_into_wadl(test)).to eq(@wadl2)
+      end
+    end
+
+    context "when a resource is ill-defined" do
+      it "should raise an ArgumentError with appropriate descrition of the error" do
+        expect {
+          test = { nil => {
+                   'doc' => 'This returns resource1 for the identifier provided' }}
+          @iut.translate_resources_into_wadl(test)
+        }.to raise_error(ArgumentError, "Invalid resource path")
+        expect {
+          test = { '/resource' => 2 }
+          @iut.translate_resources_into_wadl(test)
+        }.to raise_error(ArgumentError, "Resource definition invalid")
+        expect {
+          test = copy_hash(@resource1)
+          test['/resource1']['doc'] = nil
+          @iut.translate_resources_into_wadl(test)
+        }.to raise_error(ArgumentError, "Resource documentation invalid")
+        expect {
+          test = copy_hash(@resource1)
+          test['/resource1']['method'] = nil
+          @iut.translate_resources_into_wadl(test)
+        }.to raise_error(ArgumentError, "Invalid method")
+        expect {
+          test = copy_hash(@resource1)
+          test['/resource1']['method'] = 'invalid'
+          @iut.translate_resources_into_wadl(test)
+        }.to raise_error(ArgumentError, "Invalid method")
+        expect {
+          test = copy_hash(@resource1)
+          test['/resource1']['id'] = nil
+          @iut.translate_resources_into_wadl(test)
+        }.to raise_error(ArgumentError, "Resource id invalid")
+        expect {
+          test = copy_hash(@resource1)
+          test['/resource1']['required'] = 'invalid'
+          @iut.translate_resources_into_wadl(test)
+        }.to raise_error(ArgumentError, "Parameter presence indicator invalid")
+        expect {
+          test = copy_hash(@resource1)
+          test['/resource1']['params']['identifier']['type'] = 'invalid'
+          @iut.translate_resources_into_wadl(test)
+        }.to raise_error(ArgumentError, "Parameter type invalid")
+        expect {
+          test = copy_hash(@resource1)
+          test['/resource1']['required'] = 'true'
+          test['/resource1']['default'] = 'one'
+          @iut.translate_resources_into_wadl(test)
+        }.to raise_error(ArgumentError, "parameter should not have a default value when required")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'rspec'
+require 'rspec/mocks'
+require 'tempfile'
+require 'simplecov'
+require 'simplecov-rcov'
+require 'byebug'
+
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'wadling'))
+$:.unshift(File.join(File.dirname(__FILE__), '..'))
+
+require 'lib/wadling.rb'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  #config.expect_with(:rspec) { |c| c.syntax = :should }
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end
+
+SimpleCov.formatter = SimpleCov::Formatter::RcovFormatter
+SimpleCov.start do
+  add_filter "/spec/"
+end
+

data/wadling.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wadling/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "wadling"
+  spec.version       = Wadling::VERSION
+  spec.authors       = ["Ernst van Graan"]
+  spec.email         = ["ernst.van.graan@hetzner.co.za"]
+  spec.description   = %q{Turns a list of services (REST resources) definitions into a WADL definition}
+  spec.summary       = %q{Given a dictionary of resources with a description, input and output schemas, produces a WADL definition}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+  spec.required_ruby_version = '>= 2.0'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-rcov'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: wadling
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ernst van Graan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-rcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Turns a list of services (REST resources) definitions into a WADL definition
+email:
+- ernst.van.graan@hetzner.co.za
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wadling.rb
+- lib/wadling/version.rb
+- spec/lib/wadling/wadling_spec.rb
+- spec/spec_helper.rb
+- wadling.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Given a dictionary of resources with a description, input and output schemas,
+  produces a WADL definition
+test_files:
+- spec/lib/wadling/wadling_spec.rb
+- spec/spec_helper.rb