expedition 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 141d6721450724842c369dc719dc7c730bf9ca33
-  data.tar.gz: fe74ec4f70c28284ce8368ba260eccafebd6a307
+  metadata.gz: 88b001358532eca38c34e829587ff88f5ce5e0f0
+  data.tar.gz: 38bf70bc6eec3aee3453487d19833170eac1c4af
 SHA512:
-  metadata.gz: 5be107f3cf7a0c8a449c3022e5d1fc9f1b862384a92db439e9d6c4125f49451714b4771dda11edd7cee6df4f803b16ee9276c3ea79251a92adfce5ae72aeb269
-  data.tar.gz: 3064b19068add7e17547c07b610655446e308a8e1fd9ee94759c1f5e420986f645ce0260e587c81cb5f6d4be2e8517ab779ec32940b505a4044e1082a90dbd6e
+  metadata.gz: 111ba58baef943aac22bd2b4a618f56e40b375d27b8395b0f6fcd016bf30922eadb588f9275cb5e9c91ee2f96b67a1bbb3f63cde0b53b07c764f7614c200b7d2
+  data.tar.gz: b51384cbb26b4c65bb5a075f59a9ba4a24a562cce966c8f8a875051af0585e27cb313866a4b70cec78c54a5d52709e317e6b537de0af3fa8214452267abd73c2

data/.travis.yml

@@ -1,5 +1,4 @@
 language: ruby
 rvm:
   - 2.1.1
-  - 2.1.0
   - 2.0.0

data/expedition.gemspec

@@ -13,13 +13,15 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/gevans/expedition'
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = '>= 2.0.0'
+
   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 = %w(lib)
 
   spec.add_dependency 'multi_json',    '~> 1.3'
-  spec.add_dependency 'activesupport', '~> 4.0'
+  spec.add_dependency 'activesupport', '>= 3.2'
 
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'coveralls'

data/lib/expedition.rb

@@ -1,11 +1,19 @@
-require 'active_support'
-require 'active_support/core_ext'
+require 'active_support/core_ext/module/delegation'
 
 require 'expedition/client'
 require 'expedition/version'
 
 module Expedition
 
+  class << self
+    ##
+    # @return [Client]
+    #   A client for accessing the API of a cgminer-compatible service.
+    attr_accessor :client
+
+    delegate(*Client.public_instance_methods(false), to: :client)
+  end
+
   ##
   # Initializes a new {Expedition::Client}.
   #

data/lib/expedition/client.rb

@@ -29,6 +29,27 @@ module Expedition
       @port = port
     end
 
+    def devices
+      send(:devdetails) do |body|
+        body[:devdetails].collect { |attrs|
+          attrs.delete(:devdetails)
+          attrs[:variant] = attrs.delete(:name).downcase
+          attrs
+        }
+      end
+    end
+
+    def metrics
+      send(:devs) do |body|
+        body[:devs].collect { |attrs|
+          attrs.merge(
+            enabled: attrs[:enabled] == 'Y',
+            status: attrs[:status].downcase
+          )
+        }
+      end
+    end
+
     ##
     # Sends the supplied `command` with optionally supplied `parameters` to the
     # service and returns the result, if any.
@@ -44,21 +65,21 @@ module Expedition
     #
     # @return [Response]
     #   The service's response.
-    def send(command, *parameters)
+    def send(command, *parameters, &block)
       socket = TCPSocket.new(host, port)
       socket.puts command_json(command, *parameters)
 
-      parse(socket.gets)
+      parse(socket.gets, &block)
     ensure
       socket.close if socket.respond_to?(:close)
     end
 
-    alias method_missing send
+    alias_method :method_missing, :send
 
     private
 
-    def parse(response)
-      Response.parse(MultiJson.load(response.chomp("\x0")))
+    def parse(response, &block)
+      Response.parse(MultiJson.load(response.chomp("\x0")), &block)
     end
 
     def command_json(command, *parameters)

data/lib/expedition/response.rb

@@ -1,3 +1,5 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
 require 'expedition/status'
 
 module Expedition
@@ -10,27 +12,29 @@ module Expedition
     attr_reader :status
 
     def self.parse(raw)
-      new(normalize(raw), raw)
+      normalized = normalize(raw)
+      normalized = yield normalized if block_given?
+      new(normalized, raw)
     end
 
     def initialize(normalized, raw)
-      @body = normalized
-      @raw = raw
-      @status = Status.new(normalized[:status])
+      @body   = normalized
+      @raw    = raw
+      @status = Status.new(raw['STATUS'])
     end
 
-    delegate :success?, :informational?, :warning?, :error?, :fatal?,
+    delegate :success?, :info?, :warn?, :error?, :fatal?, :ok?,
              :executed_at, to: :status
 
-    delegate :[], :to_hash, to: :body
+    delegate :[], :to_h, :to_hash, :to_a, :to_ary, to: :body
 
     def respond_to_missing?(method_name, include_private = false)
-      body.has_key?(method_name) || super
+      body.respond_to?(method_name) || super
     end
 
     def method_missing(method_name, *arguments, &block)
       if respond_to_missing?(method_name)
-        body[method_name]
+        body.send(method_name, *arguments, &block)
       else
         super
       end
@@ -41,7 +45,7 @@ module Expedition
     def self.normalize(value)
       case value
       when Hash
-        Hash[value.collect { |k, v| [normalize_key(k), normalize(v)] }]
+        Hash[value.collect { |k, v| [normalize_key(k), normalize(v)] }].with_indifferent_access
       when Array
         value.collect { |v| normalize(v) }
       else
@@ -50,7 +54,8 @@ module Expedition
     end
 
     def self.normalize_key(key)
-      key.gsub(/(\w)%/, '\\1_percent').gsub('%', 'percent').gsub(/\s/, '_').downcase.to_sym
+      key = key.gsub(/(\w)%/, '\\1_percent').gsub('%', 'percent').gsub(/[^\w]+/, ' ')
+      key.strip.gsub(/\s+/, '_').downcase
     end
   end # Response
 end # Expedition

data/lib/expedition/status.rb

@@ -4,12 +4,12 @@ module Expedition
     SEVERITIES = {
       'S' => :success,
       'I' => :info,
-      'W' => :warning,
+      'W' => :warn,
       'E' => :error,
       'F' => :fatal
     }.freeze
 
-    OK_SEVERITIES = %i(success info warning).freeze
+    OK_SEVERITIES = %i(success info warn).freeze
 
     attr_reader :severity
 
@@ -22,13 +22,13 @@ module Expedition
     attr_reader :executed_at
 
     def initialize(body)
-      status = body.try(:first) || {}
+      status = body ? body.first : {}
 
-      @severity    = SEVERITIES[status[:status]]
-      @code        = status[:code]
-      @message     = status[:msg]
-      @description = status[:description]
-      @executed_at = Time.at(status[:when]) rescue nil
+      @severity    = SEVERITIES[status['STATUS']]
+      @code        = status['Code']
+      @message     = status['Msg']
+      @description = status['Description']
+      @executed_at = Time.at(status['When']) rescue nil
     end
 
     def success?
@@ -39,8 +39,8 @@ module Expedition
       severity == :info
     end
 
-    def warning?
-      severity == :warning
+    def warn?
+      severity == :warn
     end
 
     def error?

data/lib/expedition/version.rb

@@ -1,3 +1,3 @@
 module Expedition
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.2.0'.freeze
 end

data/spec/expedition/client_spec.rb

@@ -56,7 +56,7 @@ describe Expedition::Client do
         expect(socket).to receive(:gets).and_return(%/{"what a":["body"]}\x0/)
         result = client.__send__(method_name, 'foo', 'bar', 'baz')
         expect(result.body).to eq(
-          what_a: ['body']
+          'what_a' => ['body']
         )
       end
     end

data/spec/expedition/response_spec.rb

@@ -45,7 +45,9 @@ describe Expedition::Response do
           'Last Valid Work' => 1394735379,
           'Device Hardware%' => 0.3998,
           'Device Rejected%' => 0.4283,
-          'Device Elapsed' => 178612
+          'Device*Elapsed' => 178612,
+          '*Inconsistent-Bullshit*' => 'teehee',
+          '*Dev-* Throttle***' => 0
         }
       ],
       'id' => 1
@@ -95,11 +97,13 @@ describe Expedition::Response do
           last_valid_work: 1394735379,
           device_hardware_percent: 0.3998,
           device_rejected_percent: 0.4283,
-          device_elapsed: 178612
+          device_elapsed: 178612,
+          inconsistent_bullshit: 'teehee',
+          dev_throttle: 0
         }
       ],
       id: 1
-    }
+    }.with_indifferent_access
   end
 
   let(:response) do
@@ -144,7 +148,7 @@ describe Expedition::Response do
         expect(status).to be_success
 
         expect(status).not_to be_info
-        expect(status).not_to be_warning
+        expect(status).not_to be_warn
         expect(status).not_to be_info
         expect(status).not_to be_info
         expect(status).not_to be_info
@@ -165,7 +169,7 @@ describe Expedition::Response do
         expect(status).to be_info
 
         expect(status).not_to be_success
-        expect(status).not_to be_warning
+        expect(status).not_to be_warn
         expect(status).not_to be_error
         expect(status).not_to be_fatal
       end
@@ -175,14 +179,14 @@ describe Expedition::Response do
       end
     end
 
-    context 'when warning' do
+    context 'when warn' do
 
       before do
         original_data['STATUS'].first['STATUS'] = 'W'
       end
 
       it 'is warning' do
-        expect(status).to be_warning
+        expect(status).to be_warn
 
         expect(status).not_to be_success
         expect(status).not_to be_info
@@ -206,7 +210,7 @@ describe Expedition::Response do
 
         expect(status).not_to be_success
         expect(status).not_to be_info
-        expect(status).not_to be_warning
+        expect(status).not_to be_warn
         expect(status).not_to be_fatal
       end
 
@@ -226,7 +230,7 @@ describe Expedition::Response do
 
         expect(status).not_to be_success
         expect(status).not_to be_info
-        expect(status).not_to be_warning
+        expect(status).not_to be_warn
         expect(status).not_to be_error
       end
 
@@ -236,7 +240,7 @@ describe Expedition::Response do
     end
   end
 
-  %i(success? informational? warning? error? fatal? executed_at).each do |method_name|
+  %i(success? info? warn? error? fatal? ok? executed_at).each do |method_name|
 
     describe "##{method_name}" do
 
@@ -247,7 +251,7 @@ describe Expedition::Response do
     end
   end
 
-  %i([] to_hash).each do |method_name|
+  %i([] to_h to_hash to_a to_ary).each do |method_name|
 
     describe "##{method_name}" do
 
@@ -260,28 +264,15 @@ describe Expedition::Response do
 
   describe '#respond_to_missing?' do
 
-    let(:response) do
-      described_class.new(body, {})
-    end
-
-    context 'when #body has key' do
-
-      let(:body) do
-        {
-          foo: 'blah'
-        }
-      end
+    context 'when #body responds' do
 
       it 'returns true' do
+        expect(response.body).to receive(:respond_to?).with(:foo).and_return(true)
         expect(response).to respond_to(:foo)
       end
     end
 
-    context 'when #body does not have key' do
-
-      let(:body) do
-        {}
-      end
+    context 'when #body does not respond' do
 
       it 'returns false' do
         expect(response).not_to respond_to(:foo)
@@ -291,18 +282,19 @@ describe Expedition::Response do
 
   describe '#method_missing' do
 
-    context 'when key in #body' do
+    context 'when #body responds' do
 
       before do
-        allow(response).to receive(:body).and_return(something: 'stuff')
+        allow(response.body).to receive(:respond_to?).and_return(true)
+        allow(response.body).to receive(:something).and_return('stuff')
       end
 
-      it 'returns value' do
+      it 'returns method call' do
         expect(response.something).to eq('stuff')
       end
     end
 
-    context 'when not key in #body' do
+    context 'when #body does not respond' do
 
       it 'raises NoMethodError' do
         expect {

data/spec/spec_helper.rb

@@ -5,7 +5,10 @@ SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter
 ]
-SimpleCov.start
+SimpleCov.start do
+  add_filter '/.bundle/'
+  add_filter '/spec/'
+end
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'expedition'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: expedition
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Gabe Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-16 00:00:00.000000000 Z
+date: 2014-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -28,16 +28,16 @@ dependencies:
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -263,7 +263,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="