shapeshiftio 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8521419ac9cc63ddc3966299a099a8b224e97ac
-  data.tar.gz: 0e9cb73787dac20e96e55a7943dcaea502e23712
+  metadata.gz: 7b62b2c2299505f6afc19972515c0815ae04a575
+  data.tar.gz: 8f16403ea3b4014c420fe1e114f5235f80a412af
 SHA512:
-  metadata.gz: d166c033b47a05ed8e0baaba6ffc8eff970ce61bd0901ce7d4c9c0012c3aa9b2520b8db59625bc2e1fbca58ca5c1daab690a5dc5d2a94d3c7d67bbcad09a4944
-  data.tar.gz: 73eecafd1eaeed6c20d6cadf0c92c80c7b896f9bfa7cf1ad876c56464544084cdb6837f675a2edd54a3177f8eb935fbe11d3e2f71aa0bd0603bbadf4e31c2780
+  metadata.gz: 27ff68cd37d4e8215b1fbcc4d349db05c8e3f93c580d6e63fe3ad710798ae764260488cb837d86d3ab10fa67bb0976ab4db96e83831ddb6b13cfac8de020f485
+  data.tar.gz: fe2daff0ba4698a62664c1032655f7bbebc0d108390be0fc6c34d13164be265948db4faa1bb1d59ddc05fca7142440d44d65987bdb2bcf385534c7fd72b3f1ca

data/README.md

@@ -1,15 +1,13 @@
-# Shapeshift
+# Shapeshiftio
+A complete ruby wrapper for shapeshift.io API
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/shapeshift`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Refactor and make code base more DRY
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'shapeshift'
+gem 'shapeshiftio'
 ```
 
 And then execute:
@@ -18,21 +16,88 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install shapeshift
+    $ gem install shapeshiftio
 
 ## Usage
+..* All methods return a JSON object with the fields detailed at the [shapeshift's official website](https://info.shapeshift.io/api)
+..* To call a method you only need the __required fields__, if you want to pass more parameters, just add a hash when callind a method (examples below)
+
+# GET requests:
+
+List available coins in the shapeshift API:
+
+    Shapeshiftio.get_coins
+
+Gets the current deposit limit set by Shapeshift for a specific pair:
+
+    Shapeshiftio.limit("doge_dgb")
+
+Market info of a specific pair:
+
+    Shapeshiftio.market_info("doge_dgb")
+    
+Gets the current rate offered by Shapeshift:
+
+    Shapeshiftio.rate("btc_eth")
+
+Get a list of the most recent transactions:
+
+    Shapeshiftio.recent_tx(max)  #[max] is an optional maximum number of transactions to return.
+
+Returns the status of the most recent deposit transaction to the address:
+
+    Shapeshiftio.tx_stat(deposit_address) #[address] is the deposit address to look up.
+
+Time Remaining on Fixed Amount Transaction:
+
+    Shapeshiftio.time_remaining(deposit_address) #[address] is the deposit address to look up. 
+
+Validate an address, given a currency symbol and address.
+
+    Shapeshiftio.validate(address,coin_symbol) #[address] the address that the user wishes to validate, [coinSymbol] the currency symbol of the coin
+
+# POST requests
+
+# Normal Transaction (convert coin):
+
+withdrawal     = the address for resulting coin to be sent to
+pair       = what coins are being exchanged in the form [input coin]_[output coin]  
+returnAddress  = (Optional) address to return deposit to if anything goes wrong with the exchange
+destTag    = (Optional) Destination tag that you want appended to a Ripple payment to you
+rsAddress  = (Optional) For new NXT accounts to be funded, you supply this on NXT payment to you
+apiKey     = (Optional) Your affiliate PUBLIC KEY
+ 
+example data: {"withdrawal":"AAAAAAAAAAAAA", "pair":"btc_ltc", returnAddress:"BBBBBBBBBBB"}
+
+    Shapeshiftio.shift("AAAAAAAAAAAAA","btc_ltc",options = {"returnAddress" : "BBBBBBBBBBB"})
+    Shapeshiftio.shift("RIPPLE ADDRESS","ltc_xrp",options = {"returnAddres" : "RIPPLE ADDRESS", "destTag" : "RIPPLE ADDRESS TAG"})
+
+# Request Email Receipt
+email    = the address for receipt email to be sent to
+txid       = the transaction id of the transaction TO the user (ie the txid for the withdrawal NOT the deposit)
+example data {"email":"mail@example.com", "txid":"123ABC"}
 
-TODO: Use cases and example code coming soon.
+    Shapeshiftio.receipt("mail@example.com","123ABC")
+    
+# Fixed Amount Transaction / Quote Send Exact Price
+amount          = the amount to be sent to the withdrawal address
+withdrawal      = the address for coin to be sent to
+pair            = what coins are being exchanged in the form [input coin]_[output coin]
+returnAddress   = (Optional) address to return deposit to if anything goes wrong with exchange
+destTag         = (Optional) Destination tag that you want appended to a Ripple payment to you
+rsAddress       = (Optional) For new NXT accounts to be funded, supply this on NXT payment to you
+apiKey          = (Optional) Your affiliate PUBLIC KEY
 
-## Development
+    Shapeshiftio.fixed(amount, wallet_address, coin_pair, options = {})
+    Shapeshiftio.quote(amount, coin_pair)
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+# Cancel Pending Transaction
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+    Shapeshiftio.cancel(deposit_address)
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/atjohnson/shapeshift.
+Bug reports and pull requests are welcome on GitHub.
 
 
 ## License

data/lib/shapeshiftio/version.rb

@@ -1,3 +1,3 @@
 module Shapeshiftio
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/shapeshiftio.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ricardo Malafaia"]
   spec.email         = ["ricardo.malafaia1994@gmail.com"]
 
-  spec.summary       = %q{A complete Ruby wrapper for the shapeshift.io API.}
+  spec.summary       = %q{A complete functional Ruby wrapper for the shapeshift.io API.}
   spec.description   = %q{}
   spec.homepage      = "https://github.com/rbm4/shapeshiftio"
   spec.license       = "MIT"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shapeshiftio
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ricardo Malafaia
@@ -78,5 +78,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: A complete Ruby wrapper for the shapeshift.io API.
+summary: A complete functional Ruby wrapper for the shapeshift.io API.
 test_files: []