Merge pull request #2 from juan62/add_readme

Add readme

Author: juan62

LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Yoshitaka Okuda
+
+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.

README.md

@@ -0,0 +1,111 @@
+# sqscala
+simple AWS SQS client for Scala.
+
+This library, has been inspired by [com.kifi.franz](https://github.com/kifi/franz).
+I like franz, but there are only a few of the configurations in order to create the AWS client.
+I wanted a more customizable interfaces.
+
+## Installation
+
+```
+resolvers += "jitpack" at "https://jitpack.io"
+libraryDependencies += "com.github.juan62" % "sqscala" % "1.0.0"
+```
+
+## How to use
+
+### 1a. prepare by application.conf(easy way)
+
+put application.conf in your classpath(resources).
+
+```conf
+aws {
+  sqs {
+    # endpoint-url or region
+    # If you want to connect to localhost, example 'endpoint-url="http://localhost:9324"'
+    # endpoint-url = null
+    region = "us-west-2"
+
+    # max-retry = 3
+    # max-connections = 50
+    # connection-timeout-ms = 50000  # millis
+    # socket-timeout-ms = 50000      # millis
+  }
+}
+```
+
+then your code, like
+
+```scala
+import com.github.juan62.sqscala._
+
+val client = ConfiguredSqsClient()
+```
+
+### 1b. prepare by code
+
+You can use SqsClient with credential provider and regions.
+In many cases, it is easy that you should use regions pattern.
+Of course, you can instantiate AWS client directly, and set SqsClient object to first argument.
+
+```scala
+import com.amazonaws.regions.Regions
+import com.github.juan62.sqscala._
+
+val client = SqsClient()
+// or
+val client = SqsClient(regions = Regions.US_WEST_2)
+// or
+val client = SqsClient(credentialProvider = new YourCustomCredentialProvider())
+```
+
+### 2. connect the SQS via queue
+
+Get a queue object from SqsClient.
+
+```scala
+val queue = client.queue(QueueName("foo"))
+// or
+val queue = client.queue(QueueName("foo"), createIfNotExists = true)
+```
+
+SqsQueue requires MessageSerializer used to serialize/deserialize the SQS message body.
+(Message Body <=> Any Type)
+By default, sqscala has only a StringSerializer(Message Body <=> String).
+You can switch it on implicit parameter.
+
+```scala
+import com.github.juan62.sqscala.Implicits.stringSerializer
+// or
+implicit val serializer = YourOriginalSerializer
+```
+
+then you can use queue, like
+
+```scala
+// send message to SQS
+queue.send("hello, sqs.").onComplete {
+  // ...
+}
+
+// receive message from SQS
+queue.receive().onComplete {
+  case Success(message) => // ...
+  case Failure(exception) => // ...
+}
+
+// delete message from SQS
+queue.receive().onSuccess {
+  case Some(message) =>
+    // ...
+    queue.delete(message.receiptHandle).onComplete {
+      // ...
+    }
+}
+```
+
+## Road map
+
+1. support batch request.
+2. support queue attributes.
+3. support JSON serialization.

build.sbt

@@ -4,7 +4,7 @@ licenses +=("MIT", url("http://opensource.org/licenses/MIT"))
 
 name := "sqscala"
 
-version := "1.0"
+version := "1.0.0"
 
 scalaVersion := "2.11.7"
 

src/main/scala/com/github/juan62/sqscala/serializer/MessageSerializer.scala

@@ -1,8 +1,9 @@
 package com.github.juan62.sqscala.serializer
 
 trait MessageSerializer[T] {
+  type MessageBody = String
 
-  def serialize(obj: T): String
+  def serialize(obj: T): MessageBody
 
-  def deserialize(messageBody: String): T
+  def deserialize(messageBody: MessageBody): T
 }

src/main/scala/com/github/juan62/sqscala/serializer/StringSerializer.scala

@@ -1,7 +1,7 @@
 package com.github.juan62.sqscala.serializer
 
 object StringSerializer extends MessageSerializer[String] {
-  override def serialize(obj: String): String = obj
+  override def serialize(obj: String): MessageBody = obj
 
-  override def deserialize(messageBody: String): String = messageBody
+  override def deserialize(messageBody: MessageBody): String = messageBody
 }