dashboard-api 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fe6ff96f28e3094c3518fe307c09794656e2f9a
-  data.tar.gz: e861bfecfc0f90fee654e0175bd63dea7bc0dbf8
+  metadata.gz: 76f99b3ba5f01a335d52b5578bb6e9543076e81e
+  data.tar.gz: 12731012f9e74c580c0d07351dcd8e11438fc561
 SHA512:
-  metadata.gz: cf14d3502d0e1e120815d1d900b54b54cb6578cbd94ce733edcf00a0c19d1119b2213dbf997dde6c5d7ee7bc7bd18e1201cb836299e623f7d15371cea3010100
-  data.tar.gz: cd18dafbbd891cd29e45c5ec38bb85fb8f916320a33f4ed7b10968f47745034c9e1e4a2b3fb3d25d4401ffa5fc8e393f4911cdcc83ed9a6d2b062e06e0102d80
+  metadata.gz: ad02d784855e57a5a0ad6098744cdca5f73c31cfe0da99f0ff4aa7a5b6032a78575ffe403a25cff7fa556893bf3b100c8005740bba4ba32c2184c2f635d09211
+  data.tar.gz: d1fd20cca6cf3ba00def18c6e11ef5ac0b43eb0559315ef3915e9ffa9fa732d2c7fd254b77e47403be910c98cc6b2052ab5097011745ed946295c24d7c2bc6fc

data/.codeclimate.yml

@@ -0,0 +1,34 @@
+---
+engines:
+  bundler-audit:
+    enabled: true
+  csslint:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+      - javascript
+      - python
+      - php
+  eslint:
+    enabled: true
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.css"
+  - "**.inc"
+  - "**.js"
+  - "**.jsx"
+  - "**.module"
+  - "**.php"
+  - "**.py"
+  - "**.rb"
+exclude_paths:
+- test/
+- doc/

data/.gitignore

@@ -1,4 +1,5 @@
-fixtures/
-.yardoc
-_Yardoc
-.DS_Store
+fixtures/
+tools/
+.yardoc
+_Yardoc
+.DS_Store

data/.travis.yml

@@ -0,0 +1,20 @@
+language: ruby
+rvm:
+    - 2.3.0
+cache:
+  directories:
+    - fixtures
+after_success:
+    - coveralls
+env:
+  global:
+  - secure: Xap2VUqjAVjlspW6A6LK3VpBptIPXLzdx4XVYJJC4J61MmfcHwUX4rb0LVSvAPS1wiji7cjmmBJVhy5PyOn3JFGe+PiWEGjnn9OcVmr650mOhX6+3net+QDHYLz8phrX+WjNBmdK/uuZaeV4b8F/iPm0CRSF5WjUFRwPJVzH9pj1gtcdiWNv+spjPSEnTuF+ws1nOpmZ2Xu1vlajeEZC1GF6iaHgwYM1XCqRuNsrv2EQr1c6Dupl9jZmbeGcluFNVWnOn41JuBvnVgs7cZkaJC89h8waXnagfcuRTdM1B61L4DPpRbcxCWG7eVsfVft0ejLbaMnZqDs5usLJAdf6PM0vID57PdrWLwzX8f4STh4VtjM7sfXZQHloPJlBkBlUenwWfOvqHsmwgQjqd4SSTFReZrc2Z8YQR0S9ulNtAIR58X+kI3/zJW/1MDbB3RkB+PIAQodRK4NJK52czmRQtvLjEONzDO8ubyruBWCqKY0x1DlcIkt2sZatBPe/w6r5K2bKF+lHZW6WXGNkbtj2h9q0qVgcWshPP9S+iEfrwrVqMyUWE/JIM6vu6DE/rd0Jw19IeFj6nYxG6hVfSBClWAuVGmOfWqgx8Lc3XmD8htgrT6zcIpOWLTdnXwywyiCPICCUUu01/W8qqXwwR5MA0UaEsoBehmoV2bDT3UOMr30=
+  - secure: tKqHedMq0IssTYZINtgkX3KV3yPGE6+mm9netbbA1ZU1Uq8xr6jMLbeGZIWYzb8RkwzFyOO70OvL1aB9/PVe2CXqyvYxqCNLSmB2t+9AAiue1WXt/xr6k5gGUXbTzRdsnYyehzcGQKqG2p3ppp+Cx282ZFk3FlkTw+WyZrZeOGJGFhhoKVDGb8VyE+Ythd5ZVfqQ9Sbt7+Pd+jmBFfBh6sAVg+gkAfYyYz+rBO6SPyiICU7cIuHR1ox/3hjVCrSfGioTchtPjUHh3hFaCa0X5Gl9Em5H7h4xjI+dTlHP2LPC20vpPygiWqgUF8vDWKlKZ2P5xSfwCLeneqOE6N1ALm1Ld75572rFzlEnPkhMJot6zSWEc5ukCWG5kGz7Rq9lTco5hhaVCMyDOhNpQpIzP/02Bsoz/g0hBNOJ4O3Otfrvqq2g2+0hgfDF4AqlfuIl+u0mAvUMfj5hKIL002+xJdon16FicFvZ5I4smGoYD8yVL1WlZ+nHQ95w7HF8RDkkTp31B4lP5WB5yyvMxExMlm1Q1DCFUtH1xD3bHDC/oTZmFF4iXI0nWG3J11idkuc5cqaXARuv6Ebt+6SnfLDET1Os9ymsQKp9zrHQ9X7gDz0UlzZuvXD3ikKWeWqcM3HNq0+BkB4mGJbV9/iO6sZagu2jnIgaTO0O2qpdSZX7w50=
+  - secure: gWBWTdBq+yE5w41pVeUP58BBFtLyhdSEE7DDR9sXYL94CddmSoevnquIh5T1A5zUTi8hLLYM/mJhLbLKnEDn6nXN2y0X/xA1KOTLLO2eAQhjXc5VnQwkDbLNEzjscx3ISTcm0IyigQJuvRZENL7SdqydmnVDmoV4RbXcYzTTJ7EoG4OaRGHxKjmZJDyEGgcMUznA7+6f+Amlaj35Sre8pNBnXJf+TSQTNsS3mc2IRpdCm70dL5P0dK13X0bdQ4Jemx5RbIpionffHk0DUoWOFCKKyRJl7h0GJWLPQFFmCJrSHBfuTUk197G0kKIBd0tdGv1iFww1UsXQuAbRw286uK5kX5q55nATwQnMpNcGjPlbwAId+LakaqCQX+PjFMCStXbLZZ4/8nEUPrthu86pCO6Yhj3TYxOagY8hhG0On6sgOI9x0RbnRbe4LqcucX40uNjTB+CG2/HHGxHBferXI6lbD6zy2/fvS3SPRVP+HpbvDlim6+BBn1S/FrDD54RbkqWBU9H+T9ZLo+RqRWc6aabRtPMf0nX+D1APlp4T3OHNupSia7zBYxDlVGNtl/Rn6dCYTNxxLbh58u6fa3GTaFqIWFu5YAJQyHmJJZiUMWAGYAMBSkKlCLE1jGFmFvIWR6IKDQZ9EIB54i1Jo40/cP0gNK7Ic+yrdJcrWgcCsFQ=
+  - secure: gi2wM2D5AmSIimCe0zckd+kZsFTfXU7WAO5Wnsdq9oVq0Y080J2+heb+XMVfIZ6W10pAsgDcjhfUClVaYaDAqczniBauqHUWxfoC3FvHVg5RfUAbWcLWXwXYkbrKNrPN+6FcRGu3iw2xdlmIHw6VBADHgIbkQdVlOIEYJHoFk2ZlSD4pAfSffDZaN10N26BEHTRrqDzfFQV60c2l8qelrg53G6mZh3NG1rdti1weQ8ay/884y8Y1GXg9ZfE1XgqEygpaZDIPGVxW1h4X+Azg2U0nJno/rKJQur6cnLfysSyEWeIzEANGlKAwH0Z9TNgaFA3DMJ2dIGnnyl5+sW7nJ7xcXzrBQr+EizqdWs6g4/S4LgQlZ+nF+bKjg3oOpHQtx17ExBZ5dRFrbD/e6lsVureJK/4xx1l408Q6hxv5QWhHKjnuu7sd6YR3XhpHagGVSB+5NiOqxsstx34Ouen1jktQoVbEOdZz3UtK2Iv0QAN9lJsmilV2A68ISko9bLfAi/cfCuytVrRJwHgKA3S5kCTzyMkNgBB3b2KQENgGB23T8EjjbGYqkjKIGc4iUrBejLTsqk6ApKfyzln8044ML2a7fnUJXsP3XQuhNLg2sdhPkw+fwB9ylIXdOoqZ89JLx6Mw29C6If7FVBxRyLNpTYIjQGKUA9yLYfkIVmbiwPM=
+  - secure: PktYWdrmvuzPeTRF+sMyGRL3gz2QAAp9HXsgO4i1ddM0e4SUGKcZsMIaSTopyxHaLQ8/nTzLL8W2h7x+XgEPQSEoMP02g+MNqp/KQKfOcONZFV62xAVTqlmpg3I2bBfQhRoTfQ240R7NdyyeSVY+Z2yry4+e6JyoyaWvW0NeFMEchrOXTfwlu6b3U/teK85duGCkZSSW88W9taI/xLZcM8vy4X8y15KnjLqs957kFNmk2Qkr8+xIPE7jv9XFzg5feP5/vuKMv7uPg4iYdXoyhCvvtme1TJNd/Vc8tE8C9f83K7EoUDFAaPCclhVLKJPxNgpOkAJVJre3Haer7kyx0HP8edCULw/dRNVoTWnVrpa+VTW55QNGOQzHrcva9AX5xeBndsg2uxwpmkTH7V3k5kDQep/DwawR2CIg3O4v1z7pz6roixPDqA4C0Wqxaaq5tr2knbGALpdlMH0ZVP2Xt6XMdJ+OVTQ99vyImVNuymYDdKir0Iq37YbIB2lbLjxyWSC9ghPKMO2XH/LgTlyLdMAYzhq7s/LdRxl4chVTj+0xnpD3Qbgb4cBmIL2GB+rsH1KbpLQusfG4cIY/hz9ewlDcL5J5sPd+dwnlZodz/jJ77kJDBNqrVGgExQIGAgQulwR+IcZAkZp75ZDgdSPJ8TSnlsMpdcntF9XliP06+7E=
+  - secure: kfjGcv1j/JRQkRUld4S+X3xXX/4urigXr5nYaPfdoaAA6B6jSBPS3IXl/H3bmjYMm8jxTj2EFy+4iP7x33j/UKL/E7KiusWpnBmcxs59ZBmar4ju67zmnblb8wxWtUNVUPvMvXPc3V3WPElvttaVgZileY7CJY/p+TMmV7wQuy28BVIOk56CNhWW0cxbIsXcX7y81ETJBKwF4nz0YICmSVa+BEDtgH37GReljjOvXyms+lO2mcazssI4IzfmJTFl6Kx6+5mYHyvV+K0xA/QvYAGmYYo6oLFr6X/zkWJPpVqLlRD2EL+BYkYWWWs6als28zLYe4lAt1twYDkyDzBJDv4JVWnqdfC3iHy2HB8/NuON07LXGg5WAp6XhMc3J23+YnE27kDSNIsVASAmfiFLRGQNBa+ltp9IsnFxot4M8dO54OCY1zezOf0TjsuVBsl/1yMo+IDTz2gkxgScOpV/Rx8pYx4x0GGnat6n2YoA6udY06XpphfUP00WQEXljN8rbu6/UP4KNOHkLCLU3TJhMcnb6yZboi8Hx6h3U+ru/5ce+UBzXD/btOU0eIHuUZW823sva6dKrTUf2Qlx5x2pvrDv2tzOmYFC5rWzeimuADHrO+46O7n0iLWgfMAmtLXpLXWtbZHrtSSsLGFaSgGPjTXkx8zvgxRtqVpCSBlPcKM=
+  - secure: fJBf7aseEY3JnMr+U5pbRuOpiMV0Mfj2ZZ9/7nWoZBz3zuHcmBEfYkFReiusB7l1DlzDb64YOXJCo3CnEhhiiBYM42Lw9kQyKNvPXeDA93fKcRYppQuRC/bkQ6MXVJWU4pFKFdR6cbTKciorwVdU2QcxU7EbrmxTjCT0mH6Dl/GH/dRSDpyc0UquF/QMsBWYV3V1Ony49A9yj3Pk+I4OHNh7YtmbqooCpjMx0f8cveirsaQDTyREEweGSHNo3Vfcx36wXsrXkBC2kCU6y42gteyTObAtSmSSrYaU8/aKTGEkgfOnz5lYTLIXa0r24HgFrHWcE3zdgbeKnh8YMuJLAB2WWzFNkjJx5EAF35puu58DrgVASigB5OH8wc0l0yN7ZEimggT9vaR3tu9OQ9r77KDL8jYPlb4s4fWTM41EkYow6O3q9m97Kyt5Qegs8lBljf0cD93YWE0iCfSLIaRcBRlHDuTpaxXxIWewctPwq8hciZ9BT61Z0cJUD0/FNO3vCZzuXxt2Z5OP73JyQweZGke1xrNSVnrTiHKS2dSOxcgmVGVn/+ZT9TrHzD50hcVMRQKJ5mn/NasfCbPyLzJ56eEGV+2yn84xOmHNmqEz+oAmLCgOqvrhtx5L91/l61F2dLg+mZwl0wBNTZ4ZUw/6F9WocY1yZ+kRG4Qsz15Jxk4=
+  - secure: SOO7//JqvWyi8NYMnGWS16BfmEu54bJQp9KN5G+wF+0fXwohaN0dEud5j/gKof4DA3Bu4r7L9hw45XFmRfenX8LbgDYImKb0geGw3Qd1xXYJrlRiBFM3Jbr+vYFlYNzm3HUYojU5FxB5thQkTLlUyTlhLg93TUnurIrZg1MOnc4i9hnd9hCGefvf9LhX3ntMiNxCaHh+ZnR69bBm/EWaTLDU/oB2BcxmYrXXlg8BhuBX3C3556mpVKfjhuu6loh8QWCmM7lQoAEOZp9HHTyxB3gG8q6l1wI7r647Ffl6Y7zhaYuO+xlINXqjByJKc+t0oOv+X/EnX8/8VWpJtacuCh2qfeMbTms84az3YBuVlVRQSDSHiXgDSZJH7S9S6xEkE+meYXhv6FdJmvF75Yh7OwgR7Q8dq6ZzlqGnpJ9jDDTL/dvIaePmGYd1YwMOoNaKO+hCJbK7Cu0RAZtq0rGB9ioPrzAmjf+EN8CpWsQRPqYAdoPyh3+x82FSgFu4jTIqj50CikkK6YN7cFu18bjwbIIQA6Abs/mTJPtR42ad88nPrgCeoXTeMseOWZbq6Y0hPy561bIST1vcUJaeZfNIEDQHlay2oo5bSJxwOjgeR3PTdxDYH1TxFvaYGxKJoD3n/rhmL6N0d/VeFZLr0wcmvI4X9H+S43pY9UaURKeYBj0=
+  - secure: JGrjnYIqj61DF67rZ6qMvCdyxkqFRofSxh/WVcSZV81eYwtS49fGNzAuJ+/sMCGx5IzivB1HMdnOZvbm36BReXVK9GUDQlHb6CFiH0/cdJXYosSOb3vqFEMpu6nHnqzZY7MwTjWXyRcCqclasKDW0pMmF+5MR91JEsfgwd4q0ehjIdm+UTz0mrZF6TMDguRb0nXlIOcN81buPf1uB0YM4NBQNrfrZyo+Ov9b2EgM7Csnjyi9FcSNO0eiYY+Ym3uTVn+bRRSUlgQF0J/y8RfD8atgrHnp8cvnWPau09yMHTvdaWZ566nGdtEfXWF8CXJ/OYDMPnBYp0LC7WvTqgi8gYiuVFo6Kr1V50OWpR7VkxYce65DGSOkJ5SDImoUaeaFjT5/Y6D2Ml2MjgzpSBqclffqHPnZPBde1XVzgbQNEiZkPp20o0Hrz7SVc6My8CPpy4ZyCgCfXw5B+uLIV643+qjP8cgNXjsedUBvak2Ap1UY1tqvjnuwBhe4q2Y1/aH+Fk6BovFbpPlUsA5LLsjmedUhWBUa5qdpvblWXq2BQFqi0CnRvSWXETR8mA3Aa6zVk6/UI9VoLTXdSUgn8EkJIijVlKMTmlyCUPZYhnFWUxj+KONpsWeG7DemE9tdzggnxtnMyFKc845yzRyA8dHNnbPQjADT++mVal6pmOthCE0=
+  - secure: LIeTDv8v2zGIqzwED5nQEtaFPp5qaFx7n7KY2JK3TkNi+n0NHVmI8pjUVAtRvjO51GuuFZ4opvOXN1eX/Op3BKCGK2q0YAo028f5Um9m/zPenwwAWfUx/gg+NL4TTqDzRZ5s2AxJUl1P0HZG419N6RRk0UeCqK/qS/g39qS063nF6ecNDg4uvvxQerY1yDQ40XehEVrSuJRZz7AX3NOaSiv90yUGGqP1QkyZk0oAaNmuBgyaZRB3b/hzueDBkoWBPXKwxdMCQSwjDVZKW+mjGH3AH5nRa6AV2bPLHUCwJa2W48HEMoZpMnDgORWPD/2bEmBVH4Iey0WbRFN3T9srpfku72CVqrVZ0it+OWxvYSnp2zWJy4TIpJt4N45gZ52Sb8Eksm26HF4gULuRQzt+LiDzPiaM88Se4Yu478mlT5TSDcr/pwcrgPHVcmwbRjeFwXgYTt0AW0iCM9tdelU2zEcdbC0bQNudqbkzaWTJtnwqPq2GlNLd/J0dCbhhgHOliZmP8EYlclIj9wl5AOPJw+XSZy/x0fUsh6imLY4CHuMcPBtIhA3VQ5U3uXYeZreaJgZx5nU4b3nWkpatwIcAguyqkXUXKZX/Mpto8ja2uCM+d7VExdMiMuu4dzhboSM+RdeRr5U+RbClS23Hlc3uTBHo8trZcbrngY0+A01/KTg=

data/Gemfile

@@ -1,5 +1,9 @@
-source "https://rubygems.org"
-gem "httparty"
-gem 'vcr'
-gem 'webmock'
-gem 'yard'
+source "https://rubygems.org"
+gem "httparty"
+gem 'vcr'
+gem 'webmock'
+gem 'yard', '~> 0.9.11'
+gem 'rake'
+gem 'minitest'
+gem 'minitest-reporters'
+gem 'coveralls', require: false

data/Gemfile.lock

@@ -1,31 +1,63 @@
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.5.0)
-      public_suffix (~> 2.0, >= 2.0.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    hashdiff (0.3.0)
-    httparty (0.14.0)
-      multi_xml (>= 0.5.2)
-    multi_xml (0.5.5)
-    public_suffix (2.0.4)
-    safe_yaml (1.0.4)
-    vcr (3.0.3)
-    webmock (2.1.0)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-      hashdiff
-    yard (0.9.5)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  httparty
-  vcr
-  webmock
-  yard
-
-BUNDLED WITH
-   1.13.6
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.0)
+      public_suffix (~> 2.0, >= 2.0.2)
+    ansi (1.5.0)
+    builder (3.2.2)
+    coveralls (0.8.15)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.12.0)
+      term-ansicolor (~> 1.3)
+      thor (~> 0.19.1)
+      tins (>= 1.6.0, < 2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    docile (1.1.5)
+    hashdiff (0.3.0)
+    httparty (0.14.0)
+      multi_xml (>= 0.5.2)
+    json (1.8.3)
+    minitest (5.9.1)
+    minitest-reporters (1.1.12)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    multi_xml (0.5.5)
+    public_suffix (2.0.4)
+    rake (11.3.0)
+    ruby-progressbar (1.8.1)
+    safe_yaml (1.0.4)
+    simplecov (0.12.0)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.0)
+    term-ansicolor (1.4.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.12.0)
+    vcr (3.0.3)
+    webmock (2.1.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+    yard (0.9.12)
+
+PLATFORMS
+  ruby
+  x64-mingw32
+
+DEPENDENCIES
+  coveralls
+  httparty
+  minitest
+  minitest-reporters
+  rake
+  vcr
+  webmock
+  yard (~> 0.9.11)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -1,138 +1,134 @@
-# Dashboard API v1.0.0
-Documentation: [here](http://www.rubydoc.info/gems/dashboard-api/1.0.0)
-
-Issues: [here](https://github.com/jletizia/dashboardapi/issues)
-
-# Description
-A ruby implementation of the entire [Meraki Dashboard API](https://documentation.meraki.com/zGeneral_Administration/Other_Topics/The_Cisco_Meraki_Dashboard_API)
-
-# Usage
-## Installation
-```bash
-gem install dashboard-api
-```
-
-Once the gem is installed, you can use it by requiring `dashboard-api`
-```ruby
-require 'dashboard-api'
-```
-## Examples
-
-### Basic implementation
-#### Get a list of networks for a specific Dashboard Organization
-
-```ruby
-# get_networks.rb
-require 'dashboard-api'
-
-# read in API key and Org ID from Environment variables
-@dashboard_api_key = ENV['dashboard_api_key']
-@dashboard_org_id = ENV['dashboard_org_id']
-
-dapi = DashboardAPI.new(@dashboard_api_key)
-dapi.get_networks(@dashboard_org_id)
-```
-
-#### Update a specific network
-This will update a specific network to have the new name of `New VPN Spoke`. Note the options hash, `network_options`. Whenever making a call to something that updates
-Dashboard, an options hash will be used, with all necessary attributes as keys. Specifics about these keys can be found in the official [Meraki API Documentation](https://dashboard.meraki.com/manage/support/api_docs).
-```ruby
-# update_network.rb
-require 'dashboard-api'
-
-# read in API key and Org ID from Environment variables
-@dashboard_api_key = ENV['dashboard_api_key']
-@dashboard_org_id = ENV['dashboard_org_id']
-@network_id = ENV['combined_network']
-
-dapi = DashboardAPI.new(@dashboard_api_key)
-
-network_options = {:id => @network_id, :name => 'New VPN Spoke'}
-dapi.update_network(@network_id, network_options)
-```
-
-
-# Contributing
-If you feel like contributing, information about the testing environment can be found below. If you just want to use the gem to help interact with the Meraki Dashboard,
-you only need to read the above sections.
-
-## Dependencies
-To install the necessary dependencies run:
-```bash
-bundle install
-```
-or
-
-```bash
-gem install --dev dashboard-api
-```
-or look in the `Gemfile` and install each dependency individually.
-
-## Testing
-Because the Dashboard API needs actual Dashboard resources to hit against, there is a decent amount of pre-configuring that needs to go into place. This includes not only setting your API key, a default organization ID, etc. but also setting up test devices that will be modified, removed, claimed, etc. on Dashboard. It is recommended to use a completely separate test organization, with separate test devices if possible, as to not potentially disturb a production organization.
-
-### Environment Variables
-Each test file will read in the necessary ENV variables for it's specifc set of tests:
-```ruby
-class OrganizationsTest < Minitest::Test
-  def setup
-    @dashboard_api_key = ENV['dashboard_api_key']
-    @org_id = ENV['dashboard_org_id']
-    @network_id = ENV['test_network_id']
-    @dapi = DashboardAPI.new(@dashboard_api_key)
-  end
-```
-The full list of necessary ENV variables is:
-* `dashboard_api_key` Your Meraki Dashboard API key
-* `dashboard_org_id` The Meraki Dashboard Organization ID you will be testing on
-* `test_network_id` A test network ID that will be used to test renaming networks
-* `vpn_network` A test MX network that will test modifying AutoVPN settings
-* `switch_network` A test MS netwok that will test things like access policies, etc.
-* `mx_serial` A test MX that has client traffic passing through it
-* `spare_mr` A test MR used to claim in and out of networks
-* `test_admin_id` The ID of a test admin used to test updating and deleting admins
-* `config_template_id` A test configuration template network ID used to test removing a template
-* `unclaimed_device` A device that can be used to test claiming
-* `phone_network` Test phone network
-* `phone_contact_id` Test contact for your phone network
-* `saml_id` ID of a test SAML user
-* `config_template_id` ID of the template you will bind the test network to
-* `config_bind_network` network you want to bind to a template
-
-### Running a test
-As this is an wrapper gem for an RESTful API, the vast majority of methods make some sort of HTTP call. To reduce the amount of time testing takes, and ensure that we have good data to work against at all times, we utilize [VCR](https://github.com/vcr/vcr). This will capture the HTTP interaction the first time a test is ran, save them as fixtures, and then replay that fixture on each subsequent call to that method during tests.
-
-#### First test run issues
-Due to the HTTP interactions containing private data we are trying to obscure with environment variables in the first place (API key, organization IDs, etc.), the fixtures used to initially test this gem can not be provided here. This means that you will need to generate your own fixtures. Luckily, this is as easy as just running the tests in the first place. Unluckily, due to Minitest randomizing the order of it's tests, you may run into situations where the test to delete a network runs for the first time, before that network ever exists (remember, with VCR, only the first test run's HTTP interaction is saved, and used for each later test). When this happens, a 404 will be received, VCR will save it, and the test will fail.
-
-#### What this means
-Getting all of the tests to a point where they all pass will not be a trivial task, due to the workflow of: running the tests, finding the tests that failed due to a prerequisite not having happened at some point before that test run, fixing the prerequisite, deleting the fixture (they live in `fixtures/vcr_cassettes/`), and rerunning the tests.
-
-#### How to actually run the tests
-```
-rake test
-```
-
-After the first completely successful, all green run, tests will be almost instantenous:
-
-```bash
-➜  dashboard-api git:(master) ✗ rake test
-Started with run options --seed 42405
-
-DashAPITest
-  test_snmp_returns_as_array                                      PASS (0.01s)
-  test_license_state_returns_as_hash                              PASS (0.01s)
-  test_api_key_is_a_string                                        PASS (0.00s)
-  test_get_an_organization                                        PASS (0.01s)
-  test_it_returns_as_json                                         PASS (0.00s)
-  test_get_inventory_for_an_org                                   PASS (0.01s)
-  test_get_license_state_for_an_org                               PASS (0.00s)
-  test_third_party_peer_returns_as_array                          PASS (0.01s)
-  test_it_is_a_dash_api                                           PASS (0.00s)
-  test_current_snmp_status                                        PASS (0.00s)
-  test_inventory_returns_as_array                                 PASS (0.00s)
-  test_third_party_vpn_peers                                      PASS (0.00s)
-
-Finished in 0.05813s
-12 tests, 12 assertions, 0 failures, 0 errors, 0 skips
-```
+# Dashboard API v1.0.0
+[![Build Status](https://travis-ci.org/jletizia/dashboardapi.svg?branch=master)](https://travis-ci.org/jletizia/dashboardapi)
+[![Coverage Status](https://coveralls.io/repos/github/jletizia/dashboardapi/badge.svg?branch=master)](https://coveralls.io/github/jletizia/dashboardapi?branch=master)
+[![Code Climate](https://codeclimate.com/github/jletizia/dashboardapi/badges/gpa.svg)](https://codeclimate.com/github/jletizia/dashboardapi)
+
+Documentation: [here](http://www.rubydoc.info/gems/dashboard-api/1.0.0)
+
+Issues: [here](https://github.com/jletizia/dashboardapi/issues)
+
+# Description
+A ruby implementation of the entire [Meraki Dashboard API](https://documentation.meraki.com/zGeneral_Administration/Other_Topics/The_Cisco_Meraki_Dashboard_API)
+
+# Usage
+## Installation
+```bash
+gem install dashboard-api
+```
+Once the gem is installed, you can use it by requiring `dashboard-api`
+```ruby
+require 'dashboard-api'
+```
+## Examples
+
+### Basic implementation
+#### Get a list of networks for a specific Dashboard Organization
+
+```ruby
+# get_networks.rb
+require 'dashboard-api'
+
+# read in API key and Org ID from Environment variables
+@dashboard_api_key = ENV['dashboard_api_key']
+@dashboard_org_id = ENV['dashboard_org_id']
+
+dapi = DashboardAPI.new(@dashboard_api_key)
+dapi.get_networks(@dashboard_org_id)
+```
+
+#### Update a specific network
+This will update a specific network to have the new name of `New VPN Spoke`. Note the options hash, `network_options`. Whenever making a call to something that updates
+Dashboard, an options hash will be used, with all necessary attributes as keys. Specifics about these keys can be found in the official [Meraki API Documentation](https://dashboard.meraki.com/manage/support/api_docs).
+```ruby
+# update_network.rb
+require 'dashboard-api'
+
+# read in API key and Org ID from Environment variables
+@dashboard_api_key = ENV['dashboard_api_key']
+@dashboard_org_id = ENV['dashboard_org_id']
+@network_id = ENV['combined_network']
+
+dapi = DashboardAPI.new(@dashboard_api_key)
+
+network_options = {:id => @network_id, :name => 'New VPN Spoke'}
+dapi.update_network(@network_id, network_options)
+```
+
+
+# Contributing
+If you feel like contributing, information about the testing environment can be found below. If you just want to use the gem to help interact with the Meraki Dashboard,
+you only need to read the above sections.
+
+## Dependencies
+To install the necessary dependencies run:
+```bash
+bundle install
+```
+or
+
+```bash
+gem install --dev dashboard-api
+```
+or look in the `Gemfile` and install each dependency individually.
+
+## Testing
+### Prerequisites
+There are a few prerequisites if you want to be able to run tests (at least for the first time, until fixtures get generated). These are split up into Dashboard and Environment Variables:
+#### Dashboard configuration
+* A combined network that should have
+  * an MX, with VLANs enabled
+  * an MS
+  * an MR, with the first SSID
+* a single network called 'DELETE ME' exists
+* A single template called 'API Delete Me' already exists
+* A single template exists called 'API Permanent'
+
+#### Environment Variables
+* `dashboard_api_key` Your Meraki Dashboard API key
+* `org_id` The Meraki Dashboard Organization where you will be testing on
+* `combined_network` The combined network set up in the above requirements
+* `ms_serial` The serial number of the MS in the combined network. Used to test switchport methods
+* `unclaimed_device` A device that is unclaimed. Used to test claining into an org / network.
+
+### Running a test
+As this is a wrapper gem for an RESTful API, the vast majority of methods make some sort of HTTP call. To reduce the amount of time testing takes, and ensure that we have good data to work against at all times, we utilize [VCR](https://github.com/vcr/vcr). This will capture the HTTP interaction the first time a test is ran, save them as fixtures, and then replay that fixture on each subsequent call to that method during tests.
+
+**NOTE**: This means that if you happen to have things misconfigured, run a test, and receive a 404, that 404 response is now saved for that test. You will need to manually remove it from `fixtures/vcr_cassettes` and rerun the test.
+
+#### How to actually run the tests
+```
+rake test without-secrets
+```
+#### Without secrets?
+Running the rake test with the `without-secrets` options tells VCR not to obfuscate any sensitive information when creating fixtures (sensitive information being described as the ENVs listed below). This is OK for 99.99% of the normal use cases (such as feature development on a local machine). The reason the functionality to allow for the obfuscation is for the potential down the line to be able to release a current "working set" of fixtures, so that you don't need to have an entire Dashboard Organization set up to modify existing methods and test them.
+
+If you want to run your local tests with secret obfuscation for any reason, you need the following ENV variables set:
+```
+['secret_dashboard_api_key', 'secret_dashboard_org_id', 'secret_ms_serial', 'secret_unclaimed_device', 'secret_combined_network', 'secret_first_name', 'secret_last_name',
+           'secret_email', 'secret_admin_id', 'secret_shard_id']
+```
+
+### Test results
+After the first completely successful, all green run, subsequent tests will be almost instantaneous:
+
+```bash
+➜  dashboard-api git:(master) ✗ rake test
+Started with run options --seed 42405
+
+DashAPITest
+  test_snmp_returns_as_array                                      PASS (0.01s)
+  test_license_state_returns_as_hash                              PASS (0.01s)
+  test_api_key_is_a_string                                        PASS (0.00s)
+  test_get_an_organization                                        PASS (0.01s)
+  test_it_returns_as_json                                         PASS (0.00s)
+  test_get_inventory_for_an_org                                   PASS (0.01s)
+  test_get_license_state_for_an_org                               PASS (0.00s)
+  test_third_party_peer_returns_as_array                          PASS (0.01s)
+  test_it_is_a_dash_api                                           PASS (0.00s)
+  test_current_snmp_status                                        PASS (0.00s)
+  test_inventory_returns_as_array                                 PASS (0.00s)
+  test_third_party_vpn_peers                                      PASS (0.00s)
+
+Finished in 0.05813s
+12 tests, 12 assertions, 0 failures, 0 errors, 0 skips
+```