dnsimple 2.2.0 → 3.0.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b4fdacf67fa0361f299902ba1f3c323150320c0
-  data.tar.gz: be9c4fd05ecbc4c638d1cdda892d99ecbeab8d8d
+  metadata.gz: 6571b9393456ff941623f5001f393bfd819493f3
+  data.tar.gz: bf1878874ee2fa403519e51bcf28e7c1a36afbd9
 SHA512:
-  metadata.gz: 5f5bcf78ff845d629377ac08c4f37ed8a31bb9e13f22218fa9b70d28e20245c8a5e8b9b667ce8c2b7fc9d9485698e3d84e5214920cab795b2f876f0c380b9080
-  data.tar.gz: 584c677a4e3c36d8a1e8fd63c86723b74bbe516ea570fa7eb3c15264d0a8a4a7a0cc40b25402a578a3d9337d7ad70b7c674db50503a1b37e2d61cf972cfa08c8
+  metadata.gz: 2fb5142d55bbc3408be6b2626c67a7c2c41caeb4239ace0a1b3624e870857bfb987e0073e3cea7180eec3fb935c819441d9ff1f6eee3de6c9c38b5de2f184763
+  data.tar.gz: e681b2fc92d3c1c4d6c51bf9407c28c89b3129e73180009ab6a1e2aabf2ebf7579b70af34c638e8e627dd1979724de3313bdd58057e42b68de1361e19878f433

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1
+ruby-2.3.0

data/.travis.yml

@@ -1,9 +1,11 @@
+sudo: false
 language: ruby
 rvm:
-- 1.9.3
 - 2.0
 - 2.1
 - 2.2
+- 2.3.0
 env: COVERALL=1
+
 before_install:
 - gem install bundler

data/CHANGELOG.md

@@ -1,8 +1,19 @@
 # Changelog
 
-#### 2.2.0
+This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
-- NEW: Add support for Vanity Name Servers (GH-67, GH-63, GH-60). Thanks @iseem.
+
+#### 3.0
+
+##### beta1
+
+- CHANGED: Minimum Ruby version >= 2
+
+- CHANGED: Renamed `api_endpoint` to `base_url` to match the other clients.
+
+The client has been completely redesigned to support the [API v2](https://developer.dnsimple.com/v2). Overall, the client behaves like the previous version, however it has been rewritten to leverage the API v2 features specifically.
+
+Internal changes were made to match conventions adopted in other clients, such as the Go one and the Elixir one.
 
 #### 2.1.1
 

data/CONTRIBUTING.md

@@ -0,0 +1,35 @@
+# Contributing to DNSimple/Ruby
+
+## Getting started
+
+Clone the repository and move into it:
+
+```
+$ git clone git@github.com:aetrion/dnsimple-ruby.git
+$ cd dnsimple-ruby
+```
+
+Install the dependencies using [Bundler](http://bundler.io/):
+
+```
+$ bundle
+```
+
+[Run the test suite](#testing) to check everything works as expected.
+
+
+## Testing
+
+To run the test suite:
+
+```
+$ rake
+```
+
+
+## Tests
+
+Submit unit tests for your changes. You can test your changes on your machine by [running the test suite](#testing).
+
+When you submit a PR, tests will also be run on the continuous integration environment [through Travis](https://travis-ci.org/aetrion/dnsimple-ruby).
+

data/Gemfile

@@ -2,4 +2,6 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'rake', '< 11'
 gem 'coveralls', require: false
+gem 'rspec-core', '>= 3.4.4'

data/LICENSE.txt

@@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+SOFTWARE.

data/README.md

@@ -1,14 +1,21 @@
 # DNSimple Ruby Client
 
-A Ruby client for the [DNSimple API](https://developer.dnsimple.com/).
+A Ruby client for the [DNSimple API v2](https://developer.dnsimple.com/v2/).
 
-[![Build Status](https://travis-ci.org/aetrion/dnsimple-ruby.svg?branch=master-v1)](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-v1)
+[![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.
 
 
+## :warning: Beta Warning
+
+This branch targets the development of the API client for the [DNSimple API v2](https://developer.dnsimple.com/v2/). If you are looking for the stable version of the client for [DNSimple API v1](https://developer.dnsimple.com/v1/) then use the [`master-v1`](https://github.com/aetrion/dnsimple-ruby/tree/master-v1) branch.
+
+This library is currently in beta version, the methods and the implementation should be considered a work-in-progress. Changes in the method naming, method signatures, public or internal APIs may happen during the beta period.
+
+
 ## Installation
 
 ```
@@ -16,103 +23,44 @@ $ gem install dnsimple
 ```
 
 
-## Getting Started
+## Usage
 
-This library is a Ruby client you can use to interact with the [DNSimple API](https://developer.dnsimple.com/). Here are some examples.
+This library is a Ruby client you can use to interact with the [DNSimple API v2](https://developer.dnsimple.com/v2/). Here are some examples.
 
 ```ruby
 require 'dnsimple'
 
-client = Dnsimple::Client.new(username: 'YOUR_USERNAME', api_token: 'YOUR_TOKEN')
+client = Dnsimple::Client.new(access_token: "a1b2c3")
 
-# Fetch your user details
-user = client.users.user
-puts "My email is #{user.email}"
+# Fetch your details
+response = client.identity.whoami   # execute the call
+response.data                       # extract the relevant data from the response or
+client.identity.whoami.data         # execute the call and get the data in one line
 
+# Define an account ID.
+account_id = 1010
+
+# You can also fetch it from the whoami response
+whoami = client.identity.whoami.data
+account_id = whoami.account.id
 
 # List your domains
-domains = client.domains.list
-domains.each do |domain|
-  puts "Domain: %s (id: %d)" % [domain.name, domain.id]
-end
+puts client.domains.list_domains(account_id).data                      # => domains from the account 1234, first page
+puts client.domains.list_domains(account_id, query: { page: 3 }).data  # => domains from the account 1234, third page
+puts client.domains.all_domains(account_id).data                       # => all domains from the account 1234 (use carefully)
 
 # Create a domain
-domain = client.domains.create(name: "example.com")
-puts "Domain: %s (id: %d)" % [domain.name, domain.id]
+response = client.domains.create_domain(account_id, name: "example.com")
+puts response.data
 
 # Get a domain
-domain = client.domains.domain("example.com")
-puts "Domain: %s (id: %d)" % [domain.name, domain.id]
-
-
-# Create a domain record
-record = client.domains.create_record("example.com", record_type: "A", name: "www", content: "127.0.0.1")
-puts "Record: %s (id: %d)" % [record.name, record.id]
-
-# Get a domain record
-record = client.domains.record("example.com", 1234)
-puts "Record: %s (id: %d)" % [record.name, record.id]
-
-# List domain records
-records = client.domains.records("example.com")
-records.each do |record|
-  puts "Record: %s (id: %d)" % [record.name, record.id]
-end
+response = client.domains.domain(account_id, "example.com")
+puts response.data
 ```
 
 For the full library documentation visit http://rubydoc.info/gems/dnsimple
 
 
-## Authentication
-
-This client supports both the HTTP Basic and API Token authentication mechanism.
-
-#### HTTP Basic
-
-```ruby
-client = Dnsimple::Client.new(username: 'YOUR_USERNAME', password: 'YOUR_PASSWORD')
-client.users.user
-# => Dnsimple::Struct::User
-```
-
-#### HTTP Basic with two-factor authentication enabled
-
-See the [2FA API documentation](https://developer.dnsimple.com/authentication/#twofa).
-
-```ruby
-# Request the 2FA exchange token
-client = Dnsimple::Client.new(username: 'YOUR_USERNAME', password: 'YOUR_PASSWORD')
-token  = client.users.exchange_token('otp-token')
-
-# Authenticate with the exchange token
-client.exchange_token = token
-client.users.user
-# => Dnsimple::Struct::User
-```
-
-#### API Token
-
-```ruby
-client = Dnsimple::Client.new(username: 'YOUR_USERNAME', api_token: 'YOUR_TOKEN')
-
-client.users.user
-# => Dnsimple::Struct::User
-```
-
-#### Domain API Token
-
-The domain API token grants [limited access]](https://developer.dnsimple.com/v1/authentication/#domain-token) to a single domain.
-
-```ruby
-client = Dnsimple::Client.new(domain_api_token: 'DOMAIN_TOKEN')
-
-client.domains.records("example.com")
-# => [Dnsimple::Struct::Record, Dnsimple::Struct::Record, ...]
-
-client.domains.records("foobar.com")
-# => Authentication error
-```
-
 ## License
 
 Copyright (c) 2010-2016 Aetrion LLC. This is Free Software distributed under the MIT license.

data/dnsimple.gemspec

@@ -11,11 +11,12 @@ Gem::Specification.new do |s|
   s.summary     = 'The DNSimple API client for Ruby'
   s.description = 'The DNSimple API client for Ruby.'
 
-  s.required_ruby_version = ">= 1.9.3"
+  s.required_ruby_version = ">= 2.0"
 
   s.require_paths    = ['lib']
   s.files            = `git ls-files`.split("\n")
   s.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.extra_rdoc_files = %w( LICENSE.txt )
 
   s.add_dependency  'httparty'
 

data/lib/dnsimple.rb

@@ -1,5 +1,3 @@
-require 'httparty'
-
 module Dnsimple
 
   # Echoes a deprecation warning message.

data/lib/dnsimple/client.rb

@@ -1,25 +1,23 @@
-require 'dnsimple/compatibility'
+require 'httparty'
 require 'dnsimple/extra'
 require 'dnsimple/struct'
+require 'dnsimple/response'
 require 'dnsimple/client/clients'
 
 module Dnsimple
 
   # Client for the DNSimple API
   #
-  # @see http://developer.dnsimple.com
+  # @see https://developer.dnsimple.com/
   class Client
-    include Dnsimple::Compatibility
 
-    HEADER_2FA_STRICT = "X-DNSimple-2FA-Strict"
-    HEADER_API_TOKEN = "X-DNSimple-Token"
     HEADER_DOMAIN_API_TOKEN = "X-DNSimple-Domain-Token"
-    HEADER_OTP_TOKEN = "X-DNSimple-OTP"
-    HEADER_EXCHANGE_TOKEN = "X-DNSimple-OTP-Token"
+    HEADER_AUTHORIZATION = "Authorization"
+    WILDCARD_ACCOUNT = "_"
 
 
     # @return [String] The current API version.
-    API_VERSION = "v1"
+    API_VERSION = "v2"
 
 
     # Prepends the correct API version to +path+.
@@ -30,29 +28,27 @@ module Dnsimple
     end
 
 
-    # @!attribute api_endpoint
-    #   @return [String] Base URL for API requests. (default: https://api.dnsimple.com/)
     # @!attribute username
+    #   @see https://developer.dnsimple.com/v2/#authentication
     #   @return [String] DNSimple username for Basic Authentication
     # @!attribute password
-    #   @see http://developer.dnsimple.com/authentication/
+    #   @see https://developer.dnsimple.com/v2/#authentication
     #   @return [String] DNSimple password for Basic Authentication
-    # @!attribute exchange_token
-    #   @see http://developer.dnsimple.com/authentication/
-    #   @return [String] Exchange Token for Basic Authentication with 2FA
-    # @!attribute api_token
-    #   @see http://developer.dnsimple.com/authentication/
-    #   @return [String] API access token for authentication
     # @!attribute domain_api_token
-    #   @see http://developer.dnsimple.com/authentication/
+    #   @see https://developer.dnsimple.com/v2/#authentication
+    #   @return [String] Domain API access token for authentication
+    # @!attribute access_token
+    #   @see https://developer.dnsimple.com/v2/#authentication
     #   @return [String] Domain API access token for authentication
+    # @!attribute base_url
+    #   @return [String] Base URL for API requests. (default: https://api.dnsimple.com/)
     # @!attribute user_agent
     #   @return [String] Configure User-Agent header for requests.
     # @!attribute proxy
     #   @return [String,nil] Configure address:port values for proxy server
 
-    attr_accessor :api_endpoint, :username, :password, :exchange_token, :api_token, :domain_api_token,
-                  :user_agent, :proxy
+    attr_accessor :username, :password, :domain_api_token, :access_token,
+                  :base_url, :user_agent, :proxy
 
 
     def initialize(options = {})
@@ -66,61 +62,79 @@ module Dnsimple
     end
 
 
+    # @return [String] Base URL for API requests.
+    def base_url
+      Extra.join_uri(@base_url, "")
+    end
+
+
     # Make a HTTP GET request.
     #
-    # @param  [String] path The path, relative to {#api_endpoint}
-    # @param  [Hash] options Query and header params for request
+    # @param  [String] path The path, relative to {#base_url}
+    # @param  [Hash] options The query and header params for the request
     # @return [HTTParty::Response]
     def get(path, options = {})
-      execute :get, path, options
+      execute :get, path, nil, options
     end
 
     # Make a HTTP POST request.
     #
-    # @param  [String] path The path, relative to {#api_endpoint}
-    # @param  [Hash] options Body and header params for request
+    # @param  [String] path The path, relative to {#base_url}
+    # @param  [Hash] data The body for the request
+    # @param  [Hash] options The query and header params for the request
     # @return [HTTParty::Response]
-    def post(path, options = {})
-      execute :post, path, options
+    def post(path, data = nil, options= {})
+      execute :post, path, data, options
     end
 
     # Make a HTTP PUT request.
     #
-    # @param  [String] path The path, relative to {#api_endpoint}
-    # @param  [Hash] options Body and header params for request
+    # @param  [String] path The path, relative to {#base_url}
+    # @param  [Hash] data The body for the request
+    # @param  [Hash] options The query and header params for the request
     # @return [HTTParty::Response]
-    def put(path, options = {})
-      execute :put, path, options
+    def put(path, data = nil, options = {})
+      execute :put, path, data, options
     end
 
-    # Make a HTTP DELETE request.
+    # Make a HTTP PATCH request.
     #
-    # @param  [String] path The path, relative to {#api_endpoint}
-    # @param  [Hash] options Query and header params for request
+    # @param  [String] path The path, relative to {#base_url}
+    # @param  [Hash] data The body for the request
+    # @param  [Hash] options The query and header params for the request
     # @return [HTTParty::Response]
-    def delete(path, options = {})
-      execute :delete, path, options
+    def patch(path, data = nil, options = {})
+      execute :patch, path, data, options
     end
 
+    # Make a HTTP DELETE request.
+    #
+    # @param  [String] path The path, relative to {#base_url}
+    # @param  [Hash] options The query and header params for the request
+    # @return [HTTParty::Response]
+    def delete(path, data = nil, options = {})
+      execute :delete, path, data, options
+    end
 
     # Executes a request, validates and returns the response.
     #
     # @param  [String] method The HTTP method
-    # @param  [String] path The path, relative to {#api_endpoint}
-    # @param  [Hash] options Query and header params for request
+    # @param  [String] path The path, relative to {#base_url}
+    # @param  [Hash] data The body for the request
+    # @param  [Hash] options The query and header params for the request
     # @return [HTTParty::Response]
     # @raise  [RequestError]
     # @raise  [NotFoundError]
     # @raise  [AuthenticationFailed]
     # @raise  [TwoFactorAuthenticationRequired]
-    def execute(method, path, data, options = {})
+    def execute(method, path, data = nil, options = {})
       response = request(method, path, data, options)
 
       case response.code
       when 200..299
         response
       when 401
-        raise (response.headers[HEADER_OTP_TOKEN] == "required" ? TwoFactorAuthenticationRequired : AuthenticationFailed), response["message"]
+        raise AuthenticationFailed.new(response["message"])
       when 404
         raise NotFoundError.new(response)
       else
@@ -128,7 +142,6 @@ module Dnsimple
       end
     end
 
-
     # Make a HTTP request.
     #
     # This method doesn't validate the response and never raise errors
@@ -138,25 +151,14 @@ module Dnsimple
     # Therefore, it's up to the caller to properly handle and validate the response.
     #
     # @param  [String] method The HTTP method
-    # @param  [String] path The path, relative to {#api_endpoint}
-    # @param  [Hash] options Query and header params for request
+    # @param  [String] path The path, relative to {#base_url}
+    # @param  [Hash] data The body for the request
+    # @param  [Hash] options The query and header params for the request
     # @return [HTTParty::Response]
-    def request(method, path, data, options = {})
-      if data.is_a?(Hash)
-        options[:query]   = data.delete(:query)   if data.key?(:query)
-        options[:headers] = data.delete(:headers) if data.key?(:headers)
-      end
-      if !data.empty?
-        options[:body] = data
-      end
+    def request(method, path, data = nil, options = {})
+      options[:body] = data if data
 
-      HTTParty.send(method, api_endpoint + path, Extra.deep_merge!(base_options, options))
-    end
-
-
-    # @return [String] Base URL for API requests.
-    def api_endpoint
-      Extra.join_uri(@api_endpoint, "")
+      HTTParty.send(method, base_url + path, Extra.deep_merge!(base_options, options))
     end
 
 
@@ -173,16 +175,14 @@ module Dnsimple
         options.merge!(http_proxyaddr: address, http_proxyport: port)
       end
 
-      if exchange_token
-        options[:basic_auth] = { username: exchange_token, password: "x-2fa-basic" }
-      elsif password
+      if password
         options[:basic_auth] = { username: username, password: password }
       elsif domain_api_token
         options[:headers][HEADER_DOMAIN_API_TOKEN] = domain_api_token
-      elsif api_token
-        options[:headers][HEADER_API_TOKEN] = "#{username}:#{api_token}"
+      elsif access_token
+        options[:headers][HEADER_AUTHORIZATION] = "Bearer #{access_token}"
       else
-        raise Error, 'A password or API token is required for all API requests.'
+        raise Error, 'A password, domain API token or access token is required for all API requests.'
       end
 
       options