The swift-api from qminder

Reconnect when losing connection with 1001 error

{
  "total_events": 1,
  "page": 0,
  "events": [
    {
      "raw": "{"rawmsg":"onDisconnected = Optional(Error Domain=WebSocket Code=1001 \\"The web application is stopping\\" UserInfo={NSLocalizedDescription=The web application is stopping})","sessionid":"811823","devicename":"Apple TV","lang":"en-US","devicemodel":"Apple TV","sourcelocation":"ScreenViewController.swift:1025","level":"ERROR","appname":"qminder-tv","timestamp":"2017-04-27T07:00:34.746Z","osversion":"10.2","appversion":"20170426.173650"}",
      "logtypes": [
        "json"
      ],
      "timestamp": 1493276434746,
      "unparsed": null,
      "logmsg": "{"rawmsg":"onDisconnected = Optional(Error Domain=WebSocket Code=1001 \\"The web application is stopping\\" UserInfo={NSLocalizedDescription=The web application is stopping})","sessionid":"811823","devicename":"Apple TV","lang":"en-US","devicemodel":"Apple TV","sourcelocation":"ScreenViewController.swift:1025","level":"ERROR","appname":"qminder-tv","timestamp":"2017-04-27T07:00:34.746Z","osversion":"10.2","appversion":"20170426.173650"}",
      "id": "ea82f83b-2b1b-11e7-80b4-0a269df17f5b",
      "tags": [
        "apple-tv"
      ],
      "event": {
        "json": {
          "lang": "en-US",
          "devicename": "Apple TV",
          "devicemodel": "Apple TV",
          "level": "ERROR",
          "timestamp": "2017-04-27T07:00:34.746Z",
          "appname": "qminder-tv",
          "appversion": "20170426.173650",
          "sessionid": "811823",
          "rawmsg": "onDisconnected = Optional(Error Domain=WebSocket Code=1001 "The web application is stopping" UserInfo={NSLocalizedDescription=The web application is stopping})",
          "osversion": "10.2",
          "sourcelocation": "ScreenViewController.swift:1025"
        },
        "http": {
          "clientHost": "80.235.115.84",
          "contentType": "application/x-www-form-urlencoded"
        }
      }
    }
  ]
}

Improve tests to cover more exceptions

Tickets search
Detail calls

Add schemes for different SDKs

iOS, macOS, tvOS

Refactor reconnection with ReactiveX approach

thread safe
code isn't spread between multiple functions

API key set method

Use when API Key is known. Some calls don't require API key

Improve podspec

Add social links
Link to Qminder API specs instead of website

Remove extra_params from ticket model

Can use protocols + compositions https://gist.github.com/AliSoftware/9e4946c8b6038572d678

Implement force disconnecting from websocket

disconnect
don't send error because this will be used when remove pairing

Take scalar types when subscribe to event

Lines changed event takes locationId as Int not JSON object.

Parse data with HTML characters

{subscriptionId:ZgUROHanBE70tBZRMRh4Z86BLx6Z2b,messageId:3,data:{id:24505134,status:NEW,source:MANUAL,line:62633,firstName:^*&%*((*,created:{date:2017-02-17T08:52:33Z}}}

Set encoding for JSON data requests

Remove Qminder icons from Example

Coma seperated list for ticket search

Status
Line

Date transformations doesn't work

Theme tag in TV details

{
  "statusCode": 200,
  "id": 12363,
  "name": "TV",
  "theme": "lyft"
}

Don't open another socket if it's opening one currently

Return User object with userDetails call

Error passing with enum

Proper error passing with status code, network connection etc.

Add external variable names for easy of use

Decrease timeout when disconnected

Use ObjectMapper to map in object to avoid using Dictionary with Any object type

https://cocoapods.org/pods/ObjectMapper

http://www.thedroidsonroids.com/blog/ios/rxswift-examples-4-multithreading/

Add matrix building for different platforms

iOS, tvOS, macOS

Examples: Alamofire, SwiftyJSON

Use PromiseKit for better tests readability

https://github.com/mxcl/PromiseKit

Use struct to give as response for API functions

Simpler code
Result as Dictionary object
Error

Example: Alamofire

Endpoint: https://api.qminder.com/v1/tv/{id}/emptystate
This API endpoint should be called only when there are no tickets to show.
When called, this endpoint will send a reply in the form of
{
"statusCode": 200,
"layout": "simple",
"message": ""
}

Possible values for "layout" are: "simple"
Possible values for message are:

"Fantastic, your TV is now connected"
When the TV was created less than 5 minutes ago.
"Good Morning"
When the local time in the location is before 10:00 and there have been
no tickets so far on that day.
"Ahh, it's bed time.. Welcome back tomorrow"
When the local time is after 18:00 and there haven't been
any new tickets in the last hour
"Welcome, we are ready for service. Simply sign in using the iPad!"
When the location has at least one iPad that has given a heartbeat in the past 5 minutes
"Welcome, we are ready for service. Simply sign in!"
Default case when none of the others apply
A copy of the response is stored in the overview_monitor_empty_state_history
table for debugging purposes.

Improve reconnection

Reconnect unless error code is goingAway - close connection.
reconnect if error is nil as well

Settings in TV details API call

https://www.qminder.com/docs/api/devices/

When closing connection need to clear the sent messages and message queue

Websocket tests

mock Qminder websockets server:
- imitate connection
- take all event subscriptions
- after all subscriptions are read run test runs

Use Node.js http://www.eikospartners.com/blog/how-to-mock-web-servers-using-node.js-part-2-websockets

Heartbeat call to update TV status

Reconnect function

Resets the timer to reconnect to websockets

Implement PING - PONG from server

User picture in user object

Don't use SwiftyJSON objects in Events

Use Dictionary instead

TV details call

TV device settings line as array

settings.lines as array of selected lines

Implement OVERVIEW_MONITOR_CHANGE websocket event

Improve logging when app disconnects with nil error

JSON parse warning

WARN | xcodebuild: /Users/travis/build/Qminder/swift-api/QminderAPI/Classes/QminderEvents.swift:236:23: warning: 'parse' is deprecated: Use instead init(parseJSON: )``

qminder / swift-api Goto Github PK

swift-api's People

Contributors

Stargazers

Watchers

Forkers

swift-api's Issues

Recommend Projects

Recommend Topics

Recommend Org