@wiajs/request 3.0.0 → 3.0.1

package/examples/README.md

@@ -0,0 +1,135 @@
+
+# Authentication
+
+## OAuth
+
+### OAuth1.0 Refresh Token
+
+- http://oauth.googlecode.com/svn/spec/ext/session/1.0/drafts/1/spec.html#anchor4
+- https://developer.yahoo.com/oauth/guide/oauth-refreshaccesstoken.html
+
+```js
+request.post('https://api.login.yahoo.com/oauth/v2/get_token', {
+  oauth: {
+    consumer_key: '...',
+    consumer_secret: '...',
+    token: '...',
+    token_secret: '...',
+    session_handle: '...'
+  }
+}, function (err, res, body) {
+  var result = require('querystring').parse(body)
+  // assert.equal(typeof result, 'object')
+})
+```
+
+### OAuth2 Refresh Token
+
+- https://tools.ietf.org/html/draft-ietf-oauth-v2-31#section-6
+
+```js
+request.post('https://accounts.google.com/o/oauth2/token', {
+  form: {
+    grant_type: 'refresh_token',
+    client_id: '...',
+    client_secret: '...',
+    refresh_token: '...'
+  },
+  json: true
+}, function (err, res, body) {
+  // assert.equal(typeof body, 'object')
+})
+```
+
+# Multipart
+
+## multipart/form-data
+
+### Flickr Image Upload
+
+- https://www.flickr.com/services/api/upload.api.html
+
+```js
+request.post('https://up.flickr.com/services/upload', {
+  oauth: {
+    consumer_key: '...',
+    consumer_secret: '...',
+    token: '...',
+    token_secret: '...'
+  },
+  // all meta data should be included here for proper signing
+  qs: {
+    title: 'My cat is awesome',
+    description: 'Sent on ' + new Date(),
+    is_public: 1
+  },
+  // again the same meta data + the actual photo
+  formData: {
+    title: 'My cat is awesome',
+    description: 'Sent on ' + new Date(),
+    is_public: 1,
+    photo:fs.createReadStream('cat.png')
+  },
+  json: true
+}, function (err, res, body) {
+  // assert.equal(typeof body, 'object')
+})
+```
+
+# Streams
+
+## `POST` data
+
+Use Request as a Writable stream to easily `POST` Readable streams (like files, other HTTP requests, or otherwise).
+
+TL;DR: Pipe a Readable Stream onto Request via:
+
+```
+READABLE.pipe(request.post(URL));
+```
+
+A more detailed example:
+
+```js
+var fs = require('fs')
+  , path = require('path')
+  , http = require('http')
+  , request = require('request')
+  , TMP_FILE_PATH = path.join(path.sep, 'tmp', 'foo')
+;
+
+// write a temporary file:
+fs.writeFileSync(TMP_FILE_PATH, 'foo bar baz quk\n');
+
+http.createServer(function(req, res) {
+  console.log('the server is receiving data!\n');
+  req
+    .on('end', res.end.bind(res))
+    .pipe(process.stdout)
+  ;
+}).listen(3000).unref();
+
+fs.createReadStream(TMP_FILE_PATH)
+  .pipe(request.post('http://127.0.0.1:3000'))
+;
+```
+
+# Proxys
+
+Run tor on the terminal and try the following. (Needs `socks5-http-client` to connect to tor)
+
+```js
+var request = require('../index.js');
+var Agent = require('socks5-http-client/lib/Agent');
+
+request.get({
+    url: 'http://www.tenreads.io',
+    agentClass: Agent,
+    agentOptions: {
+        socksHost: 'localhost', // Defaults to 'localhost'.
+        socksPort: 9050 // Defaults to 1080.
+    }
+}, function (err, res) {
+    console.log(res.body); 
+});
+```

package/gulpfile.js

@@ -0,0 +1,71 @@
+/* eslint-disable import/no-extraneous-dependencies */
+import gulp from 'gulp'
+import fs from 'fs-extra'
+import {build} from './script/build.js'
+import configs from './script/config.js'
+
+const nodeEnv = process.env.NODE_ENV || 'development'
+const src = './src'
+const out = './dist'
+
+console.log(`env:${nodeEnv} src:${src} out:${out}`)
+
+if (!fs.existsSync(out)) {
+  fs.mkdirSync(out)
+}
+
+/**
+ * 删除已有发布文件，全部重新生成
+ * @returns
+ */
+async function clean(cb) {
+  // const toRemove = ['*.map'].map(cmd => `rm -rf ${cmd}`);
+  // await exec.promise(`cd dist && ${toRemove.join(' && ')}`);
+  await fs.emptyDir('./dist/')
+  cb && cb()
+}
+
+/**
+ * 同时生成umd、cjs、esm 三种格式输出文件
+ */
+const buildAll = gulp.series(clean, cb => {
+  console.log('start build ...')
+  build(configs, cb)
+})
+
+/**
+ * 仅生成cjs 格式
+ */
+gulp.task('cjs', cb => {
+  console.log('dev cjs...')
+  // filter configs
+  const cfg = configs.filter(c => c.output.format === 'cjs')
+  build(cfg, cb)
+})
+
+/**
+ * 仅生成 esm 格式
+ */
+gulp.task('esm', cb => {
+  console.log('dev esm...')
+  // filter configs
+  const cfg = configs.filter(c => c.output.format === 'esm')
+  build(cfg, cb)
+})
+
+/**
+ * 仅生成 umd 格式
+ */
+gulp.task('umd', cb => {
+  console.log('dev umd...')
+  // filter configs
+  const cfg = configs.filter(c => c.output.format === 'umd')
+  build(cfg, cb)
+})
+
+gulp.task('watch', () => {
+  gulp.watch(`${src}/*.js`, gulp.series([buildAll]))
+})
+
+export default buildAll
+export {buildAll as build}

package/package.json

@@ -2,7 +2,7 @@
   "name": "@wiajs/request",
   "description": "Stream HTTP request client.",
   "keywords": ["http", "simple", "util", "utility"],
-  "version": "3.0.0",
+  "version": "3.0.1",
   "type": "module",
   "main": "index.js",
   "exports": {
@@ -31,7 +31,6 @@
     "test-browser": "node tests/browser/start.js",
     "lint": "standard"
   },
-  "files": ["src/", "lib/", "index.js", "request.js"],
   "author": "Sibyl Yu <sibyl@wia.pub>",
   "contributors": ["Mikeal Rogers <mikeal.rogers@gmail.com>"],
   "repository": {

package/release.sh

@@ -0,0 +1,45 @@
+#!/bin/sh
+
+if [ -z "`which github-changes`" ]; then
+  # specify version because github-changes "is under heavy development. Things
+  # may break between releases" until 0.1.0
+  echo "First, do: [sudo] npm install -g github-changes@0.0.14"
+  exit 1
+fi
+
+if [ -d .git/refs/remotes/upstream ]; then
+  remote=upstream
+else
+  remote=origin
+fi
+
+# Increment v2.x.y -> v2.x+1.0
+npm version minor || exit 1
+
+# Generate changelog from pull requests
+github-changes -o request -r request \
+  --auth --verbose \
+  --file CHANGELOG.md \
+  --only-pulls --use-commit-body \
+  --date-format '(YYYY/MM/DD)' \
+  || exit 1
+
+# Since the tag for the new version hasn't been pushed yet, any changes in it
+# will be marked as "upcoming"
+version="$(grep '"version"' package.json | cut -d'"' -f4)"
+sed -i -e "s/^### upcoming/### v$version/" CHANGELOG.md
+
+# This may fail if no changelog updates
+# TODO: would this ever actually happen?  handle it better?
+git add CHANGELOG.md; git commit -m 'Update changelog'
+
+# Publish the new version to npm
+npm publish || exit 1
+
+# Increment v2.x.0 -> v2.x.1
+# For rationale, see:
+# https://github.com/request/oauth-sign/issues/10#issuecomment-58917018
+npm version patch || exit 1
+
+# Push back to the main repo
+git push $remote master --tags || exit 1

package/tests/browser/karma.conf.js

@@ -0,0 +1,57 @@
+'use strict'
+var istanbul = require('browserify-istanbul')
+
+module.exports = function (config) {
+  config.set({
+    client: { requestTestUrl: process.argv[4] },
+    basePath: '../..',
+    frameworks: ['tap', 'browserify'],
+    preprocessors: {
+      'tests/browser/test.js': ['browserify'],
+      '*.js,!(tests)/**/*.js': ['coverage']
+    },
+    files: [
+      'tests/browser/test.js'
+    ],
+    port: 9876,
+
+    reporters: ['dots', 'coverage'],
+
+    colors: true,
+
+    logLevel: config.LOG_ERROR,
+
+    autoWatch: false,
+
+    browsers: ['PhantomJS_without_security'],
+
+    singleRun: true,
+
+    plugins: [
+      'karma-phantomjs-launcher',
+      'karma-coverage',
+      'karma-browserify',
+      'karma-tap'
+    ],
+    browserify: {
+      debug: true,
+      transform: [istanbul({
+        ignore: ['**/node_modules/**', '**/tests/**']
+      })]
+    },
+    coverageReporter: {
+      type: 'lcov',
+      dir: 'coverage/'
+    },
+
+    // Custom launcher to allowe self signed certs.
+    customLaunchers: {
+      PhantomJS_without_security: {
+        base: 'PhantomJS',
+        flags: [
+          '--ignore-ssl-errors=true'
+        ]
+      }
+    }
+  })
+}

package/tests/browser/ssl/ca.crt

@@ -0,0 +1,14 @@
+-----BEGIN CERTIFICATE-----
+MIICKTCCAZICCQDB/6lRlsirjzANBgkqhkiG9w0BAQUFADBZMQswCQYDVQQGEwJB
+VTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50ZXJuZXQgV2lkZ2l0
+cyBQdHkgTHRkMRIwEAYDVQQDEwlsb2NhbGhvc3QwHhcNMTUwMTA3MTcwODM2WhcN
+MjUwMTA0MTcwODM2WjBZMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0
+ZTEhMB8GA1UEChMYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMRIwEAYDVQQDEwls
+b2NhbGhvc3QwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAMba6FQ1VkgW8vWa
+FBxV1VdLhQ5HP0eKZ/CyEGG4r89CzfzC0+V3bnFWGBGF2kSJlVjc7eVSSVio383A
+inq3i+86Mavfy18BwcP4I0NqUSvvcV9yduBLUySklJhOlhhHeFUlycQyxuODbrG9
+QOd411c4eccsbDHq5vSnS7AJh6tVAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEAI0H3
+bJIUQgnSGyrSHmjoKm66QLBPvQ1Zd7Zxjlg1uFv6glPOhdkeTQx9XQPT/WDG3qmJ
+BdHvQLDtPS9P8vRaiQW1OCP7dQJkVYCxyFbSQiieuzwBAEGtZcLdZbvcp3PKRGbx
+sIrkzyYdAXE1EZ5z7yLVcpWwTKnBnuRz2D0XOk4=
+-----END CERTIFICATE-----

package/tests/browser/ssl/server.crt

@@ -0,0 +1,14 @@
+-----BEGIN CERTIFICATE-----
+MIICKTCCAZICCQDl9xx8ZXLMPTANBgkqhkiG9w0BAQUFADBZMQswCQYDVQQGEwJB
+VTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50ZXJuZXQgV2lkZ2l0
+cyBQdHkgTHRkMRIwEAYDVQQDEwlsb2NhbGhvc3QwHhcNMTUwMTA3MTcwOTQ4WhcN
+MjUwMTA0MTcwOTQ4WjBZMQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0
+ZTEhMB8GA1UEChMYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMRIwEAYDVQQDEwls
+b2NhbGhvc3QwgZ8wDQYJKoZIhvcNAQEBBQADgY0AMIGJAoGBAKWxvvLNi8AcT0wI
+sf+LoWAvtoIV29ypI6j1JRqmsPO433JP/ijLhJLFc6RKXpKs6pd4am82vzk8Bxs3
+VtUXJ0yKh3KMevT7L4X1hw+QxvYAZD6Kl/kaNvKFTuAgcaeSnmnWGjQYLF/i20w7
+7dpeXDmnNMCKwdg+kLeJdPtW0d+vAgMBAAEwDQYJKoZIhvcNAQEFBQADgYEADL6l
+Z2mDKj4kPyGD58uBGeBHjmcDA2oJcnsHhOiC1u1NuCwQW4RDWs6Ili0GhuHYHP0B
+JDcPw6ZSa1Gx3ZaUJ5yM/+YHpbLev34CjmiwQeG36DF2rAxfoIQk/wI4iWmu1+ed
+5Wwc0cZAb10uy0ihmMK98yhVQPmkBOEyw2O1xJw=
+-----END CERTIFICATE-----

package/tests/browser/ssl/server.key

@@ -0,0 +1,15 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIICXAIBAAKBgQClsb7yzYvAHE9MCLH/i6FgL7aCFdvcqSOo9SUaprDzuN9yT/4o
+y4SSxXOkSl6SrOqXeGpvNr85PAcbN1bVFydMiodyjHr0+y+F9YcPkMb2AGQ+ipf5
+GjbyhU7gIHGnkp5p1ho0GCxf4ttMO+3aXlw5pzTAisHYPpC3iXT7VtHfrwIDAQAB
+AoGBAJa5edmk4NuA5SFlR4YOnl3BCWSMPdQciDPJzFbSC2WpZpm16p1xhMd+lhN9
+E0qZwUzIXQmN46VM1aoMTRDKXxPqujUIvhn7kxMLmD8lajHzFUIhgnp1XQCfxIIV
+sCcnIoP+cbnzP+AegAEPjds/0ngI3YM28UeooqZAmZCHQ0cBAkEAz0go7tCxXqED
++cY+P2axAKuGR+6srx08g5kONTpUx8jXr4su02F376dxhPB9UXWOJkYiGEBwKEds
+OnUSNTF/RQJBAMyjUzjb/u6sZqTcHd3owes3UsCC+kfSb814qdG3Z9qYX9p55ESu
+hA7Sbjq0WdTHGZdgEexwpfLtTRS8x5ldiGMCQFC3GLlmKqtep92rhLHLm0FXiYKZ
+PkUybU4RW6b+f+UMIHELEcDeQ4Xe/iV2QFZoIGJnDP/El+gXZ92bmOt9ysECQD/i
+zVx28gO5NuJJBdn9jGzOfLs1KMW7YMQY44thYr7Pyzz9yNHYWcn20Arruw++iLLF
+f1L9aBGLHAFZXkb2+FkCQA5/3Z3SgiZrRYX/bWcNe6N65+nGfJv8ZBVsX13pKOxR
+8JzJLyEmx67IOGZvVgfVABrCHJvTrKlUO3x3mDoEPzI=
+-----END RSA PRIVATE KEY-----

package/tests/browser/start.js

@@ -0,0 +1,37 @@
+'use strict'
+var spawn = require('child_process').spawn
+var https = require('https')
+var fs = require('fs')
+var path = require('path')
+
+var server = https.createServer({
+  key: fs.readFileSync(path.join(__dirname, '/ssl/server.key')),
+  cert: fs.readFileSync(path.join(__dirname, '/ssl/server.crt')),
+  ca: fs.readFileSync(path.join(__dirname, '/ssl/ca.crt')),
+  requestCert: true,
+  rejectUnauthorized: false
+}, function (req, res) {
+  // Set CORS header, since that is something we are testing.
+  res.setHeader('Access-Control-Allow-Origin', '*')
+  res.writeHead(200)
+  res.end('Can you hear the sound of an enormous door slamming in the depths of hell?\n')
+})
+server.listen(0, function () {
+  var port = this.address().port
+  console.log('Started https server for karma tests on port ' + port)
+  // Spawn process for karma.
+  var c = spawn('karma', [
+    'start',
+    path.join(__dirname, '/karma.conf.js'),
+    'https://localhost:' + port
+  ])
+  c.stdout.pipe(process.stdout)
+  c.stderr.pipe(process.stderr)
+  c.on('exit', function (c) {
+    // Exit process with karma exit code.
+    if (c !== 0) {
+      throw new Error('Karma exited with status code ' + c)
+    }
+    server.close()
+  })
+})

package/tests/browser/test.js

@@ -0,0 +1,34 @@
+'use strict'
+
+if (!Function.prototype.bind) {
+  // This is because of the fact that phantom.js does not have Function.bind.
+  // This is a bug in phantom.js.
+  // More info: https://github.com/ariya/phantomjs/issues/10522
+  /* eslint no-extend-native:0 */
+  Function.prototype.bind = require('function-bind')
+}
+
+var tape = require('tape')
+var request = require('../../index')
+
+tape('returns on error', function (t) {
+  t.plan(1)
+  request({
+    uri: 'https://stupid.nonexistent.path:port123/\\<-great-idea',
+    withCredentials: false
+  }, function (error, response) {
+    t.equal(typeof error, 'object')
+    t.end()
+  })
+})
+
+tape('succeeds on valid URLs (with https and CORS)', function (t) {
+  t.plan(1)
+  request({
+    uri: __karma__.config.requestTestUrl, // eslint-disable-line no-undef
+    withCredentials: false
+  }, function (_, response) {
+    t.equal(response.statusCode, 200)
+    t.end()
+  })
+})

package/tests/fixtures/har.json

@@ -0,0 +1,158 @@
+{
+  "application-form-encoded": {
+    "method": "POST",
+    "headers": [
+      {
+        "name": "content-type",
+        "value": "application/x-www-form-urlencoded"
+      }
+    ],
+    "postData": {
+      "mimeType": "application/x-www-form-urlencoded; charset=UTF-8",
+      "params": [
+        {
+          "name": "foo",
+          "value": "bar"
+        },
+        {
+          "name": "hello",
+          "value": "world"
+        }
+      ]
+    }
+  },
+
+  "application-json": {
+    "method": "POST",
+    "headers": [
+      {
+        "name": "content-type",
+        "value": "application/json"
+      }
+    ],
+    "postData": {
+      "mimeType": "application/json",
+      "text": "{\"number\":1,\"string\":\"f\\\"oo\",\"arr\":[1,2,3],\"nested\":{\"a\":\"b\"},\"arr_mix\":[1,\"a\",{\"arr_mix_nested\":{}}]}"
+    }
+  },
+
+  "cookies": {
+    "method": "POST",
+    "cookies":  [
+      {
+        "name": "foo",
+        "value": "bar"
+      },
+      {
+        "name": "bar",
+        "value": "baz"
+      }
+    ]
+  },
+
+  "custom-method": {
+    "method": "PROPFIND"
+  },
+
+  "headers": {
+    "method": "GET",
+    "headers": [
+      {
+        "name": "x-foo",
+        "value": "Bar"
+      }
+    ]
+  },
+
+  "multipart-data": {
+    "method": "POST",
+    "headers": [
+      {
+        "name": "content-type",
+        "value": "multipart/form-data"
+      }
+    ],
+    "postData": {
+      "mimeType": "multipart/form-data",
+      "params": [
+        {
+          "name": "foo",
+          "value": "Hello World",
+          "fileName": "hello.txt",
+          "contentType": "text/plain"
+        }
+      ]
+    }
+  },
+
+  "multipart-file": {
+    "method": "POST",
+    "headers": [
+      {
+        "name": "content-type",
+        "value": "multipart/form-data"
+      }
+    ],
+    "postData": {
+      "mimeType": "multipart/form-data",
+      "params": [
+        {
+          "name": "foo",
+          "fileName": "../tests/unicycle.jpg",
+          "contentType": "image/jpeg"
+        }
+      ]
+    }
+  },
+
+  "multipart-form-data": {
+    "method": "POST",
+    "headers": [
+      {
+        "name": "content-type",
+        "value": "multipart/form-data"
+      }
+    ],
+    "postData": {
+      "mimeType": "multipart/form-data",
+      "params": [
+        {
+          "name": "foo",
+          "value": "bar"
+        }
+      ]
+    }
+  },
+
+  "query": {
+    "method": "GET",
+    "queryString": [
+      {
+        "name": "foo",
+        "value": "bar"
+      },
+      {
+        "name": "foo",
+        "value": "baz"
+      },
+      {
+        "name": "baz",
+        "value": "abc"
+      }
+    ]
+  },
+
+  "text-plain": {
+    "method": "POST",
+    "headers": [
+      {
+        "name": "content-type",
+        "value": "text/plain"
+      }
+    ],
+    "postData": {
+      "mimeType": "text/plain",
+      "text": "Hello World"
+    }
+  }
+}