objectstore 1.1.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3236943c5074458941ff9c00a1aba785c347d641
-  data.tar.gz: ebb78024e581576a84bde92add4a39a12d17b667
+  metadata.gz: 66e598ae7b0fe9b6c113a6eddb9b537a932546eb
+  data.tar.gz: 651558ef45223a9f6882e4c3090813b6819b25ca
 SHA512:
-  metadata.gz: fab4ae85a925ae2f04607844934f852dce4e5c98444a9eccb21c5bf933302ab38a1f7c161dd31e3040f0c6bb6080841e266fc7d1ca0bafeecfaa83d7467d705f
-  data.tar.gz: 133179d6e5dd12f5703fe7e55c067dcd4748636408a2afed263fe9d7d796c698fa0c99a226b41c552c9b1006b4210428a1d880f6e20df4eb9146a55953959eac
+  metadata.gz: a1901b6334397f8796f6bdbb2d7bcb1fbb3ae5c75eb7d119f3fc8c1e1445c93f80348bc6abb7f18e371870969ac818569501dbe96f11a0840c94ec971d831cbc
+  data.tar.gz: 2fc2609f51c372a1e9a68b7ab75f6b3be15a87aaded85f609fe376e42e3800afdfee735c61b83489ccf06da5e94fe9e01ef3f53f872e80d0adcea7f55e4348a2

data/lib/atech/object_store.rb

@@ -1,21 +1,23 @@
 module Atech
+  # Global module, contains configuration information
   module ObjectStore
-    VERSION = '1.1.2'
-    
     ## Error class which all Object Store errors are inherited fro
     class Error < StandardError; end
-    
+
     class << self
-      attr_accessor :backend
+      # Hash to be passed to Mysql2::Client when creating a new client
+      attr_accessor :backend_options
+
+      # Largest file that can be uploaded to the database
       attr_accessor :maximum_file_size
-      
+
       def maximum_file_size
-        @maximum_file_size ||= 1024 * 1024 * 1024
+        @maximum_file_size ||= 1024 * 1024 * 1024 # 1.megabyte
       end
-      
     end
-    
   end
 end
 
+require 'atech/object_store/connection'
 require 'atech/object_store/file'
+require 'atech/object_store/version'

data/lib/atech/object_store/connection.rb

@@ -0,0 +1,43 @@
+module Atech
+  module ObjectStore
+    # A very simple connection pool. Allows as many connections as MySQL is happy to give us. Probably not
+    # compatible with a truly concurrent Ruby due to the use of Array#shift, but good enough for MRI
+    module Connection
+      @free_clients = []
+
+      # Get an available connection (or create a new one) and yield it to the passed block. Places the client into
+      # @free_clients once done.
+      #
+      # @yield [client] Block that wishes to access database
+      # @yieldparam [Mysql2::Client] client A mysql2 client just for this block
+      #
+      # @return [Object] Result of the block
+      def self.client
+        client = @free_clients.shift || new_client
+        return_value = nil
+        tries = 2
+        begin
+          return_value = yield client
+        rescue Mysql2::Error => e
+          if e.message =~ /(lost connection|gone away)/i && (tries -= 1) > 0
+            retry
+          else
+            raise
+          end
+        ensure
+          @free_clients << client
+        end
+        return_value
+      end
+
+      private
+
+      # Build a new Mysql2 client with the options suppplied in backend_options
+      #
+      # @return [Mysql2::Client] Fresh mysql2 client
+      def self.new_client
+        Mysql2::Client.new(Atech::ObjectStore.backend_options)
+      end
+    end
+  end
+end

data/lib/atech/object_store/file.rb

@@ -1,7 +1,6 @@
 module Atech
   module ObjectStore
     class File
-
       ## Raised when a file cannot be found
       class FileNotFound < Error; end
 
@@ -14,10 +13,14 @@ module Atech
       ## Raised if the data is larger than the maximum file size
       class FileDataTooBig < Error; end
 
-      ## Run a query on the backend database, attempt to run the query up to 3 times
+      # Run a single query on a backend connection. This should only be used when running a single query. If you need
+      # to do multiple things on the same connection (e.g. INSERT and then get LAST_INSERT_ID) you should checkot your
+      # own connection using ObejctStore::Connection.client
       def self.execute_query(query)
         tries ||= 3
-        ObjectStore.backend.query(query)
+        ObjectStore::Connection.client do |client|
+          client.query(query)
+        end
       rescue Mysql2::Error => e
         retry unless (tries -= 1).zero?
         raise
@@ -52,32 +55,34 @@ module Atech
       ## Inserts a new File into the database. Returns a new object if successfully inserted or raises an error.
       ## Filename & data must be provided, options options will be added automatically unless specified.
       def self.add_file(filename, data = '', options = {})
-
         if data.bytesize > Atech::ObjectStore.maximum_file_size
           raise FileDataTooBig, "Data provided was #{data.bytesize} and the maximum size is #{Atech::ObjectStore.maximum_file_size}"
         end
 
-        ## Create a hash of properties to be for this class
+        # Create a hash of properties to be for this class
         options[:name]          = filename
         options[:size]        ||= data.bytesize
         options[:blob]          = data
         options[:created_at]  ||= Time.now
         options[:updated_at]  ||= Time.now
 
-        ## Ensure that new files have a filename & data
+        # Ensure that new files have a filename & data
         raise ValidationError, "A 'name' must be provided to add a new file" if options[:name].nil?
 
-        ## Encode timestamps
+        # Encode timestamps
         options[:created_at] = options[:created_at].utc
         options[:updated_at] = options[:updated_at].utc
 
-        ##Create an insert query
-        columns = options.keys.join('`,`')
-        data    = options.values.map { |data| escape_and_quote(data) }.join(',')
-        File.execute_query("INSERT INTO files (`#{columns}`) VALUES (#{data})")
+        # Create an insert query
+        last_insert_id = ObjectStore::Connection.client do |client|
+          columns = options.keys.join('`,`')
+          data = options.values.map { |v| escape_and_quote(v) }.join(',')
+          client.query("INSERT INTO files (`#{columns}`) VALUES (#{data})")
+          client.last_id
+        end
 
         ## Return a new File object
-        self.new(options.merge({:id => ObjectStore.backend.last_id}))
+        self.new(options.merge(:id => last_insert_id))
       end
 
       ## Initialises a new File object with the hash of attributes from a MySQL query ensuring that
@@ -179,14 +184,12 @@ module Atech
 
       def self.escape_and_quote(string)
         string = string.strftime('%Y-%m-%d %H:%M:%S') if string.is_a?(Time)
-        "'#{ObjectStore.backend.escape(string.to_s)}'"
+        "'#{Mysql2::Client.escape(string.to_s)}'"
       end
 
       def self.time_now
         Time.now.utc.strftime('%Y-%m-%d %H:%M:%S')
       end
-
-
     end
   end
 end

data/lib/atech/object_store/version.rb

@@ -0,0 +1,5 @@
+module Atech
+  module ObjectStore
+    VERSION = '2.0.0'.freeze
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: objectstore
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Adam Cooke
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-02 00:00:00.000000000 Z
-dependencies: []
+date: 2017-03-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.3'
 description: 
 email: adam@atechmedia.com
 executables: []
@@ -17,7 +31,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/atech/object_store.rb
+- lib/atech/object_store/connection.rb
 - lib/atech/object_store/file.rb
+- lib/atech/object_store/version.rb
 - schema.sql
 homepage: http://www.atechmedia.com
 licenses: []
@@ -38,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A SQL based object store library