Freebox OS API bindings for Ruby
================================

WARNING: Work In Progress.

Overview
--------

This gem contains Freebox OS API bindings for the Ruby language.
I started working on that to use it with https://github.com/mcanevet/puppet-freebox

Obtaining an app\_token
-----------------------

```ruby
require 'freebox_api'

puts FreeboxApi::Freebox.app_token('fr.freebox.testapp', 'Test App', '0.0.7', 'Pc de Xavier')
```

Initialize application
----------------------

```ruby
require 'freebox_api'

mafreebox = FreeboxApi::Freebox.new('dyNYgfK0Ya6FWGqq83sBHa7TwzWo+pg4fDFUJHShcjVYzTfaRrZzm93p7OTAfH/0', 'fr.freebox.testapp', 'Test App', '0.0.7', 'Pc de Xavier', 'http://mafreebox.example.com:4242')
```

Get the current challenge
-------------------------

```ruby
puts mafreebox.challenge
```

Get the current password
------------------------

```ruby
puts mafreebox.password
```

Get the current session\_token
-----------------------------

```ruby
puts mafreebox.session_token
```

Get the list of browsable LAN interfaces
----------------------------------------

```ruby
puts mafreebox.interfaces
```

Get the list of LAN hosts
-------------------------

```ruby
puts mafreebox.lan_hosts
```

Get the list of DHCP static leases
----------------------------------

```ruby
puts mafreebox.static_leases
```

Get the list of Port Forwardings
--------------------------------

```ruby
puts mafreebox.redirs
```