nomics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3b9bd275f69f7804f8a53c351ac6c6c850d5a8e3a6f02681626bf625dcca2af6
+  data.tar.gz: 1e822000e4c3a5c2c9caf2d1f340a5c93b1b12ea265948ce1b16f87750510fcd
+SHA512:
+  metadata.gz: c8c6e62a107545709d628d81635d7a3e8c2ddee651e87f17d01dae62838bb5048cc7abc65375b09cbff55fb8982702ea5122640b0e116a150c3d8c7319a68ef2
+  data.tar.gz: 6676c9046042c4042bdfa2f21c224abf4a8a584c72231c2da47c3854dc614a73649bfbaaa75738d02469154f85f92dc2ba3723b9040530e41e8b0025323eba37

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nomics.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,48 @@
+PATH
+  remote: .
+  specs:
+    nomics (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    hashdiff (1.0.1)
+    public_suffix (4.0.6)
+    rake (13.0.6)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    vcr (6.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-18
+
+DEPENDENCIES
+  nomics!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  vcr
+  webmock
+
+BUNDLED WITH
+   2.2.22

data/README.md

@@ -0,0 +1,121 @@
+# Nomics
+
+[Nomics](https://p.nomics.com/about) is an API-first cryptoasset data company delivering professional-grade market data APIs to institutional crypto investors & exchanges. This gem provides Ruby bindings to its V1 API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nomics'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nomics
+
+## Usage
+
+First, configure Nomics. You can use the `NOMICS_API_KEY` env var or using a block:
+
+```ruby
+Nomics.configure do |config|
+  # Get an API key at https://p.nomics.com/pricing
+  # This defaults to ENV['NOMICS_API_KEY']
+  config.api_key = 'abcd1234'.freeze
+
+  # If you have a free API key that is limited to one call per second,
+  # you can add 2 seconds before network calls:
+  config.wait_time_in_between_calls = 2
+end
+```
+
+### Getting currency data
+
+Create a currency object and fetch some data on it
+```ruby
+btc = Nomics::Currency.new('BTC') # also supports symbols like Nomics::Currency.new(:BTC)
+```
+
+Let's see some data!
+```ruby
+btc.price
+btc.name
+```
+
+Get all the known attributes (casted for convenience) for a given currency:
+```ruby
+btc.attributes
+```
+You can reload the data from the Nomics API with a single call. Here's how you'd get an up-to-date price:
+```ruby
+btc.reload.price
+```
+
+If a currency cannot be found, it will raise an error (once we fetch any data):
+```ruby
+bazinga = Nomics::Currency.new('BAZINGA')
+bazinga.price
+# => Cannot find currency with id: BAZINGA (Nomics::UnknownCurrencyError)
+```
+
+### Fetching multiple currencies at once
+
+You can fetch multiple currencies using a single call and fetch all attributes:
+
+```ruby
+currencies = Nomics::Currencies.new(*%w[BTC XRP ETH])
+currencies.map &:attributes
+```
+
+If you want to view a specific set of attributes for the currencies provided, you can map over them:
+
+```ruby
+currencies = Nomics::Currencies.new(*%w[ETH BTC])
+
+currencies.map &:circulating_supply
+currencies.map &:name
+currencies.map &:symbol
+currencies.map &:price
+```
+
+Alternatively you simply just pluck these (similar to how ActiveRecord works)
+
+```ruby
+currencies.pluck :circulating_supply, :name, :symbol, :price
+```
+
+### Retrieving currencies in given fiat
+
+Retrieving a specific cryptocurrency in a specific fiat currency can also be done. This will quote ticker price, market cap, and volume in the specified currency:
+
+```ruby
+btc_in_zar = Nomics::Currency.new('BTC', convert: 'EUR')
+eth_in_usd = Nomics::Currency.new('ETH', convert: 'USD')
+eth_in_usd = Nomics::Currency.new('ETH') # convert defaults to USD
+```
+
+### Calculating the price of one cryptocurrency from another
+
+Advanced calculations are yet under consideration for this gem, but you can calculate prices in relation to their dollar value. For example:
+
+```ruby
+btc_price_in_usd = Nomics::Currency.new('BTC').price.to_f # Nomics API defaults to USD
+eth_price_in_usd = Nomics::Currency.new('ETH').price.to_f # Nomics API defaults to USD
+
+eth_price_in_btc = eth_price_in_usd / btc_price_in_usd
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/attilagyorffy/nomics.rb.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "nomics"
+
+# 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/nomics/client.rb

@@ -0,0 +1,43 @@
+require 'uri'
+require 'net/http'
+require 'json'
+module Nomics
+  class Client
+
+    # NOMICS_BASE_URL = "https://api.nomics.com"
+
+    def get(path, params = {})
+      params.merge!(key: api_key)
+
+      uri = URI::HTTPS.build(host: 'api.nomics.com', path: path, query: URI.encode_www_form(params))
+
+      wait_if_necessary
+      response = Net::HTTP.get_response(uri)
+
+      case response
+      when Net::HTTPSuccess
+        JSON.parse response.body
+      when Net::HTTPUnauthorized
+        raise HTTPAuthorizationError.new(response.body)
+      when Net::HTTPServerError
+        raise APIServerError.new(response.body)
+      else
+        raise UnhandledError.new(response.body)
+      end
+    end
+
+  private
+
+    def api_key
+      ::Nomics.configuration.api_key || raise(HTTPAuthorizationError, "Missing API key. Forgot to set ENV['NOMICS_API_KEY'] or Nomics.configuration.api_key?")
+    end
+
+    # Nomics.com’s free plan allows for 1 request per second. This allows us to wait in between calls.
+    # TODO: Rescue from the specific nomics authorization error and implement automatic waiting in between calls
+    def wait_if_necessary
+      if seconds = ::Nomics.configuration.wait_time_in_between_calls
+        sleep seconds
+      end
+    end
+  end
+end

data/lib/nomics/configuration.rb

@@ -0,0 +1,10 @@
+module Nomics
+  class Configuration
+    attr_accessor :api_key, :wait_time_in_between_calls
+
+    def initialize
+      @api_key = ENV['NOMICS_API_KEY']
+      @wait_time_in_between_calls = nil
+    end
+  end
+end

data/lib/nomics/currencies.rb

@@ -0,0 +1,33 @@
+module Nomics
+  class Currencies
+    include Enumerable
+
+    def initialize(*currencies)
+      @currencies = currencies.map { |symbol| Currency.new(symbol) }
+    end
+
+    def each
+      @currencies.map { |currency| yield currency }
+    end
+
+    def last
+      @currencies.last
+    end
+
+    def pluck(*attributes)
+      if attributes.one?
+        map { |currency| currency.send(attributes.first) }
+      else
+        map do |currency|
+          [].tap do |data|
+            attributes.each { |attribute| data << currency.send(attribute) }
+          end
+        end
+      end
+    end
+
+    def reload
+      @currencies.each &:reload
+    end
+  end
+end

data/lib/nomics/currency.rb

@@ -0,0 +1,103 @@
+require 'time'
+require 'bigdecimal'
+
+module Nomics
+  class Currency
+    ATTTRIBUTES_WITH_TYPES = {
+      'id' => :string,
+      'currency' => :string,
+      'symbol' => :symbol,
+      'name' => :string,
+      'logo_url' => :string,
+      'status' => :string,
+      'price' => :number,
+      'price_date' => :timestamp,
+      'price_timestamp' => :timestamp,
+      'circulating_supply' => :number,
+      'max_supply' => :number,
+      'market_cap' => :number,
+      'market_cap_dominance' => :number,
+      'num_exchanges' => :number,
+      'num_pairs' => :number,
+      'num_pairs_unmapped' => :number,
+      'first_candle' => :timestamp,
+      'first_trade' => :timestamp,
+      'first_order_book' => :timestamp,
+      'rank' => :number,
+      'rank_delta' => :number,
+      'high' => :number,
+      'high_timestamp' => :timestamp
+    }.freeze
+
+    attr_reader :symbol, :quote_currency
+
+    def initialize(symbol, convert: :USD)
+      @symbol = symbol.to_s.upcase.to_sym
+      @quote_currency = convert.to_s.upcase.to_sym
+
+      ATTTRIBUTES_WITH_TYPES.except('symbol').keys.each do |attribute_name|
+        instance_variable_set("@#{attribute_name}", nil)
+      end
+    end
+
+    def <=>(other_currency)
+      name <=> other_currency.name
+    end
+
+    ATTTRIBUTES_WITH_TYPES.except('symbol').each do |(attribute_name, attribute_type)|
+      define_method(attribute_name) do
+        attributes[attribute_name]
+      end
+    end
+
+    def attributes(reload: false)
+      if reload
+        @attributes = attributes_with_types data.slice(*ATTTRIBUTES_WITH_TYPES.keys)
+      else
+        @attributes ||= attributes_with_types data.slice(*ATTTRIBUTES_WITH_TYPES.keys)
+      end
+
+      @attributes.each do |(attribute_name, attribute_value)|
+        instance_variable_set("@#{attribute_name}", attribute_value)
+      end
+    end
+
+    def reload
+      attributes reload: true
+      self
+    end
+
+  private
+
+    def attributes_with_types(attributes = {})
+      attributes.inject({}) do |typed_attributes, (attribute_key, attribute_value)|
+        typed_attributes[attribute_key] = cast value: attribute_value, type: ATTTRIBUTES_WITH_TYPES[attribute_key]
+
+        typed_attributes
+      end
+    end
+
+    def cast(value:, type:)
+      case type
+      when :string
+        value.to_s
+      when :symbol
+        value.to_sym
+      when :number
+        BigDecimal(value)
+      when :timestamp
+        Time.parse(value)
+      else
+        raise "Unknown type: #{attribute_type}"
+      end
+    end
+
+    def data
+      client.get('/v1/currencies/ticker', ids: [@symbol], convert: @quote_currency).first || raise(Nomics::UnknownCurrencyError.new("Cannot find currency with id: #{@symbol}"))
+    end
+
+    def client
+      @client ||= Client.new
+    end
+  end
+end

data/lib/nomics/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Nomics
+  VERSION = "0.1.0"
+end

data/lib/nomics.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "nomics/version"
+
+module Nomics
+  class HTTPAuthorizationError < StandardError; end
+  class APIServerError < StandardError; end
+  class UnknownCurrencyError < StandardError; end
+  class UnhandledError < StandardError; end
+
+  autoload(:Configuration, 'nomics/configuration')
+  autoload(:Client, 'nomics/client')
+  autoload(:Currency, 'nomics/currency')
+  autoload(:Currencies, 'nomics/currencies')
+
+  class << self
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+end

data/nomics.gemspec

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require_relative "lib/nomics/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nomics"
+  spec.version       = Nomics::VERSION
+  spec.authors       = ["Attila Györffy"]
+  spec.email         = ["attila@attilagyorffy.com"]
+
+  spec.summary       = "A Ruby client for the Nomics Cryptocurrency API"
+  spec.description   = "A Ruby client for the Nomics Cryptocurrency API"
+  spec.homepage      = "https://nomics.com/docs/"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "vcr"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: nomics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Attila Györffy
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-10-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: 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: vcr
+  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 Ruby client for the Nomics Cryptocurrency API
+email:
+- attila@attilagyorffy.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nomics.rb
+- lib/nomics/client.rb
+- lib/nomics/configuration.rb
+- lib/nomics/currencies.rb
+- lib/nomics/currency.rb
+- lib/nomics/version.rb
+- nomics.gemspec
+homepage: https://nomics.com/docs/
+licenses: []
+metadata:
+  homepage_uri: https://nomics.com/docs/
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key:
+specification_version: 4
+summary: A Ruby client for the Nomics Cryptocurrency API
+test_files: []