swift-sdk

2016-05-21

The iOS-sdk version 0.3.0 has many major changes with this new release. The team worked diligently at removing many of the third party dependencies and fully embracing AlamoFire by implementing the rest-kit code.

Major updates

• Added IBM Watson Tone Analyzer
• Added IBM Watson Visual Recognition
• Updated all of the code to use the new Rest-kit and removed NetworkUtils and WatsonGateway. We still have one service to convert, Alchemy Language, but we anticipate that change coming in the next minor release.
• Removed many dependencies and reducing the total number to three. Alamofire, Freddy, and Starscream.
• You will notice an update to the targets available and now the developer can pick and choose the services to include.

The process of migrating a service to Rest-kit required a large re-implementation of the service. As part of the reimplementation, we additionally gain:

• More consistent coding patterns between services.
• Better documentation.
• Better tests.
• Reorganized project structure to support Swift Package Manager.

In addition, the Rest-kit branch has a number of architectural changes that should make the SDK easier to maintain and easier to consume.

• Uses Alamofire directly instead of NetworkUtils or WatsonGateway.
• Uses Freddy instead of ObjectMapper, allowing us to better express the models.
• Uses separate failure and success closures to avoid unwrapping optionals and enable consistent error handling. We debated as a team as to the correct approach and concluded this was the best approach for the granularity. One benefit is the user does not have to unwrap a response. It also allows for a more unified error return.

This release includes several minor bug fixes and documentation improvements.

• Removes the copy frameworks build phase to resolve an app store submission bug.
• Adds a user-agent HTTP header to track version usage.
• Updates README.md to reflect changes made to the API signatures.
• Reorganizes Quickstart.md to prevent users from skipping app transport security configuration.
• Fixes continuous integration with Travis.

This release fixes build errors caused by changes made to the most recent version of Starscream. In particular, several function signatures were modified, causing the inheritance of SpeechToTextWebSocket from WebSocket to break. These signatures have been updated so that the SDK successfully builds.

In addition, we have removed non-existing library search paths that were producing build warnings.

Related PRs: #223, #224

This release fixes errors that would occur when building the Watson Developer Cloud iOS SDK with Xcode 7.3. In particular, it:

• Removes the libogg and libopus libraries, which were causing build failures.
• Modifies the Text to Speech implementation to use WAV instead of OPUS.
• Repairs the corrupt WAV header returned by the Text to Speech service.
• Updates dependencies to Xcode 7.3 and Swift 2.2 compatible releases.
• Disables Xcode code coverage that caused errors with Xcode 7.3.
• Updates the readme with information about using Xcode 7.3.

Please note that all binaries must be re-built for use with Xcode 7.3 and Swift 2.2. To do so, please run: carthage update --platform iOS --no-use-binaries

• Removes logging and the XCGLogger dependency.

• Removes @testable annotation from all tests
• Fixes a bug where some AlchemyLanguage and Dialog models were internal instead of public.

• Adds a new implementation of Speech to Text with support for streaming audio
• Adds an example application to test and demonstrate the new Speech to Text implementation
• Adds a simpler translate function that accepts a String argument instead of [String]
• Updates comments and tests to make the Dialog application's time zone explicit
• Updates Starscream from 1.0.2 to 1.1.1
• Updates AlamofireObjectMapper from 2.1.0 to 2.1.3
• Standardizes the spacing for all copyright headers
• Updates .gitignore file

• Fixes a bug that caused an HTTP 400 error when executing TextToSpeech.synthesize(text:voice:completionHandler:)

• Issue deleting a model just after creating it in Language Translation Test db177fb
• Enable code coverage in xcode project c0ec43c
• Update test setup functions to only instantiate the service if it is nil c06033d
• WatsonGateway should always refresh a nil token fec0f6c
• Update type of all completion handlers 36e16a0
• Get Travis CI working with our test cases 461ffde
• Update readme with specific Carthage info c92c8a6
• Discover why carthage pull and build fails occasionally
• Enable Travis builds and add badge to README
• Fix the race condition with Dialog tests d15b5d5
• Integrate CodeCov for test coverage reporting c4c6bc9

This initial release contains code that will communicate with 8 different Watson services

• Alchemy Language
• Alchemy Vision
• Dialog
• Language Translation
• Natural Language Classifier
• Personality Insights
• Speech to Text
• Text to Speech