bitex 0.2.2 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1227db3393d7ebd0e58012b2681595b4bcb503b6
-  data.tar.gz: 34d7bfca10d7bc61f828ffa9fca9f16eda3bcac3
+  metadata.gz: c0f409f2edf134480559d42b2a79d57a09d4fefa
+  data.tar.gz: 198bf2f788ea24c148c947e5f01d2c17d96747e8
 SHA512:
-  metadata.gz: f24e2d0d0780b94d252fdba0a5ea9ab8bf548d27d8a25bc716a83d652f4ca277d8a3614bde9bf97f10d81d0e902b1be6d7c2ae5519f07c88ea7c59083a54dc5d
-  data.tar.gz: d06fee68bf940dc454973e54b98074866b6192b83fc361af27d29d6e4827a2ea06216dce75a09f65bb4a408e81caa472c9a03579f42c3a410c101747b8cab42e
+  metadata.gz: 85597c781f7eb8ef612dca37f546593ad453d8ebb507e3b2f7a6e63196c4cc9fdbf17eba2ac4cc76c3d400ba843956ff3e01557c9b869b24b052ae1ab4dd674c
+  data.tar.gz: 9fb13004f9956c6a4b449d3e844e43cd6c001d5e2a7c24c944186cbeb897689432814263c9fab0cda314da5dde75a85581e64d9fd232d1aad862860572a75a91

data/README.md

@@ -40,6 +40,19 @@ fetching all public market data available.
     ruby > Bitex::BitcoinMarketData.transactions
     => [[1404501180, 1335, 632.0, 0.95], [1404501159, 1334, 632.0, 0.95], ...]
 
+## Exchange Rates 
+
+Learn more here: [https://sandbox.bitex.la/developers#rates](Rates docs)
+
+
+From 1000 ARS in CASH to USD in my BITEX balance, via MORE_MT
+
+    ruby > Bitex::Rates.calculate_path(1000, [:ars, :cash, :usd, :bitex, :more_mt])
+
+How many ARS in CASH should I deposit via MORE_MT to get 50 USD in BITEX?
+
+    ruby > Bitex::Rates.calculate_path_backwards([:ars, :cash, :usd, :bitex, :more_mt], 50)
+
 ## Use for Private Trading
 
 ### Authentication
@@ -71,6 +84,37 @@ on that page. Once done you can start using it as follows:
 
     ruby > Bitex::Transaction.all
 
+# Payments
+
+Check the [https://sandbox.bitex.la/developers#payments-overview](Payaments Developer Docs)
+to learn more about payment processing with Bitex
+
+### Create a new payment for 4 USD in Bitcoin
+
+    ruby > Bitex::Payment.create!(
+      currency_id: 3,
+      amount: 4,
+      callback_url: "https://example.com/ipn",
+      keep: 25.0,
+      customer_reference: "An Alto latte, no sugar",
+      merchant_reference: "invoice#1234")
+
+### List all your payments
+
+    ruby > Bitex::Payment.all
+
+### Validate and deserialize payments from callbacks.
+
+    ruby > Bitex::Payment.from_callback(the_callback_json)
+
+###  Setup your Web Point of Sale
+  
+    ruby > Bitex::Payment.pos_setup!(
+      merchant_name: "Tierra Buena",
+      merchant_slug: "tierrabuena",
+      merchant_logo: "https://t.co/logo.png",
+      merchant_keep: 0)
+
 ## Sandbox
 
 Bitex.la has a sandbox environment available at https://sandbox.bitex.la, you

data/lib/bitex/rates.rb

@@ -1,11 +1,71 @@
 module Bitex
-  # Exchange rates for cash in and cash out
+  # Exchange Rates Tree.
+  # Example calculation for turning 1000 ARS in cash to USD credited
+  # to your bitex balance using more_mt as the funding option.
+  #     Bitex::Rates.calculate(1000, [:ars, :cash, :usd, :bitex, :more_mt])
+  # Also available backwards: How many ARS should I deposit using more_mt
+  # to end up with 200 USD in my bitex balance?
+  #     Bitex::Rates.calculate_back([:ars, :cash, :usd, :bitex, :more_mt], 200)
+  # @see https://bitex.la/developers#rates
   class Rates
-    # The rates tree conveniently formatted as a ruby Hash with
-    # symbolized keys.
-    # @see https://bitex.la/developers#rates
-    def self.all
-      Api.private(:get, "/private/rates").deep_symbolize_keys
+
+    # Full exchange rates tree, gets cached locally for 60 seconds.
+    def self.tree
+      if @tree.nil? || @last_tree_fetch.to_i < (Time.now.to_i - 60)
+        @tree = Api.public("/rates/tree").deep_symbolize_keys
+        @last_tree_fetch = Time.now.to_i
+      end
+      @tree
+    end
+    
+    def self.clear_tree_cache
+      @tree = nil 
+      @last_tree_fetch = nil
+    end
+
+    def self.calculate_path(value, path)
+      value = value.to_d
+      path_to_calculator(path).each do |step|
+        case step[:type].to_sym
+        when :exchange
+          value *= step[:rate].to_d
+        when :percentual_fee
+          value *= 1 - (step[:percentage].to_d / 100.to_d)
+        when :fixed_fee
+          value -= step[:amount].to_d
+        when :minimum_fee
+          value -= [step[:minimum].to_d, value * step[:percentage].to_d / 100.to_d].max
+        end
+      end
+      value
+    end
+    
+    def self.calculate_path_backwards(path, value)
+      value = value.to_d
+      path_to_calculator(path).each do |step|
+        case step[:type].to_sym
+        when :exchange
+          value /= step[:rate].to_d
+        when :percentual_fee
+          value /= 1 - (step[:percentage].to_d / 100.to_d)
+        when :fixed_fee
+          value += step[:amount].to_d
+        when :minimum_fee
+          value = [value + step[:minimum].to_d,
+            value / (1 - (step[:percentage].to_d / 100.to_d))].max
+        end
+      end
+      value
+    end
+  
+    def self.path_to_calculator(path)
+      steps = tree
+      begin
+        path.each { |step| steps = steps[step] }
+      rescue StandardError => e
+        raise "InvalidPath: #{path}"
+      end
+      steps
     end
   end
 end

data/lib/bitex/version.rb

@@ -1,3 +1,3 @@
 module Bitex
-  VERSION = "0.2.2"
+  VERSION = "0.2.3"
 end

data/spec/rates_spec.rb

@@ -1,19 +1,29 @@
 require 'spec_helper'
 
 describe Bitex::Rates do
-  it "gets all rates" do
+  before(:each){ Bitex::Rates.clear_tree_cache }
+
+  it "gets the full exchange rates tree and caches for 1 minute" do
+    Bitex::Rates.clear_tree_cache
     Bitex.api_key = 'valid_api_key'
-    stub_private(:get, "/private/rates", 'rates')
-    Bitex::Rates.all.should == {
-      AR: {
-        astropay: {USDARS: [8.7592,nil,1412969688]}, 
-        reference:{USDARS: [nil,nil,0]}},
-      BR: {astropay:{USDBRL: [2.3779,nil,1412969689]}},
-      CL: {astropay:{USDCLP: [611.673,nil,1412969691]}},
-      CO: {astropay:{USDCOP: [2006.368,nil,1412969693]}},
-      PE: {astropay:{USDPEN: [2.9807,nil,1412969696]}},
-      UY: {astropay:{USDUYU: [24.751,nil,1412969698]}},
-      MX: {astropay:{USDMXN: [13.7471,nil,1412969700]}}
-   }
+    stub = stub_get("/rates/tree", 'rates_tree')
+    Bitex::Rates.tree.keys.should == 
+      %w(btc usd ars clp eur uyu brl cop pen mxn bob nio hnl dop gbp cad vef).collect(&:to_sym)
+    2.times{ Bitex::Rates.tree }
+    Timecop.travel 2.minutes.from_now
+    Bitex::Rates.tree
+    stub.should have_been_requested.twice
+  end
+  
+  it "calculates a given path using the tree" do
+    stub_get("/rates/tree", 'rates_tree')
+    Bitex::Rates.calculate_path(1000, [:ars, :cash, :usd, :bitex, :more_mt])
+      .should == '64.332439179'.to_d
+  end
+  
+  it "calculates backwards using a path" do
+    stub_get("/rates/tree", 'rates_tree')
+    Bitex::Rates.calculate_path_backwards([:ars, :cash, :usd, :bitex, :more_mt], 64)
+      .should == '994.832479799730206496'.to_d
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitex
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors:
 - Nubis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -193,7 +193,6 @@ files:
 - spec/fixtures/order_book.json
 - spec/fixtures/orders.json
 - spec/fixtures/profile.json
-- spec/fixtures/rates.json
 - spec/fixtures/specie_deposit.json
 - spec/fixtures/specie_deposits.json
 - spec/fixtures/specie_withdrawal.json
@@ -267,7 +266,6 @@ test_files:
 - spec/fixtures/order_book.json
 - spec/fixtures/orders.json
 - spec/fixtures/profile.json
-- spec/fixtures/rates.json
 - spec/fixtures/specie_deposit.json
 - spec/fixtures/specie_deposits.json
 - spec/fixtures/specie_withdrawal.json

data/spec/fixtures/rates.json

@@ -1 +0,0 @@
-{"AR":{"astropay":{"USDARS":[8.7592,null,1412969688]},"reference":{"USDARS":[null,null,0]}},"BR":{"astropay":{"USDBRL":[2.3779,null,1412969689]}},"CL":{"astropay":{"USDCLP":[611.673,null,1412969691]}},"CO":{"astropay":{"USDCOP":[2006.368,null,1412969693]}},"PE":{"astropay":{"USDPEN":[2.9807,null,1412969696]}},"UY":{"astropay":{"USDUYU":[24.751,null,1412969698]}},"MX":{"astropay":{"USDMXN":[13.7471,null,1412969700]}}}