swgg-itunes-search
this zero-dependency package will provide a swagger-client for itunes-search's web-apis, with a working web-demo
live web demo
git-branch : | master | beta | alpha |
---|
test-server-github : | | | |
test-report : | | | |
coverage : | | | |
build-artifacts : | | | |
table of contents
- cdn download
- documentation
- quickstart standalone app
- quickstart example.js
- extra screenshots
- package.json
- changelog of last 50 commits
- internal build script
- misc
cdn download
documentation
cli help
api doc
todo
changelog for v2018.1.16
- npm publish 2018.6.21
- update build
- none
this package requires
quickstart standalone app
to run this example, follow the instruction in the script below
# example.sh
# this shell script will download and run a web-demo of swgg-itunes-search as a standalone app
# 1. download standalone app
curl -O https://kaizhu256.github.io/node-swgg-itunes-search/build..beta..travis-ci.org/app/assets.app.js
# 2. run standalone app
PORT=8081 node ./assets.app.js
# 3. open a browser to http://127.0.0.1:8081 and play with the web-demo
# 4. edit file assets.app.js to suit your needs
output from browser
output from shell
quickstart example.js
to run this example, follow the instruction in the script below
(function () {
'use strict';
var local;
(function () {
local = {};
(function () {
try {
local.modeJs = typeof process.versions.node === 'string' &&
typeof require('http').createServer === 'function' &&
'node';
} catch (ignore) {
}
local.modeJs = local.modeJs || 'browser';
}());
local.global = local.modeJs === 'browser'
? window
: global;
local = local.global.utility2_rollup || (local.modeJs === 'browser'
? local.global.utility2_swgg_itunes_search
: require('swgg-itunes-search'));
local.global.local = local;
local.assetsDict['/assets.index.template.html'] = local.assetsDict['/assets.swgg.html'];
}());
switch (local.modeJs) {
case 'browser':
break;
case 'node':
module.exports = local;
local.buffer = require('buffer');
local.child_process = require('child_process');
local.cluster = require('cluster');
local.console = require('console');
local.constants = require('constants');
local.crypto = require('crypto');
local.dgram = require('dgram');
local.dns = require('dns');
local.domain = require('domain');
local.events = require('events');
local.fs = require('fs');
local.http = require('http');
local.https = require('https');
local.module = require('module');
local.net = require('net');
local.os = require('os');
local.path = require('path');
local.process = require('process');
local.punycode = require('punycode');
local.querystring = require('querystring');
local.readline = require('readline');
local.repl = require('repl');
local.stream = require('stream');
local.string_decoder = require('string_decoder');
local.timers = require('timers');
local.tls = require('tls');
local.tty = require('tty');
local.url = require('url');
local.util = require('util');
local.v8 = require('v8');
local.vm = require('vm');
local.zlib = require('zlib');
local.assetsDict = local.assetsDict || {};
[
'assets.index.template.html',
'assets.swgg.swagger.json',
'assets.swgg.swagger.server.json'
].forEach(function (file) {
file = '/' + file;
local.assetsDict[file] = local.assetsDict[file] || '';
if (local.fs.existsSync(local.__dirname + file)) {
local.assetsDict[file] = local.fs.readFileSync(
local.__dirname + file,
'utf8'
);
}
});
local.assetsDict['/assets.swgg_itunes_search.js'] =
local.assetsDict['/assets.swgg_itunes_search.js'] ||
local.fs.readFileSync(local.__dirname + '/lib.swgg_itunes_search.js', 'utf8'
).replace((/^#!\//), '// ');
local.assetsDict['/'] =
local.assetsDict['/assets.example.html'] =
local.assetsDict['/assets.index.template.html']
.replace((/\{\{env\.(\w+?)\}\}/g), function (match0, match1) {
switch (match1) {
case 'npm_package_description':
return 'the greatest app in the world!';
case 'npm_package_name':
return 'swgg-itunes-search';
case 'npm_package_nameLib':
return 'swgg_itunes_search';
case 'npm_package_version':
return '0.0.1';
default:
return match0;
}
});
if (module !== require.main || local.global.utility2_rollup) {
break;
}
local.assetsDict['/assets.example.js'] =
local.assetsDict['/assets.example.js'] ||
local.fs.readFileSync(__filename, 'utf8');
local.assetsDict['/favicon.ico'] = local.assetsDict['/favicon.ico'] || '';
if (Number(process.env.npm_config_timeout_exit)) {
setTimeout(process.exit, Number(process.env.npm_config_timeout_exit));
}
if (local.global.utility2_serverHttp1) {
break;
}
process.env.PORT = process.env.PORT || '8081';
console.error('server starting on port ' + process.env.PORT);
local.http.createServer(function (request, response) {
request.urlParsed = local.url.parse(request.url);
if (local.assetsDict[request.urlParsed.pathname] !== undefined) {
response.end(local.assetsDict[request.urlParsed.pathname]);
return;
}
response.statusCode = 404;
response.end();
}).listen(process.env.PORT);
break;
}
}());
output from browser
output from shell
-
https://kaizhu256.github.io/node-swgg-itunes-search/build/screenshot.buildCi.browser.%252Ftmp%252Fbuild%252Fapidoc.html.png
-
https://kaizhu256.github.io/node-swgg-itunes-search/build/screenshot.buildCi.browser.%252Ftmp%252Fbuild%252Fcoverage.lib.html.png
-
https://kaizhu256.github.io/node-swgg-itunes-search/build/screenshot.buildCi.browser.%252Ftmp%252Fbuild%252Ftest-report.html.png
-
https://kaizhu256.github.io/node-swgg-itunes-search/build/screenshot.deployGithub.browser.%252Fnode-swgg-itunes-search%252Fbuild%252Fapp%252Fassets.swgg.html.png
-
https://kaizhu256.github.io/node-swgg-itunes-search/build/screenshot.deployGithub.browser.%252Fnode-swgg-itunes-search%252Fbuild%252Fapp.png
-
https://kaizhu256.github.io/node-swgg-itunes-search/build/screenshot.deployGithubTest.browser.%252Fnode-swgg-itunes-search%252Fbuild%252Fapp.png
-
https://kaizhu256.github.io/node-swgg-itunes-search/build/screenshot.npmTest.browser.%252F.png
-
https://kaizhu256.github.io/node-swgg-itunes-search/build/screenshot.testExampleJs.browser.%252F.png
-
https://kaizhu256.github.io/node-swgg-itunes-search/build/screenshot.testExampleSh.browser.%252F.png
package.json
{
"author": "kai zhu <kaizhu256@gmail.com>",
"description": "this zero-dependency package will provide a swagger-client for itunes-search's web-apis, with a working web-demo",
"devDependencies": {
"electron-lite": "kaizhu256/node-electron-lite#alpha",
"utility2": "kaizhu256/node-utility2#alpha"
},
"engines": {
"node": ">=4.0"
},
"githubRepoAlias": "swgg-io/node-swgg-itunes-search",
"homepage": "https://github.com/kaizhu256/node-swgg-itunes-search",
"keywords": [
"itunes-search",
"swagger-client"
],
"license": "MIT",
"main": "lib.swgg_itunes_search.js",
"name": "swgg-itunes-search",
"nameAliasPublish": "",
"nameLib": "swgg_itunes_search",
"nameOriginal": "swgg-itunes-search",
"os": [
"darwin",
"linux"
],
"repository": {
"type": "git",
"url": "https://github.com/kaizhu256/node-swgg-itunes-search.git"
},
"scripts": {
"build-ci": "./npm_scripts.sh",
"eval": "./npm_scripts.sh",
"heroku-postbuild": "./npm_scripts.sh",
"postinstall": "./npm_scripts.sh",
"start": "./npm_scripts.sh",
"test": "./npm_scripts.sh",
"utility2": "./npm_scripts.sh"
},
"version": "2018.6.21"
}
changelog of last 50 commits
internal build script
# build_ci.sh
# this shell script will run the build for this package
shBuildCiAfter () {(set -e
# shDeployCustom
shDeployGithub
# shDeployHeroku
shReadmeTest example.sh
)}
shBuildCiBefore () {(set -e
shNpmTestPublished
shReadmeTest example.js
)}
# run shBuildCi
eval "$(utility2 source)"
shBuildCi
misc