flattenarray

Array Flattening

if running code locally:

Environment Requirements

• Golang 9.0 or above
• At least 1.2 MB of free space

Install golang on mac

brew update
brew install golang

export GOPATH=/your/directory/of/flatten/array/clone
export GOROOT=/usr/local/opt/go/libexec
export PATH=$PATH:$GOPATH/bin
export PATH=$PATH:$GOROOT/bin

Install golang on ubuntu

sudo apt-get update
sudo apt-get -y upgrade
sudo apt-get wget 'if you dont have it already'
wget https://dl.google.com/go/go1.12.7.linux-amd64.tar.gz
sudo tar -xvf go1.12.7.linux-amd64.tar.gz
sudo mv go /usr/local

export GOROOT=/usr/local/go
export GOPATH=/your/directory/of/flatten/array/clone
export PATH=$GOPATH/bin:$GOROOT/bin:$PATH

Install golang on windows

Download Windows Installer here

Running the project

cd /your/directory/of/flatten/array/clone/src
go run main.go

Using the unit tests

After you have followed the above steps and have your environment ready, you can run some local testing utilizing golangs standard testing library "testing". Use the following steps to run testing in your terminal.

For mac, linux and windows type the following in the terminal or cmd:

cd /your/directory/of/flatten/array/clone/src/testing
go test

API Endpoints

The Flatten Array project offers 2 endpoints, both utilizing json as the data input. These endpoints are designed to flatten 2 types of arrays, 3d arrays and also standard arrays at variable lengths.

Endpoint /v1/flatten_standard

Request Data:

{
  "array_of_arrays" : [
    [1,2,3,4],
    [5,6,7,8,9],
    [10,11,12,13]
  ]
}

Response Data Success:

{"message" : [1,2,3,4,5,6,7,8,9,10,11,12,13], "status" : 200}

Response Data Failure:

 {"message" : "Bad Request, json improperly formatted", "status" : 400}

Endpoint /v1/flatten_3d

Request Data:

{
  "coordinates" : {
    "x" : 3,
    "y" : 2,
    "z" : 6
  }
}

Response Data Success:

{"message" : [0,0,1,2,3,4,5,1,2,3,4,5,6,1,1,2,3,4,5,6,2,3,4,5,6,7,2,2,3,4,5,6,7,3,4,5,6,7,8], "status" : 200}

Response Data Failure:

 {"message" : "Bad Request, json improperly formatted", "status" : 400}

Docker Implementation

This project is also available on dockerhub at aapirp/flat_array_api:latest testing cannot be run in the docker container because the image will be compiled, if you want to view testing scripts you will need to use the local installation.

NOTE: Using the docker installation both endpoints above will be usable via postman or another api calling product. No endpoint authorization is needed due to the demo nature of this project.

Docker instructions:

docker pull aapirp/flat_array_api:latest
docker run --publish 8234 aapirp/flat_array_api:latest