freebox_api 0.1.0 → 0.1.1

data/README.md

@@ -5,8 +5,11 @@ 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
+I started working on that to use it with https://github.com/mcanevet/puppet-freebox.
+
+The official documentation is located here: http://dev.freebox.fr/sdk/os/
 
 Building the Freebox object
 ---------------------------
@@ -52,13 +55,7 @@ auth_request = myFreebox.authorize(token_request)
 app_token = auth_request['app_token']
 ```
 
-#### Track authorization progress
-
-```ruby
-puts myFreebox.track_auth(auth_request['track_id'])
-```
-
-### Obtaining a session\_token
+### Creating the session object
 
 ```ruby
 myApp = {
@@ -82,20 +79,16 @@ mysession = FreeboxApi::Session.new({
 Reference
 ---------
 
-### Connection API
-
 ```ruby
-connection = FreeboxApi::Services::Connection.new(mySession)
+config = FreeboxApi::Config.new(mySession)
 ```
 
+### Connection API
+
 #### Connection status
 
 ##### Get the current Connection status
-[X] GET /api/v1/connection/
-
-```ruby
-connection.status
-```
+[ ] GET /api/v1/connection/
 
 #### Connection configuration
 
@@ -103,26 +96,41 @@ connection.status
 [X] GET /api/v1/connection/config/
 
 ```ruby
-connection.config
+config.show('connection')
 ```
 
 ##### Update the Connection configuration
 [X] PUT /api/v1/connection/config/
 
 ```ruby
-connection.config = {
+config.update('connection', {
   :ping => true,
   :wol  => false,
-}
+})
 ```
 
 #### Connection IPv6 configuration
 
 ##### Get the current IPv6 Connection configuration
-[ ] GET /api/v1/connection/ipv6/config/
+[X] GET /api/v1/connection/ipv6/config/
+
+```ruby
+config.show('ipv6')
+```
 
 ##### Update the IPv6 Connection configuration
-[ ] PUT /api/v1/connection/ipv6/config/
+[X] PUT /api/v1/connection/ipv6/config/
+
+```ruby
+config.update('ipv6', {
+  :delegations => [
+    {
+     :prefix   => '2a01:e30:d252:a2a2::/64',
+     :next_hop => 'fe80::be30:5bff:feb5:fcc7',
+    }
+  ]
+})
+```
 
 #### Connection DynDNS status
 
@@ -132,20 +140,48 @@ connection.config = {
 #### Connection DynDNS configuration
 
 ##### Get the config of a DynDNS service
-[ ] GET /api/v1/connection/ddns/{provider}/
+[X] GET /api/v1/connection/ddns/{provider}/
+
+```ruby
+config.show('ddns/dyndns')
+```
 
 ##### Set the config of a DynDNS service
-[ ] PUT /api/v1/connection/ddns/{provider}/
+[X] PUT /api/v1/connection/ddns/{provider}/
+
+```ruby
+config.update('ddns/dyndns', {
+  :enabled  => false,
+  :user     => 'test',
+  :password => 'ssss',
+  :hostname => 'ttt',
+})
+```
 
 ### Lan
 
 #### Lan Config API
 
 ##### Get the current Lan configuration
-[ ] GET /api/v1/lan/config/
+[X] GET /api/v1/lan/config/
+
+```ruby
+config.show('lan')
+```
 
 ##### Update the current Lan configuration
-[ ] PUT /api/v1/lan/config/
+[X] PUT /api/v1/lan/config/
+
+```ruby
+config.update('lan', {
+  :mode         => 'router',
+  :ip           => '192.168.69.254',
+  :name         => 'Freebox de r0ro',
+  :name_dns     => 'freebox-de-r0ro',
+  :name_mdns    => 'Freebox-de-r0ro',
+  :name_netbios => 'Freebox_de_r0ro',
+})
+```
 
 ### Lan Browser
 
@@ -193,37 +229,50 @@ lan_hosts.update({
 
 #### Freeplug API
 
+```ruby
+freeplug_networks = FreeboxApi::Resources::FreeplugNetwork.new(session)
+freeplugs = FreeboxApi::Resources::Freeplug.new(session)
+```
+
 ##### Get the current Freeplugs networks
-[ ] GET /api/v1/freeplug/
+[X] GET /api/v1/freeplug/
+
+```ruby
+freeplug_networks.index
+```
 
 ##### Get a particular Freeplug information
-[ ] GET /api/v1/freeplug/{id}/
+[X] GET /api/v1/freeplug/{id}/
+
+```ruby
+freeplugs.show('F4:CA:E5:1D:46:AE')
+```
 
 ##### Reset a Freeplug
-[ ] POST /api/v1/freeplug/{id}/reset/
+[X] POST /api/v1/freeplug/{id}/reset/
+
+```ruby
+freeplugs.reset('F4:CA:E5:1D:46:AE')
+```
 
 ### 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
+config.show('dhcp')
 ```
 
 ##### Update the current DHCP configuration
 [X] PUT /api/v1/dhcp/config/
 
 ```ruby
-dhcp.config = {
+config.update('dhcp', {
   :enabled => false,
-}
+})
 ```
 
 #### DHCP Static Lease API
@@ -278,20 +327,41 @@ static_lease.create({
 #### Ftp config API
 
 ##### Get the current Ftp configuration
-[ ] GET /api/v1/ftp/config/
+[X] GET /api/v1/ftp/config/
+
+```ruby
+config.show('ftp')
+```
 
 ##### Update the FTP configuration
-[ ] PUT /api/v1/ftp/config/
+[X] PUT /api/v1/ftp/config/
+
+```ruby
+config.update('ftp', {
+  :enabled => true
+})
+```
 
 ### NAT
 
 #### Dmz Config API
 
 ##### Get the current Dmz configuration
-[ ] GET /api/v1/fw/dmz/
+[X] GET /api/v1/fw/dmz/
+
+```ruby
+config.show('dmz')
+```
 
 ##### Update the current Dmz configuration
-[ ] PUT /api/v1/fw/dmz/
+[X] PUT /api/v1/fw/dmz/
+
+```ruby
+config.update('dmz', {
+  :enabled => true,
+  :ip      => '192.168.1.42',
+})
+```
 
 ### Port Forwarding
 
@@ -349,10 +419,20 @@ port_forwardings.destroy(3)
 #### UPnP IGD config API
 
 ##### Get the current UPnP IGD configuration
-[ ] GET /api/v1/upnpigd/config/
+[X] GET /api/v1/upnpigd/config/
+
+```ruby
+config.show('upnpigd')
+```
 
 ##### Update the UPnP IGD configuration
-[ ] PUT /api/v1/upnpigd/config/
+[X] PUT /api/v1/upnpigd/config/
+
+```ruby
+config.update('upnpigd', {
+  :enabled => true,
+})
+```
 
 #### UPnP IGD Redirection API
 
@@ -376,38 +456,78 @@ upnp_redir.destroy('0.0.0.0-53644-udp')
 #### LCD config API
 
 ##### Get the current LCD configuration
-[ ] GET /api/v1/lcd/config/
+[X] GET /api/v1/lcd/config/
+
+```ruby
+config.show('lcd')
+```
 
 ##### Update the lcd configuration
-[ ] PUT /api/v1/lcd/config/
+[X] PUT /api/v1/lcd/config/
+
+```ruby
+config.update('lcd', {
+  :brightness => 50,
+})
+```
 
 ### Network Share
 
 #### Samba config API
 
 ##### Get the current Samba configuration
-[ ] GET /api/v1/netshare/samba/
+[X] GET /api/v1/netshare/samba/
+
+```ruby
+config.show('samba')
+```
 
 ##### Update the Samba configuration
-[ ] PUT /api/v1/netshare/samba/
+[X] PUT /api/v1/netshare/samba/
+
+```ruby
+config.update('samba', {
+  :print_share_enabled => false,
+})
+```
 
 #### Afp config API
 
 ##### Get the current Afp configuration
-[ ] GET /api/v1/netshare/afp/
+[X] GET /api/v1/netshare/afp/
+
+```ruby
+config.show('afp')
+```
 
 ##### Update the Afp configuration
-[ ] PUT /api/v1/netshare/afp/
+[X] PUT /api/v1/netshare/afp/
+
+```ruby
+config.update('afp', {
+  :guest_allow => false,
+})
+```
 
 ### UPnP AV
 
 #### UPnP AV config API
 
 ##### Get the current UPnP AV configuration
-[ ] GET /api/v1/upnpav/config/
+[X] GET /api/v1/upnpav/config/
+
+```ruby
+config.show('upnpav')
+```
 
 ##### Update the UPnP AV configuration
-[ ] PUT /api/v1/upnpav/config/
+[X] PUT /api/v1/upnpav/config/
+
+```ruby
+config.update('upnpav', {
+  :enabled => false,
+})
+```
 
 ### Switch
 
@@ -435,10 +555,22 @@ upnp_redir.destroy('0.0.0.0-53644-udp')
 #### Wi-Fi config API
 
 ##### Get the current Wi-Fi configuration
-[ ] GET /api/v1/wifi/config/
+[X] GET /api/v1/wifi/config/
+
+```ruby
+config.show('wifi')
+```
 
 ##### Update the Wi-Fi configuration
-[ ] PUT /api/v1/wifi/config/
+[X] PUT /api/v1/wifi/config/
+
+```ruby
+config.update('wifi', {
+  :ap_params => {
+    :ht_mode => 'disabled',
+  }
+})
+```
 
 ##### Reset the Wi-Fi configuration
 [ ] POST /api/v1/wifi/config/reset/

data/freebox_api.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |gem|
   gem.name          = 'freebox_api'
   gem.require_paths = ["lib"]
   gem.version       = FreeboxApi::VERSION
+  gem.license       = 'Apache 2.0'
 
   gem.add_dependency 'json'
   gem.add_dependency 'rest-client', '>= 1.6.1'

data/lib/freebox_api.rb

@@ -1,10 +1,9 @@
 module FreeboxApi
 end
 
+require 'freebox_api/config'
 require 'freebox_api/freebox'
 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 }

data/lib/freebox_api/config.rb

@@ -0,0 +1,33 @@
+module FreeboxApi
+
+  class Config
+
+    def initialize(session)
+    end
+
+    def url(service)
+      case service
+      when 'ipv6'
+        '/connection/ipv6/config/'
+      when /^ddns\//
+        "/connection/#{service}/"
+      when 'dmz'
+        '/fw/dmz/'
+      when 'samba', 'afp'
+        '/netshare/samba/'
+      else
+        "/#{service}/config/"
+      end
+    end
+
+    def show(service)
+      @session.http_call('get', url)
+    end
+
+    def update(service, params = {})
+      @session.http_call('put', url, params)
+    end
+
+  end
+
+end

data/lib/freebox_api/resources/freeplug.rb

@@ -0,0 +1,29 @@
+module FreeboxApi
+
+  module Resources
+
+    class Freeplug
+
+      def initialize(session)
+        @session = session
+      end
+
+      def index
+        FreeplugNetwork.new(session).collect { |freeplug_network|
+          freeplug_network['members']
+	}.flatten
+      end
+
+      def show(id)
+        @session.http_call('get', "/freeplug/#{id}/")
+      end
+
+      def reset(id)
+        @session.http_call('post', "/freeplug/#{id}/reset/")
+      end
+
+    end
+
+  end
+
+end

data/lib/freebox_api/resources/freeplug_network.rb

@@ -0,0 +1,20 @@
+module FreeboxApi
+
+  module Resources
+
+    class FreeplugNetwork
+
+      def initialize(session)
+        @session = session
+      end
+
+      def index
+        @session.http_call('get', '/freeplug/')
+      end
+
+    end
+
+  end
+
+end
+

data/lib/freebox_api/version.rb

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

metadata

@@ -1,86 +1,110 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: freebox_api
-version: !ruby/object:Gem::Version
-  version: 0.1.0
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
 platform: ruby
-authors:
-- Mickaël Canévet
+authors: 
+- "Micka\xC3\xABl Can\xC3\xA9vet"
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-29 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-09-30 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rest-client
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 1.6.1
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rest-client
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 6
+        - 1
         version: 1.6.1
+  type: :runtime
+  version_requirements: *id002
 description: Helps you to use Freebox OS's API calls from your app
 email: mickael.canevet@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - LICENSE
 - README.md
 - freebox_api.gemspec
 - lib/freebox_api.rb
 - lib/freebox_api/application.rb
+- lib/freebox_api/config.rb
 - lib/freebox_api/freebox.rb
+- lib/freebox_api/resources/freeplug.rb
+- lib/freebox_api/resources/freeplug_network.rb
 - lib/freebox_api/resources/interface.rb
 - lib/freebox_api/resources/lan_host.rb
 - 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
-licenses: []
-metadata: {}
+licenses: 
+- Apache 2.0
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 2.1.5
+rubygems_version: 1.8.24
 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 |-
-    OTBiM2ZhNGVjYzZkMTEwZGVkOTc3NWMxNzQ0MmVkYWEzMmVhNmZmMQ==
-  data.tar.gz: !binary |-
-    M2EyZDUzMGQ2MTVjOTlkZGRiNzczZWRjMTFiMmJjNTRmODJkNjUzOA==
-SHA512:
-  metadata.gz: !binary |-
-    YjUwZTUyN2FmM2I4ZTJjNjI4M2IxOGU0YmFjNzNmZmY0NzIyM2U2YzA5NGJi
-    OWVmNTIzYmIwYTJhNGQ1ZjU0NmZhZTRiMTc1YjMyZWIwNjYwYzgwZDhlNzFl
-    MzkwMDA4NzcwZmZiZDQ2OGM2NTQ5MjFhMTBiZmE2MGVjZWU2Njc=
-  data.tar.gz: !binary |-
-    MWU1Mzk1ODc1MzA4ODMwZWYwOWViYjlmODViZWIxNGIyZTdhNzUyNDEwMDBj
-    ZDk5NDgzZDA5OGVmZmU4Y2NhZjE3NmU0ZGZkNTI5MTk1ZGYyMTQyYmMyYTgz
-    YmQ5NjMyMTk0ZGE5MjhmM2ZjY2FiMDQxZjM4NTJiYzVhOTY1MTA=

data/lib/freebox_api/services/connection.rb

@@ -1,27 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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