gandi 1.0.0 → 2.0.0

data/README

@@ -1,31 +1,34 @@
+DOCUMENTATION
+=============
+
+See https://rpc.ote.gandi.net/doc/2.0/
+
+API endpoint:
+
+* Test: https://rpc.ote.gandi.net/xmlrpc/
+* Production: https://rpc.gandi.net/xmlrpc/
+
+Feel free to fork it and fix it you need to.
+
 USAGE
 =====
 
 require 'gandi'
-session = Gandi::Session.connect(:login => "FO1234-GANDI", :password => "foobar")
-
-session.password("new_password")
-session.domain_list
-session.account_balance
-
-domain  = "example.org"
-period  = 1
-owner_handle    = "AA1234-GANDI"
-admin_handle    = "BB2345-GANDI"
-tech_handle     = "CC3456-GANDI"
-billing_handle  = "DD4567-GANDI"
-ns_list  = ["ns1.example.net", "ns2.example.net", "ns1.example.com"]
-
-operation = session.domain_create( domain, period,
-                                   owner_handle, admin_handle,
-                                   tech_handle, billing_handle,
-                                   ns_list)
-
-session.operation_list :state => "PENDING"
-
-TODO
-====
-Tests
-Gem release
-Argument checking for all Gandi methods
-Documentation
+
+# test env
+api = Gandi::Session.new("24-character API key", "https://rpc.ote.gandi.net/xmlrpc/")
+
+api.domain.list
+api.domain.info('mydomain.com')
+api.hosting.list
+api.catalog.list(product: {type: 'domains'})
+...
+
+
+# production env
+api = Gandi::Session.new("24-character API key")
+api.domain.list
+api.domain.info('mydomain.com')
+api.hosting.list
+api.catalog.list(product: {type: 'domains'})
+...

data/lib/gandi.rb

@@ -3,22 +3,11 @@
 $:.unshift(File.dirname(__FILE__)) unless
   $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
+require 'hashie'
 require 'xmlrpc/client'
 require 'gandi/session'
 require 'gandi/errors'
 
-# Gandi/Ruby Library
-#
-# Author::    Jérôme Lipowicz (mailto:jerome@yayel.com)
-# License::   MIT License
-
-class Array
-  # from ActiveSupport::CoreExtensions::Array::ExtractOptions
-  def extract_options!
-    last.is_a?(::Hash) ? pop : {}
-  end
-end
-
 module Gandi
-  VERSION = '1.0.0'
+  VERSION = '2.0.0'
 end

data/lib/gandi/session.rb

@@ -1,48 +1,161 @@
 module Gandi
-  
-  class Session
-    HOST = "https://api.gandi.net/xmlrpc/"
-    
-    attr_reader :handler, :session_id
+  VALID_METHODS = %w(
+  catalog.list
+  contact.balance
+  contact.can_associate
+  contact.can_associate_domain
+  contact.create
+  contact.info
+  contact.list
+  contact.update
+  datacenter.list
+  domain.available
+  domain.contacts.set
+  domain.count
+  domain.create
+  domain.forward.count
+  domain.forward.create
+  domain.forward.delete
+  domain.forward.list
+  domain.forward.update
+  domain.host.count
+  domain.host.create
+  domain.host.delete
+  domain.host.info
+  domain.host.list
+  domain.host.update
+  domain.info
+  domain.list
+  domain.mailbox.alias.set
+  domain.mailbox.count
+  domain.mailbox.create
+  domain.mailbox.delete
+  domain.mailbox.info
+  domain.mailbox.list
+  domain.mailbox.purge
+  domain.mailbox.responder.activate
+  domain.mailbox.responder.deactivate
+  domain.mailbox.update
+  domain.nameservers.set
+  domain.packmail.autorenew
+  domain.packmail.create
+  domain.packmail.delete
+  domain.packmail.info
+  domain.packmail.renew
+  domain.packmail.update
+  domain.renew
+  domain.status.lock
+  domain.status.unlock
+  domain.tld.list
+  domain.tld.region
+  domain.transferin.proceed
+  domain.webredir.count
+  domain.webredir.create
+  domain.webredir.delete
+  domain.webredir.list
+  domain.webredir.update
+  domain.zone.clone
+  domain.zone.count
+  domain.zone.create
+  domain.zone.delete
+  domain.zone.info
+  domain.zone.list
+  domain.zone.record.add
+  domain.zone.record.count
+  domain.zone.record.delete
+  domain.zone.record.list
+  domain.zone.record.set
+  domain.zone.set
+  domain.zone.update
+  domain.zone.version.delete
+  domain.zone.version.new
+  domain.zone.version.set
+  hosting.datacenter.list
+  hosting.disk.count
+  hosting.disk.create
+  hosting.disk.create_from
+  hosting.disk.delete
+  hosting.disk.info
+  hosting.disk.list
+  hosting.disk.list_kernels
+  hosting.disk.list_options
+  hosting.disk.rollback_from
+  hosting.disk.update
+  hosting.iface.count
+  hosting.iface.create
+  hosting.iface.delete
+  hosting.iface.info
+  hosting.iface.ip_attach
+  hosting.iface.ip_detach
+  hosting.iface.list
+  hosting.iface.update
+  hosting.image.info
+  hosting.image.list
+  hosting.ip.count
+  hosting.ip.create
+  hosting.ip.delete
+  hosting.ip.info
+  hosting.ip.list
+  hosting.ip.update
+  hosting.vm.count
+  hosting.vm.create
+  hosting.vm.create_from
+  hosting.vm.delete
+  hosting.vm.disk_attach
+  hosting.vm.disk_detach
+  hosting.vm.disk_rollback
+  hosting.vm.iface_attach
+  hosting.vm.iface_detach
+  hosting.vm.info
+  hosting.vm.list
+  hosting.vm.reboot
+  hosting.vm.start
+  hosting.vm.stop
+  hosting.vm.update
+  operation.count
+  operation.info
+  operation.list
+  )
 
-    def initialize(login, password, host, safe_mode = true)
-      @login     = login
-      @password  = password
-      @host      = host
-      @safe_mode = safe_mode
-    end
-    
-    def connect
-      @handler    = XMLRPC::Client.new2(@host)
-      @session_id = call("login", @login, @password, @safe_mode)
-    end
-    alias login connect
-    
-    def call(*args)
-      raise LoadError, "no connexion handler is set." unless @handler.is_a?(XMLRPC::Client)
-      @handler.call(*args)
-    rescue XMLRPC::FaultException => exception
-      raise ( exception.faultCode < 500000 ? Gandi::ServerError : Gandi::DataError ), exception.faultString
+  class ProxyCall
+    attr_accessor :server, :api_key, :chained
+
+    def initialize(server, api_key)
+      self.server = server
+      self.api_key = api_key
+      self.chained = []
+      self
     end
-    
+
     def method_missing(method, *args)
-      if %w(password account_currency account_balance domain_list domain_available domain_lock domain_unlock domain_info domain_renew domain_create domain_restore domain_del domain_transfer_in_available domain_transfer_in domain_transfer_out domain_trade domain_change_owner domain_change_contact domain_ns_list domain_ns_add domain_ns_del domain_ns_set host_list host_info host_create host_delete domain_gandimail_activate domain_gandimail_deactivate domain_forward_list domain_forward_set domain_forward_delete domain_mailbox_list domain_mailbox_info domain_mailbox_add domain_mailbox_update domain_mailbox_delete domain_mailbox_alias_list domain_mailbox_alias_set domain_mailbox_purge domain_web_redir_list domain_web_redir_add domain_web_redir_del contact_create contact_update contact_del contact_info operation_list operation_details operation_relaunch operation_cancel tld_list).include?(method.to_s)
-        call(method, @session_id, *args)
+      self.chained << method
+      method_name = chained.join(".")
+      if Gandi::VALID_METHODS.include?(method_name)
+        # puts "CALL: #{method_name} - #{api_key} - #{args.inspect}"
+        res = self.server.call(method_name, api_key, *args)
+        if res.is_a?(Array)
+          res.collect! { |x| x.is_a?(Hash) ? Hashie::Mash.new(x) : x }
+        else
+          Hashie::Mash.new(res)
+        end
       else
-        raise NoMethodError, "method #{method} is not available in the GANDI API."
+        self
       end
     end
-    
-    # Accepted arguments are:
-    # :host, :login, :password and :safe_mode (defaults to true)
-    def self.connect(*args)
-      config = { :host => HOST, :safe_mode => true }.merge(args.extract_options!)
-      unless config[:login] && config[:password]
-        raise ArgumentError, "login and password needed"
-      end
-      client = self.new(config[:login], config[:password], config[:host], config[:safe_mode])
-      client.connect
-      return client
+  end
+
+  class Session
+    attr_reader :api_key
+
+    def initialize(api_key, endpoint = "https://rpc.gandi.net/xmlrpc/")
+      @api_key  = api_key
+      @server = XMLRPC::Client.new2(endpoint)
+    end
+
+    def method_missing(method, *args)
+      ProxyCall.new(@server, self.api_key).send(method, *args)
+    rescue XMLRPC::FaultException => exception
+      raise(exception.faultCode < 500000 ? Gandi::ServerError : Gandi::DataError, exception.faultString)
     end
   end
-end
+end

metadata

@@ -1,70 +1,59 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gandi
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 2.0.0
   prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
 platform: ruby
-authors: []
-
+authors:
+- Olivier Ruffin
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-26 00:00:00 +01:00
-default_executable: 
-dependencies: []
-
+date: 2012-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70111286048400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70111286048400
 description: Wrapper around gandi xml-rpc API
 email: 
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README
 - lib/gandi/errors.rb
 - lib/gandi/session.rb
 - lib/gandi.rb
-has_rdoc: true
 homepage: https://github.com/veilleperso/gandi
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.5.2
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Gandi XML RPC API
+summary: Gandi XML RPC API v2.0
 test_files: []
-