cradlepoint 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a39b1ded7fedf95f572b701bc48aa6a8610b49e8
+  data.tar.gz: c74d80eb9a4246dde59bc3ff97a2e0ef7bf1a3a4
+SHA512:
+  metadata.gz: ce512a39b670eb5b1eb47ee41f75612882c2577a6460d2168a17df92ef02a6dbc107fa73b1b2e47ee1866c75af42ddfba6fd707e79f258f81d05059909d28f9b
+  data.tar.gz: 426f4d58f1d264c61916fa353d987e487ed4db19b84315c547286aff65602504c933863e0f599ea67ffaf4219350be637b4af9f8c8a04053f14b521025bc657d

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 johnotander
+
+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,60 @@
+# Cradlepoint
+
+This is a gem that talks to Cradlepoint's Enterprise Cloud Manager \(ECM\).
+
+In order to use this gem you will need a valid ECM username and password.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cradlepoint'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cradlepoint
+
+__Note:__ in order to run the tests you will need to do the following:
+
+    # These are required in order to run the tests, you can locate these
+    # details at https://cradlepointecm.com/
+    $ export ECM_USERNAME='<my_username>'
+    $ export ECM_PASSWORD='<my_password>'
+    $ export ECM_ACCOUNT_ID='<my_account_id>'
+    $ export ECM_ROUTER_ID='<my_router_id>'
+
+    # Now you're ready to run the tests.
+    $ rspec
+
+## Usage
+
+Getting router information:
+
+```ruby
+Cradlepoint::Router.get(my_router_id) # => Router's JSON blob.
+Cradlepoint::Rouer.index              # => All the routers as a JSON array.
+```
+
+Getting net device information:
+
+```ruby
+router = Cradlepoint::NetDevice.new(my_router_id) # => Router object
+Cradlepoint::NetDevice.new(router).get            # => Router's net_device info as JSON blob.
+```
+
+## More Information
+
+http://dev.cradlepoint.com/
+
+## Contributing
+
+1. Fork it
+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,13 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = "test/test_*.rb"  
+end
+
+desc "Run tests"
+task default: :test
+
+task :build do
+  system "gem build cradlepoint.gemspec"
+end

data/cradlepoint.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cradlepoint/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cradlepoint"
+  spec.version       = Cradlepoint::VERSION
+  spec.authors       = ["uceem"]
+  spec.email         = ["support@uceem.com"]
+  spec.description   = %q{Cradlepoint ECM API gem}
+  spec.summary       = %q{Cradlepoint ECM API gem}
+  spec.homepage      = "https://www.uceem.com"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'rest-client'
+  spec.add_dependency 'json'
+
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+end

data/lib/cradlepoint.rb

@@ -0,0 +1,73 @@
+require 'json'
+require 'rest-client'
+
+require 'cradlepoint/version'
+
+require 'cradlepoint/cradlepoint_object'
+require 'cradlepoint/account'
+require 'cradlepoint/net_device'
+require 'cradlepoint/net_flow'
+require 'cradlepoint/router'
+require 'cradlepoint/config'
+
+module Cradlepoint
+
+  class << self
+    attr_accessor :username, :password, :account, :base_url
+  end
+  
+  @base_url = 'cradlepointecm.com/api/v1'
+
+  def self.make_request(method, url = '', params = {})
+    raise 'You need to call Cradlepoint.authenticate(username, password) first.' unless username and password
+
+    parameters = { format: :json }
+    headers = { accept: :json, content_type: :json }
+
+    response = case method
+               when :get then RestClient.get()
+               when :configs then get_configs
+               else false
+               end
+    
+    response ? handle_response(response) : false
+  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)
+           end
+  end
+  
+  def self.authenticate(username, password)
+    self.username = username
+    self.password = password
+    true
+  end
+  
+  def self.url_prepend
+    "https://#{ @username }:#{ @password }@"
+  end
+  
+  def self.url_append
+    "?format=json"
+  end
+  
+  def self.handle_response(response)
+    begin
+      parsed_response = JSON.parse(response)
+    rescue JSON::ParserError, TypeError
+      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
+  end
+end

data/lib/cradlepoint/account.rb

@@ -0,0 +1,38 @@
+module Cradlepoint
+  class Account < CradlepointObject
+
+    attr_accessor :ecm_id, :data
+
+    def initialize(id = nil)
+      self.ecm_id = id
+    end
+
+    def self.rel_url
+      '/accounts'
+    end
+
+    def rel_url
+      Cradlepoint::Account.rel_url
+    end
+
+    def self.rel_url_with_id(id)
+      "#{ rel_url }/#{ id }/"
+    end
+
+    def rel_url_with_id
+      Cradlepoint::Account.rel_url_with_id(id)
+    end
+
+    def id
+      self.ecm_id ? self.ecm_id : lazy_load_id
+    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.ecm_id
+    end
+  end
+end

data/lib/cradlepoint/config.rb

@@ -0,0 +1,97 @@
+module Cradlepoint
+  # In order to apply a configuration to the ECM you can simply call 
+  # Cradlepoint::Config.update(router), where the router is currently
+  # an ActiveRecord object, this will soon merely require a ruby dictionary
+  # instead.
+  #
+  # When update is called, a few steps must be undergone:
+  #   1. We must facilitate a POST to create a configuration_editor with the ECM API.
+  #   2. We must then perform a PUT of the configuration data to the configuration_editor.
+  #   3. Then we simply DELETE the configuration_editor, the ECM API does the rest.
+  class Config < CradlepointObject
+
+    attr_accessor :id, :router, :config_settings, :config_editor_id, :data
+
+    def initialize(router, config_settings = nil)
+      self.router = router
+      self.config_settings = config_settings
+    end
+
+    def self.rel_url
+      '/configuration_editors/'
+    end
+
+    def rel_url
+      Cradlepoint::Config.rel_url
+    end
+
+    def self.rel_url_with_id(id)
+      "#{ rel_url }#{ id }/"
+    end
+
+    def rel_url_with_id
+      Cradlepoint::Config.rel_url_with_id(id)
+    end
+
+    def self.rel_url_from_router(router)
+      "#{ Cradlepoint::Router.rel_url }/#{ router.id }/configuration_manager/"
+    end
+
+    def rel_url_from_router
+      Cradlepoint::Config.rel_url_from_router(router)
+    end
+
+    def create_editor
+      self.data = Cradlepoint.handle_response RestClient.post(build_url(rel_url),
+                                                               router.get_configuration_editor_data.to_json,
+                                                               content_type: :json,
+                                                               accept: :json)
+      self.id = self.data['data']['id']
+      self.data
+    end
+
+    def apply_config_to_editor
+      self.data = Cradlepoint.handle_response RestClient.put(build_url(rel_url_with_id),
+                                                              get_config_data_with_wrapper(config_settings).to_json,
+                                                              content_type: :json,
+                                                              accept: :json)
+    end
+
+    def remove_editor
+      self.data = Cradlepoint.handle_response RestClient.delete(build_url(rel_url_with_id),
+                                                                 content_type: :json,
+                                                                 accept: :json)
+    end
+
+    private
+
+      def get_config_data_with_wrapper(config_settings = {})
+        editor_data = router.get_configuration_editor_data
+        editor_data[:resource_uri] = '/api/v1' + rel_url_with_id
+        editor_data[:committed] = true
+        editor_data[:id] = self.id
+        editor_data[:diff_from_default] = [wifi_values_wrapper(config_settings), []]
+        editor_data
+      end
+      
+      def wifi_values_wrapper(config_settings)
+        {
+          wlan: {
+            bss: {
+              :'0' => wifi_values(config_settings)
+            }
+          }
+        }
+      end
+      
+      def wifi_values(config_settings)
+        {
+          system: { ui_activated: true },
+          radius0ip: config_settings[:radius_ip1],
+          radius1ip: config_settings[:radius_ip2],
+          radius0key: config_settings[:shared_secret] || :foobarbaz,
+          ssid: config_settings[:ssid] || '@uceem_ECM'
+        }
+      end
+  end
+end

data/lib/cradlepoint/cradlepoint_object.rb

@@ -0,0 +1,24 @@
+module Cradlepoint
+  class CradlepointObject
+
+    def self.build_url(rel_url = '/')
+      "#{ Cradlepoint.url_prepend }#{ Cradlepoint.base_url }#{ rel_url }#{ Cradlepoint.url_append }"
+    end
+
+    def build_url(rel_url = '/')
+      CradlepointObject.build_url(rel_url)
+    end
+
+    def self.build_new_url(rel_url = '/')
+      "#{ Cradlepoint.url_prepend }#{ Cradlepoint.base_url }#{ rel_url }"
+    end
+
+    def build_new_url(rel_url = '/')
+      CradlepointObject.build_new_url(rel_url)
+    end
+
+    def params
+      { params: { format: :json } }
+    end
+  end
+end

data/lib/cradlepoint/net_device.rb

@@ -0,0 +1,42 @@
+module Cradlepoint
+  class NetDevice < CradlepointObject
+
+    attr_accessor :id, :router, :data
+
+    def initialize(id = nil, router = nil)
+      self.id = id
+      self.router = router
+    end
+
+    def self.rel_url
+      '/net_devices'
+    end
+
+    def rel_url
+      Cradlepoint::NetDevice.rel_url
+    end
+
+    def self.rel_url_with_id(id)
+      "#{ Cradlepoint::NetDevice.rel_url }/#{ id }"
+    end
+
+    def rel_url_with_id
+      Cradlepoint::NetDevice.rel_url_with_id(id)
+    end
+
+    def self.rel_url_from_router(router_id)
+      "/routers/#{ router_id }/net_devices/"
+    end
+
+    def rel_url_from_router
+      Cradlepoint::NetDevice.rel_url_from_router(router.id)
+    end
+
+    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)
+    end
+  end
+end

data/lib/cradlepoint/net_flow.rb

@@ -0,0 +1,33 @@
+module Cradlepoint
+  class NetFlow < CradlepointObject
+
+    attr_accessor :mac, :router, :data, :status_data
+
+    def initialize(mac = nil, router = nil)
+      self.mac = mac
+      self.router = router
+    end
+
+    def self.rel_url
+      '/remote'
+    end
+
+    def rel_url
+      Cradlepoint::NetFlow.rel_url
+    end
+
+    def get
+      raise 'You must provide a mac' unless self.mac
+      self.data = Cradlepoint.handle_response RestClient.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)
+    end
+
+    def params
+      { params: { format: :json, mac: self.mac, limit: 1 }, accept: :json, content_type: :json }
+    end
+  end
+end

data/lib/cradlepoint/router.rb

@@ -0,0 +1,100 @@
+module Cradlepoint
+  class Router < CradlepointObject
+
+    attr_accessor :id, :data, :ecm_firmware_uri, :ecm_configuration_uri, 
+                  :ecm_configuration_manager_uri, :ecm_configuration_manager_data
+
+    def initialize(id = nil)
+      self.id = id
+    end
+
+    def self.rel_url
+      '/routers'
+    end
+
+    def rel_url
+      Cradlepoint::Router.rel_url
+    end
+
+    def self.rel_url_with_id(id)
+      "#{ rel_url }/#{ id }/"
+    end
+
+    def rel_url_with_id
+      Cradlepoint::Router.rel_url_with_id(id)
+    end
+
+    def self.rel_url_for_configuration_managers(id)
+      "#{ Cradlepoint::Router.rel_url_with_id(id) }/confguration_managers/"
+    end
+
+    def rel_url_for_configuration_managers
+      Cradlepoint::Router.rel_url_with_id(id)
+    end
+
+    def self.index
+      Cradlepoint.handle_response RestClient.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))
+    end
+
+    def apply_new_config(config_settings = {})
+      config = Cradlepoint::Config.new(self, config_settings)
+      config.create_editor
+      config.apply_config_to_editor
+      config.remove_editor
+    end
+
+    def configuration_manager_data
+      check_for_id_or_raise_error
+      lazy_load_configuration_manager_data unless self.ecm_configuration_manager_data
+      self.ecm_configuration_manager_data
+    end
+
+    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
+    end
+
+    def firmware_uri
+      lazy_load_router_data unless self.ecm_firmware_uri
+      self.ecm_firmware_uri
+    end
+
+    def configuration_uri
+      lazy_load_router_data unless self.ecm_configuration_manager_uri
+      lazy_load_configuration_manager_data unless self.ecm_configuration_uri
+      self.ecm_configuration_uri
+    end
+
+    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']
+    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)
+    end
+
+    def get_configuration_editor_data
+      {
+        account: '/api/v1' + Cradlepoint.account.rel_url_with_id,
+        baseline: configuration_uri,
+        firmware: firmware_uri,
+        router: '/api/v1' + rel_url_with_id
+      }
+    end
+
+    private
+
+      def check_for_id_or_raise_error
+        raise 'You must provide an ECM router id' if id.nil?
+      end
+  end
+end

data/lib/cradlepoint/version.rb

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

data/lib/cradlepoint/wlan_survey.rb

@@ -0,0 +1,18 @@
+module Cradlepoint
+  class WlanSurvey < CradlepointObject
+
+    attr_accessor :router, :data
+
+    def initialize(router = nil)
+      self.router = router
+    end
+
+    def self.rel_url
+      '/remote/status/wlan/survey'
+    end
+
+    def self.get
+      # ...
+    end
+  end
+end

data/spec/account_spec.rb

@@ -0,0 +1,62 @@
+require 'spec_helper'
+
+describe Cradlepoint::Account do
+
+  context 'without an id' do
+
+    let(:account) { Cradlepoint::Account.new }
+
+    before do 
+      authenticate_with_valid_credentials
+      account.id
+    end
+
+    after { logout }
+
+    it 'should lazy load the id' do
+      account.id.should == ACCOUNT_ID
+    end
+
+    it 'should also assign the response to the data attribute' do
+      account.data.should be
+    end
+  end
+
+  context 'with an id' do
+
+    let(:id) { 123 }
+    let(:account) { Cradlepoint::Account.new(id) }
+
+    it 'should return the id' do
+      account.id.should == id
+    end
+  end
+
+  describe '.rel_url' do
+
+    let(:rel_url) { '/accounts' }
+
+    it 'should return the proper rel_url from the factory' do
+      Cradlepoint::Account.rel_url.should == rel_url
+    end
+
+    it 'should return the proper rel_url' do
+      Cradlepoint::Account.new.rel_url.should == rel_url
+    end
+  end
+
+  describe '.rel_url_with_id' do
+
+    let(:id) { 123 }
+    let(:rel_url_with_id) { "/accounts/#{ id }/" }
+    let(:account) { Cradlepoint::Account.new(id) }
+
+    it 'should return the proper rel_url_with_id from the factory' do
+      Cradlepoint::Account.rel_url_with_id(id).should == rel_url_with_id
+    end
+
+    it 'should return the proper rel_url_with_id' do
+      account.rel_url_with_id.should == rel_url_with_id
+    end
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+=begin
+describe Cradlepoint::Config do
+
+  let(:router) { Cradlepoint::Router.new(ROUTER_ID) }
+  let(:config) { Cradlepoint::Config.new(router, {}) }
+
+  before do
+    Cradlepoint.account = Cradlepoint::Account.new(ACCOUNT_ID)
+    authenticate_with_valid_credentials
+  end
+  after { logout }
+
+  subject { config }
+  it { should be }
+  it { should respond_to(:id) }
+  it { should respond_to(:data) }
+  it { should respond_to(:router) }
+  it { should respond_to(:config_settings) }
+  it { should respond_to(:config_editor_id) }
+
+  it 'should return the correct rel_url' do
+    config.rel_url.should == '/configuration_editors/'
+  end
+
+  it 'should return the correct rel_url_with_id' do
+    config.id = 123
+    config.rel_url_with_id.should == '/configuration_editors/123/'
+    config.id = nil
+  end
+
+  context 'configuration patch' do
+
+    describe '.create_editor' do
+
+      before { config.create_editor }
+      after  { config.remove_editor }
+
+      it 'should have been successful' do
+        config.id.should be
+        config.data['success'].should be_true
+      end
+    end
+
+    describe '.apply_config_to_editor' do
+
+      before do 
+        config.create_editor
+        config.apply_config_to_editor
+      end
+      after { config.remove_editor }
+
+      it 'should have been successful' do
+        config.data['success'].should be_true
+      end
+    end
+
+    describe '.remove_editor' do
+
+      before do
+        config.create_editor
+        config.remove_editor
+      end
+
+      it 'should have been successful' do
+        config.data['success'].should be_true
+      end
+    end
+  end
+end
+=end

data/spec/cradlepoint_object_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+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' }
+
+  context 'factory' do
+
+    it 'should return the correct url' do
+      factory_cradlepoint_object.build_url('/blah').should == url
+    end
+  end
+
+  context 'initialized object' do
+
+    it 'should return the correct url' do
+      cradlepoint_object.build_url('/blah').should == url
+    end
+  end
+end

data/spec/cradlepoint_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Cradlepoint do
+
+  let(:cradlepoint) { Cradlepoint }
+
+  subject { cradlepoint }
+  it { should be }
+  it { should respond_to(:username) }
+  it { should respond_to(:password) }
+
+  context 'authentication' do
+
+    it 'should raise an error if you make a request without credentials' do
+      -> { cradlepoint.make_request(:fake) }.should raise_error
+    end
+
+    context 'with credentials' do
+
+      before { cradlepoint.authenticate(:blah_user, :blah_password) }
+
+      it 'should not raise an error' do
+        -> { cradlepoint.make_request(:fake) }.should_not raise_error
+      end
+    end
+  end
+
+  context 'make_request' do
+
+    before { authenticate_with_valid_credentials }
+
+    it 'should return the proper credentials' do
+      cradlepoint.username.should == USERNAME
+      cradlepoint.password.should == PASSWORD
+    end
+  end
+end

data/spec/net_device_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Cradlepoint::NetDevice do
+
+  let(:net_device) { Cradlepoint::NetDevice }
+
+  subject { net_device.new }
+  it { should be }
+  it { should respond_to(:id) }
+  it { should respond_to(:data) }
+  it { should respond_to(:router) }
+
+  it 'should provide the proper rel_url' do
+    net_device.rel_url_from_router(123).should == '/routers/123/net_devices/'
+  end
+
+  context 'when authenticated' do
+
+    before { authenticate_with_valid_credentials }
+
+    describe '.get_all_from_router' do
+
+      let(:router) { Cradlepoint::Router.new(ROUTER_ID) }
+      let(:device) { net_device.new(nil, router) }
+
+      before { device.get_all_from_router }
+
+      it 'should have been successful' do
+        device.data['success'].should be_true
+      end
+
+      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
+      end
+
+      it 'should be an array' do
+        device.data['data'].is_a?(Array).should be_true
+      end
+    end
+  end
+end

data/spec/net_flow_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Cradlepoint::NetFlow do
+
+  let(:net_flow) { Cradlepoint::NetFlow.new(ROUTER_MAC) }
+
+  before { login }
+
+  describe '.get' do
+
+    let(:net_flow_data) { net_flow.get }
+
+    it 'should return successfully' do
+      net_flow_data['success'].should be_true
+    end
+  end
+
+  describe '.get_status' do
+
+    let(:net_flow_status_data) { net_flow.get_status }
+
+    it 'should return data successfully' do
+      net_flow_status_data['success'].should be_true
+    end
+  end
+end

data/spec/router_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe Cradlepoint::Router do
+
+  let(:router) { Cradlepoint::Router }
+
+  subject { router }
+  it { should be }
+
+  it 'should provide the proper rel_url' do
+    router.rel_url.should == '/routers'
+  end
+
+  it 'should provide the proper rel_url_with_id' do
+    router.rel_url_with_id(123).should == '/routers/123/'
+  end
+
+  context 'when authenticated' do
+
+    before { authenticate_with_valid_credentials }
+
+    describe '.get' do
+
+      let(:response)      { router.new(ROUTER_ID).get }
+      let(:response_hash) { response['data']          }
+
+      subject { response }
+      it { should be }
+
+      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
+
+      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
+      end
+    end
+
+    describe '.index' do
+
+      let(:response)      { router.index           }
+      let(:response_hash) { response['data'].first }
+
+      subject { response }
+      it { should be }
+
+      it 'should be successful' do
+        response['success'].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
+      end
+    end
+
+    describe '.get_configuration_manager_data' do
+
+      let(:the_router)  { router.new(ROUTER_ID) }
+
+      before { the_router.configuration_manager_data }
+
+      it 'should have gotten the configuration manager data' do
+        the_router.ecm_configuration_manager_data.should be
+      end
+    end
+
+    describe '.firmware_data' do
+
+      let(:the_router) { router.new(ROUTER_ID) }
+
+      it 'should have gotten the firmware data' do
+        pending 'Waiting for updates to the firmware on the API side.'
+        the_router.firmware_data['success'].should be_true
+      end
+    end
+
+    describe '.apply_new_config' do
+
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+
+require 'json'
+require 'rest-client'
+
+require 'cradlepoint'
+
+RSpec.configure do |config|
+  config.color_enabled = true
+end
+
+USERNAME   ||= ENV['ECM_USERNAME']
+PASSWORD   ||= ENV['ECM_PASSWORD']
+ROUTER_ID  ||= ENV['ECM_ROUTER_ID']
+ACCOUNT_ID ||= ENV['ECM_ACCOUNT_ID']
+ROUTER_MAC ||= ENV['ECM_ROUTER_MAC']
+
+unless USERNAME and PASSWORD and ROUTER_ID and ACCOUNT_ID
+  raise 'REQUIRED ENV variables: [ECM_USERNAME, ECM_PASSWORD, ECM_ROUTER_ID, ECM_ACCOUNT_ID] in order to run the specs.'
+end
+
+def authenticate_with_valid_credentials(username = USERNAME, password = PASSWORD)
+  Cradlepoint.authenticate(username, password)
+end
+
+alias :login :authenticate_with_valid_credentials
+
+def logout
+  Cradlepoint.username = nil
+  Cradlepoint.password = nil
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: cradlepoint
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- uceem
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Cradlepoint ECM API gem
+email:
+- support@uceem.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- cradlepoint.gemspec
+- lib/cradlepoint.rb
+- lib/cradlepoint/account.rb
+- lib/cradlepoint/config.rb
+- lib/cradlepoint/cradlepoint_object.rb
+- lib/cradlepoint/net_device.rb
+- lib/cradlepoint/net_flow.rb
+- lib/cradlepoint/router.rb
+- lib/cradlepoint/version.rb
+- lib/cradlepoint/wlan_survey.rb
+- script/.gitkeep
+- spec/account_spec.rb
+- spec/config_spec.rb
+- spec/cradlepoint_object_spec.rb
+- spec/cradlepoint_spec.rb
+- spec/net_device_spec.rb
+- spec/net_flow_spec.rb
+- spec/router_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.uceem.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.6
+signing_key: 
+specification_version: 4
+summary: Cradlepoint ECM API gem
+test_files:
+- spec/account_spec.rb
+- spec/config_spec.rb
+- spec/cradlepoint_object_spec.rb
+- spec/cradlepoint_spec.rb
+- spec/net_device_spec.rb
+- spec/net_flow_spec.rb
+- spec/router_spec.rb
+- spec/spec_helper.rb