Allow nested attributes to be accessed

[dsul]

The current architecture of the Base::attributed method does not allow for access to nested attributes that are a part of the Harvest v2 API. We modified that method in a way that we thought aligned with your vision so that accessors can be dynamically created when nested attributes are passed in.

For example:
The v2 API has id nested within a project object in Time Entries, as opposed to having a top-level project_id accessor like the current architecture assumes. The suggested change would create a project_id accessor by combining the top level project key with each nested attribute.

[etagwerker]

@dsul This is very interesting. Thanks for starting the conversation.

I understand that we need a solution for this problem, but I think it would be best to implement something that allowed the user to do this:

time_entries = client.time_entries
time_entry = time_entries.first

expect(time_entry.project.name).to eq(project_name)
expect(time_entry.project.id).to eq(project_id)

In that scenario, we could load time_entry.project with a Harvesting::Models::Project instance and populate it with the right attributes.

What do you think?

[gap777]

@etagwerker how about now? Your approach was one we considered, but didn't land on initially, but seems easy enough to adopt.

Did you imagine making model classes for things like time_entry.invoice and time_entry.external_reference?

[gap777]

@etagwerker @benphelps @mscottford can we get some response to this? Seems like a few PRs have stalled.

[etagwerker]

@dsul This is great! One last thing, could you add some examples to README.md?

Also, I'm open to ideas to improve documentation for this new behavior.

[gap777]

@etagwerker Updates made - what do you think?

[etagwerker]

@gap777 @dsul Great, thanks! 💯