remote_db 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 54d0b659f91bd851c797b2378a5a58a44e727778
+  data.tar.gz: 77d11bfeb7c050e54642f3621f58c665d0b06fd3
+SHA512:
+  metadata.gz: 0c964ced6b11c7ef08d8e6fed0fa535267778247eeb8274d24bbbe2c5543b62a56ec124a4bda02ebc15cd8ff78d800c9a19c737090ff34535929416611fc8b8a
+  data.tar.gz: cdc286bb4cd33772b352dd223818e3514721a3654a68067ad17eacd6a305dd39097555702ad3b31c0986cab42017f224dfbd88669051f72bb47d9efc57fd84ad

data/.gitignore

@@ -0,0 +1,10 @@
+# Ignore Mac's hidden File
+.DS_Store
+
+# Ignore redis file
+dump.rdb
+
+# Ignore RubyMine's Metadata
+/.idea
+/.project
+/pmip

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial release.

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in remote_db.gemspec
+gemspec

data/README.md

@@ -0,0 +1,7 @@
+## Remote DB
+
+There are cases where you want to easily consume database objects from a specific database. This gem
+makes it very easy to expose a specific set of tables/columns from a remote database, and allow them to
+be consumed in *read only* form within a gem.
+
+ 

data/lib/remote_db/concerns/configurable.rb

@@ -0,0 +1,50 @@
+module RemoteDb
+  module Concerns
+    module Configurable
+      extend ActiveSupport::Concern
+
+      module ClassMethods
+        def configure(config_hash = nil)
+          if config_hash
+            config_hash.each do |k,v|
+              setter = "#{k}="
+              if configuration.respond_to?(setter )
+                configuration.send(setter , v)
+              end
+            end
+          end
+
+          yield(configuration) if block_given?
+        end
+
+        def configuration
+          @configuration ||= RemoteDb::Configuration.new
+        end
+
+        def load_models!
+          define_base_record
+          send(:require_models) if respond_to?(:require_models)
+        end
+
+        private
+
+        def define_base_record
+          connection_spec = configuration.connection_spec
+          klass = Class.new(ActiveRecord::Base) do
+            self.abstract_class = true
+
+            # Connect via custom db settings
+            establish_connection(connection_spec)
+
+            # Force model to be ready-only
+            include Concerns::ReadOnlyModel
+
+            # Scope which columns are exposed
+            include Concerns::RestrictedColumns
+          end
+          self.const_set 'BaseRecord', klass
+        end
+      end
+    end
+  end
+end

data/lib/remote_db/concerns/read_only_model.rb

@@ -0,0 +1,41 @@
+module RemoteDb
+  module Concerns
+    module ReadOnlyModel
+      extend ActiveSupport::Concern
+
+      included do
+        attr_readonly(*column_names) unless abstract_class?
+      end
+
+      module ClassMethods
+        def delete(id_or_array)
+          raise ActiveRecord::ReadOnlyRecord
+        end
+
+        def delete_all(conditions = nil)
+          raise ActiveRecord::ReadOnlyRecord
+        end
+
+        def update_all(conditions = nil)
+          raise ActiveRecord::ReadOnlyRecord
+        end
+      end
+
+      def readonly?
+        true
+      end
+
+      def destroy
+        raise ActiveRecord::ReadOnlyRecord
+      end
+
+      def delete
+        raise ActiveRecord::ReadOnlyRecord
+      end
+
+      def update_column
+        raise ActiveRecord::ReadOnlyRecord
+      end
+    end
+  end
+end

data/lib/remote_db/concerns/restricted_columns.rb

@@ -0,0 +1,52 @@
+module RemoteDb
+  module Concerns
+    module RestrictedColumns
+      extend ActiveSupport::Concern
+
+      class ForbiddenColumnException < Exception; end
+
+      included do
+        def read_attribute_with_safety(name)
+          original_db_column = self.class.original_columns.include?(name.to_sym)
+          visible_db_column  = self.class.visible_columns.include? (name.to_sym)
+
+          if (original_db_column && visible_db_column) || !original_db_column
+            read_attribute_without_safety(name)
+          else
+            raise ForbiddenColumnException, "Column #{name} is not allowed for access."
+          end
+        end
+        alias_method_chain :read_attribute, :safety
+      end
+
+      module ClassMethods
+
+        def visible_columns
+          @visible_columns ||= []
+        end
+
+        def original_columns
+          @original_columns ||= []
+        end
+
+        # Note: This is a hack that relies on ActiveRecord's internals. Most of the
+        # logic is originally from: ActiveRecord::ModelSchema#reset_column_information`
+
+        def table_columns=(visible_columns)
+          unless abstract_class?
+            @visible_columns  = visible_columns
+            @original_columns = columns.map(&:name).map(&:to_sym)
+            @columns.reject! do |column|
+              !visible_columns.include?(column.name.to_sym)
+            end
+
+            @column_names = @content_columns = @column_defaults = @columns_hash = nil
+            @dynamic_methods_hash = nil
+            @inheritance_column = nil unless defined?(@explicit_inheritance_column) && @explicit_inheritance_column
+            @arel_engine = @relation = nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/remote_db/configuration.rb

@@ -0,0 +1,21 @@
+module RemoteDb
+  class Configuration
+    attr_accessor :adapter
+    attr_accessor :pool
+    attr_accessor :host
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :database
+
+    def connection_spec
+      {
+        adapter:   adapter ,
+        pool:      pool,
+        host:      host,
+        username:  username,
+        password:  password,
+        database:  database
+      }
+    end
+  end
+end

data/lib/remote_db/version.rb

@@ -0,0 +1,3 @@
+module RemoteDb
+  VERSION = '0.0.1'
+end

data/lib/remote_db.rb

@@ -0,0 +1,8 @@
+require 'active_support/concern'
+require 'active_record'
+
+require_relative 'remote_db/configuration'
+require_relative 'remote_db/version'
+require_relative 'remote_db/concerns/configurable'
+require_relative 'remote_db/concerns/read_only_model'
+require_relative 'remote_db/concerns/restricted_columns'

data/remote_db.gemspec

@@ -0,0 +1,19 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'remote_db/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'remote_db'
+  spec.version       = RemoteDb::VERSION
+  spec.summary       = 'Easily create a gem for consuming remote database tables/columns.'
+  spec.description   = ''
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.authors       = ['Omar Skalli']
+  spec.email         = ['omar@zenpayroll.com']
+  spec.homepage      = 'https://github.com/ZenPayroll/remote_db'
+
+  spec.add_runtime_dependency 'activesupport', '>= 3.0'
+  spec.add_runtime_dependency 'activerecord' , '>= 3.0'
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: remote_db
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Omar Skalli
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: ''
+email:
+- omar@zenpayroll.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CHANGELOG.md
+- Gemfile
+- README.md
+- lib/remote_db.rb
+- lib/remote_db/concerns/configurable.rb
+- lib/remote_db/concerns/read_only_model.rb
+- lib/remote_db/concerns/restricted_columns.rb
+- lib/remote_db/configuration.rb
+- lib/remote_db/version.rb
+- remote_db.gemspec
+homepage: https://github.com/ZenPayroll/remote_db
+licenses: []
+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.4.4
+signing_key: 
+specification_version: 4
+summary: Easily create a gem for consuming remote database tables/columns.
+test_files: []
+has_rdoc: