lib/src/sync/cookies.dart

// Copyright 2017 Google Inc. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

import 'package:webdriver/src/common/cookie.dart';
import 'package:webdriver/src/common/request_client.dart';
import 'package:webdriver/src/common/webdriver_handler.dart';

/// Interacts with browser's cookies.
class Cookies {
  final SyncRequestClient _client;
  final WebDriverHandler _handler;

  Cookies(this._client, this._handler);

  /// Sets a cookie.
  void add(Cookie cookie) {
    _client.send(_handler.cookies.buildAddCookieRequest(cookie),
        _handler.cookies.parseAddCookieResponse);
  }

  /// Deletes the cookie with the given [name].
  void delete(String name) {
    _client.send(_handler.cookies.buildDeleteCookieRequest(name),
        _handler.cookies.parseDeleteCookieResponse);
  }

  /// Deletes all cookies visible to the current page.
  void deleteAll() {
    _client.send(_handler.cookies.buildDeleteAllCookiesRequest(),
        _handler.cookies.parseDeleteAllCookiesResponse);
  }

  /// Retrieves all cookies visible to the current page.
  List<Cookie> get all => _client.send(
      _handler.cookies.buildGetAllCookiesRequest(),
      _handler.cookies.parseGetAllCookiesResponse);

  /// Retrieves cookie with the given name.
  Cookie getCookie(String name) => _client.send(
      _handler.cookies.buildGetCookieRequest(name),
      (response) => _handler.cookies.parseGetCookieResponse(response, name));

  @override
  String toString() => '$_handler.cookies($_client)';

  @override
  int get hashCode => _client.hashCode;

  @override
  bool operator ==(other) =>
      other is Cookies &&
      _handler == other._handler &&
      _client == other._client;
}