reg.api2 0.0.4 → 0.0.5

data/README.md

@@ -98,6 +98,16 @@ We hope that this information will be useful for you and that it will help you t
 
 ## REG.API 2.0 overview
 
+### Method accessibility
+
+All REG.API methods can be divided into categories of accessibility. On Ruby documentation accessibility marked by note. At the moment the following categories of accessibility present:
+
+| Category | Description |
+|----------|-------------|
+| everyone | All methods tagged by this one are accessible to all users. Those methods does not require authentication before call. |
+| clients  | This tag indicates the methods which accessible only for users registered on REG.API provider. Strongly required an authenticated API request. |
+| partners | Group of methods which accessible only for partners (resellers) of the REG.API provider (REG.RU LLC). Actually, partners (resellers) able to execute all methods of the REG.API without any restrictions. |
+
 ### Service identification parameters
 This group of parameters serves for identification of specific pre-ordered services.
 

data/lib/reg_api2/domain.rb

@@ -8,14 +8,14 @@ module RegApi2
     category :domain
 
     # @!method nop(opts = {})
-    # @param [Hash] opts
+    # @param [Hash] opts Options.
     # @option opts [String] :dname Domain name to check.
     # For testing purposes. Also, with the help of this function you can check accessibility of a domain and get its ID. For this, pass username+password+dname.
     # @return [NilClass or String] nil or Domain identifier, available only when the domain name is passed in the field domain_name/dname.
     define :nop
 
     # @!method get_prices(opts = {})
-    # @param [Hash] opts
+    # @param [Hash] opts Options.
     # @option opts [Fixnum] :show_renew_data With this flag enabled the System will return the price of registration renewal (1/0). Optional field.
     # @option opts [Fixnum] :show_update_data Флаг возврата цен для обновления домена (1/0). Необязательное поле.
     # @option opts [String] :currency Identifier of the currency in which the prices will be quoted: RUR (default), UAH, USD, EUR. Optional field.
@@ -26,70 +26,174 @@ module RegApi2
     define :get_prices
 
     # @!method get_suggest(opts = {})
-    define :get_suggest
+    # @param [Hash] opts Options.
+    # Suggest a domain name using keywords. The function is similar to the [Reg.Choice](https://www.reg.com/domain/new/choose) service.
+    # @option opts [String] :word Main keyword. For example, «domain». Mandatory field.
+    # @option opts [String] :additional_word Additional keyword. For example, «new» or «best». Optional field.
+    # @option opts [String/Symbol] :category The category of picked up names. Valid values: `pattern` — names matching defined patterns («name + prefix»), `search_trends` – current search trends, `all` (default) – all categories.
+    # @option opts [String/Array<String>] :tlds The zone in which the domain name should be checked for availability. Valid zones: `ru`, `рф`, `su`, `com`, `net`, `org`, `biz`, `info`. If a request does not contain a single `tlds` field, the domains will be searched in all the above-mentioned zones.
+    # @option opts [Boolean] :use_hyphen Use hyphens to delimit words in domain names (for example, “best- domain”). Valid values: `false` (do not use hyphens) and `true` (use hyphens). By default hyphens are not used (“bestdomain”).
+    # @option opts [Boolean] :use_plural Suggest plural forms for domain names. Valid values: `false` (do not suggest plural forms) and `true` (suggest plural forms). Optional field.
+    # @return [Array<Hash(name, avail_in)>] An array with domain name alternatives. Each element includes the field `name` (name alternative) and the array `avail_in` with a list of zones in which this name is available for registration. Maximum array size: 100.
+    # @example Suggest for `house` and `new`
+    #    RegApi2.domain.get_suggest word: 'house', additional_word: 'new', use_hyphen: false, tlds: [ :ru ]
+    # @note Accessibility: partners
+    # @note Support of service lists: no
+    define :get_suggest, required: %w[ word ], field: :suggestions
 
     # @!method get_premium(opts = {})
-    define :get_premium
+    # Gets the list of available premium domain registration, the function works like the [Reg.Premium](https://www.reg.com/domain/new/premiumdomains) service
+    # @param [Hash] opts Options.
+    # @note Accessibility: partners
+    # @note Support of service lists: no
+    define :get_premium, field: :domains
+
+    # @!method get_deleted(opts = {})
+    # Get a list of deleted domains. The function is similar to the [Deleted Domains](https://www.reg.com/domain/new/freeing_domains) page.
+    # @param [Hash] opts Options.
+    # @note Accessibility: partners
+    # @note Support of service lists: no
+    define :get_deleted, field: :domains
 
     # @!method check(opts = {})
-    define :check
+    # This function serves to check availability of domains for registration.
+    # @param [Hash] opts Options.
+    # @note Accessibility: partners
+    # @note Support of service lists: yes
+    define :check, field: :domains
 
     # @!method create(opts = {})
+    # Apply for domain name registration.
+    # @param [Hash] opts Options.
+    # @note Accessibility: clients
+    # @note Support of service lists: For privileged clients only
     define :create
 
     # @!method transfer(opts = {})
+    # With the help of this function you can apply for a transfer of a domain from another registrar.
+    # @param [Hash] opts Options.
+    # @note Accessibility: clients
+    # @note Support of service lists: For privileged clients only
     define :transfer
 
     # @!method get_rereg_data(opts = {})
+    # Use this function to get a list of “to be released” domains and their details. The data is updated every 90 minutes.
+    # @param [Hash] opts Options.
+    # @note Accessibility: clients
+    # @note Support of service lists: no
     define :get_rereg_data
 
     # @!method set_rereg_bids(opts = {})
+    # Use this function to place bids for “to be released” domains. Click [here](https://www.reg.com/domain/new/rereg) for details.
+    # @param [Hash] opts Options.
+    # @note Accessibility: clients. Partners can make an advance payment in the amount of 225 rub. and to pay the balance upon the successful fulfillment of the application for registration within 10 days of its execution (see the instalment parameter below). In case of choosing this payment procedure the domain will be registered, and after payment of the full amount it will be re-registered automatically on the specified data. In case of payment violation of the full amount by the due date, the pre-payment will be considered as firfeit and will not be refunded. See more information: Clauses 2.16, 2.17, 3.2.9, 6.11 of the agreement.
+    # @note Support of service lists: yes
     define :set_rereg_bids
 
     # @!method get_user_rereg_bids(opts = {})
+    # Use this function to get the list with information about bids placed on them. The list also includes domains with overbids.
+    # @param [Hash] opts Options.
+    # @note Accessibility: clients.
+    # @note Support of service lists: yes
     define :get_user_rereg_bids
 
     # @!method get_docs_upload_uri(opts = {})
+    # Use this function to get a hyperlink for uploading documents on .RU/.SU/.РФ domains.
+    # @param [Hash] opts Options.
+    # @note Accessibility: clients.
+    # @note Support of service lists: no
     define :get_docs_upload_uri
 
     # @!method update_contacts(opts = {})
+    # @param [Hash] opts Options.
+    # With the help of this function you can make changes in the domain contact data.
+    # @note Accessibility: clients.
+    # @note Support of service lists: yes
     define :update_contacts
 
     # @!method update_private_person_flag(opts = {})
-    define :update_private_person_flag
+    # Use this function to change settings of the Private Person and Total Private Person flags (show/hide contact data in WHOIS).
+    # @param [Hash] opts Options.
+    # @note Accessibility: clients.
+    # @note Support of service lists: yes
+     define :update_private_person_flag
 
     # @!method register_ns(opts = {})
+    # Domain registration in the NSI registry (for internatonal domains only).
+    # @param [Hash] opts Options.
+    # @note Accessibility: everyone.
+    # @note Support of service lists: no
     define :register_ns
 
     # @!method delete_ns(opts = {})
+    # Deletion of a domain from the NSI registry (for international domains only).
+    # @param [Hash] opts Options.
+    # @note Accessibility: everyone.
+    # @note Support of service lists: no
     define :delete_ns
 
     # @!method get_nss(opts = {})
+    # You can use this function to get DNSs for domains.
+    # @param [Hash] opts Options.
+    # @note Accessibility: clients.
+    # @note Support of service lists: yes
     define :get_nss
 
     # @!method update_nss(opts = {})
-    define :update_nss
+    # Use this function to change DNS servers of the domain. Also this function enables/disables domain delegation (for partners only).
+    # @param [Hash] opts Options.
+    # @note Accessibility: clients.
+    # @note Support of service lists: yes
+    define :update_nss, field: :domains
 
     # @!method delegate(opts = {})
+    # Use this this function to set the domain delegation flag.
+    # @param [Hash] opts Options.
+    # @note Accessibility: partners.
+    # @note Support of service lists: yes
     define :delegate
 
     # @!method undelegate(opts = {})
+    # Use this flag to clear the domain delegation flag.
+    # @param [Hash] opts Options.
+    # @note Accessibility: partners.
+    # @note Support of service lists: yes
     define :undelegate
 
     # @!method transfer_to_another_account(opts = {})
-    define :transfer_to_another_account
+    # Full transfer of a domain to another account.
+    # @param [Hash] opts Options.
+    # @note Accessibility: partners.
+    # @note Support of service lists: yes
+    define :transfer_to_another_account, field: :domains
 
     # @!method look_at_entering_list(opts = {})
-    define :look_at_entering_list
+    # Use this function to view the list of domains transferred to this account.
+    # @param [Hash] opts Options.
+    # @note Accessibility: partners.
+    # @note Support of service lists: yes
+    define :look_at_entering_list, field: :messages
 
     # @!method accept_or_refuse_entering_list(opts = {})
-    define :accept_or_refuse_entering_list
+    # Accept or decline domains transferred to this account.
+    # @param [Hash] opts Options.
+    # @note Accessibility: partners.
+    # @note Support of service lists: yes
+    define :accept_or_refuse_entering_list, field: :domains
 
     # @!method cancel_transfer(opts = {})
+    # Use this function for cancelling domain transfers
+    # @param [Hash] opts Options.
+    # @note Accessibility: partners.
+    # @note Support of service lists: yes
     define :cancel_transfer
 
     # @!method request_to_transfer(opts = {})
-    define :request_to_transfer
+    # Send request to domain transfer.
+    # @param [Hash] opts Options.
+    # @note Accessibility: partners.
+    # @note Support of service lists: no
+    define :request_to_transfer, field: :domains
 
     extend self
   end

data/lib/reg_api2/service.rb

@@ -9,7 +9,7 @@ module RegApi2
 
     # @!method nop(opts = {})
     # Return list of specified services with its stats if specified.
-    # @param opts
+    # @param opts Options.
     # @option opts [Array] services
     # @return [Hash("services" => [])]
     # @example List of services by specified identifiers
@@ -24,7 +24,7 @@ module RegApi2
 
     # @!method get_prices(opts = {})
     # Get services registration/renewal prices.
-    # @param opts
+    # @param opts Options.
     # @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.
@@ -35,7 +35,7 @@ module RegApi2
     # @!method get_servtype_details(opts = {})
     # Use this function to get prices for services and general data.
     # @note To obtain prices for several service types, you can define them in the servtype field delimiting them with commas or include several servtype fields into the request. In this case the field subtype is ignored.
-    # @param opts
+    # @param opts Options.
     # @option opts [String, Symbol] :servtype Type of service: srv_webfwd — web forwarding, srv_parking — domain parking, srv_dns_both — DNS support, srv_hosting_ispmgr — hosting, srv_certificate — domain certificate, srv_voucher — domain voucher, srv_kvm — KVM access.
     # @option opts [String, Symbol] :subtype Service subtype.
     # @option opts [Boolean] :unroll_prices Show prices in expanded form.
@@ -70,6 +70,7 @@ module RegApi2
     #
     # 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.
     # @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.
@@ -90,57 +91,98 @@ module RegApi2
     define :create, required: %w[ servtype ]
 
     # @!method delete(opts = {})
+    # Removes the service.
+    # @param opts Options.
     define :delete, required: %w[ servtype ]
 
     # @!method get_info(opts = {})
+    # Use this function to obtain information about all services.
+    # @param opts Options.
     define :get_info
 
     # @!method get_list(opts = {})
+    # Use this function to obtain a list of active services.
+    # @param opts Options.
     define :get_list
 
     # @!method get_folders(opts = {})
+    # Use this function to get the list of folders the service is associated with.
+    # @param opts Options.
     define :get_folders
 
     # @!method get_details(opts = {})
+    # Use this function to get detailed information about the service, including contact data for domains.
+    # @param opts Options.
     define :get_details
 
     # @!method service_get_details(opts = {})
+    # @deprecated Use {#get_info} instead.
+    # You can use this function to obtain general information about the ordered service, as well as additional data about the hosting and web forwarding services. It is an obsolete function. For the major part of service it is advisable to use the {#get_info} function instead.
+    # @param opts Options.
     define :service_get_details
 
     # @!method get_dedicated_server_list(opts = {})
+    # Get the dedicated server list.
+    # @param opts Options.
     define :get_dedicated_server_list
 
     # @!method update(opts = {})
+    # Service configuration.
+    # @param opts Options.
     define :update
 
     # @!method renew(opts = {})
+    # Domain or service renewal.
+    # @param opts Options.
     define :renew
 
     # @!method get_bills(opts = {})
+    # Use this function to get a list of invoices associated with the defined services.
+    # @param opts Options.
     define :get_bills
 
     # @!method set_autorenew_flag(opts = {})
+    # Enables or disables automatic service renewal.
+    # @param opts Options.
     define :set_autorenew_flag
 
     # @!method suspend(opts = {})
+    # Use this function to suspend services (for domains – suspend delegation).
+    # @param opts Options.
     define :suspend
 
     # @!method resume(opts = {})
+    # Use this function to resume services (for domains – resume domain delegation).
+    # @param opts Options.
     define :resume
 
     # @!method get_depreciated_period(opts = {})
+    # Use this function to calculate the number of periods till the service expiration date.
+    # @param opts Options.
     define :get_depreciated_period
 
     # @!method upgrade(opts = {})
+    # This function upgrades service subtypes (rate plans). It can be used for changes of rate plans for virtual hosting ("srv_hosting_ispmgr"), VPS servers("srv_vps") and Additional Disk Space for VPS ("srv_disk_space").
+    # @param opts Options.
     define :upgrade
 
     # @!method partcontrol_grant(opts = {})
+    # You can use this function to grant a part of service management rights to other users.
+    # @param opts Options.
     define :partcontrol_grant
 
     # @!method partcontrol_revoke(opts = {})
+    # Use this function to stop granting service management rights to other.
+    # @param opts Options.
     define :partcontrol_revoke
 
     # @!method resend_mail(opts = {})
+    # Resend mail to user.
+    # @param opts Options.
+    # @option opts [Array] mailtype Email type: `approver_email` — approve ssl certificate order, `certificate_email` — certificate email.
+    # @return [Hash(service_id, dname)]
+    # @example Resend mail.
+    #    RegApi2.service.resend_mail servtype: :srv_ssl_certificate
     define :resend_mail
 
     extend self

data/lib/reg_api2/version.rb

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

data/reg.api2.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rr"
   spec.add_development_dependency "faker"
   spec.add_development_dependency "machinist"
-  spec.add_development_dependency "yard"
-  spec.add_development_dependency "redcarpet"
-  spec.add_development_dependency "yard-redcarpet-ext"
+  spec.add_development_dependency "yard", "~> 0.8"
+  spec.add_development_dependency "redcarpet", "~> 3.0"
+  spec.add_development_dependency "yard-redcarpet-ext", "~> 0.0.3"
 end

data/spec/lib/reg_api2/domain_spec.rb

@@ -23,4 +23,11 @@ describe RegApi2::Domain do
       prices.currency.should == 'USD'
     end
   end
+
+  describe :get_suggest do
+    it "should return suggestions" do
+      ans = domain.get_suggest word: 'house', additional_word: 'new', use_hyphen: false, tlds: [ :ru ]
+      ans.should be_kind_of(Array)
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reg.api2
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-01 00:00:00.000000000 Z
+date: 2013-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yajl-ruby
@@ -144,49 +144,49 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: yard-redcarpet-ext
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.0.3
 description: REG.API v2 Implementation
 email:
 - akzhan.abdulin@gmail.com
@@ -198,7 +198,6 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
-- .yard_redcarpet_ext
 - .yardopts
 - Gemfile
 - LICENSE
@@ -253,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 784159006101606174
+      hash: -3976809343195065454
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -262,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 784159006101606174
+      hash: -3976809343195065454
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/.yard_redcarpet_ext

@@ -1 +0,0 @@
-tables