waffle_api 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b37de94f955112e583f831d8a16ef579c1afc5ec
-  data.tar.gz: e1ae1d9128a4835d55610e2b475c4b64a79911b8
+  metadata.gz: 1fad819993b7da91f6552c4a5248d5135c80152a
+  data.tar.gz: 0e25efe461072be56c26cd0b736ddb8815aa4303
 SHA512:
-  metadata.gz: 15f87d7fe974b901553c758274cdf48dcd5affd67c4214349f3b74d374624a520bed35c09e6d67e4459eb440f2e206215d7d91941bed4c90764ce3fa78cd9559
-  data.tar.gz: f15a48e4b2a09c51841cf1099b4c3152e5579cef02de7b8cd50e7bf4d77dfce7de27f70d73f73097fda07c3fff91269f9e52b08e2576ee4154a73b324cc0991d
+  metadata.gz: 82607fe7ec0d0279ed86aabbd135e2d272868643af918f765038eece6585cab8a2cb04157a9236bf16ad1d485f4c400a52a5c232133d7f6cc89a58e63e3266f2
+  data.tar.gz: 708e73919a1190d8b6b234875fc3a8b19c3c523a78129ad20cdfb7b3c034ceb9028fb9e6f071285e78535a74aaa50dc156f0c44793ae08f18dee9eeb216496bd

data/.travis.yml

@@ -1,4 +1,10 @@
 language: ruby
+
+addons:
+  code_climate:
+    repo_token:
+      secure: I1x0uh8d7/sfhmTJA3+V4w/2X55nT4+jLTqiTiIVJHSRhbMts+SJr8DTDUHYlOENIX5ZNzZjDY2LkD3tpC98ysxwyAq3gx3lA6HDE5aTbBuzOuQgkm8nxkMBy7NaBYCwmEldaZxsefL8qmV2omAxsmdoGnFAV5Ozhue8Bv8EjkU=
+
 cache: bundler
 rvm:
   - 2.0.0

data/README.md

@@ -23,81 +23,86 @@ client = WaffleAPI::Client.new address: '1Ju8U9Ukfc5kiMqzQrRgQBP1JvRkeSv94V'
 ```
 
 
-### Get current total hashrate
+### WaffleAPI::Client
 ```ruby
+# Hash rate in H/s
 client.hashrate
-```
+#=> 1_234_567
 
+# List of all workers
+workers = client.workers
+#=> [ #<WaffleAPI::Worker>, #<WaffleAPI::Worker>, ... ]
 
-### Get workers infos
+# Current balances
+balances = client.balances
+#=> #<WaffleAPI::Balances>
 
-```ruby
-client.worker_hashrates
+# 10 last recent payments
+payments = client.payments
+#=> [ #<WaffleAPI::Payment>, #<WaffleAPI::Payment>, ... ]
 ```
 
-Will return a JSON array
-
-```json
-[
-  {
-    "username": "1Ju8U9Ukfc5kiMqzQrRgQBP1JvRkeSv94V_calyhrerig1",
-    "hashrate": 2529705,
-    "stalerate": 3.33,
-    "last_seen": 1398022030,
-    "str": "2.53 MH/s"
-  },
-  {
-    "username": "1Ju8U9Ukfc5kiMqzQrRgQBP1JvRkeSv94V_dqmsrig1",
-    "hashrate": 1773702,
-    "stalerate": 1.61,
-    "last_seen": 1398022030,
-    "str": "1.77 MH/s"
-  }
-]
-```
+### WaffleAPI::Worker
+```ruby
+worker = workers.first
+#=> #<WaffleAPI::Worker>
 
+# Worker name, without an underscore in it
+worker.name
+#=> 1Ju8U9Ukfc5kiMqzQrRgQBP1JvRkeSv94V
 
-### Get balances
+# Worker name, with an underscore in it e.g: 1Ju8U...94V_worker0
+worker.name
+#=> worker0
 
-```ruby
-client.balances
-```
+# Hash rate in H/s
+worker.hash_rate
+#=> 723_456
 
-Will return a JSON array
+# Stale rate in %
+worker.stale_rate
+#=> 3.6
 
-```json
-{
-  "sent": 1.61039009,
-  "confirmed": 0.00383488,
-  "unconverted": 0.011964213459441
-}
+# Last seen
+worker.last_seen
+#=> 2014-03-13 20:22:42 +0100
 ```
 
+### WaffleAPI::Balances
+```ruby
+# BTC already paid
+balances.sent
+#=> 1.623456
 
-### Get payments
+# BTC confirmed but not yet paid
+balances.confirmed
+#=> 0.012345
 
-```ruby
-client.recent_payments
+# BTC not yet converted (approximate)
+balances.unconverted
+#=> 0.012345
+
+# Expected BTC (confirmed + unconverted, approximate)
+balances.expected
+#=> 0.02469
 ```
 
-Will return a JSON array containing the last 10 payments
-
-```json
-[
-  {
-    "amount": "0.01715311",
-    "time": "2014-04-20 16:03:24",
-    "txn": "8706e0a..."
-  },
-  {
-    "amount": "0.01600557",
-    "time": "2014-04-20 04:36:01",
-    "txn": "258dda8..."
-  },
-  {
-    "..."
-  }
-]
+### WaffleAPI::Payment
+```ruby
+payment = payments.first
+#=> #<WaffleAPI::Payment>
+
+# Payment amount
+payment.amount
+#=> 0.02469
+
+# Payment paid date
+payment.paid_at
+#=> 2014-03-13 20:22:42 +0100
+
+# Payment transaction hash
+payment.transaction_hash
+#=> "4a5e1e4baab89f3a32518a88c31bc87f618f76673e2cc77ab2127b7afdeda33b"
 ```
 
 

data/lib/waffle_api/balances.rb

@@ -0,0 +1,13 @@
+module WaffleAPI
+  # Balances object give access to all balances from Wafflepool
+  class Balances
+    attr_reader :sent, :confirmed, :unconverted, :expected
+
+    def initialize(sent: 0.0, confirmed: 0.0, unconverted: 0.0)
+      @sent        = sent
+      @confirmed   = confirmed
+      @unconverted = unconverted
+      @expected    = @confirmed + @unconverted
+    end
+  end
+end

data/lib/waffle_api/client.rb

@@ -1,5 +1,8 @@
 require 'waffle_api/helpers'
 require 'waffle_api/address_validator'
+require 'waffle_api/worker'
+require 'waffle_api/balances'
+require 'waffle_api/payment'
 
 module WaffleAPI
   # A Ruby class to call the Waffle stat API. You might use this if you want to
@@ -14,20 +17,51 @@ module WaffleAPI
     include WaffleAPI::Helpers
     include WaffleAPI::AddressValidator
 
-    attr_accessor :address, :https_only
+    attr_accessor :address
 
-    def initialize(address: nil, ignore_bad_address: false)
+    def initialize(address: nil)
       @address   = address || ENV['BTC_ADDRESS']
-      @https_only = https_only
 
       fail Error::EmptyAddress if @address.nil? || @address.empty?
-      fail Error::BadAddress, @address unless valid_address? || ignore_bad_address
+      fail Error::BadAddress, @address unless valid_address?
     end
 
     def hashrate
       stats 'hash_rate'
     end
 
+    def workers
+      stats('worker_hashrates').map do |worker|
+        WaffleAPI::Worker.new(
+          name: worker['username'],
+          hash_rate: worker['hashrate'],
+          stale_rate: worker['stalerate'],
+          last_seen: worker['last_seen']
+        )
+      end
+    end
+
+    def balances
+      balances = stats 'balances'
+
+      WaffleAPI::Balances.new(
+        sent: balances['sent'],
+        confirmed: balances['confirmed'],
+        unconverted: balances['unconverted']
+      )
+    end
+
+    def payments
+      stats('recent_payments').map do |payment|
+        WaffleAPI::Payment.new(
+          amount: payment['amount'],
+          paid_at: payment['time'],
+          transaction_hash: payment['txn']
+        )
+      end
+    end
+
+    # This is for not yet suported keys
     def method_missing(method, *args, &block)
       stats method.to_s
     rescue Error::UnknownKey

data/lib/waffle_api/payment.rb

@@ -0,0 +1,13 @@
+module WaffleAPI
+  # Payment object give access to recent payments from Wafflepool. It give
+  # access to amount, paid_at and transaction_hash
+  class Payment
+    attr_reader :amount, :paid_at, :transaction_hash
+
+    def initialize(amount: 0.0, paid_at: Time.now.to_s, transaction_hash: '')
+      @amount = amount
+      @paid_at = DateTime.parse(paid_at).to_time
+      @transaction_hash = transaction_hash
+    end
+  end
+end

data/lib/waffle_api/version.rb

@@ -1,4 +1,4 @@
 # WaffleAPI Version
 module WaffleAPI
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

data/lib/waffle_api/worker.rb

@@ -0,0 +1,14 @@
+module WaffleAPI
+  # Worker object give access to it's hashrate, stalerate, etc...
+  class Worker
+    attr_reader :name, :hash_rate, :stale_rate, :last_seen
+
+    def initialize(name: '', hash_rate: 0, stale_rate: 0.0, last_seen: 0)
+      @name = name.split('_', 2).last
+      @name = name if @name.nil? || @name.empty?
+      @hash_rate = hash_rate
+      @stale_rate = stale_rate
+      @last_seen = Time.at(last_seen)
+    end
+  end
+end

data/spec/factories.rb

@@ -0,0 +1,26 @@
+FactoryGirl.define do
+  factory :worker, class: WaffleAPI::Worker do
+    name       { Faker::Bitcoin.address }
+    hash_rate  { Faker::Number.number(7).to_i }
+    stale_rate { Faker::Number.decimal(1).to_f }
+    last_seen  { Time.now.to_i }
+
+    initialize_with { new(attributes) }
+  end
+
+  factory :payment, class: WaffleAPI::Payment do
+    amount           { Faker::Number.decimal(0, 6).to_f }
+    paid_at          { Time.now.to_s }
+    transaction_hash { Faker::Lorem.characters(64) }
+
+    initialize_with { new(attributes) }
+  end
+
+  factory :balances, class: WaffleAPI::Balances do
+    sent        { Faker::Number.decimal(1, 6).to_f }
+    confirmed   { Faker::Number.decimal(0, 6).to_f }
+    unconverted { Faker::Number.decimal(0, 6).to_f }
+
+    initialize_with { new(attributes) }
+  end
+end

data/spec/lib/waffle_api/balances_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe WaffleAPI::Balances do
+  subject { build :balances }
+
+  it 'should have expected attributes' do
+    subject.should respond_to :sent
+    subject.should respond_to :confirmed
+    subject.should respond_to :unconverted
+    subject.should respond_to :expected
+  end
+
+  it 'should correctly set expected' do
+    subject.expected.should == subject.confirmed + subject.unconverted
+  end
+end

data/spec/lib/waffle_api/client_spec.rb

@@ -17,47 +17,87 @@ describe WaffleAPI::Client do
     end
   end
 
-  describe 'with a valid address' do
+  describe 'If wafflepool has moved his api endpoint' do
+    subject do
+      stub_waffle_with Wafflepool::EndPointMoved
+      WaffleAPI::Client.new address: BTC_ADDRESS
+    end
+
+    it 'raises WaffleAPI::Error::EndPointMoved' do
+      expect do
+        subject.hashrate
+      end.to raise_error(WaffleAPI::Error::EndPointMoved)
+    end
+  end
+
+  describe 'with address which not exist on waffle' do
+    subject do
+      stub_waffle_with Wafflepool::AddressNotFound
+      WaffleAPI::Client.new address: BTC_ADDRESS
+    end
+
+    it 'raises WaffleAPI::Error::AddressNotFound' do
+      expect do
+        subject.hashrate
+      end.to raise_error(WaffleAPI::Error::AddressNotFound)
+    end
+  end
+
+  describe 'with a not yet supported error' do
     subject do
+      stub_waffle_with Wafflepool::UnknownError
       WaffleAPI::Client.new address: BTC_ADDRESS
     end
 
-    describe 'which not exist on waffle' do
-      it 'raises WaffleAPI::Error::AddressNotFound' do
-        stub_waffle_with Wafflepool::AddressNotFound
+    it 'raises WaffleAPI::Error::UnknownError' do
+      expect do
+        subject.hashrate
+      end.to raise_error(WaffleAPI::Error::UnknownError)
+    end
+  end
+
+  describe 'with a valid address' do
+    subject do
+      stub_waffle_with Wafflepool::Success
+      WaffleAPI::Client.new address: BTC_ADDRESS
+    end
 
+    describe 'asking for a non existing key' do
+      it 'raises NoMethodError' do
         expect do
-          subject.hashrate
-        end.to raise_error(WaffleAPI::Error::AddressNotFound)
+          subject.i_hope_this_key_will_never_exist
+        end.to raise_error(NoMethodError)
       end
     end
 
-    describe 'which exist on waffle' do
-      describe 'with a not yet supported error' do
-        it 'raises WaffleAPI::Error::UnknownError' do
-          stub_waffle_with Wafflepool::UnknownError
-
-          expect do
-            subject.i_hope_this_key_will_never_exist
-          end.to raise_error(WaffleAPI::Error::UnknownError)
-        end
+    describe 'hashrate' do
+      it 'returns correct hashrate' do
+        subject.hash_rate.should == 4_303_407
       end
 
-      describe 'asking for a non existing key' do
-        it 'raises NoMethodError' do
-          stub_waffle_with Wafflepool::Success
+      it 'returns correct hashrate' do
+        subject.hash_rate.should == 4_303_407
+      end
+    end
 
-          expect do
-            subject.i_hope_this_key_will_never_exist
-          end.to raise_error(NoMethodError)
+    describe 'workers' do
+      it 'returns an array of WaffleAPI::Worker' do
+        subject.workers.each do |worker|
+          worker.should be_an_instance_of WaffleAPI::Worker
         end
       end
+    end
 
-      describe 'asking for an existing key' do
-        it 'just return it' do
-          stub_waffle_with Wafflepool::Success
+    describe 'balances' do
+      it 'returns an instance of WaffleAPI::Balnaces' do
+        subject.balances.should be_an_instance_of WaffleAPI::Balances
+      end
+    end
 
-          expect(subject.hashrate).to eq 4_303_407
+    describe 'payments' do
+      it 'returns an array of WaffleAPI::Payment' do
+        subject.payments.each do |payment|
+          payment.should be_an_instance_of WaffleAPI::Payment
         end
       end
     end

data/spec/lib/waffle_api/payment_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe WaffleAPI::Payment do
+  subject { build :payment }
+
+  it 'should have expected attributes' do
+    subject.should respond_to :amount
+    subject.should respond_to :paid_at
+    subject.should respond_to :transaction_hash
+  end
+
+  it 'should parse paid_at to Time' do
+    subject.paid_at.should be_an_instance_of Time
+  end
+end

data/spec/lib/waffle_api/worker_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe WaffleAPI::Worker do
+  subject { build :worker }
+
+  it 'should have expected attributes' do
+    subject.should respond_to :name
+    subject.should respond_to :hash_rate
+    subject.should respond_to :stale_rate
+    subject.should respond_to :last_seen
+  end
+
+  it 'should parse last_seen to Time' do
+    subject.last_seen.should be_an_instance_of Time
+  end
+end

data/spec/spec_helper.rb

@@ -1,14 +1,18 @@
 if ENV['TRAVIS']
   require 'coveralls'
+  require 'codeclimate-test-reporter'
   Coveralls.wear!
+  CodeClimate::TestReporter.start
 end
 
-require 'webmock/rspec'
 require 'waffle_api'
+require 'webmock/rspec'
+require 'faker'
+require 'factory_girl'
 
 Dir[File.dirname(__FILE__) + '/support/**/*.rb'].each { |f| require f }
 
-WebMock.disable_net_connect! allow_localhost: true
+WebMock.disable_net_connect! allow_localhost: true, allow: 'codeclimate.com'
 
 BTC_ADDRESS = '1Ju8U9Ukfc5kiMqzQrRgQBP1JvRkeSv94V'
 URL = "http://wafflepool.com/tmp_api?address=#{BTC_ADDRESS}"

data/spec/support/factory_girl.rb

@@ -0,0 +1,5 @@
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end
+
+FactoryGirl.find_definitions

data/waffle_api.gemspec

@@ -20,5 +20,8 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '~> 2.14'
   s.add_development_dependency 'sinatra', '~> 1.4'
   s.add_development_dependency 'webmock', '~> 1.17'
+  s.add_development_dependency 'factory_girl', '~> 4.0'
+  s.add_development_dependency 'faker', '~> 1.3'
   s.add_development_dependency 'coveralls', '~> 0.7'
+  s.add_development_dependency 'codeclimate-test-reporter', '~> 0.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: waffle_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Calyhre
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: coveralls
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: Simple gem to make fast and cached calls to Wafflepool API
 email:
 - contact@calyh.re
@@ -96,12 +138,20 @@ files:
 - Rakefile
 - lib/waffle_api.rb
 - lib/waffle_api/address_validator.rb
+- lib/waffle_api/balances.rb
 - lib/waffle_api/client.rb
 - lib/waffle_api/errors.rb
 - lib/waffle_api/helpers.rb
+- lib/waffle_api/payment.rb
 - lib/waffle_api/version.rb
+- lib/waffle_api/worker.rb
+- spec/factories.rb
+- spec/lib/waffle_api/balances_spec.rb
 - spec/lib/waffle_api/client_spec.rb
+- spec/lib/waffle_api/payment_spec.rb
+- spec/lib/waffle_api/worker_spec.rb
 - spec/spec_helper.rb
+- spec/support/factory_girl.rb
 - spec/support/fixtures/error.json
 - spec/support/fixtures/not_found.json
 - spec/support/fixtures/success.json
@@ -132,8 +182,13 @@ signing_key:
 specification_version: 4
 summary: Waffle pool API gem
 test_files:
+- spec/factories.rb
+- spec/lib/waffle_api/balances_spec.rb
 - spec/lib/waffle_api/client_spec.rb
+- spec/lib/waffle_api/payment_spec.rb
+- spec/lib/waffle_api/worker_spec.rb
 - spec/spec_helper.rb
+- spec/support/factory_girl.rb
 - spec/support/fixtures/error.json
 - spec/support/fixtures/not_found.json
 - spec/support/fixtures/success.json