gandi_v5 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d32f073e157edcd88519f82b4dd082943d4ea049e0232de31dc80d6585070fd7
+  data.tar.gz: ed3c8d5156a3efed4980f62775affc680e73c59890c3430740e41e27dca04763
+SHA512:
+  metadata.gz: a15a87d90b92a53b37544862adb13cf11d21fa7d3737300f2b392b2abc9fa28cc150da48d40d0bb1d63c9a7f5b65dbf13cde7ed8d002e51ab78aac084fb17567
+  data.tar.gz: 91812fc13dabdb21e84164a478376d411271aaec1a30be651f1c9af78c9c1d0e521a5af5f6b4162adb1e5a46ff1cd0bc6ce6231bc80e41cd86d2a33d45060f38

data/.gitignore

@@ -0,0 +1,24 @@
+# Because this is a gem, ignore Gemfile.lock:
+
+Gemfile.lock
+
+# And because this is Ruby, ignore the following
+#  (source: https://github.com/github/gitignore/blob/master/Ruby.gitignore):
+
+notes.txt
+todo.txt
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+gemfiles/*.lock
+.yardoc

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+require:
+- rubocop-performance
+AllCops:
+  TargetRubyVersion: 2.6.0
+Gemspec/RequiredRubyVersion:
+  Enabled: false
+Metrics/AbcSize:
+  Max: 17
+Metrics/ClassLength:
+  Max: 200
+Metrics/LineLength:
+  Max: 100
+Metrics/MethodLength:
+  Max: 15
+Metrics/ModuleLength:
+  Max: 200
+Style/DocumentationMethod:
+  Enabled: true
+Style/SignalException:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,23 @@
+language: ruby
+rvm:
+  - 2.6.0
+  - 2.6.1
+  - 2.6.2
+gemfile:
+  - Gemfile
+branches:
+  only:
+    - master
+    - staging
+    - /gh(?:\d)+(?:-.+)?/
+    - /dev_ver_\d+\.\d+/
+before_install: gem update bundler
+script:
+  - bundle exec rubocop
+  - bundle exec rspec
+notifications:
+  slack:
+    on_success: always
+    on_failure: always
+    rooms:
+    - secure: Nx1TmVs32ILAvH3Cv+jX6rZh1hgx3YaY9azC3PIaJba/bF9xXY1l8L4wF0dJGupQlFP3lWN3Y/aPIJo3SNbH+qll9o317105FfTecPWloyiDgWvz5qPz+oh5MImBUs220jW2XsaACfZkGTUsQt8OUCfhtUeUiW+YqqfAZEwnl+0TyTSFBSLKSNdMcT0sKYPb0IuX5WrOspokSoE9+QL5k0cNN8d78MvtUIC6Em5/ffKVbk4TulQhbzyUhIlPDoxVELq16dQ7njyWJb58khOCaJGV7a2NdFvFCJqImFVQPRT5Ad6EJMQ461cdPY5+ZwxDGlIkA5Srt1L+CyV2wJtMarCIPoGQaxuOTVjNiedEmzblg3K9VXkI7Q5LupJ+vOBhtUS54ODYVBnQgoNVPuRe6T81VZ7NCejeest9bqga8QAVVNhKvMvb6l+YXabnPo7okDZM4+4AlaG/pBKWKjxDJ5QXlbRUZqnJt36sA7y3wvIxnYMX45oaqLD9OS8DQ7Va9+9bsPGZnI0oQrkoPGazGnCryvNtEdl+Qy2KSFaocJL7XLavmAYCmqnNGIaO0eiI+VoX9rvOadDNaPJoa6G4YpO+yTBlx1mxLjneY3FfCHZ1lma7UxzV0t0AVYZtnYBalXbw3mvIWEg6PPRI2uXGCvwUBrNCQqonULsRTFSseMw=

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## Version 0.0.1
+
+ * Initial release.

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gandi_v5.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+guard :bundler do
+  watch(/^Gemfile(?:\.lock)$'/)
+  watch(/^.+\.gemspec$'/)
+end
+
+# rubocop:disable Metrics/BlockLength
+group :red_green_refactor, halt_on_fail: true do
+  group :rspec do
+    guard(
+      'rspec',
+      all_on_start: true,
+      all_after_pass: false,
+      notification: :failed,
+      cmd: 'bundle exec rspec'
+    ) do
+      watch(%r{^spec/.+_spec\.rb$})
+      watch(%r{^lib/(.+)\.rb$})       { |m| "spec/units/#{m[1]}_spec.rb" }
+      watch('spec/spec_helper.rb')    { 'spec' }
+      watch(%r{^spec/.+_shared\.rb$}) { 'spec' }
+    end
+  end
+
+  group :rubocop do
+    guard(
+      'rubocop',
+      all_on_start: true,
+      all_after_pass: false,
+      notification: :failed,
+      keep_failed: false,
+      cmd: 'bundle exec rubocop'
+    ) do
+      watch(%r{^lib/(.+)\.rb$}) { |m| [m[0], "spec/units/#{m[1]}_spec.rb"] }
+      watch(%r{^spec/.+?/(.+)_spec\.rb$}) { |m| [m[0], "lib/#{m[1]}.rb"] }
+      watch(%r{^(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+    end
+  end
+end
+# rubocop:enable Metrics/BlockLength

data/LICENSE.md

@@ -0,0 +1,32 @@
+##Copyright
+Copyright (c) 2018, Robert Gauld. All rights reserved.
+
+
+##License
+This code can be used under the BSD License (reproduced below).
+Commiters to the project give Robert Gauld the right to redistribute their commits
+under the BSD license.
+
+
+###BSD License
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice,
+  this list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+- Neither the name of the project nor the names of its contributors
+  may be used to endorse or promote products derived from this software
+  without specific prior written permission.
+ 
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT
+OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,94 @@
+[![Gem Version](https://badge.fury.io/rb/gandi_v5.png)](http://badge.fury.io/rb/gandi_v5)
+
+Master branch:
+[![Build Status](https://secure.travis-ci.org/robertgauld/gandi_v5.png?branch=master)](http://travis-ci.org/robertgauld/gandi_v5)
+[![Coveralls Status](https://coveralls.io/repos/robertgauld/gandi_v5/badge.png?branch=master)](https://coveralls.io/r/robertgauld/gandi_v5)
+[![Code Climate](https://codeclimate.com/github/robertgauld/gandi_v5.png?branch=master)](https://codeclimate.com/github/robertgauld/gandi_v5)
+
+Staging branch:
+[![Build Status](https://secure.travis-ci.org/robertgauld/gandi_v5.png?branch=staging)](http://travis-ci.org/robertgauld/gandi_v5)
+[![Coveralls Status](https://coveralls.io/repos/robertgauld/gandi_v5/badge.png?branch=staging)](https://coveralls.io/r/robertgauld/gandi_v5)
+
+
+## Build State
+This project uses continuous integration to help ensure that a quality product is delivered.
+Travis CI monitors two branches (versions) of the code:
+
+* Master (which is what gets released)
+* Staging (which is what is currently being developed ready for moving to master).
+
+
+## Ruby Versions
+This gem supports the following versions of ruby, it may work on other versions but is not tested against them so don't rely on it.
+
+* ruby:
+  * 2.6.0 - 2.6.2
+* jruby, once it's reached parity with ruby 2.6.x
+
+
+## Gandi V5
+
+Make use of Gandi's V5 API.
+See the table in the [Versioning section](#Versioning) to see what Gandi
+API Changes each version is current for.
+
+Gandi say: **_"Please note that this API is currently in BETA testing, so care should be taken when used in production._"**
+
+But then you were going to be careful anyway as this gem is currently in the version 0.something range weren't you!
+
+Details of the API can be found at:
+
+* (https://api.gandi.net/docs/)
+* (https://doc.livedns.gandi.net/)
+
+
+## Installation
+
+If you're using bundler then add it to your Gemfile and run the bundle command.
+
+```ruby
+gem 'gandi_v5', '~> 0.1'
+```
+
+If you're not using bundler then install it from the command line.
+```bash
+gem install gandi_v5 -v '~> 0.1'
+```
+
+## Usage
+
+### Setup
+
+You'll need you Gandi API KEY, you can get this by logging into Gandi and
+navigating to User Settings -> Change password & configure access restrictions.
+
+```ruby
+require 'gandi_v5'    # Unless you're using Bundler
+GandiV5.api_key = '…' # Unless you've set it in the environment variable GANDI_API_KEY
+```
+
+### Examples
+
+#### Domains
+
+```ruby
+# Get an array of all your domains.
+domains = GandiV5::Domain.list
+
+# Since each domain has only basic information, lets get all of the information.
+domains.map!(&:refresh)
+```
+
+TODO: More examples!
+
+
+## Versioning
+
+We follow the [Semantic Versioning](http://semver.org/) concept.
+
+| Gem Version     | Gandi API Release Date | 
+| --------------- | ---------------------- |
+| 0.1.0           | 2019-05-16             |
+
+See (https://api.gandi.net/docs/reference#API-Changelog) to find out what
+Gandi changed on each date.

data/Rakefile

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'

data/TODO.md

@@ -0,0 +1,29 @@
+# To Do List
+
+* Domain:
+  * [ ] .restore_information - test when I have a restorable domain
+  * [ ] .create - return created domain
+  * [ ] .availability - return a new type of object
+  * [ ] .tld * return a new type of object
+* Email Mailbox:
+  * [ ] .create - check type is valid
+  * [ ] .create - check a slot is available
+  * [ ] .create - fetch created mailbox
+* Email Slot:
+  * [ ] #delete - check for inactiveness
+  * [ ] #delete - check for refundableness
+  * [ ] .create - fetch created slot
+* LiveDNS Domain:
+  * [ ] #replace_??_records_for - incorporate into #replace_records_for
+  * [ ] Make record type a symbol
+  * [ ] Add #zone method
+* LiveDNS Zone:
+  * [ ] .create - fetch created zone
+  * [ ] #replace_??_records_for - incorporate into #replace_records_for
+  * [ ] Make record type a symbol
+  * [ ] Add #zone method
+* LiveDNS Zone Snapshot:
+  * [ ] Move method for getting listing to here
+* Gandi updates from 2019-05-23:
+  * [ ] Domain API: Domain hosts (glue records)
+  * [ ] Domain API: Domain nameservers

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+Dotenv.load
+
+unless ENV.key?('GANDI_API_KEY')
+  puts 'YOU MUST SET YOUR API KEY -> GandiV5.api_key = \'…\''
+  puts 'You can avoid having to do this by'
+  puts 'setting the environment variable GANDI_API_KEY.'
+end
+
+require 'irb'
+IRB.start

data/gandi_v5.gemspec

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+$LOAD_PATH.push File.expand_path('lib', __dir__)
+require File.join(File.dirname(__FILE__), 'lib', 'gandi_v5', 'version')
+
+Gem::Specification.new do |gem|
+  gem.name        = 'gandi_v5'
+  gem.license     = 'BSD 3 clause'
+  gem.version     = GandiV5::VERSION
+  gem.authors     = ['Robert Gauld']
+  gem.email       = ['robert@robertgauld.co.uk']
+  gem.homepage    = 'https://github.com/robertgauld/gandi_v5'
+  gem.summary     = 'Make use of Gandi\'s V5 API.'
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version     = '>= 2.4'
+  gem.required_rubygems_version = '>= 2.6.14'
+
+  gem.add_dependency 'dotenv', '~> 2.5'
+  gem.add_dependency 'rest-client', '>= 2', '< 3'
+
+  gem.add_development_dependency 'coveralls', '~> 0.7'
+  gem.add_development_dependency 'guard', '~> 2.15'
+  gem.add_development_dependency 'guard-bundler', '~> 2.2'
+  gem.add_development_dependency 'guard-rspec', '~> 4.2', '>= 4.2.5'
+  gem.add_development_dependency 'guard-rubocop', '~> 1.3'
+  gem.add_development_dependency 'rake', '~> 12.0'
+  gem.add_development_dependency 'rb-inotify', '~> 0.9'
+  gem.add_development_dependency 'rspec', '>= 3.7', '< 4'
+  gem.add_development_dependency 'rspec-its', '~> 1.3'
+  gem.add_development_dependency 'rubocop', '~> 0.67'
+  gem.add_development_dependency 'rubocop-performance', '~> 1.1'
+  gem.add_development_dependency 'simplecov', '~> 0.7'
+  gem.add_development_dependency 'timecop', '~> 0.5'
+  gem.add_development_dependency 'vcr', '~> 4.0'
+  gem.add_development_dependency 'webmock', '~> 3.5'
+end

data/lib/gandi_v5/billing/info/prepaid.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+class GandiV5
+  class Billing
+    class Info
+      # Account's prepaid information.
+      # @!attribute [r] amount
+      #   @return [Numeric] current amount available in the prepaid account.
+      # @!attribute [r] currency
+      #   @return [String] currency in use for the prepaid account.
+      # @!attribute [r] warning_threshold
+      #   @return [Numeric] amount under which a warning email is sent.
+      # @!attribute [r] created_at
+      #   @return [Time] creation date of the prepaid account.
+      # @!attribute [r] updated_at
+      #   @return [Time] last modification date of the prepaid account.
+      class Prepaid
+        include GandiV5::Data
+
+        members :amount, :currency, :warning_threshold
+        member :created_at, converter: GandiV5::Data::Converter::Time
+        member :updated_at, converter: GandiV5::Data::Converter::Time
+
+        # Check if current balance is below the warning threshold.
+        def warning?
+          return nil if warning_threshold.nil?
+
+          amount < warning_threshold
+        end
+      end
+    end
+  end
+end

data/lib/gandi_v5/billing/info.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative 'info/prepaid'
+
+class GandiV5
+  class Billing
+    # Account's information.
+    # @!attribute [r] annual_balance
+    #   @return [Numeric] amount of purchased over the past 12 months since the request.
+    # @!attribute [r] outstanding_amount
+    #   @return [Numeric] amount of outstanding orders (payment by terms) since the last invoice.
+    # @!attribute [r] grid
+    #   @return [String] price rate that is applied
+    #      depending on the amount purchased over the last 12 months.
+    # @!attribute [r] prepaid_monthly_invoice
+    #   @return [nil, Boolean] whether orders are gathered into a single monthly invoice.
+    # @!attribute [r] prepaid
+    #   @return [nil, Gandiv5::Billing::Info::Prepaid]
+    class Info
+      include GandiV5::Data
+
+      members :annual_balance, :grid, :outstanding_amount, :prepaid_monthly_invoice
+      member :prepaid, converter: GandiV5::Billing::Info::Prepaid
+    end
+  end
+end

data/lib/gandi_v5/billing.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative 'billing/info'
+
+class GandiV5
+  # Gandi Billing API.
+  # @see https://api.gandi.net/docs/billing
+  class Billing
+    # Get account info (defaults to currently authenticated user).
+    # @see https://api.gandi.net/docs/billing#get-v5-billing-info
+    # @param url [sharing_id] the Sharing ID of the organisation to get info for
+    #   defaults to the user the api key belomgs to.
+    # @return [GandiV5::Billing::Info]
+    # @raise [GandiV5::Error::GandiError::GandiError] if Gandi returns an error.
+    def self.info(sharing_id = nil)
+      data = GandiV5.get url(sharing_id)
+      GandiV5::Billing::Info.from_gandi data
+    end
+
+    private
+
+    def self.url(sharing_id = nil)
+      "#{BASE}billing/info" +
+        (sharing_id ? "/#{CGI.escape sharing_id}" : '')
+    end
+    private_class_method :url
+  end
+end

data/lib/gandi_v5/data/converter/array_of.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+class GandiV5
+  module Data
+    class Converter
+      # Used for applying the same converter to each item in an array.
+      class ArrayOf
+        # @param converter the converter to apply to each item in the array.
+        def initialize(converter)
+          @converter = converter
+        end
+
+        # @param value [Array<Object>]
+        # @return [Array<Object>]
+        def to_gandi(value)
+          return nil if value.nil?
+
+          value.map { |item| converter.to_gandi(item) }
+        end
+
+        # @param [Array<Object>]
+        # @return value [Array<Object>]
+        def from_gandi(value)
+          return nil if value.nil?
+
+          value.map { |item| converter.from_gandi(item) }
+        end
+
+        private
+
+        attr_reader :converter
+      end
+    end
+  end
+end

data/lib/gandi_v5/data/converter/symbol.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+class GandiV5
+  module Data
+    class Converter
+      # Methods for converting strings to/from symbols.
+      class Symbol
+        # @param value [Symbol]
+        # @return [String]
+        def self.to_gandi(value)
+          return nil if value.nil?
+
+          value.to_s
+        end
+
+        # @param [String]
+        # @return value [Symbol]
+        def self.from_gandi(value)
+          return nil if value.nil?
+
+          value.to_sym
+        end
+      end
+    end
+  end
+end

data/lib/gandi_v5/data/converter/time.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+class GandiV5
+  module Data
+    class Converter
+      # Methods for converting times to/from Gandi ("2019-02-13T11:04:18Z").
+      class Time
+        # Convert a time to Gandi's prefered string format.
+        # @param value [Time]
+        # @return [String]
+        def self.to_gandi(value)
+          return nil if value.nil?
+
+          value.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+        end
+
+        # Convert a time from Gandi's prefered string format.
+        # @param [String]
+        # @return value [Time]
+        def self.from_gandi(value)
+          return nil if value.nil?
+
+          ::Time.parse value
+        end
+      end
+    end
+  end
+end

data/lib/gandi_v5/data/converter.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative 'converter/array_of'
+require_relative 'converter/symbol'
+require_relative 'converter/time'
+
+class GandiV5
+  module Data
+    # Namespace for converters to/from Gandi's format.
+    class Converter
+      # Initialize a new simple converter.
+      # The passed procs will be run at the appropriate time.
+      # @param from_gandi [Proc]
+      # @param to_gandi [Proc]
+      def initialize(from_gandi: nil, to_gandi: nil)
+        @from_gandi_proc = from_gandi
+        @to_gandi_proc = to_gandi
+      end
+
+      # @param value [Object]
+      # @return [Object]
+      def to_gandi(value)
+        return value unless to_gandi_proc
+
+        to_gandi_proc.call value
+      end
+
+      # @param [Object]
+      # @return value [Object]
+      def from_gandi(value)
+        return value unless from_gandi_proc
+
+        from_gandi_proc.call value
+      end
+
+      private
+
+      attr_reader :from_gandi_proc, :to_gandi_proc
+    end
+  end
+end