Merge pull request #29 from ninech/netbox_2.4_compatibility

Update for Netbox 2.4

Author: cimnine

Diff for: README.md

@@ -5,7 +5,7 @@
 [![Code Climate](https://codeclimate.com/github/ninech/netbox-client-ruby/badges/gpa.svg)](https://codeclimate.com/github/ninech/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.
+via it's API from Ruby. This gem is currently only compatible with Netbox v2.4 or newer.
 
 ## Installation
 
@@ -134,6 +134,11 @@ NetboxClientRuby.secrets.session_key = persisted_session_key
 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.
 
+* Circuits:
+  * Circuits
+  * Circuit Types
+  * Circuit Terminations
+  * Providers
 * DCIM:
   * Devices
   * Device Roles
@@ -146,6 +151,7 @@ Not all objects which the Netbox API exposes are currently implemented. Implemen
   * Racks
   * Rack Groups
   * Rack Roles
+  * Rack Reservations
   * Regions
   * Sites
 * IPAM:
@@ -178,11 +184,33 @@ 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.
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `rake spec` to run the tests.
 
 To install this gem onto your local machine, run `bundle exec rake install`.
 
+To experiment interactively, fire up the Netbox Docker container by running `docker-compose up -d`.
+Then, run `bin/console` for an interactive prompt that will allow you to experiment against your local Netbox.
+
+### Load Development Data
+
+To simplify development, e.g. via the `bin/console` described above, there is a very complete sample set of Netbox data readily available.
+You can use it to query almost every object and relation in Netbox.
+
+```bash
+cat dump.sql | docker-compose exec postgres psql -U postgres
+```
+
+### Dump Development from Database
+
+Should you want to export the current set of data, use the command below.
+
+```bash
+docker-compose exec postgres pg_dump -U netbox --exclude-table-data=extras_objectchange -Cc netbox > dump.sql
+```
+
+(Remove `--exclude-table-data=extras_objectchange` from the command if you want to retain the history!)
+
 ## Contributing
 
 Bug reports and pull requests are very welcome [on GitHub](https://github.com/ninech/netbox-client-ruby).

Diff for: bin/console

@@ -6,7 +6,29 @@ 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!)
+NetboxClientRuby.configure do |c|
+  c.netbox.auth.token = '0123456789abcdef0123456789abcdef01234567'
+  c.netbox.auth.rsa_private_key.path =
+    File.expand_path('../netbox-client-ruby_rsa', __dir__)
+  c.netbox.auth.rsa_private_key.password = nil
+  c.netbox.api_base_url = "http://#{`docker-compose port nginx 8080`.strip}/api/"
+  c.faraday.logger = :detailed_logger
+end
+
+NCR = NetboxClientRuby
+
+version = File.read(File.expand_path('../VERSION', __dir__)).strip
+
+puts <<~WELCOME_TEXT
+  This is using NetboxClientRuby v#{version}.
+  `NetboxClientRuby` has been abbreviated to `NCR` in this console.
+  You will be talking to '#{NetboxClientRuby.config.netbox.api_base_url}'.
+
+  Wondering how many regions you have in your Netbox?
+  Type: NetboxClientRuby.dcim.regions.count
+  Or Short: NCR.dcim.regions.count
+WELCOME_TEXT
+
 require 'pry'
 Pry.start
 

Diff for: docker-compose.yml

@@ -1,7 +1,7 @@
 version: '2'
 services:
   nginx:
-    image: nginx:1.11-alpine
+    image: nginx:1.14-alpine
     command: nginx -g 'daemon off;' -c /etc/netbox-nginx/nginx.conf
     depends_on:
       - netbox
@@ -11,15 +11,15 @@ services:
     ports:
       - 8080
   netbox:
-    image: ninech/netbox:latest
+    image: ninech/netbox:v2.4.3
     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
+    image: postgres:10.4-alpine
     environment:
       POSTGRES_USER: netbox
       POSTGRES_PASSWORD: netbox