fog-dnsimple 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dcf65e13872990212aa464afd0e7b722ac833e1f
-  data.tar.gz: d4231b7ca89911e60c350aa5d1e423c3b987d051
+  metadata.gz: 0354086ffbb0b1f2866f487a18268ba11eb6be51
+  data.tar.gz: ccfcba77bec25c5a529c1f0458fd324e7ada83dc
 SHA512:
-  metadata.gz: 7bc69069676be810e0300ab1f921a765a62c24d96e473cee7c1af5cd794326dceb112364381df5e4be8f9e6f128abf2cb3e4af06b1f0e419772f97d741ff92c5
-  data.tar.gz: c79c093383b298e0485d890c1be103023939c9a7b1e9bcec9d797a9687c9d46fc57f7938420af9afd8f94a7efd8a91bb325527c124af664d9263e263a5f7c7a0
+  metadata.gz: 7ef2487be043841076620e863a78c8553f658710b315b1fed129cdf67b28460998fb0016d89a8def934f3727ceae2a8819aeb014ac02d9f242d1b7a37072be7c
+  data.tar.gz: 48ff4ad4dc4d169df5d2527d98a0e1d85b8111cda50351c6e0a8ad3db7d93ca5c480ca9fbb4035f77787fd28ba66951ce5c1064784b6b79d500953a734a1bb16

data/.ruby-gemset

@@ -0,0 +1 @@
+fog-dnsimple

data/.travis.yml

@@ -1,5 +1,18 @@
-sudo: false
 language: ruby
+
 rvm:
+  - 2.0
+  - 2.1
+  - 2.2
   - 2.3.1
-before_install: gem install bundler -v 1.12.5
+  - ruby-head
+  - jruby9k
+  - jruby-head
+
+before_install:
+  - gem install bundler
+
+matrix:
+  allow_failures:
+    - rvm: jruby-head
+    - rvm: jruby9k

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+#### Release 1.0
+
+Initial version, extracted from `fog`.

data/LICENSE.md

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2016-2016 Aetrion LLC.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 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.

data/README.md

@@ -1,8 +1,16 @@
 # Fog::Dnsimple
 
-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/fog/dnsimple`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Build Status](https://travis-ci.org/fog/fog-dnsimple.svg?branch=master)](https://travis-ci.org/fog/fog-dnsimple)
+
+
+## API Version
+
+This library currently uses the [DNSimple API v1](https://developer.dnsimple.com/v1/) 
+and it is fully compatible with the legacy implementation bundled with the `fog` gem.
+
+In other words, this is a drop-in replacement. Please note that the `dnsimple` provider
+will eventually be removed from the `fog` gem in favor of this fog-specific module.
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -20,22 +28,57 @@ Or install it yourself as:
 
     $ gem install fog-dnsimple
 
-## Usage
-
-TODO: Write usage instructions here
 
-## Development
+## Usage
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+Initialize a `Fog::DNS` object using the DNSimple provider.
 
-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`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+dns = Fog::DNS.new({
+  provider:       "DNSimple",
+  dnsimple_email: "YOUR_EMAIL",
+  dnsimple_token: "YOUR_API_V1_TOKEN",
+})
+```
 
-## Contributing
+This can then be used like other [Fog DNS](http://fog.io/dns/) providers.
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fog-dnsimple. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+```ruby
+zone = dns.zones.create(
+  domain: "example.com
+)
+record = zone.records.create(
+  name: "example.com,
+  value: "1.2.3.4,
+  type: "A"
+)
+```
 
+The following configurations are supported:
 
-## License
+```ruby
+dns = Fog::DNS.new({
+  # Use dnsimple_url to provide a different base URL, e.g. the Sandbox URL
+  dnsimple_url:   "https://api.sandbox.dnsimple.com/",
+
+  # API v1 token-based authentication
+  dnsimple_email: "...",
+  dnsimple_token: "...",
+
+  # API v1 basic-auth
+  dnsimple_email: "...",
+  dnsimple_password: "...",
+
+  # API v1 domain-token authentication
+  dnsimple_domain: "example.com",
+  dnsimple_token: "...",
+})
+```
 
-The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+## Contributing
 
+1. Fork it ( https://github.com/fog/fog-dnsimple/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`)
+5. Create new Pull Request

data/Rakefile

@@ -1,3 +1,9 @@
 require "bundler/gem_tasks"
+require "rake/testtask"
 
 task :default => :test
+
+mock = ENV['FOG_MOCK'] || 'true'
+task :test do
+  sh("export FOG_MOCK=#{mock} && bundle exec shindont")
+end

data/fog-dnsimple.gemspec

@@ -10,11 +10,19 @@ Gem::Specification.new do |spec|
   spec.email         = ["weppos@weppos.net"]
 
   spec.summary       = %q{Module for the 'fog' gem to support DNSimple.}
-  spec.description   = %q{This is currently a stub. The full gem will be released soon.}
+  spec.description   = %q{This library can be used as a module for `fog` or as standalone provider
+                        to use the DNSimple in applications.}
   spec.homepage      = "https://github.com/fog/fog-dnsimple"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
-end
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "shindo", "~> 0.3"
+
+  spec.add_dependency 'fog-core',  '~> 1.38'
+  spec.add_dependency 'fog-json',  '~> 1.0'
+end

data/lib/fog/bin/dnsimple.rb

@@ -0,0 +1,28 @@
+class Dnsimple < Fog::Bin
+  class << self
+    def class_for(key)
+      case key
+      when :dns
+        Fog::DNS::Dnsimple
+      else
+        raise ArgumentError, "Unrecognized service: #{key}"
+      end
+    end
+
+    def [](service)
+      @@connections ||= Hash.new do |hash, key|
+        hash[key] = case key
+        when :dns
+          Fog::DNS.new(:provider => 'Dnsimple')
+        else
+          raise ArgumentError, "Unrecognized service: #{key.inspect}"
+        end
+      end
+      @@connections[service]
+    end
+
+    def services
+      Fog::Dnsimple.services
+    end
+  end
+end

data/lib/fog/dnsimple.rb

@@ -1,7 +1,14 @@
-require "fog/dnsimple/version"
+require "fog/core"
+require_relative "dnsimple/version"
 
 module Fog
   module Dnsimple
-    # Your code goes here...
+    extend Fog::Provider
+
+    service(:dns, 'DNS')
+  end
+
+  module DNS
+    autoload :Dnsimple, File.expand_path('../dnsimple/dns', __FILE__)
   end
 end

data/lib/fog/dnsimple/dns.rb

@@ -0,0 +1,118 @@
+require "fog/core"
+require "fog/json"
+
+module Fog
+  module DNS
+    class Dnsimple < Fog::Service
+      recognizes :dnsimple_email, :dnsimple_password, :dnsimple_token, :dnsimple_domain, :dnsimple_url
+
+      model_path 'fog/dnsimple/models/dns'
+      model       :record
+      collection  :records
+      model       :zone
+      collection  :zones
+
+      request_path 'fog/dnsimple/requests/dns'
+      request :list_domains
+      request :create_domain
+      request :get_domain
+      request :delete_domain
+      request :create_record
+      request :list_records
+      request :update_record
+      request :delete_record
+      request :get_record
+
+      class Mock
+        def self.data
+          @data ||= Hash.new do |hash, key|
+            hash[key] = {
+                :domains => [],
+                :records => {}
+            }
+          end
+        end
+
+        def self.reset
+          @data = nil
+        end
+
+        def initialize(options={})
+          @dnsimple_email = options[:dnsimple_email]
+          @dnsimple_password  = options[:dnsimple_password]
+          @dnsimple_token = options[:dnsimple_token]
+          @dnsimple_domain = options[:dnsimple_domain]
+        end
+
+        def data
+          self.class.data[@dnsimple_email]
+        end
+
+        def reset_data
+          self.class.data.delete(@dnsimple_email)
+        end
+      end
+
+      class Real
+        def initialize(options={})
+          @dnsimple_email = options[:dnsimple_email]
+          @dnsimple_password  = options[:dnsimple_password]
+          @dnsimple_token = options[:dnsimple_token]
+          @dnsimple_domain = options[:dnsimple_domain]
+
+          if options[:dnsimple_url]
+            uri = URI.parse(options[:dnsimple_url])
+            options[:host]    = uri.host
+            options[:port]    = uri.port
+            options[:scheme]  = uri.scheme
+          end
+
+          connection_options = options[:connection_options] || {}
+          connection_options[:headers] ||= {}
+          connection_options[:headers]["User-Agent"] = "#{Fog::Core::Connection.user_agents} fog-dnsimple/#{Fog::Dnsimple::VERSION}"
+
+          host       = options[:host]        || "api.dnsimple.com"
+          persistent = options[:persistent]  || false
+          port       = options[:port]        || 443
+          scheme     = options[:scheme]      || 'https'
+          @connection = Fog::Core::Connection.new("#{scheme}://#{host}:#{port}", persistent, connection_options)
+        end
+
+        def reload
+          @connection.reset
+        end
+
+        def request(params)
+          params[:headers] ||= {}
+
+          if(@dnsimple_password)
+            key = "#{@dnsimple_email}:#{@dnsimple_password}"
+            params[:headers].merge!("Authorization" => "Basic " + Base64.encode64(key).gsub("\n",''))
+          elsif(@dnsimple_token)
+            if(@dnsimple_domain)
+              params[:headers].merge!("X-DNSimple-Domain-Token" => @dnsimple_token)
+            else
+              params[:headers].merge!("X-DNSimple-Token" => "#{@dnsimple_email}:#{@dnsimple_token}")
+            end
+          else
+            raise ArgumentError.new("Insufficient credentials to properly authenticate!")
+          end
+          params[:headers].merge!(
+              "Accept" => "application/json",
+              "Content-Type" => "application/json"
+          )
+
+          version = params.delete(:version) || 'v1'
+          params[:path] = File.join('/', version, params[:path])
+
+          response = @connection.request(params)
+
+          unless response.body.empty?
+            response.body = Fog::JSON.decode(response.body)
+          end
+          response
+        end
+      end
+    end
+  end
+end

data/lib/fog/dnsimple/models/dns/record.rb

@@ -0,0 +1,59 @@
+require 'fog/core/model'
+
+module Fog
+  module DNS
+    class Dnsimple
+      class Record < Fog::Model
+        identity :id
+
+        attribute :zone_id,     :aliases => "domain_id"
+        attribute :name
+        attribute :value,       :aliases => "content"
+        attribute :ttl
+        attribute :priority,    :aliases => "prio"
+        attribute :type,        :aliases => "record_type"
+        attribute :created_at
+        attribute :updated_at
+
+        def initialize(attributes={})
+          super
+        end
+
+        def destroy
+          service.delete_record(zone.id, identity)
+          true
+        end
+
+        def zone
+          @zone
+        end
+
+        def save
+          requires :name, :type, :value
+          options = {}
+          options[:prio] = priority if priority
+          options[:ttl]  = ttl if ttl
+
+          # decide whether its a new record or update of an existing
+          if id.nil?
+            data = service.create_record(zone.id, name, type, value, options)
+          else
+            options[:name] = name if name
+            options[:content] = value if value
+            options[:type] = type if type
+            data = service.update_record(zone.id, id, options)
+          end
+
+          merge_attributes(data.body["record"])
+          true
+        end
+
+        private
+
+        def zone=(new_zone)
+          @zone = new_zone
+        end
+      end
+    end
+  end
+end

data/lib/fog/dnsimple/models/dns/records.rb

@@ -0,0 +1,34 @@
+require 'fog/core/collection'
+require 'fog/dnsimple/models/dns/record'
+
+module Fog
+  module DNS
+    class Dnsimple
+      class Records < Fog::Collection
+        attribute :zone
+
+        model Fog::DNS::Dnsimple::Record
+
+        def all
+          requires :zone
+          clear
+          data = service.list_records(zone.id).body.map {|record| record['record']}
+          load(data)
+        end
+
+        def get(record_id)
+          requires :zone
+          data = service.get_record(zone.id, record_id).body["record"]
+          new(data)
+        rescue Excon::Errors::NotFound
+          nil
+        end
+
+        def new(attributes = {})
+          requires :zone
+          super({ :zone => zone }.merge!(attributes))
+        end
+      end
+    end
+  end
+end