#SmartibuyAPI

Web service of Smartibuy based on sinatra. （Deployed on Codeship）

For development

After clone this repository, use bundle to install all dependences

$ bundle install

Use rackup to run the web app (default port is 9292) and visit the website http://localhost:port (http://localhost:9292) that tells you the current API version and Github homepage of API.

$ rackup config.ru -p [port]
Thin web server (v1.6.4 codename Gob Bluth)
Maximum connections set to 1024
Listening on localhost:[port], CTRL+C to stop

If you want to run in test environment.

$ rackup config.ru -p 3000 -E test

Run testing

$ rake spec

API usage

GET /

• functionality:
  • show our service status such as vesrion and alive
• response :
  • 200, show version
• example:

 curl -GET http://127.0.0.1:3000/

GET /api/v1/fb_data/[facebook group id].json

• functionality:
  • Show all good infomation in the certian FB group
• response :
  • 200, return in application/json format
  • 404, the facebook group is not existed.
• example:

 curl -GET http://127.0.0.1:3000/api/v1/fb_data/817620721658179.json

POST /api/v1/fb_data/search

• functionality:
  • Search the certain good info. by good ID
• request :
  • Content-type: application/json

  {
    "group_id":"[Group_id]", # (string) facebook id
    "good_id":"[Good_id]" # (string) good id
  }

• response :
  • 200, return in application/json format
  • 400, request not in json format
• example:

$ curl -v -H "Accept: application/json" -H "Content-type: application/json" -X POST -d "{\"group_id\":\"817620721658179\", \"good_id\":\"817620721658179_909156159171301\"}" http://localhost:3000/api/v1/fb_data/search

GET /api/vi/group/:id

• functionality:
• Get group id and name by unique id.
• request:
  • method: GET
  • request url: http://localhost:3000/api/v1/group/:id
• reponse:
  • 200
  • 400 - Not found

{
  id: 5,
  group_name: "清交二手貨倉XD",
  group_id: "817620721658179"
}

POST /api/v1/create_group

• functionality:
  • Create a group with id and name.
• request :
  • Content-type: application/json

  {
    "group_id":"[Group_id]", # (string) facebook group id
    "group_name":"[Group_name]" # (string) group name
  }

• response :
  • 303, redirect to http://localhost:3000/api/v1/group/:id
  • 400, request not in json format
• example:

$ curl -v -H "Accept: application/json" -H "Content-type: application/json" -X POST -d "{\"group_id\":\"817620721658179\", \"group_name\":\"清交二手大拍賣XD\"}" http://localhost:3000/api/v1/create_group

GET /api/vi/product/:id

• functionality:
• Get product's informations by unique id.
• request:
  • method: GET
  • request url: http://localhost:3000/api/v1/product/:id
• reponse:
  • 200
  • 400 - Not found

{
  product_title: "PONY 運動鞋",
  product_id: "817620721658179_914934681926782",
  fb_user_id: "rubyuser",
  product_information: "7-8 可穿",
  price: 0,
  group_id: "817620721658179"
}

POST /api/v1/create_product

• functionality:
  • Create a product with its informations.
• request :
  • Content-type: application/json

  {
    "product_id":"[Product ID]", # (string) Product ID
    "fb_user_id": "[FB User ID]", # (string) FB User ID
    "product_title": "[Product Title]", # (string) Product Title
    "product_information": "[Product INFO]", # (string) Product INFO
    "price": "[Product Price]", # (string) Product Pric
    "group_id": "[FB Group ID]", # (string) FB Group ID
    "pic_url": "[Picture URL]", # (string) Picture URL
    "update_time": "[Update Time]", # (string) Update Time
    "create_time": "[Create Time]", # (string) Create Time
    "created_at": "[Create at]", # (string) Create at
    "updated_at": "[Update at]" # (string) Update at
  }

• response :
  • 303, redirect to http://localhost:3000/api/v1/product/:id
  • 400, request not in json format
• example:

$ curl -v -H "Accept: application/json" -H "Content-type: application/json" -X POST -d "{\"product_id\":\"817620721658179_914934681926782\", \"fb_user_id\":\"rubyuser\", \"product_title\":\"PONY拖鞋\", \"product_information\":\"7-8成新\", \"price\":\"議價\", \"group_id\":\"817620721658179\", \"pic_url\":\"None\", \"update_time\":\"2015-11-08T05:41:08+0000\", \"create_time\":\"2015-11-08T05:41:08+0000\", \"create_at\":\"2015-11-08T05:41:08+0000\", \"update_at\":\"2015-11-08T05:41:08+0000\"}" http://localhost:3000/api/v1/create_product

GET /api/v1/search_mobile01/:cate/:name/:num/result.json'

• functionality:
• Get product list from mobile01 using category and keyword.
• :cate is category, in this example, category is 電腦資訊.
• :name is keyword, in this example, name is iphone.
• :number is the number of result you want to list.
• request:
  • method: GET
  • request url: /api/v1/search_mobile01/電腦資訊/iphone/5/result.json
• reponse:
  • 200
  • 400 - Not found

[
  {"name":"全新未拆 SP Slicon Power DDR3L 1600 4G 筆記型電腦 記憶體  B40CCD (1)　商品所在地:台北市","price":"  600元","num":"0","update_time":"2015-12-06"},
  {"name":"iPad mini 羅技 Logitech超薄鍵盤保護殼 黑色.1-3代通用  bluem23 (47)　商品所在地:台北市","price":"  7,299元","num":"2","update_time":"2015-12-06"},
  {"name":"Micron 固態硬碟SSD crucial 64GB（送中古INTEL X25-V 40GB）  歌丸にゃんこ (9)　商品所在地:新北市","price":"  28,900元","num":"0","update_time":"2015-12-06"},
  {"name":"ASUS ZENBOOK 13.3吋 Full HD 筆電 Notebook  pcmew (8)　商品所在地:新北市","price":"  2,500元","num":"0","update_time":"2015-12-06"},
  {"name":"金士頓 KHX1600C9D3K 12GX Hyper X系列  蝸牛小哥哥 (1)　商品所在地:基隆市","price":"  498元","num":"0","update_time":"2015-12-06"}]%

LICENSE

MIT @ Smartibuy