cloudflare 1.0.0 → 1.1.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Marcin "B4k3r" Prokop
+Copyright (c) 2012-2013 Marcin "B4k3r" Prokop
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -1,13 +1,25 @@
+NOTICE
+======
+
+In version v1.1.0 I renamed some functions in Client API.
+
+-	threat_score -> ip_lkup
+-	set_cache_lvl -> cache_lvl
+-	set_security_lvl -> sec_lvl
+- 	purge_cache -> fpurge_ts
+-	update_image -> zone_grab
+
+
 CloudFlare
 ==========
 
 It is a Ruby wrapper for the CloudFlare API.
 
-Official home page is [here](http://b4k3r.github.com/cloudflare). The complete [RDoc](http://rdoc.info/github/B4k3r/cloudflare/) is online.
+Official home page is [here](https://github.com/B4k3r/cloudflare). The complete [RDoc](http://rdoc.info/github/B4k3r/cloudflare/) is online.
 
 Visit also a CloudFlare API documentation:
 
--    [Client](http://www.cloudflare.com/wiki/Client_Interface_API)
+-    [Client](http://www.cloudflare.com/docs/client-api.html)
 -    [Host](http://www.cloudflare.com/docs/host-api.html)
 
 Installation
@@ -35,9 +47,9 @@ cf = CloudFlare.new('user_api_key', 'user_email')
 output = cf.add_rec('domain.com', 'A', '212.11.6.211', 'subdomain.domain.com', true)
 
 if output['result'] == 'success'
-  puts 'Successfuly added DNS record'
+  	puts 'Successfuly added DNS record'
 else
-  puts output['msg'] // error message
+	puts output['msg'] # error message
 end
 ```
 
@@ -47,20 +59,20 @@ end
 require 'cloudflare'
 
 cf = CloudFlare.new('host_api_key')
-output = cf.create_user('new_user_email', 'new_password', 'new_username (optional)', 'unique id (optional)')
+output = cf.create_user('john@example.com', 'secret', 'john')
 
 if output['result'] == 'success'
-  puts output['msg']
-  puts "Your login is #{output['response']['cloudflare_username']}"
+  	puts output['msg']
+  	puts "Your login is #{output['response']['cloudflare_username']}" # => john
 else
-  puts output['msg'] // error message
+  	puts output['msg'] # error message
 end
 ```
 
 License
 -------
 
-Copyright © 2012. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
+Copyright © 2012 - 2013. It is free software, and may be redistributed under the terms specified in the MIT-LICENSE file.
 
 
 

data/lib/cloudflare.rb

@@ -4,323 +4,512 @@ require 'json'
 # All public functions return (Hash) result: success or error with message and error code
 #
 # For more information please visit:
-# - http://www.cloudflare.com/wiki/Client_Interface_API
+# - http://www.cloudflare.com/docs/client-api.html
 # - http://www.cloudflare.com/docs/host-api.html
+#
 
 class CloudFlare
 
-  # URL for Client and Host API
-
-  URL_API = {
-    client: 'https://www.cloudflare.com/api_json.html',
-    host: 'https://api.cloudflare.com/host-gw.html'
-  }
-
-  TIMEOUT = 5 # Default is 5 seconds
-
-  # @param api_key User or Host API key.
-  # @param email It is for a Client API.
-  def initialize(api_key, email = nil)
-
-    @params = Hash.new
-
-    if email.nil?
-      @params[:api_key] = api_key
-    else
-      @params[:api_key] = api_key
-      @params[:email] = email
-    end
-
-  end
-
-  # CLIENT
-
-  # This function can be used to get currently settings of values such as the security level. 
-  #
-  # More: https://www.cloudflare.com/wiki/Client_Interface_API#FUNCTION:_Current_Stats_and_Settings
-  #
-  # @param zone The zone you'd like to run CNAMES through CloudFlare for, e.g. +example.com+.
-  # @param interval The interval parameter defines what period you want to look at. Default is 30 days, but 1 day delayed. Pro only intervals are 100, 110, and 120.
-  #
-  # @return (Hash) the current stats and settings for a particular website 
-
-  def stats(zone, interval = 20)
-    send_req({a: :stats, z: zone, interval: interval})
-  end
-
-  # This function sets the Basic Security Level to HELP I'M UNDER ATTACK / HIGH / MEDIUM / LOW / ESSENTIALLY OFF.
-  #
-  # @param zone The zone you'd like to run CNAMES through CloudFlare for, e.g. +example.com+.
-  # @param value Must be one of low|med|high|help|eoff.
-
-  def set_security_lvl(zone, value)
-    send_req({a: :sec_lvl, z: zone, v: value})
-  end
-
-  # This function sets the Caching Level to Aggressive or Basic.
-  #
-  # @param zone The zone you'd like to run CNAMES through CloudFlare for, e.g. +example.com+.
-  # @param value Must be one of agg|basic.
-
-  def set_cache_lvl(zone, value)
-    send_req({a: :cache_lvl, z: zone, v: value})   
-  end
-
-  # This function allows you to toggle Development Mode on or off for a particular domain. When Development Mode is on the cache is bypassed. Development mode remains on for 3 hours or until when it is toggled back off.
-  #
-  # @note Development mode will expire on "expires_on" (3 hours from when it is toggled on). Development mode can be toggled off immediately by setting +value+ to 0.
-  #
-  # @param zone The zone you'd like to run CNAMES through CloudFlare for, e.g. +example.com+
-  # @param value May be set to true (on) or false (off).
-  # @return (Hash) expires_on
-
-  def devmode(zone, value)
-    send_req({a: :devmode, z: zone, v: value == true ? 1 : 0})
-  end
-
-  # This function will purge CloudFlare of any cached files. It may take up to 48 hours for the cache to rebuild and optimum performance to be achieved so this function should be used sparingly. 
-  #
-  # @param zone The zone you'd like to run CNAMES through CloudFlare for, e.g. +example.com+.
-  # @return (Hash) fpurge_ts, cooldawn
-  # @return *fpurge_ts* - Time at which cache was purged.
-  # @return *cooldown* - Number of seconds before the next time this call is allowed again.
-
-  def purge_cache(zone)
-    send_req({a: :fpurge_ts, z: zone, v: 1})    
-  end
-
-  # This function checks whether one or more websites/domains are active under an account and return the zone ids (zids) for these.
-  #
-  # @param zones Zones, eg. +example.com+, +exampletwo.com+
-  # @return (Hash) Map of passed in zones. If a zone if hosted on CloudFlare and the email + tkn combination is correct for the given zone, the value for the zone will be its zone id (use this for other API calls). Otherwise 0.
-
-  def zone_check(*zones)
-    send_req({a: :zone_check, zones: zones.kind_of?(Array) ? zones.join(',') : zones})
-  end
-
-  # This function pulls recent IPs hitting your site.
-  #
-  # @param zoneid Id of the zone you would like to check.
-  # @param hours Number of hours to go back. Default is 24, max is 48.
-  # @param class Restrict the result set to a given class. Currently r|s|t, for regular, crawler, threat resp.
-  # @param geo Add to add longitude and latitude information to the response. 0,0 means no data.
-  # @return (Hash) A list of IP addresses which hit your site classified by type.
-
-  def zone_ips(zoneid, classification, hours = 24, geo = '0,0')
-    send_req({a: :zone_ips, zid: zoneid, hours: hours, class: classification, geo: geo})  
-  end
-
-  # This functions updates the snapshot of your site for CloudFlare's challenge page.
-  #
-  # @note Yhis call is rate limited to once per zone per day. Also the new image may take up to 1 hour to appear.
-  # 
-  # @param zoneid Id of the zone you would like to check.
-
-  def update_image(zoneid)
-    send_req({a: :zone_grab, zid: zoneid})
-  end
-
-  # This function adds an IP address to your white lists.
-  #
-  # @param address The address you wish to set a rule for.
-
-  def whitelist(address)
-    send_req({a: :wl, key: address})
-  end
-
-  # This function adds an IP address to your black lists.
-  #
-  # @param address The address you wish to set a rule for.
-
-  def blacklist(address)  
-    send_req({a: :ban, key: address})
-  end
-
-  # This function creates a new DNS record for your site. This can be either a CNAME or A record.
-  #
-  # @param zone The zone you'd like to run CNAMES through CloudFlare for, e.g. +example.com+.
-  # @param type Type of record - CNAME or A.
-  # @param content The value of the cname or IP address (the destination).
-  # @param name The name of the record you wish to create.
-  # @param mode False or true. false means CloudFlare is off (grey cloud) for the new zone, while true means a happy orange cloud.
-
-  def add_rec(zone, type, content, name, mode)
-    send_req({a: :rec_set, zone: zone, type: type, content: content, name: name, mode: mode == true ? 1 : 0})
-  end
-
-  # This function deletes a DNS record.
-  #
-  # @note All records of the given name will be deleted. For this reason, you must pass in the full DNS name of the record you wish to remove. For +example+, +sub.foo.com+, as opposed to just sub.
-  #
-  # @param zone
-  # @param name The name of the record you wish to remove.
-
-  def del_rec(zone, name)
-    send_req({a: :rec_del, zone: zone, name: name})
-  end
-
-  # This function purges the preloader's cache.
-  #
-  # @note Can take up to an hour for this to take effect.
-  #
-  # @param ip The value of the IP address.
-
-  def pre_purge(ip)
-    send_req({a: :pre_purge, zone_name: ip})
-  end
-
-  # This function updates a DNS record for your site. This needs to be an A record.
-  #
-  # @param ip The value of the IP address (the destination).
-  # @param hosts The name of the record you wish to adjust.
-
-  def update_rec(ip, hosts)
-    send_req({a: :DIUP, ip: ip, hosts: hosts})
-  end
-
-  # This function checks the threat score for a given IP.
-  #
-  # @note scores are logarithmically increasing, like the Richter scale.
-  #
-  # @param ip IP address to check.
-  # @return The current threat score for a given IP.
-
-  def threat_score(ip)
-    send_req({a: :ip_lkup, ip: ip})
-  end
-
-  # This function toggles ipv6 support for a site.
-  #
-  # @param zone
-  # @param value False disables, true enables support.
-
-  def toggle_ipv6(zone, value)
-    send_req({a: :ipv46, z: zone, v: value == true ? 1 : 0})
-  end
-
-  # HOST
-  
-  # This function creates a CloudFlare account mapped to your user.
-  #
-  # @param email The user's e-mail address for the new CloudFlare account.
-  # @param pass The user's password for the new CloudFlare account. CloudFlare will never store this password in clear text.
-  # @param login (optional) The user's username for the new CloudFlare account. CloudFlare will auto-generate one if it is not specified.
-  # @param id Set a unique string identifying the User. This identifier will serve as an alias to the user's CloudFlare account. Typically you would set this value to the unique ID in your system (e.g., the internal customer number or username stored in your own system). This parameter can be used to retrieve a user_key when it is required. The unique_id must be an ASCII string with a maximum length of 100 characters.
-  # @return (String) cloudflare_email
-  # @return (String) user_key
-  # @return (String) unique_id
-  # @return (String) cloudflare_username
-
-  def create_user(email, pass, login = nil, id = nil)
-    send_req({act: :user_create, cloudflare_email: email, cloudflare_pass: pass, cloudflare_username: login, unique_id: id})
-  end
-
-  # This function setups a User's zone for CNAME hosting.
-  #
-  # @note This function replaces any previous setup for the particular zone_name. If are adding an additional subdomain to an account that already has some subdomains setup, you should specify all the subdomains not only the new subdomains.
-  #
-  # @param user_key The unique 32 hex character auth string, identifying the user's CloudFlare Account. Generated from a +create_user+ or +user_auth+.
-  # @param zone The zone you'd like to run CNAMES through CloudFlare for, e.g. +example.com+.
-  # @param resolve_to The CNAME that CloudFlare should ultimately resolve web connections to after they have been filtered, e.g. +resolve-to-cloudflare.example.com+. This record should ultimately resolve to the one or more IP addresses of the hosts for the particular website for all the specified subdomains.
-  # @param subdomains A comma-separated string of subdomain(s) that CloudFlare should host, e.g. +www,blog,forums+ or +www.example.com,blog.example.com,forums.example.com+.
-  # @return (String) zone_name
-  # @return (String) resolving_to
-  # @return (Hash) hosted_cnames
-  # @return (Hash) forward_tos
-
-  def add_zone(user_key, zone, resolve_to, subdomains)
-    send_req({act: :zone_set, user_key: user_key, zone_name: zone, resolve_to: resolve_to, subdomains: subdomains.kind_of?(Array) ? zones.join(',') : subdomains})
-  end
-
-  # This function lookups a user's CloudFlare account information.
-  #
-  # @note If you use +unique_id+, +id+ must be +true+.
-  #
-  # *Example:*
-  #
-  #   cf = CloudFlare('your_host_key')
-  #   cf.user_lookup('unique_id', true)
-  #
-  # @param email Lookup a user's account information or status by either +email+ or +unique_id+.
-  # @return (String) user_key
-  # @return (Boolean) user_exists
-  # @return (Boolean) user_authed
-  # @return (String) cloudflare_email
-  # @return (String) unique_id
-  # @return (Array) hosted_zones 
-
-  def user_lookup(email, id = false)
-    if id
-      send_req({act: :user_lookup, unique_id: email})
-    else
-      send_req({act: :user_lookup, cloudflare_email: email})
-    end
-  end
-
-  # This function authorizes access to a user's existing CloudFlare account.
-  #
-  # @param email the user's e-mail address for the new CloudFlare account.
-  # @param pass the user's password for the new CloudFlare account. CloudFlare will never store this password in clear text.
-  # @param unique_id (optional) set a unique string identifying the user. This identifier will serve as an alias to the user's CloudFlare account. Typically you would set this value to the unique ID in your system. This parameter can be used as an alias for other actions (e.g., it can substitute for the +email+ and +pass+ if you choose not to store those fields in your system).
-  # @return (Hash) User's e-mail, key and unique id.
-
-  def user_auth(email, pass, id = nil)
-    send_req({act: :user_auth, cloudflare_email: email, cloudflare_pass: pass, unique_id: id})
-  end
-
-  # This function lookups a specific user's zone.
-  #
-  # @param user_key API user key
-  # @param zone the zone you'd like to lookup, e.g. "example.com"
-  # @return (String) zone_name
-  # @return (Boolean) zones_exists
-  # @return (Boolean) zone_hosted
-  # @return (Hash) hosted_cnames
-  # @return (Hash) hosted_cnames
-  # @return (Hash) forward_tos
-
-  def zone_lookup(user_key, zone)
-    send_req({act: :zone_lookup, user_key: user_key, zone_name: zone}) 
-  end
-
-  # This function deletes a specific zone on behalf of a user.
-  #
-  # @param user_key API user key
-  # @param zone The zone you'd like to lookup, e.g. +example.com+
-  # @return (String) zone_name, 
-  # @return (Boolean) zone_deleted
-
-  def del_zone(user_key, zone)
-    send_req({act: :zone_delee, user_key: user_key, zone_name: zone}) 
-  end
-
-  private 
-
-  def send_req(params)
-
-    if @params[:email]
-      params[:tkn] = @params[:api_key]
-      params[:u] = @params[:email]
-      uri = URI(URL_API[:client])
-    else
-      params[:host_key] = @params[:api_key]
-      uri = URI(URL_API[:host])
-    end
-
-    req = Net::HTTP::Post.new(uri.path)
-    req.set_form_data(params)
-
-    http = Net::HTTP.new(uri.host, uri.port)
-    http.use_ssl = true
-    http.read_timeout = TIMEOUT
-
-    begin
-      res = http.request(req)
-      JSON.parse(res.body)
-    rescue => e
-      puts "#{e.class} #{e.message}"
-    end
-
-  end
-
-end
+    # URL for Client and Host API
+
+    URL_API = {
+        client: 'https://www.cloudflare.com/api_json.html',
+        host: 'https://api.cloudflare.com/host-gw.html'
+    }
+
+    TIMEOUT = 5 # Default is 5 seconds
+
+    # @param api_key [String] user or Host API key.
+    # @param email [String] it is for a Client API.
+    def initialize(api_key, email = nil)
+        @params = Hash.new
+
+        if email.nil?
+            @params[:api_key] = api_key
+        else
+            @params[:api_key] = api_key
+            @params[:email] = email
+        end
+
+    end
+
+    # CLIENT
+
+    # This function can be used to get currently settings of values such as the security level.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#s3.1
+    #
+    # @param zone [String]
+    # @param interval [Integer]
+
+    def stats(zone, interval = 20)
+        send_req({a: :stats, z: zone, interval: interval})
+    end
+
+    # This function lists all domains in a CloudFlare account along with other data.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#s3.2
+
+    def zone_load_multi
+        send_req(a: :zone_load_multi)
+    end
+
+    # This function lists all of the DNS records from a particular domain in a CloudFlare account.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#s3.3
+    #
+    # @param zone [String]
+
+    def rec_load_all(zone)
+        send_req({a: :rec_load_all, z: zone})
+    end
+
+    # This function checks whether one or more websites/domains are active under an account and return the zone ids (zids) for these.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#s3.4
+    #
+    # @param zones [String or Array] 
+
+    def zone_check(*zones)
+        send_req({a: :zone_check, zones: zones.kind_of?(Array) ? zones.join(',') : zones})
+    end
+
+    # This function pulls recent IPs hitting your site.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#s3.5
+    #
+    # @param zone [String]
+    # @param hours [Integer] max 48
+    # @param classification [String] (optional) values: r|c|t
+    # @param geo [Fixnum] (optional)
+
+    def zone_ips(zone, classification = nil, hours = 24, geo = 1)
+        send_req({a: :zone_ips, z: zone, hours: hours, "class" => classification, geo: geo})
+    end
+
+    # This function checks the threat score for a given IP.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#s3.6
+    #
+    # @param ip [String]
+
+    def ip_lkup(ip)
+        send_req({a: :ip_lkup, ip: ip})
+    end
+
+    # This function retrieves all current settings for a given domain.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#s3.7
+    #
+    # @param zone [String]
+
+    def zone_settings(zone)
+        send_req({a: :zone_settings, z: zone})
+    end
+
+    # This function sets the Basic Security Level to HELP I'M UNDER ATTACK / HIGH / MEDIUM / LOW / ESSENTIALLY OFF.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#4.1
+    #
+    # @param zone [String]
+    # @param value [String] values: low|med|high|help|eoff
+
+    def sec_lvl(zone, value)
+        send_req({a: :sec_lvl, z: zone, v: value})
+    end
+
+    # This function sets the Caching Level to Aggressive or Basic.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#4.2
+    #
+    # @param zone [String]
+    # @param value [String] values: agg|basic
+
+    def cache_lvl(zone, value)
+        send_req({a: :cache_lvl, z: zone, v: value})
+    end
+
+    # This function allows you to toggle Development Mode on or off for a particular domain.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#4.3
+    #
+    # @param zone [String]
+    # @param value [Boolean] 
+
+    def devmode(zone, value)
+        send_req({a: :devmode, z: zone, v: value ? 1 : 0})
+    end
+
+    # This function will purge CloudFlare of any cached files.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#4.4
+    #
+    # @param zone [String]
+
+    def fpurge_ts(zone)
+        send_req({a: :fpurge_ts, z: zone, v: 1})
+    end
+
+    # This function will purge a single file from CloudFlare's cache.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#4.5
+    #
+    # @param zone [String]
+    # @param url [String]
+
+    def zone_file_purge(zone, url)
+        send_req({a: :zone_file_purge, z: zone, url: url})
+    end
+
+    # This function updates the snapshot of your site for CloudFlare's challenge page.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#4.6
+    #
+    # @param zoneid [Integer]
+
+    def zone_grab(zoneid)
+        send_req({a: :zone_grab, zid: zoneid})
+    end
+
+    # This function adds an IP address to your white lists.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#4.7
+    #
+    # @param ip [String]
+
+    def whitelist(ip)
+        send_req({a: :wl, key: ip})
+    end
+
+
+    # This function adds an IP address to your black lists.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#4.7
+    #
+    # @param ip [String]
+
+    def blacklist(ip)
+        send_req({a: :ban, key: ip})
+    end
+
+    # This function removes the IP from whitelist or blacklist.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#4.7
+    #
+    # @param ip [String]
+
+    def remove_ip(ip)
+        send_req({a: :nul, key: ip})
+    end
+
+    # This function toggles IPv6 support.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#4.8
+    #
+    # @param zone [String]
+    # @param value [Boolean] 
+
+    def ipv46(zone, value)
+        send_req({a: :ipv46, z: zone, v: value ? 1 : 0})
+    end
+
+    # This function changes Rocket Loader setting.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#s4.9
+    #
+    # @param zone [String]
+    # @param value [Integer or String] values: 0|a|m
+
+    def async(zone, value)
+        send_req({a: :async, z: zone, v: value})
+    end
+
+    # This function changes minification settings.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#s4.9
+    #
+    # @param zone [String]
+    # @param value [Integer] values: 0|2|3|4|5|6|7
+
+    def minify(zone, value)
+        send_req({a: :minify, z: zone, v: value})
+    end
+
+    # This function creates a new DNS record for your site. This can be either a CNAME or A record.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#s5.1
+    #
+    # @param zone [String]
+    # @param type [String] values: A|CNAME|MX|TXT|SPF|AAAA|NS|SRV|LOC
+    # @param name [String]
+    # @param content [String]
+    # @param ttl [Integer] values: 1|120...4294967295
+    # @param prio [Integer] (applies to MX/SRV)
+    # @param service [String] (applies to SRV)
+    # @param srvname [String] (applies to SRV)
+    # @param protocol [Integer] (applies to SRV) values: _tcp|_udp|_tls
+    # @param weight [Intger] (applies to SRV)
+    # @param port [Integer] (applies to SRV)
+    # @param target [String] (applies to SRV)
+
+    def rec_new(zone, type, name, content, ttl, prio = nil, service = nil, srvname = nil, protocol = nil, weight = nil, port = nil, target = nil)
+        send_req({
+            a: :rec_new,
+            zone: zone,
+            type: type,
+            name: name,
+            content: content,
+            ttl: ttl,
+            prio: prio,
+            service: service,
+            srvname: srvname,
+            protocol: protocol,
+            weight: weight,
+            port: port,
+            target: target
+        })
+    end
+
+    # This function edits a DNS record for a zone.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#s5.2
+    #
+    # @param zone [String]
+    # @param type [String] values: A|CNAME|MX|TXT|SPF|AAAA|NS|SRV|LOC
+    # @param zoneid [Integer]
+    # @param name [String]
+    # @param content [String]
+    # @param ttl [Integer] values: 1|120...4294967295
+    # @param service_mode [Boolean] (applies to A/AAAA/CNAME)
+    # @param prio [Integer] (applies to MX/SRV)
+    # @param service [String] (applies to SRV)
+    # @param srvname [String] (applies to SRV)
+    # @param protocol [Integer] (applies to SRV) values: _tcp/_udp/_tls
+    # @param weight [Intger] (applies to SRV)
+    # @param port [Integer] (applies to SRV)
+    # @param target [String] (applies to SRV)
+
+    def rec_edit(zone, type, zoneid, name, content, ttl, service_mode = nil, prio = nil, service = nil, srvname = nil, protocol = nil, weight = nil, port = nil, target = nil)
+        send_req({
+            a: :rec_new,
+            z: zone,
+            type: type,
+            id: zoneid,
+            name: name,
+            content: content,
+            ttl: ttl,
+            service_mode: service_mode ? 1 : 0,
+            prio: prio,
+            service: service,
+            srvname: srvname,
+            protocol: protocol,
+            weight: weight,
+            port: port,
+            target: target
+        })
+    end
+
+    # This functon deletes a record for a domain.
+    #
+    # @see http://www.cloudflare.com/docs/client-api.html#s5.3
+    #
+    # @param zone [String]
+    # @param zoneid [Integer]
+
+    def rec_delete(zone, zoneid)
+        send_req({a: :rec_delete, z: zone, id: zoneid})
+    end
+
+    # HOST
+
+    # This function creates a CloudFlare account mapped to your user.
+    #
+    # @see http://www.cloudflare.com/docs/host-api.html#s3.2.1
+    #
+    # @param email [String]
+    # @param pass [String]
+    # @param login [String] (optional) cloudflare_username
+    # @param id [Integer] (optional) unique_id
+    # @param cui [Integer] (optional) clobber_unique_id
+
+    def create_user(email, pass, login = nil, id = nil, cui = nil)
+        send_req({
+            act: :user_create,
+            cloudflare_email: email,
+            cloudflare_pass: pass,
+            cloudflare_username: login,
+            unique_id: id,
+            clobber_unique_id: cui
+        })
+    end
+
+    # This function setups a User's zone for CNAME hosting.
+    #
+    # @see http://www.cloudflare.com/docs/host-api.html#s3.2.2
+    #
+    # @param user_key [String]
+    # @param zone [String]
+    # @param resolve_to [String]
+    # @param subdomains [String or Array]
+
+    def add_zone(user_key, zone, resolve_to, subdomains)
+        send_req({
+            act: :zone_set,
+            user_key: user_key,
+            zone_name: zone,
+            resolve_to: resolve_to,
+            subdomains: subdomains.kind_of?(Array) ? zones.join(',') : subdomains
+        })
+    end
+
+    # This function lookups a user's CloudFlare account information.
+    #
+    # @see http://www.cloudflare.com/docs/host-api.html#s3.2.3
+    #
+    # *Example:*
+    #
+    #   cf = CloudFlare('your_host_key')
+    #   cf.user_lookup('unique_id', true)
+    #
+    # If +id+ is set to true, email is a unique_id.
+    #
+    # @param email [String or Integer]
+    # @param id [Boolean]
+
+    def user_lookup(email, id = false)
+        if id
+            send_req({act: :user_lookup, unique_id: email})
+        else
+            send_req({act: :user_lookup, cloudflare_email: email})
+        end
+    end
+
+    # This function authorizes access to a user's existing CloudFlare account.
+    #
+    # @see http://www.cloudflare.com/docs/host-api.html#s3.2.4
+    #
+    # @param email [String]
+    # @param pass [String]
+    # @param unique_id [Integer] (optional)
+    # @param cui [Integer] (optional) clobber_unique_id
+
+    def user_auth(email, pass, id = nil, cui = nil)
+        send_req({
+            act: :user_auth,
+            cloudflare_email: email,
+            cloudflare_pass: pass,
+            unique_id: id,
+            clobber_unique_id: cui
+        })
+    end
+
+    # This function lookups a specific user's zone.
+    #
+    # @see http://www.cloudflare.com/docs/host-api.html#s3.2.5
+    #
+    # @param user_key [String]
+    # @param zone [String]
+
+    def zone_lookup(user_key, zone)
+        send_req({act: :zone_lookup, user_key: user_key, zone_name: zone})
+    end
+
+    # This function deletes a specific zone on behalf of a user.
+    #
+    # @see http://www.cloudflare.com/docs/host-api.html#s3.2.6
+    #
+    # @param user_key [String]
+    # @param zone [String]
+
+    def del_zone(user_key, zone)
+        send_req({act: :zone_delete, user_key: user_key, zone_name: zone})
+    end
+
+    # This function creates a new child host provider.
+    #
+    # @see http://www.cloudflare.com/docs/host-api.html#s3.2.7
+    #
+    # @param host_name [String]
+    # @param pub_name [String]
+    # @param prefix [String]
+    # @param website [String]
+    # @param email [String]
+
+    def host_child_new(host_name, pub_name, prefix, website, email)
+        send_req({
+            act: :host_child_new,
+            pub_name: pub_name,
+            prefix: prefix,
+            website: website,
+            email: email
+        })
+    end
+
+    # This function regenerates your host key.
+    #
+    # @see http://www.cloudflare.com/docs/host-api.html#s3.2.8
+
+    def host_key_regen
+        send_req(act: :host_key_regen)
+    end
+
+    # This function stops a child host provider account.
+    #
+    # @see http://www.cloudflare.com/docs/host-api.html#s3.2.9
+    #
+    # @param id [Integer] child_id
+
+    def host_child_stop(id)
+        send_req({act: host_child_stop, child_id: id})
+    end
+
+    # This function lists the domains currently active on CloudFlare for the given host.
+    #
+    # @see http://www.cloudflare.com/docs/host-api.html#s3.2.10
+    #
+    # @param limit [Integer] (optional)
+    # @param offset [Integer] (optional)
+    # @param name [String] (optional) zone_name
+    # @param sub_id [Integer] (optional) sub_id
+    # @param status [String] (optional) values: V|D|ALL
+
+    def zone_list(limit = 100, offset = 0, name = nil, sub_id = nil, status = nil)
+        send_req({
+            act: :zone_list,
+            offset: offset,
+            zone_name: name,
+            sub_id: sub_id,
+            zone_status: status
+        })
+    end
+
+    private
+
+    def send_req(params)
+
+        if @params[:email]
+            params[:tkn] = @params[:api_key]
+            params[:u] = @params[:email]
+            uri = URI(URL_API[:client])
+        else
+            params[:host_key] = @params[:api_key]
+            uri = URI(URL_API[:host])
+        end
+
+        req = Net::HTTP::Post.new(uri.path)
+        req.set_form_data(params)
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.read_timeout = TIMEOUT
+
+        begin
+            res = http.request(req)
+            JSON.parse(res.body)
+        rescue => e
+            puts "#{e.class} #{e.message}"
+        end
+
+    end
+
+end

data/test/test_cloudflare.rb

@@ -5,7 +5,7 @@ class HostTest < Test::Unit::TestCase
 
   def test_client_connection
     cf = CloudFlare.new('example_api', 'example@example.com')
-    assert_equal('E_UNAUTH', cf.toggle_ipv6('example.com', true)['err_code'])
+    assert_equal('E_UNAUTH', cf.ipv46('example.com', true)['err_code'])
   end
 
   def test_host_connection

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cloudflare
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-30 00:00:00.000000000 Z
+date: 2013-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &8532060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,12 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *8532060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A Ruby wrapper for the CloudFlare API.
 email: marcin@prokop.co
 executables: []
@@ -35,7 +40,7 @@ files:
 - test/test_cloudflare.rb
 - README.md
 - LICENSE
-homepage: http://b4k3r.github.com/cloudflare/
+homepage: https://github.com/B4k3r/cloudflare
 licenses: []
 post_install_message: 
 rdoc_options:
@@ -58,10 +63,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A Ruby wrapper for the CloudFlare API.
 test_files:
 - test/test_cloudflare.rb
-has_rdoc: