dashbeautiful 0.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.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/.rspec +3 -0
- data/.rubocop.yml +33 -0
- data/.travis.yml +7 -0
- data/CHANGELOG.md +22 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +4 -0
- data/Gemfile.lock +67 -0
- data/LICENSE.txt +21 -0
- data/README.md +60 -0
- data/Rakefile +6 -0
- data/bin/console +13 -0
- data/bin/setup +8 -0
- data/dashbeautiful.gemspec +32 -0
- data/lib/dashbeautiful.rb +9 -0
- data/lib/dashbeautiful/api.rb +69 -0
- data/lib/dashbeautiful/device.rb +38 -0
- data/lib/dashbeautiful/network.rb +62 -0
- data/lib/dashbeautiful/organization.rb +55 -0
- data/lib/dashbeautiful/version.rb +3 -0
- metadata +161 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA256:
|
|
3
|
+
metadata.gz: 3de5cd848f4a54787c922403ce78ae47284b9f532a2b1a495248cdfe0f39a36f
|
|
4
|
+
data.tar.gz: 647e85f1fabf2f9d2ff96c420aa3ffb204d7030e33197293785448ed720c220f
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: d8668dd1a29db055be9d02770c6472d2b6331b5b2ce74826fe5a580d9fc530e246657bc336b178da91c8ff28c872a32616f4da0de9db228bb2ff591676eefce9
|
|
7
|
+
data.tar.gz: 4957083b9a342925195d4aa5ed2cffb56d84214b3bd3243373a8ae162eb00e73095ddb20117d104732f91c0135fd4da4d8b42e3c5950d1f434938063001e73b8
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.rubocop.yml
ADDED
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
AllCops:
|
|
2
|
+
Exclude:
|
|
3
|
+
- 'node_modules/**/*'
|
|
4
|
+
- 'tmp/**/*'
|
|
5
|
+
- 'vendor/**/*'
|
|
6
|
+
- '.git/**/*'
|
|
7
|
+
# Default formatter will be used if no `-f/--format` option is given.
|
|
8
|
+
DefaultFormatter: progress
|
|
9
|
+
# Cop names are displayed in offense messages by default. Change behavior
|
|
10
|
+
# by overriding DisplayCopNames, or by giving the `--no-display-cop-names`
|
|
11
|
+
# option.
|
|
12
|
+
DisplayCopNames: true
|
|
13
|
+
# Style guide URLs are not displayed in offense messages by default. Change
|
|
14
|
+
# behavior by overriding `DisplayStyleGuide`, or by giving the
|
|
15
|
+
# `-S/--display-style-guide` option.
|
|
16
|
+
DisplayStyleGuide: true
|
|
17
|
+
# When specifying style guide URLs, any paths and/or fragments will be
|
|
18
|
+
# evaluated relative to the base URL.
|
|
19
|
+
StyleGuideBaseURL: https://rubystyle.guide
|
|
20
|
+
|
|
21
|
+
Layout/LineLength:
|
|
22
|
+
Enabled: false
|
|
23
|
+
Metrics/BlockLength:
|
|
24
|
+
Enabled: true
|
|
25
|
+
Exclude:
|
|
26
|
+
- 'meraki.gemspec'
|
|
27
|
+
- '**/*_spec.rb'
|
|
28
|
+
Metrics/ModuleLength:
|
|
29
|
+
Enabled: true
|
|
30
|
+
Exclude:
|
|
31
|
+
- '**/*_spec.rb'
|
|
32
|
+
Style/FrozenStringLiteralComment:
|
|
33
|
+
Enabled: false
|
data/.travis.yml
ADDED
data/CHANGELOG.md
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
All notable changes to this project will be documented in this file.
|
|
3
|
+
|
|
4
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
5
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
6
|
+
|
|
7
|
+
## [unreleased]
|
|
8
|
+
|
|
9
|
+
## [0.0.1] - 2019-01-16
|
|
10
|
+
### Added
|
|
11
|
+
- API class for doing HTTP requests
|
|
12
|
+
- Organization, Network, Device classes
|
|
13
|
+
- Dashboard read access via methods like name, tags, networks, devices
|
|
14
|
+
- Caching by default, add a '!' to force an API request
|
|
15
|
+
- rspec testing for Ogranization/Network/Device classes with fixtures
|
|
16
|
+
|
|
17
|
+
### Changed
|
|
18
|
+
- renamed from meraki to dashbeautiful
|
|
19
|
+
- changed version from 0.1.0 -> 0.0.1 to account for renaming and better follow semantic versioning
|
|
20
|
+
|
|
21
|
+
[Unreleased]: https://github.com/ellingtonjp/dashbeautiful/compare/v0.0.1...HEAD
|
|
22
|
+
[0.0.1]: https://github.com/ellingtonjp/dashbeautiful/releases/tag/v0.0.1
|
data/CODE_OF_CONDUCT.md
ADDED
|
@@ -0,0 +1,74 @@
|
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
|
2
|
+
|
|
3
|
+
## Our Pledge
|
|
4
|
+
|
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
|
10
|
+
orientation.
|
|
11
|
+
|
|
12
|
+
## Our Standards
|
|
13
|
+
|
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
|
15
|
+
include:
|
|
16
|
+
|
|
17
|
+
* Using welcoming and inclusive language
|
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
|
19
|
+
* Gracefully accepting constructive criticism
|
|
20
|
+
* Focusing on what is best for the community
|
|
21
|
+
* Showing empathy towards other community members
|
|
22
|
+
|
|
23
|
+
Examples of unacceptable behavior by participants include:
|
|
24
|
+
|
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
|
26
|
+
advances
|
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
|
28
|
+
* Public or private harassment
|
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
|
30
|
+
address, without explicit permission
|
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
|
32
|
+
professional setting
|
|
33
|
+
|
|
34
|
+
## Our Responsibilities
|
|
35
|
+
|
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
|
38
|
+
response to any instances of unacceptable behavior.
|
|
39
|
+
|
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
|
44
|
+
threatening, offensive, or harmful.
|
|
45
|
+
|
|
46
|
+
## Scope
|
|
47
|
+
|
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
|
49
|
+
when an individual is representing the project or its community. Examples of
|
|
50
|
+
representing a project or community include using an official project e-mail
|
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
|
53
|
+
further defined and clarified by project maintainers.
|
|
54
|
+
|
|
55
|
+
## Enforcement
|
|
56
|
+
|
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
|
58
|
+
reported by contacting the project team at ellingtonjp@gmail.com. All
|
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
|
63
|
+
|
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
|
66
|
+
members of the project's leadership.
|
|
67
|
+
|
|
68
|
+
## Attribution
|
|
69
|
+
|
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
|
71
|
+
available at [http://contributor-covenant.org/version/1/4][version]
|
|
72
|
+
|
|
73
|
+
[homepage]: http://contributor-covenant.org
|
|
74
|
+
[version]: http://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/Gemfile.lock
ADDED
|
@@ -0,0 +1,67 @@
|
|
|
1
|
+
PATH
|
|
2
|
+
remote: .
|
|
3
|
+
specs:
|
|
4
|
+
dashbeautiful (0.0.1)
|
|
5
|
+
httparty (~> 0.17)
|
|
6
|
+
|
|
7
|
+
GEM
|
|
8
|
+
remote: https://rubygems.org/
|
|
9
|
+
specs:
|
|
10
|
+
ast (2.4.0)
|
|
11
|
+
byebug (11.0.1)
|
|
12
|
+
coderay (1.1.2)
|
|
13
|
+
diff-lcs (1.3)
|
|
14
|
+
httparty (0.17.3)
|
|
15
|
+
mime-types (~> 3.0)
|
|
16
|
+
multi_xml (>= 0.5.2)
|
|
17
|
+
jaro_winkler (1.5.4)
|
|
18
|
+
method_source (0.9.2)
|
|
19
|
+
mime-types (3.3.1)
|
|
20
|
+
mime-types-data (~> 3.2015)
|
|
21
|
+
mime-types-data (3.2019.1009)
|
|
22
|
+
multi_xml (0.6.0)
|
|
23
|
+
parallel (1.19.1)
|
|
24
|
+
parser (2.7.0.2)
|
|
25
|
+
ast (~> 2.4.0)
|
|
26
|
+
pry (0.12.2)
|
|
27
|
+
coderay (~> 1.1.0)
|
|
28
|
+
method_source (~> 0.9.0)
|
|
29
|
+
rainbow (3.0.0)
|
|
30
|
+
rake (10.5.0)
|
|
31
|
+
rspec (3.9.0)
|
|
32
|
+
rspec-core (~> 3.9.0)
|
|
33
|
+
rspec-expectations (~> 3.9.0)
|
|
34
|
+
rspec-mocks (~> 3.9.0)
|
|
35
|
+
rspec-core (3.9.1)
|
|
36
|
+
rspec-support (~> 3.9.1)
|
|
37
|
+
rspec-expectations (3.9.0)
|
|
38
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
39
|
+
rspec-support (~> 3.9.0)
|
|
40
|
+
rspec-mocks (3.9.1)
|
|
41
|
+
diff-lcs (>= 1.2.0, < 2.0)
|
|
42
|
+
rspec-support (~> 3.9.0)
|
|
43
|
+
rspec-support (3.9.2)
|
|
44
|
+
rubocop (0.79.0)
|
|
45
|
+
jaro_winkler (~> 1.5.1)
|
|
46
|
+
parallel (~> 1.10)
|
|
47
|
+
parser (>= 2.7.0.1)
|
|
48
|
+
rainbow (>= 2.2.2, < 4.0)
|
|
49
|
+
ruby-progressbar (~> 1.7)
|
|
50
|
+
unicode-display_width (>= 1.4.0, < 1.7)
|
|
51
|
+
ruby-progressbar (1.10.1)
|
|
52
|
+
unicode-display_width (1.6.0)
|
|
53
|
+
|
|
54
|
+
PLATFORMS
|
|
55
|
+
ruby
|
|
56
|
+
|
|
57
|
+
DEPENDENCIES
|
|
58
|
+
bundler (~> 2.0)
|
|
59
|
+
byebug (~> 11.0)
|
|
60
|
+
dashbeautiful!
|
|
61
|
+
pry (~> 0.12)
|
|
62
|
+
rake (~> 10.0)
|
|
63
|
+
rspec (~> 3.0)
|
|
64
|
+
rubocop (~> 0.79)
|
|
65
|
+
|
|
66
|
+
BUNDLED WITH
|
|
67
|
+
2.1.2
|
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
The MIT License (MIT)
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2020 Jonathan Ellington
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
|
13
|
+
all copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Dashbeautiful
|
|
2
|
+
|
|
3
|
+
Beautiful interface Meraki's wonderful Dashboard API. API calls are cached for fast access.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Add this line to your application's Gemfile:
|
|
8
|
+
|
|
9
|
+
```ruby
|
|
10
|
+
gem 'dashbeautiful'
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
And then execute:
|
|
14
|
+
|
|
15
|
+
$ bundle
|
|
16
|
+
|
|
17
|
+
Or install it yourself as:
|
|
18
|
+
|
|
19
|
+
$ gem install dashbeautiful
|
|
20
|
+
|
|
21
|
+
## Usage
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'dashbeautiful'
|
|
25
|
+
|
|
26
|
+
KEY = 'my-beautiful-api-key'
|
|
27
|
+
|
|
28
|
+
# Get all organizations that KEY has access to, and find one by name
|
|
29
|
+
organizations = Dashbeautiful::Organization.all api_key: KEY
|
|
30
|
+
dunder = organizations.find { |org| org.name == 'Dunder Mifflin Paper Co.' }
|
|
31
|
+
|
|
32
|
+
# Find a network and get all its devices
|
|
33
|
+
scranton = dunder.networks.find_by(:name, 'Scranton, PA')
|
|
34
|
+
device_list = scranton.devices
|
|
35
|
+
|
|
36
|
+
# Calls against the API are cached, so subsequent calls are fast
|
|
37
|
+
schrute_farms = dunder.networks.find_by(:name, 'Schrute Farms') # fast, 'networks' returns cached result
|
|
38
|
+
|
|
39
|
+
# You can force API access with a bang
|
|
40
|
+
schrute_farms = dunder.networks!.find_by(:id, '123456') # slow, 'networks!' makes api call
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
## Development
|
|
45
|
+
|
|
46
|
+
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
|
47
|
+
|
|
48
|
+
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
|
|
49
|
+
|
|
50
|
+
## Contributing
|
|
51
|
+
|
|
52
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/ellingtonjp/dashbeautiful. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
|
|
53
|
+
|
|
54
|
+
## License
|
|
55
|
+
|
|
56
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
|
57
|
+
|
|
58
|
+
## Code of Conduct
|
|
59
|
+
|
|
60
|
+
Everyone interacting in the Dashbeautiful project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ellingtonjp/dashbeautiful/blob/master/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
data/bin/console
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
#!/usr/bin/env ruby
|
|
2
|
+
require 'bundler/setup'
|
|
3
|
+
require 'dashbeautiful'
|
|
4
|
+
|
|
5
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
|
6
|
+
# with your gem easier. You can also use a different console, if you like.
|
|
7
|
+
|
|
8
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
|
9
|
+
# require "pry"
|
|
10
|
+
# Pry.start
|
|
11
|
+
|
|
12
|
+
require 'irb'
|
|
13
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
lib = File.expand_path('lib', __dir__)
|
|
2
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
|
3
|
+
require 'dashbeautiful/version'
|
|
4
|
+
|
|
5
|
+
Gem::Specification.new do |spec|
|
|
6
|
+
spec.name = 'dashbeautiful'
|
|
7
|
+
spec.version = Dashbeautiful::VERSION
|
|
8
|
+
spec.authors = ['Jonathan Ellington']
|
|
9
|
+
spec.email = ['ellingtonjp@gmail.com']
|
|
10
|
+
|
|
11
|
+
spec.summary = 'dashbeautiful'
|
|
12
|
+
spec.description = 'dashbeautiful'
|
|
13
|
+
spec.homepage = 'http://github.com/ellingtonjp/dashbeautiful'
|
|
14
|
+
spec.license = 'MIT'
|
|
15
|
+
|
|
16
|
+
# Specify which files should be added to the gem when it is released.
|
|
17
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
|
18
|
+
spec.files = Dir.chdir(File.expand_path(__dir__)) do
|
|
19
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
|
20
|
+
end
|
|
21
|
+
spec.bindir = 'exe'
|
|
22
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
|
23
|
+
spec.require_paths = ['lib']
|
|
24
|
+
|
|
25
|
+
spec.add_dependency 'httparty', '~> 0.17'
|
|
26
|
+
spec.add_development_dependency 'bundler', '~> 2.0'
|
|
27
|
+
spec.add_development_dependency 'byebug', '~> 11.0'
|
|
28
|
+
spec.add_development_dependency 'pry', '~> 0.12'
|
|
29
|
+
spec.add_development_dependency 'rake', '~> 10.0'
|
|
30
|
+
spec.add_development_dependency 'rspec', '~> 3.0'
|
|
31
|
+
spec.add_development_dependency 'rubocop', '~> 0.79'
|
|
32
|
+
end
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
require 'httparty'
|
|
2
|
+
|
|
3
|
+
module Dashbeautiful
|
|
4
|
+
# description TODO
|
|
5
|
+
class API
|
|
6
|
+
attr_reader :key
|
|
7
|
+
|
|
8
|
+
def initialize(key, requestor: HTTParty)
|
|
9
|
+
@key = key
|
|
10
|
+
@base_url = 'https://api.meraki.com/api/v0'
|
|
11
|
+
@headers = {
|
|
12
|
+
'X-Cisco-Meraki-API-Key' => key,
|
|
13
|
+
'Content-Type' => 'application/json'
|
|
14
|
+
}
|
|
15
|
+
@options = {
|
|
16
|
+
headers: @headers
|
|
17
|
+
}
|
|
18
|
+
@requestor = requestor
|
|
19
|
+
end
|
|
20
|
+
|
|
21
|
+
def organizations
|
|
22
|
+
get('/organizations').map { |h| symbolize_keys(h) }
|
|
23
|
+
end
|
|
24
|
+
|
|
25
|
+
def update_organization(organization_id, body)
|
|
26
|
+
valid_keys = %i[name]
|
|
27
|
+
|
|
28
|
+
raise ArgumentError, 'body must be a hash' unless body.is_a? Hash
|
|
29
|
+
raise ArgumentError, 'body cannot be empty' if body.empty?
|
|
30
|
+
|
|
31
|
+
put("/organizations/#{organization_id}", valid_keys: valid_keys, body: body)
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
def networks(organization_id)
|
|
35
|
+
get("/organizations/#{organization_id}/networks").map { |h| symbolize_keys(h) }
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
def devices(network_id)
|
|
39
|
+
get("/networks/#{network_id}/devices").map { |h| symbolize_keys(h) }
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
def get(path, **options)
|
|
43
|
+
options = @options.merge(options)
|
|
44
|
+
response = @requestor.get(@base_url + path, options)
|
|
45
|
+
|
|
46
|
+
raise APIRequestError if response.code != 200
|
|
47
|
+
|
|
48
|
+
response
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
def put(path, valid_keys:, body:, **options)
|
|
52
|
+
raise ArgumentError, "body key can only be #{valid_keys}" unless valid_keys.all? { |key| body.key? key }
|
|
53
|
+
|
|
54
|
+
options = @options.merge(options)
|
|
55
|
+
options = options.merge(body: body.to_json)
|
|
56
|
+
response = @requestor.put(@base_url + path, options)
|
|
57
|
+
|
|
58
|
+
raise APIRequestError if response.code != 200
|
|
59
|
+
|
|
60
|
+
response
|
|
61
|
+
end
|
|
62
|
+
|
|
63
|
+
private
|
|
64
|
+
|
|
65
|
+
def symbolize_keys(hash)
|
|
66
|
+
Hash[hash.map { |(k, v)| [k.to_sym, v] }]
|
|
67
|
+
end
|
|
68
|
+
end
|
|
69
|
+
end
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
module Dashbeautiful
|
|
2
|
+
# description TODO
|
|
3
|
+
class Device
|
|
4
|
+
attr_reader :network, :name, :serial, :mac, :model, :tags
|
|
5
|
+
|
|
6
|
+
def self.create(*args, **kwargs)
|
|
7
|
+
type = case kwargs[:model]
|
|
8
|
+
when /MV/ then CameraDevice
|
|
9
|
+
when /MS/ then SwitchDevice
|
|
10
|
+
when /MR/ then WirelessDevice
|
|
11
|
+
when /MX/ then ApplianceDevice
|
|
12
|
+
else Device
|
|
13
|
+
end
|
|
14
|
+
type.new(*args, **kwargs)
|
|
15
|
+
end
|
|
16
|
+
|
|
17
|
+
def self.all(network)
|
|
18
|
+
raise ArgumentError, 'must pass a Network' if network.nil?
|
|
19
|
+
|
|
20
|
+
network.devices
|
|
21
|
+
end
|
|
22
|
+
|
|
23
|
+
def initialize(network, **attributes)
|
|
24
|
+
@network = network
|
|
25
|
+
@name = attributes[:name]
|
|
26
|
+
@serial = attributes[:serial]
|
|
27
|
+
@mac = attributes[:mac]
|
|
28
|
+
@model = attributes[:model]
|
|
29
|
+
@tags = attributes[:tags]
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
|
|
33
|
+
class CameraDevice < Device; end
|
|
34
|
+
class SwitchDevice < Device; end
|
|
35
|
+
class ApplianceDevice < Device; end
|
|
36
|
+
class WirelessDevice < Device; end
|
|
37
|
+
class CombinedDevice < Device; end
|
|
38
|
+
end
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
module Dashbeautiful
|
|
2
|
+
# description TODO
|
|
3
|
+
class Network
|
|
4
|
+
attr_reader :organization, :id, :name, :tags
|
|
5
|
+
|
|
6
|
+
def self.create(*args, **kwargs)
|
|
7
|
+
type = case kwargs[:type]
|
|
8
|
+
when 'camera' then CameraNetwork
|
|
9
|
+
when 'switch' then SwitchNetwork
|
|
10
|
+
when 'wireless' then WirelessNetwork
|
|
11
|
+
when 'appliance' then ApplianceNetwork
|
|
12
|
+
when 'combined' then CombinedNetwork
|
|
13
|
+
else Network
|
|
14
|
+
end
|
|
15
|
+
type.new(*args, **kwargs)
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
def self.all(organization)
|
|
19
|
+
raise ArgumentError, 'must pass an Organization' if organization.nil?
|
|
20
|
+
|
|
21
|
+
organization.networks
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
def self.find(organization, &block)
|
|
25
|
+
all(organization).find(&block)
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
def self.find_by_id(id, organization)
|
|
29
|
+
find(organization) { |network| network.id == id }
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
def self.find_by_name(name, organization)
|
|
33
|
+
find(organization) { |network| network.name == name }
|
|
34
|
+
end
|
|
35
|
+
|
|
36
|
+
def initialize(organization, **attributes)
|
|
37
|
+
@organization = organization
|
|
38
|
+
@id = attributes[:id]
|
|
39
|
+
@name = attributes[:name]
|
|
40
|
+
@tags = attributes[:tags]
|
|
41
|
+
|
|
42
|
+
raise ArgumentError if @id.nil? || @name.nil? || @tags.nil?
|
|
43
|
+
|
|
44
|
+
@tags = @tags.split.uniq
|
|
45
|
+
end
|
|
46
|
+
|
|
47
|
+
def devices
|
|
48
|
+
@devices ||= organization.api.devices(id).map { |device| Device.create(self, **device) }
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
def devices!
|
|
52
|
+
@devices = nil
|
|
53
|
+
devices
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
|
|
57
|
+
class CameraNetwork < Network; end
|
|
58
|
+
class SwitchNetwork < Network; end
|
|
59
|
+
class ApplianceNetwork < Network; end
|
|
60
|
+
class WirelessNetwork < Network; end
|
|
61
|
+
class CombinedNetwork < Network; end
|
|
62
|
+
end
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
module Dashbeautiful
|
|
2
|
+
# description TODO
|
|
3
|
+
class Organization
|
|
4
|
+
attr_accessor :api
|
|
5
|
+
attr_reader :name, :id, :url
|
|
6
|
+
|
|
7
|
+
ATTRIBUTES = %i[id name url].freeze
|
|
8
|
+
|
|
9
|
+
def self.all(api_key, api: API.new(api_key))
|
|
10
|
+
raise ArgumentError, 'api_key is nil. Either initialize Organization or pass a key' if api_key.nil?
|
|
11
|
+
|
|
12
|
+
api.organizations.map { |org| Organization.new(api, **org) }
|
|
13
|
+
end
|
|
14
|
+
|
|
15
|
+
def self.find_by(attribute, value, api_key, api: API.new(api_key))
|
|
16
|
+
all(api_key, api: api).each do |org|
|
|
17
|
+
return org if org.send(attribute) == value
|
|
18
|
+
end
|
|
19
|
+
nil
|
|
20
|
+
end
|
|
21
|
+
|
|
22
|
+
def self.init(organization:, api_key:, api: API.new(api_key))
|
|
23
|
+
ATTRIBUTES.each do |attribute|
|
|
24
|
+
org = find_by(attribute, organization, api_key, api: api)
|
|
25
|
+
return org unless org.nil?
|
|
26
|
+
end
|
|
27
|
+
raise ArgumentError, "Could not find organization: #{organization}"
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
def initialize(api, **attributes)
|
|
31
|
+
@api = api
|
|
32
|
+
@id = attributes[:id]
|
|
33
|
+
@name = attributes[:name]
|
|
34
|
+
@url = attributes[:url]
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
def name=(value)
|
|
38
|
+
api.update_organization(id, name: value)
|
|
39
|
+
@name = value
|
|
40
|
+
end
|
|
41
|
+
|
|
42
|
+
def api_key
|
|
43
|
+
api.key
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
def networks
|
|
47
|
+
@networks ||= api.networks(id).map { |network| Network.create(self, **network) }
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
def networks!
|
|
51
|
+
@networks = nil
|
|
52
|
+
networks
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
metadata
ADDED
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: dashbeautiful
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.0.1
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Jonathan Ellington
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: exe
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2020-01-16 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: httparty
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - "~>"
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '0.17'
|
|
20
|
+
type: :runtime
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - "~>"
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '0.17'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: bundler
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - "~>"
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '2.0'
|
|
34
|
+
type: :development
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - "~>"
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '2.0'
|
|
41
|
+
- !ruby/object:Gem::Dependency
|
|
42
|
+
name: byebug
|
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
|
44
|
+
requirements:
|
|
45
|
+
- - "~>"
|
|
46
|
+
- !ruby/object:Gem::Version
|
|
47
|
+
version: '11.0'
|
|
48
|
+
type: :development
|
|
49
|
+
prerelease: false
|
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
51
|
+
requirements:
|
|
52
|
+
- - "~>"
|
|
53
|
+
- !ruby/object:Gem::Version
|
|
54
|
+
version: '11.0'
|
|
55
|
+
- !ruby/object:Gem::Dependency
|
|
56
|
+
name: pry
|
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
|
58
|
+
requirements:
|
|
59
|
+
- - "~>"
|
|
60
|
+
- !ruby/object:Gem::Version
|
|
61
|
+
version: '0.12'
|
|
62
|
+
type: :development
|
|
63
|
+
prerelease: false
|
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
65
|
+
requirements:
|
|
66
|
+
- - "~>"
|
|
67
|
+
- !ruby/object:Gem::Version
|
|
68
|
+
version: '0.12'
|
|
69
|
+
- !ruby/object:Gem::Dependency
|
|
70
|
+
name: rake
|
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
|
72
|
+
requirements:
|
|
73
|
+
- - "~>"
|
|
74
|
+
- !ruby/object:Gem::Version
|
|
75
|
+
version: '10.0'
|
|
76
|
+
type: :development
|
|
77
|
+
prerelease: false
|
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
79
|
+
requirements:
|
|
80
|
+
- - "~>"
|
|
81
|
+
- !ruby/object:Gem::Version
|
|
82
|
+
version: '10.0'
|
|
83
|
+
- !ruby/object:Gem::Dependency
|
|
84
|
+
name: rspec
|
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
|
86
|
+
requirements:
|
|
87
|
+
- - "~>"
|
|
88
|
+
- !ruby/object:Gem::Version
|
|
89
|
+
version: '3.0'
|
|
90
|
+
type: :development
|
|
91
|
+
prerelease: false
|
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
93
|
+
requirements:
|
|
94
|
+
- - "~>"
|
|
95
|
+
- !ruby/object:Gem::Version
|
|
96
|
+
version: '3.0'
|
|
97
|
+
- !ruby/object:Gem::Dependency
|
|
98
|
+
name: rubocop
|
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
|
100
|
+
requirements:
|
|
101
|
+
- - "~>"
|
|
102
|
+
- !ruby/object:Gem::Version
|
|
103
|
+
version: '0.79'
|
|
104
|
+
type: :development
|
|
105
|
+
prerelease: false
|
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
107
|
+
requirements:
|
|
108
|
+
- - "~>"
|
|
109
|
+
- !ruby/object:Gem::Version
|
|
110
|
+
version: '0.79'
|
|
111
|
+
description: dashbeautiful
|
|
112
|
+
email:
|
|
113
|
+
- ellingtonjp@gmail.com
|
|
114
|
+
executables: []
|
|
115
|
+
extensions: []
|
|
116
|
+
extra_rdoc_files: []
|
|
117
|
+
files:
|
|
118
|
+
- ".gitignore"
|
|
119
|
+
- ".rspec"
|
|
120
|
+
- ".rubocop.yml"
|
|
121
|
+
- ".travis.yml"
|
|
122
|
+
- CHANGELOG.md
|
|
123
|
+
- CODE_OF_CONDUCT.md
|
|
124
|
+
- Gemfile
|
|
125
|
+
- Gemfile.lock
|
|
126
|
+
- LICENSE.txt
|
|
127
|
+
- README.md
|
|
128
|
+
- Rakefile
|
|
129
|
+
- bin/console
|
|
130
|
+
- bin/setup
|
|
131
|
+
- dashbeautiful.gemspec
|
|
132
|
+
- lib/dashbeautiful.rb
|
|
133
|
+
- lib/dashbeautiful/api.rb
|
|
134
|
+
- lib/dashbeautiful/device.rb
|
|
135
|
+
- lib/dashbeautiful/network.rb
|
|
136
|
+
- lib/dashbeautiful/organization.rb
|
|
137
|
+
- lib/dashbeautiful/version.rb
|
|
138
|
+
homepage: http://github.com/ellingtonjp/dashbeautiful
|
|
139
|
+
licenses:
|
|
140
|
+
- MIT
|
|
141
|
+
metadata: {}
|
|
142
|
+
post_install_message:
|
|
143
|
+
rdoc_options: []
|
|
144
|
+
require_paths:
|
|
145
|
+
- lib
|
|
146
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
147
|
+
requirements:
|
|
148
|
+
- - ">="
|
|
149
|
+
- !ruby/object:Gem::Version
|
|
150
|
+
version: '0'
|
|
151
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
152
|
+
requirements:
|
|
153
|
+
- - ">="
|
|
154
|
+
- !ruby/object:Gem::Version
|
|
155
|
+
version: '0'
|
|
156
|
+
requirements: []
|
|
157
|
+
rubygems_version: 3.1.2
|
|
158
|
+
signing_key:
|
|
159
|
+
specification_version: 4
|
|
160
|
+
summary: dashbeautiful
|
|
161
|
+
test_files: []
|