require 'intercom/user_resource'

module Intercom

  ##
  # Represents a users interaction with your app (eg page view, or using a particular feature)
  #
  # An impressions contains user_ip, user_agent and location.
  #
  #  impression = Intercom::Impression.create(:email => "person@example.com", :location => "/pricing/upgrade",
  #                                           :user_ip => '1.2.3.4', :user_agent => "my-service-iphone-app-1.2")
  # The impression response will contain {#unread_messages}
  #  impression.unread_messages
  # You can also create an impression and save it like this:
  #  impression = Intercom::Impression.new
  #  impression.email = "person@example.com"
  #  impression.location = "person@example.com"
  #  ....
  #  impression.save
  class Impression < UserResource
    ##
    # Creates a new Impression using params and saves it
    # @see #save
    def self.create(params)
      Impression.new(params).save
    end

    ##
    # Records that a user has interacted with your application, including the 'location' within the app they used
    def save
      response = Intercom.post("users/impressions", to_hash)
      self.update_from_api_response(response)
    end

    ##
    # Set the ip address of the user for this impression
    def user_ip=(user_ip)
      @attributes["user_ip"] = user_ip
    end

    ##
    # Set the location in your application that this impression occurred. E.g. the url in a web app, or perhaps the screen in a desktop  or phone application.
    def location=(location)
      @attributes["location"] = location
    end

    ##
    # Set the user agent of the user this impression (E.g. their browser user agent, or the name and version of a desktop or phone application)
    def user_agent=(user_agent)
      @attributes["user_agent"] = user_agent
    end

    ##
    # For convenience, after saving, the unread_messages count will be updated with the number of unread messages for the user for their current location.
    #
    # Remember, Auto Messages (http://docs.intercom.io/#AutoMessages) can be targeted to only show when a user views a particular page in your application.
    def unread_messages
      @attributes["unread_messages"]
    end
  end
end