waffle_api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc3f850365ea0b87271e5c6ff17619781fe21834
+  data.tar.gz: 66d0b71214fbb07192d370848347d56a21d54d44
+SHA512:
+  metadata.gz: 9d13db65aa6dbb6aa3672c0fbf79e8c20ef49c5b3989e95d0f6e5cfa054ee3e67356da7c277dc784f5e5e4f0c8bada3620303d801e80cf7eb8da694239832002
+  data.tar.gz: 0e076e76958040a268e72766e6ea1a8af8fb571ca30da634fbc1254415de8d99bfc0562b64d948e227a0475989861b688eebe42a36e5a14a9dc35c5ddcda8b5b

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+1. Fork repository
+2. Create a branch following a [successfull branching model](http://nvie.com/posts/a-successful-git-branching-model/)
+3. Write your feature/fix
+4. Write tests
+5. Pull request

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Charley D.
+
+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,119 @@
+# WaffleAPI
+
+[![Build Status][travis_img]][travis_url]
+[![Gem Version][fury_img]][fury_url]
+[![Code Climate][code_climate_img]][code_climate_url]
+[![Coverage Status][coveralls_img]][coveralls_url]
+
+_Waffle pool API gem_
+
+## Installation
+
+### Ruby 1.9.3+, 2+
+
+```ruby
+gem install waffle_api
+```
+
+## Usage
+
+```ruby
+require 'waffle_pool'
+client = WaffleAPI::Client.new address: '1Ju8U9Ukfc5kiMqzQrRgQBP1JvRkeSv94V'
+```
+
+
+### Get current total hashrate
+```ruby
+client.hashrate
+```
+
+
+### Get workers infos
+
+```ruby
+client.worker_hashrates
+```
+
+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"
+  }
+]
+```
+
+
+### Get balances
+
+```ruby
+client.balances
+```
+
+Will return a JSON array
+
+```json
+{
+  "sent": 1.61039009,
+  "confirmed": 0.00383488,
+  "unconverted": 0.011964213459441
+}
+```
+
+
+### Get payments
+
+```ruby
+client.recent_payments
+```
+
+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..."
+  },
+  {
+    "..."
+  }
+]
+```
+
+
+## Contributing
+
+[Contributors](https://github.com/Calyhre/waffle_api/graphs/contributors) and [CONTRIBUTING](https://github.com/Calyhre/waffle_api/blob/master/CONTRIBUTING.md)
+
+## Licence
+
+Released under the MIT License. See the [LICENSE](https://github.com/Calyhre/waffle_api/blob/master/LICENSE.md) file for further details.
+
+[travis_img]: https://travis-ci.org/Calyhre/waffle_api.png?branch=master
+[travis_url]: https://travis-ci.org/Calyhre/waffle_api
+[fury_img]: https://badge.fury.io/rb/waffle_api.png
+[fury_url]: http://badge.fury.io/rb/waffle_api
+[code_climate_img]: https://codeclimate.com/github/Calyhre/waffle_api.png
+[code_climate_url]: https://codeclimate.com/github/Calyhre/waffle_api
+[coveralls_img]: https://coveralls.io/repos/Calyhre/waffle_api/badge.png?branch=master
+[coveralls_url]: https://coveralls.io/r/Calyhre/waffle_api?branch=master

data/lib/waffle_api/address_validator.rb

@@ -0,0 +1,56 @@
+require 'digest'
+
+module WaffleAPI
+  # Module use to deeply validate BTC address
+  # From https://gist.github.com/alexandrz/4491729
+  module AddressValidator
+    private
+
+    B58_CHARS = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz'
+    B58_BASE = B58_CHARS.length
+
+    def valid_address?
+      (@address =~ /^[a-zA-Z1-9]{33,35}$/) && DigestUtilities.version(@address)
+    end
+
+    # Utilities are in a class to make them private
+    class DigestUtilities
+      def self.version(address)
+        decoded = b58_decode(address, 25)
+
+        version = decoded[0, 1]
+        checksum = decoded[-4, decoded.length]
+        vh160 = decoded[0, decoded.length - 4]
+
+        hashed = (Digest::SHA2.new << (Digest::SHA2.new << vh160).digest).digest
+
+        hashed[0, 4] == checksum ? version[0] : nil
+      end
+
+      def self.b58_decode(value, length)
+        long_value = 0
+        index = 0
+        result = ""
+
+        value.reverse.each_char do |c|
+          long_value += B58_CHARS.index(c) * (B58_BASE ** index)
+          index += 1
+        end
+
+        while long_value >= 256 do
+          div, mod = long_value.divmod 256
+          result = mod.chr + result
+          long_value = div
+        end
+
+        result = long_value.chr + result
+
+        if result.length < length
+          result = 0.chr * (length - result.length) + result
+        end
+
+        result
+      end
+    end
+  end
+end

data/lib/waffle_api/client.rb

@@ -0,0 +1,38 @@
+require 'waffle_api/helpers'
+require 'waffle_api/address_validator'
+
+module WaffleAPI
+  # A Ruby class to call the Waffle stat API. You might use this if you want to
+  # retrieve your waffle pool stats from within a Ruby program.
+  #
+  # Example:
+  #
+  #   require 'waffle_api'
+  #   stats = WaffleAPI::Client.new address: '<BTC_ADDRESS_HERE>'
+  #   stats.create()
+  #
+  class Client
+    include WaffleAPI::Helpers
+    include WaffleAPI::AddressValidator
+
+    attr_accessor :address, :https_only
+
+    def initialize(address: nil, https_only: false, ignore_bad_address: false)
+      @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
+    end
+
+    def hashrate
+      stats 'hash_rate'
+    end
+
+    def method_missing(method, *args, &block)
+      stats method.to_s
+    rescue Error::UnknownKey
+      super method, *args, &block
+    end
+  end
+end

data/lib/waffle_api/errors.rb

@@ -0,0 +1,80 @@
+module WaffleAPI
+  # WaffleAPI raised errors with explanations
+  module Error
+    ISSUES_URL = 'https://github.com/Calyhre/waffle_api/issues/new'
+
+    # Standard error we will inherit
+    class Standard < StandardError
+      def initialize(message = nil)
+        super(message || self.message)
+      end
+    end
+
+    # Error raised when address is missing
+    class EmptyAddress < Standard
+      def message
+        "You must provide an address to use this API. Please check the " \
+        "documentation."
+      end
+    end
+
+    # Error raised when address isn't valid
+    class BadAddress < Standard
+      def initialize(address = '')
+        super message address
+      end
+
+      def message(address = '')
+        "Address '#{address}' doesn't seem to be valid. You must provide a " \
+        "valid address to use this API. Use ignore_bad_address to skip this " \
+        "error."
+      end
+    end
+
+    # Error raised when https call Waffle returned a bad call
+    # It meens Waffle isn't supporting https right now.
+    class HttpsNotSupportedYet < Standard
+      def message
+        "Waffle pool isn\'t supporting https yet. Please use WaffleAPI " \
+        "without https_only argument."
+      end
+    end
+
+    # Error raised when Waffle change his API endpoint. Nothing to do but
+    # report an issue on this gem repo
+    class EndPointMoved < Standard
+      def message
+        "Waffle pool seems to have change his API endpoint. Please report " \
+        "an issue on #{ISSUES_URL}."
+      end
+    end
+
+    # Error raised when Waffle change his API endpoint. Nothing to do but
+    # report an issue on this gem repo
+    class AddressNotFound < Standard
+      def initialize(address = '')
+        super message address
+      end
+
+      def message(address = '')
+        "The address #{address} was not found on Wafflepool. Please check it."
+      end
+    end
+
+    # If you raise this exception, please report it as an issue with the
+    # message on this gem repo
+    class UnknownError < Standard; end
+
+    # If you raise this exception, please report it as an issue with it's
+    # message on this gem repo
+    class UnknownKey < Standard
+      def initialize(key = '')
+        super message key
+      end
+
+      def message(key = '')
+        "The key '#{key}' does not exist on Wafflepool api."
+      end
+    end
+  end
+end

data/lib/waffle_api/helpers.rb

@@ -0,0 +1,56 @@
+require 'waffle_api/errors'
+require 'net/http'
+require 'openssl'
+require 'json'
+require 'uri'
+
+module WaffleAPI
+  # List of helpers used in WaffleAPI
+  module Helpers
+    WAFFLE_POOL_HOST = 'wafflepool.com'
+    NOT_FOUND_ERROR = 'Invalid BTC Address!'
+    INVALIDATION_TIME = 30 # Seconds
+
+    def call_uri
+      URI(
+        "#{@https_only ? 'https' : 'http'}://#{WAFFLE_POOL_HOST}" \
+        "/tmp_api?address=#{@address}"
+      )
+    end
+
+    def request_json
+      response = Net::HTTP.get_response call_uri
+      fail Error::EndPointMoved if response.is_a? Net::HTTPNotFound
+
+      json = JSON.parse response.body
+      fail Error::AddressNotFound, @address if json['error'] == NOT_FOUND_ERROR
+      fail Error::UnknownError, json['error'] unless json['error'].empty?
+      json.delete 'error'
+
+      return json
+    rescue OpenSSL::SSL::SSLError
+      raise Error::HttpsNotSupportedYet
+    end
+
+    def data_recent?
+      @retrieved_at && @retrieved_at > Time.now - INVALIDATION_TIME
+    end
+
+    def data_recent!
+      @retrieved_at = Time.now
+    end
+
+    def stats(key, force_update = false)
+      @datas ||= []
+
+      if !data_recent? || force_update
+        @datas = request_json
+        data_recent!
+      end
+
+      fail Error::UnknownKey, key if @datas[key].nil?
+
+      @datas[key]
+    end
+  end
+end

data/lib/waffle_api/version.rb

@@ -0,0 +1,3 @@
+module WaffleAPI
+  VERSION = '0.1.0'
+end

data/lib/waffle_api.rb

@@ -0,0 +1,6 @@
+# Waffle pool API gem
+module WaffleAPI
+end
+
+require 'waffle_api/client'
+require 'waffle_api/version'

data/waffle_api.gemspec

@@ -0,0 +1,14 @@
+require File.expand_path('../lib/waffle_api/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name         = 'waffle_api'
+  s.version      = WaffleAPI::VERSION
+  s.summary      = 'Waffle pool API gem'
+  s.description  = s.summary
+  s.authors      = ['Calyhre']
+  s.email        = ['contact@calyh.re']
+  s.files        = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+  s.homepage     = 'http://rubygems.org/gems/waffle_api'
+  s.license      = 'MIT'
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: waffle_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Calyhre
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-20 00:00:00.000000000 Z
+dependencies: []
+description: Waffle pool API gem
+email:
+- contact@calyh.re
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CONTRIBUTING.md
+- LICENSE.md
+- README.md
+- lib/waffle_api.rb
+- lib/waffle_api/address_validator.rb
+- lib/waffle_api/client.rb
+- lib/waffle_api/errors.rb
+- lib/waffle_api/helpers.rb
+- lib/waffle_api/version.rb
+- waffle_api.gemspec
+homepage: http://rubygems.org/gems/waffle_api
+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.2.0
+signing_key: 
+specification_version: 4
+summary: Waffle pool API gem
+test_files: []