bittrex 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cd849c0f70e937b817ebf384aba50c95749106e
-  data.tar.gz: 11d2cb28dd38cfc46e2c66b5ecc28ab94eb0704b
+  metadata.gz: 3deff4d67afa6d177474b50f61c96555e01d4237
+  data.tar.gz: 0a0b94bf9f4577c679da4a52a8c0c85d7c4064a1
 SHA512:
-  metadata.gz: 711d86b97047ae0deb9d2979990d3fef5245c0d580da6b8ceeb0eaccb2dcb07499ad041e0eb04870c3624b59f46c0e67f0575c1faa31f8599d3e79d118726f00
-  data.tar.gz: d9d64dba3ac81e59faaf4de5ac19683884e634058d2a236a9cfd00665eee3a0dac0048778e1f1b52f28748b2e5c0cae79d83c755ecbcff3948b9202c6524fd45
+  metadata.gz: 9139ad753901cc960de237d182ee302023fa37c0d4aabca9f3654d085012869fe9a5dd720952ab68163154e95361dbd7f70e159cf4e8a12abc4e724c6b9518aa
+  data.tar.gz: 81491a2f5d641e957287ec4341b4adee5a2919f2b548da9f9cab0a18aa1028a131c8223f54329a479c2674e82fcbdb10545d3b0d05035ba19b8345d504ebfdb6

data/.gitignore

@@ -23,3 +23,6 @@ tmp
 *.a
 mkmf.log
 script
+
+# Ignore application configuration
+/config/application.yml

data/.ruby-version

@@ -0,0 +1 @@
+2.3.3

data/README.md

@@ -16,6 +16,34 @@ Or install it yourself as:
 
     $ gem install bittrex
 
+## Usage
+
+The gem uses a simple mapping of API resources to models, with a majority of the attributes mapped to corresponding attributes on the corresponding class. There are some translations into a more "rubyish" verbage, but for the most part things are directly mapped.
+
+    require 'rubygems'
+    require 'bittrex'
+    >> Quote.current('BTC-LTC')
+    #=> #<Bittrex::Quote:0x000001015cd058 @market="BTC-LTC", @bid=0.015792, @ask=0.01602899, @last=0.015792, @raw={"Bid"=>0.015792, "Ask"=>0.01602899, "Last"=>0.015792}>
+
+## Authentication
+
+You can authenticate access to your Bittrex account by configuring your implementation of the bittrex gem. This is accomplished by using a config block at the top of your application.
+
+Set up your keys at: https://bittrex.com/Manage#sectionApi
+
+    Bittrex.config do |c|
+      c.key = 'my_api_key'
+      c.secret = 'my_api_secret'
+    end
+
+## Development
+
+You can test out public API calls any time by running `bundle exec rake bittrex:console` and inputting your method.
+
+If you want to test private API calls, you will need to create `config/application.yml` and add your Bittrex keys to it (`config/application.yml.example` provides a template for this).
+
+Once you've added the API keys, run `bundle exec rake bittrex:console`
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/bittrex/fork )

data/Rakefile

@@ -1,2 +1,11 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'figaro'
 
+Figaro.application.path = File.expand_path('../config/application.yml', __FILE__)
+Figaro.load
+
+namespace :bittrex do
+  task :console do
+    exec "irb -r bittrex -I ./lib"
+  end
+end

data/bittrex.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "simplecov"
   spec.add_development_dependency "mocha"
+  spec.add_development_dependency "figaro"
 end

data/config/application.yml.example

@@ -0,0 +1,2 @@
+bittrex_api_key: xxx
+bittrex_api_secret: xxx

data/lib/bittrex.rb

@@ -10,7 +10,7 @@ module Bittrex
   autoload :Quote,         'bittrex/quote'
   autoload :Summary,       'bittrex/summary'
   autoload :Wallet,        'bittrex/wallet'
-  autoload :Withdrawl,     'bittrex/withdrawl'
+  autoload :Withdrawal,    'bittrex/withdrawal'
 
   def self.client
     @client ||= Client.new(configuration.auth)

data/lib/bittrex/client.rb

@@ -1,5 +1,6 @@
 require 'faraday'
 require 'base64'
+require 'json'
 
 module Bittrex
   class Client

data/lib/bittrex/configuration.rb

@@ -7,8 +7,8 @@ module Bittrex
     attr_accessor :key, :secret
 
     @@defaults = {
-      key: nil,
-      secret: nil
+      key: ENV['bittrex_api_key'],
+      secret: ENV['bittrex_api_secret']
     }
 
     def self.defaults

data/lib/bittrex/market.rb

@@ -1,3 +1,5 @@
+require 'time'
+
 module Bittrex
   class Market
     attr_reader :name, :currency, :base, :currency_name, :base_name, :minimum_trade, :active, :created_at, :raw

data/lib/bittrex/version.rb

@@ -1,3 +1,3 @@
 module Bittrex
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/bittrex/wallet.rb

@@ -14,7 +14,7 @@ module Bittrex
     end
 
     def self.all
-      client.get('account/getbalances').values.map{|data| new(data) }
+      client.get('account/getbalances').map{|data| new(data) }
     end
 
     private

data/lib/bittrex/{withdrawl.rb → withdrawal.rb}

@@ -1,5 +1,5 @@
 module Bittrex
-  class Withdrawl
+  class Withdrawal
     attr_reader :id, :currency, :quantity, :address, :authorized,
                 :pending, :canceled, :invalid_address,
                 :transaction_cost, :transaction_id, :executed_at

data/spec/models/{withdrawl_spec.rb → withdrawal_spec.rb}

@@ -1,8 +1,8 @@
 require 'spec_helper'
 
-describe Bittrex::Withdrawl do
-  let(:data){ fixture(:withdrawl) }
-  let(:subject){ Bittrex::Withdrawl.new(data) }
+describe Bittrex::Withdrawal do
+  let(:data){ fixture(:withdrawal) }
+  let(:subject){ Bittrex::Withdrawal.new(data) }
 
   describe '#initialization' do
     it { should_assign_attribute(subject, :id, 'c7f7b806-36cf-4xxx-b198-fcdeb1220762') }

data/spec/spec_helper.rb

@@ -10,7 +10,7 @@ Dir[File.join(Bittrex.root, 'spec/support/**/*.rb')].each {|f| require f}
 
 RSpec.configure do |config|
   config.before(:each) do
-    Bittrex.stub(:client)
+    allow(Bittrex).to receive(:client)
   end
 end
 
@@ -20,5 +20,5 @@ def fixture(resource)
 end
 
 def should_assign_attribute(subject, method, value)
-  subject.send(method).should eq(value)
+  expect(subject.send(method)).to eq(value)
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bittrex
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Matthew Werner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-26 00:00:00.000000000 Z
+date: 2017-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: figaro
+  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: API Client for the Bittrex API
 email:
 - m@mjw.io
@@ -102,11 +116,13 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bittrex.gemspec
+- config/application.yml.example
 - lib/bittrex.rb
 - lib/bittrex/client.rb
 - lib/bittrex/configuration.rb
@@ -118,7 +134,7 @@ files:
 - lib/bittrex/summary.rb
 - lib/bittrex/version.rb
 - lib/bittrex/wallet.rb
-- lib/bittrex/withdrawl.rb
+- lib/bittrex/withdrawal.rb
 - spec/fixtures/currency.json
 - spec/fixtures/deposit.json
 - spec/fixtures/market.json
@@ -126,7 +142,7 @@ files:
 - spec/fixtures/quote.json
 - spec/fixtures/summary.json
 - spec/fixtures/wallet.json
-- spec/fixtures/withdrawl.json
+- spec/fixtures/withdrawal.json
 - spec/models/configuration_spec.rb
 - spec/models/currency_spec.rb
 - spec/models/deposit_spec.rb
@@ -135,7 +151,7 @@ files:
 - spec/models/quote_spec.rb
 - spec/models/summary_spec.rb
 - spec/models/wallet_spec.rb
-- spec/models/withdrawl_spec.rb
+- spec/models/withdrawal_spec.rb
 - spec/spec_helper.rb
 - spec/support/api_helper.rb
 homepage: https://github.com/mwerner/bittrex
@@ -158,7 +174,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: API Client for the Bittrex API
@@ -170,7 +186,7 @@ test_files:
 - spec/fixtures/quote.json
 - spec/fixtures/summary.json
 - spec/fixtures/wallet.json
-- spec/fixtures/withdrawl.json
+- spec/fixtures/withdrawal.json
 - spec/models/configuration_spec.rb
 - spec/models/currency_spec.rb
 - spec/models/deposit_spec.rb
@@ -179,6 +195,6 @@ test_files:
 - spec/models/quote_spec.rb
 - spec/models/summary_spec.rb
 - spec/models/wallet_spec.rb
-- spec/models/withdrawl_spec.rb
+- spec/models/withdrawal_spec.rb
 - spec/spec_helper.rb
 - spec/support/api_helper.rb