module Keen class Client module PublishingMethods # @deprecated # # Publishes a synchronous event # @param event_collection # @param [Hash] event properties # # @return the JSON response from the API def add_event(event_collection, properties, options={}) self.publish(event_collection, properties, options) end # Publishes a synchronous event # See detailed documentation here # https://keen.io/docs/api/reference/#event-collection-resource # # @param event_collection # @param [Hash] event properties # # @return the JSON response from the API def publish(event_collection, properties) ensure_project_id! ensure_write_key! check_event_data!(event_collection, properties) publish_body( api_event_collection_resource_path(event_collection), MultiJson.encode(properties), "publish") end # Publishes a batch of events # See detailed documentation here # https://keen.io/docs/api/reference/#post-request-body-example-of-batch-event-posting # # @param events - a hash where the keys are event collection names # and the values are arrays of hashes (event properties) # # @return the JSON response from the API def publish_batch(events) ensure_project_id! ensure_write_key! publish_body( api_events_resource_path, MultiJson.encode(events), "publish") end # Publishes an asynchronous event # See detailed documentation here # https://keen.io/docs/api/reference/#event-collection-resource # # @param event_collection # @param [Hash] event properties # # @return a deferrable to apply callbacks to def publish_async(event_collection, properties) ensure_project_id! ensure_write_key! check_event_data!(event_collection, properties) http_client = Keen::HTTP::Async.new( self.api_url, {:proxy_url => self.proxy_url, :proxy_type => self.proxy_type}) http = http_client.post( :path => api_event_collection_resource_path(event_collection), :headers => api_headers(self.write_key, "async"), :body => MultiJson.encode(properties) ) if defined?(EM::Synchrony) process_with_synchrony(http) else process_with_callbacks(http) end end def publish_batch_async(events) ensure_project_id! ensure_write_key! http_client = Keen::HTTP::Async.new( self.api_url, {:proxy_url => self.proxy_url, :proxy_type => self.proxy_type}) http = http_client.post( :path => api_events_resource_path, :headers => api_headers(self.write_key, "async"), :body => MultiJson.encode(events) ) if defined?(EM::Synchrony) process_with_synchrony(http) else process_with_callbacks(http) end end # Returns an encoded URL that will record an event. Useful in email situations. # See detailed documentation here # https://keen.io/docs/api/reference/#event-collection-resource # # @param event_collection # @param [Hash] event properties # # @return a URL that will track an event when hit def beacon_url(event_collection, properties) json = MultiJson.encode(properties) data = [json].pack("m0").tr("+/", "-_").gsub("\n", "") "#{self.api_url}#{api_event_collection_resource_path(event_collection)}?api_key=#{self.write_key}&data=#{data}" end # Returns an encoded URL that will record an event and then redirect. Useful in email situations. # See detailed documentation here # https://keen.io/docs/api/reference/#event-collection-resource # # @param event_collection # @param [Hash] event properties # # @return a URL that will track an event when hit def redirect_url(event_collection, properties, redirect_url) require 'open-uri' encoded_url = URI::encode(redirect_url) json = MultiJson.encode(properties) data = [json].pack("m0").tr("+/", "-_").gsub("\n", "") "#{self.api_url}#{api_event_collection_resource_path(event_collection)}?api_key=#{self.write_key}&data=#{data}&redirect=#{encoded_url}" end private def process_with_synchrony(http) if http.error error = HttpError.new("HTTP em-synchrony publish_async error: #{http.error}") Keen.logger.error(error) raise error else process_response(http.response_header.status, http.response.chomp) end end def process_with_callbacks(http) deferrable = EventMachine::DefaultDeferrable.new http.callback { begin response = process_response(http.response_header.status, http.response.chomp) rescue Exception => e Keen.logger.error(e) deferrable.fail(e) end deferrable.succeed(response) if response } http.errback { error = Error.new("HTTP publish_async failure: #{http.error}") Keen.logger.error(error) deferrable.fail(error) } deferrable end def publish_body(path, body, error_method) begin response = Keen::HTTP::Sync.new( self.api_url, self.proxy_url).post( :path => path, :headers => api_headers(self.write_key, "sync"), :body => body) rescue Exception => http_error raise HttpError.new("HTTP #{error_method} failure: #{http_error.message}", http_error) end process_response(response.code, response.body.chomp) end def api_events_resource_path "/#{api_version}/projects/#{project_id}/events" end def check_event_data!(event_collection, properties) raise ArgumentError, "Event collection can not be nil" unless event_collection raise ArgumentError, "Event properties can not be nil" unless properties end end end end