Contents

module Datarank
  class Client

    # Module containing methods for interacting with topics
    module Volume
     
      # Return volume for a topic grouped by a time interval
      # 
      # @param slug [String] A topic's unique identifier slug
      def volume_secondly(slug, options={})
        get "/topics/#{slug}/volume/secondly", options
      end

      def volume_minutely(slug, options={})
        get "/topics/#{slug}/volume/minutely", options
      end

      def volume_hourly(slug, options={})
        get "/topics/#{slug}/volume/hourly", options
      end

      def volume_daily(slug, options={})
        get "/topics/#{slug}/volume/daily", options
      end

      def volume_weekly(slug, options={})
        get "/topics/#{slug}/volume/weekly", options
      end

      def volume_monthly(slug, options={})
        get "/topics/#{slug}/volume/monthly", options
      end

      def volume_quarterly(slug, options={})
        get "/topics/#{slug}/volume/quarterly", options
      end

      def volume_yearly(slug, options={})
        get "/topics/#{slug}/volume/yearly", options
      end

      # Return hourly average volume for a topic
      #
      # @param slug [String] A topic's unique identifier slug
      def volume_hourly_average(slug, options={})
        get "/topics/#{slug}/volume/hourly/average", options
      end

      # Return day-of-week volume for a topic
      #
      # @param slug [String] A topic's unique identifier slug
      def volume_weekday(slug, options={})
        get "/topics/#{slug}/volume/weekday", options
      end

      # Return hourly day-of-week heatmap information for a topic
      #
      # @param slug [String] A topic's unique identifier slug
      def volume_weekday_heatmap_hourly(slug, options={})
        get "/topics/#{slug}/volume/weekday/heatmap/hourly", options
      end

    end

  end
end

Version data entries

2 entries across 2 versions & 2 rubygems

Version	Path
datarank-v2-1.0.0	lib/datarank/volume.rb
datarank-1.4.0	lib/datarank/volume.rb