@readme/httpsnippet 4.0.1 → 4.0.4

package/src/targets/node/unirest/fixtures/headers.js

@@ -1,15 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('GET', 'https://httpbin.org/headers');
-
-req.headers({
-  accept: 'application/json',
-  'x-foo': 'Bar',
-  'x-bar': 'Foo'
-});
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/http-insecure.js

@@ -1,9 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('GET', 'http://httpbin.org/anything');
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/jsonObj-multiline.js

@@ -1,18 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('POST', 'https://httpbin.org/anything');
-
-req.headers({
-  'content-type': 'application/json'
-});
-
-req.type('json');
-req.send({
-  foo: 'bar'
-});
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/jsonObj-null-value.js

@@ -1,18 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('POST', 'https://httpbin.org/anything');
-
-req.headers({
-  'content-type': 'application/json'
-});
-
-req.type('json');
-req.send({
-  foo: null
-});
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/multipart-data.js

@@ -1,23 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('POST', 'https://httpbin.org/anything');
-
-req.headers({
-  'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
-});
-
-req.multipart([
-  {
-    body: 'Hello World',
-    'content-type': 'text/plain'
-  },
-  {
-    body: 'Bonjour le monde'
-  }
-]);
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/multipart-file.js

@@ -1,21 +0,0 @@
-const fs = require('fs');
-const unirest = require('unirest');
-
-const req = unirest('POST', 'https://httpbin.org/anything');
-
-req.headers({
-  'content-type': 'multipart/form-data; boundary=---011000010111000001101001'
-});
-
-req.multipart([
-  {
-    body: fs.createReadStream('src/fixtures/files/hello.txt'),
-    'content-type': 'text/plain'
-  }
-]);
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/multipart-form-data-no-params.js

@@ -1,13 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('POST', 'https://httpbin.org/anything');
-
-req.headers({
-  'Content-Type': 'multipart/form-data'
-});
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/multipart-form-data.js

@@ -1,19 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('POST', 'https://httpbin.org/anything');
-
-req.headers({
-  'Content-Type': 'multipart/form-data; boundary=---011000010111000001101001'
-});
-
-req.multipart([
-  {
-    body: 'bar'
-  }
-]);
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/nested.js

@@ -1,15 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('GET', 'https://httpbin.org/anything');
-
-req.query({
-  'foo[bar]': 'baz,zap',
-  fiz: 'buz',
-  key: 'value'
-});
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/query-encoded.js

@@ -1,14 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('GET', 'https://httpbin.org/anything');
-
-req.query({
-  startTime: '2019-06-13T19%3A08%3A25.455Z',
-  endTime: '2015-09-15T14%3A00%3A12-04%3A00'
-});
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/query.js

@@ -1,18 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('GET', 'https://httpbin.org/anything');
-
-req.query({
-  foo: [
-    'bar',
-    'baz'
-  ],
-  baz: 'abc',
-  key: 'value'
-});
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/short.js

@@ -1,9 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('GET', 'https://httpbin.org/anything');
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/node/unirest/fixtures/text-plain.js

@@ -1,15 +0,0 @@
-const unirest = require('unirest');
-
-const req = unirest('POST', 'https://httpbin.org/anything');
-
-req.headers({
-  'content-type': 'text/plain'
-});
-
-req.send('Hello World');
-
-req.end(function (res) {
-  if (res.error) throw new Error(res.error);
-
-  console.log(res.body);
-});

package/src/targets/objc/helpers.ts

@@ -1,60 +0,0 @@
-/**
- * Create a string corresponding to a valid declaration and initialization of an Objective-C object literal.
- *
- * @param nsClass Class of the litteral
- * @param name Desired name of the instance
- * @param parameters Key-value object of parameters to translate to an Objective-C object litearal
- * @param indent If true, will declare the litteral by indenting each new key/value pair.
- * @return A valid Objective-C declaration and initialization of an Objective-C object litteral.
- *
- * @example
- *   nsDeclaration('NSDictionary', 'params', {a: 'b', c: 'd'}, true)
- *   // returns:
- *   NSDictionary *params = @{ @"a": @"b",
- *                             @"c": @"d" };
- *
- *   nsDeclaration('NSDictionary', 'params', {a: 'b', c: 'd'})
- *   // returns:
- *   NSDictionary *params = @{ @"a": @"b", @"c": @"d" };
- */
-export const nsDeclaration = (nsClass: string, name: string, parameters: Record<string, any>, indent?: boolean) => {
-  const opening = `${nsClass} *${name} = `;
-  const literal = literalRepresentation(parameters, indent ? opening.length : undefined);
-  return `${opening}${literal};`;
-};
-
-/**
- * Create a valid Objective-C string of a literal value according to its type.
- *
- * @param value Any JavaScript literal
- */
-export const literalRepresentation = (value: any, indentation?: number): string => {
-  const join = indentation === undefined ? ', ' : `,\n   ${' '.repeat(indentation)}`;
-
-  switch (Object.prototype.toString.call(value)) {
-    case '[object Number]':
-      return `@${value}`;
-
-    case '[object Array]': {
-      const valuesRepresentation = value.map((val: any) => literalRepresentation(val));
-      return `@[ ${valuesRepresentation.join(join)} ]`;
-    }
-
-    case '[object Object]': {
-      const keyValuePairs: string[] = [];
-      Object.keys(value).forEach(key => {
-        keyValuePairs.push(`@"${key}": ${literalRepresentation(value[key])}`);
-      });
-      return `@{ ${keyValuePairs.join(join)} }`;
-    }
-
-    case '[object Boolean]':
-      return value ? '@YES' : '@NO';
-
-    default:
-      if (value === null || value === undefined) {
-        return '';
-      }
-      return `@"${value.toString().replace(/"/g, '\\"')}"`;
-  }
-};

package/src/targets/objc/nsurlsession/client.test.ts

@@ -1,36 +0,0 @@
-import type { Request } from '../../..';
-import full from '../../../fixtures/requests/full';
-import jsonNullValue from '../../../fixtures/requests/jsonObj-null-value';
-import short from '../../../fixtures/requests/short';
-import { runCustomFixtures } from '../../../fixtures/runCustomFixtures';
-
-runCustomFixtures({
-  targetId: 'objc',
-  clientId: 'nsurlsession',
-  tests: [
-    {
-      it: 'should support an indent option',
-      input: short.log.entries[0].request as Request,
-      options: { indent: '  ' },
-      expected: 'indent-option.m',
-    },
-    {
-      it: 'should support a timeout option',
-      input: short.log.entries[0].request as Request,
-      options: { timeout: 5 },
-      expected: 'timeout-option.m',
-    },
-    {
-      it: 'should support pretty option',
-      input: full.log.entries[0].request as Request,
-      options: { pretty: false },
-      expected: 'pretty-option.m',
-    },
-    {
-      it: 'should support json object with null value',
-      input: jsonNullValue as unknown as Request,
-      options: { pretty: false },
-      expected: 'json-with-null-value.m',
-    },
-  ],
-});

package/src/targets/objc/nsurlsession/client.ts

@@ -1,164 +0,0 @@
-/**
- * @description
- * HTTP code snippet generator for Objective-C using NSURLSession.
- *
- * @author
- * @thibaultCha
- *
- * for any questions or issues regarding the generated code snippet, please open an issue mentioning the author.
- */
-
-import type { Client } from '../../targets';
-import { CodeBuilder } from '../../../helpers/code-builder';
-import { nsDeclaration } from '../helpers';
-
-export interface NsurlsessionOptions {
-  pretty?: boolean;
-  timeout?: number;
-}
-
-export const nsurlsession: Client<NsurlsessionOptions> = {
-  info: {
-    key: 'nsurlsession',
-    title: 'NSURLSession',
-    link: 'https://developer.apple.com/library/mac/documentation/Foundation/Reference/NSURLSession_class/index.html',
-    description: "Foundation's NSURLSession request",
-  },
-  convert: ({ allHeaders, postData, method, fullUrl }, options) => {
-    const opts = {
-      indent: '    ',
-      pretty: true,
-      timeout: 10,
-      ...options,
-    };
-
-    const { push, join, blank } = new CodeBuilder({ indent: opts.indent });
-    // Markers for headers to be created as literal objects and later be set on the NSURLRequest if exist
-    const req = {
-      hasHeaders: false,
-      hasBody: false,
-    };
-
-    // We just want to make sure people understand that is the only dependency
-    push('#import <Foundation/Foundation.h>');
-
-    if (Object.keys(allHeaders).length) {
-      req.hasHeaders = true;
-      blank();
-      push(nsDeclaration('NSDictionary', 'headers', allHeaders, opts.pretty));
-    }
-
-    if (postData.text || postData.jsonObj || postData.params) {
-      req.hasBody = true;
-
-      switch (postData.mimeType) {
-        case 'application/x-www-form-urlencoded':
-          if (postData.params) {
-            // By appending parameters one by one in the resulting snippet,
-            // we make it easier for the user to edit it according to his or her needs after pasting.
-            // The user can just add/remove lines adding/removing body parameters.
-            blank();
-
-            const [head, ...tail] = postData.params;
-            push(
-              `NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"${head.name}=${head.value}" dataUsingEncoding:NSUTF8StringEncoding]];`
-            );
-
-            tail.forEach(({ name, value }) => {
-              push(`[postData appendData:[@"&${name}=${value}" dataUsingEncoding:NSUTF8StringEncoding]];`);
-            });
-          } else {
-            req.hasBody = false;
-          }
-          break;
-
-        case 'application/json':
-          if (postData.jsonObj) {
-            push(nsDeclaration('NSDictionary', 'parameters', postData.jsonObj, opts.pretty));
-            blank();
-            push('NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];');
-          }
-          break;
-
-        case 'multipart/form-data':
-          // By appending multipart parameters one by one in the resulting snippet,
-          // we make it easier for the user to edit it according to his or her needs after pasting.
-          // The user can just edit the parameters NSDictionary or put this part of a snippet in a multipart builder method.
-          push(nsDeclaration('NSArray', 'parameters', postData.params || [], opts.pretty));
-          push(`NSString *boundary = @"${postData.boundary}";`);
-          blank();
-          push('NSError *error;');
-          push('NSMutableString *body = [NSMutableString string];');
-          push('for (NSDictionary *param in parameters) {');
-          push('[body appendFormat:@"--%@\\r\\n", boundary];', 1);
-          push('if (param[@"fileName"]) {', 1);
-          push(
-            '[body appendFormat:@"Content-Disposition:form-data; name=\\"%@\\"; filename=\\"%@\\"\\r\\n", param[@"name"], param[@"fileName"]];',
-            2
-          );
-          push('[body appendFormat:@"Content-Type: %@\\r\\n\\r\\n", param[@"contentType"]];', 2);
-          push(
-            '[body appendFormat:@"%@", [NSString stringWithContentsOfFile:param[@"fileName"] encoding:NSUTF8StringEncoding error:&error]];',
-            2
-          );
-          push('if (error) {', 2);
-          push('NSLog(@"%@", error);', 3);
-          push('}', 2);
-          push('} else {', 1);
-          push('[body appendFormat:@"Content-Disposition:form-data; name=\\"%@\\"\\r\\n\\r\\n", param[@"name"]];', 2);
-          push('[body appendFormat:@"%@", param[@"value"]];', 2);
-          push('}', 1);
-          push('}');
-          push('[body appendFormat:@"\\r\\n--%@--\\r\\n", boundary];');
-          push('NSData *postData = [body dataUsingEncoding:NSUTF8StringEncoding];');
-          break;
-
-        default:
-          blank();
-          push(
-            `NSData *postData = [[NSData alloc] initWithData:[@"${postData.text}" dataUsingEncoding:NSUTF8StringEncoding]];`
-          );
-      }
-    }
-
-    blank();
-    push(`NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"${fullUrl}"]`);
-
-    // NSURLRequestUseProtocolCachePolicy is the default policy, let's just always set it to avoid confusion.
-    push('                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy');
-    push(`                                                   timeoutInterval:${opts.timeout.toFixed(1)}];`);
-    push(`[request setHTTPMethod:@"${method}"];`);
-
-    if (req.hasHeaders) {
-      push('[request setAllHTTPHeaderFields:headers];');
-    }
-
-    if (req.hasBody) {
-      push('[request setHTTPBody:postData];');
-    }
-
-    blank();
-
-    // Retrieving the shared session will be less verbose than creating a new one.
-    push('NSURLSession *session = [NSURLSession sharedSession];');
-    push('NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request');
-    push(
-      '                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {'
-    );
-    push('                                            if (error) {', 1);
-    push('                                            NSLog(@"%@", error);', 2);
-    push('                                            } else {', 1);
-
-    // Casting the NSURLResponse to NSHTTPURLResponse so the user can see the status     .
-    push(
-      '                                            NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;',
-      2
-    );
-    push('                                            NSLog(@"%@", httpResponse);', 2);
-    push('                                            }', 1);
-    push('                                            }];');
-    push('[dataTask resume];');
-
-    return join();
-  },
-};

package/src/targets/objc/nsurlsession/fixtures/application-form-encoded.m

@@ -1,25 +0,0 @@
-#import <Foundation/Foundation.h>
-
-NSDictionary *headers = @{ @"content-type": @"application/x-www-form-urlencoded" };
-
-NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"foo=bar" dataUsingEncoding:NSUTF8StringEncoding]];
-[postData appendData:[@"&hello=world" dataUsingEncoding:NSUTF8StringEncoding]];
-
-NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://httpbin.org/anything"]
-                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy
-                                                   timeoutInterval:10.0];
-[request setHTTPMethod:@"POST"];
-[request setAllHTTPHeaderFields:headers];
-[request setHTTPBody:postData];
-
-NSURLSession *session = [NSURLSession sharedSession];
-NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
-                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
-                                                if (error) {
-                                                    NSLog(@"%@", error);
-                                                } else {
-                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
-                                                    NSLog(@"%@", httpResponse);
-                                                }
-                                            }];
-[dataTask resume];

package/src/targets/objc/nsurlsession/fixtures/application-json.m

@@ -1,30 +0,0 @@
-#import <Foundation/Foundation.h>
-
-NSDictionary *headers = @{ @"content-type": @"application/json" };
-NSDictionary *parameters = @{ @"number": @1,
-                              @"string": @"f\"oo",
-                              @"arr": @[ @1, @2, @3 ],
-                              @"nested": @{ @"a": @"b" },
-                              @"arr_mix": @[ @1, @"a", @{ @"arr_mix_nested": @{  } } ],
-                              @"boolean": @NO };
-
-NSData *postData = [NSJSONSerialization dataWithJSONObject:parameters options:0 error:nil];
-
-NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://httpbin.org/anything"]
-                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy
-                                                   timeoutInterval:10.0];
-[request setHTTPMethod:@"POST"];
-[request setAllHTTPHeaderFields:headers];
-[request setHTTPBody:postData];
-
-NSURLSession *session = [NSURLSession sharedSession];
-NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
-                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
-                                                if (error) {
-                                                    NSLog(@"%@", error);
-                                                } else {
-                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
-                                                    NSLog(@"%@", httpResponse);
-                                                }
-                                            }];
-[dataTask resume];

package/src/targets/objc/nsurlsession/fixtures/cookies.m

@@ -1,21 +0,0 @@
-#import <Foundation/Foundation.h>
-
-NSDictionary *headers = @{ @"cookie": @"foo=bar; bar=baz" };
-
-NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://httpbin.org/cookies"]
-                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy
-                                                   timeoutInterval:10.0];
-[request setHTTPMethod:@"GET"];
-[request setAllHTTPHeaderFields:headers];
-
-NSURLSession *session = [NSURLSession sharedSession];
-NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
-                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
-                                                if (error) {
-                                                    NSLog(@"%@", error);
-                                                } else {
-                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
-                                                    NSLog(@"%@", httpResponse);
-                                                }
-                                            }];
-[dataTask resume];

package/src/targets/objc/nsurlsession/fixtures/custom-method.m

@@ -1,18 +0,0 @@
-#import <Foundation/Foundation.h>
-
-NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://httpbin.org/anything"]
-                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy
-                                                   timeoutInterval:10.0];
-[request setHTTPMethod:@"PROPFIND"];
-
-NSURLSession *session = [NSURLSession sharedSession];
-NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
-                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
-                                                if (error) {
-                                                    NSLog(@"%@", error);
-                                                } else {
-                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
-                                                    NSLog(@"%@", httpResponse);
-                                                }
-                                            }];
-[dataTask resume];

package/src/targets/objc/nsurlsession/fixtures/full.m

@@ -1,26 +0,0 @@
-#import <Foundation/Foundation.h>
-
-NSDictionary *headers = @{ @"cookie": @"foo=bar; bar=baz",
-                           @"accept": @"application/json",
-                           @"content-type": @"application/x-www-form-urlencoded" };
-
-NSMutableData *postData = [[NSMutableData alloc] initWithData:[@"foo=bar" dataUsingEncoding:NSUTF8StringEncoding]];
-
-NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://httpbin.org/anything?foo=bar&foo=baz&baz=abc&key=value"]
-                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy
-                                                   timeoutInterval:10.0];
-[request setHTTPMethod:@"POST"];
-[request setAllHTTPHeaderFields:headers];
-[request setHTTPBody:postData];
-
-NSURLSession *session = [NSURLSession sharedSession];
-NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
-                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
-                                                if (error) {
-                                                    NSLog(@"%@", error);
-                                                } else {
-                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
-                                                    NSLog(@"%@", httpResponse);
-                                                }
-                                            }];
-[dataTask resume];

package/src/targets/objc/nsurlsession/fixtures/headers.m

@@ -1,23 +0,0 @@
-#import <Foundation/Foundation.h>
-
-NSDictionary *headers = @{ @"accept": @"application/json",
-                           @"x-foo": @"Bar",
-                           @"x-bar": @"Foo" };
-
-NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://httpbin.org/headers"]
-                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy
-                                                   timeoutInterval:10.0];
-[request setHTTPMethod:@"GET"];
-[request setAllHTTPHeaderFields:headers];
-
-NSURLSession *session = [NSURLSession sharedSession];
-NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
-                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
-                                                if (error) {
-                                                    NSLog(@"%@", error);
-                                                } else {
-                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
-                                                    NSLog(@"%@", httpResponse);
-                                                }
-                                            }];
-[dataTask resume];

package/src/targets/objc/nsurlsession/fixtures/http-insecure.m

@@ -1,18 +0,0 @@
-#import <Foundation/Foundation.h>
-
-NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"http://httpbin.org/anything"]
-                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy
-                                                   timeoutInterval:10.0];
-[request setHTTPMethod:@"GET"];
-
-NSURLSession *session = [NSURLSession sharedSession];
-NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
-                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
-                                                if (error) {
-                                                    NSLog(@"%@", error);
-                                                } else {
-                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
-                                                    NSLog(@"%@", httpResponse);
-                                                }
-                                            }];
-[dataTask resume];