freebox_api 0.0.2 → 0.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZTRhOTA2NWI2NTZhM2E1NGEwMzA1MzE4OGRhMzhlZWNmNDE1MTljNg==
+    OTBiM2ZhNGVjYzZkMTEwZGVkOTc3NWMxNzQ0MmVkYWEzMmVhNmZmMQ==
   data.tar.gz: !binary |-
-    YzAwZmY4YzI2MzFlODliOTE3NTljOGJiNTliYTQxMDE3NDRkNDY2Nw==
+    M2EyZDUzMGQ2MTVjOTlkZGRiNzczZWRjMTFiMmJjNTRmODJkNjUzOA==
 SHA512:
   metadata.gz: !binary |-
-    NDcyYjNhNTRhYWZhZTRmMjBjZDFkMWE5ZTI1MGM3YjVmOTIwOWM4ZmM0N2U3
-    NDgyY2Q1MzRmMTRkZjAxOWZjYjhiNWFlNjBiMTFkZDA4ZGMxN2M3ZWE4ZGI2
-    MTJhMGM0MTBlNjQ5MjcyYWU4YjgzMjQzOGNjMWJmYzg2MzE3ODE=
+    YjUwZTUyN2FmM2I4ZTJjNjI4M2IxOGU0YmFjNzNmZmY0NzIyM2U2YzA5NGJi
+    OWVmNTIzYmIwYTJhNGQ1ZjU0NmZhZTRiMTc1YjMyZWIwNjYwYzgwZDhlNzFl
+    MzkwMDA4NzcwZmZiZDQ2OGM2NTQ5MjFhMTBiZmE2MGVjZWU2Njc=
   data.tar.gz: !binary |-
-    MWZiZGYxYjk1YTY0ZGRmZjNiMDMzZWQ2MmFkMTJiNzQ2NTdmNTNkODc0Nzg3
-    M2Q0YThjYzliNjEzZDk3OTFmNWIwY2JhYmI0ZGY0YzM1NWVlOTAwZTdjYzM4
-    NWY2MDFhNzI4MWJjNzNhMDA0ZTg5MjM2MGVjNTI5YTY2MjYwOGU=
+    MWU1Mzk1ODc1MzA4ODMwZWYwOWViYjlmODViZWIxNGIyZTdhNzUyNDEwMDBj
+    ZDk5NDgzZDA5OGVmZmU4Y2NhZjE3NmU0ZGZkNTI5MTk1ZGYyMTQyYmMyYTgz
+    YmQ5NjMyMTk0ZGE5MjhmM2ZjY2FiMDQxZjM4NTJiYzVhOTY1MTA=

data/README.md

@@ -69,42 +69,113 @@ myApp = {
 mySession = FreeboxApi::Session.new(myApp, myFreebox)
 ```
 
-#### Getting the current challenge value
+or
+
+```ruby
+mysession = FreeboxApi::Session.new({
+  :app_id      => 'fr.freebox.testapp',
+  :app_version => '0.0.7',
+  :app_token   => 'dyNYgfK0Ya6FWGqq83sBHa7TwzWo+pg4fDFUJHShcjVYzTfaRrZzm93p7OTAfH/0',
+}, FreeboxApi::Freebox.new)
+```
+
+Reference
+---------
+
+### Connection API
 
 ```ruby
-myFreebox.challenge
+connection = FreeboxApi::Services::Connection.new(mySession)
 ```
 
-#### Opening a session
+#### Connection status
+
+##### Get the current Connection status
+[X] GET /api/v1/connection/
 
 ```ruby
-mySession.session_token
+connection.status
 ```
 
-LAN Browser
------------
+#### Connection configuration
+
+##### Get the current Connection configuration
+[X] GET /api/v1/connection/config/
+
+```ruby
+connection.config
+```
+
+##### Update the Connection configuration
+[X] PUT /api/v1/connection/config/
+
+```ruby
+connection.config = {
+  :ping => true,
+  :wol  => false,
+}
+```
+
+#### Connection IPv6 configuration
+
+##### Get the current IPv6 Connection configuration
+[ ] GET /api/v1/connection/ipv6/config/
+
+##### Update the IPv6 Connection configuration
+[ ] PUT /api/v1/connection/ipv6/config/
+
+#### Connection DynDNS status
+
+##### Get the status of a DynDNS service
+[ ] GET /api/v1/connection/ddns/{provider}/status/
+
+#### Connection DynDNS configuration
+
+##### Get the config of a DynDNS service
+[ ] GET /api/v1/connection/ddns/{provider}/
+
+##### Set the config of a DynDNS service
+[ ] PUT /api/v1/connection/ddns/{provider}/
 
-### Getting the list of browsable LAN interfaces
+### Lan
+
+#### Lan Config API
+
+##### Get the current Lan configuration
+[ ] GET /api/v1/lan/config/
+
+##### Update the current Lan configuration
+[ ] PUT /api/v1/lan/config/
+
+### Lan Browser
+
+#### Lan Browser API
+
+##### Getting the list of browsable LAN interfaces
+[X] GET /api/v1/lan/browser/interfaces/
 
 ```ruby
 interfaces = FreeboxApi::Resources::Interface.new(mySession)
 interfaces.index
 ```
 
-### Getting the list of hosts
+##### Getting the list of hosts on a given interface
+[X] GET /api/v1/lan/browser/{interface}/
 
 ```ruby
 lan_hosts = FreeboxApi::Resources::LanHost.new(mySession)
 lan_hosts.index
 ```
 
-### Getting an host information
+##### Getting an host information
+[X] GET /api/v1/lan/browser/{interface}/{hostid}/
 
 ```ruby
 lan_hosts.show('ether-00:24:d4:7e:00:4c')
 ```
 
-### Updating an host information
+##### Updating an host information
+[X] PUT /api/v1/lan/browser/{interface}/{hostid}/
 
 ```ruby
 lan_hosts.update({
@@ -113,23 +184,67 @@ lan_hosts.update({
 })
 ```
 
-DHCP
-----
+#### Wake on LAN
+
+##### Send Wake ok Lan packet to an host
+[ ] POST /api/v1/lan/wol/{interface}/
 
-### Get the list of DHCP static leases
+### Freeplug
+
+#### Freeplug API
+
+##### Get the current Freeplugs networks
+[ ] GET /api/v1/freeplug/
+
+##### Get a particular Freeplug information
+[ ] GET /api/v1/freeplug/{id}/
+
+##### Reset a Freeplug
+[ ] POST /api/v1/freeplug/{id}/reset/
+
+### DHCP
+
+#### DHCP Configuration API
+
+```ruby
+dhcp = FreeboxApi::Services::DHCP.new(mySession)
+```
+
+##### Get the current DHCP configuration
+[X] GET /api/v1/dhcp/config/
+
+```ruby
+dhcp.config
+```
+
+##### Update the current DHCP configuration
+[X] PUT /api/v1/dhcp/config/
+
+```ruby
+dhcp.config = {
+  :enabled => false,
+}
+```
+
+#### DHCP Static Lease API
+
+##### Get the list of DHCP static leases
+[X] GET /api/v1/dhcp/static\_lease/
 
 ```ruby
 static_leases = FreeboxApi::Resources::StaticLease.new(mySession)
 static_leases.index
 ```
 
-### Get a given DHCP static lease
+##### Get a given DHCP static lease
+[X] GET /api/v1/dhcp/static\_lease/{id}
 
 ```ruby
-static_leases.show('00:DE:AD:B0:0B:55)
+static_leases.show('00:DE:AD:B0:0B:55')
 ```
 
-### Update DHCP static lease
+##### Update DHCP static lease
+[X] PUT /api/v1/dhcp/static\_lease/{id}
 
 ```ruby
 static_leases.update({
@@ -138,13 +253,16 @@ static_leases.update({
 })
 ```
 
-### Delete a DHCP static lease
+##### Delete a DHCP static lease
+[X] DELETE /api/v1/dhcp/static\_lease/{id}
 
 ```ruby
 static_lease.destroy('00:DE:AD:B0:0B:55')
 ```
 
-### Add a DHCP static lease
+##### Add a DHCP static lease
+[X] POST /api/v1/dhcp/static\_lease/
+
 ```ruby
 static_lease.create({
   :ip  => '192.168.1.222',
@@ -152,23 +270,50 @@ static_lease.create({
 })
 ```
 
-Port Forwarding
----------------
+##### Get the list of DHCP dynamic leases
+[ ] GET /api/v1/dhcp/dynamic\_lease/
+
+### Ftp
+
+#### Ftp config API
+
+##### Get the current Ftp configuration
+[ ] GET /api/v1/ftp/config/
+
+##### Update the FTP configuration
+[ ] PUT /api/v1/ftp/config/
+
+### NAT
 
-### Getting the list of port forwarding
+#### Dmz Config API
+
+##### Get the current Dmz configuration
+[ ] GET /api/v1/fw/dmz/
+
+##### Update the current Dmz configuration
+[ ] PUT /api/v1/fw/dmz/
+
+### Port Forwarding
+
+#### Port Forwarding API
+
+##### Getting the list of port forwarding
+[X] GET /api/v1/fw/redir/
 
 ```ruby
 port_forwardings = FreeboxApi::Resources::PortForwarding.new(mySession)
 port_forwardings.index
 ```
 
-### Getting a specific port forwarding
+##### Getting a specific port forwarding
+[X] GET /api/v1/fw/redir/{redir\_id}
 
 ```ruby
 port_forwardings.show(1)
 ```
 
-### Updating a port forwarding
+##### Updating a port forwarding
+[X] PUT /api/v1/fw/redir/{redir\_id}
 
 ```ruby
 port_forwardings.update({
@@ -177,7 +322,8 @@ port_forwardings.update({
 })
 ```
 
-### Add a port forwarding
+##### Add a port forwarding
+[X] POST /api/v1/fw/redir/
 
 ```ruby
 port_forwardings.create({
@@ -191,24 +337,130 @@ port_forwardings.create({
 })
 ```
 
-### Delete a port forwarding
+##### Delete a port forwarding
+[X] DELETE /api/v1/fw/redir/{redir\_id}
 
 ```ruby
 port_forwardings.destroy(3)
 ```
 
-UPnP IGD
---------
+### UPnP IGD
+
+#### UPnP IGD config API
 
-### Get the list of current redirection
+##### Get the current UPnP IGD configuration
+[ ] GET /api/v1/upnpigd/config/
+
+##### Update the UPnP IGD configuration
+[ ] PUT /api/v1/upnpigd/config/
+
+#### UPnP IGD Redirection API
+
+##### Get the list of current redirection
+[X] GET /api/v1/upnpigd/redir/
 
 ```ruby
 upnp_redir = FreeboxApi::Resources::UPnPRedir.new(mySession)
 upnp_redir.index
 ```
 
-### Delete a redirection
+##### Delete a redirection
+[X] DELETE /api/v1/upnpigd/redir/{id}
 
 ```ruby
 upnp_redir.destroy('0.0.0.0-53644-udp')
 ```
+
+### LCD
+
+#### LCD config API
+
+##### Get the current LCD configuration
+[ ] GET /api/v1/lcd/config/
+
+##### Update the lcd configuration
+[ ] PUT /api/v1/lcd/config/
+
+### Network Share
+
+#### Samba config API
+
+##### Get the current Samba configuration
+[ ] GET /api/v1/netshare/samba/
+
+##### Update the Samba configuration
+[ ] PUT /api/v1/netshare/samba/
+
+#### Afp config API
+
+##### Get the current Afp configuration
+[ ] GET /api/v1/netshare/afp/
+
+##### Update the Afp configuration
+[ ] PUT /api/v1/netshare/afp/
+
+### UPnP AV
+
+#### UPnP AV config API
+
+##### Get the current UPnP AV configuration
+[ ] GET /api/v1/upnpav/config/
+
+##### Update the UPnP AV configuration
+[ ] PUT /api/v1/upnpav/config/
+
+### Switch
+
+#### Switch API
+
+##### Get the current switch status
+[ ] GET /api/v1/switch/status/
+
+##### Get a port configuration
+[ ] GET /api/v1/switch/port/{id}
+
+##### Update a port configuration
+[ ] PUT /api/v1/switch/port/{id}
+
+##### Get a port stats
+[ ] GET /api/v1/switch/port/{id}/stats
+
+### Wi-Fi
+
+#### Wi-Fi Status API
+
+##### Get the current Wi-Fi status
+[ ] GET /api/v1/wifi/
+
+#### Wi-Fi config API
+
+##### Get the current Wi-Fi configuration
+[ ] GET /api/v1/wifi/config/
+
+##### Update the Wi-Fi configuration
+[ ] PUT /api/v1/wifi/config/
+
+##### Reset the Wi-Fi configuration
+[ ] POST /api/v1/wifi/config/reset/
+
+#### Wi-Fi Stations API
+
+##### Get Wi-Fi Stations List
+[ ] GET /api/v1/wifi/stations/{bss\_name}/
+
+#### Wi-Fi MAC Filter API
+
+##### Get the MAC filter list
+[ ] GET /api/v1/wifi/mac\_filter/
+
+##### Getting a particular MAC filter
+[ ] GET /api/v1/wifi/mac\_filter/{filter\_id}
+
+##### Updating a MAC filter
+[ ] PUT /api/v1/wifi/mac\_filter/{filter\_id}
+
+##### Delete a MAC filter
+[ ] DELETE /api/v1/wifi/mac\_filter/{filter\_id}
+
+##### Create a new MAC filter
+[ ] POST /api/v1/wifi/mac\_filter/

data/lib/freebox_api/services/connection.rb

@@ -0,0 +1,27 @@
+module FreeboxApi
+
+  module Services
+
+    class Connection
+
+      def initialize(session)
+        @session = session
+      end
+
+      def status
+        @session.http_call('get', '/connection/')
+      end
+
+      def config
+        @session.http_call('get', '/connection/config/')
+      end
+
+      def config=(value)
+        @session.http_call('put', '/connection/config/', value)
+      end
+
+    end
+
+  end
+
+end

data/lib/freebox_api/services/dhcp.rb

@@ -0,0 +1,23 @@
+module FreeboxApi
+
+  module Services
+
+    class DHCP
+
+      def initialize(session)
+        @session = session
+      end
+
+      def config
+        @session.http_call('get', '/dhcp/config/')
+      end
+
+      def config=(value)
+        @session.http_call('put', '/dhcp/config/', value)
+      end
+
+    end
+
+  end
+
+end

data/lib/freebox_api/version.rb

@@ -1,3 +1,3 @@
 module FreeboxApi
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/lib/freebox_api.rb

@@ -6,3 +6,5 @@ require 'freebox_api/session'
 require 'freebox_api/version'
 resource_files = Dir[File.expand_path("#{File.dirname(__FILE__)}/freebox_api/resources/*.rb", __FILE__)]
 resource_files.each { |f| require f }
+service_files = Dir[File.expand_path("#{File.dirname(__FILE__)}/freebox_api/services/*.rb", __FILE__)]
+service_files.each { |f| require f }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: freebox_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Mickaël Canévet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-28 00:00:00.000000000 Z
+date: 2013-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -56,6 +56,8 @@ files:
 - lib/freebox_api/resources/port_forwarding.rb
 - lib/freebox_api/resources/static_lease.rb
 - lib/freebox_api/resources/upnp_redir.rb
+- lib/freebox_api/services/connection.rb
+- lib/freebox_api/services/dhcp.rb
 - lib/freebox_api/session.rb
 - lib/freebox_api/version.rb
 homepage: http://github.com/mcanevet/freebox_api