Generate Crystal language code (#343)

* Generate Crystal language code

* Generate Crystal language code

* Remove a blank line

* fix crystal tests

---------

Co-authored-by: Filipe Freire <livrofubia@gmail.com>

README.md

@@ -2,7 +2,7 @@
 
 [![version][npm-version]][npm-url] [![License][npm-license]][license-url]
 
-> HTTP Request snippet generator for _many_ languages & tools including: `cURL`, `HTTPie`, `JavaScript`, `Node`, `C`, `Java`, `PHP`, `Objective-C`, `Swift`, `Python`, `Ruby`, `C#`, `Go`, `OCaml` and [more](https://github.com/Kong/httpsnippet/wiki/Targets)!
+> HTTP Request snippet generator for _many_ languages & tools including: `cURL`, `HTTPie`, `JavaScript`, `Node`, `C`, `Java`, `PHP`, `Objective-C`, `Swift`, `Python`, `Ruby`, `C#`, `Go`, `OCaml`, `Crystal` and [more](https://github.com/Kong/httpsnippet/wiki/Targets)!
 
 Relies on the popular [HAR](http://www.softwareishard.com/blog/har-12-spec/#request) format to import data and describe HTTP calls.
 

package.json

@@ -11,6 +11,7 @@
  "keywords": [
  "api",
  "clojure",
+ "crystal",
  "csharp",
  "curl",
  "go",

src/helpers/__snapshots__/utils.test.ts.snap

@@ -30,6 +30,20 @@ Array [
  "key": "clojure",
  "title": "Clojure",
  },
+ Object {
+ "clients": Array [
+ Object {
+ "description": "Crystal HTTP client",
+ "key": "native",
+ "link": "https://crystal-lang.org/api/master/HTTP/Client.html",
+ "title": "http::client",
+ },
+ ],
+ "default": "native",
+ "extname": ".cr",
+ "key": "crystal",
+ "title": "Crystal",
+ },
  Object {
  "clients": Array [
  Object {

src/targets/crystal/native/client.test.ts

@@ -0,0 +1,18 @@
+import https from '../../../fixtures/requests/https.json';
+import { runCustomFixtures } from '../../../fixtures/runCustomFixtures';
+import { Request } from '../../../httpsnippet';
+
+runCustomFixtures({
+ targetId: 'crystal',
+ clientId: 'native',
+ tests: [
+ {
+ it: 'should support the insecureSkipVerify option',
+ input: https as Request,
+ options: {
+ insecureSkipVerify: true,
+ },
+ expected: 'insecure-skip-verify.cr',
+ },
+ ],
+});

src/targets/crystal/native/client.ts

@@ -0,0 +1,72 @@
+/**
+ * @description
+ * HTTP code snippet generator for native Crystal
+ *
+ * @author
+ * @18183883296
+ *
+ * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
+ */
+import { CodeBuilder } from '../../../helpers/code-builder';
+import { escapeForDoubleQuotes } from '../../../helpers/escape';
+import { Client } from '../../targets';
+
+export interface CrystalNativeOptions {
+ insecureSkipVerify?: boolean;
+}
+
+export const native: Client<CrystalNativeOptions> = {
+ info: {
+ key: 'native',
+ title: 'http::client',
+ link: 'https://crystal-lang.org/api/master/HTTP/Client.html',
+ description: 'Crystal HTTP client',
+ },
+ convert: ({ method: rawMethod, fullUrl, postData, allHeaders }, options = {}) => {
+ const { insecureSkipVerify = false } = options;
+
+ const { push, blank, join } = new CodeBuilder();
+
+ push('require "http/client"');
+
+ blank();
+
+ push(`url = "${fullUrl}"`);
+
+ const headers = Object.keys(allHeaders);
+ if (headers.length) {
+ push('headers = HTTP::Headers{');
+ headers.forEach(key => {
+ push(` "${key}" => "${escapeForDoubleQuotes(allHeaders[key])}"`);
+ });
+ push('}');
+ }
+
+ if (postData.text) {
+ push(`reqBody = ${JSON.stringify(postData.text)}`);
+ }
+
+ blank();
+
+ const method = rawMethod.toUpperCase();
+ const methods = ['GET', 'POST', 'HEAD', 'DELETE', 'PATCH', 'PUT', 'OPTIONS'];
+
+ const headersContext = headers.length ? ', headers: headers' : '';
+ const bodyContext = postData.text ? ', body: reqBody' : '';
+ const sslContext = insecureSkipVerify ? ', tls: OpenSSL::SSL::Context::Client.insecure' : '';
+
+ if (methods.includes(method)) {
+ push(
+ `response = HTTP::Client.${method.toLowerCase()} url${headersContext}${bodyContext}${sslContext}`,
+ );
+ } else {
+ push(
+ `response = HTTP::Client.exec "${method}", url${headersContext}${bodyContext}${sslContext}`,
+ );
+ }
+
+ push('puts response.body');
+
+ return join();
+ },
+};

src/targets/crystal/native/fixtures/application-form-encoded.cr

@@ -0,0 +1,10 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+headers = HTTP::Headers{
+ "content-type" => "application/x-www-form-urlencoded"
+}
+reqBody = "foo=bar&hello=world"
+
+response = HTTP::Client.post url, headers: headers, body: reqBody
+puts response.body

src/targets/crystal/native/fixtures/application-json.cr

@@ -0,0 +1,10 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+headers = HTTP::Headers{
+ "content-type" => "application/json"
+}
+reqBody = "{\"number\":1,\"string\":\"f\\\"oo\",\"arr\":[1,2,3],\"nested\":{\"a\":\"b\"},\"arr_mix\":[1,\"a\",{\"arr_mix_nested\":{}}],\"boolean\":false}"
+
+response = HTTP::Client.post url, headers: headers, body: reqBody
+puts response.body

src/targets/crystal/native/fixtures/cookies.cr

@@ -0,0 +1,9 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+headers = HTTP::Headers{
+ "cookie" => "foo=bar; bar=baz"
+}
+
+response = HTTP::Client.post url, headers: headers
+puts response.body

src/targets/crystal/native/fixtures/custom-method.cr

@@ -0,0 +1,6 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+
+response = HTTP::Client.exec "PROPFIND", url
+puts response.body

src/targets/crystal/native/fixtures/full.cr

@@ -0,0 +1,12 @@
+require "http/client"
+
+url = "http://mockbin.com/har?foo=bar&foo=baz&baz=abc&key=value"
+headers = HTTP::Headers{
+ "cookie" => "foo=bar; bar=baz"
+ "accept" => "application/json"
+ "content-type" => "application/x-www-form-urlencoded"
+}
+reqBody = "foo=bar"
+
+response = HTTP::Client.post url, headers: headers, body: reqBody
+puts response.body

src/targets/crystal/native/fixtures/headers.cr

@@ -0,0 +1,11 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+headers = HTTP::Headers{
+ "accept" => "application/json"
+ "x-foo" => "Bar"
+ "quoted-value" => "\"quoted\" 'string'"
+}
+
+response = HTTP::Client.get url, headers: headers
+puts response.body

src/targets/crystal/native/fixtures/https.cr

@@ -0,0 +1,6 @@
+require "http/client"
+
+url = "https://mockbin.com/har"
+
+response = HTTP::Client.get url
+puts response.body

src/targets/crystal/native/fixtures/insecure-skip-verify.cr

@@ -0,0 +1,6 @@
+require "http/client"
+
+url = "https://mockbin.com/har"
+
+response = HTTP::Client.get url, tls: OpenSSL::SSL::Context::Client.insecure
+puts response.body

src/targets/crystal/native/fixtures/jsonObj-multiline.cr

@@ -0,0 +1,10 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+headers = HTTP::Headers{
+ "content-type" => "application/json"
+}
+reqBody = "{\n \"foo\": \"bar\"\n}"
+
+response = HTTP::Client.post url, headers: headers, body: reqBody
+puts response.body

src/targets/crystal/native/fixtures/jsonObj-null-value.cr

@@ -0,0 +1,10 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+headers = HTTP::Headers{
+ "content-type" => "application/json"
+}
+reqBody = "{\"foo\":null}"
+
+response = HTTP::Client.post url, headers: headers, body: reqBody
+puts response.body

src/targets/crystal/native/fixtures/multipart-data.cr

@@ -0,0 +1,10 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+headers = HTTP::Headers{
+ "content-type" => "multipart/form-data; boundary=---011000010111000001101001"
+}
+reqBody = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"; filename=\"hello.txt\"\r\nContent-Type: text/plain\r\n\r\nHello World\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bar\"\r\n\r\nBonjour le monde\r\n-----011000010111000001101001--\r\n"
+
+response = HTTP::Client.post url, headers: headers, body: reqBody
+puts response.body

src/targets/crystal/native/fixtures/multipart-file.cr

@@ -0,0 +1,10 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+headers = HTTP::Headers{
+ "content-type" => "multipart/form-data; boundary=---011000010111000001101001"
+}
+reqBody = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"; filename=\"hello.txt\"\r\nContent-Type: text/plain\r\n\r\n\r\n-----011000010111000001101001--\r\n"
+
+response = HTTP::Client.post url, headers: headers, body: reqBody
+puts response.body

src/targets/crystal/native/fixtures/multipart-form-data-no-params.cr

@@ -0,0 +1,9 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+headers = HTTP::Headers{
+ "Content-Type" => "multipart/form-data"
+}
+
+response = HTTP::Client.post url, headers: headers
+puts response.body

src/targets/crystal/native/fixtures/multipart-form-data.cr

@@ -0,0 +1,10 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+headers = HTTP::Headers{
+ "Content-Type" => "multipart/form-data; boundary=---011000010111000001101001"
+}
+reqBody = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"foo\"\r\n\r\nbar\r\n-----011000010111000001101001--\r\n"
+
+response = HTTP::Client.post url, headers: headers, body: reqBody
+puts response.body

src/targets/crystal/native/fixtures/nested.cr

@@ -0,0 +1,6 @@
+require "http/client"
+
+url = "http://mockbin.com/har?foo%5Bbar%5D=baz%2Czap&fiz=buz&key=value"
+
+response = HTTP::Client.get url
+puts response.body

src/targets/crystal/native/fixtures/query.cr

@@ -0,0 +1,6 @@
+require "http/client"
+
+url = "http://mockbin.com/har?foo=bar&foo=baz&baz=abc&key=value"
+
+response = HTTP::Client.get url
+puts response.body

src/targets/crystal/native/fixtures/short.cr

@@ -0,0 +1,6 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+
+response = HTTP::Client.get url
+puts response.body

src/targets/crystal/native/fixtures/text-plain.cr

@@ -0,0 +1,10 @@
+require "http/client"
+
+url = "http://mockbin.com/har"
+headers = HTTP::Headers{
+ "content-type" => "text/plain"
+}
+reqBody = "Hello World"
+
+response = HTTP::Client.post url, headers: headers, body: reqBody
+puts response.body

src/targets/crystal/target.ts

@@ -0,0 +1,14 @@
+import { Target } from '../targets';
+import { native } from './native/client';
+
+export const crystal: Target = {
+ info: {
+ key: 'crystal',
+ title: 'Crystal',
+ extname: '.cr',
+ default: 'native',
+ },
+ clientsById: {
+ native,
+ },
+};

src/targets/targets.test.ts

@@ -84,6 +84,7 @@ availableTargets()
  expect(result).toStrictEqual(expected);
  });
  } catch (error) {
+ console.error(error);
  throw new Error(
  `Missing a test file for ${targetId}:${clientId} for the ${fixture} fixture.\nExpected to find the output fixture: \`/src/targets/${targetId}/${clientId}/fixtures/${fixture}${fixtureExtension}\``,
  );

src/targets/targets.ts

@@ -4,6 +4,7 @@ import { CodeBuilderOptions } from '../helpers/code-builder';
 import { Request } from '../httpsnippet';
 import { c } from './c/target';
 import { clojure } from './clojure/target';
+import { crystal } from './crystal/target';
 import { csharp } from './csharp/target';
 import { go } from './go/target';
 import { http } from './http/target';
@@ -60,6 +61,7 @@ export interface Target {
 export const targets = {
  c,
  clojure,
+ crystal,
  csharp,
  go,
  http,