cgminer-api 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7756647b4310355759dc0bdd5c012143b3cc8646
-  data.tar.gz: 58a41157a89c31d15e90ca972915d30ddc6aeb19
+  metadata.gz: 258b3f4a7e4028128e92b2bbcb026a2e97cbde53
+  data.tar.gz: 85ae5352fd614a55d1085c70e43f54841ace30ee
 SHA512:
-  metadata.gz: 2f052bde67c8d0c0ff4c0c95338fc121066340095e4d1c669b6e1dfed5edb0cfa417ccf87bc4999dbde28842e944579f13007a1c67961311cf70e6c2307ba0a8
-  data.tar.gz: 1bce611fdab7a6ad2f8bcc27043d9b0bf722eaf859c9434f0be2c628e67dda2ec28591032111dad6d1b8cbfdc96791da6ffa1f5e48e56ac8a1fe371bfb2c67d7
+  metadata.gz: c593334573da5e8e2ff38fa8ea9b7df34ffdeaca094001cb98a08c0964073847d5d351f853acf09bff655c9a8718df3fdb391bbc12c1036d5b41f1b4357c2ea6
+  data.tar.gz: ba4c8d4d7483874049e01c7b2f3fc884745f01f051fce501fe6b3cf7f99e1113f4990835eb0ee6027b32aec2c408bcdb6f18791291eee74df57595e35c038f50

data/lib/cgminer/api/client.rb

@@ -3,6 +3,10 @@ module CGMiner
 
     class Client
 
+      attr_reader :host
+
+      attr_reader :port
+
       def initialize(host, port)
         @host = host
         @port = port
@@ -76,19 +80,11 @@ module CGMiner
       private
 
       def command(symbol, *parameters)
-        api = Net::Telnet::new('Host' => @host, 'Port' => @port)
-        results = api.cmd({ command: symbol.to_s, parameter: parameters.join(',') }.to_json)
-
-        begin
-          json = JSON.parse(results)
-          status = json['STATUS'][0]
-          reply = json[symbol.to_s.upcase]
-          response = CGMiner::API::Response.new(status, reply)
-        rescue JSON::ParserError => e
-          raise RuntimeError, "Failed parsing response: #{e}"
-        end
+        telnet = Net::Telnet::new('Host' => @host, 'Port' => @port)
+        results = telnet.cmd({ command: symbol.to_s, parameter: parameters.join(',') }.to_json)
+        CGMiner::API::Response.new(symbol, results)
       ensure
-        api.close unless api.nil?
+        telnet.close unless telnet.nil?
       end
 
     end

data/lib/cgminer/api/response.rb

@@ -7,9 +7,12 @@ module CGMiner
 
       attr_reader :body
 
-      def initialize(status, body)
-        @status = status
-        @body = body
+      attr_reader :raw
+
+      def initialize(command_symbol, raw_command_response)
+        @raw = JSON.parse(raw_command_response)
+        @status = @raw['STATUS'][0]
+        @body = @raw[command_symbol.to_s.upcase]
       end
 
       def received_at

data/lib/cgminer/api/version.rb

@@ -1,5 +1,5 @@
 module CGMiner
   module API
-    VERSION = '0.0.4'
+    VERSION = '0.1.0'
   end
 end

data/spec/client_spec.rb

@@ -0,0 +1,143 @@
+require 'spec_helper'
+
+describe CGMiner::API::Client do
+
+  let(:host) { 'my-hostname' }
+
+  let(:port) { 1234 }
+
+  let(:telnet) do
+    telnet = double('Net::Telnet')
+  end
+
+  before(:each) do
+    stub_const 'Net::Telnet', double(new: telnet)
+    @client = described_class.new(host, port)
+  end
+
+  subject { @client }
+
+  context 'successful communication' do
+
+    let(:reply) do
+      <<-EOF
+{"STATUS":[{"STATUS":"S","When":1391459548,"Code":78,"Msg":"CGMiner coin","Description":"cgminer 3.7.2"}],"COIN":[{"Hash Method":"scrypt","Current Block Time":1391457585.060405,"Current Block Hash":"0012a85cfa3d1b7cc00bf56a5c8cd283e8ca95995d040c42ff4c66f219e24567","LP":true,"Network Difficulty":10.87349847}],"id":1}
+      EOF
+    end
+
+    before(:each) do
+      telnet.stub(:cmd).and_return(reply)
+      telnet.should_receive(:close)
+    end
+
+    its(:coin) { should be_a(CGMiner::API::Response) }
+
+  end
+
+  context 'with parameters' do
+
+    let(:reply) do
+      <<-EOF
+{"STATUS":[{"STATUS":"S","When":1391459548,"Code":78,"Msg":"CGMiner coin","Description":"cgminer 3.7.2"}],"ASC":[{"Hash Method":"scrypt","Current Block Time":1391457585.060405,"Current Block Hash":"0012a85cfa3d1b7cc00bf56a5c8cd283e8ca95995d040c42ff4c66f219e24567","LP":true,"Network Difficulty":10.87349847}],"id":1}
+      EOF
+    end
+
+    before(:each) do
+      expected = '{"command":"asc","parameter":"1"}'
+      telnet.stub(:cmd).with(expected).and_return(reply)
+      telnet.should_receive(:close)
+    end
+
+    specify { expect(subject.asc(1)).to be_a(CGMiner::API::Response) }
+
+  end
+
+  context 'failed communication' do
+
+    before(:each) do
+      telnet.stub(:cmd).and_raise(TimeoutError)
+      telnet.should_receive(:close)
+    end
+
+    specify { expect { subject.asc(0) }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.asccount }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.check(:version) }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.coin }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.config }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.devdetails }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.devs }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.gpu(0) }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.gpucount }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.pga(0) }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.pgacount }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.pools }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.stats }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.summary }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.usbstats }.to raise_error(TimeoutError) }
+
+    specify { expect { subject.version }.to raise_error(TimeoutError) }
+
+  end
+
+  context 'invalid JSON response' do
+
+    let(:reply) { "I AM A PRETTY BAD RESPONSE" }
+
+    before(:each) do
+      telnet.stub(:cmd).and_return(reply)
+      telnet.should_receive(:close)
+    end
+
+    specify { expect { subject.asc(0) }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.asccount }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.check(:version) }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.coin }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.config }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.devdetails }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.devs }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.gpu(0) }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.gpucount }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.pga(0) }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.pgacount }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.pools }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.stats }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.summary }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.usbstats }.to raise_error(JSON::ParserError) }
+
+    specify { expect { subject.version }.to raise_error(JSON::ParserError) }
+
+  end
+
+  its(:host) { should eql('my-hostname') }
+
+  its(:port) { should eql(1234) }
+
+end

data/spec/response_spec.rb

@@ -0,0 +1,51 @@
+require 'spec_helper'
+
+describe CGMiner::API::Response do
+
+  before(:each) do
+    @response = described_class.new(:coin, raw)
+  end
+
+  subject { @response }
+
+  context 'successful response' do
+
+    let(:raw) do
+      <<-EOF
+{"STATUS":[{"STATUS":"S","When":1391459548,"Code":78,"Msg":"CGMiner coin","Description":"cgminer 3.7.2"}],"COIN":[{"Hash Method":"scrypt","Current Block Time":1391457585.060405,"Current Block Hash":"0012a85cfa3d1b7cc00bf56a5c8cd283e8ca95995d040c42ff4c66f219e24567","LP":true,"Network Difficulty":10.87349847}],"id":1}
+      EOF
+    end
+
+    its(:raw) { should be_a(Hash) }
+
+    its(:body) { should be_a(Array) }
+
+    its(:status) { should be_a(Hash) }
+
+    its(:received_at) { should be_a(DateTime) }
+
+    its(:success?) { should be_true }
+
+  end
+
+  context 'invalid command response' do
+
+    let(:raw) do
+      <<-EOF
+{"STATUS":[{"STATUS":"E","When":1391459330,"Code":14,"Msg":"Invalid command","Description":"cgminer 3.7.2"}],"id":1}
+      EOF
+    end
+
+    its(:raw) { should be_a(Hash) }
+
+    its(:body) { should be_nil }
+
+    its(:status) { should be_a(Hash) }
+
+    its(:received_at) { should be_a(DateTime) }
+
+    its(:success?) { should be_false }
+
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cgminer-api
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.1.0
 platform: ruby
 authors:
 - Nick Veys
@@ -139,6 +139,8 @@ files:
 - lib/cgminer/api/client.rb
 - lib/cgminer/api/response.rb
 - lib/cgminer/api/version.rb
+- spec/client_spec.rb
+- spec/response_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -165,4 +167,6 @@ signing_key:
 specification_version: 4
 summary: cgminer api gem
 test_files:
+- spec/client_spec.rb
+- spec/response_spec.rb
 - spec/spec_helper.rb