exmo_api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03d087b99e91c18cf049f4d8542cf5df9c6f5ac188e709436f805aac51587aed
-  data.tar.gz: 3c9745dcb0fc537d38984d5f9bfe51cbb4eb7aa8fb1f0e4851e4fd6f073d5f2b
+  metadata.gz: dd4943d99b314e94a8528a4c41c9bc18b855b9f733ca5514ce1c38baff1aba81
+  data.tar.gz: 8f4ba5c8d8879c825328df6b7c94ddaae2a962d5409da127648f261116dade40
 SHA512:
-  metadata.gz: 8844c73b7d15533658d99e2d867580ed7cba22d557179e6452c6f667425d879bfa70328662aace6e13a901ccb4f118d30431e9d8d908c6be78448df4991076a7
-  data.tar.gz: '068b36ce20b1fafedd03e72d3c7e2df36a2245366b768d06d829045824b912cb9b4340a417c4f11bbeb124f7465c5a056e6a216a3a3d4e8cb298de0c23a237ae'
+  metadata.gz: 6b94dee993fbf18bce700e9ca2a26e4b0311638272433ca79a545a4abadf64890f2583bda35ffbf95196d3dfdf101254e1f921ce6969c25bf083448f52f67e00
+  data.tar.gz: a62cb34e7c0098a435ca93659c0517d0f99acf15d61579636eca72d4346e114cc54b54f1f445760fdccdfc8c84a47366bc39cde63549f876b6a71eb3583995f5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    exmo_api (0.1.0)
+    exmo_api (0.1.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,8 +1,10 @@
-# ExmoApi
+[![Build Status](https://semaphoreci.com/api/v1/igormalinovskiy/exmo_api/branches/master/shields_badge.svg)](https://semaphoreci.com/igormalinovskiy/exmo_api)
+[![Code Climate](https://codeclimate.com/github/psyipm/exmo_api/badges/gpa.svg)](https://codeclimate.com/github/psyipm/exmo_api)
+[![Gem Version](https://badge.fury.io/rb/exmo_api.svg)](https://badge.fury.io/rb/exmo_api)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/exmo_api`. To experiment with that code, run `bin/console` for an interactive prompt.
+# ExmoApi
 
-TODO: Delete this and the text above, and describe your gem
+This gem is a simple wrapper for Exmo.com exchange API. Please, refer to [official documentation](https://exmo.com/en/api) for detailed API methods description.
 
 ## Installation
 
@@ -20,9 +22,68 @@ Or install it yourself as:
 
     $ gem install exmo_api
 
+## Configuration
+
+Configure your gem if you want to use private API methods:
+
+```ruby
+# config/initializers/exmo_api.rb
+
+ExmoApi.setup do |config|
+  config.api_key = 'your_api_key'
+  config.api_secret = 'your_api_secret'
+end
+```
+
+There is some additional configuration options available. These options are set by default:
+
+```ruby
+ExmoApi.setup do |config|
+  # API endpoint can be changed via configuration
+  #
+  config.api_endpoint = 'https://api/exmo.com/v1'
+
+  # Public methods list can also be changed
+  #
+  public_api_methods = [
+    :trades,
+    :order_book,
+    :ticker,
+    :pair_settings,
+    :currency
+  ]
+end
+```
+
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+  request = ExmoApi::Request.new(:ticker)
+
+  request.perform
+  {
+    "BTC_USD"=>{
+      "buy_price"=>"6559.79",
+      "sell_price"=>"6569",
+      "last_trade"=>"6559.79000001",
+      "high"=>"6591.15652728",
+      "low"=>"6414",
+      "avg"=>"6508.36792358",
+      "vol"=>"789.26528294",
+      "vol_curr"=>"5177414.51040588",
+      "updated"=>1535105637
+    },
+    #  ... truncated ...
+  }
+```
+
+```ruby
+  r = ExmoApi::Request.new(:currency)
+  => #<ExmoApi::Request:0x00007f9af8814080 @api_method=:currency, @params={}>
+
+  r.perform
+  => ["USD", "EUR", "RUB", "PLN", "UAH", "BTC", "LTC", "DOGE", "DASH", "ETH", "WAVES", "ZEC", "USDT", "XMR", "XRP", "KICK", "ETC", "BCH", "BTG", "EOS", "HBZ", "BTCZ", "DXT", "STQ", "XLM", "MNX", "OMG", "TRX", "ADA", "INK"]
+```
 
 ## Development
 

data/lib/exmo_api.rb

@@ -5,6 +5,7 @@ require 'exmo_api/version'
 module ExmoApi
   autoload :Config, 'exmo_api/config'
   autoload :Request, 'exmo_api/request'
+  autoload :Client, 'exmo_api/client'
 
   def self.configuration
     @configuration ||= Config.new

data/lib/exmo_api/client.rb

@@ -0,0 +1,16 @@
+module ExmoApi
+  class Client
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+    end
+
+    def call(api_method, params)
+      request = ExmoApi::Request.new(api_method, params)
+      request.config = config
+
+      request.perform
+    end
+  end
+end

data/lib/exmo_api/request.rb

@@ -7,6 +7,7 @@ require 'openssl'
 module ExmoApi
   class Request
     attr_reader :api_method
+    attr_writer :config
 
     def initialize(api_method, params = {})
       @api_method = api_method
@@ -65,7 +66,7 @@ module ExmoApi
     end
 
     def config
-      ExmoApi.configuration
+      @config ||= ExmoApi.configuration
     end
   end
 end

data/lib/exmo_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ExmoApi
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exmo_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Igor Malinovskiy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-23 00:00:00.000000000 Z
+date: 2019-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -168,6 +168,7 @@ files:
 - bin/setup
 - exmo_api.gemspec
 - lib/exmo_api.rb
+- lib/exmo_api/client.rb
 - lib/exmo_api/config.rb
 - lib/exmo_api/request.rb
 - lib/exmo_api/version.rb