haveapi 0.29.7 → 0.29.9

data/lib/haveapi/client_examples/php_client.rb

@@ -148,20 +148,26 @@ module HaveAPI::ClientExamples
 
     def format_parameters(dir, params, prefix = '')
       ret = params.map do |k, v|
-        if action[dir][:parameters][k][:type] == 'Custom'
-          "#{prefix}  \"#{k}\" => custom type}"
-        else
-          "#{prefix}  \"#{k}\" => #{value(v)}"
-        end
+        "#{prefix}  #{value(k.to_s)} => #{value(v)}"
       end
 
       "#{prefix}[\n#{ret.join(",\n")}\n#{prefix}]"
     end
 
     def value(v)
-      return v if v.is_a?(::Numeric) || v === true || v === false
-
-      "\"#{v}\""
+      case v
+      when ::NilClass
+        'null'
+      when ::Numeric, true, false
+        v.to_s
+      when ::Array
+        "[#{v.map { |item| value(item) }.join(', ')}]"
+      when ::Hash
+        "[#{v.map { |key, item| "#{value(key.to_s)} => #{value(item)}" }.join(', ')}]"
+      else
+        escaped = v.to_s.gsub(/[\\']/) { |char| "\\#{char}" }
+        "'#{escaped}'"
+      end
     end
   end
 end

data/lib/haveapi/server.rb

@@ -533,7 +533,12 @@ module HaveAPI
       @sinatra.get "#{@root}doc/json-schema" do
         content_type 'text/html'
         erb :doc_layout, layout: :main_layout do
-          @content = File.read(File.join(settings.root, '../../doc/json-schema.html'))
+          begin
+            @content = File.read(File.join(settings.root, '../../doc/json-schema.html'))
+          rescue Errno::ENOENT
+            halt 404
+          end
+
           @sidebar = erb :'doc_sidebars/json-schema'
         end
       end

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
   PROTOCOL_VERSION = '2.0'.freeze
-  VERSION = '0.29.7'.freeze
+  VERSION = '0.29.9'.freeze
 end

data/spec/client_examples/syntax_spec.rb

@@ -20,7 +20,8 @@ describe HaveAPI::ClientExamples do
         namespace: :widget,
         parameters: {
           name: { type: 'String' },
-          enabled: { type: 'Boolean' }
+          enabled: { type: 'Boolean' },
+          group_by: { type: 'Custom' }
         }
       },
       output: {
@@ -36,7 +37,11 @@ describe HaveAPI::ClientExamples do
   let(:sample) do
     {
       path_params: [101],
-      request: { name: 'documented widget', enabled: true },
+      request: {
+        name: "documented \"widget\" with $value and an apostrophe's backslash \\",
+        enabled: true,
+        group_by: ['vps_id', "owner's $group\\path"]
+      },
       response: { id: 101, name: 'documented widget' },
       status: true,
       message: nil,
@@ -77,6 +82,12 @@ describe HaveAPI::ClientExamples do
     status, output = syntax_check(%w[php -l], "<?php\n#{source}", '.php')
 
     expect(status).to be_success, output
+    expect(source).to include(
+      "'group_by' => ['vps_id', 'owner\\'s $group\\\\path']"
+    )
+    expect(source).to include(
+      "'name' => 'documented \"widget\" with $value and an apostrophe\\'s backslash \\\\'"
+    )
   end
 
   it 'generates valid Ruby' do
@@ -102,8 +113,9 @@ describe HaveAPI::ClientExamples do
     expect(request_lines).to include('Host: api.example.test', 'Content-Type: application/json')
     expect(JSON.parse(request_body)).to eq(
       'widget' => {
-        'name' => 'documented widget',
-        'enabled' => true
+        'name' => "documented \"widget\" with $value and an apostrophe's backslash \\",
+        'enabled' => true,
+        'group_by' => ['vps_id', "owner's $group\\path"]
       }
     )
 

data/spec/documentation_spec.rb

@@ -195,4 +195,18 @@ describe 'Documentation' do
     expect(last_response.status).to eq(200)
     expect(last_response.headers['Content-Type']).to include('text/html')
   end
+
+  {
+    '/doc/json-schema' => 'Envelope',
+    '/doc/protocol.md' => 'Protocol definition',
+    '/doc/create-client.md' => 'Client definition'
+  }.each do |path, heading|
+    it "serves shared documentation at #{path}" do
+      get path
+
+      expect(last_response.status).to eq(200)
+      expect(last_response.headers['Content-Type']).to include('text/html')
+      expect(last_response.body).to include(heading)
+    end
+  end
 end

data/spec/extensions/exception_mailer_spec.rb

@@ -122,6 +122,39 @@ describe HaveAPI::Extensions::ExceptionMailer do
     expect(body).to include('request boom')
   end
 
+  it 'does not mail a missing JSON schema documentation file' do
+    mailer = new_mailer
+    calls = collect_mail_calls(mailer)
+    doc_path = File.join(app.settings.root, '../../doc/json-schema.html')
+    allow(File).to receive(:read).and_call_original
+    allow(File).to receive(:read).with(doc_path).and_raise(Errno::ENOENT, doc_path)
+
+    with_exception_mailer(mailer) do
+      get '/doc/json-schema'
+    end
+
+    expect(last_response.status).to eq(404)
+    expect(calls).to be_empty
+  end
+
+  it 'still mails other JSON schema file errors' do
+    mailer = new_mailer
+    calls = collect_mail_calls(mailer)
+    app.set :raise_errors, false
+    app.set :show_exceptions, false
+    doc_path = File.join(app.settings.root, '../../doc/json-schema.html')
+    allow(File).to receive(:read).and_call_original
+    allow(File).to receive(:read).with(doc_path).and_raise(Errno::EACCES, doc_path)
+
+    with_exception_mailer(mailer) do
+      get '/doc/json-schema'
+    end
+
+    expect(last_response.status).to eq(500)
+    expect(calls.size).to eq(1)
+    expect(calls.first[1]).to be_a(Errno::EACCES)
+  end
+
   it 'redacts secrets from request-level exception emails' do
     mailer = new_mailer
     calls = collect_mail_calls(mailer)

data/spec/packaging_spec.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'open3'
+require 'rake'
+require 'rbconfig'
+require 'rubygems/package'
+require 'tmpdir'
+
+describe HaveAPI::Server do
+  def required_docs
+    %w[json-schema.html protocol.md create-client.md typed-input-validation.md protocol.png]
+  end
+
+  before(:context) do
+    load File.expand_path('../Rakefile', __dir__)
+  end
+
+  def invoke_build
+    Rake::Task[:check_doc].reenable
+    Rake::Task[:build].reenable
+    Rake::Task[:build].invoke
+  end
+
+  %i[missing empty].each do |condition|
+    it "rejects a direct build with #{condition} shared documentation" do
+      Dir.mktmpdir('haveapi-doc-check') do |dir|
+        FileUtils.mkdir_p(File.join(dir, 'doc'))
+        required_docs.each do |name|
+          next if name == 'json-schema.html' && condition == :missing
+
+          content = name == 'json-schema.html' && condition == :empty ? '' : 'document'
+          File.write(File.join(dir, 'doc', name), content)
+        end
+
+        Dir.chdir(dir) do
+          expect do
+            expect { invoke_build }.to raise_error(SystemExit) do |error|
+              expect(error.status).to eq(1)
+            end
+          end.to output(/json-schema.html.*Run `make doc`/).to_stderr
+        end
+      end
+    end
+  end
+
+  it 'ships and serves shared documentation from the built gem' do
+    invoke_build
+    gem_path = File.expand_path("../pkg/haveapi-#{HaveAPI::VERSION}.gem", __dir__)
+
+    Dir.mktmpdir('haveapi-package') do |dir|
+      Gem::Package.new(gem_path).extract_files(dir)
+      required_docs.each do |name|
+        expect(File.read(File.join(dir, 'doc', name))).not_to be_empty
+      end
+
+      script = <<~RUBY
+        require 'haveapi'
+        require 'rack/mock'
+
+        module PackagedAPI
+          class Test < HaveAPI::Resource
+            version 1
+            auth false
+
+            class Index < HaveAPI::Actions::Default::Index
+              authorize { allow }
+              def exec
+                []
+              end
+            end
+          end
+        end
+
+        server = HaveAPI::Server.new(PackagedAPI)
+        server.use_version(1)
+        server.mount('/')
+        request = Rack::MockRequest.new(server.app)
+        responses = %w[/doc/json-schema /doc/protocol.md /doc/create-client.md].to_h do |path|
+          response = request.get(path, 'HTTP_HOST' => 'localhost')
+          [path, { status: response.status, type: response.content_type, body: response.body }]
+        end
+        puts JSON.generate({
+          framework: HaveAPI::Server.instance_method(:mount).source_location.first,
+          responses: responses
+        })
+      RUBY
+
+      empty_gem_home = File.join(dir, 'empty-gems')
+      original_env = Bundler.original_env.merge('GEM_HOME' => empty_gem_home, 'GEM_PATH' => empty_gem_home)
+      allow(Bundler).to receive(:original_env).and_return(original_env)
+
+      # Retain Bundler's resolved gem paths for installations such as vendor/bundle.
+      child_env = {
+        'GEM_HOME' => Gem.dir,
+        'GEM_PATH' => Gem.path.join(File::PATH_SEPARATOR),
+        'RUBYLIB' => nil,
+        'RUBYOPT' => nil
+      }
+      stdout, stderr, status = Bundler.with_unbundled_env do
+        Open3.capture3(
+          child_env,
+          RbConfig.ruby, '-I', File.join(dir, 'lib'), '-e', script,
+          '-I', File.join(Gem.loaded_specs.fetch('haveapi-client').full_gem_path, 'lib'),
+          chdir: dir
+        )
+      end
+      expect(status.success?).to be(true), "Packaged server failed: #{stderr}"
+      result = JSON.parse(stdout)
+      expect(File.realpath(result.fetch('framework'))).to eq(File.join(dir, 'lib/haveapi/server.rb'))
+
+      {
+        '/doc/json-schema' => 'Envelope',
+        '/doc/protocol.md' => 'Protocol definition',
+        '/doc/create-client.md' => 'Client definition'
+      }.each do |path, heading|
+        response = result.fetch('responses').fetch(path)
+        expect(response.fetch('status')).to eq(200), "Packaged route failed: #{path}"
+        expect(response.fetch('type')).to include('text/html')
+        expect(response.fetch('body')).to include(heading)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.29.7
+  version: 0.29.9
 platform: ruby
 authors:
 - Jakub Skokan
@@ -29,14 +29,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.7
+        version: 0.29.9
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.7
+        version: 0.29.9
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
@@ -210,8 +210,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- doc/create-client.md
 - doc/hooks.erb
 - doc/index.md
+- doc/json-schema.html
+- doc/protocol.md
+- doc/protocol.png
+- doc/typed-input-validation.md
 - haveapi.gemspec
 - lib/haveapi.rb
 - lib/haveapi/action.rb
@@ -338,6 +343,7 @@ files:
 - spec/hooks_spec.rb
 - spec/i18n_spec.rb
 - spec/model_adapters/active_record_spec.rb
+- spec/packaging_spec.rb
 - spec/parameters/typed_spec.rb
 - spec/params_spec.rb
 - spec/resource_spec.rb