yandex_domains 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 277c32eb2b75d01b8cca09f0773b346d765db57c
-  data.tar.gz: 310dc2aecdfd994aaf533a84b766895cd8e31f8c
+  metadata.gz: 127018646750b8e3798cf8c5cb800a0bd759318d
+  data.tar.gz: bffda633ad2060bc4f95911753a120b26f6cbb9b
 SHA512:
-  metadata.gz: 9daf3719232de306e16a54d90f37d64e85d9d202dbbc582d30a62e1a65828e97efce6a698fa913384d64ae89394e17b2c083e1be12d5abfba071e14625ac0615
-  data.tar.gz: e7e792b58a978042312ad074b3df0da1d5995d7d3ccc7ea517d3c3860bf8988c12cd94194371288df895dff80cf55d3f43ea1bfa490536a099d3f17df8185733
+  metadata.gz: 2b60972295ed099c6db31f36c8abbcc4fe0c52a7f94ffe6f9b4b38dea97b5811233f2b94f03a571419aa649af60f1e1399b86c46883846264333e1f520997309
+  data.tar.gz: 36d304596df2b16b874889463ad78ec0886d78da141ed5d2ee9c46b75d49e88c2da0ac703345f91036fccfa6c4a0f84cfb14c76b71d224f174563f1580ac97d1

data/Gemfile

@@ -2,3 +2,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in yandex_domains.gemspec
 gemspec
+
+group :test do
+  gem 'webmock'
+  gem 'yardstick'
+end
+gem 'pry'

data/README.md

@@ -17,12 +17,16 @@ And then execute:
 Or install it yourself as:
 
     $ gem install yandex_domains
+    
+## Documentation
+
+http://www.rubydoc.info/github/beydogan/yandex_domains/
 
 ## Usage
 
-This client works for only **Administrator** access. More details about Administrator user is [here](https://tech.yandex.com/domain/doc/concepts/termin-docpage/).  In order to use the client and API features, the PDD token is required. You can get a PDD token on the [token management](https://pddimp.yandex.ru/api2/admin/get_token)  page by entering a domain name that has already been verified.
+This client works with only **Administrator** access. More details about Administrator user is [here](https://tech.yandex.com/domain/doc/concepts/termin-docpage/).  In order to use the client and API features, the PDD token is required. You can get a PDD token on the [token management](https://pddimp.yandex.ru/api2/admin/get_token)  page by entering a domain name that has already been verified.
 
-** Initialize a client
+**Initialize a client**
 ```ruby
 client = YandexDomains::Client.new(pdd_token)
 ```
@@ -32,19 +36,21 @@ After configuring a client, you can do the followings.
 
 **Signing up a domain**
 ```ruby
-client.connect('google.com')
+client.connect_domain('google.com')
 ```
 
-** Adding a mailbox for a domain**
+**Adding a mailbox for a domain**
 ```ruby
 client.add_mailbox('google.com', 'hi', 'strongpassword')
 ```
 
-** Deleting a mailbox on a domain**
+**Deleting a mailbox on a domain**
 ```ruby
 client.delete_mailbox('google.com', 'hi')
 ```
 
+[More examples here](http://www.rubydoc.info/github/beydogan/yandex_domains/)
+
 ## Contributing
 
 1. Fork it ( https://github.com/beydogan/yandex_domains/fork )

data/lib/yandex_domains/admin/domain.rb

@@ -0,0 +1,48 @@
+module YandexDomains
+  module Admin
+    module Domain
+      # Used for signing up a domain.
+      # @param domain [String]
+      # @return [Hash]
+      # @see https://api.yandex.com.tr/kurum/doc/reference/domain-register.xml
+      def connect_domain(domain)
+        req = self.class.post("/admin/domain/register", {query: {domain: domain}})
+        req.parsed_response
+      end
+
+      # Used for getting the results of the last check, the date and time the check was performed,
+      # and the date and time of the next check.
+      # @param [String] domain
+      # @return [Hash] Parsed Response
+      # @see https://api.yandex.com.tr/kurum/doc/reference/domain-registrationstatus.xml
+      def registration_status(domain)
+        req = self.class.get("/admin/domain/registration_status", {query: {domain: domain}})
+        req.parsed_response
+      end
+
+      # Get current domain properties: the status of connecting and delegating the domain to Yandex,
+      # the mailbox interface language and design, and the POP and IMAP modes.
+      # @param [String] domain
+      # @return [Hash] Parsed Response
+      # @example Example Usage
+      #   client.details('google.com)
+      # @example Return Hash
+      #   {
+      #       "domain": "{domain name}",
+      #       "status": "{domain status}",
+      #       "stage": "{service key}",
+      #       "delegated": "{status of delegating domain to Yandex}",
+      #       "country": "{interface language}",
+      #       "imap_enabled": "{status of IMAP operation}",
+      #       "pop_enabled": "{status of POP operation}",
+      #       "default_theme": "{design theme ID}",
+      #       "success": "{status of request execution}"
+      #   }
+      # @see https://tech.yandex.com/domain/doc/reference/domain-details-docpage/
+      def details(domain)
+        req = self.class.get("/admin/domain/details", {query: {domain: domain}})
+        req.parsed_response
+      end
+    end
+  end
+end

data/lib/yandex_domains/admin/email.rb

@@ -0,0 +1,116 @@
+module YandexDomains
+  module Admin
+    module Email
+      # Used for adding a mailbox for the domain.
+      # @param domain [String] Name of the domain.
+      # @param login [String] The email address of the mailbox, in the format “username@domain.ru” or “username”.
+      # @param password [String] User's password.
+      #   The password must:
+      #   contain from 6 to 20 characters — Latin letters, numbers, and the symbols “!”, “@”, “#”, “$”, “%”, “^”, “&”, “*”, “(”, “)”, “_”, “-”, “+”, “:”, “;”, “,”, “.”
+      #   be different from the username.
+      # @return [Hash] Parsed Response
+      # @example Example create hi@google.com with strongpassword
+      #   client.add_mailbox('google.com', 'hi', 'strongpassword')
+      # @example Return Hash
+      #   {
+      #     "domain": "{domain name}",
+      #     "login":"{email address of the mailbox}",
+      #     "uid": "{mailbox ID}",
+      #     "success": "{status of request execution}"
+      #   }
+      #
+      # @see https://api.yandex.com.tr/kurum/doc/reference/email-add.xml
+      def add_mailbox(domain, login, password)
+        req = self.class.post("/admin/email/add", {query: {domain: domain, login: login, password: password}})
+        req.parsed_response
+      end
+
+      # Used for getting a list of the domain's mailboxes.
+      # @param domain [String] Name of the domain.
+      # @param options [Hash]
+      # @option options [Integer] :page Page number in the response. The default value is 1. #TODO
+      # @option options [Integer] :on_page Number of mailboxes on each response page. The default value is 30. #TODO
+      # @return [Hash]
+      # @see https://tech.yandex.com/domain/doc/reference/email-list-docpage/
+      # @todo Add support for options
+      def get_mailboxes(domain, options = {})
+        req = self.class.get("/admin/email/list", {query: {domain: domain}})
+        req.parsed_response['accounts']
+      end
+
+      # Used for editing mailbox parameters: password, user's first and last name, and so on.
+      # @param domain [String] Name of the domain.
+      # @param login [String] The email address of the mailbox, in the format “username@domain.com” or “username”.
+      # @param options [Hash]
+      # @option options [String] :password User's new password.
+      # @option options [String] :iname User's first name.
+      # @option options [String] :fname User's last name.
+      # @option options [String] :enabled Whether the mailbox is enabled.
+      #   Possible values:
+      #   yes — Mailbox is enabled
+      #   no — Mailbox is blocked (for example, due to spam distribution or suspected hacking).
+      # @option options [Integer] :birth_date User's date of birth in the format YYYY-MM-DD.
+      # @option options [Integer] :sex User's gender.
+      #   Possible values:
+      #   0 — Not specified.
+      #   1 — Male.
+      #   2 — Female.
+      # @option options [Integer] :hintq Secret question.
+      # @option options [Integer] :hinta Answer to the secret question.
+      # @return [Hash]
+      # @example Example Usage
+      #   client.update_mailbox('google.com', 'hi', {sex: 0, birth_date: "1998-09-04"})
+      # @example Example Response
+      #   {
+      #       "domain": "{domain name}",
+      #       "login":"{email address of the mailbox}",
+      #       "uid": "{mailbox ID}",
+      #       "success": "{status of request execution}",
+      #       "account":
+      #       {
+      #           "uid": "{mailbox ID}",
+      #           "iname": "{user's name}",
+      #           "sex": "{user's gender}",
+      #           "ready": "{mailbox readiness}",
+      #           "hintq": "{pet's favorite food ???}",
+      #           "aliases":
+      #           [
+      #               "{alias name}",
+      #           ...
+      #           ],
+      #           "enabled": "{whether mailbox is working}",
+      #           "maillist": "{mailing list flag}",
+      #           "fname": "{user's last name}",
+      #           "birth_date": "{user's date of birth}",
+      #           "login": "{mailbox email address}",
+      #           "fio": "{user's full name}"
+      #       }
+      #   }
+      # @see https://tech.yandex.com/domain/doc/reference/email-edit-docpage/
+      def update_mailbox(domain, login, options = {})
+        query = {domain: domain, login: login}
+        query = query.merge(options)
+        req = self.class.post("/admin/email/edit", query: query)
+        req.parsed_response
+      end
+
+      # Used for deleting a mailbox on a domain
+      # @param domain [String] Name of the domain.
+      # @param login [String] The email address of the mailbox, in the format “username@domain.com” or “username”.
+      # @return [Hash] Parsed Response
+      # @example Example Usage
+      #   client.delete_mailbox('google.com', 'hi')
+      # @example Example Response
+      #   {
+      #       "domain": "{domain name}",
+      #       "login":"{mailbox address}",
+      #       "success": "{status of request execution}"
+      #   }
+      # @see https://api.yandex.com.tr/kurum/doc/reference/email-del.xml
+      def delete_mailbox(domain, login)
+        req = self.class.post("/admin/email/del", {query: {domain: domain, login: login}})
+        req.parsed_response
+      end
+    end
+  end
+end

data/lib/yandex_domains/client.rb

@@ -0,0 +1,24 @@
+require "yandex_domains/version"
+require "yandex_domains/admin/domain"
+require "yandex_domains/admin/email"
+require "httparty"
+
+module YandexDomains
+  class Client
+    include HTTParty
+    attr_accessor :pdd_token
+    base_uri 'https://pddimp.yandex.ru/api2'
+
+    # Initializes a new Client
+    #
+    # @param pdd_token [String]
+    # @return [YandexDomains::Client]
+    def initialize(pdd_token)
+      self.pdd_token = pdd_token
+      self.class.headers 'PddToken' => pdd_token
+    end
+
+    include YandexDomains::Admin::Domain
+    include YandexDomains::Admin::Email
+  end
+end

data/lib/yandex_domains/version.rb

@@ -1,3 +1,3 @@
 module YandexDomains
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/lib/yandex_domains.rb

@@ -1,149 +1 @@
-require "yandex_domains/version"
-require "httparty"
-
-module YandexDomains
-  class Client
-    include HTTParty
-    attr_accessor :pdd_token
-    base_uri 'https://pddimp.yandex.ru/api2'
-
-    # Initializes a new Client
-    #
-    # @param pdd_token [String]
-    # @return [YandexDomains::Client]
-    def initialize(pdd_token)
-      self.pdd_token = pdd_token
-      self.class.headers 'PddToken' => pdd_token
-    end
-
-    # Used for signing up a domain.
-    # @param domain [String]
-    # @return [Hash]
-    # @see https://api.yandex.com.tr/kurum/doc/reference/domain-register.xml
-    def connect_domain(domain)
-      req = self.class.post("/admin/domain/register", {query: {domain: domain}})
-      req.parsed_response
-    end
-
-    # The request is used for getting the results of the last check, the date and time the check was performed,
-    # and the date and time of the next check.
-    # @param [String] domain
-    # @return [Hash] Parsed Response
-    # @see https://api.yandex.com.tr/kurum/doc/reference/domain-registrationstatus.xml
-    def registration_status(domain)
-      req = self.class.get("/admin/domain/registration_status", {query: {domain: domain}})
-      req.parsed_response
-    end
-
-    # Used for adding a mailbox for the domain.
-    # @param domain [String] Name of the domain.
-    # @param login [String] The email address of the mailbox, in the format “username@domain.ru” or “username”.
-    # @param password [String] User's password.
-    #   The password must:
-    #   contain from 6 to 20 characters — Latin letters, numbers, and the symbols “!”, “@”, “#”, “$”, “%”, “^”, “&”, “*”, “(”, “)”, “_”, “-”, “+”, “:”, “;”, “,”, “.”
-    #   be different from the username.
-    # @return [Hash] Parsed Response
-    # @example Example create hi@google.com with strongpassword
-    #   client.add_mailbox('google.com', 'hi', 'strongpassword')
-    # @example Return Hash
-    #   {
-    #     "domain": "{domain name}",
-    #     "login":"{email address of the mailbox}",
-    #     "uid": "{mailbox ID}",
-    #     "success": "{status of request execution}"
-    #   }
-    #
-    # @see https://api.yandex.com.tr/kurum/doc/reference/email-add.xml
-    def add_mailbox(domain, login, password)
-      req = self.class.post("/admin/email/add", {query: {domain: domain, login: login, password: password}})
-      req.parsed_response
-    end
-
-    # Used for getting a list of the domain's mailboxes.
-    # @param domain [String] Name of the domain.
-    # @param options [Hash]
-    # @option options [Integer] :page Page number in the response. The default value is 1. #TODO
-    # @option options [Integer] :on_page Number of mailboxes on each response page. The default value is 30. #TODO
-    # @return [Hash]
-    # @see https://tech.yandex.com/domain/doc/reference/email-list-docpage/
-    # @todo Add support for options
-    def get_mailboxes(domain, options = {})
-      req = self.class.get("/admin/email/list", {query: {domain: domain}})
-      req.parsed_response['accounts']
-    end
-
-    # Used for editing mailbox parameters: password, user's first and last name, and so on.
-    # @param domain [String] Name of the domain.
-    # @param login [String] The email address of the mailbox, in the format “username@domain.com” or “username”.
-    # @param options [Hash]
-    # @option options [String] :password User's new password.
-    # @option options [String] :iname User's first name.
-    # @option options [String] :fname User's last name.
-    # @option options [String] :enabled Whether the mailbox is enabled.
-    #   Possible values:
-    #   yes — Mailbox is enabled
-    #   no — Mailbox is blocked (for example, due to spam distribution or suspected hacking).
-    # @option options [Integer] :birth_date User's date of birth in the format YYYY-MM-DD.
-    # @option options [Integer] :sex User's gender.
-    #   Possible values:
-    #   0 — Not specified.
-    #   1 — Male.
-    #   2 — Female.
-    # @option options [Integer] :hintq Secret question.
-    # @option options [Integer] :hinta Answer to the secret question.
-    # @return [Hash]
-    # @example Example Usage
-    #   client.update_mailbox('google.com', 'hi', {sex: 0, birth_date: "1998-09-04"})
-    # @example Example Response
-    #   {
-    #       "domain": "{domain name}",
-    #       "login":"{email address of the mailbox}",
-    #       "uid": "{mailbox ID}",
-    #       "success": "{status of request execution}",
-    #       "account":
-    #       {
-    #           "uid": "{mailbox ID}",
-    #           "iname": "{user's name}",
-    #           "sex": "{user's gender}",
-    #           "ready": "{mailbox readiness}",
-    #           "hintq": "{pet's favorite food ???}",
-    #           "aliases":
-    #           [
-    #               "{alias name}",
-    #           ...
-    #           ],
-    #           "enabled": "{whether mailbox is working}",
-    #           "maillist": "{mailing list flag}",
-    #           "fname": "{user's last name}",
-    #           "birth_date": "{user's date of birth}",
-    #           "login": "{mailbox email address}",
-    #           "fio": "{user's full name}"
-    #       }
-    #   }
-    # @see https://tech.yandex.com/domain/doc/reference/email-edit-docpage/
-    def update_mailbox(domain, login, options = {})
-      query = {domain: domain, login: login}
-      query = query.merge(options)
-      req = self.class.post("/admin/email/edit", query: query)
-      req.parsed_response
-    end
-    # Used for deleting a mailbox on a domain
-    # @param domain [String] Name of the domain.
-    # @param login [String] The email address of the mailbox, in the format “username@domain.com” or “username”.
-    # @return [Hash] Parsed Response
-    # @example Example Usage
-    #   client.delete_mailbox('google.com', 'hi')
-    # @example Example Response
-    #   {
-    #       "domain": "{domain name}",
-    #       "login":"{mailbox address}",
-    #       "success": "{status of request execution}"
-    #   }
-    # @see https://api.yandex.com.tr/kurum/doc/reference/email-del.xml
-    def delete_mailbox(domain, login)
-      req = self.class.post("/admin/email/del", {query: {domain: domain, login: login}})
-      req.parsed_response
-    end
-
-  end
-end
+require "yandex_domains/client"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yandex_domains
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Mehmet Beydogan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-05-29 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,6 +68,9 @@ files:
 - bin/console
 - bin/setup
 - lib/yandex_domains.rb
+- lib/yandex_domains/admin/domain.rb
+- lib/yandex_domains/admin/email.rb
+- lib/yandex_domains/client.rb
 - lib/yandex_domains/version.rb
 - yandex_domains.gemspec
 homepage: http://github.com/beydogan/yandex-domains
@@ -95,3 +98,4 @@ signing_key:
 specification_version: 4
 summary: Ruby client for Yandex.Mail for Domains API
 test_files: []
+has_rdoc: