ovh_savoni 1.36.0

data/LICENSE

@@ -0,0 +1,167 @@
+Copyright (C) 2012 Thibault Poncelet <thibaultponcelet@gmail.com>
+
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,113 @@
+ovh_savoni
+===
+OVH SoAPI wrapper.
+
+Super easy access to the OVH Soap API for Ruby >1.9, with extra support for SMS handling.
+
+Please refer to http://www.ovh.com/soapi/en/ for the API definition.
+
+##Install
+
+Install it on your system:
+
+        gem install ovh_savoni
+
+Or add it to your Gemfile:
+
+        gem 'ovh_savoni', 'x.x.x'
+
+
+### Version
+
+
+Be carefull that methods will change with versions to follow the updates done by OVH in their WSDL file.
+Version number of this gem match the WSDL version of OVH (see the changelog here: http://www.ovh.com/soapi/fr/changelog.xml).
+An additional version number will be added if required by the gem.
+
+## Example
+
+
+### SMS sending
+
+
+        require "ovh_savoni"
+        savoni = OvhSavoni::SoAPI.new :sms_user=>"*****",:sms_password=>"*****",:sms_account=>"*****"
+
+        puts savoni.telephony_sms_user_credit_left
+        puts savoni.telephony_sms_user_multi_send("+320000000",["+321111111","+32111111"],"SMS content")
+
+This will display the credit left, send a SMS to two recipients using a sms user from OVH and display the returned ids.
+
+### Domain info
+
+
+        require "ovh_savoni"
+
+        savoni = OvhSavoni::SoAPI.new(:nichandle=>"******",:password=>"******")
+        result = savoni.domain_info("example.com")
+
+'result' is now a Struct with accessors for all response elements defined by OVH. In this case:
+  - dns
+  - nicbilling
+  - nicadmin
+  - domain
+  - modification
+  - expiration
+  - nicowner
+  - authinfo
+  - creation
+
+## Usage
+
+### Connection establishment
+
+
+  For actions with authentications:
+
+        savoni = OvhSavoni::SoAPI.new(:nickhandle=>"******",:password=>"******")
+
+  For SMS user:
+
+        savoni = OvhSavoni::SoAPI.new(:sms_user=>"*****",:sms_password=>"*****",:sms_account=>"*****")
+
+  Both can be specified if needed to have always full access:
+
+        savoni = OvhSavoni::SoAPI.new(:nickhandle=>"******",:password=>"password", :sms_user=>"*****",:sms_password=>"*****",:sms_account=>"*****")
+
+  In case you do not want the gem to handle the authentification for you just create a new instance without parameters:
+  (This mean that you will have to perfom a login call explicitely and pass the result with each action that requires authentication.)
+
+        savoni = OvhSavoni::SoAPI.new
+
+
+### API access
+
+
+  OvhSavoni::SoAPI instances define one method for each SOAP action defined by OVH
+  parameters have to be passed in the same order than the one defined at http://www.ovh.com/soapi/en/ (optional parameters can be omited)
+        savoni.action_name(arg1,arg2,arg3)
+
+  The *session* parameter must be skipped when the SoAPI instance has been initialized with the *nichandle* and *passowrd* parameters
+
+  The *sms_account*, *sms_user*, *sms_password* parameters for sms users methods must also be skipped when setted at initialization.
+
+  N.B. The actions are to be in snake case in order to follow Ruby conventions.
+
+  Results are sub-classes of Struct mapped on the returned XML for comppound values and basic values for simple return values such as String, Dates,etc
+
+## Contributions
+
+If you want to contribute, please open an issue or:
+
+  * Fork the project.
+  * Make your feature addition or bug fix.
+  * Send a pull request on Github with a clear description.
+
+## TODO
+
+  * Tests
+  * Check methods arity
+
+## Copyright
+
+Copyright 2011-2012 Thibault Poncelet - See LICENCE for details.

data/Rakefile

@@ -0,0 +1,5 @@
+desc "Run tests"
+task :default => :spec
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')

data/lib/ovh_savoni/error.rb

@@ -0,0 +1,2 @@
+class OvhSavoni::Error < StandardError
+end

data/lib/ovh_savoni/response_builder.rb

@@ -0,0 +1,46 @@
+class OvhSavoni::ResponseBuilder
+  
+  # Build a Response class
+  def self.build(r,action)
+    if r.is_a?(Hash) # Build the class from the hash
+      const = "OvhSavoniResponse_#{action}"
+      klass=nil
+      if Struct.const_defined?(const) 
+        klass=Struct.const_get(const) 
+      else # Create a new struct if not exist already
+        klass=Struct.new(const,*r.keys)
+        build_class(klass,action)
+      end
+      ret = klass.new(*r.values) # Instanciate the class
+      if ret.members.include?(:item) && [:item].is_a?(Array)
+        ret.item
+      else
+        ret
+      end
+    else # Return the value in case of basic type
+      r
+    end
+  end
+  
+  # Add recursive construction behavior to the class initializer
+  def self.build_class(klass,action)
+    klass.class_eval do 
+      define_method(:initialize) do |*args|
+        super(*args)
+        each do |inst|
+          each_pair do |k,v|
+            if v.is_a?(Hash)
+              self[k]=OvhSavoni::ResponseBuilder.build(v,"#{action}__#{k}")
+              # replace response_info.item[] by response_info[]
+              if self[k].respond_to?(:item) && self[k].item.is_a?(Array)
+                self[k]=self[k].item
+              end
+            elsif v.is_a?(Array)
+              self[k].map!{|i| OvhSavoni::ResponseBuilder.build(i,"#{action}__#{k}")}
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ovh_savoni/soapi.rb

@@ -0,0 +1,91 @@
+class OvhSavoni::SoAPI
+  # Init Class
+  class << self
+    attr_reader :soap
+  end
+  # Initialize soap connection
+  @soap = Savon::Client.new do
+    wsdl.document =File.expand_path("../../soapi-dlw-1.36.wsdl" , __FILE__)
+  end
+  # Initialize the class structure on the basis of the WSDL file
+  # Meta definition of one method for each action
+  # Return value is the values in return[:#{action}_response][:return]
+  @soap.wsdl.soap_actions.each do |action|
+    arg_names = @soap.wsdl.type_namespaces.find_all do |i|
+      i[0][0]==@soap.wsdl.soap_input(action)
+    end.map{|j| j[0][1]}.compact
+
+    define_method(action) do |*arg_values|
+      begin
+        r = request(action,arg_names,arg_values)["#{action}_response".to_sym][:return]
+      rescue Savon::SOAP::Fault => e
+        raise OvhSavoni::Error.new(e.message)
+      end
+      OvhSavoni::ResponseBuilder.build(r,action)
+    end
+  end
+
+  # Create a new instance and connect to OVH if nic and pwd provided
+  def initialize(logins={}, lang=:en)
+    @nichandle = logins[:nichandle]
+    @password = logins[:password]
+    @sms_account = logins[:sms_account]
+    @sms_user = logins[:sms_user]
+    @sms_password= logins[:sms_password]
+    #Connect if login infos provided
+    if @nichandle && @password
+      @session = self.login(@nichandle,@password,lang.to_s)
+    end
+    @session
+  end
+
+  private
+  # Handle generic requests
+  def request(method, arg_names, arg_values)
+    structured_args = set_default_args(method,arg_names)
+    preset_args = structured_args.keys
+    custom_args = arg_names[preset_args.size-1..-1]
+    custom_args.each_index do |i|
+      key = custom_args[i].snakecase.to_sym
+      structured_args[key] = arg_values[i]
+      if structured_args[key].is_a?(Array)
+        set_array_arg(structured_args,key,custom_args[i],arg_values[i])
+      end
+    end
+    self.class.soap.request(method) do
+      soap.namespaces["xmlns:soapenc"]="http://schemas.xmlsoap.org/soap/encoding/"
+      http.headers["SOAPAction"] = ""
+      soap.body = structured_args
+    end.body
+  end
+
+  # Add xml attributes for array arguments
+  def set_array_arg(structured_args,key,original_key,value)
+    structured_args[:attributes!] ||= {}
+    # ins0 to workaround savon bug
+    structured_args[:attributes!]["ins0:#{original_key}"]=
+      { "soapenc:arrayType"=>"xsd:#{structured_args[key].first.class.name.downcase}[]" }
+    structured_args[key]={:item=>value}
+  end
+
+  # Set default args with ones defined at initialization
+  def set_default_args(method,arg_names)
+    default_args={}
+    if arg_names.include?("session") && !@session.nil?
+      default_args[:session] = @session
+    end
+    if arg_names.include?("smsAccount") && !@sms_account.nil?
+      default_args[:smsAccount] = @sms_account
+    end
+    if method.to_s.match(/sms_user/i)
+      if arg_names.include?("login") && !@sms_user.nil?
+        default_args[:login] = @sms_user
+      end
+      if arg_names.include?("password") && !@sms_password.nil?
+        default_args[:password] = @sms_password
+      end
+    end
+    default_args[:order!]=arg_names.dup # Dup to avoid savon changing args
+    default_args
+  end
+end

data/lib/ovh_savoni/version.rb

@@ -0,0 +1,3 @@
+module OvhSavoni
+  VERSION = "1.36.0"
+end

data/lib/ovh_savoni.rb

@@ -0,0 +1,16 @@
+# Load the gem files in the system
+require "savon"
+
+# Configure savon
+HTTPI.log = false
+Nori.parser = :nokogiri
+Savon.configure do |config|
+  config.log = false
+end
+
+module OvhSavoni
+end
+
+require_relative "./ovh_savoni/error.rb"
+require_relative "./ovh_savoni/response_builder.rb"
+require_relative "./ovh_savoni/soapi.rb"