dnsimple-ruby 1.7.1 → 2.0.0

data/README.markdown

@@ -1,159 +0,0 @@
-# DNSimple Ruby Client
-
-A Ruby client for the [DNSimple API](http://developer.dnsimple.com/).
-
-[![Build Status](https://travis-ci.org/aetrion/dnsimple-ruby.svg?branch=master)](https://travis-ci.org/aetrion/dnsimple-ruby)
-[![Coverage Status](https://img.shields.io/coveralls/aetrion/dnsimple-ruby.svg)](https://coveralls.io/r/aetrion/dnsimple-ruby?branch=master)
-
-[DNSimple](https://dnsimple.com/) provides DNS hosting and domain registration that is simple and friendly.
-We provide a full API and an easy-to-use web interface so you can get your domain registered and set up with a minimal amount of effort.
-
-## Installation
-
-    $ gem install dnsimple-ruby
-
-## DNSimple Client
-
-This library provides a Ruby DNSimple client you can use to interact with the [DNSimple API](http://developer.dnsimple.com/). Here's a short example.
-
-```ruby
-require 'dnsimple'
-
-DNSimple::Client.username   = 'YOUR_USERNAME'
-DNSimple::Client.password   = 'YOUR_PASSWORD'
-
-user = DNSimple::User.me
-puts "#{user.domain_count} domains"
-
-puts "Domains..."
-DNSimple::Domain.all.each do |domain|
-  puts "  #{domain.name}"
-end
-
-domain = DNSimple::Domain.find("example.com")
-domain.apply("template") # applies a standard or custom template to the domain
-
-domain = DNSimple::Domain.create("newdomain.com")
-puts "Added #{domain.name}"
-domain.delete # removes from DNSimple
-```
-
-For the full API documentation visit http://rubydoc.info/gems/dnsimple-ruby
-
-### Authentication
-
-This client supports both the HTTP Basic and API Token authentication mechanism.
-
-#### HTTP Basic
-
-```ruby
-DNSimple::Client.username = 'YOUR_USERNAME'
-DNSimple::Client.password = 'YOUR_PASSWORD'
-
-user = DNSimple::User.me
-```
-
-#### HTTP Basic with two-factor authentication enabled
-
-See the [2FA API documentation](http://developer.dnsimple.com/authentication/#twofa).
-
-```ruby
-# Request the 2FA exchange token
-DNSimple::Client.username = 'YOUR_USERNAME'
-DNSimple::Client.password = 'YOUR_PASSWORD'
-token = DNSimple::User.two_factor_exchange_token('otp-token')
-
-# Authenticate with the exchange token
-DNSimple::Client.exchange_token = token
-user = DNSimple::User.me
-```
-
-#### API Token
-
-```ruby
-DNSimple::Client.api_token = 'the-token'
-
-user = DNSimple::User.me
-```
-
-
-## Credentials
-
-Create a file in your home directory called `.dnsimple`.
-
-In this file add the following:
-
-    username: YOUR_USERNAME
-    password: YOUR_PASSWORD
-
-Or if using an API token
-
-    username: YOUR_USERNAME
-    api_token: YOUR_API_TOKEN
-
-## Commands
-
-There are two ways to interact with the DNSimple Ruby wrapper. The first is
-to use the command line utility that is included. The commands available
-are as follows:
-
-For help:
-
-- dnsimple help
-
-The following commands are available for domains:
-
-- dnsimple list
-- dnsimple describe domain.com
-- dnsimple create domain.com
-- dnsimple register domain.com registrant_id
-- dnsimple transfer domain.com registrant_id [authinfo]
-- dnsimple delete domain.com
-- dnsimple apply domain.com template_short_name
-
-Please note that domain registration and transfer can only be done through the API for domains that do not require extended attributes. A future version of the API will add support for extended attributes.
-
-The following commands are available for records:
-
-- dnsimple record:create [--prio=priority] domain.com name type content [ttl]
-- dnsimple record:list domain.com
-- dnsimple record:delete domain.com record_id
-
-The following commands are available for custom templates:
-
-- dnsimple template:list
-- dnsimple template:create name short_name [description]
-- dnsimple template:delete short_name
-- dnsimple template:list_records short_name
-- dnsimple template:add_record short_name name type content [ttl] [prio]
-- dnsimple template:delete_record short_name template_record_id
-
-The following commands are available for managing contacts:
-
-- dnsimple contact:list
-- dnsimple contact:describe id
-- dnsimple contact:create [name:value name:value ...]
-- dnsimple contact:update id [name:value name:value ...]
-- dnsimple contact:delete id
-
-The following commands are available for purchasing certificates:
-
-- dnsimple certificate:purchase domain.com name contact_id
-- dnsimple certificate:submit id
-
-The contact name/value pairs are:
-
-- first_name
-- last_name
-- organization_name (optional)
-- job_title (required if organization name is specified)
-- address1
-- address2 (optional)
-- city
-- state_province (also aliased as state)
-- postal_code
-- country
-- email
-- phone
-- phone_ext (optional)
-- fax (optional)

data/bin/dnsimple

@@ -1,4 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'rubygems'
-require File.dirname(__FILE__) + '/dnsimple'

data/bin/dnsimple.rb

@@ -1,156 +0,0 @@
-#!/usr/bin/env ruby
-
-$:.unshift(File.dirname(__FILE__) + '/../lib')
-require 'dnsimple'
-require 'dnsimple/cli'
-
-cli = DNSimple::CLI.new
-
-require 'optparse'
-
-def usage
-  $stderr.puts <<EOF
-
-NOTICE: The CLI is moving out into its own repository and its own gem! Visit
-https://github.com/aetrion/dnsimple-cli
-
-This is a command line tool for DNSimple. More information about DNSimple can
-be found at http://dnsimple.com/
-
-Before using this tool you should create a file called .dnsimple in your home 
-directory and add the following to that file:
-
-username: YOUR_USERNAME
-password: YOUR_PASSWORD
-
-Alternatively you can pass the credentials via command-line arguments, as in:
-
-dnsimple -u username -p password command
-
-== Commands
-
-All commands are executed as dnsimple [options] command [command-options] args
-
-
-The following commands are available:
-
-help                                    # Show this usage
-
-info                                    # Show your account information
-
-check domain.com                                            # Check if a domain is available (for registration)
-create [--template=short_name] domain.com                   # Add the given domain
-register [--template=short_name] domain.com registrant_id \ # Register the given domain with DNSimple
-  [[name:value] [name:value]]                               # name:value pairs can be given for extended attributes
-transfer domain.com registrant_id [authinfo] \              # Transfer the given domain into DNSimple
-  [[name:value] [name:value] ...]                           # name:value pairs can be given for extended attributes
-describe domain.com                                         # Describe the given domain
-list                                                        # List all domains
-delete domain.com                                           # Delete the given domain
-clear domain.com                                            # Remove all records from the domain 
-apply domain.com template_short_name                        # Apply a template to the domain
-
-record:describe domain.com record_id                        # Describe the given record
-record:create [--prio=priority] domain.com name type \\
-  content [ttl]                                             # Create the DNS record on the domain
-record:list domain.com                                      # List all records for the domain
-record:update domain.com record_id \                        # Update a specific record
-  [[name:value] [name:value] ...]                           # name:value pairs are given for updateable attributes
-record:delete domain.com record_id                          # Delete the given domain
-
-template:create name short_name [description]               # Create a template
-template:list                                               # List all templates
-template:delete short_name                                  # Delete the given template
-
-template:list_records short_name                            # List all of the records for a template
-template:add_record [--prio=priority] short_name name \\ 
-  type content [ttl]                                        # Add a template record to the given template
-template:delete_record short_name template_record_id        # Delete the given template record
-
-contact:create [[name:value [name:value] ...]               # Create a contact
-contact:list                                                # List all contacts
-contact:describe contact_id                                 # Describe the given contact
-contact:update contact_id [[name:value] [name:value] ...]   # Update the given contact
-contact:delete contact_id                                   # Delete the given contact
-
-extended-attributes:list tld                                # List all extended attributes for the given TLD
-
-service:list                                                # List all supported services
-service:describe short_name                                 # Describe a specific service
-
-service:applied domain.com                                  # List all of the services applied to the domain
-service:available domain.com                                # List all of the services available for the domain
-service:add domain.com short_name                           # Add the service to the domain
-service:remove domain.com short_name                        # Remove the service from the domain
-
-certificate:list domain.com                                 # List all certificates for a domain
-certificate:describe domain.com id                          # Get a specific certificate for a domain
-certificate:purchase domain.com name contact_id             # Purchase a certificate
-certificate:submit domain.com id approver_email             # Submit a certificate for processing
-
-Please see the DNSimple documentation at http://developer.dnsimple.com for additional
-information on the commands that are available to DNSimple customers.
-
-EOF
-end
-
-if $0.split("/").last == 'dnsimple'
-
-  options = {}
-
-  global = OptionParser.new do |opts|
-    opts.on("-s", "--site [ARG]") do |site|
-      DNSimple::Client.site_uri = site
-    end
-    opts.on("-u", "--username [ARG]") do |username|
-      DNSimple::Client.username = username
-    end
-    opts.on("-p", "--password [ARG]") do |password|
-      DNSimple::Client.password = password
-    end
-    opts.on("-c", "--credentials [ARG]") do |credentials|
-      DNSimple::Client.load_credentials(credentials)
-    end
-    opts.on("-d") do
-      DNSimple::Client.debug = true
-    end
-  end
-
-  subcommands = { 
-    'create' => OptionParser.new do |opts|
-      opts.on("--template [ARG]") do |opt|
-        options[:template] = opt 
-      end
-    end,
-    'register' => OptionParser.new do |opts|
-      opts.on("--template [ARG]") do |opt|
-        options[:template] = opt
-      end
-    end,
-    'record:create' => OptionParser.new do |opts|
-      opts.on("--prio [ARG]") do |prio|
-        options[:prio] = prio 
-      end
-    end,
-    'template:add_record' => OptionParser.new do |opts|
-      opts.on("--prio [ARG]") do |prio|
-        options[:prio] = prio
-      end
-    end,
-  }
-
-  global.order!
-  command = ARGV.shift
-  if command.nil? || command == 'help'
-    usage
-  else
-    options_parser = subcommands[command]
-    options_parser.order! if options_parser
-    begin
-      cli.execute(command, ARGV, options)
-    rescue DNSimple::CommandNotFound => e
-      puts e.message
-    end
-  end
-
-end

data/features/README.md

@@ -1,9 +0,0 @@
-Before running the DNSimple Ruby Client cucumber feature files, you must do the following:
-
-1. If you haven't already go to https://sandbox.dnsimple.com and create an account. Activate your account to the Platinum level using the credit card number of "1".
-
-2. Create a file in your home directory called .dnsimple.test and include the following:
-
-        username: YOUR_USERNAME
-        password: YOUR_PASSWORD
-        base_uri: https://api.sandbox.dnsimple.com/

data/features/cli/certificates/purchase_certificate.feature

@@ -1,10 +0,0 @@
-Feature: purchase a certificate with the CLI
-  As a user
-  In order to purchase a certificate
-  I should be able to use the CLI for purchasing a certificate
-
-  @announce-cmd @announce-stdout
-  Scenario:
-    Given I have set up my credentials
-    When I run `dnsimple certificate:purchase` with a domain I created
-    Then the output should show that a certificate was purchased

data/features/cli/contacts/create_contact.feature

@@ -1,10 +0,0 @@
-Feature: create a contact with the CLI
-  As a user
-  In order to add a contact to my list of contacts
-  I should be able to use the CLI to create a contact
-
-  @announce-cmd
-  Scenario:
-    Given I have set up my credentials
-    When I run `dnsimple contact:create first:John last:Smith address1:"Example Road" city:Anytown state:Florida postal_code:12345 country:US email:john.smith@example.com phone:12225051122 label:test-contact`
-    Then the output should contain "Created contact John Smith"

data/features/cli/domains/check_domain.feature

@@ -1,10 +0,0 @@
-Feature: check a domain with the CLI
-  As a user
-  In order to check if a domain is available for registration
-  I should be able to use the CLI to check domains
-
-  @announce-cmd
-  Scenario:
-    Given I have set up my credentials
-    When I run `dnsimple check domain.com`
-    Then the output should contain "Check domain result for domain.com: registered"

data/features/cli/domains/create_domain.feature

@@ -1,10 +0,0 @@
-Feature: add a domain with the CLI
-  As a user
-  In order to add a domain to my account
-  I should be able to use the CLI to add domains
-
-  @announce-cmd
-  Scenario:
-    Given I have set up my credentials
-    When I run `dnsimple create` with a new domain
-    Then the output should show that the domain was created 

data/features/cli/domains/delete_domain.feature

@@ -1,11 +0,0 @@
-Feature: delete a domain with the CLI
-  As a user
-  In order to remove a domain from my account
-  I should be able to use the CLI to delete domains
-
-  @announce-cmd @skip-delete
-  Scenario:
-    Given I have set up my credentials
-    When I run `dnsimple delete` with a domain I created
-    Then the output should show that the domain was deleted 
-

data/features/cli/domains/register_domain.feature

@@ -1,10 +0,0 @@
-Feature: register a domain with the CLI
-  As a user
-  In order to register a domain
-  I should be able to use the CLI for domain registration
-
-  @announce-cmd @announce-stdout
-  Scenario:
-    Given I have set up my credentials
-    When I run `dnsimple register` with a new domain
-    Then the output should show that the domain was registered

data/features/cli/records/create_ptr_record.feature

@@ -1,11 +0,0 @@
-Feature: add a PTR record with the CLI
-  As a user
-  In order to add a PTR record to a domain in my account
-  I should be able to use the CLI to add the PTR record
-
-  @announce-cmd @announce-stdout
-  Scenario:
-    Given I have set up my credentials
-    When I run `dnsimple create` with a in-addr.arpa domain
-    And I run `dnsimple record:create` with the domain I added and the name "1" and the type "PTR" and the content "domain.com"
-    Then the output should show that the "PTR" record was created

data/features/cli/records/create_record.feature

@@ -1,12 +0,0 @@
-Feature: add a record with the CLI
-  As a user
-  In order to add records to a domain in my account
-  I should be able to use the CLI to add records
-
-  @announce-cmd @announce-stdout
-  Scenario:
-    Given I have set up my credentials
-    When I run `dnsimple create` with a new domain
-    And I run `dnsimple record:create` with the domain I added and no name and the type "A" and the content "1.2.3.4"
-    Then the output should show that the "A" record was created
-    And the output should include the record id

data/features/cli/records/delete_record.feature

@@ -1,14 +0,0 @@
-Feature: delete a record with the CLI
-  As a user
-  In order to remove a record from a domain in my account
-  I should be able to use the CLI to delete a record
-
-  @announce-cmd @announce-stdout
-  Scenario:
-    Given I have set up my credentials
-    When I run `dnsimple create` with a new domain
-    And I run `dnsimple record:create` with the domain I added and no name and the type "A" and the content "1.2.3.4"
-    And I note the id of the record I added
-    And I run `dnsimple record:delete` with the id of the record
-    Then the output should show that the record was deleted
-     

data/features/cli/templates/apply_template.feature

@@ -1,11 +0,0 @@
-Feature: apply a template to a domain
-  As a user
-  In order to apply a set of records to a domain at once
-  I should be able to use the CLI to apply a template
-
-  Scenario:
-    Given I have set up my credentials
-    When I run `dnsimple create` with a new domain
-    And I run `dnsimple apply` with the domain and the template named "googleapps"
-    Then the output should show that the template was applied
-    And I the domain should have 13 records