kucoin_ruby 0.1.2 → 0.1.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +22 -0
  3. data/Gemfile.lock +1 -1
  4. data/README.md +71 -4
  5. data/lib/kucoin_ruby/version.rb +1 -1
  6. metadata +3 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: ba8140ccb8633dc2dff5dcd614711a9027835458
4
- data.tar.gz: 6f235e978533519a0ce639291e0a63ba7dbb39a3
3
+ metadata.gz: 7093c1d401923d5deeb7111db6667a17477cd6d5
4
+ data.tar.gz: d800824977fbe1a591cc3b2cfb482c05ecfe0932
5
5
  SHA512:
6
- metadata.gz: 762756f1aa6c87695cc02a6522d7a5c5297422cc3b346c93862dffdb06ca59657ee3b78e221cc0f99149c5eb7b12c340355a60d11e54295d245085bc0ab8a981
7
- data.tar.gz: f5117a46c123fd978380c47815fcd54685684287b2e0a18a1cfdf9e19cf1b1491678cac0d0e7c3a4a3ec3ea3ed68eef0d93cc766a1e3be5ee26ad6e728b0be2a
6
+ metadata.gz: c2d9b1e2c16be588a59cae9535d56b3cfd4797f72bca4f6f4e8f05d43eb40e3481d0b6090d7d6cb42f724853a19cd74c892c099ec0323bc876e1060f0c8df4bd
7
+ data.tar.gz: 950f3bf435e53e8ca7960ac9d97c52272ddda5de9b773742627cfd1fdd13d642f646e7ce219dead23e08408aa02620a482b7edf3ac9b12d4d553f816d8c07ccb
data/CHANGELOG.md ADDED
@@ -0,0 +1,22 @@
1
+ ## 0.1.3
2
+
3
+ ### Changed
4
+
5
+ - Add CHANGELOG.md
6
+ - Improve README
7
+
8
+ ## 0.1.2
9
+
10
+ ### Changed
11
+
12
+ - Enabled rubygems
13
+
14
+ ## 0.1.1
15
+
16
+ ### Changed
17
+
18
+ - Add missing gemset information
19
+
20
+ ## 0.1.0
21
+
22
+ - Initial commit
data/Gemfile.lock CHANGED
@@ -1,7 +1,7 @@
1
1
  PATH
2
2
  remote: .
3
3
  specs:
4
- kucoin_ruby (0.1.2)
4
+ kucoin_ruby (0.1.3)
5
5
  httparty
6
6
 
7
7
  GEM
data/README.md CHANGED
@@ -16,22 +16,89 @@ are not working correctly yet
16
16
  Add gem to your Gemfile
17
17
  `gem 'kucoin_ruby'`
18
18
 
19
- Define your KuCoin API credentials as ENV vars of your project:
19
+ Some of API endpoints are open, like exchange or market information.
20
+ No credentials are required to use them, but if you want to use private endpoints
21
+ you will need to define your KuCoin **API credentials** as ENV vars of your project:
20
22
 
21
23
  ```
22
24
  KUCOIN_KEY=YOUR_KEY
23
25
  KUCOIN_SECRET=YOUR_SECRET
24
26
  ```
25
27
 
26
- ### Usage
28
+ ## Usage
27
29
 
28
30
  All Kucoin methods are class methods, just call it with expected parameters
29
31
 
32
+ ### Currency
33
+
34
+ ```ruby
35
+ KucoinRuby::Currency.exanges
36
+ ```
37
+
38
+ ### Language
39
+
40
+ ```ruby
41
+ KucoinRuby::Language.lang_list
42
+ KucoinRuby::Language.change_lang 'en_US' # Not working as expected
43
+ ```
44
+
45
+ ### User
46
+
30
47
  ```ruby
31
- Kucoin::Currency.exanges
48
+ KucoinRuby::User.user_info
32
49
  ```
33
50
 
34
- WIP
51
+ ### Inviting
52
+
53
+ ```ruby
54
+ KucoinRuby::Invinting.invitation_count
55
+ KucoinRuby::Invinting.promotion_reward
56
+ KucoinRuby::Invinting.promotion_summary
57
+ ```
58
+
59
+ ### Operations
60
+
61
+ COIN: "BTC", "ETH", "NEO"...
62
+
63
+ ```ruby
64
+ KucoinRuby::Operations.get_coin_address(<COIN>)
65
+ KucoinRuby::Operations.create_withdrawal(<COIN>, <AMOUNT>, <ADDRESS>) # Not working as expected
66
+ KucoinRuby::Operations.cancel_withdrawal(<COIN>, <OP_ID>) # Not working as expected
67
+ KucoinRuby::Operations.wallet_records(<COIN>, <TYPE>, <STATUS>, <LIMIT>, <PAGE>) # Not working as expected
68
+ KucoinRuby::Operations.coin_balance(<COIN>)
69
+ KucoinRuby::Operations.balance
70
+ ```
71
+
72
+ ### Trading
73
+
74
+ Symbol: "ETH-BTC", "BTC-ETH", "GVT-BTC"...
75
+
76
+ ```ruby
77
+ KucoinRuby::Trading.create_order(<SYMBOL>, <TYPE>, <PRICE>, <AMOUNT>) # Not tested yet
78
+ KucoinRuby::Trading.active_orders(<SYMBOL>)
79
+ KucoinRuby::Trading.cancel_order(<SYMBOL>, <ORDER_ID>, <TYPE>) # Not tested yet
80
+ KucoinRuby::Trading.dealt_orders(<SYMBOL>, <TYPE>, <LIMIT>, <PAGE>, <SINCE>, <BEFORE>)
81
+ KucoinRuby::Trading.symbol_dealt_order(<SYMBOL>, <TYPE>, <LIMIT>, <PAGE>)
82
+ ```
83
+
84
+ ### Market
85
+
86
+ ```ruby
87
+ KucoinRuby::Market.tick(<SYMBOL>)
88
+ KucoinRuby::Market.orders(<SYMBOL>)
89
+ KucoinRuby::Market.buy_orders(<SYMBOL>, <GROUP>, <LIMIT>)
90
+ KucoinRuby::Market.sell_orders(<SYMBOL>, <GROUP>, <LIMIT>)
91
+ KucoinRuby::Market.recent_deal_orders(<SYMBOL>, <LIMIT>, <SINCE>)
92
+ KucoinRuby::Market.trading_symbols
93
+ KucoinRuby::Market.trending_symbols
94
+ KucoinRuby::Market.kline_data(<SYMBOL>, <TYPE>, <FROM>, <TO>, <LIMIT>)
95
+ KucoinRuby::Market.kline_config
96
+ KucoinRuby::Market.chart_symbol(<SYMBOL>)
97
+ KucoinRuby::Market.history_kline_data(<SYMBOL>, <RESOLUTION>, <FROM>, <TO>)
98
+ KucoinRuby::Market.coin_info(<COIN>)
99
+ KucoinRuby::Market.coins
100
+
101
+ ```
35
102
 
36
103
  ## Donations
37
104
 
data/lib/kucoin_ruby/version.rb CHANGED
@@ -1,3 +1,3 @@
1
1
  module KucoinRuby
2
- VERSION = "0.1.2"
2
+ VERSION = "0.1.3"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: kucoin_ruby
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.2
4
+ version: 0.1.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - lalo
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2017-12-05 00:00:00.000000000 Z
11
+ date: 2017-12-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -88,6 +88,7 @@ extensions: []
88
88
  extra_rdoc_files: []
89
89
  files:
90
90
  - ".gitignore"
91
+ - CHANGELOG.md
91
92
  - CODE_OF_CONDUCT.md
92
93
  - Gemfile
93
94
  - Gemfile.lock