yandex_domains 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b585be5a4b837cadbb735a27f9e015e382ae3daf
+  data.tar.gz: 9794d4a261ac075cce892c712b01ae64cef7134f
+SHA512:
+  metadata.gz: 2b89af835baa920e2e3929423467cc9b726fa113c09ecf1b82034443399afa67d3696c5ed6c6ad5c3138985a9f9cd88c63b9bc0ed4a58ce55606f7650004c839
+  data.tar.gz: 0c434f3406289682f91fd481101ea62449d97b6a8974750bbc157936f82cf47455fe339414b3bbb6a8a3893c71ce0055c90a2fd0271e6237eae20d0947d54ea4

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yandex_domains.gemspec
+gemspec

data/README.md

@@ -0,0 +1,39 @@
+# YandexDomains
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yandex_domains`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yandex_domains'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yandex_domains
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/yandex_domains/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "yandex_domains"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/yandex_domains.rb

@@ -0,0 +1,149 @@
+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 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”.
+    # @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

data/lib/yandex_domains/version.rb

@@ -0,0 +1,3 @@
+module YandexDomains
+  VERSION = "0.1.0"
+end

data/yandex_domains.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yandex_domains/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yandex_domains"
+  spec.version       = YandexDomains::VERSION
+  spec.authors       = ["Mehmet Beydogan"]
+  spec.email         = ["m@mehmet.pw"]
+
+  spec.summary       = %q{Ruby client for Yandex.Mail for Domains API}
+  spec.homepage      = "http://github.com/beydogan/yandex-domains"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "httparty", "~> 0.13.3"
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: yandex_domains
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mehmet Beydogan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-05-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+description: 
+email:
+- m@mehmet.pw
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yandex_domains.rb
+- lib/yandex_domains/version.rb
+- yandex_domains.gemspec
+homepage: http://github.com/beydogan/yandex-domains
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Ruby client for Yandex.Mail for Domains API
+test_files: []