easy-exist 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 737047bef920cbfe0d8eea570262ffb60373384f
+  data.tar.gz: 7961d81d7d2acd4040ebc52c3f21e4697d3bad46
+SHA512:
+  metadata.gz: 87a2179c43a6c3e4813a76b0411687b36d46581a1ce02ec3369a3f2cbb9cdeb6264eaa6ef25ae931a3964f9e5ea2b1dead020141e13e2936ed9bd6ff9f7da747
+  data.tar.gz: f1d0167739ae35fdef4991c9aa4711fafe09104d43cc25a56478edfa6f45354b1cc6dfba4baf4680bcc162fb54beb1a93836999a115fd63fa3c6378691c4e114

data/lib/easy-exist/db.rb

@@ -0,0 +1,109 @@
+module EasyExist
+
+	# Responsible for communicating with the eXist-db server
+	class DB
+
+		# Initializes an EasyExist::DB.
+		#
+		# @param url [String] the url to the eXist-db server, include protocol.
+		# @param opts [Hash] options to initialize the DB with.
+		# @option opts :collection [String] The collection for which all GET, PUT and DELETE requests will be relative to.
+		# @option opts :username [String] Username for Basic HTTP Authentication.
+		# @option opts :password [String] Password for Basic HTTP Authentication.
+		# @return [EasyExist::DB] an instance of an EasyExist::DB.
+		def initialize(url, opts = {})
+			validate_opts(opts)
+			@default_opts = { base_uri: url + "/exist/rest/db#{opts[:collection] ||= ''}" }
+			if(opts[:username] && opts[:password])
+				@default_opts[:basic_auth] = { username: opts[:username], password: opts[:password] }
+			end
+		end
+
+		# Retrieves the document at the specified document_uri from the store.
+		#
+		# @param document_uri [String] the uri of the document to retrieve.
+		# relative to the collection specified on initialization otherwise '/db'.
+		# @return [String] the contents of the document at 'document_uri'
+		def get(document_uri)
+			validate_uri(document_uri)
+			res = HTTParty.get(document_uri, @default_opts)
+			res.success? ? res.body	: handle_error(res)
+		end
+
+		# Puts the given document content at the specified document_uri
+		#
+		# @param document_uri [String] the uri of the document to store.
+		# relative to the collection specified on initialization otherwise '/db'.
+		# @return [HTTParty::Response] the response object
+		def put(document_uri, document)
+			validate_uri(document_uri)
+			res = HTTParty.put(document_uri, @default_opts.merge({
+				body: document,
+				headers: { "Content-Type" => "application/xml"},
+			}))
+			res.success? ? res : handle_error(res)
+		end
+
+		# Deletes the document at the specified document_uri from the store
+		#
+		# @param document_uri [String] the uri of the document to delete.
+		# relative to the collection specified on initialization otherwise '/db'.
+		# @return [HTTParty::Response] the response object
+		def delete(document_uri)
+			validate_uri(document_uri)
+			res = HTTParty.delete(document_uri, @default_opts)
+			res.success? ? res : handle_error(res)
+		end
+
+		# Determines if the document at the specified document_uri exists in the store
+		#
+		# @param document_uri [String] the uri of the document to check.
+		# relative to the collection specified on initialization otherwise '/db'.
+		# @return [TrueClass | FalseClass] 
+		def exists?(document_uri)
+			validate_uri(document_uri)
+			HTTParty.get(document_uri, @default_opts).success?
+		end
+
+		# Runs the given XQuery against the store and returns the results
+		#
+		# @param query [String] XQuery to run against the store
+		# @param opts [Hash] options for the query request.
+		# @option opts :start [Integer] Index of first item to be returned.
+		# @option opts :max [Integer] The maximum number of items to be returned.
+		# @return [String] the query results
+		def query(query, opts = {})
+			body = EasyExist::QueryRequest.new(query, opts).body
+			res = HTTParty.post("", @default_opts.merge({
+				body: body,
+				headers: { 'Content-Type' => 'application/xml', 'Content-Length' => body.length.to_s }
+			}))
+			res.success? ? res.body : handle_error(res)
+		end
+
+		private
+			# Raises an error based on a HTTParty::Response.
+			# HTTParty:Response objects contain a reference to the Net::HTTResponse object.
+			# Where a request is unsuccessful, the reference can be raised as an exception for clients to rescue
+			# and decide on next steps.
+			#
+			# @param res [HTTParty::Response] the response
+			def handle_error(res)
+				res.response.value
+			end
+
+			# Raises an error if the given uri does not start with a '/'
+			#
+			# @param uri [String] the uri to validate
+			def validate_uri(uri)
+				raise ArgumentError, 'URI must contain preceding "/"' if uri[0] != '/';
+			end
+
+			# Raises an error if any of the given opts are invalid
+			#
+			# @param opts [Hash] options to validate.
+			def validate_opts(opts)
+				validate_uri(opts[:collection]) unless opts[:collection].nil? || opts[:collection].empty?
+			end
+	end
+end

data/lib/easy-exist/query_request.rb

@@ -0,0 +1,45 @@
+module EasyExist
+
+	# Representation of an eXist-db query request.
+	# Responsible for encapsulating the XQuery text ready to POST to server.
+	class QueryRequest
+
+		using EasyExist::RefinedTrue
+		using EasyExist::RefinedFalse
+		using EasyExist::RefinedObject
+
+		# Initializes an EasyExist::QueryRequest.
+		# Takes the given XQuery text and builds an Nokogiri::XML object around it.
+		#
+		# @param text [String] the XQuery text
+		# @param opts [Hash] options for the query request.
+		# @option opts :start [Integer] Index of first item to be returned.
+		# @option opts :max [Integer] The maximum number of items to be returned.
+		# @option opts :wrap [Boolean] Wrap results in exist:result element.
+		# @return [EasyExist::QueryRequest] an instance of an EasyExist::QueryRequest.
+		def initialize(text, opts = {})
+			@body = Nokogiri::XML::Builder.new do |xml|
+				xml.query({ xmlns: EXIST_NAMESPACE }.merge(parse_opts(opts))) {
+					xml.text_ text
+				}
+			end
+		end
+
+		# Returns the request body as xml
+		#
+		# @return [String] the request body
+		def body
+			@body.to_xml
+		end
+
+		private
+			def parse_opts(opts)
+				if(opts.key?(:wrap)) then
+					raise(ArgumentError, ":wrap must be a TrueClass or FalseClass") unless opts[:wrap].is_a_boolean?
+					opts[:wrap] = opts[:wrap].to_yes_no
+				end
+				opts
+			end
+	end
+
+end

data/lib/easy-exist.rb

@@ -0,0 +1,12 @@
+require 'httparty'
+require 'nokogiri'
+require_relative "./easy-exist/refinements"
+require_relative "./easy-exist/query_request"
+require_relative "./easy-exist/db"
+
+# The EasyExist module
+module EasyExist
+
+	# Defines the eXist-db xml namespace
+	EXIST_NAMESPACE = "http://exist.sourceforge.net/NS/exist"
+end

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: easy-exist
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Tom Cass
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.13'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.6.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+- !ruby/object:Gem::Dependency
+  name: pry-debugger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+description: An easy to use gem to interact with eXist-db via its REST API.
+email: easy.exist.gem@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/easy-exist.rb
+- lib/easy-exist/db.rb
+- lib/easy-exist/query_request.rb
+homepage: http://rubygems.org/gems/easy-exist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: eXist-db made easy!
+test_files: []
+has_rdoc: