Support Comment API #127

AdrianRaFo · 2017-05-10T10:37:37Z

Fixes #106 Create, Edit and Delete Comments

…github.com/47deg/github4s into arf-106-Support-Comment-Api

fix notification name

create runEmpty

…ment-Api

codecov-io · 2017-05-10T12:45:11Z

Codecov Report

Merging #127 into master will decrease coverage by 0.33%.
The diff coverage is 77.77%.

@@            Coverage Diff            @@
##           master    #127      +/-   ##
=========================================
- Coverage   88.44%   88.1%   -0.34%     
=========================================
  Files          38      38              
  Lines         528     555      +27     
  Branches        2       2              
=========================================
+ Hits          467     489      +22     
- Misses         61      66       +5

Impacted Files	Coverage Δ
...cala/github4s/free/interpreters/Interpreters.scala	`80% <0%> (-3.59%)`	⬇️
...c/main/scala/github4s/free/algebra/IssuesOps.scala	`50% <0%> (-21.43%)`	⬇️
...cala/github4s/HttpRequestBuilderExtensionJVM.scala	`100% <100%> (ø)`	⬆️
...4s/shared/src/main/scala/github4s/HttpClient.scala	`100% <100%> (+10.34%)`	⬆️
...4s/shared/src/main/scala/github4s/api/Issues.scala	`100% <100%> (ø)`	⬆️
...4s/shared/src/main/scala/github4s/GithubAPIs.scala	`100% <100%> (ø)`	⬆️
...scala/github4s/HttpRequestBuilderExtensionJS.scala	`80.76% <75%> (-6.19%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f8233d9...def7d08. Read the comment docs.

fedefernandez

Left some comments, my main concern is the way we've added the new algebras, I've created a new issue to tackle that (#129). Please, move the operations to the Issues algebra/api

Good work overall

fedefernandez · 2017-05-10T12:24:45Z

docs/src/main/tut/comments.md

+Github4s supports the [Comments API](https://developer.github.com/v3/activity/comments/). As a result,
+with github4s, you can:
+
+- [Set a thread subscription](#set-a-thread-subscription)


😏 "Set a thread subscription"?

I don't have any idea how that can be there 😋

fedefernandez · 2017-05-10T12:27:39Z

docs/src/main/tut/comments.md

+ To create a comment:
+
+```scala
+val editComment = Github(accessToken).comments.edit("47deg", "github4s", 20,"this is the new comment")


-- val editComment = Github(accessToken).comments.edit("47deg", "github4s", 20,"this is the new comment") ++ val editComment = Github(accessToken).comments.edit("47deg", "github4s", 20, "this is the new comment")

fedefernandez · 2017-05-10T12:28:03Z

docs/src/main/tut/comments.md

+ To create a comment:
+
+```scala
+val createcomment = Github(accessToken).comments.create("47deg", "github4s", 123,"this is the comment")


-- val createcomment = Github(accessToken).comments.create("47deg", "github4s", 123,"this is the comment") ++ val createcomment = Github(accessToken).comments.create("47deg", "github4s", 123, "this is the comment")

fedefernandez · 2017-05-10T12:28:35Z

docs/src/main/tut/comments.md

+ - `id`: The comment id
+ - `body`: The new comment description
+
+ To create a comment:


-- To create a comment: ++ To edit a comment:

fedefernandez · 2017-05-10T12:28:56Z

docs/src/main/tut/comments.md

+## Delete a Comment
+
+
+You can create a comment for an issue whit the next parameters:


fedefernandez · 2017-05-10T12:35:51Z

docs/src/main/tut/comments.md

+
+See [the API doc](https://developer.github.com/v3/activity/comments/#set-a-thread-subscription) for full reference.
+
+As you can see, a few features of the pull request endpoint are missing. As a result, if you'd like


comments instead of pull request

fedefernandez · 2017-05-10T12:39:01Z

github4s/shared/src/main/scala/github4s/app.scala

@@ -27,5 +27,6 @@ object app {
  type COGH05[A]   = Coproduct[GitDataOp, COGH04, A]
  type COGH06[A]   = Coproduct[PullRequestOp, COGH05, A]
  type COGH07[A]   = Coproduct[NotificationOp, COGH06, A]
-  type GitHub4s[A] = Coproduct[StatusOp, COGH07, A]
+  type COGH08[A]   = Coproduct[CommentOp, COGH07, A]
+  type GitHub4s[A] = Coproduct[StatusOp, COGH08, A]


Comment algebra should be inside of Issue algebra

fedefernandez · 2017-05-10T12:48:55Z

github4s/shared/src/main/scala/github4s/api/Comments.scala

+   * @param repo name of the repo
+   * @param number Issue number
+   * @param body Comment body
+   * @return a GHResponse with the created Status


created Comment

fedefernandez · 2017-05-10T12:49:28Z

github4s/shared/src/main/scala/github4s/api/Comments.scala

+   * @param repo name of the repo
+   * @param id Comment id
+   * @param body Comment body
+   * @return a GHResponse with the edit Status


edited Comment

fedefernandez · 2017-05-10T12:49:40Z

github4s/shared/src/main/scala/github4s/api/Comments.scala

+   * @param owner of the repo
+   * @param repo name of the repo
+   * @param id Comment id
+   * @return a GHResponse with the delete Status


deleted Comment

fedefernandez

LGTM! Great work!

BenFradet

LGTM 👍 , a few minors regarding the doc

BenFradet · 2017-05-10T14:17:29Z

docs/src/main/tut/issue.md

@@ -138,4 +142,62 @@ The `result` on the right is a [SearchIssuesResult][issue-scala].

 See [the API doc](https://developer.github.com/v3/search/#search-issues) for full reference.

+## Create a Comment
+
+You can create a comment for an issue whit the next parameters:


with the following parameters

BenFradet · 2017-05-10T14:18:23Z

docs/src/main/tut/issue.md

+## Edit a Comment
+
+
+You can edit a comment from an issue whit the next parameters:


BenFradet · 2017-05-10T14:18:50Z

docs/src/main/tut/issue.md

+## Delete a Comment
+
+
+You can delete a comment from an issue whit the next parameters:


BenFradet · 2017-05-10T14:21:01Z

github4s/jvm/src/main/scala/github4s/HttpRequestBuilderExtensionJVM.scala


-import scalaj.http._
+import scalaj.http.{Http, HttpOptions, HttpRequest, HttpResponse, _}


just scalaj.http._ would suffice, no?

BenFradet · 2017-05-10T14:27:34Z

docs/src/main/tut/issue.md

@@ -138,4 +142,62 @@ The `result` on the right is a [SearchIssuesResult][issue-scala].

 See [the API doc](https://developer.github.com/v3/search/#search-issues) for full reference.

+## Create a Comment


Should we have a separate section for comments? like

Issue API

...

Issues

Create an issue

...

Comments

Create a comment

...

peterneyens · 2017-05-10T14:35:39Z

github4s/jvm/src/main/scala/github4s/HttpRequestBuilderExtensionJVM.scala

+    Either.right(GHResult((): Unit, r.code, toLowerCase(r.headers)))
+
+  def decodeEntity[A](r: HttpResponse[String])(implicit D: Decoder[A]): GHResponse[A] =
+    decode[A](r.body).fold(


Just FYI, I think you can use bimap (from cats.functor.Bifunctor[Either]) instead of fold and Either.left and Either.right.

Something like (untested) :

decode[A](r.body).bimap( e => JsonParsingException(e.getMessage, r.body), result => GHResult(result, r.code, toLowerCase(r.headers)) )

Similarly in HttpRequestBuilderExtensionJS.scala.

I didn't knew bimap, it's really cool

juanpedromoreno

LGTM! Great work!

AdrianRaFo added 10 commits May 8, 2017 17:27

create comment api support

22735e0

wip comment api docs

97a8e60

fix some merge errors

9c2482d

Merge branches 'arf-106-Support-Comment-Api' and 'master' of https://…

32c9886

…github.com/47deg/github4s into arf-106-Support-Comment-Api

create the docs

3139378

create the js and jvm integration and test

6b10b50

fix notification name

create shared test

970c3fb

wip fix delete test

febb79d

create runEmpty

wip fix basespec

0cc286d

fix basespec

7f9562f

juanpedromoreno changed the title ~~Support comment api~~ Support Comment API May 10, 2017

Merge remote-tracking branch 'origin/master' into arf-106-Support-Com…

d1f0533

…ment-Api

fedefernandez requested changes May 10, 2017

View reviewed changes

adrian added 5 commits May 10, 2017 15:00

fix doc

7d35802

fix doc

92cea02

refactor comment to issue

4e1350f

refactor comment to issue doc

590b137

minor fix

cd83b5f

fedefernandez approved these changes May 10, 2017

View reviewed changes

BenFradet reviewed May 10, 2017

View reviewed changes

peterneyens reviewed May 10, 2017

View reviewed changes

Requested Changes

6c893f9

juanpedromoreno approved these changes May 10, 2017

View reviewed changes

minos fixes

def7d08

juanpedromoreno merged commit 0e6041a into master May 11, 2017

juanpedromoreno deleted the arf-106-Support-Comment-Api branch May 11, 2017 07:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support Comment API #127

Support Comment API #127

AdrianRaFo commented May 10, 2017

codecov-io commented May 10, 2017 •

edited

Loading

fedefernandez left a comment

fedefernandez May 10, 2017

AdrianRaFo May 10, 2017 •

edited

Loading

fedefernandez May 10, 2017

fedefernandez May 10, 2017

fedefernandez May 10, 2017

fedefernandez May 10, 2017

fedefernandez May 10, 2017

fedefernandez May 10, 2017

fedefernandez May 10, 2017

fedefernandez May 10, 2017

fedefernandez May 10, 2017

fedefernandez left a comment

BenFradet left a comment

BenFradet May 10, 2017

BenFradet May 10, 2017

BenFradet May 10, 2017

BenFradet May 10, 2017

BenFradet May 10, 2017

fedefernandez May 10, 2017

peterneyens May 10, 2017 •

edited

Loading

AdrianRaFo May 10, 2017

juanpedromoreno left a comment

		## Delete a Comment


		You can create a comment for an issue whit the next parameters:


		See [the API doc](https://developer.github.com/v3/activity/comments/#set-a-thread-subscription) for full reference.

		As you can see, a few features of the pull request endpoint are missing. As a result, if you'd like

		## Edit a Comment


		You can edit a comment from an issue whit the next parameters:

		## Delete a Comment


		You can delete a comment from an issue whit the next parameters:


		import scalaj.http._
		import scalaj.http.{Http, HttpOptions, HttpRequest, HttpResponse, _}

		@@ -138,4 +142,62 @@ The `result` on the right is a [SearchIssuesResult][issue-scala].

		See [the API doc](https://developer.github.com/v3/search/#search-issues) for full reference.

		## Create a Comment

Support Comment API #127

Support Comment API #127

Conversation

AdrianRaFo commented May 10, 2017

codecov-io commented May 10, 2017 • edited Loading

Codecov Report

fedefernandez left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AdrianRaFo May 10, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fedefernandez left a comment

Choose a reason for hiding this comment

BenFradet left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Issue API

Issues

Create an issue

Comments

Create a comment

Choose a reason for hiding this comment

peterneyens May 10, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

juanpedromoreno left a comment

Choose a reason for hiding this comment

codecov-io commented May 10, 2017 •

edited

Loading

AdrianRaFo May 10, 2017 •

edited

Loading

peterneyens May 10, 2017 •

edited

Loading