Skip to content

Commit

Permalink
Initial commit
Browse files Browse the repository at this point in the history
  • Loading branch information
DennisMartinez committed Oct 6, 2022
0 parents commit 5e214e4
Show file tree
Hide file tree
Showing 16 changed files with 4,536 additions and 0 deletions.
80 changes: 80 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# TypeScript v1 declaration files
typings/

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variables file
.env
.env.test

# parcel-bundler cache (https://parceljs.org/)
.cache

# next.js build output
.next

# nuxt.js build output
.nuxt

# vuepress build output
.vuepress/dist

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/
29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# image-proxy-client
image proxy utilities for client apps

## Strategies
1. `proxy` - route http photo through our https proxy
1. `swap` - swap protocols from http to https
1. `null/nil/undefined` - no strategy, return original

## Installation
```sh
yarn add @wrstudios/image-proxy-client
```

## Publishing a new version
1. Make changes on branch
1. Commit changes
1. Merge changes into master
1. `yarn bump: [patch|minor|major]`
1. Update package dependency to new version in consuming apps.

## Quick Start
```js
import getProxiedImageUrl from "@wrstudios/image-proxy-client";

const strategy = "swap"
const url = "http://something.com/image"
const finalImageUrl = getProxiedImageUrl({ url, strategy })
console.log(finalImageUrl) //=> https://something.com/image
```
14 changes: 14 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
const isTest = process.env.NODE_ENV === "test";
module.exports = {
presets: [
[
"@babel/preset-env",
{
targets: {
browsers: [">0.2%", "not dead", "not ie <= 11", "not op_mini all"]
},
modules: isTest ? "cjs" : false
}
]
]
};
40 changes: 40 additions & 0 deletions dist/image-proxy-client.cjs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
'use strict';

Object.defineProperty(exports, '__esModule', { value: true });

function swapProtocol(url) {
if (typeof url !== 'string') return url;
return url.replace('http://', 'https://');
}

var baseImageUrl = 'https://images.cloudagentsuite.com';

function proxy(url) {
if (typeof url !== 'string') return url;
return "".concat(baseImageUrl, "/").concat(url.replace(/https?:\/\//, ''));
}

/**
* Get proxied url given photo proxy strategy
* @param {string} strategy - the name of the proxy strategy, one of [ "proxy", "swap", "none" ]
* @param {string} url - the original url of the image
*/

function getProxiedImageUrl(_ref) {
var strategy = _ref.strategy,
url = _ref.url;

switch (strategy) {
case "proxy":
return proxy(url);

case "swap":
return swapProtocol(url);

case "none":
default:
return url;
}
}

exports.getProxiedImageUrl = getProxiedImageUrl;
36 changes: 36 additions & 0 deletions dist/image-proxy-client.esm.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
function swapProtocol(url) {
if (typeof url !== 'string') return url;
return url.replace('http://', 'https://');
}

var baseImageUrl = 'https://images.cloudagentsuite.com';

function proxy(url) {
if (typeof url !== 'string') return url;
return "".concat(baseImageUrl, "/").concat(url.replace(/https?:\/\//, ''));
}

/**
* Get proxied url given photo proxy strategy
* @param {string} strategy - the name of the proxy strategy, one of [ "proxy", "swap", "none" ]
* @param {string} url - the original url of the image
*/

function getProxiedImageUrl(_ref) {
var strategy = _ref.strategy,
url = _ref.url;

switch (strategy) {
case "proxy":
return proxy(url);

case "swap":
return swapProtocol(url);

case "none":
default:
return url;
}
}

export { getProxiedImageUrl };
185 changes: 185 additions & 0 deletions jest.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,185 @@
// For a detailed explanation regarding each configuration property, visit:
// https://jestjs.io/docs/en/configuration.html

module.exports = {
// All imported modules in your tests should be mocked automatically
// automock: false,

// Stop running tests after `n` failures
// bail: 0,

// Respect "browser" field in package.json when resolving modules
// browser: false,

// The directory where Jest should store its cached dependency information
// cacheDirectory: "/private/var/folders/3s/fkwtyspx0jqgyvvcn94_fv600000gn/T/jest_dx",

// Automatically clear mock calls and instances between every test
clearMocks: true,

// Indicates whether the coverage information should be collected while executing the test
// collectCoverage: false,

// An array of glob patterns indicating a set of files for which coverage information should be collected
// collectCoverageFrom: null,

// The directory where Jest should output its coverage files
coverageDirectory: "coverage",

// An array of regexp pattern strings used to skip coverage collection
// coveragePathIgnorePatterns: [
// "/node_modules/"
// ],

// A list of reporter names that Jest uses when writing coverage reports
// coverageReporters: [
// "json",
// "text",
// "lcov",
// "clover"
// ],

// An object that configures minimum threshold enforcement for coverage results
// coverageThreshold: null,

// A path to a custom dependency extractor
// dependencyExtractor: null,

// Make calling deprecated APIs throw helpful error messages
// errorOnDeprecated: false,

// Force coverage collection from ignored files usin a array of glob patterns
// forceCoverageMatch: [],

// A path to a module which exports an async function that is triggered once before all test suites
// globalSetup: null,

// A path to a module which exports an async function that is triggered once after all test suites
// globalTeardown: null,

// A set of global variables that need to be available in all test environments
// globals: {},

// An array of directory names to be searched recursively up from the requiring module's location
// moduleDirectories: [
// "node_modules"
// ],

// An array of file extensions your modules use
// moduleFileExtensions: [
// "js",
// "json",
// "jsx",
// "ts",
// "tsx",
// "node"
// ],

// A map from regular expressions to module names that allow to stub out resources with a single module
// moduleNameMapper: {},

// An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader
// modulePathIgnorePatterns: [],

// Activates notifications for test results
// notify: false,

// An enum that specifies notification mode. Requires { notify: true }
// notifyMode: "failure-change",

// A preset that is used as a base for Jest's configuration
// preset: null,

// Run tests from one or more projects
// projects: null,

// Use this configuration option to add custom reporters to Jest
// reporters: undefined,

// Automatically reset mock state between every test
// resetMocks: false,

// Reset the module registry before running each individual test
// resetModules: false,

// A path to a custom resolver
// resolver: null,

// Automatically restore mock state between every test
// restoreMocks: false,

// The root directory that Jest should scan for tests and modules within
// rootDir: null,

// A list of paths to directories that Jest should use to search for files in
// roots: [
// "<rootDir>"
// ],

// Allows you to use a custom runner instead of Jest's default test runner
// runner: "jest-runner",

// The paths to modules that run some code to configure or set up the testing environment before each test
// setupFiles: [],

// A list of paths to modules that run some code to configure or set up the testing framework before each test
// setupFilesAfterEnv: [],

// A list of paths to snapshot serializer modules Jest should use for snapshot testing
// snapshotSerializers: [],

// The test environment that will be used for testing
testEnvironment: "node",

// Options that will be passed to the testEnvironment
// testEnvironmentOptions: {},

// Adds a location field to test results
// testLocationInResults: false,

// The glob patterns Jest uses to detect test files
// testMatch: [
// "**/__tests__/**/*.[jt]s?(x)",
// "**/?(*.)+(spec|test).[tj]s?(x)"
// ],

// An array of regexp pattern strings that are matched against all test paths, matched tests are skipped
// testPathIgnorePatterns: [
// "/node_modules/"
// ],

// The regexp pattern or array of patterns that Jest uses to detect test files
// testRegex: [],

// This option allows the use of a custom results processor
// testResultsProcessor: null,

// This option allows use of a custom test runner
// testRunner: "jasmine2",

// This option sets the URL for the jsdom environment. It is reflected in properties such as location.href
// testURL: "http://localhost",

// Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout"
// timers: "real",

// A map from regular expressions to paths to transformers
// transform: null,

// An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation
// transformIgnorePatterns: [
// "/node_modules/"
// ],

// An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them
// unmockedModulePathPatterns: undefined,

// Indicates whether each individual test should be reported during the run
// verbose: null,

// An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode
// watchPathIgnorePatterns: [],

// Whether to use watchman for file crawling
// watchman: true,
};
Loading

0 comments on commit 5e214e4

Please sign in to comment.