cradlepoint 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a39b1ded7fedf95f572b701bc48aa6a8610b49e8
-  data.tar.gz: c74d80eb9a4246dde59bc3ff97a2e0ef7bf1a3a4
+  metadata.gz: 829fb48e12131b6d4ea897f9344275051062999a
+  data.tar.gz: 623697fe461d2a039bd8539afb7819b676370cac
 SHA512:
-  metadata.gz: ce512a39b670eb5b1eb47ee41f75612882c2577a6460d2168a17df92ef02a6dbc107fa73b1b2e47ee1866c75af42ddfba6fd707e79f258f81d05059909d28f9b
-  data.tar.gz: 426f4d58f1d264c61916fa353d987e487ed4db19b84315c547286aff65602504c933863e0f599ea67ffaf4219350be637b4af9f8c8a04053f14b521025bc657d
+  metadata.gz: 05fae43cf310e2960965dcbabe49c1e04ed1d9dfc3baaaaa758e83a2cfc79bf5d399bd406b81de625c87952c10bb37b378f22ea2b389850aaa3474427335b354
+  data.tar.gz: d410545ed0e3f38ea6774ad14f886c00abe0c9b1d6f6d80a8a624f20b1a1394198359b2fd2665d50256abd561597b6bf6b2feb8dc0aed4c92ba8f5115ed675cf

data/lib/cradlepoint.rb

@@ -3,6 +3,8 @@ require 'rest-client'
 
 require 'cradlepoint/version'
 
+require 'cradlepoint/hash_helpers'
+
 require 'cradlepoint/cradlepoint_object'
 require 'cradlepoint/account'
 require 'cradlepoint/net_device'
@@ -21,24 +23,24 @@ module Cradlepoint
   def self.make_request(method, url = '', params = {})
     raise 'You need to call Cradlepoint.authenticate(username, password) first.' unless username and password
 
-    parameters = { format: :json }
+    params.merge!(format: :json)
     headers = { accept: :json, content_type: :json }
 
     response = case method
-               when :get then RestClient.get()
-               when :configs then get_configs
-               else false
+               when :get then RestClient.get(url, params: params, headers: headers)
+               else return false
                end
     
-    response ? handle_response(response) : false
+    handle_response(response)
   rescue RestClient::Exception => e
-    return case e.code
-           when 400 then { data: :unavailable }
-           when 401 then { data: :unavailable }
-           when 403 then { data: :unavailable }
-           when 404 then { data: :unavailable }
-           when 500 then { data: :unavailable }
-           else raise(e)
+    puts "RestClient::Exception received: #{ e.response.code }"
+    return case e.response.code
+           when 400 then { success: false, error_code: 400, error: e }
+           when 401 then { success: false, error_code: 401, error: e }
+           when 403 then { success: false, error_code: 403, error: e }
+           when 404 then { success: false, error_code: 404, error: e }
+           when 500 then { success: false, error_code: 500, error: e }
+           else raise(e) # Not an error we are expecting.
            end
   end
   
@@ -52,10 +54,6 @@ module Cradlepoint
     "https://#{ @username }:#{ @password }@"
   end
   
-  def self.url_append
-    "?format=json"
-  end
-  
   def self.handle_response(response)
     begin
       parsed_response = JSON.parse(response)
@@ -63,11 +61,8 @@ module Cradlepoint
       raise "Cradlepoint received an invalid json response."
     end
     
-    case response.code
-    when 200, 302 then parsed_response
-    when 400, 401 then false
-    when 500 then false
-    else false
-    end
+    parsed_response['success'] ? 
+      symbolize_keys(parsed_response['data']) : 
+      raise("Unsuccessful response received.")  # TODO: Handle more elegantly.
   end
 end

data/lib/cradlepoint/account.rb

@@ -1,7 +1,7 @@
 module Cradlepoint
   class Account < CradlepointObject
 
-    attr_accessor :ecm_id, :data
+    attr_accessor :ecm_id, :data, :disabled, :expiration, :name
 
     def initialize(id = nil)
       self.ecm_id = id
@@ -28,10 +28,8 @@ module Cradlepoint
     end
 
     def lazy_load_id
-      self.data = Cradlepoint.handle_response RestClient.get(build_url(rel_url),
-                                                              content_type: :json,
-                                                              accept: :json)
-      self.ecm_id = self.data['data'][0]['id']
+      self.data = Cradlepoint.make_request(:get, build_url(rel_url))
+      self.ecm_id = self.data[0][:id]
       self.ecm_id
     end
   end

data/lib/cradlepoint/config.rb

@@ -46,7 +46,7 @@ module Cradlepoint
                                                                router.get_configuration_editor_data.to_json,
                                                                content_type: :json,
                                                                accept: :json)
-      self.id = self.data['data']['id']
+      self.id = self.data[:id]
       self.data
     end
 

data/lib/cradlepoint/cradlepoint_object.rb

@@ -2,7 +2,7 @@ module Cradlepoint
   class CradlepointObject
 
     def self.build_url(rel_url = '/')
-      "#{ Cradlepoint.url_prepend }#{ Cradlepoint.base_url }#{ rel_url }#{ Cradlepoint.url_append }"
+      "#{ Cradlepoint.url_prepend }#{ Cradlepoint.base_url }#{ rel_url }"
     end
 
     def build_url(rel_url = '/')

data/lib/cradlepoint/hash_helpers.rb

@@ -0,0 +1,24 @@
+module Cradlepoint
+  module HashHelpers
+    # From 
+    # http://devblog.avdi.org/2009/07/14/recursively-symbolize-keys/
+    def symbolize_keys(hash)
+      if hash.is_a?(Array)
+        hash.map { |h| symbolize_keys(h) }
+      else
+        hash.inject({}) { |result, (key, value)|
+          new_key = case key
+                    when String then key.to_sym
+                    else key
+                    end
+          new_value = case value
+                      when Hash then symbolize_keys(value)
+                      else value
+                      end
+          result[new_key] = new_value
+          result
+        }
+      end
+    end
+  end
+end

data/lib/cradlepoint/net_device.rb

@@ -1,7 +1,10 @@
 module Cradlepoint
   class NetDevice < CradlepointObject
+    include Cradlepoint::HashHelpers
 
-    attr_accessor :id, :router, :data
+    attr_accessor :id, :router, :data, :bytes_in, :bytes_out, :carrier, :esn, :imei, :info, 
+                  :ip_address, :mac, :mode, :name, :type, :uptime, :netmask, :dns0, :dns1,
+                  :connection_state, :ip_mode
 
     def initialize(id = nil, router = nil)
       self.id = id
@@ -34,9 +37,50 @@ module Cradlepoint
 
     def get_all_from_router
       raise 'You must provide an ECM router' if router.nil?
-      self.data = Cradlepoint.handle_response RestClient.get(build_url(rel_url_from_router),
-                                                              content_type: :json,
-                                                              accept: :json)
+      self.data = Cradlepoint.make_request(:get, build_url(rel_url_from_router))
+      assign_attributes_from_data(group: true)
+    end
+
+    def assign_attributes_from_data(options = {})
+      return unless self.data and self.data.any?
+      raw_data = self.data
+
+      if options[:group]
+        return unless raw_data.is_a?(Array)
+
+        net_devices = []
+        raw_data.each do |nd|
+          new_net_device = NetDevice.new(nd[:id], self.id)
+          new_net_device.assign_attributes_from_blob(nd)
+          net_devices << new_net_device
+        end
+
+        net_devices
+      else
+        assign_attributes_from_blob(raw_data)
+      end
+    end
+
+    def assign_attributes_from_blob(blob = {})
+      return unless blob and blob.any?
+
+      self.connection_state = blob[:connection_state]
+      self.bytes_in = blob[:bytes_in]
+      self.bytes_out = blob[:bytes_out]
+      self.carrier = blob[:carrier]
+      self.esn = blob[:esn]
+      self.imei = blob[:imei]
+      self.info = blob[:info]
+      self.ip_address = blob[:ip_address]
+      self.mac = blob[:mac]
+      self.mode = blob[:mode]
+      self.name = blob[:name]
+      self.type = blob[:type]
+      self.uptime = blob[:uptime]
+      self.netmask = blob[:netmask]
+      self.dns0 = blob[:dns0]
+      self.dns1 = blob[:dns1]
+      self.ip_mode = blob[:config][:ipmode] if blob[:config].is_a?(Hash)
     end
   end
-end
+end

data/lib/cradlepoint/net_flow.rb

@@ -18,16 +18,16 @@ module Cradlepoint
 
     def get
       raise 'You must provide a mac' unless self.mac
-      self.data = Cradlepoint.handle_response RestClient.get(build_new_url(rel_url), params)
+      self.data = Cradlepoint.make_request(:get, build_new_url(rel_url), params)
     end
 
     def get_status
       raise 'You must provide a mac' unless self.mac
-      self.status_data = Cradlepoint.handle_response RestClient.get(build_new_url("#{ rel_url }/status"), params)
+      self.status_data = Cradlepoint.make_request(:get, build_new_url("#{ rel_url }/status"), params)
     end
 
     def params
-      { params: { format: :json, mac: self.mac, limit: 1 }, accept: :json, content_type: :json }
+      { params: { format: :json, mac: self.mac, limit: 1 } }
     end
   end
 end

data/lib/cradlepoint/router.rb

@@ -1,11 +1,15 @@
 module Cradlepoint
   class Router < CradlepointObject
+    include Cradlepoint::HashHelpers
 
     attr_accessor :id, :data, :ecm_firmware_uri, :ecm_configuration_uri, 
-                  :ecm_configuration_manager_uri, :ecm_configuration_manager_data
+                  :ecm_configuration_manager_uri, :ecm_configuration_manager_data,
+                  :mac, :config_status, :description, :full_product_name, :ip_address,
+                  :name, :stream_usage_in, :stream_usage_out, :stream_usage_period
 
-    def initialize(id = nil)
+    def initialize(id = nil, options = {})
       self.id = id
+      options.each { |k, v| send("#{ k }=", v) if v }
     end
 
     def self.rel_url
@@ -33,12 +37,14 @@ module Cradlepoint
     end
 
     def self.index
-      Cradlepoint.handle_response RestClient.get(build_url(rel_url))
+      build_array_of_routers_from_response(Cradlepoint.make_request(:get, build_url(rel_url)))
     end
 
     def get
       check_for_id_or_raise_error
-      self.data = Cradlepoint.handle_response RestClient.get(build_url(rel_url_with_id))
+      self.data = Cradlepoint.make_request(:get, build_url(rel_url_with_id))
+      assign_attributes_from_data
+      self.data
     end
 
     def apply_new_config(config_settings = {})
@@ -56,7 +62,7 @@ module Cradlepoint
 
     def firmware_data
       check_for_id_or_raise_error
-      Cradlepoint.handle_response RestClient.get(build_url(firmware_uri.split('/api/v1').last)) if firmware_uri
+      Cradlepoint.make_request(:get, build_url(firmware_uri.split('/api/v1').last))
     end
 
     def firmware_uri
@@ -72,14 +78,12 @@ module Cradlepoint
 
     def lazy_load_router_data
       get  # Grab the data from the api.
-      self.ecm_firmware_uri = self.data['data']['actual_firmware']
-      self.ecm_configuration_manager_uri = self.data['data']['configuration_manager']
+      self.ecm_firmware_uri = self.data[:actual_firmware]
+      self.ecm_configuration_manager_uri = self.data[:configuration_manager]
     end
 
     def lazy_load_configuration_manager_data
-      self.ecm_configuration_manager_data = Cradlepoint.handle_response RestClient.get(build_url(rel_url_for_configuration_managers),
-                                                                                        content_type: :json,
-                                                                                        accept: :json)
+      self.ecm_configuration_manager_data = Cradlepoint.make_request(:get, build_url(rel_url_for_configuration_managers))
     end
 
     def get_configuration_editor_data
@@ -91,8 +95,34 @@ module Cradlepoint
       }
     end
 
+    def assign_attributes_from_data
+      return unless self.data and self.data.any?
+
+      self.mac = self.data[:mac]
+      self.name = self.data[:name]
+      self.ip_address = self.data[:ip_address]
+      self.config_status = self.data[:config_status]
+      self.description = self.data[:description]
+      self.full_product_name = self.data[:full_product_name]
+      self.stream_usage_in = self.data[:stream_usage_in]
+      self.stream_usage_out = self.data[:stream_usage_out]
+      self.stream_usage_period = self.data[:stream_usage_period]
+    end
+
     private
 
+      def self.build_array_of_routers_from_response(response)
+        return unless response and response.any?
+        response.map { |r| create_and_assign_attributes_from_data(r) }
+      end
+
+      def self.create_and_assign_attributes_from_data(data)
+        return unless data and data.any? and data[:id]
+        router = Cradlepoint::Router.new(data[:id], data: data)
+        router.assign_attributes_from_data
+        router
+      end
+
       def check_for_id_or_raise_error
         raise 'You must provide an ECM router id' if id.nil?
       end

data/lib/cradlepoint/version.rb

@@ -1,3 +1,3 @@
 module Cradlepoint
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/spec/account_spec.rb

@@ -7,7 +7,7 @@ describe Cradlepoint::Account do
     let(:account) { Cradlepoint::Account.new }
 
     before do 
-      authenticate_with_valid_credentials
+      login
       account.id
     end
 

data/spec/cradlepoint_object_spec.rb

@@ -5,7 +5,7 @@ describe Cradlepoint::CradlepointObject do
   let(:factory_cradlepoint_object) { Cradlepoint::CradlepointObject     }
   let(:cradlepoint_object)         { Cradlepoint::CradlepointObject.new }
 
-  let(:url) { 'https://:@cradlepointecm.com/api/v1/blah?format=json' }
+  let(:url) { 'https://:@cradlepointecm.com/api/v1/blah' }
 
   context 'factory' do
 

data/spec/cradlepoint_spec.rb

@@ -27,7 +27,7 @@ describe Cradlepoint do
 
   context 'make_request' do
 
-    before { authenticate_with_valid_credentials }
+    before { login }
 
     it 'should return the proper credentials' do
       cradlepoint.username.should == USERNAME

data/spec/net_device_spec.rb

@@ -16,33 +16,49 @@ describe Cradlepoint::NetDevice do
 
   context 'when authenticated' do
 
-    before { authenticate_with_valid_credentials }
+    before { login }
 
     describe '.get_all_from_router' do
 
-      let(:router) { Cradlepoint::Router.new(ROUTER_ID) }
-      let(:device) { net_device.new(nil, router) }
+      let(:router)  { Cradlepoint::Router.new(ROUTER_ID) }
+      let(:device)  { net_device.new(nil, router) }
+      let(:devices) { device.get_all_from_router }
 
-      before { device.get_all_from_router }
-
-      it 'should have been successful' do
-        device.data['success'].should be_true
-      end
+      before { devices }
 
       it 'should raise an error when there is no router' do
         device_with_no_router = net_device.new
         -> { device_with_no_router.get_all_from_router }.should raise_error
       end
 
-      # TODO: Overhaul these to allow them to endure the test of time.
-      # These are brittle, temporary tests to make sure the correct
-      # blob is being returned.
       it 'should return a blob' do
-        device.data['data'].any?.should be_true
+        devices.any?.should be_true
       end
 
       it 'should be an array' do
-        device.data['data'].is_a?(Array).should be_true
+        device.data.is_a?(Array).should be_true
+      end
+
+      describe 'devices' do
+
+        let(:first_net_device) { devices.first }
+        let(:first_raw_data)   { device.data.first }
+        let(:attrs)            { [:bytes_in, :bytes_out, :carrier, :esn, :imei, :info, 
+                                  :ip_address, :mac, :mode, :name, :type, :uptime] }
+
+        it 'should return an array' do
+          devices.is_a?(Array).should be_true
+        end
+
+        it 'should return an array of Cradlepoint::NetDevices' do
+          devices.each { |d| d.is_a?(Cradlepoint::NetDevice).should be_true }
+        end
+
+        it 'should have the correct attributes' do
+          attrs.each do |a|
+            first_net_device.send(a).should == first_raw_data[a]
+          end
+        end
       end
     end
   end

data/spec/net_flow_spec.rb

@@ -11,7 +11,7 @@ describe Cradlepoint::NetFlow do
     let(:net_flow_data) { net_flow.get }
 
     it 'should return successfully' do
-      net_flow_data['success'].should be_true
+      net_flow_data.any?.should be_true
     end
   end
 
@@ -20,7 +20,7 @@ describe Cradlepoint::NetFlow do
     let(:net_flow_status_data) { net_flow.get_status }
 
     it 'should return data successfully' do
-      net_flow_status_data['success'].should be_true
+      net_flow_status_data.any?.should be_true
     end
   end
 end

data/spec/router_spec.rb

@@ -17,48 +17,40 @@ describe Cradlepoint::Router do
 
   context 'when authenticated' do
 
-    before { authenticate_with_valid_credentials }
+    before { login }
 
     describe '.get' do
 
-      let(:response)      { router.new(ROUTER_ID).get }
-      let(:response_hash) { response['data']          }
+      describe 'attrs' do
 
-      subject { response }
-      it { should be }
+        let(:ecm_router) { router.new(ROUTER_ID) }
+        let(:attrs) { [:mac, :config_status, :description, :full_product_name, :ip_address, :name, :stream_usage_in, 
+                       :stream_usage_out, :stream_usage_period] }
 
-      it 'should be successful' do
-        response['success'].should be_true
-      end
-
-      it 'should raise an error when the id is not provided' do
-        -> { router.get }.should raise_error
-      end
+        before { ecm_router.get }
 
-      it 'should return the correct blob' do
-        response['data'].any?.should be_true
-      end
-
-      it 'should have the correct keys' do
-        ['full_product_name', 'config_status', 'mac'].all? { |k| response_hash.has_key?(k) }.should be_true
+        it 'should be assigned correctly' do
+          attrs.each do |a|
+            ecm_router.send(a).should == ecm_router.data[a]
+          end
+        end
       end
     end
 
     describe '.index' do
 
-      let(:response)      { router.index           }
-      let(:response_hash) { response['data'].first }
+      let(:routers) { router.index }
 
-      subject { response }
-      it { should be }
+      it 'should return routers' do
+        routers.any?.should be_true
+      end
 
-      it 'should be successful' do
-        response['success'].should be_true
+      it 'should return the correct collection' do
+        routers.is_a?(Array).should be_true
       end
 
-      it 'should return the correct blob' do
-        response['data'].any?.should be_true
-        response['data'].is_a?(Array).should be_true
+      it 'should be of the correct type' do
+        routers.each{ |r| r.is_a?(Cradlepoint::Router).should be_true }
       end
     end
 

data/spec/spec_helper.rb

@@ -31,3 +31,5 @@ def logout
   Cradlepoint.username = nil
   Cradlepoint.password = nil
 end
+
+include Cradlepoint::HashHelpers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cradlepoint
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - uceem
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-13 00:00:00.000000000 Z
+date: 2013-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -97,6 +97,7 @@ files:
 - lib/cradlepoint/account.rb
 - lib/cradlepoint/config.rb
 - lib/cradlepoint/cradlepoint_object.rb
+- lib/cradlepoint/hash_helpers.rb
 - lib/cradlepoint/net_device.rb
 - lib/cradlepoint/net_flow.rb
 - lib/cradlepoint/router.rb
@@ -131,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.6
+rubygems_version: 2.0.5
 signing_key: 
 specification_version: 4
 summary: Cradlepoint ECM API gem