freebox_api 0.0.1

data/.gitignore

@@ -0,0 +1,2 @@
+freebox_api-*.gem
+*.swp

data/README.md

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

data/freebox_api.gemspec

@@ -0,0 +1,18 @@
+require File.expand_path('../lib/freebox_api/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Mickaël Canévet"]
+  gem.email         = 'mickael.canevet@gmail.com'
+  gem.description   = %q{Helps you to use Freebox OS's API calls from your app}
+  gem.summary       = %q{Ruby bindings for Freebox OS's rest API}
+  gem.homepage      = 'http://github.com/mcanevet/freebox_api'
+
+  gem.files         = `git ls-files`.split($\)
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'freebox_api'
+  gem.require_paths = ["lib"]
+  gem.version       = FreeboxApi::VERSION
+
+  gem.add_dependency 'json'
+  gem.add_dependency 'rest-client', '>= 1.6.1'
+end

data/lib/freebox_api/resources/interface.rb

@@ -0,0 +1,45 @@
+module FreeboxApi
+
+  module Resources
+
+    class Interface
+
+      attr_reader :name, :host_count
+
+      def initialize(name, host_count, freebox)
+        @name = name
+	@host_count = host_count
+	@freebox = freebox
+      end
+
+      def lan_hosts
+        JSON.parse(
+          RestClient.get(
+            "#{@freebox.base_url}/api/v1/lan/browser/#{@name}",
+            :'X_Fbx_App_Auth' => @freebox.session_token
+          )
+	)['result'].collect { |lan_host|
+          FreeboxApi::Resources::LanHost.new(
+            lan_host['id'],
+            lan_host['primary_name'],
+            lan_host['host_type'],
+            lan_host['primary_name_manual'],
+            lan_host['l2ident'],
+            lan_host['vendor_name '],
+            lan_host['persistent'],
+            lan_host['reachable'],
+            lan_host['last_time_reachable'],
+            lan_host['active'],
+            lan_host['last_activity'],
+            lan_host['names'],
+            lan_host['l3connectivities'],
+            self,
+            @freebox)
+	}
+      end
+
+    end
+
+  end
+
+end

data/lib/freebox_api/resources/lan_host.rb

@@ -0,0 +1,38 @@
+module FreeboxApi
+
+  module Resources
+
+    class LanHost
+
+      attr_reader :id, :primary_name, :host_type, :primary_name_manual, :l2ident, :vendor_name, :persistent, :reachable, :last_time_reachable, :active, :last_activity, :names, :l3connectivities, :interface
+
+      def initialize(id, primary_name, host_type, primary_name_manual, l2ident, vendor_name, persistent, reachable, last_time_reachable, active, last_activity, names, l3connectivities, interface, freebox)
+        @id = id
+	@primary_name = primary_name
+	@host_type = host_type
+	@primary_name_manual = primary_name_manual
+        @l2ident = l2ident
+        @vendor_name = vendor_name
+        @persistent = persistent
+        @reachable = reachable
+        @last_time_reachable = last_time_reachable
+        @active = active
+        @last_activity = last_activity
+        @names = names
+        @l3connectivities = l3connectivities
+        @interface = interface
+        @freebox = freebox
+      end
+
+      def static_leases
+        @freebox.static_leases.select { |static_lease|
+          static_lease.host == self
+        }
+      end
+
+    end
+    
+  end
+
+end
+

data/lib/freebox_api/resources/redir.rb

@@ -0,0 +1,27 @@
+module FreeboxApi
+
+  module Resources
+
+    class Redir
+
+      attr_reader :id, :enabled, :ip_proto, :wan_port_start, :wan_port_end, :lan_ip, :lan_port, :hostname, :host, :comment
+
+      def initialize(id, enabled, ip_proto, wan_port_start, wan_port_end, lan_ip, lan_port, hostname, host, comment, freebox)
+        @id = id
+        @enabled = enabled
+        @ip_proto = ip_proto
+        @wan_port_start = wan_port_start
+        @wan_port_end = wan_port_end
+        @lan_ip = lan_ip
+        @lan_port = lan_port
+        @hostname = hostname
+        @host = host
+        @comment = comment
+        @freebox = freebox
+      end
+
+    end
+
+  end
+
+end

data/lib/freebox_api/resources/static_lease.rb

@@ -0,0 +1,22 @@
+module FreeboxApi
+
+  module Resources
+
+    class StaticLease
+
+      attr_reader :id, :mac, :comment, :hostname, :ip, :host
+
+      def initialize(id, mac, comment, hostname, ip, host, freebox)
+        @id = id
+        @mac = mac
+        @hostname = hostname
+        @ip = ip
+        @host = host
+        @freebox = freebox
+      end
+
+    end
+
+  end
+
+end

data/lib/freebox_api/version.rb

@@ -0,0 +1,3 @@
+module FreeboxApi
+  VERSION = "0.0.1"
+end

data/lib/freebox_api.rb

@@ -0,0 +1,120 @@
+require 'rest_client'
+require 'json'
+
+module FreeboxApi
+
+  class Freebox
+
+    attr_reader :app_token, :app_id, :app_name, :app_version, :device_name, :base_url
+
+    def initialize(app_token, app_id, app_name, app_version, device_name, base_url = 'http://mafreebox.free.fr')
+      @app_id = app_id
+      @app_name = app_name
+      @app_version = app_version
+      @device_name = device_name
+      @app_token = app_token
+      @base_url = base_url
+    end
+
+    def self.app_token(app_id, app_name, app_version, device_name)
+      JSON.parse(RestClient.post(
+        "#{@base_url}/api/v1/login/authorize",
+        {
+          :app_id      => app_id,
+          :app_name    => app_name,
+          :app_version => app_version,
+          :device_name => device_name,
+        }.to_json,
+        :content_type => :json,
+        :accept => :json
+      ))['result']['app_token']
+    end
+
+    def challenge
+      JSON.parse(RestClient.get("#{@base_url}/api/v1/login/"))['result']['challenge']
+    end
+
+    def password
+      Digest::HMAC.hexdigest(challenge, @app_token, Digest::SHA1)
+    end
+
+    def session_token
+      JSON.parse(
+        RestClient.post(
+          "#{@base_url}/api/v1/login/session/",
+          {
+            :app_id   => @app_id,
+            :password => password,
+          }.to_json,
+          :content_type => :json,
+          :accept => :json
+        )
+      )['result']['session_token']
+    end
+
+    def interfaces
+      JSON.parse(
+        RestClient.get(
+          "#{@base_url}/api/v1/lan/browser/interfaces",
+          :'X_Fbx_App_Auth' => session_token
+        )
+      )['result'].collect { |interface|
+        FreeboxApi::Resources::Interface.new(interface['name'], interface['host_count'], self)
+      }
+    end
+
+    def lan_hosts
+      interfaces.collect { |interface|
+        interface.lan_hosts
+      }.flatten
+    end
+
+    def static_leases
+      JSON.parse(
+        RestClient.get(
+          "#{@base_url}/api/v1/dhcp/static_lease/",
+          :'X_Fbx_App_Auth' => session_token
+        )
+      )['result'].collect { |static_lease|
+        FreeboxApi::Resources::StaticLease.new(
+          static_lease['id'],
+          static_lease['mac'],
+          static_lease['comment'],
+          static_lease['hostname'],
+          static_lease['ip'],
+          lan_hosts.select { |lan_host| lan_host.id == static_lease['host']['id'] },
+          self
+        )
+      }
+    end
+
+    def redirs
+      JSON.parse(
+        RestClient.get(
+          "#{@base_url}/api/v1/fw/redir/",
+          :'X_Fbx_App_Auth' => session_token
+        )
+      )['result'].collect { |redir|
+        FreeboxApi::Resources::Redir.new(
+          redir['id'],
+          redir['enabled'],
+          redir['ip_proto'],
+          redir['wan_port_start'],
+          redir['wan_port_end'],
+          redir['lan_ip'],
+          redir['lan_port'],
+          redir['hostname'],
+          lan_hosts.select { |lan_host| lan_host.id == redir['host']['id'] },
+          redir['comment'],
+          self
+        )
+      }
+    end
+
+  end
+
+end
+
+require 'freebox_api/version'
+resource_files = Dir[File.expand_path("#{File.dirname(__FILE__)}/freebox_api/resources/*.rb", __FILE__)]
+resource_files.each { |f| require f }

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: freebox_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Mickaël Canévet
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+description: Helps you to use Freebox OS's API calls from your app
+email: mickael.canevet@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- README.md
+- freebox_api.gemspec
+- lib/freebox_api.rb
+- lib/freebox_api/resources/interface.rb
+- lib/freebox_api/resources/lan_host.rb
+- lib/freebox_api/resources/redir.rb
+- lib/freebox_api/resources/static_lease.rb
+- lib/freebox_api/version.rb
+homepage: http://github.com/mcanevet/freebox_api
+licenses: []
+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: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Ruby bindings for Freebox OS's rest API
+test_files: []