aqueduct 0.0.0 → 0.1.0

data/CHANGELOG.rdoc

@@ -1,3 +1,8 @@
+== 0.1.0
+
+* Enhancements
+  * Defined common interface for repositories and wrappers
+
 == 0.0.0
 
-* Skeleton files to compile gem and make it available on rubygems.org
+* Skeleton files to compile gem and make it available on rubygems.org

data/README.rdoc

@@ -1,3 +1,17 @@
-= Aqueduct
+= Aqueduct {<img src="https://secure.travis-ci.org/remomueller/aqueduct.png"/>}[http://travis-ci.org/remomueller/aqueduct] {<img src="https://gemnasium.com/remomueller/aqueduct.png" alt="Dependency Status" />}[https://gemnasium.com/remomueller/aqueduct]
 
-This project rocks and uses MIT-LICENSE.
+Data integration gem designed to increase data flow between applications.
+
+== Installation
+
+Aqueduct can be installed from rubygems.org using:
+
+  gem install aqueduct
+
+Or update your Gemfile to include:
+
+  gem 'aqueduct'
+
+== Copyright
+
+Copyright (c) 2012 Remo Mueller. See {LICENSE}[https://github.com/remomueller/aqueduct/blob/master/LICENSE] for further details.

data/Rakefile

@@ -16,10 +16,13 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Aqueduct'
   rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('CHANGELOG.rdoc')
   rdoc.rdoc_files.include('README.rdoc')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
 
 
 
@@ -35,4 +38,4 @@ Rake::TestTask.new(:test) do |t|
 end
 
 
-task :default => :test
+task default: :test

data/aqueduct.gemspec

@@ -19,12 +19,12 @@ Gem::Specification.new do |s|
   s.email       = ["remosm@gmail.com"]
   s.homepage    = "https://github.com/remomueller"
   s.summary     = "Data integration gem designed to increase data flow between applications"
-  s.description = "Data integration gem designed to increase data flow between applications"
+  s.description = "Data integration gem designed to increase data flow between applications using a common interface"
 
   s.files = Dir["{app,config,db,lib}/**/*"] + ["aqueduct.gemspec", "CHANGELOG.rdoc", "LICENSE", "Rakefile", "README.rdoc"]
   s.test_files = Dir["test/**/*"]
 
-  s.add_dependency "rails", "~> 3.2.0"
+  s.add_dependency "rails", "~> 3.2.1"
 
   s.add_development_dependency "sqlite3"
 end

data/lib/aqueduct.rb

@@ -1,4 +1,47 @@
+require 'aqueduct/repository'
+require 'aqueduct/wrapper'
 require 'aqueduct/version'
 
 module Aqueduct
+  module Repositories
+    autoload :Developer, 'aqueduct/repositories/developer'
+  end
+
+  module Wrappers
+    autoload :Developer, 'aqueduct/wrappers/developer'
+  end
+
+  autoload :Repository, 'aqueduct/repository'
+  autoload :Wrapper, 'aqueduct/wrapper'
+
+  def self.repositories
+    @@repositories ||= []
+  end
+
+  def self.wrappers
+    @@wrappers ||= []
+  end
+
+  class Builder
+    def self.repository(source, user)
+      klass = source.repository[0].upcase + source.repository[1..-1]
+
+      begin
+        Aqueduct::Repositories.const_get(klass).new(source, user)
+      rescue NameError
+        raise LoadError, "Please add aqueduct-#{source.repository} to your Gemfile."
+      end
+    end
+
+    def self.wrapper(source, user)
+      klass = source.wrapper[0].upcase + source.wrapper[1..-1]
+
+      begin
+        Aqueduct::Wrappers.const_get(klass).new(source, user)
+      rescue NameError
+        raise LoadError, "Please add aqueduct-#{source.wrapper} to your Gemfile."
+      end
+    end
+  end
+
 end

data/lib/aqueduct/repositories/developer.rb

@@ -0,0 +1,42 @@
+require 'aqueduct'
+
+module Aqueduct
+  module Repositories
+    class Developer
+      include Aqueduct::Repository
+
+      # Returns a list of urls to download files
+      def count_files(file_locators, file_type)
+        error = ''
+        result = 0
+        file_paths = []
+        url_paths = []
+        file_locators.each do |file_locator|
+          file_locator = file_locator.to_s.gsub(/[\/*]/, '') # Don't allow wild cards or subfolders
+          file_type = file_type.to_s.gsub(/[\/*]/, '')       # Don't allow wild cards or subfolders
+          matching_file_names = Dir.glob(File.join(Rails.root, 'test', 'support', 'repositories', "#{file_locator}#{file_type}"))
+          matching_file_names.each do |file_name|
+            file_paths << file_name unless file_name.blank?
+            url_paths << SITE_URL + "/sources/#{@source.id}/download_file?file_locator=#{file_locator}&file_type=#{file_type}&fn=#{file_name.split('/').last}" unless file_name.blank?
+          end
+        end
+
+        { result: url_paths.size, error: error, file_paths: file_paths, urls: url_paths }
+      end
+
+      # Only For Local repositories.
+      def get_file(file_locator, file_type)
+        result_hash = count_files([file_locator], file_type)
+        { file_path: result_hash[:file_paths].first.to_s, error: result_hash[:error] }
+      end
+
+      def has_repository?
+        { result: true, error: "" }
+      end
+
+      def file_server_available?
+        { result: true, error: "" }
+      end
+    end
+  end
+end

data/lib/aqueduct/repository.rb

@@ -0,0 +1,34 @@
+require 'aqueduct'
+
+module Aqueduct
+  module Repository
+
+    def self.included(base)
+      Aqueduct.repositories << base
+    end
+
+    def initialize(source, current_user)
+      @source = source
+      @current_user = current_user
+    end
+
+    # Returns a list of urls to download files
+    def count_files(file_locators, file_type)
+      { result: 0, error: "Unknown Repository: #{@source.repository}", file_paths: [], urls: [] }
+    end
+
+    # Only For Local repositories.
+    def get_file(file_locator, file_type)
+      { file_path: '', error: "Unknown Repository: #{@source.repository}" }
+    end
+
+    def has_repository?
+      { result: false, error: "Unknown Repository: #{@source.repository}" }
+    end
+
+    def file_server_available?
+      { result: false, error: "Unknown Repository: #{@source.repository}" }
+    end
+
+  end
+end

data/lib/aqueduct/version.rb

@@ -1,7 +1,7 @@
 module Aqueduct
   module VERSION #:nodoc:
     MAJOR = 0
-    MINOR = 0
+    MINOR = 1
     TINY = 0
     BUILD = nil # nil, "pre", "rc", "rc2"
 

data/lib/aqueduct/wrapper.rb

@@ -0,0 +1,80 @@
+require 'aqueduct'
+
+module Aqueduct
+  module Wrapper
+
+    def self.included(base)
+      Aqueduct.wrappers << base
+    end
+
+    def initialize(source, current_user)
+      @source = source
+      @current_user = current_user
+      @db_connection = nil
+    end
+
+    def connect
+      @db_connection
+    end
+
+    def disconnect
+      true
+    end
+
+    def query(sql_statement)
+      [[],0]
+    end
+
+    def use_sql?
+      true
+    end
+
+    def sql_codes
+      { text: '', numeric: '', open: '', close: '' }
+    end
+
+    # Returns the Connection Status of the underlying data source.
+    def connected?
+      { result: false, error: "Unknown Wrapper: #{@source.wrapper}" }
+    end
+
+    # Returns an array of tables
+    def tables
+      { result: [], error: "Unknown Wrapper: #{@source.wrapper}" }
+    end
+
+    # Returns an array of columns for a given table
+    def table_columns(table)
+      { columns: [], error: "Unknown Wrapper: #{@source.wrapper}" }
+    end
+
+    def get_all_values_for_column(table, column)
+      { values: [], error: "<span style='vertical-align:middle'><img height='13' width='13' align='absmiddle' src='#{SITE_URL}/assets/contour/cross.png' alt='warning' /></span> Unknown Wrapper: #{@source.wrapper}" }
+    end
+
+    def column_values(table, column)
+      { result: [], error: "Unknown Wrapper: #{@source.wrapper}" }
+    end
+
+    def count(query_concepts, conditions, tables, join_conditions, concept_to_count)
+      { result: 0, error: "Unknown Wrapper: #{@source.wrapper}" }
+    end
+
+    def external_concepts(folder = '', search_term = '')
+      { result: [], error: '' }#, error: "Unknown Wrapper: #{@source.wrapper}"}
+    end
+
+    def external_concept_information(external_key = '')
+      { result: {}, error: "Unknown Wrapper: #{@source.wrapper}" }
+    end
+
+    def concept_tables(query_concept)
+      { result: [], error: "Unknown Wrapper: #{@source.wrapper}" }
+    end
+
+    def conditions(query_concepts)
+      { conditions: '', error: "Unknown Wrapper: #{@source.wrapper}" }
+    end
+
+  end
+end

data/lib/aqueduct/wrappers/developer.rb

@@ -0,0 +1,77 @@
+require 'aqueduct'
+
+module Aqueduct
+  module Wrappers
+    class Developer
+      include Aqueduct::Wrapper
+
+      def initialize(source, current_user)
+        @source = source
+        @current_user = current_user
+        @db_connection = true
+      end
+
+      def disconnect
+        true
+      end
+
+      def query(sql_statement)
+        [[[1,2,3,4],[5,nil,7,8]],2]
+      end
+
+      def sql_codes
+        { text: 'text', numeric: 'numeric', open: '[', close: ']' }
+      end
+
+      # Returns the Connection Status of the underlying data source.
+      def connected?
+        { result: true, error: "" }
+      end
+
+      # Returns an array of tables
+      def tables
+        { result: ['table'], error: "" }
+      end
+
+      # Returns an array of columns for a given table
+      def table_columns(table)
+        if table.blank?
+          { columns: [], error: "No Table Name Provided" }
+        else
+          { columns: (1..50).collect{|i| { column: "column#{i}" }} + [{ column: "gender" }], error: "" }
+        end
+      end
+
+      def get_all_values_for_column(table, column)
+        values = []
+        case column when 'gender'
+          values = ['m', 'f', nil, 'm', 'm', 'f']
+        when 'column4'
+          values = [20, 21, 22, 23, 27, 28]
+        end
+        { values: values, error: "" }
+      end
+
+      def column_values(table, column)
+        values = []
+        values_hash = self.get_all_values_for_column(table, column)
+        values = values_hash[:values].uniq
+        { result: values, error: values_hash[:error] }
+      end
+
+      def count(query_concepts, conditions, tables, join_conditions, concept_to_count)
+        result = (conditions == '1 = 1') ? 100 : 0
+        { result: result, error: "" }
+      end
+
+      def concept_tables(query_concept)
+        { result: ['table'], error: "" }
+      end
+
+      def conditions(query_concepts)
+        conditions = (query_concepts.size > 0) ? '1 = 1' : '1 = 0'
+        { conditions: conditions, error: "" }
+      end
+    end
+  end
+end

data/test/dummy/db/schema.rb

@@ -0,0 +1,16 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 0) do
+
+end

data/test/dummy/log/development.log

@@ -0,0 +1,6 @@
+   (0.1ms)  select sqlite_version(*)
+   (1.9ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (1.5ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.3ms)  select sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 

data/test/dummy/log/test.log

@@ -0,0 +1,14 @@
+   (0.1ms)  select sqlite_version(*)
+   (3.3ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.0ms)  PRAGMA index_list("schema_migrations")
+   (1.3ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.2ms)  select sqlite_version(*)
+   (0.1ms)  SELECT "schema_migrations"."version" FROM "schema_migrations" 
+   (0.2ms)  begin transaction
+   (0.0ms)  rollback transaction
+   (0.3ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.4ms)  begin transaction
+   (0.1ms)  rollback transaction
+   (0.5ms)  begin transaction
+   (0.1ms)  rollback transaction

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aqueduct
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-26 00:00:00.000000000 Z
+date: 2012-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &70189672997500 !ruby/object:Gem::Requirement
+  requirement: &70203822551000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: 3.2.1
   type: :runtime
   prerelease: false
-  version_requirements: *70189672997500
+  version_requirements: *70203822551000
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70189672997080 !ruby/object:Gem::Requirement
+  requirement: &70203822550400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,15 +32,20 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70189672997080
+  version_requirements: *70203822550400
 description: Data integration gem designed to increase data flow between applications
+  using a common interface
 email:
 - remosm@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/aqueduct/repositories/developer.rb
+- lib/aqueduct/repository.rb
 - lib/aqueduct/version.rb
+- lib/aqueduct/wrapper.rb
+- lib/aqueduct/wrappers/developer.rb
 - lib/aqueduct.rb
 - lib/tasks/aqueduct_tasks.rake
 - aqueduct.gemspec
@@ -70,6 +75,11 @@ files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config.ru
+- test/dummy/db/development.sqlite3
+- test/dummy/db/schema.rb
+- test/dummy/db/test.sqlite3
+- test/dummy/log/development.log
+- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html
@@ -125,6 +135,11 @@ test_files:
 - test/dummy/config/locales/en.yml
 - test/dummy/config/routes.rb
 - test/dummy/config.ru
+- test/dummy/db/development.sqlite3
+- test/dummy/db/schema.rb
+- test/dummy/db/test.sqlite3
+- test/dummy/log/development.log
+- test/dummy/log/test.log
 - test/dummy/public/404.html
 - test/dummy/public/422.html
 - test/dummy/public/500.html