expedition 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b469b07e45e60d178dbfa91fa63c46c7d3d0f3ea
-  data.tar.gz: 88fdd81ad47d6d705cf314c72a6b66f0d4dacffe
+  metadata.gz: 0cef207a11eed24a6983827999f5035ac80fdcf4
+  data.tar.gz: eb87eedfe67d6885d5d65e070027155bbf2fb797
 SHA512:
-  metadata.gz: 263182dee4dc4eaf432fb2bd3e1df358d9f90345f8203965e144b27665f354944af9e735ea0c0253c3eeeab4559a852863679f2bb312af54ab261d3b37b6d7e2
-  data.tar.gz: 05b339be299f3f259dbd023e5899d97c817795d77d2aee47f27ed8addacbbabc6a8197df5a3b7f2d63e8b8e2ef379e00b485d14a22cb26c611eafead42773ddd
+  metadata.gz: b9b37bc91c9ef1a071ced968e5b591429b95d430d15ca52d902f1d201d44534efff3610e0c980e215bac31952d3d55f85e61604e3f8305dc992430a378bc1987
+  data.tar.gz: 3299a161b09dfd39249d36c4f1652af2552e66f78068b525f84c7730466f7f1c29b3f0b84467919c9bad435edb8f13c04d21190c39e423a32ad1062392677782

data/README.md

@@ -34,7 +34,49 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+A client can be initialized with an optional host and port (defaulting to
+`localhost`, port `4028`):
+
+```ruby
+client = Expedition.new(host, port)
+```
+
+Querying is done by calling the method you wish to send:
+
+```ruby
+response = client.pools
+# => #<Expedition::Response ...>
+
+response.body
+# => [{"pool"=>0,
+#  "url"=>"stratum+tcp://pool.example.com:3333",
+#  "status"=>"alive"
+#  ...}]
+
+response.status
+# => #<Expedition::Status
+#  @code=7
+#  @description="sgminer 4.1.153",
+#  @executed_at=2014-05-13 17:51:53 -0700,
+#  @message="1 Pool(s)",
+#  @severity=:success>>
+
+response.ok?
+# => true
+```
+
+## Supported API Methods
+
+Expedition overrides `#method_missing` to allow sending *any* method to a
+running miner. For convenience and additional sugar, the following methods are
+implemented which offer parsed timestamps, and more consistent responses:
+
+* `#devices` - Detailed information about devices.
+* `#metrics` - Detailed statistics for all devices.
+* `#pools` - Pool information and statistics.
+
+In need of another method?
+[Open an issue](https://github.com/gevans/expedition/issues/new).
 
 ## Contributing
 

data/lib/expedition/client.rb

@@ -29,6 +29,12 @@ module Expedition
       @port = port
     end
 
+    ##
+    # Sends the `devdetails` command, returning an array of devices found in the
+    # service's response.
+    #
+    # @return [Response]
+    #   An array of devices.
     def devices
       send(:devdetails) do |body|
         body[:devdetails].collect { |attrs|
@@ -39,12 +45,30 @@ module Expedition
       end
     end
 
+    ##
+    # Sends the `devs` command, returning an array of metrics found in the
+    # service's response.
+    #
+    # @return [Response]
+    #   An array of metrics.
     def metrics
       send(:devs) do |body|
         body[:devs].collect(&method(:parse_metrics))
       end
     end
 
+    ##
+    # Sends the `pools` command, returning an array of pools found in the
+    # service's response.
+    #
+    # @return [Response]
+    #   An array of pools.
+    def pools
+      send(:pools) do |body|
+        body[:pools].collect(&method(:parse_pool))
+      end
+    end
+
     ##
     # Sends the supplied `command` with optionally supplied `parameters` to the
     # service and returns the result, if any.
@@ -61,7 +85,7 @@ module Expedition
     # @return [Response]
     #   The service's response.
     def send(command, *parameters, &block)
-      socket = TCPSocket.new(host, port)
+      socket = TCPSocket.open(host, port)
       socket.puts command_json(command, *parameters)
 
       parse(socket.gets, &block)
@@ -97,5 +121,13 @@ module Expedition
         khs: attrs.delete("khs_#{interval}")
       )
     end
+
+    def parse_pool(attrs)
+      attrs.merge!(
+        status: attrs[:status].downcase,
+        long_poll: attrs[:long_poll] != 'N',
+        last_share_time: (Time.at(attrs[:last_share_time]) rescue attrs[:last_share_time]),
+      )
+    end
   end # Client
 end # Expedition

data/lib/expedition/version.rb

@@ -1,3 +1,3 @@
 module Expedition
-  VERSION = '0.3.0'.freeze
+  VERSION = '0.4.0'.freeze
 end

data/spec/expedition/client_spec.rb

@@ -42,7 +42,7 @@ describe Expedition::Client do
       end
 
       before do
-        allow(TCPSocket).to receive(:new).with(client.host, client.port).and_return(socket)
+        allow(TCPSocket).to receive(:open).and_return(socket)
       end
 
       it 'sends supplied command and parameters to configured host and port' do
@@ -121,7 +121,7 @@ describe Expedition::Client do
     end
 
     before do
-      allow(TCPSocket).to receive(:new).with(client.host, client.port).and_return(socket)
+      allow(TCPSocket).to receive(:open).and_return(socket)
       allow(socket).to receive(:puts)
       allow(socket).to receive(:gets).and_return(response)
     end
@@ -177,7 +177,7 @@ describe Expedition::Client do
             'STATUS' => 'S',
             'When' => 1399419744,
             'Code' => 9,
-            'Msg' => '3 GPU(s)',
+            'Msg' => '1 GPU(s)',
             'Description' => 'sgminer 4.1.153'
           }
         ],
@@ -221,7 +221,7 @@ describe Expedition::Client do
     end
 
     before do
-      allow(TCPSocket).to receive(:new).with(client.host, client.port).and_return(socket)
+      allow(TCPSocket).to receive(:open).and_return(socket)
       allow(socket).to receive(:puts)
       allow(socket).to receive(:gets).and_return(response)
     end
@@ -262,4 +262,109 @@ describe Expedition::Client do
       ])
     end
   end
+
+  describe '#pools' do
+
+    subject(:pools) do
+      client.pools
+    end
+
+    let(:client) do
+      described_class.new
+    end
+
+    let(:socket) do
+      double(TCPSocket)
+    end
+
+    let(:response) do
+      {
+        'STATUS' => [
+          {
+            'STATUS' => 'S',
+            'When' => 1400026784,
+            'Code' => 7,
+            'Msg' => '1 Pool(s)',
+            'Description' => 'sgminer 4.1.153'
+          }
+        ],
+        'POOLS' => [
+          {
+            'POOL' => 0,
+            'URL' => 'stratum+tcp://us-west2.multipool.us:3352',
+            'Status' => 'Alive',
+            'Priority' => 0,
+            'Quota' => 1,
+            'Long Poll' => 'N',
+            'Getworks' => 31,
+            'Accepted' => 413,
+            'Rejected' => 0,
+            'Works' => 206,
+            'Discarded' => 1256,
+            'Stale' => 0,
+            'Get Failures' => 0,
+            'Remote Failures' => 0,
+            'User' => 'nobody',
+            'Last Share Time' => 1400026781,
+            'Diff1 Shares' => 52523,
+            'Proxy Type' => '',
+            'Proxy' => '',
+            'Difficulty Accepted' => 52864.0,
+            'Difficulty Rejected' => 0.0,
+            'Difficulty Stale' => 0.0,
+            'Last Share Difficulty' => 128.0,
+            'Has Stratum' => true,
+            'Stratum Active' => true,
+            'Stratum URL' => 'us-west2.multipool.us',
+            'Has GBT' => false,
+            'Best Share' => 22673,
+            'Pool Rejected%' => 0.0,
+            'Pool Stale%' => 0.0
+          }
+        ],
+        'id' => 1
+      }.to_json
+    end
+
+    before do
+      allow(TCPSocket).to receive(:open).and_return(socket)
+      allow(socket).to receive(:puts)
+      allow(socket).to receive(:gets).and_return(response)
+    end
+
+    specify do
+      expect(pools.body).to eq([
+        'pool' => 0,
+        'url' => 'stratum+tcp://us-west2.multipool.us:3352',
+        'status' => 'alive',
+        'priority' => 0,
+        'quota' => 1,
+        'long_poll' => false,
+        'getworks' => 31,
+        'accepted' => 413,
+        'rejected' => 0,
+        'works' => 206,
+        'discarded' => 1256,
+        'stale' => 0,
+        'get_failures' => 0,
+        'remote_failures' => 0,
+        'user' => 'nobody',
+        'last_share_time' => Time.utc(2014, 05, 14, 0, 19, 41),
+        'diff1_shares' => 52523,
+        'proxy_type' => '',
+        'proxy' => '',
+        'difficulty_accepted' => 52864.0,
+        'difficulty_rejected' => 0.0,
+        'difficulty_stale' => 0.0,
+        'last_share_difficulty' => 128.0,
+        'has_stratum' => true,
+        'stratum_active' => true,
+        'stratum_url' => 'us-west2.multipool.us',
+        'has_gbt' => false,
+        'best_share' => 22673,
+        'pool_rejected_percent' => 0.0,
+        'pool_stale_percent' => 0.0
+      ])
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expedition
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gabe Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-08 00:00:00.000000000 Z
+date: 2014-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json