cgminer_api_client 0.2.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8df86a4b12bb2eef41633534532290139749a0491fb27d89a5c7ce55b596d4a5
+  data.tar.gz: adce4406c1bcec642a7b6698473a355a211b5c467765aaba466ef34efd563d64
+SHA512:
+  metadata.gz: 0305613f25ab54883339bb54f7155ff08b09af899d42a57dabd8dd051b6176d4aed3f698584606dd6081045756cb6ffe16035ec8abaca382271289f30859e86c
+  data.tar.gz: e093f302848547c460865383a7fd65eb48103c1dab9d2991109376ab5bc9c3c3e1d32c66140dcb031da5e65ee634f840d51dfff6a689364426b360f6099cdf91

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+config/miners.yml
+._*

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.6
+notifications:
+  email: false

data/.whitesource

@@ -0,0 +1,8 @@
+##########################################################
+#### WhiteSource "Bolt for Github" configuration file ####
+##########################################################
+
+# Configuration #
+#---------------#
+ws.repo.scan=true
+vulnerable.check.run.conclusion.level=failure

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development do
+  gem 'pry' ,       '>= 0.12.0'
+  gem 'rake' ,      '>= 13.0.0'
+  gem 'rspec' ,     '>= 3.9'
+  gem 'simplecov' , '>= 0.17.0'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Justin Ramos
+
+MIT License
+
+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,188 @@
+# CgminerApiClient [![Codacy Badge](https://api.codacy.com/project/badge/Grade/b59cb27aeae64f7c992f7072c5909788)](https://app.codacy.com/app/justin_28/cgminer_api_client?utm_source=github.com&utm_medium=referral&utm_content=jramos/cgminer_api_client&utm_campaign=Badge_Grade_Dashboard) [![Build Status](https://travis-ci.org/jramos/cgminer_api_client.png?branch=master)](https://travis-ci.org/jramos/cgminer_api_client) [![DepShield Badge](https://depshield.sonatype.org/badges/jramos/cgminer_api_client/depshield.svg)](https://depshield.github.io)
+
+A gem that allows sending API commands to a pool of cgminer instances.
+
+## Requirements
+
+-   Ruby (~> 2.0.0, ~> 2.1.0)
+    -   YAML
+    -   JSON
+    -   Socket
+    -   Thread
+-   cgminer (~> 3.12.0)
+
+## GUI
+
+-   <https://github.com/jramos/cgminer_manager>
+
+## Installation Options
+
+### Bundler
+
+Add the following to your `Gemfile`:
+
+    gem 'cgminer_api_client', '~> 0.2.6'
+
+### RubyGems
+
+    $ gem install cgminer_api_client
+
+### Manually
+
+    $ git clone git@github.com:jramos/cgminer_api_client.git
+    $ cd cgminer_api_client
+    $ gem build cgminer_api_client.gemspec
+    $ gem install cgminer_api_client-0.2.6.gem
+
+## Configuration
+
+Copy [`config/miners.yml.example`](https://github.com/jramos/cgminer_api_client/blob/master/config/miners.yml.example) to `config/miners.yml` and update with the IP addresses (and optional ports and timeouts) of your cgminer instances. E.g.:
+
+    # connect to localhost on the default port (4028) with the default timeout (5 seconds)
+    - host: 127.0.0.1
+    # connect to 192.168.1.1 on a non-standard port (1234) with a custom timeout (1 second)
+    - host: 192.168.1.1
+      port: 1234
+      timeout: 1
+
+### Remote API Access
+
+Your cgminer instances must be configured to allow remote API access if connecting from anywhere but localhost (127.0.0.1). See the [cgminer API-README](https://github.com/ckolivas/cgminer/blob/master/API-README) for more information.
+
+#### Linux Instructions
+
+Under Linux, you would do the following to allow access from any computer on your local network (192.168.1.x):
+
+    $ vi /etc/config/cgminer
+
+Make the following change:
+
+    # option api_allow 'W:127.0.0.1'
+    option api_allow 'W:127.0.0.1,W:192.168.1.0/24'
+
+You also need to updated the init.d script to pass the `--api_allow` option:
+
+    $ vi /etc/init.d/cgminer
+
+Make the following change:
+
+    #PARAMS="$AOPTIONS $POOL1 $POOL2 $POOL3 $_pb --api-listen --api-network"
+    PARAMS="$AOPTIONS $POOL1 $POOL2 $POOL3 $_pb --api-listen --api-network --api-allow $_aa"
+
+Restart cgminer:
+
+    $ /etc/init.d/cgminer restart
+
+## Gem Usage
+
+    require 'cgminer_api_client'
+
+    # change the default timeout and port for the miners
+    CgminerApiClient.config do |config|
+        config.default_port    = 4023
+        config.default_timeout = 3
+    end
+
+    pool = CgminerApiClient::MinerPool.new
+
+    # run 'devs' on each miner in the pool; returns an array of response hashes
+    devices = pool.devs
+
+    # run 'summary' on each miner in the pool; returns an array of response hashes
+    summaries = pool.summary
+
+    # run 'devs' on available miners; returns an array of response hashes
+    pool.available_miners.collect do |miner|
+        miner.devs
+    end
+
+    # restart the pool
+    pool.restart
+
+## CLI Usage
+
+API commands can be sent to your miner pool from the command line.
+
+    $ cgminer_api_client <command> (<arguments>)
+
+### Commands & Arguments
+
+#### Read-Only
+
+The following read-only miner and pool commands are currently available:
+
+-   asc(number)
+-   asccount
+-   check(command)
+-   coin
+-   config
+-   devdetails
+-   devs
+-   pga(number)
+-   pgacount
+-   pools
+-   privileged
+-   notify
+-   stats
+-   summary
+-   usbstats
+-   version
+
+#### Privileged
+
+The following privileged miner and pool commands are currently available:
+
+##### Asc
+
+-   ascdisable(number)
+-   ascenable(number)
+-   ascidentify(number)
+-   ascset(number, option, value = nil)
+
+##### Pga
+
+-   pgadisable(number)
+-   pgaenable(number)
+-   pgaidentify(number)
+-   pgaset(number, option, value = nil)
+
+##### Pool
+
+-   addpool(url, user, pass)
+-   disablepool(number)
+-   enablepool(number)
+-   poolpriority(\*id_order)
+-   poolquota(number, value)
+-   removepool(number)
+-   switchpool(number)
+
+##### System
+
+-   debug(setting = 'D')
+-   failover_only(value)
+-   hotplug(seconds)
+-   quit
+-   restart
+-   save(filename = nil)
+-   setconfig(name, value)
+-   zero(which = 'All', full_summary = false)
+
+Any cgminer API commands not explictly defined above are implemented using `method_missing`. A complete list of available API commands and options can be found in the [cgminer API-README](https://github.com/ckolivas/cgminer/blob/master/API-README).
+
+## Contributing
+
+1.  Fork it ( <https://github.com/jramos/cgminer_api_client/fork> )
+2.  Create your feature branch (`git checkout -b my-new-feature`)
+3.  Commit your changes (`git commit -am 'Add some feature'`)
+4.  Push to the branch (`git push origin my-new-feature`)
+5.  Create a new Pull Request
+
+## Donating
+
+If you find this gem useful, please consider donating.
+
+BTC: `18HFFqZv2KJMHPNwPes839PJd5GZc4cT3U`
+
+## License
+
+Code released under [the MIT license](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec

data/bin/cgminer_api_client

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../lib/")
+
+require 'cgminer_api_client'
+require 'pp'
+
+command = ARGV.shift&.to_sym
+commands = CgminerApiClient::Miner::Commands.instance_methods
+
+unless command and commands.include?(command)
+  puts "USAGE: cgminer_api_client command (arguments)"
+  puts "commands: " + commands.sort.collect(&:to_s).join(', ')
+  exit(0)
+end
+
+begin
+  miner_pool = CgminerApiClient::MinerPool.new
+  pp(ARGV.empty? ? miner_pool.query(command) : miner_pool.query(command, *ARGV))
+rescue => e
+  puts e.message
+end

data/cgminer_api_client.gemspec

@@ -0,0 +1,20 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cgminer_api_client/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cgminer_api_client"
+  spec.version       = CgminerApiClient::VERSION
+  spec.authors       = ["Justin Ramos"]
+  spec.email         = ["justin.ramos@gmail.com"]
+  spec.summary       = %q{A gem that allows sending API commands to a pool of cgminer instances}
+  spec.description   = %q{}
+  spec.homepage      = "https://github.com/jramos/cgminer_api_client"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

data/config/miners.yml.example

@@ -0,0 +1,2 @@
+- host: 127.0.0.1
+  port: 4028

data/lib/cgminer_api_client.rb

@@ -0,0 +1,40 @@
+require 'json'
+require 'socket'
+require 'thread'
+require 'yaml'
+
+require "cgminer_api_client/miner"
+require "cgminer_api_client/miner/commands"
+require "cgminer_api_client/miner_pool"
+require "cgminer_api_client/socket_with_timeout"
+require "cgminer_api_client/version"
+
+module CgminerApiClient
+  def self.default_host
+    defined?(@default_host) ? @default_host : '127.0.0.1'
+  end
+
+  def self.default_host=(value)
+    @default_host = value
+  end
+
+  def self.default_port
+    defined?(@default_port) ? @default_port : 4028
+  end
+
+  def self.default_port=(value)
+    @default_port = value
+  end
+
+  def self.default_timeout
+    defined?(@default_timeout) ? @default_timeout : 5
+  end
+
+  def self.default_timeout=(value)
+    @default_timeout = value
+  end
+
+  def self.config
+    yield self if block_given?
+  end
+end

data/lib/cgminer_api_client/miner.rb

@@ -0,0 +1,103 @@
+require 'cgminer_api_client/socket_with_timeout'
+require 'cgminer_api_client/miner/commands'
+
+module CgminerApiClient
+  class Miner
+    include SocketWithTimeout
+    include Miner::Commands
+
+    attr_accessor :host, :port, :timeout
+
+    def initialize(host = nil, port = nil, timeout = nil)
+      @host    = host    ? host    : CgminerApiClient.default_host
+      @port    = port    ? port    : CgminerApiClient.default_port
+      @timeout = timeout ? timeout : CgminerApiClient.default_timeout
+    end
+
+    def query(method, *params)
+      if available?
+        request = {command: method}
+
+        unless params.length == 0
+          params = params.map { |p| p.to_s.gsub('\\', '\\\\').gsub(',', '\,') }
+          request[:parameter] = params.join(',')
+        end
+
+        response = perform_request(request)
+        data = sanitized(response)
+        method.to_s.match('\+') ? data : data[method.to_sym]
+      end
+    end
+
+    def available?(force_reload = false)
+      @available = nil if force_reload
+
+      @available ||= begin
+        open_socket(@host, @port, @timeout).close
+        true
+      rescue
+        false
+      end
+    end
+
+    def method_missing(name, *args)
+      query(name, *args)
+    end
+
+    private
+
+    def perform_request(request)
+      begin
+        s = open_socket(@host, @port, @timeout)
+      rescue
+        raise "Connection to #{@host}:#{@port} failed"
+      end
+
+      s.write(request.to_json)
+      response = s.read.strip.chars.map { |c| c.ord >= 32 ? c : "\\u#{'%04x' % c.ord}" }.join
+      s.close
+
+      response.gsub! '}{', '}, {'
+      response.gsub! '[,{', '[ {'
+
+      data = JSON.parse(response)
+
+      if request[:command].to_s.match('\+')
+        data.each_pair do |command, response|
+          check_status(response.first) if response.respond_to?(:first)
+        end
+      else
+        check_status(data)
+      end
+
+      return data
+    end
+
+    def check_status(data)
+      status =   data['STATUS'][0]
+      sc     = status['STATUS']
+      c      = status['Code']
+      msg    = status['Msg']
+
+      case sc
+        when 'S'
+        when 'I'
+          puts "Info from API [#{c}]: #{msg}"
+        when 'W'
+          puts "Warning from API [#{c}]: #{msg}"
+        else
+          raise "#{c}: #{msg}"
+      end
+    end
+
+    def sanitized(data)
+      if data.is_a?(Hash)
+        data.inject({}) { |n, (k, v)| n[k.to_s.downcase.tr(' ', '_').to_sym] = sanitized(v); n }
+      elsif data.is_a?(Array)
+        data.map { |v| sanitized(v) }
+      else
+        data
+      end
+    end
+  end
+end