specter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03a7593a58b7e476c274ddcc7a849c33d9251964
+  data.tar.gz: 61fdef93b66898a612708c4177e94f42501d237a
+SHA512:
+  metadata.gz: dba4a51691b4390d6139c48c34940e71e5f2d455f8fae87ba73dc491cd16f4a3c7eed72d87c4409292b64df086201f6ee4b4eccd6ecc984887b034228c0c40b3
+  data.tar.gz: 37cdddbb000e0bd2c2bbf8fce8f139e2f66f1e8703bce3750be79abf6186baeb0681e03edea05bb4efac7b825ad4c85b639910f1aaec7879ef5c88c0fff12a81

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.1

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## specter 0.1.0
+
+* Initial release with support for most *read* commands (ASICs and FPGAs
+  not included).
+
+  *Gabe Evans*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in specter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Gabe Evans
+
+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,37 @@
+# (Pro)specter
+
+Specter stubs a subset of cgminer's
+[client protocol](https://github.com/ckolivas/cgminer/blob/master/API-README).
+Use it to develop software that interacts with the API *without* being forced to
+always run against a real, running instance.
+
+## Installation
+
+Install it with:
+
+    $ gem install specter
+
+Then start it with:
+
+    $ specter
+
+## Usage
+
+```
+Usage: specter [options]
+    -H, --host HOST                  Bind to a specific address
+    -p, --port PORT                  Listen on a specific TCP port
+    -P, --proxy [HOST[:PORT]]        Send unrecognized commands to an actual running miner
+                                     Host defaults to `localhost', port defaults to `4028'
+    -v, --version                    Show version information and exit
+    -h, --help                       Show this help message and exit
+```
+
+
+## Contributing
+
+1. Fork it (http://github.com/gevans/specter/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 new Pull Request

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Generate a fixture for supplied command'
+task :generate_fixture, [:command] do |t, args|
+  if args[:command].nil? || args[:command].empty?
+    abort 'no command specified'
+  end
+
+  command = args[:command].to_sym
+
+  require 'expedition'
+  client = Expedition::Client.new(
+    ENV['EXPEDITION_HOST'] || 'localhost',
+    ENV['EXPEDITION_PORT'] || 4028
+  )
+
+  fixture_path = File.expand_path("../lib/specter/fixtures/#{command}.json", __FILE__)
+  File.open(fixture_path, 'w') do |f|
+    f.write JSON.pretty_generate(client.send(command).raw)
+  end
+  puts "Wrote fixture to #{fixture_path}"
+end
+
+task default: :spec

data/bin/specter

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'specter'
+
+Specter::Cli.start(ARGV)

data/lib/specter.rb

@@ -0,0 +1,10 @@
+require 'specter/version'
+require 'specter/cli'
+require 'specter/server'
+
+module Specter
+
+  ##
+  # Raised when an incoming request is malformed in some way.
+  class RequestError < StandardError; end
+end # Specter

data/lib/specter/cli.rb

@@ -0,0 +1,94 @@
+require 'optparse'
+require 'uri'
+
+module Specter
+  class Cli
+
+    DEFAULT_HOST = '0.0.0.0'
+
+    DEFAULT_PORT = 5028
+
+    attr_reader :options
+
+    def initialize(argv)
+      @argv = argv
+      @options = {}
+    end
+
+    def self.start(argv)
+      new(argv).run
+    end
+
+    def output_header
+      puts "Booting Specter v#{VERSION}..."
+      puts "* Running in #{RUBY_DESCRIPTION}"
+      puts "* Listening on tcp://#{options[:host]}:#{options[:port]}"
+      puts 'Use Ctrl-C to stop'
+    end
+
+    def run
+      parse_options
+      output_header
+
+      @thread = @server.run
+      @thread.run
+
+      Signal.trap('INT') do
+        puts 'Stopping...'
+        @thread.exit
+        exit
+      end
+
+      @thread.join
+    end
+
+    private
+
+    def parse_options
+      @options = {
+        host: DEFAULT_HOST,
+        port: DEFAULT_PORT,
+        debug: true
+      }
+
+      parser = OptionParser.new do |opts|
+        opts.banner = 'Usage: specter [options]'
+
+        opts.on '-H', '--host HOST',
+          'Bind to a specific address' do |arg|
+          options[:host] = arg
+        end
+
+        opts.on '-p', '--port PORT', 'Listen on a specific TCP port' do |arg|
+          options[:port] = Integer(arg)
+        end
+
+        opts.on '-P', '--proxy [HOST[:PORT]]', 'Send unrecognized commands to an actual running miner',
+          "Host defaults to `localhost', port defaults to `4028'" do |arg|
+          options[:proxy] = arg.to_s.split(':', 2)
+
+          case options[:proxy].size
+          when 0
+            options[:proxy] = ['localhost', 4028]
+          when 1
+            options[:proxy] << 4028
+          end
+        end
+
+        opts.on_tail '-v', '--version', 'Show version information and exit' do |arg|
+          puts "specter v#{Specter::VERSION}"
+          exit
+        end
+
+        opts.on_tail '-h', '--help', 'Show this help message and exit' do
+          puts opts
+          exit
+        end
+      end
+
+      parser.parse!(@argv)
+
+      @server = Server.new(self)
+    end
+  end # Cli
+end # Specter

data/lib/specter/env.rb

@@ -0,0 +1,22 @@
+require 'forwardable'
+
+module Specter
+  class Env < Hash
+    extend Forwardable
+
+    attr_reader :client
+
+    attr_reader :request
+
+    def_delegators :request, :command, :args
+
+    def initialize(client, request)
+      @client  = client
+      @request = request
+    end
+
+    def to_str
+      "#{to_json}\x0"
+    end
+  end # Env
+end # Specter

data/lib/specter/fixtures/coin.json

@@ -0,0 +1,21 @@
+{
+  "STATUS": [
+    {
+      "STATUS": "S",
+      "When": 1397043350,
+      "Code": 78,
+      "Msg": "specter coin",
+      "Description": "specter 0.1.0"
+    }
+  ],
+  "COIN": [
+    {
+      "Hash Method": "scrypt",
+      "Current Block Time": 1397043315.715224,
+      "Current Block Hash": "43731fc6b8fe04dc579f6a5434330a4cfbcc674988202555fb39e54802ceae3e",
+      "LP": true,
+      "Network Difficulty": 62452873.65228917
+    }
+  ],
+  "id": 1
+}

data/lib/specter/fixtures/config.json

@@ -0,0 +1,28 @@
+{
+  "STATUS": [
+    {
+      "STATUS": "S",
+      "When": 1397042317,
+      "Code": 33,
+      "Msg": "specter config",
+      "Description": "specter 0.1.0"
+    }
+  ],
+  "CONFIG": [
+    {
+      "GPU Count": 3,
+      "Pool Count": 4,
+      "ADL": "Y",
+      "ADL in use": "Y",
+      "Strategy": "Failover",
+      "Log Interval": 5,
+      "Device Code": "GPU ",
+      "OS": "Linux",
+      "Failover-Only": true,
+      "ScanTime": 60,
+      "Queue": 1,
+      "Expiry": 120
+    }
+  ],
+  "id": 1
+}

data/lib/specter/fixtures/devdetails.json

@@ -0,0 +1,41 @@
+{
+  "STATUS": [
+    {
+      "STATUS": "S",
+      "When": 1397042151,
+      "Code": 69,
+      "Msg": "Device Details",
+      "Description": "specter 0.1.0"
+    }
+  ],
+  "DEVDETAILS": [
+    {
+      "DEVDETAILS": 0,
+      "Name": "GPU",
+      "ID": 0,
+      "Driver": "opencl",
+      "Kernel": "ckolivas",
+      "Model": "AMD Radeon R9 200 Series",
+      "Device Path": ""
+    },
+    {
+      "DEVDETAILS": 1,
+      "Name": "GPU",
+      "ID": 1,
+      "Driver": "opencl",
+      "Kernel": "ckolivas",
+      "Model": "AMD Radeon R9 200 Series",
+      "Device Path": ""
+    },
+    {
+      "DEVDETAILS": 2,
+      "Name": "GPU",
+      "ID": 2,
+      "Driver": "opencl",
+      "Kernel": "ckolivas",
+      "Model": "AMD Radeon R9 200 Series",
+      "Device Path": ""
+    }
+  ],
+  "id": 1
+}

data/lib/specter/fixtures/devs.json

@@ -0,0 +1,113 @@
+{
+  "STATUS": [
+    {
+      "STATUS": "S",
+      "When": 1397042125,
+      "Code": 9,
+      "Msg": "3 GPU(s)",
+      "Description": "specter 0.1.0"
+    }
+  ],
+  "DEVS": [
+    {
+      "GPU": 0,
+      "Enabled": "Y",
+      "Status": "Alive",
+      "Temperature": 76.0,
+      "Fan Speed": -1,
+      "Fan Percent": 99,
+      "GPU Clock": 948,
+      "Memory Clock": 1500,
+      "GPU Voltage": 0.0,
+      "GPU Activity": 100,
+      "Powertune": 30,
+      "MHS av": 0.9291,
+      "MHS 5s": 0.9309,
+      "KHS av": 929,
+      "KHS 5s": 931,
+      "Accepted": 1147,
+      "Rejected": 1,
+      "Hardware Errors": 0,
+      "Utility": 1.6732,
+      "Intensity": "0",
+      "Last Share Pool": 0,
+      "Last Share Time": 1397042089,
+      "Total MH": 38214.9898,
+      "Diff1 Work": 589212,
+      "Difficulty Accepted": 587264.0,
+      "Difficulty Rejected": 512.0,
+      "Last Share Difficulty": 512.0,
+      "Last Valid Work": 1397042089,
+      "Device Hardware%": 0.0,
+      "Device Rejected%": 0.0869,
+      "Device Elapsed": 41130
+    },
+    {
+      "GPU": 1,
+      "Enabled": "Y",
+      "Status": "Alive",
+      "Temperature": 76.0,
+      "Fan Speed": -1,
+      "Fan Percent": 99,
+      "GPU Clock": 916,
+      "Memory Clock": 1500,
+      "GPU Voltage": 0.0,
+      "GPU Activity": 100,
+      "Powertune": 30,
+      "MHS av": 0.9099,
+      "MHS 5s": 0.9117,
+      "KHS av": 910,
+      "KHS 5s": 912,
+      "Accepted": 1106,
+      "Rejected": 2,
+      "Hardware Errors": 0,
+      "Utility": 1.6134,
+      "Intensity": "0",
+      "Last Share Pool": 0,
+      "Last Share Time": 1397042114,
+      "Total MH": 37423.4573,
+      "Diff1 Work": 565927,
+      "Difficulty Accepted": 566272.0,
+      "Difficulty Rejected": 1024.0,
+      "Last Share Difficulty": 512.0,
+      "Last Valid Work": 1397042114,
+      "Device Hardware%": 0.0,
+      "Device Rejected%": 0.1809,
+      "Device Elapsed": 41130
+    },
+    {
+      "GPU": 2,
+      "Enabled": "Y",
+      "Status": "Alive",
+      "Temperature": 76.0,
+      "Fan Speed": -1,
+      "Fan Percent": 97,
+      "GPU Clock": 952,
+      "Memory Clock": 1500,
+      "GPU Voltage": 0.0,
+      "GPU Activity": 100,
+      "Powertune": 30,
+      "MHS av": 0.9295,
+      "MHS 5s": 0.9308,
+      "KHS av": 930,
+      "KHS 5s": 931,
+      "Accepted": 1174,
+      "Rejected": 3,
+      "Hardware Errors": 0,
+      "Utility": 1.7126,
+      "Intensity": "0",
+      "Last Share Pool": 0,
+      "Last Share Time": 1397042096,
+      "Total MH": 38230.613,
+      "Diff1 Work": 604241,
+      "Difficulty Accepted": 601088.0,
+      "Difficulty Rejected": 1536.0,
+      "Last Share Difficulty": 512.0,
+      "Last Valid Work": 1397042096,
+      "Device Hardware%": 0.0,
+      "Device Rejected%": 0.2542,
+      "Device Elapsed": 41130
+    }
+  ],
+  "id": 1
+}