moniker_activeresource 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,20 @@
+source 'https://rubygems.org'
+
+gem "activemodel", "~> 3.2.12", :require => 'active_model'
+gem "activeresource", "~> 3.2.12", :require => 'active_resource'
+
+gem "oj", "~> 1.2.9"
+
+group :development, :test do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "jeweler", "~> 1.8.4"
+  gem "simplecov", ">= 0"
+  gem 'test-unit'
+end
+
+# Security fixes
+gem "json", "~> 1.7.7"
+
+# OpenStack ActiveResource
+gem 'openstack_activeresource', '~> 0.5.0'

data/Gemfile.lock

@@ -0,0 +1,63 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activeresource (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    bourne (1.1.2)
+      mocha (= 0.10.5)
+    builder (3.0.4)
+    git (1.2.5)
+    i18n (0.6.4)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.7)
+    metaclass (0.0.1)
+    mocha (0.10.5)
+      metaclass (~> 0.0.1)
+    multi_json (1.6.1)
+    oj (1.2.13)
+    openstack_activeresource (0.5.0)
+      activemodel (~> 3.2.12)
+      activeresource (~> 3.2.12)
+      json (~> 1.7.7)
+      oj (~> 1.2.9)
+    rake (10.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    shoulda (3.3.2)
+      shoulda-context (~> 1.0.1)
+      shoulda-matchers (~> 1.4.1)
+    shoulda-context (1.0.2)
+    shoulda-matchers (1.4.2)
+      activesupport (>= 3.0.0)
+      bourne (~> 1.1.2)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    test-unit (2.5.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activemodel (~> 3.2.12)
+  activeresource (~> 3.2.12)
+  jeweler (~> 1.8.4)
+  json (~> 1.7.7)
+  oj (~> 1.2.9)
+  openstack_activeresource (~> 0.5.0)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov
+  test-unit

data/LICENSE.txt

@@ -0,0 +1,16 @@
+Moniker-ActiveResource
+Copyright (c) 2013 Davide Guerri (@dguerri davide.guerri@gmail.com)
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU General Public License as published by
+the Free Software Foundation, either version 3 of the License, or
+(at your option) any later version.
+
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/>.
+

data/README.rdoc

@@ -0,0 +1,156 @@
+= moniker_activeresource
+
+Moniker Ruby and RoR bindings implemented with ActiveResource
+
+Moniker - DNS for OpenStack — Read more at https://launchpad.net/moniker
+
+Please note: Moniker is still in alpha stage so is the same for this gem!
+
+Tested on Moniker commit 2c66df879574cb595bd8f703818f503badce3bad
+
+== Installation
+
+Not yet released on rubygems.
+To install this gem clone this repository and:
+
+    gem install bundler # If not already installed
+    bundle install
+    rake install
+
+== Sample usage
+
+This section is incomplete. Please see unit tests for more info.
+
+=== Keystone authentication and Moniker setup
+
+    OpenStack::Keystone::Public::Base.site = "https://my.api.com:5000/v2.0/"
+
+    auth = OpenStack::Keystone::Public::Auth.new :username  => "me",
+                                                 :password  => "my pass",
+                                                 :tenant_id => "my_tenant"
+
+    if auth.save
+      Moniker::Base.token = auth.token
+      Moniker::Base.site  = auth.endpoint_for('dns').publicURL
+      # *** Set the sudo tenant id (if needed!)
+      Moniker::Base.sudo_tenant = "another tenant id"
+    else
+      raise "Cannot authenticate!"
+    end
+
+=== Create a new server (requires an administrative role)
+
+    new_server = Moniker::Server.create :name => "test.test-server.test."
+
+=== List existing server (requires an administrative role)
+
+    servers = Moniker::Server.all
+
+=== Get a server (requires an administrative role)
+
+    # By name
+    server = Moniker::Server.find_by_name "test.test-server.test."
+    # By id
+    Moniker::Server.find "ffffffff-ffff-ffff-ffff-ffffffffffff"
+
+=== Update a server  (requires an administrative role)
+
+    server = Moniker::Server.find_by_name "test.test-server.test."
+    server.update_attributes :name => "up-test.test-server.test."
+    server.save
+    # Done! Now revert
+    server.name = "test.test-server.test."
+    server.save
+
+=== Destroy a server (requires an administrative role)
+
+    server = Moniker::Server.find_by_name "test.test-server.test."
+    server.destroy
+
+=== Create a new domain (depending on your configuration, this might require an administrative role)
+
+    new_domain = Moniker::Domain.create :name => "test.test-domain.test.", :email => "fake@pretend.net"
+
+=== List existing domains
+
+    domains = Moniker::Domain.all
+
+=== Get a domain
+
+    # By name
+    domain = Moniker::Domain.find_by_name "test.test-domain.test."
+    # By id
+    Moniker::Domain.find "ffffffff-ffff-ffff-ffff-ffffffffffff"
+
+=== Update a domain (depending on your configuration, this might require an administrative role)
+
+    domain = Moniker::Domain.find_by_name n"test.test-domain.test."ame
+    domain.update_attributes :ttl => 225
+    domain.save
+    # Again but now without update_attributes
+    domain.ttl = 128
+    domain.save
+
+=== Destroy a domain (depending on your configuration, this might require an administrative role)
+
+    domain = Moniker::Domain.find_by_name n"test.test-domain.test."ame
+    domain.destroy
+
+=== Create a new record
+
+    domain = Moniker::Domain.find_by_name "test.test-domain.test."
+    new_record = Moniker::Record.create :name => record_name,
+                                        :type => "A",
+                                        :data => "1.1.1.1",
+                                        :domain_id => domain.id
+
+=== List existing records in a domain
+
+    domain = Moniker::Domain.find_by_name "test.test-domain.test."
+    records = Moniker::Record.all :params => {:domain_id => domain.id}
+
+=== Get a record in a domain
+
+    domain = Moniker::Domain.find_by_name "test.test-domain.test."
+    # All by name
+    records = Moniker::Record.find_all_by_name record_name, :params => {:domain_id => domain.id}
+    # All by type
+    records = Moniker::Record.find_all_by_type "AAAA", :params => {:domain_id => domain.id}
+    # All by data
+    records = Moniker::Record.find_all_by_data "1.1.1.1", :params => {:domain_id => domain.id}
+    # By id
+    record = Moniker::Record.find "ffffffff-ffff-ffff-ffff-ffffffffffff", :params => {:domain_id => domain.id}
+
+=== Update a record in a domain
+
+    record = Moniker::Record.find "ffffffff-ffff-ffff-ffff-ffffffffffff", :params => {:domain_id => domain.id}
+    record.update_attributes :ttl => 225
+    record.save
+    # Again but now without update_attributes
+    record.ttl = 128
+    record.save
+
+=== Destroy a record in a domain
+
+    record = Moniker::Record.find "ffffffff-ffff-ffff-ffff-ffffffffffff", :params => {:domain_id => domain.id}
+    record.destroy
+
+== Known limitation
+
+Works only with OpenStack Keystone authentication
+
+== Contributing to moniker_activeresource
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Davide Guerri (@dguerri davide.guerri@gmail.com). See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,52 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "moniker_activeresource"
+  gem.homepage = "https://github.com/Unidata-SpA/moniker_activeresource"
+  gem.license = "GPLv3"
+  gem.summary = %Q{Moniker Ruby and RoR bindings implemented with ActiveResource}
+  gem.description = %Q{Moniker Ruby and RoR bindings implemented with ActiveResource - See also http://www.unicloud.it}
+  gem.email = "d.guerri@rd.unidata.it"
+  gem.authors = ["Davide Guerri"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+desc "Code coverage detail"
+task :simplecov do
+  ENV['COVERAGE'] = "true"
+  Rake::Task['<%= test_task %>'].execute
+end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Moniker-Activeresource #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb']
+  t.verbose = true
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/hot_fixes.rb

@@ -0,0 +1,60 @@
+# This file is part of the Moniker-ActiveResource
+#
+# Copyright (C) 2013 Unidata S.p.A. (Davide Guerri - davide.guerri@gmail.com)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+# Reopens ActiveResource::Base to fix "ActiveResource nested resources not being persisted"
+# See https://github.com/rails/rails/pull/3107
+# and https://github.com/rails/activeresource/pull/30
+# Fixes non yet included in any ActiveResource releases (as of 2013-02-28)
+module ActiveResource # :nodoc:
+  class Base
+
+    def load(attributes, remove_root = false)
+      raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
+      @prefix_options, attributes = split_options(attributes)
+
+      if attributes.keys.size == 1
+        remove_root = self.class.element_name == attributes.keys.first.to_s
+      end
+
+      attributes = Formats.remove_root(attributes) if remove_root
+
+      attributes.each do |key, value|
+        @attributes[key.to_s] =
+            case value
+              when Array
+                resource = nil
+                value.map do |attrs|
+                  if attrs.is_a?(Hash)
+                    resource ||= find_or_create_resource_for_collection(key)
+                    resource.new(attrs, attrs.has_key?(resource.primary_key.to_s))
+                  else
+                    attrs.duplicable? ? attrs.dup : attrs
+                  end
+                end
+              when Hash
+                resource = find_or_create_resource_for(key)
+                resource.new(value, value.has_key?(resource.primary_key.to_s))
+              else
+                value.duplicable? ? value.dup : value
+            end
+      end
+
+      self
+    end
+
+  end
+end

data/lib/moniker.rb

@@ -0,0 +1,43 @@
+# This file is part of the Moniker-ActiveResource
+#
+# Copyright (C) 2013 Unidata S.p.A. (Davide Guerri - davide.guerri@gmail.com)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'rubygems'
+require 'bundler'
+
+libdir = File.dirname(__FILE__)
+Dir.chdir libdir do
+  Bundler.setup
+end
+Bundler.require :default
+
+open_stack_path = File.expand_path('..', __FILE__)
+$:.unshift(open_stack_path) if File.directory?(open_stack_path) && !$:.include?(open_stack_path)
+
+# Load locales for countries from +locale+ directory
+I18n.load_path += Dir[ File.join(File.dirname(__FILE__), 'locale', '*.{rb,yml}') ]
+
+module Moniker
+  extend ActiveSupport::Autoload
+
+  load 'hot_fixes.rb'
+
+  autoload :Base
+  autoload :Common
+  autoload :Server
+  autoload :Domain
+  autoload :Record
+end

data/lib/moniker/base.rb

@@ -0,0 +1,133 @@
+# This file is part of the Moniker-ActiveResource
+#
+# Copyright (C) 2012 Unidata S.p.A. (Davide Guerri - davide.guerri@gmail.com)
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module Moniker
+
+  DATETIME_FORMAT="%Y-%m-%dT%H:%M:%S"
+  IPV4_REGEX= /\A(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\Z/
+  IPV4_CIDR_REGEX= /\A(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\/(3[0-2]|[1-2][0-9]|[0-9])\Z/
+
+  class Base < ActiveResource::Base
+
+    self.format = :json
+    self.timeout = 5
+
+    # Set the X-Auth-Token header if the OpenStack authentication token is present
+    # Set the X-Moniker-Sudo-Tenant-ID if a Moniker administrative access is required
+    def self.headers
+      if defined?(@headers)
+        _headers = @headers
+      elsif self != Moniker::Base && superclass.headers
+        _headers = superclass.headers
+      else
+        _headers = @headers || {}
+      end
+
+      if self.token.present?
+        _headers['X-Auth-Token'] = self.token
+      end
+
+      if self.sudo_tenant.present?
+        _headers['X-Moniker-Sudo-Tenant-ID'] = self.sudo_tenant
+      end
+
+      _headers
+    end
+
+    # The following 2 methods overloading are required for Rails applications
+
+    # Get the Moniker endpoint
+    def self.site
+      if self == OpenStack::Nova::Compute::Base
+        Thread.current[:moniker_site]
+      else
+        super
+      end
+    end
+
+    # Set the Moniker endpoint
+    def self.site=(site)
+      super(site)
+      Thread.current[:moniker_site] = @site
+      # Regenerate the prefix method
+      default = @site.path
+      default << '/' unless default[-1..-1] == '/'
+      # generate the actual method based on the current site path
+      self.prefix = default
+
+      @site
+    end
+
+    protected
+
+    # Set the authentication token
+    def self.token=(token)
+      # Trying to be thread safe here...
+      Thread.current[:open_stack_token] = token.is_a?(OpenStack::Keystone::Public::Auth::Token) ? token.id : token
+    end
+
+    # Get the current authentication token
+    def self.token
+      # Trying to be thread safe here...
+      Thread.current[:open_stack_token]
+    end
+
+    # Set the sudo-tenant for administrative access
+    def self.sudo_tenant=(tenant)
+      # Trying to be thread safe here...
+      Thread.current[:moniker_sudo_tenant] = token.is_a?(OpenStack::Keystone::Admin::Tenant) ? tenant.id : tenant
+    end
+
+    # Get the current sudo-tenant for administrative access
+    def self.sudo_tenant
+      # Trying to be thread safe here...
+      Thread.current[:moniker_sudo_tenant]
+    end
+  end
+
+end
+
+# Reopen ActiveResource::ClientError to add the proper parsing for OpenStack errors
+class ActiveResource::ClientError < ActiveResource::ConnectionError
+  alias old_message message
+  alias old_to_s to_s
+
+  def message
+    decoded_error = decode_openstack_error
+    decoded_error.nil? ? @message : decoded_error
+  rescue Exception => e
+    # Fallback to the original method
+    @message
+  end
+
+  def to_s
+    decoded_error = decode_openstack_error
+    decoded_error.nil? ? old_to_s : decoded_error
+  rescue Exception => e
+    # Fallback to the original method
+    old_to_s
+  end
+
+  private
+
+  def decode_openstack_error
+    decoded_body = ActiveSupport::JSON.decode(self.response.body)
+
+    decoded_body[decoded_body.keys[0]]['message']
+  end
+
+end