ashikawa-core 0.8.0 → 0.9.0

data/lib/ashikawa-core/document.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'ashikawa-core/exceptions/client_error/resource_not_found/document_not_found'
 require 'equalizer'
 
@@ -13,7 +14,7 @@ module Ashikawa
       # @api public
       # @example Get the ID for a Document
       #   document = Ashikawa::Core::Document.new(database, raw_document)
-      #   document.id # => "my_fancy_collection/2345678"
+      #   document.id # => 'my_fancy_collection/2345678'
       attr_reader :id
 
       # The key of the document (No collection prefix)
@@ -22,7 +23,7 @@ module Ashikawa
       # @api public
       # @example Get the key for a Document
       #   document = Ashikawa::Core::Document.new(database, raw_document)
-      #   document.key # => "2345678"
+      #   document.key # => '2345678'
       attr_reader :key
 
       # The current revision of the document
@@ -38,11 +39,13 @@ module Ashikawa
       #
       # @param [Database] database
       # @param [Hash] raw_document
+      # @param [Hash] additional_data
       # @api public
       # @example Create a document
       #   document = Ashikawa::Core::Document.new(database, raw_document)
-      def initialize(database, raw_document)
+      def initialize(database, raw_document, additional_data = {})
         @database = database
+        raw_document.merge!(clean_up_additional_data(additional_data))
         parse_raw_document(raw_document)
       end
 
@@ -79,7 +82,7 @@ module Ashikawa
       #   document.delete
       def delete
         check_if_persisted!
-        send_request_for_document(:delete => {})
+        send_request_for_document(delete: {})
       end
 
       # Update the value of an attribute (Does not write to database)
@@ -102,24 +105,11 @@ module Ashikawa
       # @api public
       # @example Get the hash representation of a document
       #   document = Ashikawa::Core::Document.new(database, raw_document)
-      #   document.hash #=> { :name => "Lebowski", :occupation => "Not occupied" }
+      #   document.hash #=> { :name => 'Lebowski", :occupation => "Not occupied' }
       def hash
         @content
       end
 
-      # Convert the document into a hash
-      #
-      # @return [Hash]
-      # @api public
-      # @deprecated Use {#hash} instead.
-      # @example Get the hash representation of a document
-      #   document = Ashikawa::Core::Document.new(database, raw_document)
-      #   document.to_hash #=> { :name => "Lebowski", :occupation => "Not occupied" }
-      def to_hash
-        warn "`to_hash` is deprecated, please use `hash`"
-        hash
-      end
-
       # Save the changes to the database
       #
       # @return [Hash] parsed JSON response from the server
@@ -130,7 +120,7 @@ module Ashikawa
       #   document.save
       def save
         check_if_persisted!
-        send_request_for_document(:put => @content)
+        send_request_for_document(put: @content)
       end
 
       # Get a fresh version of this document from the database
@@ -155,7 +145,7 @@ module Ashikawa
         @id       = raw_document['_id'] || :not_persisted
         @key      = raw_document['_key']
         @revision = raw_document['_rev'] || :not_persisted
-        @content  = raw_document.delete_if { |key, value| key.start_with?("_") }
+        @content  = raw_document.delete_if { |key, value| key.start_with?('_') }
         self
       end
 
@@ -167,6 +157,18 @@ module Ashikawa
       def send_request_for_document(opts = {})
         @database.send_request("document/#{@id}", opts)
       end
+
+      # Clean up the raw data hash to have string keys
+      #
+      # @param [Hash] raw_data
+      # @return [Hash] Cleaned up hash
+      # @api private
+      def clean_up_additional_data(raw_data)
+        raw_data.reduce({}) do |result, (key, value)|
+          result[key.to_s] = value
+          result
+        end
+      end
     end
   end
 end

data/lib/ashikawa-core/edge.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'ashikawa-core/document'
 require 'equalizer'
 
@@ -13,7 +14,7 @@ module Ashikawa
       # @api public
       # @example Get the ID for the 'from' Document
       #   document = Ashikawa::Core::Edge.new(database, raw_document)
-      #   document.from_id # => "my_fancy_collection/2345678"
+      #   document.from_id # => 'my_fancy_collection/2345678'
       attr_reader :from_id
 
       # The ID of the 'to' document
@@ -22,20 +23,21 @@ module Ashikawa
       # @api public
       # @example Get the ID for the 'to' Document
       #   document = Ashikawa::Core::Edge.new(database, raw_document)
-      #   document.to_id # => "my_fancy_collection/2345678"
+      #   document.to_id # => 'my_fancy_collection/2345678'
       attr_reader :to_id
 
       # Initialize an Edge with the database and raw data
       #
       # @param [Database] database
       # @param [Hash] raw_edge
+      # @param [Hash] additional_data
       # @api public
       # @example Create an Edge
       #   document = Ashikawa::Core::Edge.new(database, raw_edge)
-      def initialize(database, raw_edge)
-        @from_id = raw_edge["_from"]
-        @to_id = raw_edge["_to"]
-        super(database, raw_edge)
+      def initialize(database, raw_edge, additional_data = {})
+        @from_id = raw_edge['_from']
+        @to_id = raw_edge['_to']
+        super(database, raw_edge, additional_data)
       end
 
       protected

data/lib/ashikawa-core/exceptions/client_error.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Ashikawa
   module Core
     # The client had an error in the request

data/lib/ashikawa-core/exceptions/client_error/authentication_failed.rb

@@ -0,0 +1,25 @@
+# -*- encoding : utf-8 -*-
+require 'ashikawa-core/exceptions/client_error.rb'
+
+module Ashikawa
+  module Core
+    # This exception is thrown when the client is not authorized
+    class AuthenticationFailed < ClientError
+      # Create a new authentication failure
+      #
+      # @return RuntimeError
+      # @api private
+      def initialize
+        super(401)
+      end
+
+      # String representation of the exception
+      #
+      # @return String
+      # @api private
+      def to_s
+        'Status 401: Authentication failed'
+      end
+    end
+  end
+end

data/lib/ashikawa-core/exceptions/client_error/bad_syntax.rb

@@ -1,4 +1,5 @@
-require "ashikawa-core/exceptions/client_error.rb"
+# -*- encoding : utf-8 -*-
+require 'ashikawa-core/exceptions/client_error.rb'
 
 module Ashikawa
   module Core
@@ -17,7 +18,7 @@ module Ashikawa
       # @return String
       # @api private
       def to_s
-        "Status 400: The syntax of the request was bad"
+        'Status 400: The syntax of the request was bad'
       end
     end
   end

data/lib/ashikawa-core/exceptions/client_error/resource_not_found.rb

@@ -1,4 +1,5 @@
-require "ashikawa-core/exceptions/client_error.rb"
+# -*- encoding : utf-8 -*-
+require 'ashikawa-core/exceptions/client_error.rb'
 
 module Ashikawa
   module Core
@@ -18,7 +19,7 @@ module Ashikawa
       # @return String
       # @api private
       def to_s
-        "Status 404: The Resource you requested was not found on the server"
+        'Status 404: The Resource you requested was not found on the server'
       end
     end
   end

data/lib/ashikawa-core/exceptions/client_error/resource_not_found/collection_not_found.rb

@@ -1,4 +1,5 @@
-require "ashikawa-core/exceptions/client_error/resource_not_found"
+# -*- encoding : utf-8 -*-
+require 'ashikawa-core/exceptions/client_error/resource_not_found'
 
 module Ashikawa
   module Core
@@ -10,7 +11,7 @@ module Ashikawa
       # @return String
       # @api private
       def to_s
-        "You requested a collection from the server that does not exist"
+        'You requested a collection from the server that does not exist'
       end
     end
   end

data/lib/ashikawa-core/exceptions/client_error/resource_not_found/document_not_found.rb

@@ -1,4 +1,5 @@
-require "ashikawa-core/exceptions/client_error/resource_not_found"
+# -*- encoding : utf-8 -*-
+require 'ashikawa-core/exceptions/client_error/resource_not_found'
 
 module Ashikawa
   module Core
@@ -10,7 +11,7 @@ module Ashikawa
       # @return String
       # @api private
       def to_s
-        "You requested a document from the server that does not exist"
+        'You requested a document from the server that does not exist'
       end
     end
   end

data/lib/ashikawa-core/exceptions/client_error/resource_not_found/index_not_found.rb

@@ -1,4 +1,5 @@
-require "ashikawa-core/exceptions/client_error/resource_not_found"
+# -*- encoding : utf-8 -*-
+require 'ashikawa-core/exceptions/client_error/resource_not_found'
 
 module Ashikawa
   module Core
@@ -10,7 +11,7 @@ module Ashikawa
       # @return String
       # @api private
       def to_s
-        "You requested an index from the server that does not exist"
+        'You requested an index from the server that does not exist'
       end
     end
   end

data/lib/ashikawa-core/exceptions/no_collection_provided.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Ashikawa
   module Core
     # This Exception is thrown when a Query object should execute a simple query

data/lib/ashikawa-core/exceptions/server_error.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Ashikawa
   module Core
     # The server had an error during the request

data/lib/ashikawa-core/exceptions/server_error/json_error.rb

@@ -1,4 +1,5 @@
-require "ashikawa-core/exceptions/server_error"
+# -*- encoding : utf-8 -*-
+require 'ashikawa-core/exceptions/server_error'
 
 module Ashikawa
   module Core
@@ -18,7 +19,7 @@ module Ashikawa
       # @return String
       # @api private
       def to_s
-        "Either the JSON from the server was malformed or the content type incorrect"
+        'Either the JSON from the server was malformed or the content type incorrect'
       end
     end
   end

data/lib/ashikawa-core/figure.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 module Ashikawa
   module Core
     # Wrapper around figures of a collection
@@ -9,12 +10,12 @@ module Ashikawa
       # @example Create a new figure from a raw figure
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       def initialize(raw_figure)
-        @datafiles  = raw_figure["datafiles"]
-        @alive      = raw_figure["alive"]
-        @dead       = raw_figure["dead"]
-        @shapes     = raw_figure["shapes"]
-        @journals   = raw_figure["journals"]
-        @attributes = raw_figure["attributes"]
+        @datafiles  = raw_figure['datafiles']
+        @alive      = raw_figure['alive']
+        @dead       = raw_figure['dead']
+        @shapes     = raw_figure['shapes']
+        @journals   = raw_figure['journals']
+        @attributes = raw_figure['attributes']
       end
 
       # The number of active datafiles
@@ -25,7 +26,7 @@ module Ashikawa
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       #   figure.datafiles_count #=> 1337
       def datafiles_count
-        @datafiles["count"]
+        @datafiles['count']
       end
 
       # The file size of datafiles
@@ -36,7 +37,7 @@ module Ashikawa
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       #   figure.datafile_size #=> 1337
       def datafiles_file_size
-        @datafiles["fileSize"]
+        @datafiles['fileSize']
       end
 
       # The total size in bytes used by all living documents
@@ -47,7 +48,7 @@ module Ashikawa
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       #   figure.alive_size #=> 1337
       def alive_size
-        @alive["size"]
+        @alive['size']
       end
 
       # The number of living documents
@@ -58,7 +59,7 @@ module Ashikawa
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       #   figure.alive_count #=> 1337
       def alive_count
-        @alive["count"]
+        @alive['count']
       end
 
       # The total size in bytes used by all dead documents
@@ -69,7 +70,7 @@ module Ashikawa
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       #   figure.dead_size #=> 1337
       def dead_size
-        @dead["size"]
+        @dead['size']
       end
 
       # The number of dead documents
@@ -80,7 +81,7 @@ module Ashikawa
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       #   figure.dead_count #=> 1337
       def dead_count
-        @dead["count"]
+        @dead['count']
       end
 
       # The total number of shapes used in the collection
@@ -91,7 +92,7 @@ module Ashikawa
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       #   figure.shapes_count #=> 1337
       def shapes_count
-        @shapes["count"]
+        @shapes['count']
       end
 
       # The number of deletion markers
@@ -102,7 +103,7 @@ module Ashikawa
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       #   figure.dead_deletion #=> 1337
       def dead_deletion
-        @dead["deletion"]
+        @dead['deletion']
       end
 
       # The number of journals
@@ -113,7 +114,7 @@ module Ashikawa
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       #   figure.journal_count #=> 1337
       def journals_count
-        @journals["count"]
+        @journals['count']
       end
 
       # The file size of journals
@@ -124,7 +125,7 @@ module Ashikawa
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       #   figure.journal_size #=> 1337
       def journals_file_size
-        @journals["fileSize"]
+        @journals['fileSize']
       end
 
       # Number of different attributes that are or have been used in the collection
@@ -135,7 +136,7 @@ module Ashikawa
       #   figure = Ashikawa::Core::Figure.new(raw_figure)
       #   figure.attributes_count #=> 12
       def attributes_count
-        @attributes["count"]
+        @attributes['count']
       end
     end
   end

data/lib/ashikawa-core/index.rb

@@ -1,3 +1,4 @@
+# -*- encoding : utf-8 -*-
 require 'equalizer'
 
 module Ashikawa
@@ -63,7 +64,7 @@ module Ashikawa
       #   index = Ashikawa::Core::Index.new(collection, raw_index)
       #   index.delete
       def delete
-        @collection.send_request("index/#{@id}", :delete => {})
+        @collection.send_request("index/#{@id}", delete: {})
       end
 
       private
@@ -74,12 +75,21 @@ module Ashikawa
       # @return self
       # @api private
       def parse_raw_index(raw_index)
-        @id = raw_index["id"]
-        @on = raw_index["fields"].map { |field| field.to_sym } if raw_index.has_key?("fields")
-        @type = raw_index["type"].to_sym if raw_index.has_key?("type")
-        @unique = raw_index["unique"]
+        @id = raw_index['id']
+        @on = convert_to_symbols(raw_index['fields']) if raw_index.key?('fields')
+        @type = raw_index['type'].to_sym if raw_index.key?('type')
+        @unique = raw_index['unique']
         self
       end
+
+      # Convert all elements of an array to symbols
+      #
+      # @param [Array] arr
+      # @return Array
+      # @api private
+      def convert_to_symbols(arr)
+        arr.map { |field| field.to_sym }
+      end
     end
   end
 end