cryptowatch-ruby 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bec614044574bff8ea8dc1ef818229835de2ad12
+  data.tar.gz: be69208fe6490326dbaef3a24976ef371830c494
+SHA512:
+  metadata.gz: 8c87090794ece37cbc5427a088a63b1f7c2cdfda3f648ac5d3697bca67679975d3608360c6ad7d9429dd1bd7075d625fd349fad2068a78115307588aa4ec63c1
+  data.tar.gz: 39f14c696f1425878f88d0432c07fb1a14a30a2feac4e9faa3d3c2e20d1fd0dfc95788cf96620d5deff1fd64d985049c6e4585bcd32ce27435416698ec5b83f3

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,73 @@
+PATH
+  remote: .
+  specs:
+    cryptowatch-ruby (0.0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    byebug (10.0.1)
+    concurrent-ruby (1.0.5)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    domain_name (0.5.20170404)
+      unf (>= 0.0.5, < 1.0.0)
+    faker (1.8.7)
+      i18n (>= 0.7)
+    hashdiff (0.3.7)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    i18n (1.0.0)
+      concurrent-ruby (~> 1.0)
+    mime-types (3.1)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2016.0521)
+    netrc (0.11.0)
+    public_suffix (3.0.2)
+    rake (10.5.0)
+    rest-client (2.0.2)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+    safe_yaml (1.0.4)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.5)
+    vcr (3.0.3)
+    webmock (3.3.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1)
+  byebug
+  cryptowatch-ruby!
+  faker (~> 1.8.7)
+  rake (~> 10.0)
+  rest-client (~> 2.0)
+  rspec (~> 3.7.0)
+  vcr (~> 3.0)
+  webmock
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,45 @@
+# Cryptowatch Wrapper in Ruby
+
+A simple API wrapper for Cryptowatch written in Ruby.
+
+Cryptowat.ch API documentation: https://cryptowat.ch/docs/
+
+## Get started
+
+### Installation
+
+```
+gem install 'cryptowatch'
+```
+
+Require the gem into your project with:
+```
+require 'cryptowatch'
+```
+
+## An example
+
+```ruby
+require 'cryptowatch'
+
+class MyApplication
+  wrapper = Cryptowatch::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/cryptowatch.gemspec

@@ -0,0 +1,31 @@
+# -*- 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-ruby'
+  gem.version       =  Cryptowatch::Api::VERSION_FORMAT
+  gem.date	       	= '2018-03-27'
+  gem.authors       = ["Abdelkader K"]
+  gem.summary       = 'Cryptowat.ch API wrapper written in Ruby.'
+  gem.description	  = 'A simple API wrapper in Ruby to facilite the use of Cryptowat.ch'
+  gem.email         = 'akettal@users.noreply.github.com'
+  gem.homepage		  = 'https://github.com/akettal/cryptowatch-ruby'
+  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 "bundler", "~> 1"
+  gem.add_development_dependency "rest-client", '~> 2.0'
+  gem.add_development_dependency "rspec", '~> 3.7', '>= 3.7.0'
+  gem.add_development_dependency "faker", '~> 1.8', '>= 1.8.7'
+  gem.add_development_dependency "vcr", "~> 3.0"
+  gem.add_development_dependency "rake", "~> 10.0"
+  gem.add_development_dependency "webmock", '~> 0'
+  gem.add_development_dependency "byebug", '~> 0'
+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/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, 3]
+    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: Monday, November 6th 2017, 1:07:49 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/spec/cryptowatch/client_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+RSpec.describe Cryptowatch::Wrapper, :vcr do
+  subject { Cryptowatch::Wrapper.new() }
+
+  describe '#new' do
+    it 'returns a wrapper instance' do
+      expect(subject).not_to be nil
+    end
+  end
+
+end

data/spec/cryptowatch_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+RSpec.describe Cryptowatch do
+  describe 'Cryptowatch gem' do
+    it 'has an API version number' do
+      expect(Cryptowatch::Api::VERSION).not_to be nil
+    end
+  
+    it 'has a wrapper module' do
+      expect(Cryptowatch::Wrapper).not_to be nil
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require_relative '../lib/cryptowatch'
+require 'bundler/setup'
+
+require 'ostruct'
+require 'faker'
+require 'webmock/rspec'
+require 'vcr'
+
+Bundler.setup
+
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/cassettes'
+  c.hook_into :webmock
+  c.configure_rspec_metadata!
+end
+
+WebMock.allow_net_connect!
+
+RSpec.configure do |config|
+  config.around(:each) do |ex|
+    if ex.metadata.key?(:vcr)
+      ex.run
+    else
+      VCR.turned_off { ex.run }
+    end
+  end
+end
+
+RSpec::Matchers.define :a_hash_with_keys do |expected|
+  match do |actual|
+    return false unless actual.is_a?(Hash)
+    expected.all?{|key| actual.key?(key) }
+  end
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: cryptowatch-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Abdelkader K
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.7
+- !ruby/object:Gem::Dependency
+  name: vcr
+  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: 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: webmock
+  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'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: A simple API wrapper in Ruby to facilite the use of Cryptowat.ch
+email: akettal@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- 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
+- spec/cryptowatch/client_spec.rb
+- spec/cryptowatch_spec.rb
+- spec/spec_helper.rb
+- unit_tests/.DS_Store
+homepage: https://github.com/akettal/cryptowatch-ruby
+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: Cryptowat.ch API wrapper written in Ruby.
+test_files: []