cisco-mse-client 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTQ5Y2NhMTk5OGI2Yzg1MDNlMTBjNjc4OWMyZjQ4ODYxM2ZlN2MxNw==
+  data.tar.gz: !binary |-
+    ZTY5YTJjOTM4ZGFlYzc4MWUwZGFkYTMxY2JjOTNjODc1YmMwMDQzMg==
+SHA512:
+  metadata.gz: !binary |-
+    YmY1MGMxYWU5ODk4YjQxOWZkNzYzNDRlZTYyNmVkNzA4NDZlZTRhN2RkYjBh
+    ODViNDJkODdmZjUzMzBhNzMxOWI5NWJkY2Y3M2Y0YzJmZjkxMDcxODQzY2Ew
+    NmNkZmQxMTNhNmIyYWFmMmNkYmMyN2NlYmIwYzJlYWIxMjQ2NjA=
+  data.tar.gz: !binary |-
+    MzcxYmZhNjIwN2QxNTc0ZWQxMzg5MWE4NTkxNjMwMGRlZDNjYmMxYjkyYzNh
+    YzBjZjQzNzUzOTU1NWFiZGY5NGQ2NjYyNTk2ZWYzMzhlZGYwNGQ5NjUwMzgz
+    MGY5MzkzNWViYzdkMTdiZjk5OTE4ZDQyOTZlOTk3ZDNmYzg3ZmI=

data/.gitignore

@@ -0,0 +1,18 @@
+# Ignore the _creds.rb spec file
+spec/_creds.rb
+
+# Ignore tempfiles
+*.sw[op]
+.DS_Store
+
+# RVM
+.rvmrc
+.ruby-gemset
+.ruby-version
+
+# Gems
+*.gem
+
+# IDEs
+.idea
+.project

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--backtrace
+--require rspec/instafail
+--format RSpec::Instafail

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+gemspec
+
+group :test do
+  gem 'rspec', '~> 2.14.1'
+  gem 'rspec-instafail', '~> 0.2'
+end
+
+group :development, :test do
+  gem 'pry'
+end

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    cisco-mse-client (0.0.1)
+      saddle (~> 0.0.49)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.2)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.14)
+    coderay (1.0.9)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    faraday_middleware (0.9.0)
+      faraday (>= 0.7.4, < 0.9)
+    i18n (0.6.9)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.8.2)
+    multipart-post (1.2.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.1)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.14.3)
+    saddle (0.0.49)
+      activesupport (>= 3.0)
+      faraday (~> 0.8.7)
+      faraday_middleware (~> 0.9.0)
+    slop (3.4.6)
+    thread_safe (0.1.3)
+      atomic
+    tzinfo (0.3.38)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cisco-mse-client!
+  pry
+  rspec (~> 2.14.1)
+  rspec-instafail (~> 0.2)

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2013, Mike Lewis
+
+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,32 @@
+# Ruby Cisco MSE (Mobility Services Engine) client
+
+
+## Usage
+```ruby
+client = CiscoMSE::Client.create(
+  username: 'YOUR_USERNAME',
+  password: 'YOUR_PASSWORD'
+)
+
+```
+
+
+## Testing
+
+### from your project
+In your spec_helper.rb, include the following snippet.
+```ruby
+CiscoMSE::Client.stub!
+```
+This will prevent `cisco-mse-client` from reaching out to live servers.
+Instead, endpoints will return back [local stubbed data](lib/cisco-mse-client/stub.rb).
+
+### the cisco-mse-client gem
+* Copy spec/_creds.stub.rb to spec/_creds.rb
+* Update it to include a valid token
+* bundle exec rspec
+
+
+## License
+(c) Mike Lewis 2013
+Released under the [MIT License](http://www.opensource.org/licenses/MIT).

data/cisco-mse-client.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cisco-mse-client/version', __FILE__)
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |s|
+  s.name          = 'cisco-mse-client'
+  s.version       = ::CiscoMSE::VERSION
+  s.authors       = ['Mike Lewis']
+  s.email         = ['mlewis.mail@gmail.com']
+  s.description   = %q{Cisco MSE client}
+  s.summary       = %q{
+    This is a Cisco MSE client implemented on Saddle
+  }
+  s.homepage      = 'https://github.com/mLewisLogic/cisco-mse-client'
+  s.license       = 'MIT'
+
+  s.require_path  = 'lib'
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+
+  s.add_dependency 'saddle', '~> 0.0.49'
+end

data/lib/cisco-mse-client.rb

@@ -0,0 +1,46 @@
+# encoding: UTF-8
+
+require 'saddle'
+
+require 'cisco-mse-client/exceptions'
+require 'cisco-mse-client/middleware/authentication'
+require 'cisco-mse-client/middleware/exception_raiser'
+require 'cisco-mse-client/middleware/set_format'
+require 'cisco-mse-client/stub'
+require 'cisco-mse-client/version'
+
+
+
+module CiscoMSE
+
+  class Client < Saddle::Client
+    extend CiscoMSE::Stub
+
+    def self.host
+      'localhost'
+    end
+
+    def self.path_prefix
+      'api/contextaware/v1'
+    end
+
+    def self.use_ssl
+      true
+    end
+
+
+    add_middleware({
+      klass: CiscoMSE::Middleware::ExceptionRaiser,
+    })
+
+    add_middleware({
+      klass: CiscoMSE::Middleware::Request::Authentication,
+    })
+
+    add_middleware({
+      klass: CiscoMSE::Middleware::Request::SetFormat,
+    })
+
+  end
+
+end

data/lib/cisco-mse-client/endpoints/location.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+require 'saddle/endpoint'
+
+
+
+module CiscoMSE
+  module Endpoints
+
+    class Location < Saddle::TraversalEndpoint
+
+      def clients(_id, opts = {})
+        begin
+          get("clients/#{_id}", opts)['WirelessClientLocation']
+        rescue CiscoMSE::NotFoundError => e
+          nil
+        end
+      end
+
+    end
+
+  end
+end

data/lib/cisco-mse-client/exceptions.rb

@@ -0,0 +1,24 @@
+# encoding: UTF-8
+
+##
+# Exceptions for using the Cisco MSE client
+# It is recommended that you handle these.
+##
+
+module CiscoMSE
+
+  class GenericException < StandardError; end
+
+  class TimeoutError < GenericException; end
+
+  # Some problems might take care of themselves if you try again later. Others won't.
+  class TemporaryError < GenericException; end # fire warnings on these
+  class PermanentError < GenericException; end # fire errors on these
+
+  # 404 (Not found)
+  class NotFoundError < GenericException; end
+
+  # 500 (Server error)
+  class ServiceError < GenericException; end
+
+end

data/lib/cisco-mse-client/middleware/authentication.rb

@@ -0,0 +1,28 @@
+require 'base64'
+
+require 'faraday'
+
+
+
+module CiscoMSE
+  module Middleware
+    module Request
+
+      # Authenticate our request
+      class Authentication < Faraday::Middleware
+        def call(env)
+          if env[:request][:client_options][:username] && env[:request][:client_options][:password]
+            username = env[:request][:client_options][:username]
+            password = env[:request][:client_options][:password]
+            encoded_string = Base64.encode64("#{username}:#{password}")
+
+            env[:request_headers]['Authorization'] = "Basic #{encoded_string}"
+          end
+
+          @app.call(env)
+        end
+      end
+
+    end
+  end
+end

data/lib/cisco-mse-client/middleware/exception_raiser.rb

@@ -0,0 +1,41 @@
+# encoding: UTF-8
+
+require 'faraday'
+
+require 'cisco-mse-client/exceptions'
+
+
+
+module CiscoMSE
+  module Middleware
+
+    ## Raise beautiful exceptions
+    #
+    class ExceptionRaiser < Faraday::Middleware
+
+      ## For handling errors, the message that gets returned is of the following format:
+      # {:status => env[:status], :headers => env[:response_headers], :body => env[:body]}
+
+      def call(env)
+        begin
+          @app.call(env)
+        rescue Faraday::Error::ClientError => e
+          exception =
+            case e.response[:status]
+            when 404
+              CiscoMSE::NotFoundError
+            when 500
+              CiscoMSE::ServiceError
+            else
+              CiscoMSE::GenericException
+            end
+          raise exception, e.response
+        rescue Saddle::TimeoutError => e
+          raise CiscoMSE::TimeoutError, e.response
+        end
+      end
+
+    end
+
+  end
+end

data/lib/cisco-mse-client/middleware/set_format.rb

@@ -0,0 +1,21 @@
+require 'faraday'
+
+
+
+module CiscoMSE
+  module Middleware
+    module Request
+
+      # Let the service know that we expect/accept JSON
+
+      class SetFormat < Faraday::Middleware
+        def call(env)
+          env[:request_headers]['Accept'] = 'application/json'
+
+          @app.call(env)
+        end
+      end
+
+    end
+  end
+end

data/lib/cisco-mse-client/stub.rb

@@ -0,0 +1,55 @@
+# encoding: UTF-8
+
+require 'cisco-mse-client/endpoints/location'
+
+# This allows us to stub out live calls when testing from calling projects
+
+module CiscoMSE
+  module Stub
+
+    # Setup stubbing for all endpoints
+    def stub!
+      CiscoMSE::Endpoints::Location.any_instance.stub(:clients).and_return( Stub::Data::Location::CLIENTS )
+    end
+
+    # Test data for stubs to return
+    module Data
+      module Location
+        CLIENTS = {
+          'macAddress' => '00:00:00:00:00:00',
+          'currentlyTracked' => true,
+          'confidenceFactor' => 200.0,
+          'band' => 'UNKNOWN',
+          'isGuestUser' => false,
+          'dot11Status' => 'PROBING',
+          'MapInfo' => {
+            'mapHierarchyString' => 'Campus>Building>1st Floor',
+            'floorRefId' => 1234567890,
+            'Dimension' => {
+              'length' => 228.1,
+              'width' => 319.4,
+              'height' => 14.0,
+              'offsetX' => 0.0,
+              'offsetY' => 0.0,
+              'unit' => 'FEET',
+            },
+            'Image' => {
+              'imageName' => 'domain_0_1381271699478.jpg',
+            },
+          },
+          'MapCoordinate' =>{
+            'x' => 106.71,
+            'y' => 167.93,
+            'unit' => 'FEET',
+          },
+          'Statistics' => {
+            'currentServerTime' => '2013-12-16T18:25:00.752-0500',
+            'firstLocatedTime' => '2013-12-13T10:50:01.581-0500',
+            'lastLocatedTime' => '2013-12-16T18:24:00.050-0500',
+          }
+        }
+      end
+    end
+
+  end
+end

data/lib/cisco-mse-client/version.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+module CiscoMSE
+  VERSION = '0.0.1'
+end

data/spec/_creds.stub.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+
+TEST_HOSTNAME = 'localhost'
+TEST_USERNAME = 'YOUR_USERNAME'
+TEST_PASSWORD = 'YOUR_PASSWORD'

data/spec/integration/location_spec.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+
+###
+# NOTE: This spec will actually hit CiscoMSE's servers
+###
+
+describe 'CiscoMSE::Endpoints::Location' do
+  context "Test integration of location endpoints" do
+
+    # Skip if the creds aren't setup
+    if defined?(TEST_HOSTNAME) && defined?(TEST_USERNAME) && defined?(TEST_PASSWORD)
+
+      before :each do
+        @client = CiscoMSE::Client.create(
+          host: TEST_HOSTNAME,
+          username: TEST_USERNAME,
+          password: TEST_PASSWORD,
+          extra_env: {
+            ssl: {
+              verify: false,
+            },
+          }
+        )
+      end
+
+      it 'should get client data' do
+        @client.location.clients('test')
+      end
+
+    else
+      puts "You should put valid creds in _creds.rb"
+    end
+
+  end
+end

data/spec/middleware/exception_raiser_spec.rb

@@ -0,0 +1,28 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+
+describe CiscoMSE::Middleware::ExceptionRaiser do
+
+  describe "Test raising various exceptions using stubs" do
+
+    before :each do
+      @stubs = Faraday::Adapter::Test::Stubs.new
+      @client = CiscoMSE::Client.create(stubs: @stubs)
+    end
+
+
+    it 'should detect a not found error' do
+      @stubs.get("#{CiscoMSE::Client.path_prefix}/") { [ 404, {}, {} ] }
+      expect { @client.requester.get('') }.to raise_error(CiscoMSE::NotFoundError)
+    end
+
+    it 'should detect a service error' do
+      @stubs.get("#{CiscoMSE::Client.path_prefix}/") { [ 500, {}, {} ] }
+      expect { @client.requester.get('') }.to raise_error(CiscoMSE::ServiceError)
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+
+require 'cisco-mse-client'
+
+
+# Load credentials from ENV if possible, or load from _creds.rb
+if ENV['TEST_USERNAME'] && ENV['TEST_PASSWORD']
+  TEST_HOSTNAME = ENV['TEST_HOSTNAME']
+  TEST_USERNAME = ENV['TEST_USERNAME']
+  TEST_PASSWORD = ENV['TEST_PASSWORD']
+else
+  begin
+    require '_creds'
+  rescue LoadError
+    puts "Using _creds.stub.rb, create a _creds.rb with actual credentials for a live test."
+  end
+end

data/spec/stub/stub_spec.rb

@@ -0,0 +1,22 @@
+# encoding: UTF-8
+
+require 'spec_helper'
+
+
+
+describe CiscoMSE::Stub do
+  context 'can stub out calls' do
+
+    before :each do
+      CiscoMSE::Client.stub!
+      @client = CiscoMSE::Client.create
+    end
+
+    describe 'and return test data' do
+      it 'for location.clients' do
+        @client.location.clients('test').should == CiscoMSE::Stub::Data::Location::CLIENTS
+      end
+    end
+
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: cisco-mse-client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Mike Lewis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: saddle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.49
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.49
+description: Cisco MSE client
+email:
+- mlewis.mail@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- cisco-mse-client.gemspec
+- lib/cisco-mse-client.rb
+- lib/cisco-mse-client/endpoints/location.rb
+- lib/cisco-mse-client/exceptions.rb
+- lib/cisco-mse-client/middleware/authentication.rb
+- lib/cisco-mse-client/middleware/exception_raiser.rb
+- lib/cisco-mse-client/middleware/set_format.rb
+- lib/cisco-mse-client/stub.rb
+- lib/cisco-mse-client/version.rb
+- spec/_creds.stub.rb
+- spec/integration/location_spec.rb
+- spec/middleware/exception_raiser_spec.rb
+- spec/spec_helper.rb
+- spec/stub/stub_spec.rb
+homepage: https://github.com/mLewisLogic/cisco-mse-client
+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.1.11
+signing_key: 
+specification_version: 4
+summary: This is a Cisco MSE client implemented on Saddle
+test_files:
+- spec/_creds.stub.rb
+- spec/integration/location_spec.rb
+- spec/middleware/exception_raiser_spec.rb
+- spec/spec_helper.rb
+- spec/stub/stub_spec.rb