Add Push Rule service

[jetersen]

Love the newly added updatePushRule but it felt lacking when you wanted to enforce push rule for all projects and gitlab API was lacking a createOrEdit function and would return null with status code 404 when no push rules were created.

[jetersen]

did a npm test with the newly added createOrEdit test and works on our instance. Guess the Travis CI is having a bad day 😢

[jdalrymple]

Yea travis is still having issues and im not sure why. Still waiting to hear back from them: travis-ci/travis-ci#9965

[jetersen]

I can remove this if you consider this too much but I thought it be useful otherwise devs would have to implement this all over.

[jdalrymple]

Would it make sense to include the createOrEdit functionality within the edit function with an option?

[jdalrymple]

OR have it included in the create function with an overwrite option?

[jetersen]

Sounds reasonable 😅

[jdalrymple]

lol which one makes MORE sense :P ?

[jetersen]

Well create seems more reasonable since it throws error if it exists thats more understandable then edit...

{
    "error": "Project push rule exists"
}

edit throws:

{
    "message": "404 Push Rule Not Found"
}

[jdalrymple]

Sounds good to me! So just add an option to overwrite Wooo. This is awesome. Hopefully i can get it to release ASAP. Just waiting on the travis team for an update.

[jetersen]

Just to be clear, your suggestion was removing createOrEdit and use overwrite option?

[jetersen]

Should be all good then 😅

[jdalrymple]

async create(projectId, options = { overwrite: false }) {

[jdalrymple]

Would it be cleaner to do:

...
    const { overwrite, ...args } = options;

    if (overwrite) {
      const pushRule = await this.show(projectId);

      if (pushRule) return this.edit(projectId, args)
    }

    return RequestHelper.post(this, `projects/${pId}/push_rule`, args);

[jetersen]

Overwrite seems like a bad word since a put only updates. It does not overwrite

[jetersen]

overwrite would be delete and post, while, update would be post or put

[jetersen]

this avoid the options parameter and seems cleaner at the same time.

[jdalrymple]

I agree, my only reservation is the name, i feel like its close in meaning to edit no?

[jdalrymple]

Let me step back and think. When we create a new push rule, we want to handle the case where the push rule may already exist. In that case we want to edit that already existing push rule and update its values.

Generally though, we usually don't create something and find out it already exists. We usually try and edit something and find out it doesnt exist.

So what i suggest, which it kinda against what we spoke about above, it adding this functionality to the edit function, with an option to upsert/create/ensureExists or something like that.

I think that would be clearer than an update function (which would get confused with edit) and overwrite (which probably wouldnt be used as often)

Thoughts?

[jetersen]

I like upsert as a wording for create or edit 👍 Perhaps upsert as a method instead of a parameter to avoid having edit as async function?

[jdalrymple]

All of those functions are async, they just dont require the function prefix because the its contained in the return and doesnt include an await line :)

[jetersen]

This reads horribly in edit 😞 I definitely prefer upsert just as an method

  async edit(projectId, options) {
    const pId = encodeURIComponent(projectId);

    const { upsert, ...args } = options;

    if (upsert) {
      const pushRule = await this.show(projectId);

      if (!pushRule) return this.create(projectId, args)
    }

    return RequestHelper.put(this, `projects/${pId}/push_rule`, args);
  }

[jdalrymple]

This is a little cleaner

  async edit(projectId, { upsert, ...options } ={}) {
    const pId = encodeURIComponent(projectId);

    if (upsert) {
      const pushRule = await this.show(projectId);

      if (!pushRule) return this.create(projectId, options)
    }

    return RequestHelper.put(this, `projects/${pId}/push_rule`, args);
  }

[jdalrymple]

🎉 This PR is included in version 3.8.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀