yandex_domains 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b585be5a4b837cadbb735a27f9e015e382ae3daf
-  data.tar.gz: 9794d4a261ac075cce892c712b01ae64cef7134f
+  metadata.gz: 277c32eb2b75d01b8cca09f0773b346d765db57c
+  data.tar.gz: 310dc2aecdfd994aaf533a84b766895cd8e31f8c
 SHA512:
-  metadata.gz: 2b89af835baa920e2e3929423467cc9b726fa113c09ecf1b82034443399afa67d3696c5ed6c6ad5c3138985a9f9cd88c63b9bc0ed4a58ce55606f7650004c839
-  data.tar.gz: 0c434f3406289682f91fd481101ea62449d97b6a8974750bbc157936f82cf47455fe339414b3bbb6a8a3893c71ce0055c90a2fd0271e6237eae20d0947d54ea4
+  metadata.gz: 9daf3719232de306e16a54d90f37d64e85d9d202dbbc582d30a62e1a65828e97efce6a698fa913384d64ae89394e17b2c083e1be12d5abfba071e14625ac0615
+  data.tar.gz: e7e792b58a978042312ad074b3df0da1d5995d7d3ccc7ea517d3c3860bf8988c12cd94194371288df895dff80cf55d3f43ea1bfa490536a099d3f17df8185733

data/README.md

@@ -1,8 +1,6 @@
 # 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
+Ruby client for [Yandex.Mail for Domains API](https://tech.yandex.com/domain). 
 
 ## Installation
 
@@ -22,17 +20,34 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+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.
+
+** Initialize a client
+```ruby
+client = YandexDomains::Client.new(pdd_token)
+```
 
-## Development
+## Usage Examples
+After configuring a client, you can do the followings.
 
-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.
+**Signing up a domain**
+```ruby
+client.connect('google.com')
+```
 
-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).
+** Adding a mailbox for a domain**
+```ruby
+client.add_mailbox('google.com', 'hi', 'strongpassword')
+```
+
+** Deleting a mailbox on a domain**
+```ruby
+client.delete_mailbox('google.com', 'hi')
+```
 
 ## Contributing
 
-1. Fork it ( https://github.com/[my-github-username]/yandex_domains/fork )
+1. Fork it ( https://github.com/beydogan/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`)

data/lib/yandex_domains/version.rb

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

data/lib/yandex_domains.rb

@@ -127,7 +127,7 @@ module YandexDomains
       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.
+    # 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yandex_domains
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mehmet Beydogan