stocks_exchange 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 61879aa757b655264b77b75b68f34af999c32bff
+  data.tar.gz: 70572931c4325f491417ae675b2327bfac06ca3c
+SHA512:
+  metadata.gz: b68267d74d3eedd7d35c5033976ace2b3806a7738ae2fdc70fa6e96e4f64b5dce6d779c5ae513f0c3336ebb3659f1715c08cd9cc28959780a862f3a0138ab2df
+  data.tar.gz: 980e6993b0f9e25acc7d533827a542977188f8f1a3b45e6f764fc51e1782c7e5a7e96bc1c5a9574dd295f82eac3116a0ea5d8b5e72f84f4c7eb47a64c940e160

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

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 stocks_exchange.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    stocks_exchange (0.1.0)
+      httparty (~> 0.15.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    httparty (0.15.6)
+      multi_xml (>= 0.5.2)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  rake (~> 10.0)
+  stocks_exchange!
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 alabeco
+
+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,94 @@
+# StocksExchange
+
+This gem consumes the public API of [stocks.exchange]('https://stocks.exchange') to give you a ruby friendly version.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stocks_exchange'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stocks_exchange
+
+## Usage
+
+All [currencies](https://stocks.exchange/api2/currencies) are converted into modules with their respective symbols(in uppercase) as the names.
+For example, for a currency, Intensecoin with the symbol ITNS you access it as:
+
+```ruby
+StocksExchange::ITNS
+```
+The corresponding keys are converted into methods that return their values
+For example, to get the minimum withdrawal amount for Intensecoin above. You can use:
+```ruby
+StocksExchange::ITNS.minimum_withdrawal_amount
+#=> "<some_value>"
+```
+since [stocks.exchange](https://stocks.exchange) provides `"minimum_withdrawal_amount":"<some_value>"` in their API.
+
+All [markets](https://stocks.exchange/api2/markets) are converted into modules with their respective market names(as in the API, in uppercase) as the names.
+For example, for a market, DERO/BTC, you can access it as:
+```ruby
+StocksExchange::DERO_BTC
+```
+The corresponding keys are converted into methods that return their values.
+The values from the [ticker](https://stocks.exchange/api2/ticker) and [prices](https://stocks.exchange/api2/prices) are also added to their respective market names.
+Examples:
+
+```ruby
+#to get buy fee percentage
+#sample from API: "buy_fee_percent":"0.2"
+StocksExchange::DERO_BTC.buy_fee_percent
+#=> "0.2"
+
+#to get market volume from ticker url
+#sample from API: "vol":"240114.98504904"
+StocksExchange::DERO_BTC.vol
+#=> "240114.98504904"
+
+#to get buy price from prices url
+#sample from API:  "buy":"0.000142"
+StocksExchange::DERO_BTC.buy
+#=> "0.000142"
+```
+
+### Other Methods
+
+It is important to keep updating the values since the initital values are the values grabbed during gem load time.
+To do so, use:
+```ruby
+StocksExchange.refresh
+#=> true
+```
+To check whether a market or currency exists use:
+
+```ruby
+#StocksExchange.listed?(<coin_symbol or market_name>)
+StocksExchange.listed?("ITNS_BTC")
+#=> true
+StocksExchange.listed?("dhjdcdhjcbhsjcb")
+#=> false
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/alabeco/stocks_exchange/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alabeco/stocks_exchange.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stocks_exchange"
+
+# 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/stocks_exchange.rb

@@ -0,0 +1,92 @@
+require "stocks_exchange/version"
+require "httparty"
+
+$VERBOSE=nil #silence "warning: already initialized constant" appearing during refresh
+
+module StocksExchange
+  include HTTParty
+  @base_uri="https://stocks.exchange/api2"
+
+  #updates the values of modules and functions
+  def self.refresh
+    begin
+      setup_currencies
+      setup_markets
+      return true
+    rescue => e
+      puts "StocksExchange failed to load required Modules and Methods. Error: #{e.message}"
+      return false
+    end
+  end
+
+  #checks whether a market or currency is present
+  def self.listed?(name)
+    StocksExchange.const_defined?("#{name}".upcase)
+  end
+
+  #gets all available currencies from https://stocks.exchange/api2/currencies  and creates dynamic modules with dynamic methods as from the API
+  def self.setup_currencies
+    setup("/currencies")
+  end
+
+  #gets all available markets from https://stocks.exchange/api2/currencies and sets their respective modules and methods as #self.setup_currencies above
+  #the markets are then supplimentented with values from ticker and prices
+  def self.setup_markets
+    setup("/markets")
+    setup_ticker
+    setup_prices
+  end
+
+  #add methods from https://stocks.exchange/api2/ticker to respective markets(Modules) created in #self.setup_markets above
+  #if market does not exist for some reason, it is created
+  def self.setup_ticker
+    suppliment("/ticker")
+  end
+
+  #add methods from https://stocks.exchange/api2/prices to respective markets(Modules) created in #self.setup_markets above
+  #if market does not exist for some reason, it is created
+  def self.setup_prices
+    suppliment("/prices")
+  end
+
+  private
+
+  #setup_currencies
+  #setup_markets
+  def self.setup(path)
+    get("#@base_uri#{path}").parsed_response.each do |response|
+      case path
+      when "/currencies"
+        module_name = response['currency'].upcase
+      when "/markets"
+        module_name = "#{response['currency'].upcase}_#{response['partner']}"
+      else
+        return false
+      end
+      StocksExchange.const_set(module_name, Module.new{
+        response.map{|key,value| define_singleton_method(key){value}}
+        })
+    end
+
+    return true
+  end
+
+  #setup_ticker
+  #setup_prices
+  def self.suppliment(path)
+    get("#@base_uri#{path}").parsed_response.each do |response|
+      if StocksExchange.const_defined?(response['market_name'].upcase)
+        current_module=StocksExchange.const_get(response['market_name'].upcase)
+        response.map{|key,value| current_module.define_singleton_method(key){value}}
+        current_module=nil
+      else
+        StocksExchange.const_set(response['market_name'].upcase, Module.new(response.map{|key,value| define_singleton_method(key){value}}))
+      end
+    end
+    return true
+  end
+
+  #do the initital setup
+  refresh
+
+end

data/lib/stocks_exchange/version.rb

@@ -0,0 +1,3 @@
+module StocksExchange
+  VERSION = "0.1.0"
+end

data/stocks_exchange.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "stocks_exchange/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "stocks_exchange"
+  spec.version       = StocksExchange::VERSION
+  spec.authors       = ["alabeco"]
+  spec.email         = ["alabecocliquebuster@gmail.com"]
+
+  spec.summary       = %q{Ease the use of stocks.exchange public api}
+  spec.description   = %q{Easily consume the public API of https://stocks.exchange to give a ruby friendly version}
+  spec.homepage      = "https://github.com/alabeco/stocks_exchange"
+  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_dependency "httparty","~> 0.15.6"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: stocks_exchange
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alabeco
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.15.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+description: Easily consume the public API of https://stocks.exchange to give a ruby
+  friendly version
+email:
+- alabecocliquebuster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stocks_exchange.rb
+- lib/stocks_exchange/version.rb
+- stocks_exchange.gemspec
+homepage: https://github.com/alabeco/stocks_exchange
+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: Ease the use of stocks.exchange public api
+test_files: []