shapeshift_io 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 354fe2260b9451312bb0359b9307ba905e964532
+  data.tar.gz: eb0b1ece969e49d46034512b7992342968bc9fb4
+SHA512:
+  metadata.gz: b2dcf911084b41d4a34a459298d61c3c9949eb0b4754cab7a4fec2ae7ad5ab3e5042cc9e4b03afed5c9efc302f0e90e9569929ce9a5d94f3e851f5ed8c933f69
+  data.tar.gz: c0a7695205588f20c743f70201b783b8bc8c96f6ebb2ba69efff0eb5e552ddc868b91e68a1329931af5a60c17ec786afb4c2bd0afea1f6c21da919dc6a44cd2c

data/.gitignore

@@ -0,0 +1,14 @@
+.DS_Store
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in shapeshift_io.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Romanos Fessas
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,42 @@
+# DISCLAIMER: Test before use
+I have not tested many of these endpoints given my own limited requirements. If you are making real exchanges, especially with more exotic coins, please test this implementation thoroughly.
+
+# Ruby implementation of the Shapeshift.io public API
+
+- Unofficial implementation
+- Implements public REST API
+- Full docs at [https://info.shapeshift.io/api](https://info.shapeshift.io/api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+`gem 'shapeshift_io'`
+
+And then execute:
+
+`$ bundle`
+
+Or install it yourself as:
+
+`$ gem install shapeshift_io`
+
+## Usage
+
+_Extended examples available at [Shapeshift.io](https://info.shapeshift.io/api)_
+
+```
+client = Shapeshift::Client.new
+client.market_info('BTC_ETH')
+```
+
+### Contributing
+- Fork it ( https://github.com/romanos/shapeshift-io/fork )
+- Create your feature branch (`git checkout -b my-new-feature`)
+- Commit your changes (`git commit -am 'Add some feature'`)
+- Push to the branch (`git push origin my-new-feature`)
+- Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "shapeshift_io"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/shapeshift/client.rb

@@ -0,0 +1,14 @@
+module Shapeshift
+  class Client 
+    include HTTParty
+    base_uri "https://shapeshift.io"
+
+    include Shapeshift::Connection
+    include Shapeshift::MarketClient
+
+    def initialize( headers = {} )
+      @headers = {}
+    end
+
+  end
+end

data/lib/shapeshift/connections.rb

@@ -0,0 +1,27 @@
+module Shapeshift
+  # Network Layer for API Rest client
+  module Connection
+    private
+
+    def merge_headers(input = {})
+      {
+        'Content-Type'  => 'application/json',
+        'Accept'        => 'application/json'
+      }.merge( input )
+    end
+
+    # Make an HTTP GET request
+    def get( url, options = {} )
+      headers = merge_headers( options[:headers] || {} )
+      resp = self.class.get( url, { headers: headers } )
+    end
+
+    # Make an HTTP POST request
+    def post( url, options = {} )
+      headers = merge_headers( options[:headers] || {} )
+      body = options[:body]
+      resp = self.class.get( url, { body: body.to_json, headers: headers } )
+    end
+
+  end
+end

data/lib/shapeshift/errors.rb

@@ -0,0 +1,6 @@
+module Shapeshift
+  
+  class HTTPError < StandardError; end
+  class NoDemandError < StandardError; end
+
+end

data/lib/shapeshift/market.rb

@@ -0,0 +1,96 @@
+module Shapeshift
+  # Network Layer for API Rest client
+  module MarketClient
+    # url: shapeshift.io/rate/[pair]
+    # method: GET
+    # [pair] is any valid coin pair such as btc_ltc or ltc_btc
+    def rate( pair )
+      get("/rate/#{pair}")
+    end
+
+    # url: shapeshift.io/limit/[pair]
+    # method: GET
+    # [pair] is any valid coin pair such as btc_ltc or ltc_btc
+    def limit( pair )
+      get("/limit/#{pair}")
+    end
+ 
+    # url: shapeshift.io/marketinfo/[pair]
+    # method: GET     
+    # [pair] (OPTIONAL) is any valid coin pair such as btc_ltc or ltc_btc.
+    # The pair is not required and if not specified will return an array of all market infos.
+    def market_info( pair = nil )
+      get("/marketinfo/#{pair}")
+    end
+
+    # url: shapeshift.io/recenttx/[max]
+    # method: GET 
+    # [max] is an optional maximum number of transactions to return.
+    # If [max] is not specified this will return 5 transactions.
+    # Also, [max] must be a number between 1 and 50 (inclusive).
+    def recent_tx( max = 5 )
+      # max = max.clamp( 1, 50 )  # Clamp only available in Ruby 2.4+
+      max = [ 1, max, 50 ].sort[1]
+      get("/recenttx/#{max}")
+    end
+
+    # url: shapeshift.io/txStat/[address]
+    # method: GET
+    # [address] is the deposit address to look up.
+    def tx_stat( address )
+      get("/txStat/#{address}")
+    end
+
+    # url: shapeshift.io/timeremaining/[address]
+    # method: GET
+    # [address] is the deposit address to look up.
+    def time_remaining( address )
+      address = encode( address )
+      get("/timeremaining/#{address}")
+    end
+
+    # url: shapeshift.io/getcoins
+    # method: GET
+    def get_coins
+      get("/getcoins")
+    end
+
+    # url: shapeshift.io/txbyapikey/[apiKey]
+    # method: GET
+    # [apiKey] is the affiliate's PRIVATE api key.
+    def tx_by_apikey( api_key )
+      get("/txbyapikey/#{api_key}")
+    end
+
+    # url: shapeshift.io/txbyaddress/[address]/[apiKey]
+    # method: GET
+    # [address] the address that output coin was sent to for the shift
+    # [apiKey] is the affiliate's PRIVATE api key.
+    def tx_by_address( address, api_key )
+      address = encode( address )
+      get("/txbyaddress/#{address}/#{api_key}")
+    end
+
+    # url: shapeshift.io/validateAddress/[address]/[coinSymbol]
+    # method: GET
+    # [address] the address that the user wishes to validate
+    # [coinSymbol] the currency symbol of the coin
+    def validate_address( address, symbol )
+      get("/validateAddress/#{address}/#{symbol}")
+    end
+
+
+    private
+
+      # Please note that if the address is a ripple address, 
+      # it will include the "?dt=destTagNUM" appended on the end, 
+      # and you will need to use the URIEncodeComponent() function on 
+      # the address before sending it in as a param, to get a successful response.
+      def encode( address )
+        address = URI.encode_www_form_component( address ) if address =~ /\?dt\=/i
+        return address
+      end
+      
+
+  end
+end

data/lib/shapeshift/transactions.rb

@@ -0,0 +1,110 @@
+module Shapeshift
+  # Network Layer for API Rest client
+  module TransactionClient
+
+    # url:  shapeshift.io/shift
+    # method: POST
+    # data type: JSON
+    # data required:
+    # withdrawal     = the address for resulting coin to be sent to
+    # pair       = what coins are being exchanged in the form [input coin]_[output coin]  ie btc_ltc
+    # 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, you supply this on NXT payment to you
+    # apiKey     = (Optional) Your affiliate PUBLIC KEY, for volume tracking, affiliate payments, split-shifts, etc...     
+    # Success Output:
+    #     {
+    #         deposit: [Deposit Address (or memo field if input coin is BTS / BITUSD)],
+    #         depositType: [Deposit Type (input coin symbol)],
+    #         withdrawal: [Withdrawal Address], //-- will match address submitted in post
+    #         withdrawalType: [Withdrawal Type (output coin symbol)],
+    #         public: [NXT RS-Address pubkey (if input coin is NXT)],
+    #         xrpDestTag : [xrpDestTag (if input coin is XRP)],
+    #         apiPubKey: [public API attached to this shift, if one was given]
+    #     }  
+    def shift( withdrawal, pair, opts = {} )
+      body = { withdrawal: withdrawal, pair: pair }
+      body.merge!( opts )
+      post("/shift", { body: body } )
+    end
+
+    # url:  shapeshift.io/mail
+    # method: POST
+    # data type: JSON
+    # data required:
+    # 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"}
+    def mail( email, txid )
+      body = { email: email, txid: txid }
+      post("/mail", { body: body } )
+    end
+
+    # url: shapeshift.io/sendamount
+    # method: POST
+    # data type: JSON
+
+    # 1. Send amount request
+    #
+    # Data required:
+    # 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]  ie ltc_btc
+    # 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, for volume tracking, affiliate payments, split-shifts, etc...
+    # {
+    #      success:
+    #       {
+    #         pair: [pair],
+    #         withdrawal: [Withdrawal Address], //-- will match address submitted in post
+    #         withdrawalAmount: [Withdrawal Amount], // Amount of the output coin you will receive
+    #         deposit: [Deposit Address (or memo field if input coin is BTS / BITUSD)],
+    #         depositAmount: [Deposit Amount], // Exact amount of input coin to send in
+    #         expiration: [timestamp when this will expire],
+    #         quotedRate: [the exchange rate to be honored]
+    #         apiPubKey: [public API attached to this shift, if one was given]
+    #       }
+    # }
+    def send_amount( withdrawal, pair, amount, opts = {} )
+      body = { withdrawal: withdrawal, pair: pair, amount: amount }
+      body.merge!( opts )
+      post("/sendamount", { body: body })
+    end
+
+    # 2. Quoted Price request
+    # 
+    # Note :  This request will only return information about a quoted rate
+    #         This request will NOT generate the deposit address.
+    #   Data required:
+    # amount  = the amount to be sent to the withdrawal address
+    # pair    = what coins are being exchanged in the form [input coin]_[output coin]  ie ltc_btc
+    # {
+    #      success:
+    #       {
+    #         pair: [pair],
+    #         withdrawalAmount: [Withdrawal Amount], // Amount of the output coin you will receive
+    #         depositAmount: [Deposit Amount], // Exact amount of input coin to send in
+    #         expiration: [timestamp when this will expire],
+    #         quotedRate: [the exchange rate to be honored]
+    #         minerFee: [miner fee for this transaction]
+    #       }
+    # }
+    def quote_price( pair, amount )
+      body = { pair: pair, amount: amount }
+      post("/sendamount", { body: body })
+    end
+
+
+    # url: shapeshift.io/cancelpending
+    # method: POST
+    # data type: JSON
+    # data required: address  = The deposit address associated with the pending transaction
+    def cancel( address )
+      body = { address: address }
+      post("/cancelpending", { body: body } )
+    end
+
+  end
+end

data/lib/shapeshift/version.rb

@@ -0,0 +1,3 @@
+module Shapeshift
+  VERSION = "0.0.1"
+end

data/lib/shapeshift.rb

@@ -0,0 +1,12 @@
+require 'uri'
+require 'json'
+require 'yaml'
+
+require 'httparty'
+
+require 'shapeshift/version'
+require 'shapeshift/errors'
+require 'shapeshift/connections'
+require 'shapeshift/market'
+require 'shapeshift/transactions'
+require 'shapeshift/client'

data/lib/shapeshift_io.rb

@@ -0,0 +1 @@
+require "shapeshift"

data/shapeshift_io.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "shapeshift/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "shapeshift_io"
+  spec.version       = Shapeshift::VERSION
+  spec.authors       = ["Romanos Fessas"]
+  spec.email         = ["romanos@fessas.com"]
+
+  spec.summary       = %q{Shapeshift IO API Wrapper}
+  spec.description   = %q{Simple Shapeshift API ruby wrapper}
+  spec.homepage      = 'https://github.com/romanos/shapeshift-io'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency 'httparty', '>= 0.13'
+  
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: shapeshift_io
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Romanos Fessas
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+description: Simple Shapeshift API ruby wrapper
+email:
+- romanos@fessas.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/shapeshift.rb
+- lib/shapeshift/client.rb
+- lib/shapeshift/connections.rb
+- lib/shapeshift/errors.rb
+- lib/shapeshift/market.rb
+- lib/shapeshift/transactions.rb
+- lib/shapeshift/version.rb
+- lib/shapeshift_io.rb
+- shapeshift_io.gemspec
+homepage: https://github.com/romanos/shapeshift-io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Shapeshift IO API Wrapper
+test_files: []