cryptowatch 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 662c3dca7603c941b71ae52bac099dd5752a0de7
+  data.tar.gz: a15b07fe593328600fbc90d1769f49948a361d03
+SHA512:
+  metadata.gz: b7310839cd7df577efecfa502496fe6b5e36a889a47b6a8402b2fac9bcac72844d53ac19c20f8c6afd903d87ee0c0190acfadbce48195b9b5445241bb3f3d439
+  data.tar.gz: 6626637832278b55a2b8cec147a63e29b1083d080a75561ac757e92d8e7c9f1df7ced8bf906f3f88a2b605c78757e50a1c27beeca877a282711de36566ac8db6

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# gem "rails"

data/README.md

@@ -0,0 +1,35 @@
+# Cryptowatch Library for Ruby
+
+Developpement of *a simple interface in Ruby for Cryptowatch.*
+
+To describe the use of the methods I used the phrases of the Cryptowat.ch documentation: API: https://cryptowat.ch/docs/
+
+## Get started
+
+Install it yourself as:
+```
+gem install 'cryptowatch'
+```
+Require the gem into your project with:
+```
+require 'cryptowatch'
+```
+## Requests list
+Let's construct or first request with the gem:
+```ruby
+cw = Cryptowatch::Wrapper.new({:timeout => 10}) #By default timeout = 5.
+
+cw.assets		       #Returns all assets (in no particular order).
+cw.assets(:btc)		       #Lists all markets which have this asset as a base or quote.
+
+cw.pairs		       #Returns all pairs (in no particular order).
+cw.pairs(:btcusd)	       #Returns a single pair. Lists all markets for this pair.
+
+cw.exchanges		       #Returns a list of all supported exchanges.
+cw.exchanges(:kraken)	       #Returns a single exchange, with associated routes.
+
+cw.markets		       #Returns a list of all supported markets.
+cw.markets(:kraken, :btcusd)   #Returns a single market, with associated routes.
+
+#In writing...
+```

data/cryptowatch.gemspec

@@ -0,0 +1,30 @@
+# @Author: Esteban GONZALEZ <esteban>
+# @Date:   Tuesday, October 31st 2017, 11:05:52 am
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Thursday, November 2nd 2017, 4:13:38 pm
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cryptowatch/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'cryptowatch'
+  gem.version       =  Cryptowatch::Api::VERSION_FORMAT
+  gem.date	       	= '2017-10-31'
+  gem.authors       = ["Esteban Gonzalez"]
+  gem.summary       = 'Simple Cryptowat.ch interface in Ruby.'
+  gem.description	  = 'Simple interface in Ruby to facilite the use Cryptowatch.'
+  gem.email         = 'gonzal_e@etna-alternance.net'
+  gem.homepage		  = 'https://github.com/estebgonza/Cryptowatch'
+  gem.require_paths = ['lib/cryptowatch']
+  gem.licenses      = ['MIT']
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|gem|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency "rest-client", '~> 0'
+end

data/lib/cryptowatch/adapter/rest_client_adapter.rb

@@ -0,0 +1,47 @@
+# @Author: Esteban GONZALEZ <esteban>
+# @Date:   Wednesday, November 1st 2017, 9:26:19 am
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 7:11:00 pm
+
+require 'rest-client'
+require 'logger'
+require 'json'
+
+module Cryptowatch
+  class RestClientAdapter
+
+    attr_accessor :options
+
+    def initialize (options)
+      @options = options
+    end
+
+    def get (*elements)
+
+      if (elements.size == 0)
+         Messages::LOG.error(Messages::ERROR_NO_URL)
+        return nil
+      end
+
+      url = Api::format_url(*elements)
+
+      begin
+        milli_start = Time.now
+        answer = JSON.parse(RestClient::Request.execute(
+          method: :get,
+          url: url,
+          timeout: @options[:timeout]),
+          accept: :json
+        )
+        milli_end = Time.now
+        elapsed   = Utils::time_elapsed(milli_start, milli_end)
+        Messages::LOG.info("[#{elapsed.round} ms] #{Messages::GET}'#{url}'")
+        return answer
+      rescue SocketError, RestClient::ExceptionWithResponse => e
+        Messages::LOG.error("'#{e.message}' on => #{url}")
+      end
+    end
+  end
+end

data/lib/cryptowatch/api/api.rb

@@ -0,0 +1,19 @@
+# @Author: Esteban GONZALEZ <Esteban>
+# @Date:   Tuesday, October 17th 2017, 9:32:56 pm
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 6:42:01 pm
+
+module Cryptowatch
+  module Api
+
+    API_BASE_URL      = "https://api.cryptowat.ch"
+
+    def self.format_url(*args)
+      args -= [nil]
+      return args.join'/'
+    end
+
+  end
+end

data/lib/cryptowatch/business/assets.rb

@@ -0,0 +1,22 @@
+# @Author: Esteban GONZALEZ <esteban>
+# @Date:   Sunday, November 5th 2017, 12:31:59 pm
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 2:29:23 pm
+
+module Cryptowatch
+  module Assets
+
+    API_URL = "#{Api::API_BASE_URL}/assets"
+
+    def self.index
+      return API_URL
+    end
+
+    def self.asset(asset)
+      return Api::format_url(API_URL, asset)
+    end
+
+  end
+end

data/lib/cryptowatch/business/exchanges.rb

@@ -0,0 +1,22 @@
+# @Author: Esteban GONZALEZ <esteban>
+# @Date:   Sunday, November 5th 2017, 12:55:04 pm
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 2:44:21 pm
+
+module Cryptowatch
+  module Exchanges
+
+    API_URL = "#{Api::API_BASE_URL}/exchanges"
+
+    def self.index
+      return API_URL
+    end
+
+    def self.exchange(exchange)
+      return Api::format_url(API_URL, exchange)
+    end
+
+  end
+end

data/lib/cryptowatch/business/markets.rb

@@ -0,0 +1,57 @@
+# @Author: Esteban GONZALEZ <esteban>
+# @Date:   Sunday, November 5th 2017, 1:39:50 pm
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 6:40:33 pm
+
+module Cryptowatch
+  module Markets
+
+    API_URL = "#{Api::API_BASE_URL}/markets"
+    ROUTES = [
+      :price,     #Returns a market’s last price.
+      :summary,   #Other stats based on a 24-hour sliding window.
+      :orderbook, #Returns a market’s order book.
+      :trades,    #Returns a market’s most recent trades, incrementing chronologically.
+      :ohlc       #Returns a market’s OHLC candlestick data.
+    ]
+
+    def self.index
+      return API_URL
+    end
+
+    def self.market(exchange)
+      return Api::format_url(API_URL, exchange)
+    end
+
+    def self.market(exchange, asset, route = nil)
+      if (route != nil && !ROUTES.include?(route))
+        Messages::LOG.error(Messages::ERROR_UNKNOW_MARKET_ROUTE)
+      else
+        return Api::format_url(API_URL, exchange, asset, route)
+      end
+    end
+
+    def self.price(exchange, asset)
+      return self.market(exchange, asset, :price)
+    end
+
+    def self.summary(exchange, asset)
+      return self.market(exchange, asset, :summary)
+    end
+
+    def self.orderbook(exchange, asset)
+      return self.market(exchange, asset, :orderbook)
+    end
+
+    def self.trades(exchange, asset)
+      return self.market(exchange, asset, :trades)
+    end
+
+    def self.ohlc(exchange, asset)
+      return self.market(exchange, asset, :ohlc)
+    end
+
+  end
+end

data/lib/cryptowatch/business/pairs.rb

@@ -0,0 +1,22 @@
+# @Author: Esteban GONZALEZ <esteban>
+# @Date:   Sunday, November 5th 2017, 12:45:58 pm
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 2:29:20 pm
+
+module Cryptowatch
+  module Pairs
+
+    API_URL = "#{Api::API_BASE_URL}/pairs"
+
+    def self.index
+      return API_URL
+    end
+
+    def self.pair(pair)
+      return Api::format_url(API_URL, pair)
+    end
+
+  end
+end

data/lib/cryptowatch/messages.rb

@@ -0,0 +1,19 @@
+# @Author: Esteban GONZALEZ <esteban>
+# @Date:   Sunday, November 5th 2017, 2:26:39 pm
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 7:39:39 pm
+require 'logger'
+
+module Cryptowatch
+  module Messages
+
+    LOG = Logger.new(STDOUT)
+
+    GET                       = "GET => "
+    ERROR_NO_URL              = "Can not execute a 'GET' request without url."
+    ERROR_UNKNOW_MARKET_ROUTE = "Unknow route: "
+
+  end
+end

data/lib/cryptowatch/utils.rb

@@ -0,0 +1,13 @@
+# @Author: Esteban GONZALEZ <esteban>
+# @Date:   Sunday, November 5th 2017, 6:44:18 pm
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 7:05:20 pm
+module Cryptowatch
+  module Utils
+    def self.time_elapsed(start, finish)
+      return ((finish - start) * 1000.0)
+    end
+  end
+end

data/lib/cryptowatch/version.rb

@@ -0,0 +1,13 @@
+# @Author: Esteban GONZALEZ <Esteban
+# @Date:   Tuesday, October 17th 2017, 9:38:57 pm
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 7:39:23 pm
+
+module Cryptowatch
+  module Api
+    VERSION = [0, 0, 2]
+    VERSION_FORMAT = VERSION.join('.')
+  end
+end

data/lib/cryptowatch/wrapper.rb

@@ -0,0 +1,31 @@
+# @Author: Esteban GONZALEZ <esteban>
+# @Date:   Thursday, November 2nd 2017, 9:48:46 am
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 9:06:17 pm
+
+require 'cryptowatch'
+
+module Cryptowatch
+  class Wrapper
+
+    attr_accessor :rest_adapter
+
+    def initialize(options = nil)
+      if options == nil
+        options = {
+          :timeout            => 5,
+          :display_infos      => true,
+          :display_errors     => true
+        }
+      end
+      @rest_adapter = RestClientAdapter.new(options)
+    end
+
+    def get(url)
+      return @rest_adapter.get(url)
+    end
+
+  end
+end

data/lib/cryptowatch.rb

@@ -0,0 +1,26 @@
+# @Author: Esteban GONZALEZ <Esteban>
+# @Date:   Tuesday, October 17th 2017, 8:39:43 pm
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 6:49:39 pm
+
+require "rubygems"
+
+require "cryptowatch/version"
+require "cryptowatch/api/api"
+require "cryptowatch/messages"
+require "cryptowatch/utils"
+require "cryptowatch/wrapper"
+require "cryptowatch/adapter/rest_client_adapter"
+
+
+require "cryptowatch/business/assets"
+require "cryptowatch/business/exchanges"
+require "cryptowatch/business/markets"
+require "cryptowatch/business/pairs"
+
+module Cryptowatch
+  module Api
+  end
+end

data/unit_tests/test_requests.rb

@@ -0,0 +1,30 @@
+# @Author: Esteban GONZALEZ <esteban>
+# @Date:   Tuesday, October 31st 2017, 10:29:25 am
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 8:59:13 pm
+
+require 'cryptowatch'
+
+class MyApplication
+  include Cryptowatch
+
+    wrapper = Wrapper.new;
+
+    wrapper.get(Assets::index)
+    wrapper.get(Assets::asset(:btc))
+
+    wrapper.get(Exchanges::index)
+    wrapper.get(Exchanges::exchange(:kraken))
+
+    wrapper.get(Markets::index)
+    wrapper.get(Markets::price(:kraken, :btcusd))
+    wrapper.get(Markets::summary(:gdax, :btceur))
+    wrapper.get(Markets::trades(:poloniex, :ethbtc))
+    wrapper.get(Markets::orderbook(:kraken, :xrpbtc))
+    wrapper.get(Markets::ohlc(:kraken, :xrpbtc))
+
+    wrapper.get(Pairs::index)
+    wrapper.get(Pairs::pair(:btcusd))
+end

data/worktest/script.rb

@@ -0,0 +1,6 @@
+# @Author: Esteban GONZALEZ <esteban>
+# @Date:   Sunday, November 5th 2017, 12:26:35 pm
+# @Email:  gonzal_e@etna-alternance.net
+# @Project: RubyCryptowatch
+# @Last modified by:   esteban
+# @Last modified time: Sunday, November 5th 2017, 12:26:35 pm

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: cryptowatch
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Esteban Gonzalez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-10-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple interface in Ruby to facilite the use Cryptowatch.
+email: gonzal_e@etna-alternance.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- cryptowatch.gemspec
+- lib/cryptowatch.rb
+- lib/cryptowatch/adapter/rest_client_adapter.rb
+- lib/cryptowatch/api/api.rb
+- lib/cryptowatch/business/assets.rb
+- lib/cryptowatch/business/exchanges.rb
+- lib/cryptowatch/business/markets.rb
+- lib/cryptowatch/business/pairs.rb
+- lib/cryptowatch/messages.rb
+- lib/cryptowatch/utils.rb
+- lib/cryptowatch/version.rb
+- lib/cryptowatch/wrapper.rb
+- unit_tests/.DS_Store
+- unit_tests/test_requests.rb
+- worktest/script.rb
+homepage: https://github.com/estebgonza/Cryptowatch
+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.6.14
+signing_key: 
+specification_version: 4
+summary: Simple Cryptowat.ch interface in Ruby.
+test_files: []