raml_parser 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c566421a59a1d92ee889714c3c84f37e6c1673d0
-  data.tar.gz: 0a572f77481d481ccba55d87eb09f34962e34abd
+  metadata.gz: dd25d7244f2ee30c63c0af8ffdf113abf3a2f4bf
+  data.tar.gz: 0050bfd6cbe239d7e9bd2aaf663895eb7c93a68b
 SHA512:
-  metadata.gz: b3520c84d38f67cfca3073be3c03ece838c40a54bb07b592e62b2e16a0a722b1fbb008195689c3b4202d22b839318bce7429f144b949d9edb8e18c89ad723e50
-  data.tar.gz: 52a5b63afb2a9c76702d13326a063e76af27481241d833e2085bb365c0892dd7faa586c4d47347e26266432407f962e1866e803bece269f11598ce3e0497080f
+  metadata.gz: c9415cff318565dd2ee372e5e6194b754ecf473c5370b2f7dddc0ddaa3686e99020de86e316ce00d36c22e233fce809d1274b0ebfdc8916d7d34f963f1af444b
+  data.tar.gz: 6a5d550de3bd9b9359a7fbd3a75457f5d1ded727d3430679df75c90f98b865b1bce80af7004eceec1e11944e1ee9fc4345873aa09a65701d98be3a089a2bf037

data/lib/raml_parser/snippet_generator.rb

@@ -0,0 +1,63 @@
+module RamlParser
+  class SnippetGenerator
+    attr_accessor :raml
+
+    def initialize(raml)
+      @raml = raml
+    end
+
+    def curl(resource, method_name)
+      method = resource.methods[method_name]
+
+      curl_method = "-X#{method.method.upcase}"
+      curl_content_type = map_nonempty(method.bodies.values.first) { |b| "-H \"Accept: #{b.media_type}\"" }
+      query_parameters = map_nonempty(render_query_parameters(method.query_parameters.values)) { |s| '?' + s }
+      curl_data = map_nonempty(method.bodies.values.first) { |b| "-d \"#{b.example}\"" }
+
+      ['curl', curl_method, curl_content_type, resource.absolute_uri + query_parameters, curl_data].select { |p| not is_falsy(p) }.join(' ')
+    end
+
+    def javascript_vanilla(resource, method_name)
+      method = resource.methods[method_name]
+
+      query_parameters = map_nonempty(render_query_parameters(method.query_parameters.values)) { |s| '?' + s }
+      js_content_type = map_nonempty(method.bodies.values.first) { |b| "xhr.setRequestHeader('Accept', '#{b.media_type}');\n" } || ''
+      data = map_nonempty(method.bodies.values.first) { |b| b.example.strip.gsub("\r\n", "\\r\\n").gsub("\n", "\\n") }
+
+      result = "var xhr = new XMLHttpRequest();\n"
+      result += "xhr.open('#{method.method.upcase}', '#{resource.absolute_uri + query_parameters}', true);\n"
+      result += "xhr.onreadystatechange = function () {\n"
+      result += "  if (xhr.readyState != 4 || xhr.status != 200) return;\n"
+      result += "  console.log('Success', xhr.responseText);\n"
+      result += "};\n"
+      result += js_content_type
+      result += "xhr.send(\"#{data}\");"
+
+      result
+    end
+
+    private
+    def is_falsy(value)
+      if value.is_a?(String)
+        value.length == 0
+      else
+        value.nil?
+      end
+    end
+
+    def map_nonempty(value, &code)
+      if not is_falsy(value)
+        code.call(value)
+      else
+        value
+      end
+    end
+
+    def render_query_parameters(query_parameters)
+      query_parameters
+        .select { |q| q.required }
+        .map { |q| "#{q.name}=#{q.example || 'value'}"}
+        .join('&')
+    end
+  end
+end

data/lib/raml_parser/version.rb

@@ -1,3 +1,3 @@
 module RamlParser
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/lib/raml_parser/snippet_generator_spec.rb

@@ -0,0 +1,43 @@
+require 'raml_parser/snippet_generator'
+
+RSpec.describe RamlParser::SnippetGenerator do
+  it 'generate curl snippets' do
+    raml1 = RamlParser::Parser.parse_file('spec/examples/raml/resources.raml')
+    gen1 = RamlParser::SnippetGenerator.new(raml1)
+    res1 = gen1.curl(raml1.resources[0], 'get')
+    expect(res1).to eq 'curl -XGET http://localhost:3000/first'
+
+    raml2 = RamlParser::Parser.parse_file('spec/examples/raml/requestbodies.raml')
+    gen2 = RamlParser::SnippetGenerator.new(raml2)
+    res2 = gen2.curl(raml2.resources[0], 'post')
+    expect(res2).to include '-XPOST'
+    expect(res2).to include 'Accept: application/json'
+    expect(res2).to include '"foo": "bar"'
+
+    raml3 = RamlParser::Parser.parse_file('spec/examples/raml/required.raml')
+    gen3 = RamlParser::SnippetGenerator.new(raml3)
+    res3 = gen3.curl(raml3.resources[4], 'get')
+    expect(res3).to eq 'curl -XGET http://localhost:3000/i?l=value'
+  end
+
+  it 'generate javascript vanilla snippets' do
+    raml1 = RamlParser::Parser.parse_file('spec/examples/raml/resources.raml')
+    gen1 = RamlParser::SnippetGenerator.new(raml1)
+    res1 = gen1.javascript_vanilla(raml1.resources[0], 'get')
+    expect(res1).to include 'GET'
+    expect(res1).to include 'http://localhost:3000/first'
+
+    raml2 = RamlParser::Parser.parse_file('spec/examples/raml/requestbodies.raml')
+    gen2 = RamlParser::SnippetGenerator.new(raml2)
+    res2 = gen2.javascript_vanilla(raml2.resources[0], 'post')
+    expect(res2).to include 'Accept'
+    expect(res2).to include 'application/json'
+    expect(res2).to include '"foo": "bar"'
+
+    raml3 = RamlParser::Parser.parse_file('spec/examples/raml/required.raml')
+    gen3 = RamlParser::SnippetGenerator.new(raml3)
+    res3 = gen3.javascript_vanilla(raml3.resources[4], 'get')
+    expect(res3).to include 'GET'
+    expect(res3).to include 'http://localhost:3000/i?l=value'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: raml_parser
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Christian Hoffmeister
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-05 00:00:00.000000000 Z
+date: 2015-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -82,6 +82,7 @@ files:
 - Rakefile
 - lib/raml_parser.rb
 - lib/raml_parser/model.rb
+- lib/raml_parser/snippet_generator.rb
 - lib/raml_parser/version.rb
 - lib/raml_parser/yaml_helper.rb
 - raml_parser.gemspec
@@ -148,6 +149,7 @@ files:
 - spec/examples/yaml/include2.yml
 - spec/examples/yaml/simple.yml
 - spec/examples/yaml/traversing.yml
+- spec/lib/raml_parser/snippet_generator_spec.rb
 - spec/lib/raml_parser/yaml_helper_spec.rb
 - spec/lib/raml_parser_spec.rb
 - spec/spec_helper.rb
@@ -171,7 +173,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A parser for the RAML API modeling language.
@@ -239,6 +241,7 @@ test_files:
 - spec/examples/yaml/include2.yml
 - spec/examples/yaml/simple.yml
 - spec/examples/yaml/traversing.yml
+- spec/lib/raml_parser/snippet_generator_spec.rb
 - spec/lib/raml_parser/yaml_helper_spec.rb
 - spec/lib/raml_parser_spec.rb
 - spec/spec_helper.rb