Skip to content

Commit

Permalink
[skyapi] refs fibercrypto#5 Added travis, Readme and Changelog
Browse files Browse the repository at this point in the history
Set travis to test skycoin wrapper
Updated README and Changelog for v0.25.1 release
Update contact email
  • Loading branch information
stdevMac committed Mar 20, 2019
1 parent 44fd09d commit 5f4c6bd
Show file tree
Hide file tree
Showing 62 changed files with 406 additions and 54 deletions.
5 changes: 5 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
lang: ruby

script: ./travis/skyapi.sh

rvm: 2.1
18 changes: 18 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## LibSkycoin-Ruby 0.25.1 - 2019/03/19

### Added

- Add `skyapi`, a wrapper for Skycoin api in version 0.25.1

### Fixed

- Fix #5 - Ruby API wrapper for the Skycoin node API


30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
## Skyapi, a Wrapper for Skycoin Api

This wrapper is Auto generated by openapi-generator directly from `Skycoin Api` code for version v0.25.1.

For further details of usage of `Skyapi wrapper for Skycoin Api` see [Autogenerated documentation](./lib/skyapi/README.md)

### Specific Node Address

For use a specific node of Skycoin, you just need to create a instance of `ApiClient` passing the node address:

```ruby
# Load the gem
require 'sky_api'

config =
api_instance = SkyApi::DefaultApi.new
# Set prefered host
api_instance.api_client.config.host = 'some_host'

begin
#Returns the total number of unique address that have coins.
result = api_instance.address_count
p result
rescue SkyApi::ApiError => e
puts "Exception when calling DefaultApi->address_count: #{e}"
end

```

Then in `skyapi` you can use all methods related to Api Client.
6 changes: 6 additions & 0 deletions lib/skyapi/.idea/inspectionProfiles/Project_Default.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 4 additions & 0 deletions lib/skyapi/.idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

8 changes: 8 additions & 0 deletions lib/skyapi/.idea/modules.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions lib/skyapi/.idea/skyapi.iml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

264 changes: 264 additions & 0 deletions lib/skyapi/.idea/workspace.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion lib/skyapi/lib/sky_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#Skycoin is a next-generation cryptocurrency.
OpenAPI spec version: 0.25.1
Contact: skycoin.[email protected]
Contact: contact@skycoin.net
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 3.3.4
Expand Down
2 changes: 1 addition & 1 deletion lib/skyapi/lib/sky_api/api/default_api.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#Skycoin is a next-generation cryptocurrency.
OpenAPI spec version: 0.25.1
Contact: skycoin.[email protected]
Contact: contact@skycoin.net
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 3.3.4
Expand Down
2 changes: 1 addition & 1 deletion lib/skyapi/lib/sky_api/api_client.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#Skycoin is a next-generation cryptocurrency.
OpenAPI spec version: 0.25.1
Contact: skycoin.[email protected]
Contact: contact@skycoin.net
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 3.3.4
Expand Down
2 changes: 1 addition & 1 deletion lib/skyapi/lib/sky_api/api_error.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#Skycoin is a next-generation cryptocurrency.
OpenAPI spec version: 0.25.1
Contact: skycoin.[email protected]
Contact: contact@skycoin.net
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 3.3.4
Expand Down
Loading

0 comments on commit 5f4c6bd

Please sign in to comment.