dashboard-api 1.0.0 → 1.0.1

data/lib/phones.rb

@@ -1,40 +1,40 @@
-# Phones section of the Meraki Dashboard API
-# @author Joe Letizia
-module Phones
-
-  # Get list of phone contacts
-  # @param [String] network_id the network id you want to list contacts for
-  # @return [Array] an array of hashes containing attribute information for each contact
-  def list_phone_contacts(network_id)
-    self.make_api_call("/networks/#{network_id}/phoneContacts", 'GET')
-  end
-
-  # Add a single phone contact
-  # @param [String] network_id the network id you want to add the contact to
-  # @param [Hash] options an options hash that contains the contact attributes. Currently only supports the name attribute.
-  # @return [Hash] returns the hash containing the contact attributes
-  def add_phone_contact(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}/phoneContacts", 'POST', options)
-  end
-
-  # Update a single phone contact
-  # @param [String] network_id the network id you want to update the contact in
-  # @param [String] contact_id the ID of the contact you want to update
-  # @param [Hash] options an options hash that contains the contact attributes. Currently only supports the name attribute.
-  # @return [Hash] returns the hash containing the contacts updated attributes
-  def update_phone_contact(network_id, contact_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}/phoneContacts/#{contact_id}", 'PUT', options)
-  end
-
-  # Delete a single phone contact
-  # @param [String] network_id the network id you want to delete the contact on
-  # @param [String] contact_id the ID of the contact you want to delete
-  # @return [Integer] HTTP Code
-  def delete_phone_contact(network_id, contact_id)
-    self.make_api_call("/networks/#{network_id}/phoneContacts/#{contact_id}", 'DELETE')
-  end
-end
+# Phones section of the Meraki Dashboard API
+# @author Joe Letizia
+module Phones
+
+  # Get list of phone contacts
+  # @param [String] network_id the network id you want to list contacts for
+  # @return [Array] an array of hashes containing attribute information for each contact
+  def list_phone_contacts(network_id)
+    self.make_api_call("/networks/#{network_id}/phoneContacts", 'GET')
+  end
+
+  # Add a single phone contact
+  # @param [String] network_id the network id you want to add the contact to
+  # @param [Hash] options an options hash that contains the contact attributes. Currently only supports the name attribute.
+  # @return [Hash] returns the hash containing the contact attributes
+  def add_phone_contact(network_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    
+    self.make_api_call("/networks/#{network_id}/phoneContacts", 'POST', options)
+  end
+
+  # Update a single phone contact
+  # @param [String] network_id the network id you want to update the contact in
+  # @param [String] contact_id the ID of the contact you want to update
+  # @param [Hash] options an options hash that contains the contact attributes. Currently only supports the name attribute.
+  # @return [Hash] returns the hash containing the contacts updated attributes
+  def update_phone_contact(network_id, contact_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    
+    self.make_api_call("/networks/#{network_id}/phoneContacts/#{contact_id}", 'PUT', options)
+  end
+
+  # Delete a single phone contact
+  # @param [String] network_id the network id you want to delete the contact on
+  # @param [String] contact_id the ID of the contact you want to delete
+  # @return [Integer] HTTP Code
+  def delete_phone_contact(network_id, contact_id)
+    self.make_api_call("/networks/#{network_id}/phoneContacts/#{contact_id}", 'DELETE')
+  end
+end

data/lib/saml.rb

@@ -1,47 +1,47 @@
-# SAML section of the Meraki Dashboard API
-# @author Joe Letizia
-module SAML
-  # List all SAML roles defined on an organization
-  # @param [String] org_id organization ID you want the SAML roles from
-  # @return [Array] an array of hashes containing each SAML role and it's attributes
-  def list_saml_roles(org_id)
-    self.make_api_call("/organizations/#{org_id}/samlRoles", 'GET')
-  end
-
-  # Create a new SAML role on an organization
-  # @param [String] org_id organization ID you want to create the SAML roles on
-  # @param [Hash] options an options hash containing the attributes for the SAML role. Can include role, orgAccess, tags, and networks.
-  #   Refer to the Meraki Dashboard API for more information on these tags
-  # @return [Hash] returns the newly created SAML role
-  def create_saml_role(org_id, options)
-    options = {:body => options}
-    self.make_api_call("/organizations/#{org_id}/samlRoles", 'POST', options)
-  end
-
-  # Update an existing SAML role on an organization
-  # @param [String] org_id organization ID you want to update the SAML roles on
-  # @param [String] saml_id the ID of the SAML role that you want to update
-  # @param [Hash] options an options hash containing the attributes for the SAML role. Can include role, orgAccess, tags, and networks.
-  #   Refer to the Meraki Dashboard API for more information on these tags
-  # @return [Hahs] returns the updated SAML role
-  def update_saml_role(org_id, saml_id, options)
-    options = {:body => options}
-    self.make_api_call("/organizations/#{org_id}/samlRoles/#{saml_id}", 'PUT', options)
-  end
-
-  # Return a single SAML role
-  # @param [String] org_id organization ID you want to return the SAML roles on
-  # @param [String] saml_id the ID of the SAML role that you want to return
-  # @return [Hash] returns the request SAML role
-  def return_saml_role(org_id, saml_id)
-    self.make_api_call("/organizations/#{org_id}/samlRoles/#{saml_id}", 'GET')
-  end
-
-  # Remove a single SAML role
-  # @param [String] org_id organization ID you want to remove the SAML roles on
-  # @param [String] saml_id the ID of the SAML role that you want to remove
-  # @return [Integer] HTTP Code
-  def remove_saml_role(org_id, saml_id)
-    self.make_api_call("/organizations/#{org_id}/samlRoles/#{saml_id}", 'DELETE')
-  end
-end
+# SAML section of the Meraki Dashboard API
+# @author Joe Letizia
+module SAML
+  # List all SAML roles defined on an organization
+  # @param [String] org_id organization ID you want the SAML roles from
+  # @return [Array] an array of hashes containing each SAML role and it's attributes
+  def list_saml_roles(org_id)
+    self.make_api_call("/organizations/#{org_id}/samlRoles", 'GET')
+  end
+
+  # Create a new SAML role on an organization
+  # @param [String] org_id organization ID you want to create the SAML roles on
+  # @param [Hash] options an options hash containing the attributes for the SAML role. Can include role, orgAccess, tags, and networks.
+  #   Refer to the Meraki Dashboard API for more information on these tags
+  # @return [Hash] returns the newly created SAML role
+  def create_saml_role(org_id, options)
+    
+    self.make_api_call("/organizations/#{org_id}/samlRoles", 'POST', options)
+  end
+
+  # Update an existing SAML role on an organization
+  # @param [String] org_id organization ID you want to update the SAML roles on
+  # @param [String] saml_id the ID of the SAML role that you want to update
+  # @param [Hash] options an options hash containing the attributes for the SAML role. Can include role, orgAccess, tags, and networks.
+  #   Refer to the Meraki Dashboard API for more information on these tags
+  # @return [Hahs] returns the updated SAML role
+  def update_saml_role(org_id, saml_id, options)
+    
+    self.make_api_call("/organizations/#{org_id}/samlRoles/#{saml_id}", 'PUT', options)
+  end
+
+  # Return a single SAML role
+  # @param [String] org_id organization ID you want to return the SAML roles on
+  # @param [String] saml_id the ID of the SAML role that you want to return
+  # @return [Hash] returns the request SAML role
+  def return_saml_role(org_id, saml_id)
+    self.make_api_call("/organizations/#{org_id}/samlRoles/#{saml_id}", 'GET')
+  end
+
+  # Remove a single SAML role
+  # @param [String] org_id organization ID you want to remove the SAML roles on
+  # @param [String] saml_id the ID of the SAML role that you want to remove
+  # @return [Integer] HTTP Code
+  def remove_saml_role(org_id, saml_id)
+    self.make_api_call("/organizations/#{org_id}/samlRoles/#{saml_id}", 'DELETE')
+  end
+end

data/lib/ssids.rb

@@ -1,33 +1,33 @@
-# SSIDs section of the Meraki Dashboard API
-# @author Joe Letizia
-module SSIDs
-  # Get a list of the SSIDs and their attributes for a network
-  # @param [String] network_id network id where the SSIDs you exists are
-  # @return [Array] an array of Hashes containing the SSID attributes
-  def list_ssids_in_network(network_id)
-    self.make_api_call("/networks/#{network_id}/ssids", 'GET')
-  end
-
-  # Get the attributes for a single SSID
-  # @param [String] network_id network id where the SSID you want to list is
-  # @param [Integer] ssid_number the SSID number you want to change. Range is from 0-14
-  # @return [Hash] the attributes for the requested SSID
-  def get_single_ssid(network_id, ssid_number)
-    raise "Please provide a valid SSID number" unless (ssid_number.is_a?(Integer) && ssid_number <= 14)
-    self.make_api_call("/networks/#{network_id}/ssids/#{ssid_number}", 'GET')
-  end
-
-  # Update the attributes for a single SSID
-  # @param [String] network_id network id where the SSID you want to change is
-  # @param [Integer] ssid_number the SSID number you want to change. Range is from 0-14
-  # @param [Hash] options hash containing the attributes to update. Can include name, enabled, authMode, encryptionMode and psk
-  # @return [Hash] the updated attributes for the SSID
-  def update_single_ssid(network_id, ssid_number, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-    raise "Please provide a valid SSID number" unless (ssid_number.is_a?(Integer) && ssid_number <= 14)
-    options = {:body => options}
-
-    self.make_api_call("/networks/#{network_id}/ssids/#{ssid_number}", 'PUT', options)
-  end
-
-end
+# SSIDs section of the Meraki Dashboard API
+# @author Joe Letizia
+module SSIDs
+  # Get a list of the SSIDs and their attributes for a network
+  # @param [String] network_id network id where the SSIDs you exists are
+  # @return [Array] an array of Hashes containing the SSID attributes
+  def list_ssids_in_network(network_id)
+    self.make_api_call("/networks/#{network_id}/ssids", 'GET')
+  end
+
+  # Get the attributes for a single SSID
+  # @param [String] network_id network id where the SSID you want to list is
+  # @param [Integer] ssid_number the SSID number you want to change. Range is from 0-14
+  # @return [Hash] the attributes for the requested SSID
+  def get_single_ssid(network_id, ssid_number)
+    raise "Please provide a valid SSID number" unless (ssid_number.is_a?(Integer) && ssid_number <= 14)
+    self.make_api_call("/networks/#{network_id}/ssids/#{ssid_number}", 'GET')
+  end
+
+  # Update the attributes for a single SSID
+  # @param [String] network_id network id where the SSID you want to change is
+  # @param [Integer] ssid_number the SSID number you want to change. Range is from 0-14
+  # @param [Hash] options hash containing the attributes to update. Can include name, enabled, authMode, encryptionMode and psk
+  # @return [Hash] the updated attributes for the SSID
+  def update_single_ssid(network_id, ssid_number, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    raise "Please provide a valid SSID number" unless (ssid_number.is_a?(Integer) && ssid_number <= 14)
+    
+
+    self.make_api_call("/networks/#{network_id}/ssids/#{ssid_number}", 'PUT', options)
+  end
+
+end

data/lib/switchports.rb

@@ -1,33 +1,33 @@
-# Switchports section of the Meraki Dashboard API
-# @author Joe Letizia
-module Switchports
-  # Get configuration for all switchports on a given switch
-  # @param [String] device_serial meraki serial number of the switch
-  # @return [Array] an array of Hashes, each containing the switchports attributes / configuration
-  def get_switch_ports(device_serial)
-    self.make_api_call("/devices/#{device_serial}/switchPorts", 'GET')
-  end
-
-  # Get configuration for a single switch port
-  # @param [String] device_serial meraki serial number of the switch
-  # @param [Integer] port_number port number you want to modify 
-  # @return [Hash] hash of the switch ports attributes
-  def get_single_switch_port(device_serial, port_number)
-    raise 'Invalid switchport provided' unless port_number.is_a?(Integer)
-    self.make_api_call("/devices/#{device_serial}/switchPorts/#{port_number}", 'GET')
-  end
-
-  # Update the attributes for a given switchport
-  # @param [String] device_serial meraki serial number of the switch
-  # @param [Integer] port_number port number you want to modify 
-  # @param [Hash] options hash of attributes. Keys can include name, tags, enabled, type, vlan, voiceVlan
-  #   allowedVlans, poeEnabled, isolationEnabled, rstpEnabled, stpGuard, accessPolicyNumber. For values to these keys, please refer to the official Meraki Dashboard API documentation.
-  # @return [Hash] hash of the update port attributes
-  def update_switchport(device_serial, port_number, options)
-    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
-    raise 'Invalid switchport provided' unless port_number.is_a?(Integer)
-    options = {:body => options}
-    
-    self.make_api_call("/devices/#{device_serial}/switchPorts/#{port_number}", 'PUT', options)
-  end
-end
+# Switchports section of the Meraki Dashboard API
+# @author Joe Letizia
+module Switchports
+  # Get configuration for all switchports on a given switch
+  # @param [String] device_serial meraki serial number of the switch
+  # @return [Array] an array of Hashes, each containing the switchports attributes / configuration
+  def get_switch_ports(device_serial)
+    self.make_api_call("/devices/#{device_serial}/switchPorts", 'GET')
+  end
+
+  # Get configuration for a single switch port
+  # @param [String] device_serial meraki serial number of the switch
+  # @param [Integer] port_number port number you want to modify 
+  # @return [Hash] hash of the switch ports attributes
+  def get_single_switch_port(device_serial, port_number)
+    raise 'Invalid switchport provided' unless port_number.is_a?(Integer)
+    self.make_api_call("/devices/#{device_serial}/switchPorts/#{port_number}", 'GET')
+  end
+
+  # Update the attributes for a given switchport
+  # @param [String] device_serial meraki serial number of the switch
+  # @param [Integer] port_number port number you want to modify 
+  # @param [Hash] options hash of attributes. Keys can include name, tags, enabled, type, vlan, voiceVlan
+  #   allowedVlans, poeEnabled, isolationEnabled, rstpEnabled, stpGuard, accessPolicyNumber. For values to these keys, please refer to the official Meraki Dashboard API documentation.
+  # @return [Hash] hash of the update port attributes
+  def update_switchport(device_serial, port_number, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    raise 'Invalid switchport provided' unless port_number.is_a?(Integer)
+    
+    
+    self.make_api_call("/devices/#{device_serial}/switchPorts/#{port_number}", 'PUT', options)
+  end
+end

data/lib/templates.rb

@@ -1,18 +1,18 @@
-# Templates section of the Meraki Dashboard API
-# @author Joe Letizia
-module Templates
-  # Return a list of all templates for a specific organization
-  # @param [String] org_id organization ID where that we want to list all of the templates from
-  # @return [Array] an array of hashes containing the attributes for all configuration templates
-  def list_templates(org_id)
-    self.make_api_call("/organizations/#{org_id}/configTemplates", 'GET')
-  end
-  
-  # Remove a single configuration template
-  # @param [String] org_id organization ID where that we want to remove the templates from
-  # @param [String] template_id the template ID we want to delete
-  # @return [Integer] HTTP code
-  def remove_template(org_id, template_id)
-    self.make_api_call("/organizations/#{org_id}/configTemplates/#{template_id}", 'DELETE')
-  end
-end
+# Templates section of the Meraki Dashboard API
+# @author Joe Letizia
+module Templates
+  # Return a list of all templates for a specific organization
+  # @param [String] org_id organization ID where that we want to list all of the templates from
+  # @return [Array] an array of hashes containing the attributes for all configuration templates
+  def list_templates(org_id)
+    self.make_api_call("/organizations/#{org_id}/configTemplates", 'GET')
+  end
+  
+  # Remove a single configuration template
+  # @param [String] org_id organization ID where that we want to remove the templates from
+  # @param [String] template_id the template ID we want to delete
+  # @return [Integer] HTTP code
+  def remove_template(org_id, template_id)
+    self.make_api_call("/organizations/#{org_id}/configTemplates/#{template_id}", 'DELETE')
+  end
+end

data/lib/vlans.rb

@@ -1,49 +1,49 @@
-# VLANs section of the Meraki Dashboard API
-# @author Joe Letizia
-module VLANs
-  # Returns a list of the configured VLANs in a Dashboard network
-  # @param [String] network_id the network ID you want the VLANs for
-  # @return [Array] an array of hashes containing each VLAN and it's attributes
-  def list_vlans(network_id)
-    self.make_api_call("/networks/#{network_id}/vlans", 'GET')
-  end
- 
-  # Return a single configured VLAN for a network
-  # @param [String] network_id the network ID the VLAN exists in
-  # @param [Integer] vlan_id the VLAN ID you want the attributes for
-  # @return [Hash] a hash of the VLAN's attributes 
-  def return_vlan(network_id, vlan_id)
-    self.make_api_call("/networks/#{network_id}/vlans/#{vlan_id}", 'GET')
-  end
-
-  # Add a single VLAN to a network
-  # @param [String] network_id the network you want to add a VLAN to
-  # @param [Hash] options a hash containing the attributes of id, name, subnet and applianceIp
-  #   additional details on these can be found in the official Meraki API Documentation
-  # @return [Hash] the attributes of the newly created vlan
-  def add_vlan(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}/vlans", 'POST', options)
-  end
-
-  # Update the attributes for a single VLAN
-  # @param [String] network_id the network ID for the VLAN you want to update
-  # @param [Integer] vlan_id the VLAN ID you want to update
-  # @param [Hash] options a hash containing the attributes of name, subnet and applianceIp.
-  #   additional details on these can be found in the official Meraki API Documentation
-  # @return [Hash] the updated attributes for the VLAN
-  def update_vlan(network_id, vlan_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}/vlans/#{vlan_id}", 'PUT', options)
-  end
-
-  # Delete a single vlan
-  # @param [String] network_id the Network ID for the VLAN you want to delete
-  # @param [Integer] vlan_id the VLAN ID you want to delete
-  # @return [Integer] code HTTP return code
-  def delete_vlan(network_id, vlan_id)
-    self.make_api_call("/networks/#{network_id}/vlans/#{vlan_id}", 'DELETE')
-  end
-end
+# VLANs section of the Meraki Dashboard API
+# @author Joe Letizia
+module VLANs
+  # Returns a list of the configured VLANs in a Dashboard network
+  # @param [String] network_id the network ID you want the VLANs for
+  # @return [Array] an array of hashes containing each VLAN and it's attributes
+  def list_vlans(network_id)
+    self.make_api_call("/networks/#{network_id}/vlans", 'GET')
+  end
+ 
+  # Return a single configured VLAN for a network
+  # @param [String] network_id the network ID the VLAN exists in
+  # @param [Integer] vlan_id the VLAN ID you want the attributes for
+  # @return [Hash] a hash of the VLAN's attributes 
+  def return_vlan(network_id, vlan_id)
+    self.make_api_call("/networks/#{network_id}/vlans/#{vlan_id}", 'GET')
+  end
+
+  # Add a single VLAN to a network
+  # @param [String] network_id the network you want to add a VLAN to
+  # @param [Hash] options a hash containing the attributes of id, name, subnet and applianceIp
+  #   additional details on these can be found in the official Meraki API Documentation
+  # @return [Hash] the attributes of the newly created vlan
+  def add_vlan(network_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    
+    self.make_api_call("/networks/#{network_id}/vlans", 'POST', options)
+  end
+
+  # Update the attributes for a single VLAN
+  # @param [String] network_id the network ID for the VLAN you want to update
+  # @param [Integer] vlan_id the VLAN ID you want to update
+  # @param [Hash] options a hash containing the attributes of name, subnet and applianceIp.
+  #   additional details on these can be found in the official Meraki API Documentation
+  # @return [Hash] the updated attributes for the VLAN
+  def update_vlan(network_id, vlan_id, options)
+    raise 'Options were not passed as a Hash' if !options.is_a?(Hash)
+    
+    self.make_api_call("/networks/#{network_id}/vlans/#{vlan_id}", 'PUT', options)
+  end
+
+  # Delete a single vlan
+  # @param [String] network_id the Network ID for the VLAN you want to delete
+  # @param [Integer] vlan_id the VLAN ID you want to delete
+  # @return [Integer] code HTTP return code
+  def delete_vlan(network_id, vlan_id)
+    self.make_api_call("/networks/#{network_id}/vlans/#{vlan_id}", 'DELETE')
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dashboard-api
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Joe Letizia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-18 00:00:00.000000000 Z
+date: 2018-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.9.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.5
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -102,7 +102,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -167,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.2
 signing_key: 
 specification_version: 4
 summary: A Ruby implementation of the Meraki Dashboard API