aptible / aptible-resource Goto Github PK

The current #create_XXX methods (e.g. app.create_operation) swallow errors, and return a Aptible::Resource::Base object, which can be very confusing, especially considering that attempting to reload those resources will throw an immensely cryptic Resource server root URL must be defined by subclass error.

Now, we do have equivalent bang methods (e.g. app.create_operation!), which do throw exception, but they're not used everywhere.

For example, in aptible-integration, we're using app.create_operation practically everywhere), and when it started throwing Resource server root URL must be defined by subclass (https://travis-ci.com/aptible/aptible-integration/jobs/41749266), it wasn't immediately obvious at all that the cause was in API (ultimately https://github.com/aptible/api.aptible.com/pull/373).

Is there value in having methods that swallow errors? Is there value in that being the most natural method call? I think the answer to both questions is no, and I think we should simply make both methods do the same thing (i.e. raise exceptions), and possibly raise a deprecation warning on the bang methods that they're now redundant.

Thoughts @blakepettersson @fancyremarker?

We cache links in the accessors we create for relations, but we don't check that they're still valid before returning them.

If you run something.update(a_relation: new_object, some_other_field: new_value), then something.some_other_field will return the new value, but something.a_relation will continue to return the old value (even though the new link was included in the response).

A workaround is to run: something = something.reload after the update.

So far it's:

$ grep -r hyperresource-aptible */Gemfile.lock | sed 's/:.*//' | sort | uniq
api.aptible.com/Gemfile.lock
aptible-cli/Gemfile.lock
megatron/Gemfile.lock
policy.aptible.com/Gemfile.lock
primetime/Gemfile.lock

See also #11.

For example, Aptible::Auth::User.new.roles should be [], not nil.

It should be possible to instantiate a new resource with parameters, for referencing purposes.

e.g.:

user.email = '[email protected]
user.save

cc: @sandersonet

As an alternative for requiring explicit embeds_* / has_* definition.