dnsimple 3.0.0.pre.beta2 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7128cb8f75d602974383ef364f17f679420772b2
-  data.tar.gz: a2fa6d2b0434351994f911d2b72bf385b885a8f9
+  metadata.gz: 8aca4eb6f6813b601531e5c5d82f9db0ec222dd5
+  data.tar.gz: 6076520c66e7ac64e23e1e006a9342f96cefabc5
 SHA512:
-  metadata.gz: 774ea827afd9b4f40ba487dbf04c8c5a1c32bb3850abd94bae3652e4d75867c124000384d26505186e5963f0873b74a5b117342b8530eeea491e8808b95b3360
-  data.tar.gz: e4debc8a6e08f919d7839d007e58845a58a0f68e0b64d5ecb77623030a585a830f1e2665f7f49f061ee20f89117634df8b501e40bbe6c8e7df913884d44047c6
+  metadata.gz: 3b56cb8d598eec60f48cf0eb63594e323b3a16d2d02a73a003e4fd7c64030f6a2d488fc77b8e4abab8c33598a28411aa15fdb946db4c0db2dc4faeafb1507303
+  data.tar.gz: d9cc0e1e056166b2cc5952ecd3d317bb524341ea92aaaac581a9e414bbc4e6164837f40b65566420281633a17ecb6c707430db2d0ee56e3053e439c9d96d9a65

data/.rubocop.yml

@@ -0,0 +1,13 @@
+inherit_from:
+  - .rubocop_todo.yml
+  - .rubocop_dnsimple.yml
+
+# [codesmell]
+# It's irrelevant here, but it could be a code smell.
+# Hence keep it disabled, but don't include it in the DNSimple suite.
+Lint/Loop:
+  Enabled: false
+
+# It doesn't seem to work as expected.
+Style/IfUnlessModifier:
+  Enabled: false

data/.rubocop_dnsimple.yml

@@ -0,0 +1,216 @@
+AllCops:
+  Exclude:
+    # Exclude .gemspec files because they are generally auto-generated
+    - '*.gemspec'
+
+# Generally, the keyword style uses a lot of space. This is particularly true when
+# you use case/if statements, in combination with a long-name variable.
+#
+#   invoice_error_message = case error
+#                           when 1 == 1
+#                             do_something
+#                           else
+#                             do_else
+#                           end
+#
+Lint/EndAlignment:
+  AlignWith: variable
+
+# [codesmell]
+Metrics/AbcSize:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
+# For the same reason of EndAlignment, aligning with the case may have a bad impact
+# on a case after a very long variable.
+#
+#   invoice_error_message = case error
+#                           when 1 == 1
+#                             do_something
+#                           else
+#                             do_else
+#                           end
+#
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+# [codesmell]
+Metrics/ClassLength:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
+# [codesmell]
+Metrics/MethodLength:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+  Max: 10
+
+# [codesmell]
+Metrics/ModuleLength:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
+# [codesmell]
+Metrics/LineLength:
+  Enabled: false
+  Exclude:
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+  Max: 100
+
+# [codesmell]
+# I don't really get the point of this cop.
+Performance/RedundantMerge:
+  Enabled: false
+
+# Do not use "and" or "or" in conditionals, but for readability we can use it
+# to chain executions. Just beware of operator order.
+Style/AndOr:
+  EnforcedStyle: conditionals
+
+# No specific reason, except that %q() is easier to grep than %()
+Style/BarePercentLiterals:
+  EnforcedStyle: percent_q
+
+# braces_for_chaining seems a good fit of what we've been doing so far.
+Style/BlockDelimiters:
+  EnforcedStyle: braces_for_chaining
+  IgnoredMethods:
+    - expect
+
+# I'd rather use context_dependent, even if I'm not even sure we should enforce a style.
+Style/BracesAroundHashParameters:
+  EnforcedStyle: context_dependent
+
+# I was a big fan of leading, but trailing seems to be more commonly adopted.
+# At least at the time being.
+Style/DotPosition:
+  EnforcedStyle: trailing
+
+# Warn on empty else.
+Style/EmptyElse:
+  EnforcedStyle: empty
+
+# Double empty lines are useful to separate conceptually different methods
+# in the same class or module.
+Style/EmptyLines:
+  Enabled: false
+
+Style/EmptyLinesAroundBlockBody:
+  Exclude:
+    # RSpec is all made of blocks. Disable this config in RSpec
+    # to be consistent with EmptyLinesAroundClassBody and EmptyLinesAroundModuleBody
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
+# In most cases, a space is nice. Sometimes, it's not.
+# Just be consistent with the rest of the surrounding code.
+Style/EmptyLinesAroundClassBody:
+  Enabled: false
+
+# In most cases, a space is nice. Sometimes, it's not.
+# Just be consistent with the rest of the surrounding code.
+Style/EmptyLinesAroundModuleBody:
+  Enabled: false
+
+# I personally don't care about the format style.
+# In most cases I like to use %, but not at the point I want to enforce it
+# as a convention in the entire code.
+Style/FormatString:
+  Enabled: false
+
+# Multi-line differs from standard indentation, they are indented twice.
+Style/FirstParameterIndentation:
+  IndentationWidth: 4
+
+# Prefer the latest Hash syntax
+Style/HashSyntax:
+  Exclude:
+    # But Rakefiles generally have some definition like
+    #   :default => :test
+    # that looks nicer with the old rocket syntax.
+    - 'Rakefile'
+
+# We want to be able to decide when to use one-line if/unless modifiers.
+Style/IfUnlessModifier:
+  Enabled: false
+
+# Array indentation should be considered like MultilineMethodCallIndentation indentation
+# and use 4 spaces instead of 2.
+Style/IndentArray:
+  IndentationWidth: 4
+
+# Hash indentation should be considered like MultilineMethodCallIndentation indentation
+# and use 4 spaces instead of 2.
+Style/IndentHash:
+  IndentationWidth: 4
+
+# [codesmell]
+# It's not always that bad.
+Style/IfInsideElse:
+  Enabled: false
+
+# Multi-line differs from standard indentation, they are indented twice.
+Style/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+
+# Multi-line differs from standard indentation, they are indented twice.
+Style/MultilineOperationIndentation:
+  EnforcedStyle: indented
+  IndentationWidth: 4
+
+# unless is not always cool.
+Style/NegatedIf:
+  Enabled: false
+
+# Magic numbers are not welcomed
+Style/NumericLiterals:
+  Exclude:
+    # however tests can use numeric literals for method calls,
+    # without the need to define a variable just for that.
+    - 'spec/**/*_spec.rb'
+    - 'test/**/*_test.rb'
+
+# Do we care?
+Style/RegexpLiteral:
+  Enabled: false
+
+# There are cases were the inline rescue is ok. We can either downgrade the severity,
+# or rely on the developer judgement on a case-by-case basis.
+Style/RescueModifier:
+  Enabled: false
+
+# We don't have a preference.
+Style/SpecialGlobalVars:
+  Enabled: false
+  EnforcedStyle: use_perl_names
+
+# We generally use double quotes, sometimes single quotes.
+# Should we enforce it at code level?
+Style/StringLiterals:
+  Enabled: false
+  EnforcedStyle: double_quotes
+
+# It's nice to be consistent. The trailing comma also allows easy reordering,
+# and doesn't cause a diff in Git when you add a line to the bottom.
+Style/TrailingCommaInLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrivialAccessors:
+  # IgnoreClassMethods because I want to be able to define class-level accessors
+  # that sets an instance variable on the metaclass, such as:
+  #
+  #    def self.default=(value)
+  #      @default = value
+  #    end
+  #
+  IgnoreClassMethods: true

data/.rubocop_todo.yml

@@ -0,0 +1,14 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-03-27 01:01:12 +0100 using RuboCop version 0.38.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+Style/Documentation:
+  # Silence this check for now until we fix it.
+  Enabled: false
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'

data/CHANGELOG.md

@@ -3,7 +3,22 @@
 This project uses [Semantic Versioning 2.0.0](http://semver.org/).
 
 
-#### 3.0
+#### 3.0.0
+
+##### stable
+
+- FIXED: The client was using the wrong key to store the ContactsService which could cause conflicts with the DomainsService.
+
+- FIXED: `renewDomain` used a wrong path (GH-96).
+
+- NEW: Added registrar delegation support (GH-98).
+
+- NEW: Added template support (GH-99).
+
+- NEW: Added service support (GH-101).
+
+- CHANGED: Error detection is now smarter. If the error is deserializable and contains a message, the message is attached to the exception (GH-94, GH-95, GH-100).
+
 
 ##### beta2
 

data/Gemfile

@@ -4,3 +4,4 @@ gemspec
 
 gem 'rake', '< 11'
 gem 'coveralls', require: false
+gem 'rubocop', require: false

data/Rakefile

@@ -1,16 +1,21 @@
 require 'bundler/gem_tasks'
 
-# Run test by default.
-task :default => :spec
+# By default, run tests and linter.
+task default: [:spec, :rubocop]
 
 
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new do |t|
-  t.verbose = !!ENV["VERBOSE"]
+  t.verbose = !ENV["VERBOSE"].nil?
 end
 
 
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+
 require 'yard'
 
 YARD::Rake::YardocTask.new(:yardoc) do |y|

data/lib/dnsimple/client.rb

@@ -11,13 +11,12 @@ module Dnsimple
   # @see https://developer.dnsimple.com/
   class Client
 
-    HEADER_DOMAIN_API_TOKEN = "X-DNSimple-Domain-Token"
-    HEADER_AUTHORIZATION = "Authorization"
-    WILDCARD_ACCOUNT = "_"
+    HEADER_AUTHORIZATION = "Authorization".freeze
+    WILDCARD_ACCOUNT = "_".freeze
 
 
     # @return [String] The current API version.
-    API_VERSION = "v2"
+    API_VERSION = "v2".freeze
 
 
     # Prepends the correct API version to +path+.
@@ -83,7 +82,7 @@ module Dnsimple
     # @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, data = nil, options= {})
+    def post(path, data = nil, options = {})
       execute :post, path, data, options
     end
 
@@ -134,11 +133,11 @@ module Dnsimple
       when 200..299
         response
       when 401
-        raise AuthenticationFailed.new(response["message"])
+        raise AuthenticationFailed, response["message"]
       when 404
-        raise NotFoundError.new(response)
+        raise NotFoundError, response
       else
-        raise RequestError.new(response)
+        raise RequestError, response
       end
     end
 
@@ -173,8 +172,8 @@ module Dnsimple
       options = {
           format:   :json,
           headers:  {
-            'Accept' => 'application/json',
-            'User-Agent' => user_agent
+              'Accept' => 'application/json',
+              'User-Agent' => user_agent,
           },
       }
 
@@ -185,8 +184,6 @@ module Dnsimple
 
       if password
         options[:basic_auth] = { username: username, password: password }
-      elsif domain_api_token
-        options[:headers][HEADER_DOMAIN_API_TOKEN] = domain_api_token
       elsif access_token
         options[:headers][HEADER_AUTHORIZATION] = "Bearer #{access_token}"
       else

data/lib/dnsimple/client/clients.rb

@@ -3,7 +3,7 @@ module Dnsimple
 
     # @return [Dnsimple::Client::ContactsService] The contact-related API proxy.
     def contacts
-      @services[:domains] ||= Client::ContactsService.new(self)
+      @services[:contacts] ||= Client::ContactsService.new(self)
     end
 
     # @return [Dnsimple::Client::DomainsService] The domain-related API proxy.
@@ -26,6 +26,16 @@ module Dnsimple
       @services[:registrar] ||= Client::RegistrarService.new(self)
     end
 
+    # @return [Dnsimple::Client::ServicesService] The one-click-service-related API proxy.
+    def services
+      @services[:services] ||= Client::ServicesService.new(self)
+    end
+
+    # @return [Dnsimple::Client::TemplatesService] The templates-related API proxy.
+    def templates
+      @services[:templates] ||= Client::TemplatesService.new(self)
+    end
+
     # @return [Dnsimple::Client::TldsService] The tld-related API proxy.
     def tlds
       @services[:tlds] ||= Client::TldsService.new(self)
@@ -43,7 +53,14 @@ module Dnsimple
 
 
     # @!class Struct
-    class ClientService < ::Struct.new(:client)
+    class ClientService
+
+      # @return [Dnsimple::Client]
+      attr_reader :client
+
+      def initialize(client)
+        @client = client
+      end
 
       # Internal helper that loops over a paginated response and returns all the records in the collection.
       #
@@ -107,11 +124,27 @@ module Dnsimple
     require_relative 'registrar'
     require_relative 'registrar_auto_renewal'
     require_relative 'registrar_whois_privacy'
+    require_relative 'registrar_delegation'
 
     class RegistrarService < ClientService
       include Client::Registrar
       include Client::RegistrarAutoRenewal
       include Client::RegistrarWhoisPrivacy
+      include Client::RegistrarDelegation
+    end
+
+
+    require_relative 'services'
+
+    class ServicesService < ClientService
+      include Client::Services
+    end
+
+
+    require_relative 'templates'
+
+    class TemplatesService < ClientService
+      include Client::Templates
     end
 
 
@@ -130,6 +163,7 @@ module Dnsimple
       include Client::ZonesRecords
     end
 
+
     require_relative 'webhooks'
 
     class WebhooksService < ClientService