dashboard-api 1.0.0 → 1.0.1

data/lib/dashboard-api/version.rb

@@ -1,6 +1,6 @@
-# Version number of the Gem build
-# @author Joe Letizia
-module DashboardAPIVersion
-  # Current version number of the gem
-  VERSION = "1.0.0"
-end
+# Version number of the Gem build
+# @author Joe Letizia
+module DashboardAPIVersion
+  # Current version number of the gem
+  VERSION = "1.0.1"
+end

data/lib/devices.rb

@@ -1,57 +1,57 @@
-# Devices section of the Meraki Dashboard API
-# @author Joe Letizia
-module Devices
-  # List all devices in a given network
-  # @param [String] network_id network that you want to get devices for
-  # @return [Array] array of hashes containing device information for all devices in the network
-  def list_devices_in_network(network_id)
-    self.make_api_call("/networks/#{network_id}/devices", 'GET')
-  end
-
-  # Device information for a specified device
-  # @param [String] network_id the network id where the device exists
-  # @param [String] device_serial the meraki serial number of the device you want to get
-  #   information for
-  # @return [Hash] a hash containing all of the devices attributes
-  def get_single_device(network_id, device_serial)
-    self.make_api_call("/networks/#{network_id}/devices/#{device_serial}", 'GET')
-  end
-
-  # Uplink information for a specified device
-  # @param [String] network_id network id where the device exists
-  # @param [String] device_serial meraki serial number of the device you want to check
-  # @return [Array] an array of hashes for each uplink and it's attributes
-  def get_device_uplink_stats(network_id, device_serial)
-    self.make_api_call("/networks/#{network_id}/devices/#{device_serial}/uplink", 'GET')
-  end
-
-  # Update a single devices attributes
-  # @param [String] network_id dashboard network id where the device exists
-  # @param [String] device_serial meraki serial number of the device you want to modify
-  # @param [Hash] options hash containing the attributes you want to modify.
-  #   such as name, tags, longitude, latitude. A full list is found on the official Meraki API Docs
-  # @return [Hash] a hash containing the devices new attribute set
-  def update_device_attributes(network_id, device_serial, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-    options = {:body => options}
-    self.make_api_call("/networks/#{network_id}/devices/#{device_serial}", 'PUT', options)
-  end
-
-  # Claim a single device into a network
-  # @param [String] network_id dashboard network id to claim device into
-  # @param [Hash] options hash containing :serial => 'meraki device SN' you want to claim
-  # @return [Integer] code returns the HTTP code of the API call
-  def claim_device_into_network(network_id, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-    options = {:body => options}
-    self.make_api_call("/networks/#{network_id}/devices/claim", 'POST', options) 
-  end
-
-  # Remove a single device from a network
-  # @param [String] network_id dashboard network id to remove device from
-  # @param [String] device_serial meraki serial number for device to remove
-  # @return [Integer] http_code HTTP code for API call
-  def remove_device_from_network(network_id, device_serial)
-    self.make_api_call("/networks/#{network_id}/devices/#{device_serial}/remove", 'POST')
-  end
-end
+# Devices section of the Meraki Dashboard API
+# @author Joe Letizia
+module Devices
+  # List all devices in a given network
+  # @param [String] network_id network that you want to get devices for
+  # @return [Array] array of hashes containing device information for all devices in the network
+  def list_devices_in_network(network_id)
+    self.make_api_call("/networks/#{network_id}/devices", 'GET')
+  end
+
+  # Device information for a specified device
+  # @param [String] network_id the network id where the device exists
+  # @param [String] device_serial the meraki serial number of the device you want to get
+  #   information for
+  # @return [Hash] a hash containing all of the devices attributes
+  def get_single_device(network_id, device_serial)
+    self.make_api_call("/networks/#{network_id}/devices/#{device_serial}", 'GET')
+  end
+
+  # Uplink information for a specified device
+  # @param [String] network_id network id where the device exists
+  # @param [String] device_serial meraki serial number of the device you want to check
+  # @return [Array] an array of hashes for each uplink and it's attributes
+  def get_device_uplink_stats(network_id, device_serial)
+    self.make_api_call("/networks/#{network_id}/devices/#{device_serial}/uplink", 'GET')
+  end
+
+  # Update a single devices attributes
+  # @param [String] network_id dashboard network id where the device exists
+  # @param [String] device_serial meraki serial number of the device you want to modify
+  # @param [Hash] options hash containing the attributes you want to modify.
+  #   such as name, tags, longitude, latitude. A full list is found on the official Meraki API Docs
+  # @return [Hash] a hash containing the devices new attribute set
+  def update_device_attributes(network_id, device_serial, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    
+    self.make_api_call("/networks/#{network_id}/devices/#{device_serial}", 'PUT', options)
+  end
+
+  # Claim a single device into a network
+  # @param [String] network_id dashboard network id to claim device into
+  # @param [Hash] options hash containing :serial => 'meraki device SN' you want to claim
+  # @return [Integer] code returns the HTTP code of the API call
+  def claim_device_into_network(network_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    
+    self.make_api_call("/networks/#{network_id}/devices/claim", 'POST', options) 
+  end
+
+  # Remove a single device from a network
+  # @param [String] network_id dashboard network id to remove device from
+  # @param [String] device_serial meraki serial number for device to remove
+  # @return [Integer] http_code HTTP code for API call
+  def remove_device_from_network(network_id, device_serial)
+    self.make_api_call("/networks/#{network_id}/devices/#{device_serial}/remove", 'POST')
+  end
+end

data/lib/networks.rb

@@ -1,108 +1,108 @@
-# Networks section of the Meraki Dashboard API
-# @author Joe Letizia
-module Networks
-  # Returns the list of networks for a given organization
-  # @param [String] org_id dashboard organization ID
-  # @return [Array] an array of hashes containing the network details
-  def get_networks(org_id)
-    self.make_api_call("/organizations/#{org_id}/networks", 'GET')
-  end
-
-  # Returns the network details for a single network
-  # @param [String] network_id dashboard network ID
-  # @return [Hash] a hash containing the network details of the specific network
-  def get_single_network(network_id)
-    self.make_api_call("/networks/#{network_id}", 'GET')
-  end
-
-  # Updates a network's details
-  # @param [String] network_id dashboard network ID
-  # @param [Hash] options a hash containing any of the following keys:
-  #   name: the network name
-  #   tags: tags assigned to the network
-  # @return [Hash] a hash containing the updated network details
-  def update_network(network_id, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-    options = {:body => options}
-    self.make_api_call("/networks/#{network_id}",'PUT', options)
-  end
-
-  # Create a new Dashboard network
-  # @param [String] org_id dashboard organization ID
-  # @param [Hash] options a hash containing the following options:
-  #   name: the network name (REQUIRED)
-  #   type: the type of network (wireless, switch, appliance, or phone) (REQUIRED)
-  #   tags: tags for the network (NOT REQUIRED)
-  # @return [Hash] a hash containing the new networks details
-  def create_network(org_id, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-    options = {:body => options}
-    self.make_api_call("/organizations/#{org_id}/networks", 'POST', options)
-  end
-
-  # Delete an existing Dashboard network
-  # @param [String] network_id dashboard netwok ID to delete
-  # @return [Bool] status true if the network was deleted, false if not
-  def delete_network(network_id)
-    res = self.make_api_call("/networks/#{network_id}", 'DELETE')
-    return res.code == 204 ? true : false
-  end
-
-  # Get AutoVPN settings for a specific network
-  # @param [String] network_id dashboard network ID to get AutoVPN settings for
-  # @return [Hash] a hash containing the AutoVPN details for the network
-  def get_auto_vpn_settings(network_id)
-    res = self.make_api_call("/networks/#{network_id}/siteToSiteVpn", 'GET')
-  end
-
-  # Update AutoVPN for a specific network
-  # @param [String] network_id dashboard network ID to update AutoVPN settings for
-  # @param [Hash] options options hash containing the following options:
-  #   mode: hub, spoke or none
-  #   hubs: an array of Hashes containing the hubId and a true or false for useDefaultRoute
-  #   subnets: an array of Hashes containing localSubnet and useVPN
-  # @return [Hash]
-  def update_auto_vpn_settings(network_id, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-
-    options = {:body => options}
-    res = self.make_api_call("/networks/#{network_id}/siteToSiteVpn", 'PUT', options)
-  end
-
-  # Get all MS access policies configured for a specific Dashboard network
-  # @param [String] network_id dashboard network ID to get MS policies for
-  # @return [Array] an array of hashes for containing the policy information
-  def get_ms_access_policies(network_id)
-    res = self.make_api_call("/networks/#{network_id}/accessPolicies", 'GET')
-    return res
-  end
-
-  # Bind a single network to a configuration template
-  # @param [String] network_id the source network that you want to bind to a tempalte
-  # @param [Hash] options options hash that contains configTemplateId and autoBind values. Refer to the official
-  #   Meraki Dashboard API documentation for more information on these.
-  # @return [Integer] HTTP Code
-  def bind_network_to_template(network_id, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-    options = {:body => options}
-
-    self.make_api_call("/networks/#{network_id}/bind", 'POST', options)
-  end
-
-  # Unbind a single network from a configuration template
-  # @param [String] network_id the network that you want to unbind from it's template
-  # @return [Integer] HTTP Code
-  def unbind_network_to_template(network_id)
-    self.make_api_call("/networks/#{network_id}/unbind", 'POST')
-  end
-
-  # Return traffic analysis data for a network
-  # @param [String] network_id network that you want data for
-  # @param [Hash] options options hash containing a timespan and deviceType. Refer to the official
-  #   Meraki Dashboard API documentation for more information on these.
-  def traffic_analysis(network_id, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-    options = {:body => options}
-    self.make_api_call("/networks/#{network_id}/traffic", 'GET', options)
-  end
-end
+# Networks section of the Meraki Dashboard API
+# @author Joe Letizia
+module Networks
+  # Returns the list of networks for a given organization
+  # @param [String] org_id dashboard organization ID
+  # @return [Array] an array of hashes containing the network details
+  def get_networks(org_id)
+    self.make_api_call("/organizations/#{org_id}/networks", 'GET')
+  end
+
+  # Returns the network details for a single network
+  # @param [String] network_id dashboard network ID
+  # @return [Hash] a hash containing the network details of the specific network
+  def get_single_network(network_id)
+    self.make_api_call("/networks/#{network_id}", 'GET')
+  end
+
+  # Updates a network's details
+  # @param [String] network_id dashboard network ID
+  # @param [Hash] options a hash containing any of the following keys:
+  #   name: the network name
+  #   tags: tags assigned to the network
+  # @return [Hash] a hash containing the updated network details
+  def update_network(network_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    
+    self.make_api_call("/networks/#{network_id}",'PUT', options)
+  end
+
+  # Create a new Dashboard network
+  # @param [String] org_id dashboard organization ID
+  # @param [Hash] options a hash containing the following options:
+  #   name: the network name (REQUIRED)
+  #   type: the type of network (wireless, switch, appliance, or phone) (REQUIRED)
+  #   tags: tags for the network (NOT REQUIRED)
+  # @return [Hash] a hash containing the new networks details
+  def create_network(org_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    
+    self.make_api_call("/organizations/#{org_id}/networks", 'POST', options)
+  end
+
+  # Delete an existing Dashboard network
+  # @param [String] network_id dashboard netwok ID to delete
+  # @return [Bool] status true if the network was deleted, false if not
+  def delete_network(network_id)
+    res = self.make_api_call("/networks/#{network_id}", 'DELETE')
+    return res.code == 204 ? true : false
+  end
+
+  # Get AutoVPN settings for a specific network
+  # @param [String] network_id dashboard network ID to get AutoVPN settings for
+  # @return [Hash] a hash containing the AutoVPN details for the network
+  def get_auto_vpn_settings(network_id)
+    res = self.make_api_call("/networks/#{network_id}/siteToSiteVpn", 'GET')
+  end
+
+  # Update AutoVPN for a specific network
+  # @param [String] network_id dashboard network ID to update AutoVPN settings for
+  # @param [Hash] options options hash containing the following options:
+  #   mode: hub, spoke or none
+  #   hubs: an array of Hashes containing the hubId and a true or false for useDefaultRoute
+  #   subnets: an array of Hashes containing localSubnet and useVPN
+  # @return [Hash]
+  def update_auto_vpn_settings(network_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+
+    
+    res = self.make_api_call("/networks/#{network_id}/siteToSiteVpn", 'PUT', options)
+  end
+
+  # Get all MS access policies configured for a specific Dashboard network
+  # @param [String] network_id dashboard network ID to get MS policies for
+  # @return [Array] an array of hashes for containing the policy information
+  def get_ms_access_policies(network_id)
+    res = self.make_api_call("/networks/#{network_id}/accessPolicies", 'GET')
+    return res
+  end
+
+  # Bind a single network to a configuration template
+  # @param [String] network_id the source network that you want to bind to a tempalte
+  # @param [Hash] options options hash that contains configTemplateId and autoBind values. Refer to the official
+  #   Meraki Dashboard API documentation for more information on these.
+  # @return [Integer] HTTP Code
+  def bind_network_to_template(network_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    
+
+    self.make_api_call("/networks/#{network_id}/bind", 'POST', options)
+  end
+
+  # Unbind a single network from a configuration template
+  # @param [String] network_id the network that you want to unbind from it's template
+  # @return [Integer] HTTP Code
+  def unbind_network_to_template(network_id)
+    self.make_api_call("/networks/#{network_id}/unbind", 'POST')
+  end
+
+  # Return traffic analysis data for a network
+  # @param [String] network_id network that you want data for
+  # @param [Hash] options options hash containing a timespan and deviceType. Refer to the official
+  #   Meraki Dashboard API documentation for more information on these.
+  def traffic_analysis(network_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    
+    self.make_api_call("/networks/#{network_id}/traffic", 'GET', options)
+  end
+end

data/lib/organizations.rb

@@ -1,115 +1,110 @@
-# Organization section of the Meraki Dashboard API
-# @author Joe Letizia
-module Organizations
-  # Returns information about an organization
-  # @param [String] org_id dashboard organization ID
-  # @return [Hash] results contains the org  id and name of the given organization
-  def get_organization(org_id)
-    self.make_api_call("/organizations/#{org_id}", 'GET')
-  end
-
-  # Returns the current license state for a given organization
-  # @param [String] org_id dashboard organization ID
-  # @return [Hash] results contains the current license state information
-  def get_license_state(org_id)
-    self.make_api_call("/organizations/#{org_id}/licenseState", 'GET')
-  end
-
-  # Returns the current inventory for an organization
-  # @param [String] org_id dashboard organization ID
-  # @return [Array] an array of hashes containg information on each individual device
-  def get_inventory(org_id)
-    self.make_api_call("/organizations/#{org_id}/inventory", 'GET')
-  end
-
-  # Returns the current SNMP status for an organization
-  # @param [String] org_id dashboard organization ID
-  # @return [Hash] a hash containing all SNMP configuration information for an organization
-  def get_snmp_settings(org_id)
-    self.make_api_call("/organizations/#{org_id}/snmp", 'GET')
-  end
-
-  # Updates the current SNMP status for an organization
-  # @param [String] org_id dashboard organization ID
-  # @param [Hash] options a hash containing all updated SNMP configuration information for an organization. Please
-  #   refer to official Dashboard API documentation for more information on these options: v2cEnabled, v3Enabled,
-  #   v3AuthMode, v3AuthPass, v3PrivMode, v3PrivPass, peerIps
-  # @return [Hash] a hash containing all SNMP configuration information for an organization
-  def update_snmp_settings(org_id, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-
-    options = {:body => options}
-    self.make_api_call("/organizations/#{org_id}/snmp", 'PUT', options)
-  end
-
-  # Returns the configurations for an organizations 3rd party VPN peers
-  # @param [String] org_id dashboard organization ID
-  # @return [Array] an arrry of hashes containing the configuration information
-  #   for each 3rd party VPN peer
-  def get_third_party_peers(org_id)
-    self.make_api_call("/organizations/#{org_id}/thirdPartyVPNPeers", 'GET')
-  end
-
-  # Updates your third party peers
-  # @param [String] org_id dashboard organization ID
-  # @params [Array] options An array of Hashes representing all configured third party peer. Takes the keys of name,
-  #   publicIp, privateSubnets and secret
-  # @return [Array] returns the array of hashes for all currently configured 3rd party peers
-  def update_third_party_peers(org_id, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-
-    options = {:body => options}
-    self.make_api_call("/organizations/#{org_id}/thirdPartyVPNPeers", 'PUT', options)
-  end
-
-  # Returns all organizations a user is an administrator on
-  # @return [Array] an array of hashes containing the organizations and their attributes
-  def list_all_organizations
-    self.make_api_call("/organizations", 'GET')
-  end
-
-  # Update an organization
-  # @param [String] org_id the organization ID that you want to update
-  # @param [Hash] options an options hash containing the org ID and new name of the org
-  # @return [Hash] the updated attributes of the organization
-  def update_organization(org_id, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-
-    options = {:body => options}
-    self.make_api_call("/organizations/#{org_id}", 'PUT', options)
-  end
-
-  # Create a new organization
-  # @param [Hash] options an options hash containing the name of the new organization
-  # @return [Hash] the attributes of the newly created organization
-  def create_organization(options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-
-    options = {:body => options}
-    self.make_api_call("/organizations", 'POST', options)
-  end
-
-  # Clone an organization
-  # @param [String] source_org_id the source organization that we want to clone from
-  # @param [Hash] options options hash containing the attributes for the new organization
-  # @return [Hash] the attributes of the newly cloned organization
-  def clone_organization(source_org_id, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-
-    options = {:body => options}
-    self.make_api_call("/organizations/#{source_org_id}/clone", 'POST', options)
-  end
-
-  # Claim something
-  # @param [String] org_id the organization that you want to claim to
-  # @param [Hash] options a hash containing information about what you want to claim. This can be order,
-  #   serial, licenseKey and licenseMode. Refer to the official Dashboard API documentation for more information
-  #   about these
-  # @return [Integer] HTTP Code
-  def claim(org_id, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-
-    options = {:body => options}
-    self.make_api_call("/organizations/#{org_id}/claim", 'POST', options)
-  end
-end
+# Organization section of the Meraki Dashboard API
+# @author Joe Letizia
+module Organizations
+  # Returns information about an organization
+  # @param [String] org_id dashboard organization ID
+  # @return [Hash] results contains the org  id and name of the given organization
+  def get_organization(org_id)
+    self.make_api_call("/organizations/#{org_id}", 'GET')
+  end
+
+  # Returns the current license state for a given organization
+  # @param [String] org_id dashboard organization ID
+  # @return [Hash] results contains the current license state information
+  def get_license_state(org_id)
+    self.make_api_call("/organizations/#{org_id}/licenseState", 'GET')
+  end
+
+  # Returns the current inventory for an organization
+  # @param [String] org_id dashboard organization ID
+  # @return [Array] an array of hashes containg information on each individual device
+  def get_inventory(org_id)
+    self.make_api_call("/organizations/#{org_id}/inventory", 'GET')
+  end
+
+  # Returns the current SNMP status for an organization
+  # @param [String] org_id dashboard organization ID
+  # @return [Hash] a hash containing all SNMP configuration information for an organization
+  def get_snmp_settings(org_id)
+    self.make_api_call("/organizations/#{org_id}/snmp", 'GET')
+  end
+
+  # Updates the current SNMP status for an organization
+  # @param [String] org_id dashboard organization ID
+  # @param [Hash] options a hash containing all updated SNMP configuration information for an organization. Please
+  #   refer to official Dashboard API documentation for more information on these options: v2cEnabled, v3Enabled,
+  #   v3AuthMode, v3AuthPass, v3PrivMode, v3PrivPass, peerIps
+  # @return [Hash] a hash containing all SNMP configuration information for an organization
+  def update_snmp_settings(org_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+
+
+    self.make_api_call("/organizations/#{org_id}/snmp", 'PUT', options)
+  end
+
+  # Returns the configurations for an organizations 3rd party VPN peers
+  # @param [String] org_id dashboard organization ID
+  # @return [Array] an arrry of hashes containing the configuration information
+  #   for each 3rd party VPN peer
+  def get_third_party_peers(org_id)
+    self.make_api_call("/organizations/#{org_id}/thirdPartyVPNPeers", 'GET')
+  end
+
+  # Updates your third party peers
+  # @param [String] org_id dashboard organization ID
+  # @params [Array] options An array of Hashes representing all configured third party peer. Takes the keys of name,
+  #   publicIp, privateSubnets and secret
+  # @return [Array] returns the array of hashes for all currently configured 3rd party peers
+  def update_third_party_peers(org_id, options)
+    raise 'Options were not passed as an Array' if !options.is_a?(Array)
+
+    self.make_api_call("/organizations/#{org_id}/thirdPartyVPNPeers", 'PUT', options)
+  end
+
+  # Returns all organizations a user is an administrator on
+  # @return [Array] an array of hashes containing the organizations and their attributes
+  def list_all_organizations
+    self.make_api_call("/organizations", 'GET')
+  end
+
+  # Update an organization
+  # @param [String] org_id the organization ID that you want to update
+  # @param [Hash] options an options hash containing the org ID and new name of the org
+  # @return [Hash] the updated attributes of the organization
+  def update_organization(org_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+
+    self.make_api_call("/organizations/#{org_id}", 'PUT', options)
+  end
+
+  # Create a new organization
+  # @param [Hash] options an options hash containing the name of the new organization
+  # @return [Hash] the attributes of the newly created organization
+  def create_organization(options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+
+    self.make_api_call("/organizations", 'POST', options)
+  end
+
+  # Clone an organization
+  # @param [String] source_org_id the source organization that we want to clone from
+  # @param [Hash] options options hash containing the attributes for the new organization
+  # @return [Hash] the attributes of the newly cloned organization
+  def clone_organization(source_org_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+
+    self.make_api_call("/organizations/#{source_org_id}/clone", 'POST', options)
+  end
+
+  # Claim something
+  # @param [String] org_id the organization that you want to claim to
+  # @param [Hash] options a hash containing information about what you want to claim. This can be order,
+  #   serial, licenseKey and licenseMode. Refer to the official Dashboard API documentation for more information
+  #   about these
+  # @return [Integer] HTTP Code
+  def claim(org_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+
+    self.make_api_call("/organizations/#{org_id}/claim", 'POST', options)
+  end
+end