diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..243ef34 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing to status-go + +First of all, thank you for taking time to add more value to Status, we really appreciate it! +If you just have a question, open an issue or ask us on our Slack channel: https://slack.status.im/ + +## Starter Links + +TBD + +## Workflow + +1. Pick an [issue](https://github.com/status-go-sdk/status-go/issues) to work on and drop a line there that you're working on that. +2. Wait for an approve from one of core contributors. +3. Fork the project and work right in the `develop` branch. +4. Work on the issue and file a PR back into `develop`. +5. Wait until your PR is [reviewed](https://hackmd.io/s/B1AenvFU-) by 2 core developers and merged. + +## Code Style + +Please, note that we follow [Effective Go](https://golang.org/doc/effective_go.html) and +[CodeReviewComments](https://github.com/golang/go/wiki/CodeReviewComments) in our code. + +You have a quick script for checking styles by running `make lint` + +## Keep history clean + +1. Squash PR before merging. + You can do it either with GitHub API by merging with "Squash and merge" or locally if you want to preserve your signature. + It is ok to merge multiple commits with "Rebase and merge" if they are logically separate. + +2. Preserve as much history as possible. + If you need to re-name file use `git mv` - it will preserve git history. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..688a7b4 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,355 @@ +Mozilla Public License Version 2.0 +================================== + +### 1. Definitions + +**1.1. “Contributor”** + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +**1.2. “Contributor Version”** + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +**1.3. “Contribution”** + means Covered Software of a particular Contributor. + +**1.4. “Covered Software”** + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +**1.5. “Incompatible With Secondary Licenses”** + means + +* **(a)** that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or +* **(b)** that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +**1.6. “Executable Form”** + means any form of the work other than Source Code Form. + +**1.7. “Larger Work”** + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +**1.8. “License”** + means this document. + +**1.9. “Licensable”** + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +**1.10. “Modifications”** + means any of the following: + +* **(a)** any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or +* **(b)** any new file in Source Code Form that contains any Covered + Software. + +**1.11. “Patent Claims” of a Contributor** + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +**1.12. “Secondary License”** + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +**1.13. “Source Code Form”** + means the form of the work preferred for making modifications. + +**1.14. “You” (or “Your”)** + means an individual or a legal entity exercising rights under this + License. For legal entities, “You” includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, “control” means **(a)** the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or **(b)** ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + + +### 2. License Grants and Conditions + +#### 2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +* **(a)** under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and +* **(b)** under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +#### 2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +#### 2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +* **(a)** for any code that a Contributor has removed from Covered Software; + or +* **(b)** for infringements caused by: **(i)** Your and any other third party's + modifications of Covered Software, or **(ii)** the combination of its + Contributions with other software (except as part of its Contributor + Version); or +* **(c)** under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +#### 2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +#### 2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +#### 2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +#### 2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + + +### 3. Responsibilities + +#### 3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +#### 3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +* **(a)** such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +* **(b)** You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +#### 3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +#### 3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +#### 3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + + +### 4. Inability to Comply Due to Statute or Regulation + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: **(a)** comply with +the terms of this License to the maximum extent possible; and **(b)** +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + + +### 5. Termination + +**5.1.** The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated **(a)** provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and **(b)** on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +**5.2.** If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +**5.3.** In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + + +### 6. Disclaimer of Warranty + +> Covered Software is provided under this License on an “as is” +> basis, without warranty of any kind, either expressed, implied, or +> statutory, including, without limitation, warranties that the +> Covered Software is free of defects, merchantable, fit for a +> particular purpose or non-infringing. The entire risk as to the +> quality and performance of the Covered Software is with You. +> Should any Covered Software prove defective in any respect, You +> (not any Contributor) assume the cost of any necessary servicing, +> repair, or correction. This disclaimer of warranty constitutes an +> essential part of this License. No use of any Covered Software is +> authorized under this License except under this disclaimer. + +### 7. Limitation of Liability + +> Under no circumstances and under no legal theory, whether tort +> (including negligence), contract, or otherwise, shall any +> Contributor, or anyone who distributes Covered Software as +> permitted above, be liable to You for any direct, indirect, +> special, incidental, or consequential damages of any character +> including, without limitation, damages for lost profits, loss of +> goodwill, work stoppage, computer failure or malfunction, or any +> and all other commercial damages or losses, even if such party +> shall have been informed of the possibility of such damages. This +> limitation of liability shall not apply to liability for death or +> personal injury resulting from such party's negligence to the +> extent applicable law prohibits such limitation. Some +> jurisdictions do not allow the exclusion or limitation of +> incidental or consequential damages, so this exclusion and +> limitation may not apply to You. + + +### 8. Litigation + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + + +### 9. Miscellaneous + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + + +### 10. Versions of the License + +#### 10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +#### 10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +#### 10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +#### 10.4. Distributing Source Code Form that is Incompatible With Secondary Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +## Exhibit A - Source Code Form License Notice + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +## Exhibit B - “Incompatible With Secondary Licenses” Notice + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md new file mode 100644 index 0000000..89c0c47 --- /dev/null +++ b/README.md @@ -0,0 +1,162 @@ +## status-go-sdk + +*Note about the api stability: this package is under heavy development, and it's not intended for production purposes. Its api may change without previous notice.* + +This package provides an easy way to interact with [status](https://status.im) messaging system. +This package allows you to create applications that interact with the status messaging system + +## Motivation +This library was initially created to have a low-dependency way to interact with status messaging system. + +## Build status + +[![Build Status](https://travis-ci.org/akashnimare/foco.svg?branch=master)](https://travis-ci.org/akashnimare/foco) + +## Features +This project is under heavy development process, here is a list of supported features: + +**Status messaging basic interaction** +- [x] Setup a new connection +- [x] Close a specific connection +- [x] Sign up on the platform +- [x] Login as a specific account +- [ ] Documented API for basic sdk interaction + +**Public channels interaction** +- [x] Join public channels +- [x] Publish messages on public channels +- [x] Subscribe to public channels +- [x] Unsubscribe from a public channel +- [ ] Documented API for public channels interaction +- [x] Working examples for public channel interaction + +**Contact management** +- [ ] Invite new contact +- [ ] Accept a contact request + +**1 to 1 messages interaction** +- [ ] Send 1 to 1 conversation +- [ ] Subscribe to 1 to 1 conversation +- [ ] Unsubscribe from a 1 to 1 conversation +- [ ] Documented API for 1 to 1 conversation +- [ ] Working examples for 1 to 1 conversations + +**Private groups interaction** +- [ ] Publish messages on private groups +- [ ] Subscribe to private groups +- [ ] Unsubscribe from a private groups +- [ ] Documented API for private groups interaction +- [ ] Working examples for private groups interaction + +## Code Example +You'll find some code examples on the [examples folder](/examples) + +## Installation +status-go-sdk is a lightweight dependency package, that means we try to avoid as much external dependencies as possible. You can install it by running: +``` +go get github.com/status-im/status-go-sdk +``` +However, and to run some examples you may also want to install `go-ethereum/rpc` with +``` +go get go get github.com/ethereum/go-ethereum/rpc +``` + +## API Reference +TBD + +## Tests +TBD + +## How to use? +`status-go-sdk` relies on a running instance of `statusd`, we can quickly configure it by [following its official instructions](https://github.com/status-im/status-go#build), but you can use this as a quick-start: + +``` +# Clone status-go +mkdir $GOPATH/src/status-im/ +cd $GOPATH/src/status-im/ +git clone git@github.com:status-im/status-go.git +cd status-go + +# Build it and run it + make statusgo && ./build/bin/statusd -shh=true -standalone=false -http=true -status=http -networkid=1 +``` + +With this you'll have a statusd server running on `8545` port. + +`status-go-sdk` receives as parameter an [RPCClient interface](https://github.com/status-im/status-go-sdk/blob/master/sdk.go#L7), this allows you to use it in many different ways, here we will use a basic example relying on go-ethereum/rpc client. + +``` +package main + +import ( + "fmt" + "log" + "time" + + "github.com/ethereum/go-ethereum/rpc" + "github.com/status-im/status-go-sdk" +) + +func main() { + // Here we create a new remote client against our running statusd + rpcClient, err := rpc.Dial("http://localhost:8545") + checkErr(err) + remoteClient := &remoteClient{rpcClient} + + // Setting up a new sdk client + client := sdk.New(remoteClient) + + // We signup and login as a new account + a, err := client.SignupAndLogin("password") + checkErr(err) + + // Joining a new channel + ch, err := a.JoinPublicChannel("my_channel") + checkErr(err) + + // We will be sending messages to that channel every 3 seconds + for range time.Tick(3 * time.Second) { + message := fmt.Sprintf("PING : %d", time.Now().Unix()) + _ = ch.Publish(message) + } +} + +// This is the remote client we will use to +type remoteClient struct { + c *rpc.Client +} + +func (rc *remoteClient) Call(req *sdk.Request, res interface{}) error { + return rc.c.Call(res, req.Method, req.Params) +} + +func checkErr(err error) { + if err != nil { + log.Fatal(err) + } +} +``` + +If you want to subscribe to this same channel you could easily do it with `Subscribe` method like: +``` +_, _ = ch.Subscribe(func(m *sdk.Msg) { + log.Println("Message from ", m.From, " with body: ", m.Raw) + + if strings.Contains(m.Raw, "PING :") { + time.Sleep(5 * time.Second) + message := fmt.Sprintf("PONG : %d", time.Now().Unix()) + _ = ch.Publish(message) + } +}) + +runtime.Goexit() +``` + +Please have a look at [examples](examples) folder for some working examples + +## Contribute + +Please check the [contributing guideline](CONTRIBUTING.md). + +## License +[Mozilla Public License 2.0](https://github.com/status-im/status-go/blob/develop/LICENSE.md) diff --git a/examples/mitsuku/main.go b/examples/mitsuku/main.go new file mode 100644 index 0000000..9b4d38f --- /dev/null +++ b/examples/mitsuku/main.go @@ -0,0 +1,77 @@ +// This package provides an easy example of a conversational chatbot integrated +// with rest version of mitsuku (https://www.pandorabots.com/mitsuku/), a +// three-time winner of the Loebner Prize Turing Test. +package main + +import ( + "io/ioutil" + "log" + "net/http" + "net/url" + "runtime" + "strings" + + "github.com/ethereum/go-ethereum/rpc" + sdk "github.com/status-im/status-go-sdk" +) + +type remoteClient struct { + c *rpc.Client +} + +func (rc *remoteClient) Call(req *sdk.Request, res interface{}) error { + return rc.c.Call(res, req.Method, req.Params) +} + +func checkErr(err error) { + if err != nil { + log.Fatal(err) + } +} + +func main() { + pwd := "password" + + rpcClient, err := rpc.Dial("http://localhost:8545") + checkErr(err) + + remoteClient := &remoteClient{rpcClient} + client := sdk.New(remoteClient) + + a, err := client.SignupAndLogin(pwd) + + ch, err := a.JoinPublicChannel("mitsuku") + checkErr(err) + + _, _ = ch.Subscribe(func(m *sdk.Msg) { + if m.Type != sdk.StandardMessageType { + return + } + if a.PubKey == m.PubKey { + return + } + properties := m.Properties.(*sdk.PublishMsg) + + // Print the response. + ch.Publish(askMitsuku(properties.Text)) + + }) + runtime.Goexit() +} + +func askMitsuku(question string) string { + hc := http.Client{} + uri := "https://kakko.pandorabots.com/pandora/talk?botid=87437a824e345a0d&skin=chat" + form := url.Values{} + form.Add("message", question) + req, _ := http.NewRequest("POST", uri, strings.NewReader(form.Encode())) + req.Header.Add("Content-Type", "application/x-www-form-urlencoded") + + resp, _ := hc.Do(req) + body, _ := ioutil.ReadAll(resp.Body) + + parts := strings.Split(string(body), "") + parts = strings.Split(parts[2], "
") + + return strings.Trim(parts[0], " ") +}