netbox-client-ruby 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9f3cb350125a887f394b1d4154cf36a127b76716
+  data.tar.gz: 1c58dd91126cd77adb231b2cb77f647c5561d3af
+SHA512:
+  metadata.gz: 5c045749cdcd91e09f8c3c9321155b2498cc28a8f1ed02644273b261f2e7091a699912509cb4b302e67042d1e824ee54e6173af2ebc478a5be6c69ac961d1855
+  data.tar.gz: f7b906ef672ea5645e07fe83c63d5242895466fc316ab8a088b968bb2487b8320ca4f69149df92cdca137fe21c4fc2dbf4bdf285e697c19bdae4e5caf6327d4b

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+quickstart.rb

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-version

@@ -0,0 +1 @@
+2.3.4

data/.travis.yml

@@ -0,0 +1,8 @@
+sudo: false
+language: ruby
+before_install: gem install bundler
+notifications:
+  email:
+    on_success: never
+  slack:
+    secure: kcRMRU/epqsBn3n0McTz0RdGSR07xhyz5g6jOfufA1bRlmLsIQtIaeqeO0VLtcQFUd5JJ1Z2iVz9YdvbA0RLeXwI0ZS96g9NWZn1TFBk6zMM8/CN4kZcWcPKO9INbBMziRlF7lb039CRrusE0ei1YJLojPGWnsKITcS88rSX+Uq0wPDaN6nEzQbDU2HV3TBl31W0LlYYpcmz6Ju9HGVdU1NrA0DRbeV78YmUkyJ4v6p8pgOaKKx+oZidUQmjvBIuBcko9VayXnncg4NQZWG4c6A5keLEFHzgOpSEgu+NnHsTz5ILT2AtysNxC8UJ5dYc7hR/qXsB9Z6ZJjRc+oGTXq6j58f153AW+2R4Mtx7Lp2zg+JeqYO34riu8vnihBk5rNsuHNcz3+ipmePjBt6emmJVpMxleWs9JFpbxXm3JnaSQZtUqALqvs6ZL9gxxokQcy4xbD8BJFvhYpc3b2464JPJhK7LNDNobTv4LdG6m6KSzTnN//zNuE5hSQhMbjo9mnYWN7V9n3asi1EsEpIYqpjRJnlNVDwTdW0jJ7wUSNPdEvSL7g1lDqgJTUuNBh/stpXh6nA8Um5ZxU3cAuuX7VwnDqIdaw81UnkGIlYWBFYMMR2p03y7EaTMZafKWKEcS6LJsv7yIjtfHJgf45LkIHceEj++8JEOKItvDYWHOL4=

data/Dockerfile

@@ -0,0 +1,12 @@
+FROM ruby:2.3.4-alpine
+MAINTAINER development@nine.ch
+
+RUN apk add --no-cache git
+
+RUN mkdir /app
+WORKDIR /app
+
+COPY . ./
+RUN bundle install --jobs 4 --quiet
+
+CMD docker/start.sh

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in netbox-client-ruby.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,75 @@
+PATH
+  remote: .
+  specs:
+    netbox-client-ruby (0.0.1)
+      dry-configurable (~> 0.1)
+      faraday (~> 0.12)
+      faraday-detailed_logger (~> 2.1)
+      faraday_middleware (~> 0.11.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.3.0)
+    coderay (1.1.1)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    dry-configurable (0.7.0)
+      concurrent-ruby (~> 1.0)
+    faraday (0.12.1)
+      multipart-post (>= 1.2, < 3)
+    faraday-detailed_logger (2.1.1)
+      faraday (~> 0.8)
+    faraday_middleware (0.11.0.1)
+      faraday (>= 0.7.4, < 1.0)
+    method_source (0.8.2)
+    multipart-post (2.0.0)
+    parser (2.4.0.0)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.2.2)
+      rake
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    rubocop (0.48.1)
+      parser (>= 2.3.3.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    rubocop-rspec (1.15.1)
+      rubocop (>= 0.42.0)
+    ruby-progressbar (1.8.1)
+    slop (3.6.0)
+    unicode-display_width (1.2.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.14)
+  netbox-client-ruby!
+  pry (~> 0.10)
+  rake (~> 10.0)
+  rspec (~> 3.5)
+  rubocop (~> 0.48)
+  rubocop-rspec (~> 1.15)
+
+BUNDLED WITH
+   1.14.6

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nine Internet Solutions AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,138 @@
+# NetboxClientRuby
+
+[![Build Status](https://travis-ci.org/ninech/netbox-client-ruby.svg?branch=master)](https://travis-ci.org/ninech/netbox-client-ruby)
+[![Gem Version](https://badge.fury.io/rb/netbox-client-ruby.svg)](https://badge.fury.io/rb/netbox-client-ruby)
+
+This is a gem to pragmatically access your [Netbox instance](https://github.com/digitalocean/netbox)
+via it's API from Ruby. This gem is currently only compatible with Netbox v2.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'netbox-client-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it manually:
+
+    $ gem install netbox-client-ruby
+
+## Usage
+
+### Configuration
+
+Put this somewhere, where it runs, before any call to anything else of Cloudflair.
+If you are using Rails, then this would probably be somewhere underneath /config.
+
+```ruby
+require 'netbox-client-ruby'
+NetboxClientRuby.configure do |config|
+  config.netbox.auth.token = 'YOUR_API_TOKEN'
+  config.netbox.api_base_url = 'http://netbox.local/api/'
+
+  # these are optional:
+  config.netbox.pagination.default_limit = 50
+  config.faraday.adapter = Faraday.default_adapter
+  config.faraday.request_options = { open_timeout: 1, timeout: 5 }
+  config.faraday.logger = :logger # built-in options: :logger, :detailed_logger; default: nil
+end
+```
+
+### Structure
+
+The methods are aligned with the API as it is defined in Netbox.
+You can explore the API endpoints in your browser by opening the API endpoint. Usually that's `http://YOUR_NETBOX/api/`.
+
+So if the URL is `/api/dcim/sites.json`, then the corresponding Ruby code would be `NetboxClientRuby.dcim.sites`.
+
+### Examples
+
+```ruby
+# configuration
+NetboxClientRuby.configure do |c|
+  c.netbox.auth.token = '2e35594ec8710e9922d14365a1ea66f27ea69450'
+  c.netbox.api_base_url = 'http://netbox.local/api/'
+end
+
+# get all sites
+sites = NetboxClientRuby.dcim.sites
+puts "There are #{sites.total} sites in your Netbox instance."
+
+# get the first site of the result set
+first_site = sites[0]
+puts "The first site is called #{first_site.name}."
+
+# filter devices by site
+# Note that Netbox filters by *slug*
+devices_of_site = NetboxClientRuby.dcim.devices.filter(site: first_site.slug)
+puts "#{devices_of_site.total} devices belong to the site. #{devices_of_site}.length devices have been fetched."
+```
+
+## Available Objects
+
+Not all objects which the Netbox API exposes are currently implemented. Implementing new objects
+[is trivial](https://github.com/ninech/netbox-client-ruby/commit/e3cee19d21a8a6ce480d7c03d23d7c3fbc92417a), though.
+
+* DCIM:
+  * Devices
+  * Device Roles
+  * Device Types
+  * Interfaces
+  * Manufacturers
+  * Platforms
+  * Racks
+  * Regions
+  * Sites
+* IPAM:
+  * Aggregates
+  * IP Addresses
+  * Prefixes
+  * RIRs
+  * Roles
+  * VLANs
+  * VLAN Groups
+  * VRFs
+* Tenancy:
+  * Tenant
+  * Tenant Groups
+  
+If you can't find the object you need, also check
+[the source code](https://github.com/ninech/netbox-client-ruby/tree/master/lib/netbox_client_ruby/api)
+if it was added in the meantime without the list above having been updated.
+
+## Development
+
+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.
+
+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).
+
+## Contributing
+
+Bug reports and pull requests are very welcome [on GitHub](https://github.com/ninech/netbox-client-ruby).
+
+Before opening a PR, please
+
+* extend the existing specs
+* run rspec
+* run rubocop and fix your warnings
+* check if this README.md file needs adjustments
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## About
+
+This gem is currently maintained and funded by [nine.ch](https://nine.ch).
+
+[![nine.ch logo](https://blog.nine.ch/assets/logo.png)](https://nine.ch)

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'netbox-client-ruby'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start
+
+# require 'irb'
+# IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.test.yml

@@ -0,0 +1,5 @@
+version: '2'
+services:
+  app:
+    build: .
+    command: 'docker/start.test.sh'

data/docker-compose.yml

@@ -0,0 +1,37 @@
+version: '2'
+services:
+  app:
+    build: .
+    depends_on:
+      - nginx
+    volumes:
+      - .:/app
+  nginx:
+    image: nginx:1.11-alpine
+    command: nginx -g 'daemon off;' -c /etc/netbox-nginx/nginx.conf
+    depends_on:
+      - netbox
+    volumes:
+      - netbox-nginx-config:/etc/netbox-nginx/
+      - netbox-static-files:/opt/netbox/netbox/static
+    ports:
+      - 80
+  netbox:
+    image: digitalocean/netbox:v2.0-beta2
+    depends_on:
+      - postgres
+    volumes:
+      - netbox-static-files:/opt/netbox/netbox/static
+      - netbox-nginx-config:/etc/netbox-nginx/
+    env_file: 'netbox.env'
+  postgres:
+    image: postgres:9.6-alpine
+    environment:
+      POSTGRES_USER: netbox
+      POSTGRES_PASSWORD: netbox
+      POSTGRES_DB: netbox
+volumes:
+  netbox-static-files:
+    driver: local
+  netbox-nginx-config:
+    driver: local

data/docker/start.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+exec bin/console

data/docker/start.test.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+exec bundle exec rspec

data/lib/netbox-client-ruby.rb

@@ -0,0 +1 @@
+require 'netbox_client_ruby'

data/lib/netbox_client_ruby.rb

@@ -0,0 +1,25 @@
+require 'dry-configurable'
+require 'netbox_client_ruby/api'
+
+module NetboxClientRuby
+  extend Dry::Configurable
+
+  MAX_SIGNED_64BIT_INT = 9_223_372_036_854_775_807
+
+  setting :netbox do
+    setting :api_base_url
+    setting :auth do
+      setting :token
+    end
+    setting :pagination do
+      setting :default_limit, 50
+      setting :max_limit, MAX_SIGNED_64BIT_INT
+    end
+  end
+
+  setting :faraday do
+    setting :adapter, :net_http
+    setting :logger
+    setting :request_options, open_timeout: 1, timeout: 5
+  end
+end

data/lib/netbox_client_ruby/api.rb

@@ -0,0 +1,18 @@
+require 'netbox_client_ruby/api/dcim'
+require 'netbox_client_ruby/api/ipam'
+require 'netbox_client_ruby/api/tenancy'
+require 'netbox_client_ruby/communication'
+
+module NetboxClientRuby
+  def self.dcim
+    @dcim ||= NetboxClientRuby::DCIM.new
+  end
+
+  def self.tenancy
+    @tenancy ||= NetboxClientRuby::Tenancy.new
+  end
+
+  def self.ipam
+    @ipam ||= NetboxClientRuby::IPAM.new
+  end
+end

data/lib/netbox_client_ruby/api/dcim.rb

@@ -0,0 +1,55 @@
+require 'netbox_client_ruby/api/dcim/device'
+require 'netbox_client_ruby/api/dcim/devices'
+require 'netbox_client_ruby/api/dcim/device_role'
+require 'netbox_client_ruby/api/dcim/device_roles'
+require 'netbox_client_ruby/api/dcim/device_type'
+require 'netbox_client_ruby/api/dcim/device_types'
+require 'netbox_client_ruby/api/dcim/interface'
+require 'netbox_client_ruby/api/dcim/interfaces'
+require 'netbox_client_ruby/api/dcim/manufacturer'
+require 'netbox_client_ruby/api/dcim/manufacturers'
+require 'netbox_client_ruby/api/dcim/platform'
+require 'netbox_client_ruby/api/dcim/platforms'
+require 'netbox_client_ruby/api/dcim/rack'
+require 'netbox_client_ruby/api/dcim/racks'
+require 'netbox_client_ruby/api/dcim/region'
+require 'netbox_client_ruby/api/dcim/regions'
+require 'netbox_client_ruby/api/dcim/site'
+require 'netbox_client_ruby/api/dcim/sites'
+require 'netbox_client_ruby/communication'
+
+module NetboxClientRuby
+  class DCIM
+    {
+      devices: Devices,
+      device_roles: DeviceRoles,
+      device_types: DeviceTypes,
+      interfaces: Interfaces,
+      manufacturers: Manufacturers,
+      platforms: Platforms,
+      racks: Racks,
+      regions: Regions,
+      sites: Sites
+    }.each_pair do |method_name, class_name|
+      define_method(method_name) do
+        class_name.new
+      end
+    end
+
+    {
+      device: Device,
+      device_role: DeviceRole,
+      device_type: DeviceType,
+      interface: Interface,
+      manufacturer: Manufacturer,
+      platform: Platform,
+      rack: Rack,
+      region: Region,
+      site: Site
+    }.each_pair do |method_name, class_name|
+      define_method(method_name) do |id|
+        class_name.new id
+      end
+    end
+  end
+end