purview 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 30aabf4950bc6dc20daf5b89eec19e9afe148765
-  data.tar.gz: 544c19c81308f7276a02a8b6149dd97bcd7f3312
+  metadata.gz: 1e7d924c2525271d6ebf479f498241505bbac3e8
+  data.tar.gz: 34f49f218bf0268b3801d715a73aa34a5c6847b0
 SHA512:
-  metadata.gz: 80b799628ae3f89c0eacab1cf449d1fadaf318d9f590c7408624e66849a9c527a9d7f1f280b9df03bbe54e62b496cf99d379091c0ae78aa571fdb9e6fbfe329e
-  data.tar.gz: 21600dcd05785d91a627338b14396290fed0dd3c4e18f9a116b9c9b23f25f3fd3715a48e749db0205d283ffd1a26b2764f7bf2339fb9ec90e2c0ea61d43a7708
+  metadata.gz: d4f941aeccb17386c82742f3ab4259321ca6d9da026a7a6da3ae1b202125f638153b33c19b5fcededd713287073f913f221b15560a7384403241c0f740721928
+  data.tar.gz: 8761615f2d7bfa444bf9b0f6249801a68edd96f3ed65a286c5abe9f9a6b3143004b2672fd33ab53dfeee652d565152f533c93125272779434e8f7d58f4dd0104

data/.travis.yml

@@ -1,5 +1,9 @@
 language: ruby
 
+before_install:
+  - sudo apt-get update -q
+  - sudo apt-get install -q freetds-dev
+
 rvm:
   - 1.9.3
   - 2.0.0

data/CHANGELOG

@@ -1,3 +1,10 @@
+Release 1.5.0 (2015-06-12)
+--------------------------
+
+* MSSQL support (includes JRuby support)
+* Update README with new examples
+* Remove deprecated documentation
+
 Release 1.4.0 (2015-06-10)
 --------------------------
 

data/Gemfile

@@ -2,11 +2,13 @@ source 'https://rubygems.org'
 
 group :development do
   if defined?(JRUBY_VERSION)
+    gem 'jdbc-jtds', '~> 1.3'
     gem 'jdbc-mysql', '~> 5.1'
     gem 'jdbc-postgres', '~> 9.4'
   else
     gem 'mysql2', '~> 0.3'
     gem 'pg', '~> 0.18'
+    gem 'tiny_tds', '~> 0.6'
   end
 end
 

data/README.md

@@ -21,9 +21,10 @@ Or install it yourself as:
 
 ## Usage
 
-Load the `MySQL` client (for `PostgreSQL` simply change 'mysql2' to 'pg' -- when
-using this gem in a JRuby environment the 'jdbc/mysql' and/or 'jdbc/postgres'
-library must be installed/available)
+Load the `MySQL` client (for `MSSQL` simple change 'mysql2' to 'tiny_tds'; for
+`PostgreSQL` simply change 'mysql2' to 'pg' -- when using this gem in a JRuby
+environment the 'jdbc/jtds', 'jdbc/mysql' and/or 'jdbc/postgres'library must be
+installed/available)
 ```ruby
 require 'mysql2'
 ```
@@ -36,7 +37,7 @@ table_name = :users
 Define the `Column(s)` (available column-types: `Boolean`, `CreatedTimestamp`,
 `Date`, `Float`, `Id`, `Integer`, `Money`, `String`, `Text`, `Time`, `Timestamp`,
 `UpdatedTimestamp` & `UUID` -- the `Id`, `CreatedTimestamp` & `UpdatedTimestamp`
-columns are required for all tables)
+columns are required for all `BaseSyncable` tables)
 ```ruby
 id_column = Purview::Columns::Id.new(:id),
 name_column = Purview::Columns::String.new(:name, :nullable => false),
@@ -58,11 +59,12 @@ Define the `Indices` (availble index-types: `Composite` & `Simple`). By default
 `UpdatedTimestamp`)
 ```ruby
 indices = [
-  Purview::Indices::Simple.new(email_column),
+  Purview::Indices::Simple.new(email_column, :unique => true),
 ]
 ```
 
-Configure the `Puller` (available puller-types: `MySQL`, `PostgreSQL` & `URI`)
+Configure the `Puller` (available puller-types: `MSSQL`, `MySQL`, `PostgreSQL` &
+`URI`)
 ```ruby
 puller_opts = {
   :type => Purview::Pullers::URI,
@@ -102,7 +104,7 @@ table = Purview::Tables::Raw.new(
 
 Set the database-name (this can be anything, but it must exist)
 ```ruby
-database_name = :data_warehouse
+database_name = :data_warehouse_raw
 ```
 
 Combine all the configuration options and instantiate the `Database` (for
@@ -118,12 +120,6 @@ database = Purview::Databases::MySQL.new(
 )
 ```
 
-Add the `Table` to the `Database` (schema). In order for [the] `Table` to be
-`sync[ed]` it *must* be added to [the] `Database`
-```ruby
-database.add_table(table)
-```
-
 Create the `Table` (in the DB). Recommended for testing purposes *only*. For
 production environments you will likely want an external process to manage the
 schema (for `PostgreSQL` simply change `Mysql2::Error` to `PG::DuplicateTable`)
@@ -160,16 +156,27 @@ to determine the pool of `Table(s)` available for synchronization (to remove a
 database.enable_table(table)
 ```
 
-Sync the `Database`. This process will select a [candidate] `Table`, pull data
-from its [remote-]source and reconcile the new data against the main-table (e.g.
-perform `INSERTs`, `UPDATEs` and `DELETEs`). When multiple `Table(s)` are
-configured the least recently pulled and available (`enabled` and not `locked`)
-`Table` will be selected (you will likely want to configure some process to load
-the schema run the `sync` at regularly scheduled intervals)
+Sync the `Table`. This process will pull data from its [remote-]source and
+reconcile the new data against the main-table (e.g. perform 'INSERT', 'UPDATE'
+and 'DELETE' operations).
+```ruby
+database.sync_table(table)
+```
+
+Sync the `Database`. The result of this process is the same as `sync_table`
+except that the process itself will select a candidate table. When multiple
+`Table(s)` are configured the least recently pulled and available (`enabled`,
+`initialized` and `unlocked`) `Table` will be selected.
 ```ruby
 database.sync
 ```
 
+Fetch the metadata for a `Table`. This process will return a `Struct`
+representation of the current state for the given `Table`
+```ruby
+database.table_metadata(table)
+```
+
 ## Contributing
 
 1. Fork it ( http://github.com/jzaleski/purview/fork )

data/lib/purview/connections/mssql.rb

@@ -0,0 +1,11 @@
+module Purview
+  module Connections
+    class MSSQL < Base
+      private
+
+      def raw_connection_type
+        Purview::RawConnections::MSSQL
+      end
+    end
+  end
+end

data/lib/purview/connections.rb

@@ -1,3 +1,4 @@
 require 'purview/connections/base'
+require 'purview/connections/mssql'
 require 'purview/connections/mysql'
 require 'purview/connections/postgresql'

data/lib/purview/dialects/mssql.rb

@@ -0,0 +1,25 @@
+module Purview
+  module Dialects
+    class MSSQL < Base
+      def false_value
+        '0'
+      end
+
+      def null_value
+        'NULL'
+      end
+
+      def quoted(value)
+        value.nil? ? null_value : value.quoted
+      end
+
+      def sanitized(value)
+        value.nil? ? null_value : value.sanitized
+      end
+
+      def true_value
+        '1'
+      end
+    end
+  end
+end

data/lib/purview/dialects.rb

@@ -1,4 +1,5 @@
 require 'purview/dialects/base'
 
+require 'purview/dialects/mssql'
 require 'purview/dialects/mysql'
 require 'purview/dialects/postgresql'

data/lib/purview/pullers/base_sql.rb

@@ -3,7 +3,7 @@ module Purview
     class BaseSQL < Base
       def pull(window)
         with_new_connection do |connection|
-          connection.execute(pull_sql(window))
+          connection.execute(pull_sql(window) + additional_sql)
         end
       end
 
@@ -14,6 +14,10 @@ module Purview
       include Purview::Mixins::Helpers
       include Purview::Mixins::Logger
 
+      def additional_sql
+        " #{opts[:additional_sql]}".rstrip
+      end
+
       def column_names
         table.columns.map do |column|
           name = column.name

data/lib/purview/pullers/mssql.rb

@@ -0,0 +1,15 @@
+module Purview
+  module Pullers
+    class MSSQL < BaseSQL
+      private
+
+      def connection_type
+        Purview::Connections::MSSQL
+      end
+
+      def dialect_type
+        Purview::Dialects::MSSQL
+      end
+    end
+  end
+end

data/lib/purview/pullers.rb

@@ -1,6 +1,7 @@
 require 'purview/pullers/base'
 require 'purview/pullers/base_sql'
 
+require 'purview/pullers/mssql'
 require 'purview/pullers/mysql'
 require 'purview/pullers/postgresql'
 require 'purview/pullers/uri'

data/lib/purview/raw_connections/jdbc/base.rb

@@ -10,10 +10,6 @@ module Purview
           delete?(sql) || insert?(sql) || update?(sql)
         end
 
-        def engine
-          raise %{All "#{Base}(s)" must override the "engine" method}
-        end
-
         def execute_sql(sql, opts={})
           @last_sql = sql
           @last_statement = statement = raw_connection.createStatement
@@ -58,7 +54,7 @@ module Purview
         end
 
         def url
-          "jdbc:#{engine}://#{host}#{port && ":#{port}"}/#{database}"
+          raise %{All "#{Base}(s)" must override the "url" method}
         end
       end
     end

data/lib/purview/raw_connections/jdbc/jtds.rb

@@ -0,0 +1,25 @@
+safe_require('jdbc/jtds')
+
+if defined?(Jdbc::JTDS)
+  Jdbc::JTDS.load_driver
+
+  module Purview
+    module RawConnections
+      module JDBC
+        class JTDS < Base
+          private
+
+          def url
+            "jdbc:jtds:sqlserver://#{host}#{port && ":#{port}"};databaseName=#{database}"
+          end
+
+          def username
+            super || ENV['SQLCMDUSER'] || Etc.getlogin
+          end
+        end
+      end
+    end
+  end
+
+  Purview::RawConnections::MSSQL = Purview::RawConnections::JDBC::JTDS
+end

data/lib/purview/raw_connections/jdbc/mysql.rb

@@ -9,8 +9,8 @@ if defined?(Jdbc::MySQL)
         class MySQL < Base
           private
 
-          def engine
-            'mysql'
+          def url
+            "jdbc:mysql://#{host}#{port && ":#{port}"}/#{database}"
           end
 
           def username

data/lib/purview/raw_connections/jdbc/postgres.rb

@@ -9,8 +9,8 @@ if defined?(Jdbc::Postgres)
         class Postgres < Base
           private
 
-          def engine
-            'postgresql'
+          def url
+            "jdbc:postgresql://#{host}#{port && ":#{port}"}/#{database}"
           end
 
           def username

data/lib/purview/raw_connections/tiny_tds.rb

@@ -0,0 +1,41 @@
+safe_require('tiny_tds')
+
+if defined?(TinyTds)
+  module Purview
+    module RawConnections
+      class TinyTds < Base
+        private
+
+        def execute_sql(sql, opts={})
+          raw_connection.execute(sql)
+        end
+
+        def extract_rows(result)
+          result && result.to_a
+        end
+
+        def extract_rows_affected(result)
+          result.affected_rows
+        end
+
+        def new_connection
+          ::TinyTds::Client.new(
+            filter_blank_values(
+              :database => database.to_s,
+              :host => host.to_s,
+              :password => password.to_s,
+              :port => port,
+              :username => username.to_s
+            )
+          )
+        end
+
+        def username
+          super || ENV['SQLCMDUSER'] || Etc.getlogin
+        end
+      end
+    end
+  end
+
+  Purview::RawConnections::MSSQL = Purview::RawConnections::TinyTds
+end

data/lib/purview/raw_connections.rb

@@ -1,12 +1,17 @@
 require 'purview/raw_connections/base'
 require 'purview/raw_connections/jdbc/base'
 
+require 'purview/raw_connections/jdbc/jtds'
 require 'purview/raw_connections/jdbc/mysql'
 require 'purview/raw_connections/jdbc/postgres'
 
 require 'purview/raw_connections/mysql2'
 require 'purview/raw_connections/pg'
+require 'purview/raw_connections/tiny_tds'
 
-if !defined?(Purview::RawConnections::MySQL) && !defined?(Purview::RawConnections::PostgreSQL)
-  raise 'Could not initialize raw-connections; please install and require one or more of the following gems: `jdbc-mysql`, `jdbc-postgres`, `mysql2` and/or `pg`'
+if \
+  !defined?(Purview::RawConnections::MSSQL) &&
+  !defined?(Purview::RawConnections::MySQL) &&
+  !defined?(Purview::RawConnections::PostgreSQL)
+  raise 'Could not initialize raw-connections; please install and require one or more of the following gems: `jdbc-jtds`, `jdbc-mysql`, `jdbc-postgres`, `mysql2`, `pg` and/or `tiny_tds`'
 end

data/lib/purview/version.rb

@@ -1,3 +1,3 @@
 module Purview
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

data/purview.gemspec

@@ -19,8 +19,9 @@ Gem::Specification.new do |gem|
   gem.test_files = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 
-  gem.requirements << '`jdbc-mysql` or `mysql2` gem'
-  gem.requirements << '`jdbc-postgres` or `pg` gem'
+  gem.requirements << '`mysql2` or `jdbc-mysql` gem'
+  gem.requirements << '`pg` or `jdbc-postgres` gem'
+  gem.requirements << '`tiny_tds` or `jdbc-jtds` gem'
 
   gem.add_development_dependency 'bundler', '~> 1.0'
   gem.add_development_dependency 'pry', '~> 0.10'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: purview
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Jonathan W. Zaleski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-10 00:00:00.000000000 Z
+date: 2015-06-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -99,6 +99,7 @@ files:
 - lib/purview/columns/uuid.rb
 - lib/purview/connections.rb
 - lib/purview/connections/base.rb
+- lib/purview/connections/mssql.rb
 - lib/purview/connections/mysql.rb
 - lib/purview/connections/postgresql.rb
 - lib/purview/databases.rb
@@ -107,6 +108,7 @@ files:
 - lib/purview/databases/postgresql.rb
 - lib/purview/dialects.rb
 - lib/purview/dialects/base.rb
+- lib/purview/dialects/mssql.rb
 - lib/purview/dialects/mysql.rb
 - lib/purview/dialects/postgresql.rb
 - lib/purview/exceptions.rb
@@ -152,6 +154,7 @@ files:
 - lib/purview/pullers.rb
 - lib/purview/pullers/base.rb
 - lib/purview/pullers/base_sql.rb
+- lib/purview/pullers/mssql.rb
 - lib/purview/pullers/mysql.rb
 - lib/purview/pullers/postgresql.rb
 - lib/purview/pullers/uri.rb
@@ -159,10 +162,12 @@ files:
 - lib/purview/raw_connections/base.rb
 - lib/purview/raw_connections/jdbc.rb
 - lib/purview/raw_connections/jdbc/base.rb
+- lib/purview/raw_connections/jdbc/jtds.rb
 - lib/purview/raw_connections/jdbc/mysql.rb
 - lib/purview/raw_connections/jdbc/postgres.rb
 - lib/purview/raw_connections/mysql2.rb
 - lib/purview/raw_connections/pg.rb
+- lib/purview/raw_connections/tiny_tds.rb
 - lib/purview/refinements.rb
 - lib/purview/refinements/object.rb
 - lib/purview/refinements/string.rb
@@ -212,8 +217,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- "`jdbc-mysql` or `mysql2` gem"
-- "`jdbc-postgres` or `pg` gem"
+- "`mysql2` or `jdbc-mysql` gem"
+- "`pg` or `jdbc-postgres` gem"
+- "`tiny_tds` or `jdbc-jtds` gem"
 rubyforge_project: 
 rubygems_version: 2.4.6
 signing_key: