search

HashtagSell / posting-api

API for storage and retrieval of posting details for Hashtagsell
0 stars 0 forks source link

readme

Posting API

This is a central posting API for storing and retrieving posting details for hashtagsell.

Documentation

Once the API is started, documentation can be viewed on the server: https://localhost:4043/v1/docs

Note: Please swap out localhost and port above to match configuration

Object Model

Below is an example posting from the posting-api. In the comments next to each field, there is an indication of how postings from 3taps are mapped into the posting-api model. This API will support messages posted in either the 3taps format or in the posting-API native format, but will only return postings in the native posting-API format.

var posting = {
  external : {
    source : {
      code : '',                    // 3taps item.source
      id : '',                      // 3taps item.external_id
      url : ''                      // 3taps item.external_url
    },
    threeTaps : {
      id : 1,                       // 3taps item.id
      category : '',                // 3taps item.category
      categoryGroup : '',           // 3taps item.category_group
      location : {
        city : '',                  // 3taps item.location.city
        country : '',               // 3taps item.location.country
        county : '',                // 3taps item.location.county
        formatted : '',             // 3taps item.location.formatted_address
        locality : '',              // 3taps item.location.locality
        metro : '',                 // 3taps item.location.metro
        region : '',                // 3taps item.location.region
        state : '',                 // 3taps item.location.state
        zipCode : '',               // 3taps item.location.zipcode
      },
      status : '',                  // 3taps item.status
      timestamp : 12345             // 3taps item.timestamp
    }
  },
  annotations : {},                 // 3taps item.annotations
  askingPrice : {
    currency : 'USD',               // 3taps item.currency
    value : ''                      // 3taps item.price
  },
  created : '2014-12-10T01:00:00Z'  // 3taps item.timestamp
  expires : '2014-12-10T06:29:00Z'  // 3taps item.expires
  geo : {
    accuracy : 0,                   // 3taps item.location.accuracy
    coordinates: [0, 0],            // 3taps [item.location.lat, item.location.long]
    status : 0                      // 3taps item.location.geolocation_status
  },
  body : 'required',                // 3taps item.body
  heading : 'required',             // 3taps item.heading
  images : {},                      // 3taps item.images
  language : 'EN',                  // 3taps item.language
  postingId : 'required'            // hashtagsell assigned ID
};

Docker

Environment Variables

An example command to run locally:

docker run -d -p 8880:8880 \
  -e LOGGING_LEVEL=trace \
  -e REALTIME_ENABLED=true \
  -e REDIS_ENABLED=false \
  -v /tmp/ebay:/tmp
  hashtagsell/posting-api:latest

Development

Prerequisites

A simple way to install and run both Mongo and Elasticsearch locally is to use Homebrew (http://brew.sh/):

brew install mongo
brew install elasticsearch

Getting Started

To clone the repository and install dependencies, please perform the following:

git clone git@github.com:hashtagsell/posting-api.git
cd posting-api
npm install

For convenience you may find it useful to install gulp globally as well:

sudo npm install -g gulp

Local Configuration

The server utilizes a mechanism for allowing configuration overrides by environment. To make use of this for a local environment, create a local.json configuration file in a new folder named config at the root of the application. The .gitignore has an entry to ignore this folder so that the local config won't trash other environment configurations.

mkdir ./config
touch ./config/local.json

Now put the following into the local.json configuration file:

{
  "environment": "local",
  "logging": {
    "level": "trace"
  },
  "mws": {
    "secretKey": "<your Amazon MWS secret key here - see Brad or Josh>"
  },
  "realtime": {
    "enabled": false
  },
  "server": {
    "port": 4043,
    "secure": true
  }
}

Run It

Elasticsearch

After installing all modules, gulp can assist you in starting Elasticsearch:

gulp es-start

Mongo DB

After installing all modules, gulp can assist you in starting Mongo:

gulp mongo-start

Please Note: All mongo data for hashtagsell is placed into /usr/local/var/mongodb/hashtagsell by default

Data Migrations

Once Mongo is started, run the following migrations to get a new database up to the right version:

npm run migrations
Synchronize Mongo with Elasticsearch

If you have a Mongo database populated but Elasticsearch is out of sync, you can synchronize them by running the following script (note the environment configuration specification):

NODE_ENV=local npm run sync-es

API Server

When starting the API server, an environment configuration should be specified (see above for details on creating a local.json environment config). To specify the environment, use the NODE_ENV environment variable in the console to begin the process. The npm start script uses supervisor and pipes the output to Bunyan for logging:

NODE_ENV=local npm start

General Development Notes

As changes are saved to .js files in the project, supervisor will automatically restart the server. It may be useful to periodically check the terminal to make sure a runtime unhandled exception isn't stopping the server. Additionally, using jshint may help to uncover potential problems before running code. The npm test script is connected to gulp jshint to help with this.

Pushing Branches / Pull Requests

Prior to pushing your branch to the remote to create a pull request, please ensure you've run the tests and verified and fixed any JSHint issues or failed unit tests:

npm test

After running npm test code coverage reports are created that can be viewed to determine if model changes have adequate code coverage prior to submission:

open ./reports/lcov-report/index.html

Application Structure