google-auth-library-ruby/lib/googleauth/stores/file_token_store.rb

# Copyright 2014, Google Inc.
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are
# met:
#
#     * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
#     * Redistributions in binary form must reproduce the above
# copyright notice, this list of conditions and the following disclaimer
# in the documentation and/or other materials provided with the
# distribution.
#     * Neither the name of Google Inc. nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
# "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
# LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
# A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
# OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
# SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
# LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
# DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
# THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

require "yaml/store"
require "googleauth/token_store"

module Google
  module Auth
    module Stores
      # Implementation of user token storage backed by a local YAML file
      class FileTokenStore < Google::Auth::TokenStore
        # Create a new store with the supplied file.
        #
        # @param [String, File] file
        #  Path to storage file
        def initialize(options = {})
          path = options[:file]
          @store = YAML::Store.new(path)
        end

        # (see Google::Auth::Stores::TokenStore#load)
        def load(id)
          @store.transaction { @store[id] }
        end

        # (see Google::Auth::Stores::TokenStore#store)
        def store(id, token)
          @store.transaction { @store[id] = token }
        end

        # (see Google::Auth::Stores::TokenStore#delete)
        def delete(id)
          @store.transaction { @store.delete(id) }
        end
      end
    end
  end
end