form_api 0.1.0

data/lib/form_api/version.rb

@@ -0,0 +1,15 @@
+=begin
+#API V1
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+module FormAPI
+  VERSION = "0.1.0"
+end

data/script/clean

@@ -0,0 +1,5 @@
+#!/bin/sh
+set -e
+cd "`dirname \"$0\"`/.."
+
+rm -rf lib/

data/script/fix_gemspec.rb

@@ -0,0 +1,31 @@
+bad_files       = %q{s.files         = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }}
+bad_test_files  = %q{s.test_files    = `find spec/*`.split("\n")}
+good_files      = %q{s.files         = `git ls-files`.split("\n").uniq.sort.select{|f| !f.empty? }}
+good_test_files = %q{s.test_files    = `git ls-files spec test`.split("\n")}
+
+development_dependency_marker = %q{  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'}
+development_dependency_marker_plus_injection =
+"  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  # added by script/fix_gemspec.rb.
+  s.add_development_dependency 'rake', '~>11.2', '>= 11.2.2'
+  s.add_development_dependency 'pry', '~>0.10', '>= 0.10.4'
+  # </added> : if the above lines are missing in the gemspec, then
+  # the matcher for autotest is probably broken"
+
+filename = "form_api.gemspec"
+content = File.read(filename)
+[bad_files, bad_test_files, development_dependency_marker].each do |bad_content_to_check|
+  unless content.include?(bad_content_to_check)
+    raise "Couldn't find content in form_api.gemspec. Check matchers in there for: “#{bad_content_to_check}”"
+  end
+end
+updated_content = content.dup
+updated_content.sub!(bad_files, good_files)
+updated_content.sub!(bad_test_files, good_test_files)
+updated_content.sub!(development_dependency_marker,
+                     development_dependency_marker_plus_injection)
+
+File.open(filename, "w") do |file|
+  file.write(updated_content)
+end

data/script/generate_language

@@ -0,0 +1,35 @@
+#!/bin/sh
+set -e
+cd "$(dirname "$0")/.."
+
+LANGUAGE="$1"
+CONFIG_FILE="swagger-config.json"
+
+if [ "$LANGUAGE" = "" ]; then
+  ./script/swagger # prints languages
+  exit 1
+fi
+
+if [ ! -f "$CONFIG_FILE" ]; then
+  echo "Could not find $CONFIG_FILE"
+  ./script/swagger config-help -l "$LANGUAGE"
+  exit 1
+fi
+
+./script/clean
+
+./script/swagger generate \
+  -i ../form_api/swagger/v1/swagger.json \
+  -l "$LANGUAGE" \
+  -c "$CONFIG_FILE"
+
+# call a generator cleanup script
+if [ -f "script/post_generate_language" ]; then
+  ./script/post_generate_language
+fi
+
+
+# Inject extensions
+sed -i "s/require 'form_api\/api\/pdf_api'/\
+require File.join(File.dirname(__FILE__), '..\/extensions\/lib\/form_api\/api\/client')/" \
+lib/form_api.rb

data/script/post_generate_language

@@ -0,0 +1,9 @@
+#!/bin/sh
+set -e
+cd "`dirname \"$0\"`/.."
+
+echo "Removing trailing whitespace..."
+find lib -name "*.rb" -type f -exec sed -E -i 's/[[:space:]]+$//g' {} +
+
+echo "Fixing gemspec to work around swagger..."
+ruby script/fix_gemspec.rb

data/script/swagger

@@ -0,0 +1,35 @@
+#!/bin/bash
+set -e
+cd "$(dirname "$0")/.."
+
+SWAGGER_CODGEN_REVISION=$(cat .swagger-revision 2> /dev/null || true)
+if [ "$SWAGGER_CODGEN_REVISION" = "" ]; then
+  echo "Set a revision of swagger-codegen to use in .swagger-revision"
+  exit 1
+fi
+
+if [ ! -d "swagger-codegen" ]; then
+  git clone https://github.com/swagger-api/swagger-codegen
+fi
+
+(
+  cd swagger-codegen
+  if [[ "${#SWAGGER_CODGEN_REVISION}" -lt 40 ]]; then
+    # resolve git tags / branch names
+    SWAGGER_CODGEN_REVISION=$(git show "$SWAGGER_CODGEN_REVISION" --format="%H")
+  fi
+  if [[ $(cat .git/HEAD) != "$SWAGGER_CODGEN_REVISION" ]]; then
+    git fetch
+    git checkout "$SWAGGER_CODGEN_REVISION"
+    mvn clean package
+  fi
+)
+
+executable="./swagger-codegen/modules/swagger-codegen-cli/target/swagger-codegen-cli.jar"
+
+if [ ! -f "$executable" ]; then
+  mvn clean package
+fi
+
+export JAVA_OPTS="${JAVA_OPTS} -Xmx1024M -DloggerPath=conf/log4j.properties"
+java $JAVA_OPTS -jar $executable $*

data/script/test

@@ -0,0 +1,24 @@
+#!/bin/sh
+set -e
+cd "`dirname \"$0\"`/.."
+
+# check dependencies
+ruby -v > /dev/null    || (echo "ruby must be installed"; exit 1)
+bundler -v > /dev/null || (echo "bundler must be installed"; exit 1)
+
+bundle install
+
+cd test
+
+# runs a test file with PASS/FAIL message
+run_test() {
+  ruby $1 && echo "PASS $1" || (echo "FAIL $1"; exit 1)
+}
+
+if [ "$1" == "" ]; then
+  for test in $(ls *.rb); do
+    run_test $test
+  done
+else
+  run_test $1.rb
+fi

data/spec/api/pdf_api_spec.rb

@@ -0,0 +1,60 @@
+=begin
+#API V1
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for FormAPI::PDFApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'PDFApi' do
+  before do
+    # run before each test
+    @instance = FormAPI::PDFApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PDFApi' do
+    it 'should create an instance of PDFApi' do
+      expect(@instance).to be_instance_of(FormAPI::PDFApi)
+    end
+  end
+
+  # unit tests for generate_pdf
+  # Generates a new PDF
+  # 
+  # @param template_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [Data] :data 
+  # @return [InlineResponse201]
+  describe 'generate_pdf test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_submission
+  # Check the status of a PDF request
+  # 
+  # @param submission_id 
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse201Submission]
+  describe 'get_submission test' do
+    it "should work" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,226 @@
+=begin
+#API V1
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+
+describe FormAPI::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          FormAPI.configure { |c| c.host = 'http://example.com' }
+          expect(FormAPI::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          FormAPI.configure { |c| c.host = 'https://wookiee.com' }
+          expect(FormAPI::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          FormAPI.configure { |c| c.host = 'hobo.com/v4' }
+          expect(FormAPI::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          FormAPI.configure { |c| c.base_path = 'v4/dog' }
+          expect(FormAPI::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          FormAPI.configure { |c| c.base_path = '/v4/dog' }
+          expect(FormAPI::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          FormAPI.configure { |c| c.base_path = nil }
+          expect(FormAPI::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe "params_encoding in #build_request" do
+    let(:config) { FormAPI::Configuration.new }
+    let(:api_client) { FormAPI::ApiClient.new(config) }
+
+    it "defaults to nil" do
+      expect(FormAPI::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it "can be customized" do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe "timeout in #build_request" do
+    let(:config) { FormAPI::Configuration.new }
+    let(:api_client) { FormAPI::ApiClient.new(config) }
+
+    it "defaults to 0" do
+      expect(FormAPI::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it "can be customized" do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe "#deserialize" do
+    it "handles Array<Integer>" do
+      api_client = FormAPI::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it "handles Array<Array<Integer>>" do
+      api_client = FormAPI::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it "handles Hash<String, String>" do
+      api_client = FormAPI::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq({:message => 'Hello'})
+    end
+  end
+
+  describe "#object_to_hash" do
+    it "ignores nils and includes empty arrays" do
+      # uncomment below to test object_to_hash for model
+      #api_client = FormAPI::ApiClient.new
+      #_model = FormAPI::ModelName.new
+      # update the model attribute below
+      #_model.id = 1 
+      # update the expected value (hash) below
+      #expected = {id: 1, name: '', tags: []}
+      #expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe "#build_collection_param" do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { FormAPI::ApiClient.new }
+
+    it "works for csv" do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it "works for ssv" do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it "works for tsv" do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it "works for pipes" do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it "works for multi" do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it "fails for invalid collection format" do
+      expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe "#json_mime?" do
+    let(:api_client) { FormAPI::ApiClient.new }
+
+    it "works" do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe "#select_header_accept" do
+    let(:api_client) { FormAPI::ApiClient.new }
+
+    it "works" do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe "#select_header_content_type" do
+    let(:api_client) { FormAPI::ApiClient.new }
+
+    it "works" do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe "#sanitize_filename" do
+    let(:api_client) { FormAPI::ApiClient.new }
+
+    it "works" do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end