agoo 2.11.7 → 2.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06273c8f4d9d00c382ed4d0abec44bc54b24a1063cb7cc15796137153a169206
-  data.tar.gz: ba1e9f93e1cbd39e2777ce5a0d9e61498f5718c3742ad001d28490eec848e838
+  metadata.gz: df42da153e97e018d4984fa75be78ac86a1c8b97aed6b48d62ec7fe5047d7099
+  data.tar.gz: e83a55eed4781bbb0ab08df41203509df6ec45d06817b87c9d61d25bca8a294a
 SHA512:
-  metadata.gz: ccf05a2fed955f9e44461a6557c7d3232280c0fd316d523bbbb97cfc9942ef8407a4f31e92b4ba888d3d895578d85753d12e2966aeb08d8725a4de6f5c74eb2f
-  data.tar.gz: 3af05ec64f0af3ab57bbb0c95652d8050ca6c73d0cf39777cfeff8e5c0ac2cc71ddc783b4d0fecc5d675e865616fe8dee7c145268359e51e5bc7864f00428733
+  metadata.gz: ac6e8d86a9b545d93c9ee033950422292b4ab2f740ba692f2c24940e928c42466b895dfae6ce5263040f2b53613a6c1241f5dfe5c0be21961f1ee885970ec220
+  data.tar.gz: 9dd8414c88948198bd1a22d5aac236ef8d5bf4251020b7fcfc4b94837d8a48433aa6774ba9e13df1dc36dc1e29f1697dfcc2c21e8ef1a9dc6897d223b72eb946

data/CHANGELOG.md

@@ -2,6 +2,54 @@
 
 All changes to the Agoo gem are documented here. Releases follow semantic versioning.
 
+## [2.13.0] - 2020-07-05
+
+### Added
+
+- Agoo::Server.use() added. It works similar to the Rack use() function.
+
+### Fixed
+
+- Header checks are now case insensitive to comply with RFC 7230.
+
+## [2.12.3] - 2020-03-28
+
+rb_rescue2 termination
+
+### Fixed
+
+- rb_rescue2 must be terminated by a (VALUE)0 and not simply 0.
+
+## [2.12.2] - 2020-03-22
+
+Stub generator
+
+### Added
+
+- GraphQL stub generator to generate Ruby class file corresponding to GraphQL schema type. The generator is `bin/agoo_stubs`.
+
+## [2.12.1] - 2020-03-17
+
+Check SO_REUSEPORT
+
+### Fixed
+
+- Verifiy SO_REUSEPORT is define for older OS versions.
+
+## [2.12.0] - 2020-01-19
+
+Request GraphQL access and GraphiQL support
+
+### Added
+
+- Optional addition of request information is now available in GraphQL resolve functions.
+
+- Headers for GraphQL responses can now be set.
+
+- Fixed incorrect values in introspection responses.
+
+- Fixed JSON parser bug with null, true, and false.
+
 ## [2.11.7] - 2020-01-02
 
 Ruby 2.7.0 cleanup

data/bin/agoo_stubs

@@ -0,0 +1,166 @@
+#!/usr/bin/env ruby
+
+while (index = ARGV.index('-I'))
+  _, path = ARGV.slice!(index, 2)
+  $LOAD_PATH << path
+end
+
+require 'optparse'
+
+require 'agoo'
+
+usage = %{
+Usage: agoo_stubs [options] <graphql_schema>
+
+version #{Agoo::VERSION}
+
+Generates Ruby files that match the types in the GraphQL schema file specified.
+
+Example:
+
+  agoo_stubs --module Data --dir lib schema.graphql
+
+}
+
+@verbose = false
+@single = nil
+@dir = nil
+@mod = nil
+
+@opts = OptionParser.new(usage)
+@opts.on('-h', '--help', 'show this display')                            { puts @opts.help; Process.exit!(0) }
+@opts.on('-v', '--verbose', 'verbose output')                            { @verbose = true }
+@opts.on('-s', '--single PATH', String, 'path to file for all stubs')    { |s| @single = s }
+@opts.on('-d', '--dir PATH', String, 'directory to write files into')    { |d| @dir = d }
+@opts.on('-m', '--module STRING', String, 'module for the stub classes') { |m| @mod = m }
+
+@files = @opts.parse(ARGV)
+
+if @files.empty?
+  puts "A schema file must be specified."
+  puts @opts.help
+  Process.exit!(0)
+elsif 1 < @files.size
+  puts "Only one schema file can be specified."
+  puts @opts.help
+  Process.exit!(0)
+end
+
+Agoo::GraphQL.schema(nil) {
+  Agoo::GraphQL.load_file(@files[0])
+}
+
+def write_type_stub(f, t, depth)
+  indent = '  ' * depth
+  f.puts "#{indent}# #{t.description}" unless t.description.nil?
+  f.puts "#{indent}class #{t.name}"
+  t.fields.each { |field|
+    next unless field.args.nil?
+    f.puts "#{indent}  # #{field.description}" unless field.description.nil?
+    f.puts "#{indent}  attr_accessor :#{field.name}"
+  }
+  f.puts
+  f.puts "#{indent}  def initialize"
+  f.puts "#{indent}  end"
+  t.fields.each { |field|
+    next if field.args.nil?
+    f.puts
+    f.puts "#{indent}  # #{field.description}" unless field.description.nil?
+    f.puts "#{indent}  # args: #{field.args.map { |a| a.name }.join(', ')}"
+    f.puts "#{indent}  def #{field.name}(args={})"
+    f.puts "#{indent}  end"
+  }
+  f.puts "#{indent}end"
+end
+
+def calc_filepath(t)
+  path = @dir
+  path += '/' + @mod.split('::').map { |m| m.downcase }.join('/') unless @mod.nil?
+  path + '/' + t.name.downcase + '.rb'
+end
+
+def assure_parent_dir(path)
+  dirs = path.split('/')[0..-2]
+  dirs.each_index { |i|
+    path = dirs[0..i].join('/')
+    Dir.mkdir(path) unless Dir.exist?(path)
+  }
+end
+
+def write_type_stub_file(t)
+  path = calc_filepath(t)
+  assure_parent_dir(path)
+  File.open(path, 'w') { |f|
+    f.puts "# #{t.name} class for schema file #{@files[0]}"
+    f.puts
+    depth = 0
+    unless @mod.nil?
+      @mod.split('::').each { |m|
+	f.puts("#{'  ' * depth}module #{m}")
+	depth += 1
+      }
+      f.puts
+    end
+    write_type_stub(f, t, depth)
+    f.puts
+    unless @mod.nil?
+      @mod.split('::').size.times {
+	depth -= 1
+	f.puts("#{'  ' * depth}end")
+      }
+    end
+  }
+end
+
+@out = nil
+
+if @dir.nil?
+  if @single.nil?
+    @out = STDOUT
+  else @single
+    @out = File.new(@single, 'w')
+  end
+end
+
+unless @out.nil?
+  @out.puts "# Classes for schema file #{@files[0]}"
+  @out.puts
+  depth = 0
+  unless @mod.nil?
+    @mod.split('::').each { |m|
+      @out.puts("#{'  ' * depth}module #{m}")
+      depth += 1
+    }
+    @out.puts
+  end
+  Agoo::GraphQL.sdl_types.sort { |a,b| a.name <=> b.name }.each { |t|
+    write_type_stub(@out, t, depth)
+    @out.puts
+  }
+  unless @mod.nil?
+    @mod.split('::').size.times {
+      depth -= 1
+      @out.puts("#{'  ' * depth}end")
+    }
+  end
+  @out.close unless STDOUT == @out
+else
+  Agoo::GraphQL.sdl_types.each { |t|
+    write_type_stub_file(t)
+  }
+  unless @mod.nil?
+    path = @dir
+    path += '/' + @mod.split('::').map { |m| m.downcase }.join('/')
+    assure_parent_dir(path)
+    m = path.split('/')[-1]
+    path += '.rb'
+
+    File.open(path, 'w') { |f|
+      f.puts "# Classes for schema file #{@files[0]}"
+      f.puts
+      Agoo::GraphQL.sdl_types.sort { |a,b| a.name <=> b.name }.each { |t|
+	f.puts "require_relative '#{m}/#{t.name.downcase}'"
+      }
+    }
+  end
+end

data/ext/agoo/bind.c

@@ -223,25 +223,25 @@ url_ssl(agooErr err, const char *url) {
 
 agooBind
 agoo_bind_url(agooErr err, const char *url) {
-    if (0 == strncmp("tcp://", url, 6)) {
+    if (0 == strncasecmp("tcp://", url, 6)) {
 	if ('[' == url[6]) {
 	    return url_tcp6(err, url + 6, "tcp");
 	}
 	return url_tcp(err, url + 6, "tcp");
     }
-    if (0 == strncmp("http://", url, 7)) {
+    if (0 == strncasecmp("http://", url, 7)) {
 	if ('[' == url[7]) {
 	    return url_tcp6(err, url + 7, "http");
 	}
 	return url_tcp(err, url + 7, "http");
     }
-    if (0 == strncmp("unix://", url, 7)) {
+    if (0 == strncasecmp("unix://", url, 7)) {
 	return url_named(err, url + 7);
     }
-    if (0 == strncmp("https://", url, 8)) {
+    if (0 == strncasecmp("https://", url, 8)) {
 	return url_ssl(err, url + 8);
     }
-    if (0 == strncmp("ssl://", url, 6)) {
+    if (0 == strncasecmp("ssl://", url, 6)) {
 	return url_ssl(err, url + 6);
     }
     // All others assume http
@@ -286,7 +286,9 @@ usual_listen(agooErr err, agooBind b) {
 #ifdef OSX_OS
     setsockopt(b->fd, SOL_SOCKET, SO_NOSIGPIPE, &optval, sizeof(optval));
 #endif
+#ifdef SO_REUSEPORT
     setsockopt(b->fd, SOL_SOCKET, SO_REUSEPORT, &optval, sizeof(optval));
+#endif
     setsockopt(b->fd, IPPROTO_TCP, TCP_NODELAY, &optval, sizeof(optval));
     if (AF_INET6 == b->family) {
 	struct sockaddr_in6	addr;

data/ext/agoo/con.c

@@ -173,7 +173,7 @@ agoo_con_header_value(const char *header, int hlen, const char *key, int *vlen)
     int		klen = (int)strlen(key);
 
     while (h < hend) {
-	if (0 == strncmp(key, h, klen) && ':' == h[klen]) {
+	if (0 == strncasecmp(key, h, klen) && ':' == h[klen]) {
 	    h += klen + 1;
 	    for (; ' ' == *h; h++) {
 	    }

data/ext/agoo/gqleval.c

@@ -36,8 +36,9 @@ static const char	query_str[] = "query";
 static const char	subscription_str[] = "subscription";
 static const char	variables_str[] = "variables";
 
-
 gqlValue	(*gql_doc_eval_func)(agooErr err, gqlDoc doc) = NULL;
+agooText	(*gql_build_headers)(agooErr err, agooReq req, agooText headers)  = NULL;
+agooText	gql_headers = NULL;
 
 static void
 err_resp(agooRes res, agooErr err, int status) {
@@ -93,25 +94,74 @@ value_resp(agooReq req, gqlValue result, int status, int indent) {
 	    break;
 	default:
 	    agoo_log_cat(&agoo_error_cat, "Did not expect an HTTP status of %d.", status);
-	    return;
+	    agoo_err_set(&err, AGOO_ERR_EVAL, "Did not expect an HTTP status of %d.", status);
+	    goto FAILED;
 	}
 	agoo_res_message_push(res, text);
 	return;
     }
     if (AGOO_ERR_OK != gql_object_set(&err, msg, "data", result)) {
-	err_resp(res, &err, 500);
-	gql_value_destroy(result);
-	return;
+	goto FAILED;
     }
     text = gql_value_json(text, msg, indent, 0);
     gql_value_destroy(msg); // also destroys result
+    result = NULL;
 
     cnt = snprintf(buf, sizeof(buf), "HTTP/1.1 %d %s\r\nContent-Type: application/json\r\nContent-Length: %ld\r\n\r\n",
 		   status, agoo_http_code_message(status), text->len);
-    if (NULL == (text = agoo_text_prepend(text, buf, cnt))) {
-	agoo_log_cat(&agoo_error_cat, "Failed to allocate memory for a response.");
+    if (NULL != gql_headers || NULL != gql_build_headers) {
+	agooText	headers = agoo_text_allocate(4094);
+
+	headers = agoo_text_append(headers, buf, cnt - 2);
+	if (NULL == headers) {
+	    agoo_log_cat(&agoo_error_cat, "Failed to allocate memory for a response.");
+	    return;
+	}
+	if (NULL != gql_headers) {
+	    headers = agoo_text_append(headers, gql_headers->text, (int)gql_headers->len);
+	} else {
+	    headers = gql_build_headers(&err, req, headers);
+	}
+	headers = agoo_text_append(headers, "\r\n", 2);
+	if (NULL == headers) {
+	    agoo_log_cat(&agoo_error_cat, "Failed to allocate memory for a response.");
+	    return;
+	}
+	if (NULL == (text = agoo_text_prepend(text, headers->text, (int)headers->len))) {
+	    agoo_log_cat(&agoo_error_cat, "Failed to allocate memory for a response.");
+	    agoo_text_release(headers);
+	    return;
+	}
+	agoo_text_release(headers);
+    } else {
+	if (NULL == (text = agoo_text_prepend(text, buf, cnt))) {
+	    agoo_log_cat(&agoo_error_cat, "Failed to allocate memory for a response.");
+	    return;
+	}
     }
     agoo_res_message_push(res, text);
+
+    return;
+
+FAILED:
+    err_resp(res, &err, 500);
+    if (NULL != result) {
+	gql_value_destroy(result);
+    }
+    return;
+}
+
+agooText
+gql_add_header(agooErr err, agooText headers, const char *key, const char *value) {
+    headers = agoo_text_append(headers, key, -1);
+    headers = agoo_text_append(headers, ": ", 2);
+    headers = agoo_text_append(headers, value, -1);
+    headers = agoo_text_append(headers, "\r\n", 2);
+
+    if (NULL == headers) {
+	AGOO_ERR_MEM(err, "headers");
+    }
+    return headers;
 }
 
 gqlValue
@@ -416,6 +466,7 @@ gql_eval_get_hook(agooReq req) {
 	return;
     }
     set_doc_op(doc, op_name, oplen);
+    doc->req = req;
 
     if (NULL == gql_doc_eval_func) {
 	result = gql_doc_eval(&err, doc);
@@ -488,8 +539,6 @@ eval_post(agooErr err, agooReq req) {
     gqlValue		result = NULL;
     gqlValue		j = NULL;
 
-    // TBD handle query parameter and concatenate with JSON body variables if present
-
     op_name = agoo_req_query_value(req, operation_name_str, sizeof(operation_name_str) - 1, &oplen);
     var_json = agoo_req_query_value(req, variables_str, sizeof(variables_str) - 1, &vlen);
 
@@ -502,11 +551,11 @@ eval_post(agooErr err, agooReq req) {
 	agoo_err_set(err, AGOO_ERR_TYPE, "required Content-Type not in the HTTP header");
 	return NULL;
     }
-    if (0 == strncmp(graphql_content_type, s, sizeof(graphql_content_type) - 1)) {
+    if (0 == strncasecmp(graphql_content_type, s, sizeof(graphql_content_type) - 1)) {
 	if (NULL == (doc = sdl_parse_doc(err, req->body.start, req->body.len, vars, GQL_QUERY))) {
 	    return NULL;
 	}
-    } else if (0 == strncmp(json_content_type, s, sizeof(json_content_type) - 1)) {
+    } else if (0 == strncasecmp(json_content_type, s, sizeof(json_content_type) - 1)) {
 	gqlLink	m;
 
 	if (NULL != (j = gql_json_parse(err, req->body.start, req->body.len))) {
@@ -532,19 +581,24 @@ eval_post(agooErr err, agooReq req) {
 		} else if (0 == strcmp("variables", m->key)) {
 		    gqlLink	link;
 
-		    if (GQL_SCALAR_OBJECT != m->value->type->scalar_kind) {
-			agoo_err_set(err, AGOO_ERR_EVAL, "expected variables to be an object.");
-			goto DONE;
-		    }
-		    for (link = m->value->members; NULL != link; link = link->next) {
-			gqlVar	v = gql_op_var_create(err, link->key, link->value->type, link->value);
+		    switch (m->value->type->scalar_kind) {
+		    case GQL_SCALAR_OBJECT:
+			for (link = m->value->members; NULL != link; link = link->next) {
+			    gqlVar	v = gql_op_var_create(err, link->key, link->value->type, link->value);
 
-			link->value = NULL;
-			if (NULL == v) {
-			    goto DONE;
+			    link->value = NULL;
+			    if (NULL == v) {
+				goto DONE;
+			    }
+			    v->next = vars;
+			    vars = v;
 			}
-			v->next = vars;
-			vars = v;
+			break;
+		    case GQL_SCALAR_NULL:
+			break;
+		    default:
+			agoo_err_set(err, AGOO_ERR_EVAL, "expected variables to be an object or null.");
+			goto DONE;
 		    }
 		}
 	    }
@@ -559,6 +613,7 @@ eval_post(agooErr err, agooReq req) {
 	return NULL;
     }
     set_doc_op(doc, op_name, oplen);
+    doc->req = req;
 
     if (NULL == gql_doc_eval_func) {
 	result = gql_doc_eval(err, doc);
@@ -569,7 +624,9 @@ eval_post(agooErr err, agooReq req) {
 	result = NULL;
     }
 DONE:
-    gql_doc_destroy(doc);
+    if (NULL != doc) {
+	gql_doc_destroy(doc);
+    }
     gql_value_destroy(j);
 
     return result;
@@ -595,6 +652,13 @@ gql_eval_post_hook(agooReq req) {
     }
 }
 
+void
+gql_eval_options_hook(agooReq req) {
+    struct _agooErr	err = AGOO_ERR_INIT;
+
+    value_resp(req, gql_object_create(&err), 200, 0);
+}
+
 gqlValue
 gql_get_arg_value(gqlKeyVal args, const char *key) {
     gqlValue	value = NULL;