freebox_api 0.1.2 → 0.2.0

data/README.md

@@ -69,7 +69,7 @@ mySession = FreeboxApi::Session.new(myApp, myFreebox)
 or
 
 ```ruby
-mysession = FreeboxApi::Session.new({
+mySession = FreeboxApi::Session.new({
   :app_id      => 'fr.freebox.testapp',
   :app_version => '0.0.7',
   :app_token   => 'dyNYgfK0Ya6FWGqq83sBHa7TwzWo+pg4fDFUJHShcjVYzTfaRrZzm93p7OTAfH/0',
@@ -79,50 +79,43 @@ mysession = FreeboxApi::Session.new({
 Reference
 ---------
 
-```ruby
-config = FreeboxApi::Config.new(mySession)
-```
-
-### Connection API
+### Configuration
 
-#### Connection status
+#### Connection
 
 ##### Get the current Connection status
-[ ] GET /api/v1/connection/
 
-#### Connection configuration
+```ruby
+FreeboxApi::Configuration::Connection.getStatus(mySession)
+```
 
 ##### Get the current Connection configuration
-[X] GET /api/v1/connection/config/
 
 ```ruby
-config.show('connection')
+FreeboxApi::Configuration::Connection.getConfig(mySession)
 ```
 
 ##### Update the Connection configuration
-[X] PUT /api/v1/connection/config/
 
 ```ruby
-config.update('connection', {
+FreeboxApi::Configuration::Connection.updateConfig(mySession, {
   :ping => true,
   :wol  => false,
 })
 ```
 
-#### Connection IPv6 configuration
+##### IPv6
 
-##### Get the current IPv6 Connection configuration
-[X] GET /api/v1/connection/ipv6/config/
+###### Get the current IPv6 Connection configuration
 
 ```ruby
-config.show('ipv6')
+FreeboxApi::Configuration::Connection::IPv6.getConfig(mySession)
 ```
 
-##### Update the IPv6 Connection configuration
-[X] PUT /api/v1/connection/ipv6/config/
+###### Update the IPv6 Connection configuration
 
 ```ruby
-config.update('ipv6', {
+FreeboxApi::Configuration::Connection::IPv6.updateConfig(mySession, {
   :delegations => [
     {
      :prefix   => '2a01:e30:d252:a2a2::/64',
@@ -132,25 +125,38 @@ config.update('ipv6', {
 })
 ```
 
-#### Connection DynDNS status
+##### Connection DynDNS status
+
+###### Get the status of a DynDNS service
+
+```ruby
+FreeboxApi::Configuration::Connection::DDNS.getStatus(mySession, 'dyndns')
+```
+
+or
+
+```ruby
+ddns = FreeboxApi::Configuration::Connection::DDNS.new(mySession, 'dyndns')
+ddns.status
+```
 
-##### Get the status of a DynDNS service
-[ ] GET /api/v1/connection/ddns/{provider}/status/
+###### Get the config of a DynDNS service
 
-#### Connection DynDNS configuration
+```ruby
+FreeboxApi::Configuration::Connection::DDNS.getConfig(mySession, 'dyndns')
+```
 
-##### Get the config of a DynDNS service
-[X] GET /api/v1/connection/ddns/{provider}/
+or
 
 ```ruby
-config.show('ddns/dyndns')
+ddns = FreeboxApi::Configuration::Connection::DDNS.new(mySession, 'dyndns')
+ddns.config
 ```
 
 ##### Set the config of a DynDNS service
-[X] PUT /api/v1/connection/ddns/{provider}/
 
 ```ruby
-config.update('ddns/dyndns', {
+FreeboxApi::Configuration::Connection::DDNS.updateConfig(mySession, 'dyndns', {
   :enabled  => false,
   :user     => 'test',
   :password => 'ssss',
@@ -158,22 +164,30 @@ config.update('ddns/dyndns', {
 })
 ```
 
-### Lan
+or
+
+```ruby
+ddns = FreeboxApi::Configuration::Connection::DDNS.new(mySession, 'dyndns')
+ddns.config = {
+  :enabled  => false,
+  :user     => 'test',
+  :password => 'ssss',
+  :hostname => 'ttt',
+}
+```
 
-#### Lan Config API
+#### Lan
 
 ##### Get the current Lan configuration
-[X] GET /api/v1/lan/config/
 
 ```ruby
-config.show('lan')
+FreeboxApi::Configuration::Lan.getConfig(mySession)
 ```
 
 ##### Update the current Lan configuration
-[X] PUT /api/v1/lan/config/
 
 ```ruby
-config.update('lan', {
+FreeboxApi::Configuration::Lan.updateConfig({
   :mode         => 'router',
   :ip           => '192.168.69.254',
   :name         => 'Freebox de r0ro',
@@ -183,38 +197,52 @@ config.update('lan', {
 })
 ```
 
-### Lan Browser
-
-#### Lan Browser API
+##### Lan Browser
 
-##### Getting the list of browsable LAN interfaces
-[X] GET /api/v1/lan/browser/interfaces/
+###### Getting the list of browsable LAN interfaces
 
 ```ruby
-interfaces = FreeboxApi::Resources::Interface.new(mySession)
-interfaces.index
+FreeboxApi::Configuration::Lan::Browser.interfaces(mySession)
 ```
 
 ##### 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
+FreeboxApi::Configuration::Lan::Browser::Interface.getLanHosts(mySession, 'pub')
+```
+
+```ruby
+interface = FreeboxApi::Configuration::Lan::Browser::Interface.new(mySession, 'pub')
+interface.lan_hosts
 ```
 
 ##### Getting an host information
-[X] GET /api/v1/lan/browser/{interface}/{hostid}/
 
 ```ruby
-lan_hosts.show('ether-00:24:d4:7e:00:4c')
+FreeboxApi::Configuration::Lan::Browser::LanHost.show(mySession, 'pub', 'ether-00:24:d4:7e:00:4c')
+```
+
+or
+
+```ruby
+lan_host = FreeboxApi::Configuration::Lan::Browser::LanHost.new(mySession, 'pub', 'ether-00:24:d4:7e:00:4c')
+lan_host.show
 ```
 
 ##### Updating an host information
-[X] PUT /api/v1/lan/browser/{interface}/{hostid}/
 
 ```ruby
-lan_hosts.update({
+FreeboxApi::Configuration::Lan::Browser::LanHost.update(mySession, 'pub', 'ether-00:24:d4:7e:00:4c', {
+  :id           => 'ether-00:24:d4:7e:00:4c',
+  :primary_name => 'Freebox Tv',
+})
+```
+
+or
+
+```ruby
+lan_host = FreeboxApi::Configuration::Lan::Browser::LanHost.new(mySession, 'pub', 'ether-00:24:d4:7e:00:4c')
+lan_host.update({
   :id           => 'ether-00:24:d4:7e:00:4c',
   :primary_name => 'Freebox Tv',
 })
@@ -223,96 +251,145 @@ lan_hosts.update({
 #### Wake on LAN
 
 ##### Send Wake ok Lan packet to an host
-[ ] POST /api/v1/lan/wol/{interface}/
 
-### Freeplug
+```ruby
+FreeboxApi::Configuration::Lan::Browser::Interface.wol(mySession, 'pub', {
+  :mac      => '00:24:d4:7e:00:4c',
+  :password => '',
+}
+```
+
+or
+
+```ruby
+interface = FreeboxApi::Configuration::Lan::Browser::Interface.new(mySession, 'pub')
+interface.wol({
+  :mac      => '00:24:d4:7e:00:4c',
+  :password => '',
+}
+```
 
-#### Freeplug API
+or
 
 ```ruby
-freeplug_networks = FreeboxApi::Resources::FreeplugNetwork.new(session)
-freeplugs = FreeboxApi::Resources::Freeplug.new(session)
+lan_host = FreeboxApi::Configuration::Lan::Browser::LanHost.new(mySession, 'pub', 'ether-00:24:d4:7e:00:4c')
+lan_host.wol({ :password => '' })
 ```
 
+#### Freeplug
+
 ##### Get the current Freeplugs networks
-[X] GET /api/v1/freeplug/
 
 ```ruby
-freeplug_networks.index
+FreeboxApi::Configuration::Freeplug.network(mySession)
 ```
 
 ##### Get a particular Freeplug information
-[X] GET /api/v1/freeplug/{id}/
 
 ```ruby
-freeplugs.show('F4:CA:E5:1D:46:AE')
+FreeboxApi::Configuration::Freeplug.show(mySession, 'F4:CA:E5:1D:46:AE')
+```
+
+or
+
+```ruby
+freeplug = FreeboxApi::Configuration::Freeplug.new(mySession, 'F4:CA:E5:1D:46:AE')
+freeplug.show
 ```
 
 ##### Reset a Freeplug
-[X] POST /api/v1/freeplug/{id}/reset/
 
 ```ruby
-freeplugs.reset('F4:CA:E5:1D:46:AE')
+FreeboxApi::Configuration::Freeplug.reset(mySession, 'F4:CA:E5:1D:46:AE')
 ```
 
-### DHCP
+or
+
+```ruby
+freeplug = FreeboxApi::Configuration::Freeplug.new(mySession, 'F4:CA:E5:1D:46:AE')
+freeplug.reset
+```
 
-#### DHCP Configuration API
+#### DHCP
 
 ##### Get the current DHCP configuration
-[X] GET /api/v1/dhcp/config/
 
 ```ruby
-config.show('dhcp')
+FreeboxApi::Configuration::Dhcp.getConfig(mySession)
 ```
 
 ##### Update the current DHCP configuration
-[X] PUT /api/v1/dhcp/config/
 
 ```ruby
-config.update('dhcp', {
+FreeboxApi::Configuration::Dhcp.updateConfig(mySession, {
   :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
+FreeboxApi::Configuration::Dhcp.static_leases(mySession)
 ```
 
 ##### Get a given DHCP static lease
-[X] GET /api/v1/dhcp/static\_lease/{id}
 
 ```ruby
-static_leases.show('00:DE:AD:B0:0B:55')
+FreeboxApi::Configuration::Dhcp::StaticLease.show(mySession, '00:DE:AD:B0:0B:55')
+```
+
+or
+
+```ruby
+static_lease = FreeboxApi::Configuration::Dhcp::StaticLease.new(mySession, '00:DE:AD:B0:0B:55')
+static_lease.show
 ```
 
 ##### Update DHCP static lease
-[X] PUT /api/v1/dhcp/static\_lease/{id}
 
 ```ruby
-static_leases.update({
+FreeboxApi::Configuration::Dhcp::StaticLease.update(mySession, {
+  :id      => '00:DE:AD:B0:0B:55',
+  :comment => 'Mon PC',
+})
+```
+
+or
+
+```ruby
+static_lease = FreeboxApi::Configuration::Dhcp::StaticLease.new(mySession, '00:DE:AD:B0:0B:55')
+static_lease.update({
   :id      => '00:DE:AD:B0:0B:55',
   :comment => 'Mon PC',
 })
 ```
 
 ##### Delete a DHCP static lease
-[X] DELETE /api/v1/dhcp/static\_lease/{id}
 
 ```ruby
-static_lease.destroy('00:DE:AD:B0:0B:55')
+FreeboxApi::Configuration::Dhcp::StaticLease.delete(mySession, '00:DE:AD:B0:0B:55')
+```
+
+or
+
+```ruby
+static_lease = FreeboxApi::Configuration::Dhcp::StaticLease.new(mySession, '00:DE:AD:B0:0B:55')
+static_lease.delete
 ```
 
 ##### Add a DHCP static lease
-[X] POST /api/v1/dhcp/static\_lease/
 
 ```ruby
+FreeboxApi::Configuration::Dhcp::StaticLease.create(mySession, {
+  :ip  => '192.168.1.222',
+  :mac => '00:00:00:11:11:11',
+})
+```
+
+or
+
+```ruby
+static_lease = FreeboxApi::Configuration::Dhcp::StaticLease.new(mySession, '00:00:00:11:11:11')
 static_lease.create({
   :ip  => '192.168.1.222',
   :mac => '00:00:00:11:11:11',
@@ -320,7 +397,15 @@ static_lease.create({
 ```
 
 ##### Get the list of DHCP dynamic leases
-[ ] GET /api/v1/dhcp/dynamic\_lease/
+
+```ruby
+FreeboxApi::Configuration::Dhcp.dynamic_leases(mySession)
+```
+
+
+OLD API
+=======
+
 
 ### Ftp
 

data/lib/freebox_api.rb

@@ -2,6 +2,13 @@ module FreeboxApi
 end
 
 require 'freebox_api/config'
+
+require 'freebox_api/configuration'
+require 'freebox_api/configuration/connection'
+require 'freebox_api/configuration/dhcp'
+require 'freebox_api/configuration/freeplug'
+require 'freebox_api/configuration/lan'
+
 require 'freebox_api/freebox'
 require 'freebox_api/session'
 require 'freebox_api/version'

data/lib/freebox_api/configuration.rb

@@ -0,0 +1,7 @@
+module FreeboxApi
+
+  module Configuration
+
+  end
+
+end

data/lib/freebox_api/configuration/connection.rb

@@ -0,0 +1,70 @@
+module FreeboxApi
+
+  module Configuration
+
+    module Connection
+
+      def self.getStatus(session)
+        session.http_call('get', '/connection/')
+      end
+
+      def self.getConfig(session)
+        session.http_call('get', '/connection/config/')
+      end
+
+      def self.updateConfig(session, value)
+        session.http_call('put', '/connection/config/', value)
+      end
+
+      module IPv6
+
+        def self.getConfig(session)
+          session.http_call('get', '/connection/ipv6/config/')
+        end
+
+        def self.updateConfig(session, value)
+          session.http_call('put', '/connection/ipv6/config/', value)
+        end
+
+      end
+
+      class DDNS
+
+        def initialize(session, provider)
+          # TODO: validate that provider matches (ovh|dyndns|noip)
+          @session = session
+          @provider = provider
+        end
+
+        def self.getStatus(session, provider)
+          session.http_call('get', "/connection/ddns/#{provider}/status/")
+        end
+
+        def status
+          self.class.getStatus(@session, @provider)
+        end
+
+        def self.getConfig(session, provider)
+          session.http_call('get', "/connection/ddns/#{provider}/")
+        end
+
+        def config
+          self.class.getConfig(@session, @provider)
+        end
+
+        def self.updateConfig(session, provider, value)
+          @session.http_call('put', "/connection/ddns/#{provider}/", value)
+        end
+
+        def config=(value)
+          self.class.updateConfig(@session, @provider, value)
+        end
+
+      end
+
+    end
+
+  end
+
+end
+

data/lib/freebox_api/configuration/dhcp.rb

@@ -0,0 +1,68 @@
+module FreeboxApi
+
+  module Configuration
+
+    module Dhcp
+
+      def self.getConfig(session)
+        session.http_call('get', '/dhcp/config/')
+      end
+
+      def self.updateConfig(session, value)
+        session.http_call('put', '/dhcp/config/')
+      end
+
+      def self.static_leases(session)
+        session.http_call('get', '/dhcp/static_lease/')
+      end
+
+      def self.dynamic_leases(session)
+        session.http_call('get', '/dhcp/dynamic_lease/')
+      end
+
+      class StaticLease
+
+        def initialize(session, id)
+          @session = session
+          @id = id
+	end
+
+        def self.show(session, id)
+          session.http_call('get', "/dhcp/static_lease/#{id}")
+        end
+
+        def show
+          self.class.show(@session, @id)
+  	end
+
+        def self.update(session, id, value = {})
+          session.http_call('put', "/dhcp/static_lease/#{id}", value)
+        end
+
+        def update(value = {})
+          self.class.update(@session, @id, value)
+        end
+
+        def self.delete(session, id)
+          session.http_call('delete', "/dhcp/static_lease/#{id}")
+        end
+
+        def delete
+          self.class.delete(@session, @id)
+        end
+
+        def self.create(session, value)
+          session.http_call('post', '/dhcp/static_lease/', value)
+        end
+
+        def create(value)
+          self.class.create(@session, value)
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/freebox_api/configuration/freeplug.rb

@@ -0,0 +1,36 @@
+module FreeboxApi
+
+  module Configuration
+
+    class Freeplug
+
+      def initialize(session, id)
+        @session = session
+	@id = id
+      end
+
+      def self.network(session)
+        session.http_call('get', '/freeplug/')
+      end
+
+      def self.show(session, id)
+        session.http_call('get', "/freeplug/#{id}/")
+      end
+
+      def show
+        self.class.show(@session, @id)
+      end
+
+      def self.reset(session, id)
+        session.http_call('post', "/freeplug/#{id}/reset/")
+      end
+
+      def reset
+        self.class.reset(@session, @id)
+      end
+
+    end
+
+  end
+
+end

data/lib/freebox_api/configuration/lan.rb

@@ -0,0 +1,85 @@
+module FreeboxApi
+
+  module Configuration
+
+    module Lan
+
+      def self.getConfig(session)
+        session.http_call('get', '/lan/config/')
+      end
+
+      def self.updateConfig(session, value)
+        session.http_call('put', '/lan/config/', value)
+      end
+
+      module Browser
+
+        def self.interfaces(session)
+          session.http_call('get', '/lan/browser/interfaces/')
+        end
+
+        class Interface
+
+          def initialize(session, name)
+            @session = session
+            @name = name
+          end
+
+          def self.getLanHosts(session, name)
+            session.http_call('get', "/lan/browser/#{name}/")
+          end
+
+          def lan_hosts
+            self.class.getLanHosts(@session, @name)
+          end
+
+          def self.wol(session, name, params = {})
+            session.http_call('post', "/lan/wol/#{name}/", params)
+          end
+
+          def wol(params = {})
+            self.class.wol(@session, @name, params)
+          end
+
+        end
+
+        class LanHost
+
+          def initialize(session, interface, hostid)
+            @session = session
+            @interface = interface
+            @hostid = hostid
+          end
+
+          def self.show(session, interface, hostid)
+            session.http_call('get', "/lan/browser/#{interface}/#{hostid}/")
+          end
+
+          def show
+            self.class.show(@session, @interface, @hostid)
+          end
+
+          def self.update(session, interface, hostid, value)
+            session.http_call('put', "/lan/browser/#{interface}/#{hostid}/", value)
+          end
+
+          def update(value)
+            self.class.update(@session, @interface, @hostid, value)
+          end
+
+          def wol(password = '')
+            Interface.wol(@session, interface, {
+              :mac      => show['l2ident']['id'],
+              :password => password,
+	    })
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/lib/freebox_api/freebox.rb

@@ -8,7 +8,7 @@ module FreeboxApi
 
     attr_reader :logger
 
-    def initialize(hash = {})
+    def initialize(hash = {}, logger = nil)
       self[:freebox_ip] = hash[:freebox_ip] ? hash[:freebox_ip] : 'mafreebox.free.fr'
       self[:freebox_port] = hash[:freebox_port] ? hash[:freebox_port] : '80'
       @client = RestClient::Resource.new("http://#{self[:freebox_ip]}:#{self[:freebox_port]}")
@@ -17,7 +17,7 @@ module FreeboxApi
       self[:api_version] = discover['api_version']
       self[:api_base_url] = discover['api_base_url']
       self[:device_type] = discover['device_type']
-      self.logger = nil
+      self.logger = logger
     end
 
     def logger=(logger)

data/lib/freebox_api/version.rb

@@ -1,3 +1,3 @@
 module FreeboxApi
-  VERSION = '0.1.2'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,18 +1,20 @@
 --- !ruby/object:Gem::Specification
 name: freebox_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
+  prerelease: 
 platform: ruby
 authors:
 - Mickaël Canévet
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-30 00:00:00.000000000 Z
+date: 2013-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -20,6 +22,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -27,6 +30,7 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -34,6 +38,7 @@ dependencies:
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
@@ -51,6 +56,11 @@ files:
 - lib/freebox_api.rb
 - lib/freebox_api/application.rb
 - lib/freebox_api/config.rb
+- lib/freebox_api/configuration.rb
+- lib/freebox_api/configuration/connection.rb
+- lib/freebox_api/configuration/dhcp.rb
+- lib/freebox_api/configuration/freeplug.rb
+- lib/freebox_api/configuration/lan.rb
 - lib/freebox_api/freebox.rb
 - lib/freebox_api/resources/freeplug.rb
 - lib/freebox_api/resources/freeplug_network.rb
@@ -64,25 +74,26 @@ files:
 homepage: http://github.com/mcanevet/freebox_api
 licenses:
 - Apache 2.0
-metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 1.8.23
 signing_key: 
-specification_version: 4
+specification_version: 3
 summary: Ruby bindings for Freebox OS's rest API
 test_files: []

checksums.yaml

@@ -1,15 +0,0 @@
----
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OWU0Zjg4MjY4Yjk3ZTFkNGZkMjY1MmJmOTM2NzNhNTIwNTU1ZTI0Mg==
-  data.tar.gz: !binary |-
-    MzM3ODk1MWMwZjg0NzZiYmUzMWRiY2JjNDZlYmEyMGZlZTc4NDk1YQ==
-SHA512:
-  metadata.gz: !binary |-
-    ZWE3ZTk4ODZhYjMxNGEyOTMyOTM3ZjVlY2ZjZGZmMTAwMzUyMThlNTUzOGQz
-    M2QwYTdhMzQwZmNhZTUwNTcyZGJjNjlmZmMzNjg2OGVlZTExMTU3YzU1NWZj
-    OTFmOTY1NjU1OWU1NWZmOGI3ZGJhNDY1OTY5MTQxODY3M2ViZTg=
-  data.tar.gz: !binary |-
-    MGI5ZGViOGViYmYxMTZhZTIxYjk3NmExODZhYjQ4NGYyNTZjNjMyYWZkZTY2
-    MTQyMWZkZjRlM2E3NTdmMjgyOGRjZThmY2Y0NjY1OTc0MTA5NTgyYjBhZDYz
-    YzE4MjIyMzJhODY1ZGQ1NzlmZDBlMzc4ODA3ZTM2NTRjY2EwNDE=