marklogic 0.0.1

data/lib/marklogic/database_settings.rb

@@ -0,0 +1,13 @@
+module MarkLogic
+  module DatabaseSettings
+    autoload :Index, 'marklogic/database_settings/index'
+    autoload :ElementWordLexicon, 'marklogic/database_settings/element_word_lexicon'
+    autoload :GeospatialElementChildIndex, 'marklogic/database_settings/geospatial_element_child_index'
+    autoload :GeospatialElementIndex, 'marklogic/database_settings/geospatial_element_index'
+    autoload :GeospatialElementPairIndex, 'marklogic/database_settings/geospatial_element_pair_index'
+    autoload :GeospatialPathIndex, 'marklogic/database_settings/geospatial_path_index'
+    autoload :RangeElementIndex, 'marklogic/database_settings/range_element_index'
+    autoload :RangeFieldIndex, 'marklogic/database_settings/range_field_index'
+    autoload :RangePathIndex, 'marklogic/database_settings/range_path_index'
+  end
+end

data/lib/marklogic/database_settings/element_word_lexicon.rb

@@ -0,0 +1,28 @@
+module MarkLogic
+  module DatabaseSettings
+    class ElementWordLexicon
+      def initialize(localname, collation = DEFAULT_COLLATION)
+        @localname = localname
+        @collation = collation
+      end
+
+      def append_to_db(database)
+        database.add_index("element-word-lexicon", self)
+      end
+
+      def key
+        %Q{#{self.class.to_s}-#{@localname}}
+      end
+
+      def to_json(options = nil)
+        {
+          "element-word-lexicon" => {
+            "namespace-uri" => "",
+            "localname" => @localname,
+            "collation" => @collation
+          }
+        }
+      end
+    end
+  end
+end

data/lib/marklogic/database_settings/geospatial_element_child_index.rb

@@ -0,0 +1,41 @@
+module MarkLogic
+  module DatabaseSettings
+    class GeospatialElementChildIndex
+
+      attr_accessor :parent_localname, :localname, :facet
+
+      def initialize(parent_localname, child_localname, options = {})
+        @parent_localname = parent_localname
+        @localname = child_localname
+        @coordinate_system = options[:coordinate_system] || MarkLogic::GEO_WGS84
+        @point_format = options[:point_format] || MarkLogic::POINT
+        @range_value_positions = options[:range_value_positions] || false
+        @invalid_values = options[:invalid_values] || MarkLogic::REJECT
+        @facet = options[:facet] || false
+      end
+
+      def key
+        %Q{#{self.class.to_s}-#{@localname}}
+      end
+
+      def append_to_db(database)
+        database.add_index("geospatial-element-child-index", self)
+      end
+
+      def to_json(options = nil)
+        {
+          "geospatial-element-child-index" => {
+            "parent-namespace-uri" => "",
+            "parent-localname" => @parent_localname,
+            "namespace-uri" => "",
+            "localname" => @localname,
+            "coordinate-system" => @coordinate_system,
+            "point-format" => @point_format,
+            "range-value-positions" => @range_value_positions,
+            "invalid-values" => @invalid_values
+          }
+        }
+      end
+    end
+  end
+end

data/lib/marklogic/database_settings/geospatial_element_index.rb

@@ -0,0 +1,38 @@
+module MarkLogic
+  module DatabaseSettings
+    class GeospatialElementIndex
+
+      attr_accessor :localname, :facet
+
+      def initialize(element_name, options = {})
+        @localname = element_name
+        @coordinate_system = options[:coordinate_system] || MarkLogic::GEO_WGS84
+        @point_format = options[:point_format] || MarkLogic::POINT
+        @range_value_positions = options[:range_value_positions] || false
+        @invalid_values = options[:invalid_values] || MarkLogic::REJECT
+        @facet = options[:facet] || false
+      end
+
+      def key
+        %Q{#{self.class.to_s}-#{@localname}}
+      end
+
+      def append_to_db(database)
+        database.add_index("geospatial-element-index", self)
+      end
+
+      def to_json(options = nil)
+        {
+          "geospatial-element-index" => {
+            "namespace-uri" => "",
+            "localname" => @localname,
+            "coordinate-system" => @coordinate_system,
+            "point-format" => @point_format,
+            "range-value-positions" => @range_value_positions,
+            "invalid-values" => @invalid_values
+          }
+        }
+      end
+    end
+  end
+end

data/lib/marklogic/database_settings/geospatial_element_pair_index.rb

@@ -0,0 +1,42 @@
+module MarkLogic
+  module DatabaseSettings
+    class GeospatialElementPairIndex
+
+      attr_accessor :parent_localname, :latitude_localname, :longitude_localname, :facet
+
+      def initialize(element_name, latitude_localname, longitude_localname, options = {})
+        @parent_localname = element_name
+        @latitude_localname = latitude_localname
+        @longitude_localname = longitude_localname
+        @coordinate_system = options[:coordinate_system] || MarkLogic::GEO_WGS84
+        @range_value_positions = options[:range_value_positions] || false
+        @invalid_values = options[:invalid_values] || MarkLogic::REJECT
+        @facet = options[:facet] || false
+      end
+
+      def key
+        %Q{#{self.class.to_s}-#{@localname}}
+      end
+
+      def append_to_db(database)
+        database.add_index("geospatial-element-pair-index", self)
+      end
+
+      def to_json(options = nil)
+        {
+          "geospatial-element-pair-index" => {
+            "parent-namespace-uri" => "",
+            "parent-localname" => @parent_localname,
+            "latitude-namespace-uri" => "",
+            "latitude-localname" => @latitude_localname,
+            "longitude-namespace-uri" => "",
+            "longitude-localname" => @longitude_localname,
+            "coordinate-system" => @coordinate_system,
+            "range-value-positions" => @range_value_positions,
+            "invalid-values" => @invalid_values
+          }
+        }
+      end
+    end
+  end
+end

data/lib/marklogic/database_settings/geospatial_path_index.rb

@@ -0,0 +1,37 @@
+module MarkLogic
+  module DatabaseSettings
+    class GeospatialPathIndex
+
+      attr_accessor :path_expression, :facet
+
+      def initialize(path_expression, options = {})
+        @path_expression = path_expression
+        @coordinate_system = options[:coordinate_system] || MarkLogic::GEO_WGS84
+        @point_format = options[:point_format] || MarkLogic::POINT
+        @range_value_positions = options[:range_value_positions] || false
+        @invalid_values = options[:invalid_values] || MarkLogic::REJECT
+        @facet = options[:facet] || false
+      end
+
+      def key
+        %Q{#{self.class.to_s}-#{@localname}}
+      end
+
+      def append_to_db(database)
+        database.add_index("geospatial-path-index", self)
+      end
+
+      def to_json(options = nil)
+        {
+          "geospatial-path-index" => {
+            "path-expression" => @path_expression,
+            "coordinate-system" => @coordinate_system,
+            "point-format" => @point_format,
+            "range-value-positions" => @range_value_positions,
+            "invalid-values" => @invalid_values
+          }
+        }
+      end
+    end
+  end
+end

data/lib/marklogic/database_settings/index.rb

@@ -0,0 +1,27 @@
+module MarkLogic
+  module DatabaseSettings
+    class Index
+
+      def self.from_json(type, json)
+        case type
+          when 'range-element-index'
+            RangeElementIndex.from_json(json)
+          when 'element-word-lexicon'
+            ElementWordLexicon.from_json(json)
+          when 'range-path-index'
+            RangepathIndex.from_json(json)
+          when 'range-field-index'
+            RangeFieldIndex.from_json(json)
+          when 'geospatial-element-index'
+            GeospatialElementIndex.from_json(json)
+          when 'geospatial-element-child-index'
+            GeospatialElementChildIndex.from_json(json)
+          when 'geospatial-element-pair-index'
+            GeospatialElementPairIndex.from_json(json)
+          when 'geospatial-path-index'
+            GeospatialPathIndex.from_json(json)
+          end
+        end
+      end
+  end
+end

data/lib/marklogic/database_settings/range_element_index.rb

@@ -0,0 +1,77 @@
+module MarkLogic
+  module DatabaseSettings
+    class RangeElementIndex
+
+      attr_accessor :scalar_type, :localname, :namespace_uri, :collation, :range_value_positions, :invalid_values, :facet
+
+      def initialize(name, options = {})
+        @scalar_type = options[:type] || 'string'
+        @localname = name.to_s
+        @namespace_uri = options[:namespace] || ""
+        @collation = options[:collation] || (@scalar_type == 'string' ? MarkLogic::DEFAULT_COLLATION : "")
+        @range_value_positions = options[:range_value_positions] || false
+        @invalid_values = options[:invalid_values] || MarkLogic::REJECT
+        @facet = options[:facet] || false
+      end
+
+      def key
+        %Q{#{self.class.to_s}-#{@localname}}
+      end
+
+      def <=>(other)
+        localname <=> other.localname
+      end
+
+      def ==(other)
+        self.class == other.class and
+        scalar_type == other.scalar_type and
+        localname = other.localname and
+        namespace_uri = other.namespace_uri and
+        collation == other.collation and
+        range_value_positions == other.range_value_positions and
+        invalid_values == other.invalid_values
+      end
+
+      def type
+        "range-element-index"
+      end
+
+      def append_to_db(database)
+        database.add_index("range-element-index", self)
+      end
+
+      def to_json(options = nil)
+        {
+          "scalar-type" => @scalar_type,
+          "namespace-uri" => @namespace_uri,
+          "localname" => @localname,
+          "collation" => @collation,
+          "range-value-positions" => @range_value_positions,
+          "invalid-values" => @invalid_values
+        }
+      end
+
+      def to_ref
+        options = [%Q{"type=#{@scalar_type}"}]
+        options << %Q{"collation=#{@collation}"} if @scalar_type == "string"
+        %Q{cts:json-property-reference("#{@localname}", (#{options.join(',')}))}
+      end
+
+      def self.from_json(json)
+        index = allocate
+        index.from_json(json)
+        index
+      end
+
+      def from_json(json)
+        @scalar_type = json['scalar-type']
+        @namespace_uri = json['namespace-uri']
+        @localname = json['localname']
+        @collation = json['collation']
+        @range_value_positions = json['range-value-positions']
+        @invalid_values = json['invalid-values']
+        @facet = false
+      end
+    end
+  end
+end

data/lib/marklogic/database_settings/range_field_index.rb

@@ -0,0 +1,37 @@
+module MarkLogic
+  module DatabaseSettings
+    class RangeFieldIndex
+
+      attr_accessor :scalar_type, :field_name, :collation, :facet
+
+      def initialize(field_name, options = {})
+        @scalar_type = options[:type] || MarkLogic::STRING
+        @field_name = field_name
+        @collation = options[:collation] || DEFAULT_COLLATION
+        @range_value_positions = options[:range_value_positions] || false
+        @invalid_values = options[:invalid_values] || MarkLogic::REJECT
+        @facet = options[:facet] || false
+      end
+
+      def key
+        %Q{#{self.class.to_s}-#{@localname}}
+      end
+
+      def append_to_db(database)
+        database.add_index("range-field-index", self)
+      end
+
+      def to_json(options = nil)
+        {
+          "range-field-index" => {
+            "scalar-type" => @scalar_type,
+            "field-name" => @field_name,
+            "collation" => @collation,
+            "range-value-positions" => @range_value_positions,
+            "invalid-values" => @invalid_values
+          }
+        }
+      end
+    end
+  end
+end

data/lib/marklogic/database_settings/range_path_index.rb

@@ -0,0 +1,37 @@
+module MarkLogic
+  module DatabaseSettings
+    class RangePathIndex
+
+      attr_accessor :scalar_type, :collation, :path_expression, :facet
+
+      def initialize(path_expression, options = {})
+        @scalar_type = options[:type] || MarkLogic::STRING
+        @collation = options[:collation] || DEFAULT_COLLATION
+        @path_expression = path_expression
+        @range_value_positions = options[:range_value_positions] || false
+        @invalid_values = options[:invalid_values] || MarkLogic::REJECT
+        @facet = options[:facet] || false
+      end
+
+      def key
+        %Q{#{self.class.to_s}-#{@localname}}
+      end
+
+      def append_to_db(database)
+        database.add_index("range-path-index", self)
+      end
+
+      def to_json(options = nil)
+        {
+          "range-path-index" => {
+            "scalar-type" => @scalar_type,
+            "collation" => @collation,
+            "path-expression" => @path_expression,
+            "range-value-positions" => @range_value_positions,
+            "invalid-values" => @invalid_values
+          }
+        }
+      end
+    end
+  end
+end

data/lib/marklogic/exceptions.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+module MarkLogic
+  class MissingIndexError < StandardError; end
+  class SearchError < StandardError; end
+end

data/lib/marklogic/forest.rb

@@ -0,0 +1,47 @@
+module MarkLogic
+  class Forest
+    include MarkLogic::Persistence
+
+    attr_accessor :forest_name
+    def initialize(forest_name, host_name = nil, conn = nil)
+      self.connection = conn
+      @forest_name = forest_name
+      @host_name = host_name || self.manage_connection.host
+      @options = {
+        "forest-name" => @forest_name,
+        "host" => @host_name
+      }
+    end
+
+    def []=(key, value)
+      @options[key] = value
+    end
+
+    def [](key)
+      @options[key]
+    end
+
+    def has_key?(key)
+      @options.has_key?(key)
+    end
+
+    def database=(db)
+      @database = db
+      @options['database'] = db.database_name
+    end
+
+    def create
+      r = manage_connection.post_json(
+        %Q{/manage/v2/forests?format=json},
+        @options)
+    end
+
+    def exists?
+      manage_connection.head(%Q{/manage/v2/forests/#{forest_name}}).code.to_i == 200
+    end
+
+    def drop
+      r = manage_connection.delete(%Q{/manage/v2/forests/#{forest_name}?level=full&format=json})
+    end
+  end
+end