CaffeineHTTPProxy

This is the name of a notification posted to the default notification center after Caffeine has received its remote configuration file. The userInfo dictionary of the notification contains the boolean value of whether or not the current session is using Caffeine keyed by this same notification name. This can be used to track whether the current session uses Caffeine or not.

A Swift 3 in a View Controller:

import UIKit
import Proxeine

class ViewController: UIViewController {

    override func viewDidLoad() {
        super.viewDidLoad()
        NotificationCenter.default.addObserver(self, selector: #selector(receivedCaffeineNotification(aNotification:)), name: NSNotification.Name(rawValue: CaffeineHTTPProxy.caffeineInformationStringNotificationKey), object: nil)
    }

    // Our method to receive the Caffeine notification
    func receivedCaffeineNotification(aNotification: NSNotification) {
        if aNotification.name.rawValue == CaffeineHTTPProxy.caffeineInformationStringNotificationKey {
            if let usingCaffeine = aNotification.userInfo?[CaffeineHTTPProxy.caffeineInformationStringNotificationKey] as? Bool {
                // 'usingCaffeine` now tracks whether Caffeine is enabled for this SESSION
                // You can log this value with your analytics service
            }
        }
    }

    deinit {
        NotificationCenter.default.removeObserver(self)
    }
}

A Swift 2 example in an App Delegate:

import UIKit
import Proxeine

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

    var window: UIWindow?

    func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
        CaffeineHTTPProxy.allow("http://google.com/")
        CaffeineHTTPProxy.start()

        // Start listening for the Caffeine notification

        NSNotificationCenter.defaultCenter().addObserver(self, selector: #selector(AppDelegate.receivedCaffeineNotification(_:)), name: CaffeineHTTPProxy.caffeineInformationStringNotificationKey, object: nil)
            return true
    }


    // Our method to receive the Caffeine notification
    // Called after downloading the percentage value from a remote server
        func receivedCaffeineNotification(aNotification: NSNotification) {
        if aNotification.name == CaffeineHTTPProxy.caffeineInformationStringNotificationKey {
            if let usingCaffeine = aNotification.userInfo?[CaffeineHTTPProxy.caffeineInformationStringNotificationKey] as? Bool {
                // 'usingCaffeine` now tracks whether Caffeine is enabled for this SESSION
                // Log this value to your 3rd party analytics service
            }
        }
    }
}

Starts Caffeine. start should be called first in your App Delegate’s application:didFinishLaunchingWithOptions: function.

By default, no requests are Caffeinated. To Caffeinate a request, it must be explicitly allowed using allow:.

Swift 3:

import Proxeine
func applicationDidFinishLaunching(_ application: UIApplication) {
   CaffeineHTTPProxy.start()
   //enter `allow` and `deny` filters here
}

Swift 2.3:

   import Proxeine
   func application(application: UIApplication, didFinishLaunchingWithOptions launchOptions: [NSObject: AnyObject]?) -> Bool {
       CaffeineHTTPProxy.start()
       //enter `allow` and `deny` filters here
   }

Objective-C:

   import "Proxeine-Swift.h"
   - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {
       [CaffeineHTTPProxy start];
       //enter `allow` and `deny` filters here
   }

Calling start and in debug mode will print additional information to the console about Caffeine for debugging purposes.

allow: Caffeinates specific URLs or sets of URLs. No requests will be proxied unless their URL is allowed. Call allow inside your AppDelegate, within the application:didFinishLaunchingWithOptions: function.

Swift:

    CaffeineHTTPProxy.allow("*.png")
    CaffeineHTTPProxy.allow("https://google.com*")
    CaffeineHTTPProxy.allow("http:*")
    CaffeineHTTPProxy.allow("http://google.com/humans.txt")

Objective-C:

   [CaffeineHTTPProxy allow:@"*.png"];
   [CaffeineHTTPProxy allow:@"https://google.com*"];
   [CaffeineHTTPProxy allow:@"http:*"];
   [CaffeineHTTPProxy allow:@"http://google.com/humans.txt"];

This allow configurations (above) specify that the following will be Caffeinated:

• all PNG files
• all HTTPS traffic as long as it STARTS WITH https://google.com/ (not subdomains ie. cats.google.com/)
• all HTTP traffic (not a recommended filter)
• the specific HTTP URL: http://google.com/humans.txt

deny: Decaffeinates specific URLs or sets of URLs. deny overrides allow. No requests will be proxied if their URL is within a deny clause. Call deny inside your AppDelegate, within the application:didFinishLaunchingWithOptions: function.

Swift:

CaffeineHTTPProxy.deny("*.png")
CaffeineHTTPProxy.deny("https://google.com*")
CaffeineHTTPProxy.deny("http:*")
CaffeineHTTPProxy.deny("http://google.com/humans.txt")

Objective-C:

[CaffeineHTTPProxy deny:@"*.png"];
[CaffeineHTTPProxy deny:@"https://google.com*"];
[CaffeineHTTPProxy deny:@"http:*"];
[CaffeineHTTPProxy deny:@"http://google.com/humans.txt"];

This deny configuration (above) specify that the following will NOT be Caffeinated:

• all PNG files
• all HTTPS traffic as long as it STARTS WITH https://google.com/ (NOT subdomains ie. cats.google.com/)
• all HTTP traffic (not a recommended filter)
• the specific HTTP URL: http://google.com/humans.txt

Decaffeinates specific requests by conditioning on their HTTP methods. Call deny inside your AppDelegate, within the application:didFinishLaunchingWithOptions: function before start(). By default, all HTTP methods are allowed.

Swift:

CaffeineHTTPProxy.deny(.HEAD)
CaffeineHTTPProxy.deny(.CONNECT)

Requests with their httpMethod set to HEAD or CONNECT will not use Caffeine.

By default, Caffeine will log whether or not Caffeine was used for a request, request URLs, HTTP methods, and response times to console. Calling this method will cause the console to cease this logging.