Contents

module Pixela::Client::GraphMethods
  # Create a new pixelation graph definition.
  #
  # @param graph_id [String]
  # @param name     [String]
  # @param unit     [String]
  # @param type     [String]
  # @param color    [String]
  #
  # @return [Hashie::Mash]
  #
  # @see https://pixe.la/#api-graph
  def create_graph(graph_id:, name:, unit:, type:, color:)
    params = {
      id:    graph_id,
      name:  name,
      unit:  unit,
      type:  type,
      color: color,
    }

    with_error_handling do
      connection.post("users/#{username}/graphs", params, user_token_headers).body
    end
  end

  # Get all predefined pixelation graph definitions.
  #
  # @return [Array<Hashie::Mash>]
  #
  # @see https://pixe.la/#api-graph
  def get_graphs
    with_error_handling do
      connection.get("users/#{username}/graphs", nil, user_token_headers).body.graphs
    end
  end

  # Get graph url
  #
  # @param graph_id [String]
  # @param date     [Date,Time,String]
  #
  # @return [String]
  #
  # @see https://pixe.la/#api-graph
  def graph_url(graph_id:, date: nil)
    url = "https://pixe.la/v1/users/#{username}/graphs/#{graph_id}"

    url << "?date=#{to_ymd(date)}" if date

    url
  end

  # Update predefined pixelation graph definitions.
  #
  # @param graph_id [String]
  # @param name     [String]
  # @param unit     [String]
  # @param color    [String]
  #
  # @return [Hashie::Mash]
  #
  # @see https://pixe.la/#api-graph
  def update_graph(graph_id:, name:, unit:, color:)
    params = {
      name:  name,
      unit:  unit,
      color: color,
    }

    with_error_handling do
      connection.put("users/#{username}/graphs/#{graph_id}", params, user_token_headers).body
    end
  end

  # Delete the predefined pixelation graph definition.
  #
  # @param graph_id [String]
  #
  # @return [Hashie::Mash]
  #
  # @see https://pixe.la/#api-graph
  def delete_graph(graph_id)
    with_error_handling do
      connection.delete("users/#{username}/graphs/#{graph_id}", nil, user_token_headers).body
    end
  end
end

Version data entries

1 entries across 1 versions & 1 rubygems

Version	Path
pixela-0.1.0	lib/pixela/client/graph_methods.rb