Updating docs

Author: fjcaetano

.travis.yml

@@ -5,4 +5,4 @@ install:
   - ./install_dependencies.sh
 
 script:
-  - bundle exec fastlane ci
+  - fastlane ci

Classes/RxWebSocket.swift

@@ -12,20 +12,10 @@ import RxSwift
 import Starscream
 
 
-/**
- *  This is the abstraction over Starscream to make it reactive.
- */
-public class RxWebSocket: WebSocket {
+/// This is the abstraction over Starscream to make it reactive.
+open class RxWebSocket: WebSocket {
 
-    /**
-     Every message received by the websocket is converted to an `StreamEvent`.
-     
-     - connect:    The "connect" message, flagging that the websocket did connect to the server.
-     - disconnect: A disconnect message that may contain an `Error` containing the reason for the disconection.
-     - pong:       The "pong" message the server may respond to a "ping".
-     - text:       Any string messages received by the client.
-     - data:       Any data messages received by the client, excluding strings.
-     */
+    /// Every message received by the websocket is converted to an `StreamEvent`.
     public enum StreamEvent {
         /// The "connect" message, flagging that the websocket did connect to the server.
         case connect
@@ -43,17 +33,17 @@ public class RxWebSocket: WebSocket {
         case data(Data)
     }
 
-    // MARK: Private Properties
-
     fileprivate let publishStream: PublishSubject<StreamEvent>
 
     /**
-     The creation of a `RxWebSocket` object. The client is automatically connected to the server uppon initialization.
-     
-     - parameter url:       The server url.
-     - parameter protocols: The protocols that should be used in the comms. May be nil.
-     
+     - parameters:
+         - request: A URL Request to be started.
+         - protocols: The protocols that should be used in the comms. May be nil.
+         - stream: A stream to which the client should connect.
+
      - returns: An instance of `RxWebSocket`
+
+     The creation of a `RxWebSocket` object. The client is automatically connected to the server uppon initialization.
      */
     override public init(request: URLRequest, protocols: [String]? = nil, stream: WSStream = FoundationStream()) {
         let publish = PublishSubject<StreamEvent>()
@@ -69,6 +59,22 @@ public class RxWebSocket: WebSocket {
 
         connect()
     }
+
+    /**
+     - parameters:
+         - url: The server url.
+         - protocols: The protocols that should be used in the comms. May be nil.
+
+     - returns: An instance of `RxWebSocket`
+
+     The creation of a `RxWebSocket` object. The client is automatically connected to the server uppon initialization.
+     */
+    public convenience init(url: URL, protocols: [String]? = nil) {
+        self.init(
+            request: URLRequest(url: url),
+            protocols: protocols
+        )
+    }
 }
 
 
@@ -84,12 +90,12 @@ public extension Reactive where Base: RxWebSocket {
             return Observable.just(text)
         }
 
-        return ControlProperty(values: values, valueSink: AnyObserver { event in
+        return ControlProperty(values: values, valueSink: AnyObserver { [weak base] event in
             guard case .next(let text) = event else {
                 return
             }
 
-            self.base.write(string: text)
+            base?.write(string: text)
         })
     }
 
@@ -103,12 +109,12 @@ public extension Reactive where Base: RxWebSocket {
             return Observable.just(data)
         }
 
-        return ControlProperty(values: values, valueSink: AnyObserver { event in
+        return ControlProperty(values: values, valueSink: AnyObserver { [weak base] event in
             guard case .next(let data) = event else {
                 return
             }
 
-            self.base.write(data: data)
+            base?.write(data: data)
         })
     }
 

README.md

@@ -15,13 +15,20 @@ A lightweight abstraction layer over [Starscream](https://github.com/daltoniam/S
 
 ## Installation
 
-RxWebSocket is available through [CocoaPods](http://cocoapods.org). To install
-it, simply add the following line to your Podfile:
+RxWebSocket is available through [CocoaPods](http://cocoapods.org) and
+[Carthage](https://github.com/Carthage/Carthage). To install it, simply add the
+following line to your depedencies file:
 
+#### Cocoapods
 ``` ruby
 pod "RxWebSocket"
 ```
 
+#### Carthage
+``` ruby
+github "fjcaetano/RxWebSocket"
+```
+
 ## Usage
 
 Every websocket event will be sent to the `stream` which is an `Observable<StreamEvent>`.
@@ -41,12 +48,12 @@ You may receive and send text events by subscribing to the `text` property:
 ``` swift
 let label = UILabel()
 socket.rx.text
-    .bindTo(label.rx.text)
+    .bind(to: label.rx.text)
 
 
 sendButton.rx.tap
     .flatMap { textField.text ?? "" }
-    .bindTo(socket.rx.text)
+    .bind(to: socket.rx.text)
 ```
 
 For further details, check the Example project.

install_dependencies.sh

@@ -19,22 +19,22 @@ verify() {
 install_fastlane() {
   echo "Installing Fastlane"
 
-  if [ $(which fastlane) ]; then
+  if [ $(which fastlane) ] || [ $(bundle check) ]; then
     echo ' -> Fastlane already installed'
     return
   fi
 
-  # Installing Homebrew
-  if [ ! $(which brew) ]; then
-    echo "Installing Homebrew"
-
-    # https://brew.sh/
-    /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" > "$LOGS_PATH/fastlane.log"
+  # Bundle install
+  if [ $(which bundle ) ]; then
+    bundle install
+  else
+    gem install bundler
   fi
 
-  brew cask install fastlane
-
-  verify "fastlane"
+  if [ ! $(bundle check) ]; then
+    echo "ERROR: fastlane still not installed. Aborting"
+    exit 1
+  fi
 }
 
 # Autobahn Test Suite