Skip to content

Commit

Permalink
Initial commit. v0.x branch of evrythng-scala-sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
@jeanadrien
jeanadrien committed May 8, 2017
0 parents commit 74f2224
Show file tree
Hide file tree
Showing 99 changed files with 4,523 additions and 0 deletions.
12 changes: 12 additions & 0 deletions .editorconfig
@@ -0,0 +1,12 @@
[*]
end_of_line = lf
insert_final_newline = true
charset = utf-8

[*.scala]
indent_style=space
indent_size=4

[*.sbt]
indent_style=space
indent_size=4
2 changes: 2 additions & 0 deletions .gitignore
@@ -0,0 +1,2 @@
.idea/
target/
202 changes: 202 additions & 0 deletions LICENSE-2.0.txt
@@ -0,0 +1,202 @@

Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright [yyyy] [name of copyright owner]

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
164 changes: 164 additions & 0 deletions README.md
@@ -0,0 +1,164 @@
# Evrythng Scala SDK

This is *Evrythng Scala SDK*
An unofficial Scala library for the [EVRYTHNG](http://evrythng.com) API. Features include

* Case Classes for the EVRYTHNG model, built with [spray-json](https://github.com/spray/spray-json).
* Low level asynchronous REST http wrapper.
* Higher level API browsing dsl.
* Abstraction on http client, and ready-to-use adapters for [Apache HttpComponents](https://hc.apache.org/httpcomponents-client-ga/)
and Play Framework [WS Api](https://www.playframework.com/documentation/2.5.x/ScalaWS)

# Documentation

Evrythng Scala SDK gives and structures access to the different resources provided by the EVRYTHNG IoT Platform.
It allows a type safe interaction with the EVRYTHNG model, and an easy integration within any Scala projects.

For a complete documentation about the EVRYTHNG Api, its _Resources_ and corresponding endpoints, please refer to
the official [EVRYTHNG Developer Hub](https://developers.evrythng.com/).

## Library dependency

TODO

## Examples

The entry point of the sdk is the `Environment` object. It provides the basic REST request methods.
All model classes are available in `com.github.jeanadrien.evrythng.scala.json` package.

### Make an http REST request

The simplest way to use the sdk is to use the REST method directly on your _Authenticated_ environment object.

The coresponding `get` `put` `post` and `delete` methods takes the expected json type as a _type parameter_ and
the target _endpoint_ and if applicable _input_ as method parameter. They return a `EvtRequest` which can then
be executed using `exec` method to get a `Future`.

Note that you can use the model provided in the `json` pacakge, as well as the spray `JsValue` class.

Here is an example using an _Operator API key_. You can create your own account and get your _Operation API key_
via the [EVRYTHNG Dashboard](https://dashboard.evrythng.com)


```scala

import com.github.jeanadrien.evrythng.scala.rest.Environment
import com.github.jeanadrien.evrythng.scala.json._
import EvtJsonProtocol._

import scala.concurrent._
import ExecutionContext.Implicits.global
import scala.util.{Success, Failure}

val env = Environment.operatorApi("MY-OPERATOR-API-KEY")

// Create an read a thng
(for {
create <- env.post[Thng, Thng]("/thngs", Thng(
name = Some("This is a test")
)).exec
read <- env.get[Thng](s"/thngs/${create.id.get.id}").exec
} yield read) onComplete {
case Success(t) =>
println(s"Loaded Thng '${t}'")
case Failure(error) =>
println(s"Got error: ${error}")
}

```

### Structured API

Instead of building the _endpoint_ urls and give the possibily wrong json Type,
you can use the structured API which build the `EvtRequest` with the correct url and type parameters.
Each endpoints can be constructed by a natural method chaining, following the API endpoint structure.

* E.g. to access `/thngs/<id>/properties`

```
env.thng(Ref("Uk7h9Qb2BgPw9pwRwgcAhqDq")).properties.list.exec onComplete {
case Success(t) =>
println(s"Loaded ${t.items}")
case Failure(error) =>
println(s"Cannot load thng properties: ${error}")
}
```

* Create a product _scan_ action `/products/<id>/actions/scans`

```
env.product(Ref("Uk7FRRBwBgsaQpRaRYHQ2Akn")).actions("scans").create(Action()).exec onComplete {
case Success(a) =>
println(s"Created ${a}")
case Failure(error) =>
println(s"Cannot create action: ${error}")
}
```

The _Structured API_ logic is:

* The resource API is accessible using the same methods than the _path elements_ of the resource
* The resource API provides the http methods _CRUD_ operations `create`, `read`, `update` and `delete`.
* Additionally to support the pagination a `list` operation returns a `EvtRequest` to iterate through pages
(see example here below)

### Pagination

When a _GET_ requests on an endpoint returns a Json array. The EVRYTHNG Api limits the number of result and provides
the next page link into the _Link_ http header.

The `list` method of the Structured API provides a `Page` objects which encapsulate both the results and the possible
next page _link_. Simply pass the page to the `nextPage` method on your _Environment_ to get the next results:

```
(for {
page1 <- env.thngs.list.perPage(2).exec
page2 <- env.nextPage(page1).get.exec
} yield (page1, page2)) onComplete { case Success((page1, page2)) =>
println(s"Page one contains ${page1.items}. Page two contains ${page2.items}")
case Failure(error) =>
println(s"Cannot list thngs: ${error}")
}
```

### Using another http client

By default the Evrythng Scala sdk uses the Play WS API as an http clients. It expects the corresponding jar to be available
at runtime.

If you want to use another implementation, inject the implementation class name in the property
`sdk.httpClient`. You can use any other http client as long as it implements
`com.github.jeanadrien.evrythng.scala.rest.HttpRestClient`

E.g. if you want to use the packaged _Apache Http Components_ adapter:

```
$ sbt -Dsdk.httpClient="com.github.jeanadrien.evrythng.scala.httpclient.ApacheHttpClient"
```

### More examples

More examples can be found in the test code.

Also the _Scala REPL_ tool and its completion feature are useful to interact with the Evryhtng API using the sdk:

```console

$ sbt console

```

## Contributing

All suggestions and questions welcome via any channel, including Gitter.
Feature requests to support particular use cases are welcome.

Please use this [code style](evrythng-scala-sdk.xml) file for IntelliJ

## License

[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)

See LICENSE-2.0.txt.

0 comments on commit 74f2224

Please sign in to comment.