Initial approach with tests

Rafa Paradela · Rafa Paradela · commit abc53f6b1ce1 · 2016-05-11T03:07:49.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,6 @@
+Changelog
+=============
+
+## 2016/05/11 - Version 0.1
+
+- First version
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (C) 2012 47 Degrees, LLC http://47deg.com hello@47deg.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,18 @@
+Github4s
+=============
+
+**Github4s** is a GitHub API wrapper written in Scala.
+
+
+
+# License
+
+The MIT License (MIT)
+
+Copyright (C) 2012 47 Degrees, LLC http://47deg.com hello@47deg.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/build.sbt b/build.sbt
@@ -12,5 +12,7 @@ libraryDependencies ++= Seq(
   "org.scalaj" %% "scalaj-http" % "2.2.1",
   "io.circe" %% "circe-core" % "0.3.0",
   "io.circe" %% "circe-generic" % "0.3.0",
-  "io.circe" %% "circe-parser" % "0.3.0"
+  "io.circe" %% "circe-parser" % "0.3.0",
+  "org.scalatest" %% "scalatest" % "2.2.6" % "test",
+  "com.ironcorelabs" %% "cats-scalatest" % "1.1.2" % "test"
 )
diff --git a/src/main/scala/com/fortysevendeg/github4s/Github.scala b/src/main/scala/com/fortysevendeg/github4s/Github.scala
@@ -5,10 +5,6 @@ import cats.{MonadError, ~>}
 import com.fortysevendeg.github4s.GithubResponses._
 import com.fortysevendeg.github4s.app._
 
-
-case class GithubConfig(accessToken : Option[String] = None)
-
-
 class Github(accessToken : Option[String] = None) {
 
   lazy val users = new GHUsers(accessToken)
diff --git a/src/main/scala/com/fortysevendeg/github4s/GithubResponses.scala b/src/main/scala/com/fortysevendeg/github4s/GithubResponses.scala
@@ -54,6 +54,17 @@ object GithubResponses {
 
   private def toLowerCase(headers: Map[String, IndexedSeq[String]]): Map[String, IndexedSeq[String]] = headers.map(e => (e._1.toLowerCase, e._2))
 
+  implicit class GHEntity[A](result: GHResult[A]) {
+    def entity[A] = result match {
+      case GHListResult(r, _, _, _) => r
+      case GHItemResult(r, _, _) => r
+    }
+
+    def statusCode[A] = result match {
+      case GHListResult(_, sc, _, _) => sc
+      case GHItemResult(_, sc, _) => sc
+    }
 
+  }
 
 }
diff --git a/src/main/scala/com/fortysevendeg/github4s/api/Repos.scala b/src/main/scala/com/fortysevendeg/github4s/api/Repos.scala
@@ -2,7 +2,7 @@ package com.fortysevendeg.github4s.api
 
 import com.fortysevendeg.github4s.GithubResponses.GHResponse
 import com.fortysevendeg.github4s.free.domain.{Pagination, Commit, Repository, User}
-import com.fortysevendeg.github4s.{Decoders, GithubConfig, HttpClient}
+import com.fortysevendeg.github4s.{Decoders, HttpClient}
 import io.circe.generic.auto._
 
 object Repos {
diff --git a/src/main/scala/com/fortysevendeg/github4s/api/Users.scala b/src/main/scala/com/fortysevendeg/github4s/api/Users.scala
@@ -1,7 +1,7 @@
 package com.fortysevendeg.github4s.api
 
 import com.fortysevendeg.github4s.GithubResponses.GHResponse
-import com.fortysevendeg.github4s.{GithubConfig, HttpClient}
+import com.fortysevendeg.github4s.HttpClient
 import com.fortysevendeg.github4s.free.domain.{Pagination, User}
 import io.circe.generic.auto._
 
diff --git a/src/main/scala/com/fortysevendeg/github4s/app.scala b/src/main/scala/com/fortysevendeg/github4s/app.scala
@@ -0,0 +1,10 @@
+package com.fortysevendeg.github4s
+
+import cats.data.Coproduct
+import com.fortysevendeg.github4s.free.algebra._
+
+object app {
+  type COGH01[A] = Coproduct[RepositoryOp, UserOp, A]
+  type COGH02[A] = Coproduct[RequestOp, COGH01, A]
+  type GitHub4s[A] = Coproduct[AuthOp, COGH02, A]
+}
diff --git a/src/main/scala/com/fortysevendeg/github4s/client.sc b/src/main/scala/com/fortysevendeg/github4s/client.sc
diff --git a/src/main/scala/com/fortysevendeg/github4s/free/algebra/AuthOps.scala b/src/main/scala/com/fortysevendeg/github4s/free/algebra/AuthOps.scala
@@ -59,6 +59,7 @@ class AuthOps[F[_]](implicit I: Inject[AuthOp, F]) {
 
 }
 
+
 /** Default implicit based DI factory from which instances of the AuthOps may be obtained
   */
 object AuthOps {
diff --git a/src/main/scala/com/fortysevendeg/github4s/free/algebra/RepositoryOps.scala b/src/main/scala/com/fortysevendeg/github4s/free/algebra/RepositoryOps.scala
@@ -49,6 +49,7 @@ class RepositoryOps[F[_]](implicit I: Inject[RepositoryOp, F]) {
 
 }
 
+
 /** Default implicit based DI factory from which instances of the RepositoryOps may be obtained
   */
 object RepositoryOps {
diff --git a/src/main/scala/com/fortysevendeg/github4s/free/algebra/RequestOps.scala b/src/main/scala/com/fortysevendeg/github4s/free/algebra/RequestOps.scala
@@ -39,6 +39,7 @@ class RequestOps[F[_]](implicit I: Inject[RequestOp, F]) {
 
 }
 
+
 /** Default implicit based DI factory from which instances of the RequestOps may be obtained
   */
 object RequestOps {
diff --git a/src/main/scala/com/fortysevendeg/github4s/free/algebra/UserOps.scala b/src/main/scala/com/fortysevendeg/github4s/free/algebra/UserOps.scala
@@ -25,6 +25,7 @@ class UserOps[F[_]](implicit I: Inject[UserOp, F]) {
 
 }
 
+
 /** Default implicit based DI factory from which instances of the UserOps may be obtained
   */
 object UserOps {
diff --git a/src/main/scala/com/fortysevendeg/github4s/free/domain/User.scala b/src/main/scala/com/fortysevendeg/github4s/free/domain/User.scala
@@ -5,5 +5,5 @@ case class User(
     login: String,
     avatar_url: String,
     html_url: String,
-    name: String,
-    email: String)
+    name: Option[String] = None,
+    email: Option[String] = None)
diff --git a/src/main/scala/com/fortysevendeg/github4s/free/interpreters/Interpreters.scala b/src/main/scala/com/fortysevendeg/github4s/free/interpreters/Interpreters.scala
@@ -1,7 +1,7 @@
 package com.fortysevendeg.github4s.free.interpreters
 
 import cats.{MonadError, ApplicativeError, ~>, Eval}
-import com.fortysevendeg.github4s.{HttpClient, GithubConfig}
+import com.fortysevendeg.github4s.HttpClient
 import com.fortysevendeg.github4s.api.{Auth, Repos}
 import com.fortysevendeg.github4s.app.{COGH01, COGH02, GitHub4s}
 import com.fortysevendeg.github4s.free.algebra._
diff --git a/src/test/scala/GHAuthSpec.scala b/src/test/scala/GHAuthSpec.scala
@@ -0,0 +1,28 @@
+import cats.Id
+import com.fortysevendeg.github4s.GithubResponses._
+import com.fortysevendeg.github4s.free.interpreters.IdInterpreters._
+import com.fortysevendeg.github4s.Github
+import com.fortysevendeg.github4s.Github._
+import org.scalatest._
+import cats.scalatest.{XorValues, XorMatchers}
+
+class GHAuthSpec extends FlatSpec with Matchers with XorMatchers with XorValues with TestUtils {
+
+  "Auth >> NewAuth" should "return error on Left when invalid credential is provided" in {
+    val response = Github().auth.newAuth(validUsername, invalidPassword, validScopes, validNote, validClientId, invalidClientSecret).exec[Id]
+    response shouldBe left
+  }
+
+  "Auth >> AuthorizeUrl" should "return the expected URL for valid username" in {
+    val response = Github().auth.authorizeUrl(validClientId, validRedirectUri, validScopes).exec[Id]
+    response shouldBe right
+    response.value.entity.url.contains(validRedirectUri) shouldBe true
+    response.value.statusCode shouldBe statusCodeOK
+  }
+
+  "Auth >> GetAccessToken" should "return error on Left for invalid code value" in {
+    val response = Github().auth.getAccessToken(validClientId, invalidClientSecret, "", validRedirectUri, "").exec[Id]
+    response shouldBe left
+  }
+
+}
diff --git a/src/test/scala/GHReposSpec.scala b/src/test/scala/GHReposSpec.scala
@@ -0,0 +1,36 @@
+import cats.Id
+import com.fortysevendeg.github4s.GithubResponses._
+import com.fortysevendeg.github4s.free.interpreters.IdInterpreters._
+import com.fortysevendeg.github4s.Github
+import com.fortysevendeg.github4s.Github._
+import org.scalatest._
+import cats.scalatest.{XorValues, XorMatchers}
+
+class GHReposSpec extends FlatSpec with Matchers with XorMatchers with XorValues with TestUtils {
+
+  "Repos >> Get" should "return the expected name when valid repo is provided" in {
+    val response = Github().repos.get(validRepoOwner, validRepoName).exec[Id]
+    response shouldBe right
+    response.value.entity.name shouldBe validRepoName
+    response.value.statusCode shouldBe statusCodeOK
+  }
+
+  it should "return error on Left for invalid repo name" in {
+    val response = Github().repos.get(validRepoOwner, invalidRepoName).exec[Id]
+    response shouldBe left
+  }
+
+  "Repos >> ListCommits" should "return the expected login for a valid username" in {
+    val response = Github().repos.listCommits(validRepoOwner, validRepoName).exec[Id]
+    response shouldBe right
+    response.value.entity.nonEmpty shouldBe true
+    response.value.statusCode shouldBe statusCodeOK
+  }
+
+  it should "return error on Left for invalid repo name" in {
+    val response = Github().repos.listCommits(invalidRepoName, validRepoName).exec[Id]
+    response shouldBe left
+  }
+
+
+}
diff --git a/src/test/scala/GHUsersSpec.scala b/src/test/scala/GHUsersSpec.scala
@@ -0,0 +1,43 @@
+import cats.Id
+import com.fortysevendeg.github4s.GithubResponses._
+import com.fortysevendeg.github4s.free.interpreters.IdInterpreters._
+import com.fortysevendeg.github4s.Github
+import com.fortysevendeg.github4s.Github._
+import org.scalatest._
+import cats.scalatest.{XorValues, XorMatchers}
+
+
+class GHUsersSpec extends FlatSpec with Matchers with XorMatchers with XorValues with TestUtils {
+
+  "Users >> Get" should "return the expected login for a valid username" in {
+    val response = Github().users.get(validUsername).exec[Id]
+    response shouldBe right
+    response.value.entity.login shouldBe validUsername
+    response.value.statusCode shouldBe statusCodeOK
+  }
+
+  it should "return error on Left for invalid username" in {
+    val response = Github().users.get(invalidUsername).exec[Id]
+    response shouldBe left
+  }
+
+  "Users >> GetAuth" should "return error on Left when no accessToken is provided" in {
+    val response = Github().users.getAuth.exec[Id]
+    response shouldBe left
+  }
+
+  "Users >> GetUsers" should "return users for a valid since value" in {
+    val response = Github().users.getUsers(validSinceInt).exec[Id]
+    response shouldBe right
+    response.value.entity.nonEmpty shouldBe true
+    response.value.statusCode shouldBe statusCodeOK
+  }
+
+  it should "return error on Left when a invalid since value is provided" in {
+    val response = Github().users.getUsers(invalidSinceInt).exec[Id]
+    response shouldBe right
+    response.value.entity.nonEmpty shouldBe true
+    response.value.statusCode shouldBe statusCodeOK
+  }
+
+}

Original file line number	Diff line number	Diff line change
`@@ -12,5 +12,7 @@ libraryDependencies ++= Seq(`
`12`	`12`	`"org.scalaj" %% "scalaj-http" % "2.2.1",`
`13`	`13`	`"io.circe" %% "circe-core" % "0.3.0",`
`14`	`14`	`"io.circe" %% "circe-generic" % "0.3.0",`
`15`		`- "io.circe" %% "circe-parser" % "0.3.0"`
	`15`	`+ "io.circe" %% "circe-parser" % "0.3.0",`
	`16`	`+ "org.scalatest" %% "scalatest" % "2.2.6" % "test",`
	`17`	`+ "com.ironcorelabs" %% "cats-scalatest" % "1.1.2" % "test"`
`16`	`18`	`)`