reg.api2 0.0.5 → 0.0.6

data/README.md

@@ -61,9 +61,10 @@ Your default username: "test", and You can change it with "~/.regapi2".
 ```
 
 ## Recommendations for effective use of REG.API
+
 This section provides information that will help you to make you work with REG.API more productive and convenient.
 
-One of the most frequent problems our partners face when working with REG.API is exceeding the maximum request limit (1,200 requests per hour).
+One of the most frequent problems our partners face when working with REG.API is exceeding the maximum request limit (1,200 requests per hour for user/ip). Both limits are acting at the same time. If the limits has exceeded then REG.API sets the error code (depends on kind of) to `IP_EXCEEDED_ALLOWED_CONNECTION_RATE` or `ACCOUNT_EXCEEDED_ALLOWED_CONNECTION_RATE`, that raised by client as exception of {RegApi2::ApiError} class.
 
 The analysis of such situations showed that in most cases such problems are the results of improper use or misuse of REG.API due to bugs or design faults in the software used by partners.
 
@@ -92,12 +93,20 @@ The recommendations below will, on the one hand, allow you to preclude situation
   * In case of connection failures the request can be repeated until it is executed (this significantly increases the system reliability).
   * In case of request processing errors (if REG.RU returned an error code), you can fix the problem and repeat the request, while the customer will not get any error messages. You can solve the major part of your customers’ problems on your own without their participation.
 
-4. It is a good practice to keep logs of all API request and responses. If a problem arises, logs will help you or our support engineers to efficiently locate and solve it.
+4. Use bulk operations whenever possible. A lot of methods support operations over lists of services and domains at once.
+
+5. It is a good practice to keep logs of all API request and responses. If a problem arises, logs will help you or our support engineers to efficiently locate and solve it.
 
 We hope that this information will be useful for you and that it will help you to optimize your work with REG.API.
 
 ## REG.API 2.0 overview
 
+### General interaction principles
+
+Each call of a function is atomic and synchronous, i.e. all requests are independent. All operations are also synchronous: the result of an operation returns immediately, there are no any intermediate stages during execution of operations. The choice in favor of this interaction method was made to simplify the customers’ work flow with REG.API.
+
+Parallel processing of calls is available to requests not changing balance of the client on the account of REG.API provider.
+
 ### 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:
@@ -160,6 +169,79 @@ This section describes the parameters common for the functions dealing with serv
 | pay_type | Payment option. Currently available payment options: (WM, bank, pbank, prepay, yamoney, rapida, robox, paymer, cash, chronopay). Default value: prepay. Please note that automatic payments can be done only if the selected payment method is «prepay» and you have enough funds in your account. Otherwise, your order will be marked as unpaid and you will have to arrange the payment manually from your profile page. |
 | ok_if_no_money | Enable to create bill when not enough funds to complete the operation. In this case requested operation is stored in the system, however it will be processed after submitting "change payment method" request via web interface. Return error if this flag not set and not enough funds to complete the operation. |
 
+### Common error codes
+
+Error code from REG.API raised by client as exception of {RegApi2::ApiError} class. Test its `message` or `to_s` to know what happens.
+
+| Error_code | Description |
+|------------|-------------|
+| | **Authorization errors** |
+| NO_USERNAME | Username is not specified. |
+| NO_AUTH | Method of authorization is not determined (probably, the password or signature fields are not found). |
+| PASSWORD_AUTH_FAILED | Password authentification failed. |
+| RESELLER_AUTH_FAILED | This function is available only for the Partners. |
+| ACCESS_DENIED | Your access to the API is blocked, please refer to the technical support. |
+| PURCHASES_DISABLED | Buying/selling is forbidden for the given account. |
+| | **Errors of domains, services, folders identification** |
+| DOMAIN_NOT_FOUND | Domain `domain_name` is not found, or you are not the owner. |
+| SERVICE_NOT_FOUND | Service `servtype` for domain `domain_name` is not found. |
+| SERVICE_NOT_SPECIFIED | Error of the service identification. |
+| SERVICE_ID_NOT_FOUND | Service `service_id` is not found, or you are not the owner. |
+| NO_DOMAIN | domain_name is not specified or blank |
+| INVALID_DOMAIN_NAME_FORMAT | Format domain_name is not valid or domain is in unserviced TLD. |
+| INVALID_SERVICE_ID | Format of service_id is not valid.
+| INVALID_DOMAIN_NAME_PUNYCODE | The value of punycode for domain_name is not valid. |
+| BAD_USER_SERVID | Invalid value for user_servid. |
+| USER_SERVID_IS_NOT_UNIQUE | Non-unique field value user_servid at service/domain order. |
+| TOO_MANY_OBJECTS_IN_ONE_REQUEST | Too many objects are indicated (more than 1000) in one request. |
+| | **Accessibility errors** |
+| SERVICE_UNAVAILABLE | Reg.API is temporarily unavailable |
+| BILLING_LOCK | You have another active connection for financial operation to Reg.API |
+| DOMAIN_BAD_NAME | Not valid name: `domain_name` |
+| DOMAIN_BAD_NAME_ONLYDIGITS | Domain registration, which name contains only numbers is not acceptable for the given TLD |
+| HAVE_MIXED_CODETABLES | It is unacceptable to mix national and Latin letters in the domain name |
+| DOMAIN_BAD_TLD | Domain registration with `tld` extension is not available |
+| TLD_DISABLED | Domain registration with `tld` extension is disabled |
+| DOMAIN_NAME_MUSTBEENG | National letters are unacceptable in the domain name for the given extension (`tld`) |
+| DOMAIN_NAME_MUSTBERUS | Latin letters are unacceptable in the domain name for the given extension (`tld`) |
+| DOMAIN_ALREADY_EXISTS | The domain already exists, check via whois. |
+| DOMAIN_INVALID_LENGTH | Invalid length of the domain name, you have entered either too short or too long name |
+| DOMAIN_STOP_LIST | Unacceptable name, this domain is reserved, or it’s a premium-domain, which is offered at a special price |
+| DOMAIN_STOP_PATTERN | Unfortunately, it’s impossible to register the name (`domain_name`) |
+| FREE_DATE_IN_FUTURE | Domain’s release date of `domain_name` will be in future, AFTER the next date of the mass domain release |
+| NO_DOMAINS_CHECKED | You haven’t selected any domain for registration |
+| NO_CONTRACT | Filing an application for pre-term domain name registration is not possible after release before signing your contract about domain registration |
+| INVALID_PUNYCODE_INPUT | Incorrect punycode name (error at the process of coding into Punycode) |
+| CONNECTION_FAILED | Unable to check status of the domain: Can not connect the server. Please, try again later. |
+| DOMAIN_ALREADY_ORDERED | Domain name `domain_name` has been already ordered by you before, You can pay for it, and the application for registration shall be done. |
+| DOMAIN_EXPIRED | Unfortunately, the period of domain delegation of `domain_name` either has expired or will expire in the nearest future |
+| DOMAIN_TOO_YOUNG | Unfortunately, less than 60 days have passed from the moment of domain `domain_name` registration, try to transfer the domain later |
+| CANT_OBTAIN_EXPDATE | Impossible to determine the date of the domain delegation of `domain_name` |
+| DOMAIN_CLIENT_TRANSFER_PROHIBITED | Domain `domain_name` is prohibited for transfer, contact the previous registrar to unlock the domain |
+| DOMAIN_TRANSFER_PROHIBITED_UNKNOWN | Domain `domain_name` is prohibited for transfer by the upstream registrar, contact Technical Support for details |
+| DOMAIN_REGISTERED_VIA_DIRECTI | Automatic transfer of the domain name `domain_name` within DirectI is prohibited |
+| NOT_FOUND_UNIQUE_REQUIRED_DATA | The data for checking the uniqueness are not found: dname, servtype or user_id |
+| ORDER_ALREADY_PAYED | Order on `dname` `servtype` is already payed |
+| DOUBLE_ORDER | You already have not payed order on `dname` `servtype` |
+| DOMAIN_ORDER_LOCKED | The order of the domain is disabled since processing of other order for the same domain isn't completed yet |
+| UNAVAILABLE_DOMAIN_ZONE | `tld` is unavailable domain zone |
+| | **Errors at working with DNS servers** |
+| DOMAIN_IS_NOT_USE_REGRU_NSS | This domain does not use the DNS-server of REG.RU |
+| REVERSE_ZONE_API_NOT_SUPPORTED | Configuring of reverse zones are currently not supported |
+| ZONES_VARY | The domains in the list have different TLD configurations |
+| IP_INVALID | Error in IP address. |
+| SUBD_INVALID | Invalid subdomain |
+| CONFLICT_CNAME | It’s impossible to indicate CNAME logs for a single subdomain together with other logs |
+| | **Other errors** |
+| NO_SUCH_COMMAND | Command `command_name` is not found |
+| HTTPS_ONLY | Access to API via an unsecured interface (http) is prohibited! Please, use https. |
+| PARAMETER_MISSING | `param`('s) is (are) not found.
+| PARAMETER_INCORRECT | `param` has incorrect format or data. |
+| NOT_ENOUGH_MONEY | Not enough money at account for this operation. |
+| INTERNAL_ERROR | Internal error: `error_details`, inform the developers. |
+| SERVICE_OPERATIONS_DISABLED | Service operations are prohibited |
+| UNSUPPORTED_CURRENCY | Currency is not supported in the given system |
+
 ## Documentation
 
 Actual documentation available at https://www.reg.com/support/help/API-version2

data/lib/reg_api2/impl.rb

@@ -5,12 +5,14 @@ require 'net/https'
 require 'yajl'
 
 module RegApi2
-  # Networking Error
-  class NetError < Exception
+  # Networking Error.
+  # Raised when response doesn't meet HTTP 200 OK status.
+  class NetError < IOError
   end
 
-  # API Contract Error
-  class ContractError < Exception
+  # API Contract Error.
+  # Raised when input parameters doesn't pass Ruby client tests.
+  class ContractError < ArgumentError
     # @!attribute [r] fields
     # Wrong fields.
     attr_reader :fields
@@ -21,8 +23,9 @@ module RegApi2
     end
   end
 
-  # API Error
-  class ApiError < Exception
+  # API Error from REG.API provider.
+  # Please refer to {file:README.md#Common_error_codes common error codes}.
+  class ApiError < StandardError
     # @!attribute [r] description
     # Localized error description.
     attr_reader :description

data/lib/reg_api2/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reg.api2
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-04 00:00:00.000000000 Z
+date: 2013-10-06 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: -3976809343195065454
+      hash: -909380386582521799
 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: -3976809343195065454
+      hash: -909380386582521799
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24