RubyGems - dashboard-api - Versions diffs - 1.0.0 → 1.0.1 - Mend

dashboard-api 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (49) hide show

checksums.yaml +4 -4
data/.codeclimate.yml +34 -0
data/.gitignore +5 -4
data/.travis.yml +20 -0
data/Gemfile +9 -5
data/Gemfile.lock +63 -31
data/README.md +134 -138
data/Rakefile +9 -7
data/dashboard-api.gemspec +28 -28
data/doc/Admins.html +603 -603
data/doc/Clients.html +276 -276
data/doc/DashboardAPI.html +603 -603
data/doc/DashboardAPIVersion.html +159 -159
data/doc/Devices.html +879 -879
data/doc/Networks.html +1382 -1382
data/doc/Organizations.html +1477 -1477
data/doc/Phones.html +641 -641
data/doc/SAML.html +758 -758
data/doc/SSIDs.html +523 -523
data/doc/Switchports.html +526 -526
data/doc/Templates.html +378 -378
data/doc/VLANs.html +762 -762
data/doc/_index.html +235 -235
data/doc/class_list.html +51 -51
data/doc/css/full_list.css +58 -58
data/doc/css/style.css +481 -481
data/doc/file.README.html +248 -248
data/doc/file_list.html +56 -56
data/doc/frames.html +17 -17
data/doc/index.html +248 -248
data/doc/js/app.js +243 -243
data/doc/js/full_list.js +216 -216
data/doc/js/jquery.js +3 -3
data/doc/method_list.html +523 -523
data/doc/top-level-namespace.html +113 -113
data/lib/admins.rb +37 -37
data/lib/clients.rb +12 -12
data/lib/dashboard-api.rb +82 -83
data/lib/dashboard-api/version.rb +6 -6
data/lib/devices.rb +57 -57
data/lib/networks.rb +108 -108
data/lib/organizations.rb +110 -115
data/lib/phones.rb +40 -40
data/lib/saml.rb +47 -47
data/lib/ssids.rb +33 -33
data/lib/switchports.rb +33 -33
data/lib/templates.rb +18 -18
data/lib/vlans.rb +49 -49
metadata +7 -5

data/doc/top-level-namespace.html CHANGED

@@ -1,114 +1,114 @@
-<!DOCTYPE html>
-<html>
-  <head>
-    <meta charset="utf-8">
-<meta name="viewport" content="width=device-width, initial-scale=1.0">
-<title>
-  Top Level Namespace
-    &mdash; Documentation by YARD 0.9.5
-</title>
-  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
-  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
-<script type="text/javascript" charset="utf-8">
-  pathId = "";
-  relpath = '';
-</script>
-  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
-  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
-  </head>
-  <body>
-    <div class="nav_wrap">
-      <iframe id="nav" src="class_list.html"></iframe>
-      <div id="resizer"></div>
-    </div>
-    <div id="main" tabindex="-1">
-      <div id="header">
-        <div id="menu">
-    <a href="_index.html">Index</a> &raquo;
-    <span class="title">Top Level Namespace</span>
-</div>
-        <div id="search">
-    <a class="full_list_link" id="class_list_link"
-        href="class_list.html">
-        <svg width="24" height="24">
-          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
-          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
-        </svg>
-    </a>
-</div>
-        <div class="clear"></div>
-      </div>
-      <iframe id="search_frame" src="class_list.html"></iframe>
-      <div id="content"><h1>Top Level Namespace
-</h1>
-<div class="box_info">
-</div>
-<h2>Defined Under Namespace</h2>
-<p class="children">
-      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Admins.html" title="Admins (module)">Admins</a></span>, <span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span>, <span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span>, <span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span>, <span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span>, <span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="Phones.html" title="Phones (module)">Phones</a></span>, <span class='object_link'><a href="SAML.html" title="SAML (module)">SAML</a></span>, <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span>, <span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span>, <span class='object_link'><a href="Templates.html" title="Templates (module)">Templates</a></span>, <span class='object_link'><a href="VLANs.html" title="VLANs (module)">VLANs</a></span>
-      <strong class="classes">Classes:</strong> <span class='object_link'><a href="DashboardAPI.html" title="DashboardAPI (class)">DashboardAPI</a></span>
-</p>
-</div>
-      <div id="footer">
-  Generated on Thu Nov 17 22:15:38 2016 by
-  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.9.5 (ruby-2.3.0).
-</div>
-    </div>
-  </body>
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1.0">
+<title>
+  Top Level Namespace
+    &mdash; Documentation by YARD 0.9.5
+</title>
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+<script type="text/javascript" charset="utf-8">
+  pathId = "";
+  relpath = '';
+</script>
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+  </head>
+  <body>
+    <div class="nav_wrap">
+      <iframe id="nav" src="class_list.html"></iframe>
+      <div id="resizer"></div>
+    </div>
+    <div id="main" tabindex="-1">
+      <div id="header">
+        <div id="menu">
+    <a href="_index.html">Index</a> &raquo;
+    <span class="title">Top Level Namespace</span>
+</div>
+        <div id="search">
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+        <svg width="24" height="24">
+          <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
+          <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
+        </svg>
+    </a>
+</div>
+        <div class="clear"></div>
+      </div>
+      <iframe id="search_frame" src="class_list.html"></iframe>
+      <div id="content"><h1>Top Level Namespace
+</h1>
+<div class="box_info">
+</div>
+<h2>Defined Under Namespace</h2>
+<p class="children">
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="Admins.html" title="Admins (module)">Admins</a></span>, <span class='object_link'><a href="Clients.html" title="Clients (module)">Clients</a></span>, <span class='object_link'><a href="DashboardAPIVersion.html" title="DashboardAPIVersion (module)">DashboardAPIVersion</a></span>, <span class='object_link'><a href="Devices.html" title="Devices (module)">Devices</a></span>, <span class='object_link'><a href="Networks.html" title="Networks (module)">Networks</a></span>, <span class='object_link'><a href="Organizations.html" title="Organizations (module)">Organizations</a></span>, <span class='object_link'><a href="Phones.html" title="Phones (module)">Phones</a></span>, <span class='object_link'><a href="SAML.html" title="SAML (module)">SAML</a></span>, <span class='object_link'><a href="SSIDs.html" title="SSIDs (module)">SSIDs</a></span>, <span class='object_link'><a href="Switchports.html" title="Switchports (module)">Switchports</a></span>, <span class='object_link'><a href="Templates.html" title="Templates (module)">Templates</a></span>, <span class='object_link'><a href="VLANs.html" title="VLANs (module)">VLANs</a></span>
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="DashboardAPI.html" title="DashboardAPI (class)">DashboardAPI</a></span>
+</p>
+</div>
+      <div id="footer">
+  Generated on Thu Nov 17 22:15:38 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.9.5 (ruby-2.3.0).
+</div>
+    </div>
+  </body>
 </html>

data/lib/admins.rb CHANGED

@@ -1,37 +1,37 @@
-# Admins section of the Meraki Dashboard API
-# @author Joe Letizia
-module Admins
-  # List all of the administrators for a given org
-  # @param [String] org_id organization ID you want the list of administrators for
-  # @return [Array] an array of hashes containing each admin and their attributes
-  def list_admins(org_id)
-    self.make_api_call("/organizations/#{org_id}/admins", 'GET')
-  end
-  # Add an admin to a specific org
-  # @param [String] org_id organization ID you want to add an administrator to
-  # @param [Hash] options option hash containing attributes for the new admin. Can contain:
-  #   email, name, orgAccess, tags and networks. See the Meraki API Documentation for more details.
-  def add_admin(org_id, options)
-    options = {:body => options}
-    self.make_api_call("/organizations/#{org_id}/admins", 'POST', options)
-  end
-  # Update an administrator for a specific org
-  # @param [String] org_id organization ID you want to update an administrator on
-  # @param [String] admin_id ID of the admin you want to update
-  # @param [Hash] options hash containing the attributes and values you want to update. Can contain:
-  #   email, name, orgAccess, tags and networks. See the Meraki API Documentation for more details.
-  def update_admin(org_id, admin_id, options)
-    options = {:body => options}
-    self.make_api_call("/organizations/#{org_id}/admins/#{admin_id}", 'PUT', options)
-  end
-  # Revoke an administrator for a specific org
-  # @param [String] org_id organization ID you want to revoke access on
-  # @param [String] admin_id ID of the administrator you want to revoke
-  # @return [Integer] HTTP Code
-  def revoke_admin(org_id, admin_id)
-    self.make_api_call("/organizations/#{org_id}/admins/#{admin_id}", 'DELETE')
-  end
-end
+# Admins section of the Meraki Dashboard API
+# @author Joe Letizia
+module Admins
+  # List all of the administrators for a given org
+  # @param [String] org_id organization ID you want the list of administrators for
+  # @return [Array] an array of hashes containing each admin and their attributes
+  def list_admins(org_id)
+    self.make_api_call("/organizations/#{org_id}/admins", 'GET')
+  end
+  # Add an admin to a specific org
+  # @param [String] org_id organization ID you want to add an administrator to
+  # @param [Hash] options option hash containing attributes for the new admin. Can contain:
+  #   email, name, orgAccess, tags and networks. See the Meraki API Documentation for more details.
+  def add_admin(org_id, options)
+  #
+    self.make_api_call("/organizations/#{org_id}/admins", 'POST', options)
+  end
+  # Update an administrator for a specific org
+  # @param [String] org_id organization ID you want to update an administrator on
+  # @param [String] admin_id ID of the admin you want to update
+  # @param [Hash] options hash containing the attributes and values you want to update. Can contain:
+  #   email, name, orgAccess, tags and networks. See the Meraki API Documentation for more details.
+  def update_admin(org_id, admin_id, options)
+#
+    self.make_api_call("/organizations/#{org_id}/admins/#{admin_id}", 'PUT', options)
+  end
+  # Revoke an administrator for a specific org
+  # @param [String] org_id organization ID you want to revoke access on
+  # @param [String] admin_id ID of the administrator you want to revoke
+  # @return [Integer] HTTP Code
+  def revoke_admin(org_id, admin_id)
+    self.make_api_call("/organizations/#{org_id}/admins/#{admin_id}", 'DELETE')
+  end
+end

data/lib/clients.rb CHANGED

@@ -1,12 +1,12 @@
-# Clients section of the Meraki Dashboard API
-# @author Joe Letizia
-module Clients
-  # Return client usage for a specific device
-  # @param [String] serial meraki serial number of the device
-  # @param [Integer] timespan timespan up to 1 month in seconds to get client usage for
-  # @return [Array] an array of hashes for each client's usage
-  def get_client_info_for_device(serial, timespan)
-    raise 'Timespan can not be larger than 2592000 seconds' if timespan.to_i > 2592000
-    self.make_api_call("/devices/#{serial}/clients?timespan=#{timespan}", 'GET')
-  end
-end
+# Clients section of the Meraki Dashboard API
+# @author Joe Letizia
+module Clients
+  # Return client usage for a specific device
+  # @param [String] serial meraki serial number of the device
+  # @param [Integer] timespan timespan up to 1 month in seconds to get client usage for
+  # @return [Array] an array of hashes for each client's usage
+  def get_client_info_for_device(serial, timespan)
+    raise 'Timespan can not be larger than 2592000 seconds' if timespan.to_i > 2592000
+    self.make_api_call("/devices/#{serial}/clients?timespan=#{timespan}", 'GET')
+  end
+end

data/lib/dashboard-api.rb CHANGED

@@ -1,83 +1,82 @@
-require 'httparty'
-require 'json'
-require_relative "dashboard-api/version"
-require 'organizations'
-require 'networks'
-require 'admins'
-require 'devices'
-require 'templates'
-require 'clients'
-require 'phones'
-require 'ssids'
-require 'vlans'
-require 'switchports'
-require 'saml'
-# Ruby Implementation of the Meraki Dashboard api
-# @author Joe Letizia
-class DashboardAPI
-  include HTTParty
-  include Organizations
-  include DashboardAPIVersion
-  include Networks
-  include Clients
-  include Devices
-  include SSIDs
-  include Admins
-  include Switchports
-  include VLANs
-  include Phones
-  include Templates
-  include SAML
-  base_uri "https://dashboard.meraki.com/api/v0"
-  attr_reader :key
-  def initialize(key)
-    @key = key
-  end
-  # @private
-  # Inner function, not to be called directly
-  # @todo Eventually this will need to support POST, PUT and DELETE. It also
-  #   needs to be a bit more resillient, instead of relying on HTTParty for exception
-  #   handling
-  def make_api_call(endpoint_url, http_method, options_hash={})
-    headers = {"X-Cisco-Meraki-API-Key" => @key, 'Content-Type' => 'application/json'}
-    headers.merge!(options_hash[:headers]) if options_hash[:headers]
-    options = {:headers => headers, :body => options_hash[:body].to_json}
-    case http_method
-    when 'GET'
-      res = HTTParty.get("#{self.class.base_uri}/#{endpoint_url}", options)
-      raise "404 returned. Are you sure you are using the proper IDs?" if res.code == 404
-      raise "Bad request due to the following error(s): #{JSON.parse(res.body)['errors']}" if res.body.include?('errors')
-      return JSON.parse(res.body)
-    when 'POST'
-      res = HTTParty.post("#{self.class.base_uri}/#{endpoint_url}", options)
-      raise "Bad Request due to the following error(s): #{res['errors']}" if res['errors']
-      raise "404 returned. Are you sure you are using the proper IDs?" if res.code == 404
-      begin
-        return JSON.parse(res.body)
-      rescue JSON::ParserError => e
-        return res.code
-      rescue TypeError => e
-        return res.code
-      end
-    when 'PUT'
-      res = HTTParty.put("#{self.class.base_uri}/#{endpoint_url}", options)
-      # needs to check for is an array, because when you update a 3rd party VPN peer, it returns as an array
-      # if you screw something up, it returns as a Hash, and will hit the normal if res['errors'
-      raise "Bad Request due to the following error(s): #{res['errors']}" if res['errors'] unless JSON.parse(res.body).is_a? Array
-      raise "404 returned. Are you sure you are using the proper IDs?" if res.code == 404
-      return JSON.parse(res.body)
-    when 'DELETE'
-      res = HTTParty.delete("#{self.class.base_uri}/#{endpoint_url}", options)
-      raise "Bad Request due to the following error(s): #{res['errors']}" if res['errors']
-      raise "404 returned. Are you sure you are using the proper IDs?" if res.code == 404
-      return res
-    else
-      raise 'Invalid HTTP Method. Only GET, POST, PUT and DELETE are supported.'
-    end
-  end
-end
+require 'httparty'
+require 'json'
+require_relative "dashboard-api/version"
+require 'organizations'
+require 'networks'
+require 'admins'
+require 'devices'
+require 'templates'
+require 'clients'
+require 'phones'
+require 'ssids'
+require 'vlans'
+require 'switchports'
+require 'saml'
+# Ruby Implementation of the Meraki Dashboard api
+# @author Joe Letizia
+class DashboardAPI
+  include HTTParty
+  include Organizations
+  include DashboardAPIVersion
+  include Networks
+  include Clients
+  include Devices
+  include SSIDs
+  include Admins
+  include Switchports
+  include VLANs
+  include Phones
+  include Templates
+  include SAML
+  base_uri "https://dashboard.meraki.com/api/v0"
+  attr_reader :key
+  def initialize(key)
+    @key = key
+  end
+  # @private
+  # Inner function, not to be called directly
+  # @todo Eventually this will need to support POST, PUT and DELETE. It also
+  #   needs to be a bit more resillient, instead of relying on HTTParty for exception
+  #   handling
+  def make_api_call(endpoint_url, http_method, options_hash={})
+    headers = {"X-Cisco-Meraki-API-Key" => @key, 'Content-Type' => 'application/json'}
+    options = {:headers => headers, :body => options_hash.to_json}
+    case http_method
+    when 'GET'
+      res = HTTParty.get("#{self.class.base_uri}/#{endpoint_url}", options)
+      raise "404 returned. Are you sure you are using the proper IDs?" if res.code == 404
+      raise "Bad request due to the following error(s): #{JSON.parse(res.body)['errors']}" if res.body.include?('errors')
+      return JSON.parse(res.body)
+    when 'POST'
+      res = HTTParty.post("#{self.class.base_uri}/#{endpoint_url}", options)
+      raise "Bad Request due to the following error(s): #{res['errors']}" if res['errors']
+      raise "404 returned. Are you sure you are using the proper IDs?" if res.code == 404
+      begin
+        return JSON.parse(res.body)
+      rescue JSON::ParserError => e
+        return res.code
+      rescue TypeError => e
+        return res.code
+      end
+    when 'PUT'
+      res = HTTParty.put("#{self.class.base_uri}/#{endpoint_url}", options)
+      # needs to check for is an array, because when you update a 3rd party VPN peer, it returns as an array
+      # if you screw something up, it returns as a Hash, and will hit the normal if res['errors'
+      (raise "Bad Request due to the following error(s): #{res['errors']}" if res['errors']) unless JSON.parse(res.body).is_a? Array
+      raise "404 returned. Are you sure you are using the proper IDs?" if res.code == 404
+      return JSON.parse(res.body)
+    when 'DELETE'
+      res = HTTParty.delete("#{self.class.base_uri}/#{endpoint_url}", options)
+      raise "Bad Request due to the following error(s): #{res['errors']}" if res['errors']
+      raise "404 returned. Are you sure you are using the proper IDs?" if res.code == 404
+      return res
+    else
+      raise 'Invalid HTTP Method. Only GET, POST, PUT and DELETE are supported.'
+    end
+  end
+end