reg.api2 0.0.7 → 0.0.8

data/README.md

@@ -45,6 +45,22 @@ RegApi2.service.nop(services: [
 ])
 ```
 
+or with including of {RegApi2} module:
+
+```ruby
+require "reg_api2"
+
+include RegApi2
+
+service.nop(services: [
+  { dname: "test.ru" },
+  { dname: "test.su", servtype: "srv_hosting_ispmgr" },
+  { service_id: 111111 },
+  { service_id: "22bug22" },
+  { surprise: "surprise.ru" }
+])
+```
+
 Other examples available as examples of concrete method calls.
 
 ### Console
@@ -63,7 +79,7 @@ Your default username: "test", and You can change it with "~/.regapi2".
 Console use test/test credentials by default, but you can assign new ones
 before any operations over REG.API through {RegApi2} properties.
 
-Also console reads `~/.regapi2` configuration file if exists, to assign properties from. It knows about these properties in configuration file: `username`, `password`, `lang`, `pem`, `pem_password` and `ca_cert_path`.
+Also console reads `~/.regapi2` configuration file if exists, to assign properties from. It knows about these properties in configuration file: `username`, `password`, `lang`, `pem`, `pem_password` and `ca_cert_path`. Properties should be written in `key=value` format separated by newline.
 
 ## Recommendations for effective use of REG.API
 

data/lib/reg_api2/console_helpers.rb

@@ -11,9 +11,17 @@ def try_lo_load_defaults
   if File.readable?(filename)
     IO.read(filename).split("\n").each do |line|
       line.strip!
-      props.each do |prop|
-        RegApi2.send("#{prop}=", $1)  if line =~ /\A\s*#{Regexp.escape(prop)}\s*\=(.+)\s*\z/;
+      next  if line =~ /\A\s*#/ # skip comments
+      if line !~ /\A\s*(\w+)\s*\=(.+)\s*\z/
+        $stderr.puts "#{filename}: We expect key=value string but got \"#{line}\""
+        exit 1
       end
+      name, value = $1, $2
+      unless props.include?(name)
+        $stderr.puts "#{filename}: Unknown name: \"#{name}\", we know only #{props.join(', ')}"
+        exit 1
+      end
+      RegApi2.send("#{name}=", value)
     end
   end
 

data/lib/reg_api2/result_contract.rb

@@ -17,6 +17,12 @@ module RegApi2
       renew_domains_get_ctrl_cnt
       undelegated_domains_cnt
       bill_id
+      service_id
+      server_id
+      cpu_count
+      cpu_core
+      hdd_count
+      ram_count
     ].freeze
 
     # Fields that will be converted to {Float}.
@@ -26,6 +32,8 @@ module RegApi2
       total_amount
       payment
       total_payment
+      month_traf
+      price_retail
     ].freeze
 
     # Fields that will be converted to {Boolean}.

data/lib/reg_api2/service.rb

@@ -10,8 +10,10 @@ module RegApi2
     # @!method nop(opts = {})
     # Return list of specified services with its stats if specified.
     # @param opts Options.
-    # @option opts [Array] services
-    # @return [Hash("services" => [])]
+    # @option opts [Array<Hash>] services List of services to be retrieved.
+    # @return [Array<Hash>] List of specified services with its stats.
+    # @note Accessibility: clients
+    # @note Support of service lists: yes
     # @example List of services by specified identifiers
     #  RegApi2.service.nop(services: [
     #    { dname:"test.ru" },
@@ -20,7 +22,7 @@ module RegApi2
     #    { service_id: "22bug22" },
     #    { surprise: "surprise.ru" }
     #  ])
-    define :nop
+    define :nop, field: :services
 
     # @!method get_prices(opts = {})
     # Get services registration/renewal prices.
@@ -28,6 +30,8 @@ module RegApi2
     # @option opts [Boolean] :show_renew_data With this flag enabled the system will return the price of renewal (1/0). Optional field.
     # @option opts [String, Symbol] :currency Identifier of the currency in which the prices will be quoted: rur (default), uah, usd, eur. Optional field.
     # @return [Hash(currency, price_group, show_renew_data, prices)] Prices.
+    # @note Accessibility: everyone
+    # @note Support of service lists: no
     # @example Get prices.
     #    RegApi2.service.get_prices
     define :get_prices
@@ -40,6 +44,7 @@ module RegApi2
     # @option opts [String, Symbol] :subtype Service subtype.
     # @option opts [Boolean] :unroll_prices Show prices in expanded form.
     # @return [Array(Hash(commonname, ...))] Service type details.
+    # @note Accessibility: everyone
     # @example Get service type details.
     #    RegApi2.service.get_servtype_details servtype: :srv_hosting_ispmgr
     define :get_servtype_details
@@ -47,44 +52,43 @@ module RegApi2
 
     # @!method create(opts = {})
     # Use the function to order new services.
-    # `servtype` values are supported:
-    #
-    # | servtype | service type |
-    # | ---------|--------------|
-    # | srv_webfwd | web forwarding |
-    # | srv_parking | domain parking |
-    # | srv_dns_both | DNS support |
-    # | srv_hosting_ispmgr | ISPManager hosting |
-    # | srv_hosting_cpanel | CPanel hosting |
-    # | srv_hosting_plesk | PLesk hosting |
-    # | srv_ssl_certificate | SSL certificate |
-    # | srv_certificate | Domain certificate |
-    # | srv_voucher | Domain voucher |
-    # | srv_vps | VPS server |
-    # | srv_license_isp | ISP Manager license |
-    # | srv_addip | additional IP address |
-    # | srv_disk_space | additional disk space |
-    # | srv_antispam | advanced spam protection |
-    # | srv_dedicated | dedicated server |
-    # | srv_kvm | KVM access |
-    #
-    # Common payment options are allowed.
-    # folder_name or folder_id are allowed.
     # @param opts Options.
     # @option opts [String] :domain_name Name of the domain, for which the service is ordered.
     # @option opts [String, Symbol] :servtype The type of the ordered service.
+    #
+    #   | servtype | service type |
+    #   | ---------|--------------|
+    #   | srv_webfwd | web forwarding |
+    #   | srv_parking | domain parking |
+    #   | srv_dns_both | DNS support |
+    #   | srv_hosting_ispmgr | ISPManager hosting |
+    #   | srv_hosting_cpanel | CPanel hosting |
+    #   | srv_hosting_plesk | PLesk hosting |
+    #   | srv_ssl_certificate | SSL certificate |
+    #   | srv_certificate | Domain certificate |
+    #   | srv_voucher | Domain voucher |
+    #   | srv_vps | VPS server |
+    #   | srv_license_isp | ISP Manager license |
+    #   | srv_addip | additional IP address |
+    #   | srv_disk_space | additional disk space |
+    #   | srv_antispam | advanced spam protection |
+    #   | srv_dedicated | dedicated server |
+    #   | srv_kvm | KVM access |
+    #
     # @option opts [Object] :period The period for which the service is ordered, the unit of measurement (year or month) depends on the type of the service being ordered. To learn about the measurement units used for each service, use the {#get_servtype_details} function.
     # @option opts [String] :user_servid Domain ID set by the user. Allowed symbols: digits (from 0 through 9), Latin letters (from a through f). Maximum length: 32 symbols. This ID cannot be generated automatically; if it is not defined upon service ordering, the field will be empty. Optional field.
-    # @option opts :point_of_sale See common payment parameters in {file:README.md}.
-    # @option opts :pay_type See common payment parameters in {file:README.md}.
-    # @option opts :ok_if_no_money See common payment parameters in {file:README.md}.
-    # @option opts :folder_name Defines the name of the folder, to which the services will be added (see the list of common folder identification parameters in {file:README.md}).
-    # @option opts :folder_id Defines the name of the folder, to which the services will be added (see the list of common folder identification parameters in {file:README.md}).
+    # @option opts :point_of_sale See {file:README.md#Common_payment_options common payment parameters}.
+    # @option opts :pay_type See {file:README.md#Common_payment_options common payment parameters}.
+    # @option opts :ok_if_no_money See See {file:README.md#Common_payment_options common payment parameters}.
+    # @option opts :folder_name Defines the name of the folder, to which the services will be added (see {file:README.md#Folder_identification_parameters folder identification parameters}).
+    # @option opts :folder_id Defines the name of the folder, to which the services will be added (see {file:README.md#Folder_identification_parameters folder identification parameters}).
     # @option opts [Boolean] :no_new_folder Dont't create non-existing folder; otherwise create if not exists.
     # @option opts [String] :comment An arbitrary text describing the order. Optional field.
     # @option opts [String] :admin_comment A comment for administrators. An arbitrary text describing the order. Optional field.
     # TODO: specific options.
     # @return [Hash(descr, service_id, ...)] Information about ordered service.
+    # @note Accessibility: everyone
+    # @note Support of service lists: no
     # @see #get_servtype_details
     # @example Create srv_hosting_ispmgr service.
     #    RegApi2.service.create dname: 'qqq.ru', servtype: :srv_hosting_ispmgr, period: 1, plan: 'Host-2-1209'
@@ -93,17 +97,62 @@ module RegApi2
     # @!method delete(opts = {})
     # Removes the service.
     # @param opts Options.
+    # @option opts [String, Symbol] :servtype Service type, which is to be removed. These values are supported:
+    #
+    #   | servtype | service type |
+    #   | ---------|--------------|
+    #   | srv_hosting_ispmgr | ISPManager hosting |
+    #   | srv_hosting_cpanel | CPanel hosting |
+    #   | srv_hosting_plesk | PLesk hosting |
+    #   | srv_addip | additional IP address |
+    #   | srv_antispam | advanced spam protection |
+    #   | srv_sitebuilder_plsk | SiteBuilder Plesk |
+    #   | srv_vps | VPS server |
+    #   | srv_license_isp | ISP Manager license |
+    #   | srv_disk_space | additional disk space |
+    #   | srv_dedicated | dedicated server |
+    #   | srv_kvm | KVM access |
+    #
+    # @return [NilClass] nil
+    # @note Accessibility: clients
+    # @note Support of service lists: no
+    # @example Removing of `srv_hosting_ispmgr` service.
+    #    RegApi2.service.delete domain_name: 'test.ru', servtype: :srv_hosting_ispmgr
     define :delete, required: %w[ servtype ]
 
     # @!method get_info(opts = {})
     # Use this function to obtain information about all services.
     # @param opts Options.
+    # @note Accessibility: clients
+    # @note Support of service lists: yes
     define :get_info
 
     # @!method get_list(opts = {})
     # Use this function to obtain a list of active services.
     # @param opts Options.
-    define :get_list
+    # @option opts [String,Symbol] :servtype Type of service. If nothing is defined, information about all types of services will be returned.
+    #
+    #    | Type   | Description |
+    #    |--------|-------------|
+    #    |domain | Domain|
+    #    |srv_webfwd | web forwarding|
+    #    |srv_parking | domain parking|
+    #    |srv_dns_both | DNS support|
+    #    |srv_hosting_ispmgr | ISPManager hosting|
+    #    |srv_hosting_cpanel | CPanel hosting|
+    #    |srv_hosting_plesk | Plesk hosting|
+    #    |srv_antispam | Extended spam protection|
+    #    |srv_vps | VPS server|
+    #    |srv_addip | Additional IP address|
+    #    |srv_license_isp | ISPManager license|
+    #    |srv_certificate | Domain certificate|
+    #    |srv_voucher | Domain voucher |
+    #
+    # @return [Array<Hash>] List of service of specified `servtype`.
+    # @note Accessibility: clients
+    # @example Get list of domains.
+    #    RegApi2.service.get_list servtype: :domain
+    define :get_list, field: :services
 
     # @!method get_folders(opts = {})
     # Use this function to get the list of folders the service is associated with.
@@ -124,7 +173,28 @@ module RegApi2
     # @!method get_dedicated_server_list(opts = {})
     # Get the dedicated server list.
     # @param opts Options.
-    define :get_dedicated_server_list
+    # @return [Array<Hash>] List of dedicated servers. Each item of {RegApi2::SymHash} class contain these fields:
+    # 
+    #   | Field | Description |
+    #   |-------|-------------|
+    #   | server_id   | Unique server id
+    #   | cpu_content | Processor model
+    #   | cpu_count   | Processor count
+    #   | cpu_core    | Core count
+    #   | ram_content | RAM type
+    #   | ram_count   | RAM count
+    #   | ram_size    | RAM size
+    #   | hdd_content | HDD interface type
+    #   | hdd_count   | HDD count
+    #   | hdd_size    | HDD disk size
+    #   | month_traf  | Traffic, GB per month
+    #   | price_retail |   Rent per month
+    #
+    # @note Accessibility: clients
+    # @note Support of service lists: no
+    # @example Get list of dedicated servers
+    #    RegApi2.service.get_dedicated_server_list
+    define :get_dedicated_server_list, field: :server_list
 
     # @!method update(opts = {})
     # Service configuration.
@@ -139,6 +209,17 @@ module RegApi2
     # @!method get_bills(opts = {})
     # Use this function to get a list of invoices associated with the defined services.
     # @param opts Options.
+    # @return [Hash] List of invoices associated with the defined services.
+    #
+    #    | Field | Description |
+    #    | ----- | ----------- |
+    #    | services | A list of requested services. |
+    #    | bills | A list of IDs of invoices associated with this service. |
+    #
+    # @note Accessibility: partners
+    # @note Support of service lists: yes
+    # @example Get invoices and services for `qqq.ru` domain.
+    #    RegApi2.service.get_bills dname: "qqq.ru"
     define :get_bills
 
     # @!method set_autorenew_flag(opts = {})

data/lib/reg_api2/version.rb

@@ -1,5 +1,5 @@
 # -*- encoding : utf-8 -*-
 module RegApi2
   # Gem version.
-  VERSION = "0.0.7".freeze
+  VERSION = "0.0.8".freeze
 end

data/lib/reg_api2.rb

@@ -15,18 +15,6 @@ require 'reg_api2/bill'
 require 'reg_api2/folder'
 require 'reg_api2/zone'
 
-# # REG.API v2
-# @example List of services by specified identifiers
-#  RegApi2.service.nop(services: [
-#    { dname:"test.ru" },
-#    { dname: "test.su", servtype: "srv_hosting_ispmgr" },
-#    { service_id: 111111 },
-#    { service_id: "22bug22" },
-#    { surprise: "surprise.ru" }
-#  ])
-#
-# ## RegApi2 module
-#
 # Provides r/w settings for API connection:
 #
 # * {RegApi2.username} - Your user name. `test` by default.
@@ -46,6 +34,16 @@ require 'reg_api2/zone'
 # * {RegApi2.zone} API category implemented as {RegApi2::Zone} methods.
 #
 # Please read {file:README.md} for API overview.
+#
+# @example List of services by specified identifiers
+#  RegApi2.service.nop(services: [
+#    { dname:"test.ru" },
+#    { dname: "test.su", servtype: "srv_hosting_ispmgr" },
+#    { service_id: 111111 },
+#    { service_id: "22bug22" },
+#    { surprise: "surprise.ru" }
+#  ])
+#
 
 module RegApi2
 

data/spec/lib/reg_api2/service_spec.rb

@@ -12,7 +12,7 @@ describe RegApi2::Service do
         { service_id: "22bug22" },
         { surprise: "surprise.ru" }
       ])
-      ans.services.map do |rec|
+      ans.map do |rec|
         rec.result == 'success' ? rec.dname : rec.error_code
       end.sort.should == %w[ INVALID_SERVICE_ID NO_DOMAIN test.ru test.su test12347.ru ]
     end
@@ -38,4 +38,36 @@ describe RegApi2::Service do
       ans.descr.should =~ /srv_hosting_ispmgr.+ordered/
     end
   end
+
+  describe :delete do
+    it "should remove srv_hosting_ispmgr service" do
+      ans = service.delete domain_name: 'test.ru', servtype: :srv_hosting_ispmgr
+      ans.should be_nil
+    end
+  end
+
+  describe :get_list do
+    it "should get list of domains" do
+      ans = service.get_list servtype: :domain
+      ans.should be_kind_of Array
+      ans.map(&:servtype).uniq.should == [ "domain"]
+      ans.map(&:service_id).each { |id| id.should be_kind_of Fixnum }
+    end
+  end
+
+  describe :get_dedicated_server_list do
+    it "should get list of dedicated servers" do
+      ans = RegApi2.service.get_dedicated_server_list
+      ans.should be_kind_of Array
+      ans.map(&:server_id).each { |id| id.should be_kind_of Fixnum }
+    end
+  end
+
+  describe :get_bills do
+    it "should get list of services and bills" do
+      ans = RegApi2.service.get_bills dname: "qqq.ru"
+      ans.services.should be_kind_of Array
+      ans.bills.should be_nil
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reg.api2
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-06 00:00:00.000000000 Z
+date: 2013-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -252,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3548838866357939780
+      hash: 1698904277702567800
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -261,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3548838866357939780
+      hash: 1698904277702567800
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24