dashboard-api 0.3.0

data/lib/dashboard-api/version.rb

@@ -0,0 +1,3 @@
+module DashboardAPIVersion
+  VERSION = "0.3.0"
+end

data/lib/devices.rb

@@ -0,0 +1,55 @@
+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] 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

@@ -0,0 +1,80 @@
+# 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')
+    puts res
+    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
+end

data/lib/organizations.rb

@@ -0,0 +1,39 @@
+# 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_status(org_id)
+    self.make_api_call("/organizations/#{org_id}/snmp", 'GET')
+  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
+end

data/lib/ssids.rb

@@ -0,0 +1,31 @@
+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

metadata

@@ -0,0 +1,162 @@
+--- !ruby/object:Gem::Specification
+name: dashboard-api
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Joe Letizia
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.5
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.3
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.0
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+description: A Ruby implementation of the Meraki Dashboard API. It allows you to interact
+  and provision the Meraki Dashboard via their RESTful API
+email:
+- letiziajm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- dashboard-api.gemspec
+- doc/Clients.html
+- doc/DashboardAPI.html
+- doc/DashboardAPIVersion.html
+- doc/Devices.html
+- doc/Networks.html
+- doc/Organizations.html
+- doc/SSIDs.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
+- lib/clients.rb
+- lib/dashboard-api.rb
+- lib/dashboard-api/version.rb
+- lib/devices.rb
+- lib/networks.rb
+- lib/organizations.rb
+- lib/ssids.rb
+homepage: https://github.com/jletizia/dashboardapi
+licenses: []
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby implementation of the Meraki Dashboard API
+test_files: []