gandi 2.0.10 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e13cbe3aa5c136bd5fc041ca5016d9872a04c79
-  data.tar.gz: f5b25a4c2800533f2c1fd5a7e7730080f77a4a05
+  metadata.gz: a5b019af545582d4c85c903050bee4b255b3c859
+  data.tar.gz: 424f6f7f25648c730a5f3f7e559f3a2059e44509
 SHA512:
-  metadata.gz: 8942298a657171d06b7682353bf6c81e461ac9b66c16e5a4cf67551eeb842136b8d8b8aa2e18b256d0752646ace28d5ac4a3f27da5c1f11b2b9e264dbcd8b420
-  data.tar.gz: a1676ba4a082e1c1577ecc8ad88e455c5cbdd72b54abd1dcc54ff0d85fd5197d5f3073726a67d616d331bdae15c55b8ba95ff2070800f2948e7a2c94bb3d11ca
+  metadata.gz: 76b8fb3d9cf6ae1d1fcc5074e70d0ad90598f9fdac2ba3f91e2a21577c50067df99b37824c684b39bb0b70d2d389bde8926abee3e43ce9f11aaf1ed9fdd8c750
+  data.tar.gz: 5383179b5e9d0704fb4a85249ef6b4780c42aba15e15a59132a403450e2fae1a08ecd296e098e0293eb67e27cbf5757ec6fe08a66668ce9d7950b7d54f467b72

data/README.md

@@ -0,0 +1,61 @@
+# Gandi
+
+This is a Ruby interface to the [Gandi](http://gandi.net) XML-RPC API.
+
+## Installation
+
+Add to your `Gemfile`:
+
+```ruby
+gem 'gandi'
+```
+
+Then `bundle install`.
+
+Otherwise
+
+```bash
+gem install gandi
+```
+
+## Basic Usage
+
+Every call to the Gandi API is authenticated so sessions are required to have a unique API key. If you don’t have it already, you can retrieve your API key from your Gandi account page.
+
+```ruby
+require 'gandi'
+
+api = Gandi::Session.new("24-character API key") # Endpoint: https://rpc.gandi.net/xmlrpc/
+
+api.domain.list
+api.domain.info('mydomain.com')
+api.catalog.list(product: {type: 'domains'})
+...
+api.domain.zone.clone_zone('zone_id') # instead of api.domain.zone.clone
+api.domain.zone.version.new_version('zone_id') # instead of domain.zone.version.new
+...
+```
+
+### Operational Test and Evaluation (OT&E) Endpoint
+
+Alongside the production API, Gandi provides an Operational Test and Evaluation (OT&E) system.
+
+```ruby
+require 'gandi'
+
+api = Gandi::Session.new("24-character API key", env: :test)
+
+api.domain.list
+...
+```
+
+For further information see the Gandi API documention at http://doc.rpc.gandi.net/
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+

data/lib/gandi.rb

@@ -1,7 +1,5 @@
-# Add the directory containing this file to the start of the load path if it
-# isn't there already.
-$:.unshift(File.dirname(__FILE__)) unless
-  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+# Add the directory containing this file to the start of the load path if it isn't there already.
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
 
 require 'hashie'
 require 'xmlrpc/client'
@@ -9,19 +7,23 @@ require 'gandi/session'
 require 'gandi/errors'
 
 module Gandi
-  VERSION = '2.0.5'
-  
+  VERSION = '2.1.0'
+
+  ENDPOINT = {
+    test: 'https://rpc.ote.gandi.net/xmlrpc/',
+    production: 'https://rpc.gandi.net/xmlrpc/',
+  }
+
   def self.silence_warnings
     old_verbose, $VERBOSE = $VERBOSE, nil
     yield
   ensure
     $VERBOSE = old_verbose
   end
-  
+
   silence_warnings do
     # gandi sometimes return <nil/> values so let's accept them to prevent exceptions
     XMLRPC::Config::ENABLE_NIL_PARSER = true
     XMLRPC::Config::ENABLE_NIL_CREATE = true
   end
-
 end

data/lib/gandi/session.rb

@@ -74,7 +74,6 @@ module Gandi
   domain.webredir.list
   domain.webredir.update
   domain.zone.clone
-  domain.zone.clone_zone
   domain.zone.count
   domain.zone.create
   domain.zone.delete
@@ -91,7 +90,6 @@ module Gandi
   domain.zone.version.count
   domain.zone.version.delete
   domain.zone.version.new
-  domain.zone.version.new_version
   domain.zone.version.set
   domain.zone.version.list
   hosting.datacenter.list
@@ -164,6 +162,7 @@ module Gandi
   operation.info
   operation.list
   operation.relaunch
+  version.info
   )
 
   class ProxyCall
@@ -176,12 +175,12 @@ module Gandi
       self
     end
 
+    undef_method :clone
+
     def method_missing(method, *args)
       self.chained << method
       method_name = chained.join(".")
       if Gandi::VALID_METHODS.include?(method_name)
-        method_name.sub!('clone_zone','clone')
-        method_name.sub!('new_version','new')
         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 }
@@ -199,18 +198,32 @@ module Gandi
   class Session
     attr_reader :api_key
 
-    def initialize(api_key, endpoint = "https://rpc.gandi.net/xmlrpc/")
+    def initialize(api_key, options = {})
+      endpoint = options.is_a?(Hash) ? (ENDPOINT[options[:env]] || ENDPOINT[:production]) : options
+
       @api_key  = api_key
       @server = XMLRPC::Client.new2(endpoint)
       # fix a bug in ruby 2.0, http://bugs.ruby-lang.org/issues/8182
-      @server.http_header_extra = {"accept-encoding" => "identity"}
+      @server.http_header_extra = { "accept-encoding" => "identity" }
       @server
     end
 
+    def list_methods
+      server.call('system.listMethods')
+    end
+
+    def method_signature(name)
+      server.call('system.methodSignature', name)
+    end
+
+    def method_help(name)
+      server.call('system.methodHelp', name)
+    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)
+      raise(exception.faultCode < 500_000 ? Gandi::ServerError : Gandi::DataError, exception.faultString)
     end
   end
 end

metadata

@@ -1,27 +1,27 @@
 --- !ruby/object:Gem::Specification
 name: gandi
 version: !ruby/object:Gem::Version
-  version: 2.0.10
+  version: 2.1.0
 platform: ruby
 authors:
 - Olivier Ruffin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-22 00:00:00.000000000 Z
+date: 2014-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
   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'
 description: Wrapper around gandi xml-rpc API v3
@@ -30,12 +30,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README
+- README.md
+- lib/gandi.rb
 - lib/gandi/errors.rb
 - lib/gandi/session.rb
-- lib/gandi.rb
 homepage: https://github.com/veilleperso/gandi
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -43,17 +44,17 @@ 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'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Gandi XML RPC API v3

data/README

@@ -1,37 +0,0 @@
-DOCUMENTATION
-=============
-
-See http://doc.rpc.gandi.net/
-
-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'
-
-# test env
-api = Gandi::Session.new("24-character API key", "https://rpc.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'})
-...
-api.domain.zone.clone_zone('zone_id') # instead of api.domain.zone.clone
-api.domain.zone.version.new_version('zone_id') # instead of domain.zone.version.new
-...