bitcoinaverage 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+Gemfile.lock
+coverage/*
+log/*
+*.gem
+mysession
+mysession.vim

data/.travis.yml

@@ -0,0 +1,6 @@
+bundler_args: --without development
+language: ruby
+rvm:
+  - 1.9.3-p374
+  - 2.0.0-rc1
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,18 @@
+# A sample Gemfile
+source "https://rubygems.org"
+
+gem 'httparty'
+gem 'json'
+group :development do
+  gem 'pry'
+  gem 'pry-nav'
+end
+
+group :test do
+  gem 'rspec', '>= 2.14'
+  gem 'coveralls', require: false
+  gem 'webmock'
+  gem 'simplecov'
+end
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Toni Urcola
+
+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,75 @@
+# Ruby wrapper for the BitcoinAverage API
+
+[![Gem Version]][gem]
+[![Coverage Status](https://coveralls.io/repos/git-toni/bitcoinaverage/badge.png)](https://coveralls.io/r/git-toni/bitcoinaverage)
+[gem]: https://rubygems.org/gems/bitcoinaverage
+[travis]: https://github.com/git-toni/bitcoinaverage
+
+
+
+Bitcoinaverage is an independent 'globally averaged bitcoin price' provider. They provide a **Global** price,
+based on the volume and price of BTC in all currencies, together with a **Market** price, which only takes into account
+the volume of BTC directly exchangeable through that specific currency.
+For more information on the methods BitcoinAverage uses to calculate the price, please refer to their website, in
+particular [this page](https://bitcoinaverage.com/explain.htm).
+
+## Important first note
+The development of this gem has been *deeply* inspired by Erik Michaels-Ober's great [mtgox](https://github.com/sferik/mtgox) gem ( specially this README ;) ).
+
+## Installation
+    gem install bitcoinaverage
+
+
+## Documentation
+TODO
+
+## Usage 
+```ruby
+require 'rubygems'
+require 'bitcoinaverage'
+
+# Obtain the BitcoinAverage's global price
+BitcoinAverage.global
+
+# Obtain the BitcoinAverage's market price
+BitcoinAverage.market
+
+# Obtain the BitcoinAverage's global price in EUR
+BitcoinAverage.global 'EUR'
+
+# Obtain the BitcoinAverage's market price in GBP
+BitcoinAverage.market 'GBP'
+
+# Obtain the specific fields of BitcoinAverage's global price
+BitcoinAverage.global.last
+BitcoinAverage.global.bid
+BitcoinAverage.global.ask
+BitcoinAverage.global.volume_btc
+BitcoinAverage.global.volume_percent
+```
+
+## Tested Ruby Versions
+This library aims to support and is [tested against][travis] the following Ruby
+implementations:
+
+* ruby-1.9.3-p374
+* ruby-2.0.0-rc1
+* ruby-2.1.0
+
+## Contributing
+In the spirit of [free software](http://www.fsf.org/licensing/essays/free-sw.html), **everyone** is encouraged to help improve this project.
+
+Here are some ways *you* can contribute:
+
+* by using alpha, beta, and prerelease versions
+* by reporting bugs
+* by suggesting new features
+* by writing or editing documentation
+* by writing specifications
+* by writing code (**no patch is too small**: fix typos, add comments, clean up inconsistent whitespace)
+* by refactoring code
+* by closing [issues](http://github.com/Instagram/instagram-ruby-gem/issues)
+* by reviewing patches
+
+## Copyright
+Copyright (c) 2014 Toni Urcola. See [LICENSE](https://github.com/git-toni/bitcoinaverage/LICENSE) for details.

data/bitcoinaverage.gemspec

@@ -0,0 +1,21 @@
+$:.push File.expand_path("../lib", __FILE__)
+require 'bitcoinaverage/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'bitcoinaverage'
+  s.version     = BitcoinAverage::VERSION
+  s.summary     = "Ruby Wrapper for the Bitcoinaverage API"
+  s.description = "Ruby wrapper for the Bitcoinaverage API. Bitcoinaverage is an independent 'globally averaged bitcoin price' provider"
+  s.author      = ["Toni Urcola"]
+  s.email       = 'unmail.toni@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.test_files  = `git ls-files -- {test,spec}/*`.split("\n")
+  s.require_paths = ["lib"]
+  s.required_ruby_version = '>= 1.9.3'
+  s.add_dependency 'httparty'
+  s.add_dependency 'json'
+  s.add_development_dependency 'rspec'
+  s.add_development_dependency 'bundler'
+  s.homepage    = 'http://rubygems.org/gems/bitcoinaverage'
+  s.license       = 'MIT'
+end

data/lib/bitcoinaverage.rb

@@ -0,0 +1,11 @@
+require 'bitcoinaverage/market_ticker'
+require 'bitcoinaverage/global_ticker'
+
+module BitcoinAverage
+    def self.global(currency="USD")
+        GlobalTicker.instance.request_info currency
+    end
+    def self.market(currency="USD")
+        MarketTicker.instance.request_info currency
+    end
+end

data/lib/bitcoinaverage/available_currencies.csv

@@ -0,0 +1 @@
+AED,AFN,ALL,AMD,ANG,AOA,ARS,AUD,AWG,AZN,BAM,BBD,BDT,BGN,BHD,BIF,BMD,BND,BOB,BRL,BSD,BTC,BTN,BWP,BYR,BZD,CAD,CDF,CHF,CLF,CLP,CNY,COP,CRC,CUP,CVE,CZK,DJF,DKK,DOP,DZD,EEK,EGP,ERN,ETB,EUR,FJD,FKP,GBP,GEL,GHS,GIP,GMD,GNF,GTQ,GYD,HKD,HNL,HRK,HTG,HUF,IDR,ILS,INR,IQD,IRR,ISK,JEP,JMD,JOD,JPY,KES,KGS,KHR,KMF,KPW,KRW,KWD,KYD,KZT,LAK,LBP,LKR,LRD,LSL,LTL,LVL,LYD,MAD,MDL,MGA,MKD,MMK,MNT,MOP,MRO,MTL,MUR,MVR,MWK,MXN,MYR,MZN,NAD,NGN,NIO,NOK,NPR,NZD,OMR,PAB,PEN,PGK,PHP,PKR,PLN,PYG,QAR,RON,RSD,RUB,RWF,SAR,SBD,SCR,SDG,SEK,SGD,SHP,SLL,SOS,SRD,STD,SVC,SYP,SZL,THB,TJS,TMT,TND,TOP,TRY,TTD,TWD,TZS,UAH,UGX,USD,UYU,UZS,VEF,VND,VUV,WST,XAF,XAG,XAU,XCD,XDR,XOF,XPF,YER,ZAR,ZMK,ZMW,ZWL

data/lib/bitcoinaverage/global_ticker.rb

@@ -0,0 +1,12 @@
+require 'bitcoinaverage/ticker'
+require 'singleton'
+
+module BitcoinAverage
+  class GlobalTicker < BitcoinAverage::Ticker
+    include Singleton
+    attr_accessor :volume_btc, :volume_percent
+    def avg_type
+      'global'
+    end
+  end
+end

data/lib/bitcoinaverage/market_ticker.rb

@@ -0,0 +1,12 @@
+require 'bitcoinaverage/ticker'
+require 'singleton'
+
+module BitcoinAverage
+  class MarketTicker < BitcoinAverage::Ticker
+    include Singleton
+    attr_accessor :total_vol
+    def avg_type
+      'market'
+    end
+  end
+end

data/lib/bitcoinaverage/requester.rb

@@ -0,0 +1,37 @@
+require 'httparty'
+
+module BitcoinAverage
+  module Requester
+    def sendrequest(average,currency='USD')
+      raise "#{currency} is not a known currency" unless known_currency?(currency)
+      base_url='https://api.bitcoinaverage.com/ticker/'
+      avg_url= average == 'global'? average+'/' : ''
+      ccy_url=currency
+      final_url= base_url+avg_url+ccy_url
+
+      response=HTTParty.get final_url
+    end
+
+    def known_currency?(currency)
+      av_currencies=File.open('lib/bitcoinaverage/available_currencies.csv','r')
+      .read
+      .parse_csv
+      true unless !av_currencies.include? currency
+    end
+
+    #Method to obtain all the available currencies
+    #
+    #Note: it's not run repeatedly, rather the result 
+    #was written to a file.
+    #Note 2: "require 'csv' " is necessary for this method
+    #
+    #
+    #def available_currencies
+    #  all_ccy=HTTParty.get 'https://api.bitcoinaverage.com/ticker/global/all'
+    #  all_ccy.map!{|k,v| k}
+    #  file= File.open 'currencies_file.csv','w'
+    #  file.write all_ccy[0..-2].to_csv
+    #  file.close
+    #end
+  end
+end

data/lib/bitcoinaverage/ticker.rb

@@ -0,0 +1,26 @@
+require 'bitcoinaverage/requester'
+require 'json'
+
+module BitcoinAverage
+  class Ticker
+    include BitcoinAverage::Requester
+    attr_accessor :avg_24h, :ask, :bid, :last, :timestamp
+
+    def request_info currency='USD'
+      response= sendrequest self.avg_type, currency
+      if response.success?
+        #Small patch since an attribute can't be named "24h_avg"
+        response=JSON.load(response.to_s) unless response.is_a?(Hash)
+        self.avg_24h = response["24h_avg"] 
+        response.delete("24h_avg")
+        #binding.pry
+        response.each do |key,value|
+          send("#{key}=",value)
+        end
+        self
+      else
+        raise "Error receiving response"#<- to be extended
+      end
+    end
+  end
+end

data/lib/bitcoinaverage/version.rb

@@ -0,0 +1,3 @@
+module BitcoinAverage
+  VERSION = "0.0.1"
+end

data/spec/bitcoinaverage_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+require 'bitcoinaverage'
+
+SimpleCov.start
+describe BitcoinAverage do
+  describe '.global ' do
+    before do
+      stub_request(:get, "https://api.bitcoinaverage.com/ticker/global/USD").
+        to_return(status:200, body: fixture('global_USD.json'),headers:{})
+      @response=BitcoinAverage.global
+    end
+    it 'returns a GlobalTicker object properly filled' do
+      #binding.pry
+      #expect(BitcoinAverage.global).to be_a BitcoinAverage::GlobalTicker
+      expect(@response).to be_a BitcoinAverage::GlobalTicker
+      @response.avg_24h.should == 568.44
+      @response.ask.should == 566.15
+      @response.bid.should == 563.83
+      @response.last.should == 564.61
+      @response.timestamp.should == 'Fri, 21 Feb 2014 16:22:17 -0000'
+      @response.volume_btc.should == 100496.08
+      @response.volume_percent.should == 79.49
+    end
+  end
+  describe '.market ' do
+    before do
+      stub_request(:get, "https://api.bitcoinaverage.com/ticker/USD").
+        to_return(status:200, body: fixture('market_USD.json'),headers:{})
+      @response=BitcoinAverage.market
+    end
+    it 'returns a GlobalTicker object properly filled' do
+      #binding.pry
+      #expect(BitcoinAverage.global).to be_a BitcoinAverage::GlobalTicker
+      expect(@response).to be_a BitcoinAverage::MarketTicker
+      @response.avg_24h.should == 565.89
+      @response.ask.should == 562.54
+      @response.bid.should == 559.7
+      @response.last.should == 560.54
+      @response.timestamp.should == 'Fri, 21 Feb 2014 16:24:27 -0000'
+      @response.total_vol.should == 100667.13
+    end
+  end
+  describe 'unknown currency' do
+    before do
+      stub_request(:get, "https://api.bitcoinaverage.com/ticker/EEE").
+        to_return(status:404, body:"", headers:{})
+    end
+    it 'raises an error' do
+      expect{BitcoinAverage.market('EEE')}.to raise_error("EEE is not a known currency")
+    end
+  end
+end

data/spec/fixtures/global_EUR.json

@@ -0,0 +1,9 @@
+{
+  "24h_avg": 414.43,
+  "ask": 411.77,
+  "bid": 410.41,
+  "last": 410.77,
+  "timestamp": "Fri, 21 Feb 2014 16:23:25 -0000",
+  "volume_btc": 4337.36,
+  "volume_percent": 3.43
+}

data/spec/fixtures/global_USD.json

@@ -0,0 +1,9 @@
+{
+  "24h_avg": 568.44,
+  "ask": 566.15,
+  "bid": 563.83,
+  "last": 564.61,
+  "timestamp": "Fri, 21 Feb 2014 16:22:17 -0000",
+  "volume_btc": 100496.08,
+  "volume_percent": 79.49
+}

data/spec/fixtures/market_EUR.json

@@ -0,0 +1,8 @@
+{
+  "24h_avg": 419.29,
+  "ask": 420.16,
+  "bid": 417.84,
+  "last": 418.17,
+  "timestamp": "Fri, 21 Feb 2014 16:24:27 -0000",
+  "total_vol": 4335.29
+}

data/spec/fixtures/market_USD.json

@@ -0,0 +1,8 @@
+{
+  "24h_avg": 565.89,
+  "ask": 562.54,
+  "bid": 559.7,
+  "last": 560.54,
+  "timestamp": "Fri, 21 Feb 2014 16:24:27 -0000",
+  "total_vol": 100667.13
+}

data/spec/spec_helper.rb

@@ -0,0 +1,23 @@
+#require 'pry'
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.start 
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+#Coveralls.wear!
+
+
+require 'pry'
+require 'rspec'
+require 'webmock/rspec'
+WebMock.disable_net_connect!(allow:'coverwalls.io',allow_localhost:true)
+
+def fixture_path
+  File.expand_path('../fixtures', __FILE__)
+end
+def fixture(file)
+  File.new(fixture_path + '/' + file)
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: bitcoinaverage
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Toni Urcola
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for the Bitcoinaverage API. Bitcoinaverage is an independent
+  'globally averaged bitcoin price' provider
+email: unmail.toni@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .bitcoinaverage.gemspec.swp
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- bitcoinaverage.gemspec
+- coverage/.last_run.json
+- coverage/.resultset.json
+- coverage/assets/0.8.0/application.css
+- coverage/assets/0.8.0/application.js
+- coverage/assets/0.8.0/colorbox/border.png
+- coverage/assets/0.8.0/colorbox/controls.png
+- coverage/assets/0.8.0/colorbox/loading.gif
+- coverage/assets/0.8.0/colorbox/loading_background.png
+- coverage/assets/0.8.0/favicon_green.png
+- coverage/assets/0.8.0/favicon_red.png
+- coverage/assets/0.8.0/favicon_yellow.png
+- coverage/assets/0.8.0/loading.gif
+- coverage/assets/0.8.0/magnify.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_dadada_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
+- coverage/assets/0.8.0/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_222222_256x240.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_2e83ff_256x240.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_454545_256x240.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_888888_256x240.png
+- coverage/assets/0.8.0/smoothness/images/ui-icons_cd0a0a_256x240.png
+- coverage/index.html
+- lib/bitcoinaverage.rb
+- lib/bitcoinaverage/available_currencies.csv
+- lib/bitcoinaverage/global_ticker.rb
+- lib/bitcoinaverage/market_ticker.rb
+- lib/bitcoinaverage/requester.rb
+- lib/bitcoinaverage/ticker.rb
+- lib/bitcoinaverage/version.rb
+- mysession
+- spec/bitcoinaverage_spec.rb
+- spec/fixtures/global_EUR.json
+- spec/fixtures/global_USD.json
+- spec/fixtures/market_EUR.json
+- spec/fixtures/market_USD.json
+- spec/spec_helper.rb
+homepage: http://rubygems.org/gems/bitcoinaverage
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby Wrapper for the Bitcoinaverage API
+test_files: []
+has_rdoc: