[Embed API] Ruby Client Library and Tests

[sup]

Ruby client library to make calls to the new Embed API. Added function calls and tests.

[sup]

nondeterministic failures are the best kind of failures /s

[yannmh]

Is the title parameter mandatory ?

From documentation page, it looks like it's automatically set when no value is submitted, i.e.:

curl -POST \
    -d 'graph_json={"requests":[{"q":"avg:system.load.1{*}"}],"viz":"timeseries","events":[]}' \
    -d "timeframe=1_hour" \
    -d "size=medium" \
    -d "legend=yes" \
    "https://app.datadoghq.com/api/v1/graph/embed?api_key=${api_key}&application_key=${app_key}"

leads to

{   
  "embed_id": "5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c", 
  "template_variables": [], 
  "html": "<iframe src=\"https://app.datadoghq.com/graph/embed?token=5f585b01c81b12ecdf5f40df0382738d0919170639985d3df5e2fc4232865b0c&height=300&width=600&legend=true\" width=\"600\" height=\"300\" frameBorder=\"0\"></iframe>", 
  "graph_title": "Embed created through API", 
  "revoked": false, 
  "dash_url": null, 
  "shared_by": 3658, 
  "dash_name": null

(note the graph_title field value)

[sup]

@yannmh It isn't required. Did I make title required in the Ruby code? I'm not super familiar with Ruby so I assumed the default parameters work the same way as they do in Python

[sup]

Well titles are required in the sense that the embed has to have a title at least 1 character in length and the default title is "Embed created through API"

[sup]

I guess the default params can be nil

[yannmh]

It looks great overall.

However, I think we should make all optional parameters part of a kwarg, like we do for most of our API features (unfortunately not all 👎 ).
i.e having

dog.create_embed(graph_json, :timeframe => timeframe, :size => size, :legend => legend ...)

rather than

dog.create_embed(graph_json, timeframe, size, legend, title)

[sup]

Changed parameters to use a dictionary/hash kwargs

[yannmh]

Thanks for the update @charleslai.

I added two nitpicks. Could you also update the documentation to reflect those changes please ?

[yannmh]

Can you check that the values returned match the description ?

[sup]

I sort of do a check by checking if the html after using get is different from the html that was originally created but I guess I could try parsing the html string

[yannmh]

Great work. Thanks for addressing all the comments.

I am waiting for the tests to complete and merging.