ptj 0.1.0

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,24 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.2"
+  gem "rcov", ">= 0"
+  gem "rspec", "~> 2.3.0"
+  gem "dm-core"
+  gem "dm-migrations"
+  gem "dm-types"
+  gem "dm-transactions"
+  gem "dm-aggregates"
+  gem "dm-validations"
+  gem "dm-serializer"
+  gem "dm-timestamps"
+  gem "dm-sqlite-adapter"
+  gem "dm-postgres-adapter"
+end

data/Gemfile.lock

@@ -0,0 +1,84 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    bcrypt-ruby (2.1.4)
+    data_objects (0.10.6)
+      addressable (~> 2.1)
+    diff-lcs (1.1.2)
+    dm-aggregates (1.1.0)
+      dm-core (~> 1.1.0)
+    dm-core (1.1.0)
+      addressable (~> 2.2.4)
+    dm-do-adapter (1.1.0)
+      data_objects (~> 0.10.2)
+      dm-core (~> 1.1.0)
+    dm-migrations (1.1.0)
+      dm-core (~> 1.1.0)
+    dm-postgres-adapter (1.1.0)
+      dm-do-adapter (~> 1.1.0)
+      do_postgres (~> 0.10.2)
+    dm-serializer (1.1.0)
+      dm-core (~> 1.1.0)
+      fastercsv (~> 1.5.4)
+      json (~> 1.4.6)
+    dm-sqlite-adapter (1.1.0)
+      dm-do-adapter (~> 1.1.0)
+      do_sqlite3 (~> 0.10.2)
+    dm-timestamps (1.1.0)
+      dm-core (~> 1.1.0)
+    dm-transactions (1.1.0)
+      dm-core (~> 1.1.0)
+    dm-types (1.1.0)
+      bcrypt-ruby (~> 2.1.4)
+      dm-core (~> 1.1.0)
+      fastercsv (~> 1.5.4)
+      json (~> 1.4.6)
+      stringex (~> 1.2.0)
+      uuidtools (~> 2.1.2)
+    dm-validations (1.1.0)
+      dm-core (~> 1.1.0)
+    do_postgres (0.10.6)
+      data_objects (= 0.10.6)
+    do_sqlite3 (0.10.6)
+      data_objects (= 0.10.6)
+    fastercsv (1.5.4)
+    git (1.2.5)
+    jeweler (1.6.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+    json (1.4.6)
+    rake (0.9.2)
+    rcov (0.9.10)
+    rspec (2.3.0)
+      rspec-core (~> 2.3.0)
+      rspec-expectations (~> 2.3.0)
+      rspec-mocks (~> 2.3.0)
+    rspec-core (2.3.1)
+    rspec-expectations (2.3.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.3.0)
+    shoulda (2.11.3)
+    stringex (1.2.2)
+    uuidtools (2.1.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  dm-aggregates
+  dm-core
+  dm-migrations
+  dm-postgres-adapter
+  dm-serializer
+  dm-sqlite-adapter
+  dm-timestamps
+  dm-transactions
+  dm-types
+  dm-validations
+  jeweler (~> 1.6.2)
+  rcov
+  rspec (~> 2.3.0)
+  shoulda

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Josh Grunzweig
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,96 @@
+= PTJ
+
+Minimalistic database for the analyzing and storing of passwords.
+
+== Using PTJ
+
+=== Setup
+
+First, we want to ensure our configuration file is correct.
+
+  gem which ptj
+  /some/path/gems/ptj-0.1.0/lib/ptj.rb
+
+Navigate to the 'etc' directory
+
+  cd /some/path/gems/ptj-0.1.0/etc/
+
+Modify the configuration file to point to the correct database (default is a 
+local SQLite database).
+
+When this is complete, you can setup a new project as such:
+
+  require 'ptj'
+  PTJ::Model.setup!
+  DataMapper.auto_upgrade!
+
+=== Importing Data
+
+There is a provided script which will allow you to import data into the PTJ
+database.
+
+Working with our PTJ path above, it can be found in
+  
+  /some/path/gems/ptj-0.1.0/scripts/import.rb
+
+Running it, you can see the following options:
+
+  ruby scripts/import.rb -h
+
+  Usage: import.rb [opts] -f file|-p password
+    -t, --tag TAGS                   Tags to be used to identify imported passwords (separated by a comma)
+        --[no-]strict                Enable/Disable Strict Mode
+    -f, --file FILENAME              File to import.
+    -r, --parser NUMBER              File parser to use:
+                                     1 - Password Only
+                                     2 - Hash:Password
+                                     3 - Count, Password
+                                     4 - Something ::: Password ::: Something
+    -p, --password PASSWORD          Password to import.
+    -a, --hash HASH                  Hash to import (Use in conjunction with -p).
+    -h, --help                       Show this message.
+  
+If you feel like doing it the hard way, feel free to view the source of this
+script.
+
+=== Analying Data
+
+Again, there is a handy, included, script which can be used to quickly generate
+and 'analysis' of a subset of passwords. It can be found in the 'scripts' 
+directory as well.
+
+  ruby script/analyze.rb -h
+
+  Usage: analyze.rb [opts]
+    -t, --tags TAGS                  Tags to be used to when querying passwords (separated by a comma)
+        --max-size SIZE              Maximum size of the resulting passords
+        --min-size SIZE              Minimum size of the resulting passwords
+        --[no-]upper                 Query based on upper-case letters
+        --[no-]lower                 Query based on lower-case letters
+        --[no-]special               Query based on special charaters
+        --[no-]number                Query based on numbers
+    -h, --help                       Show this message
+
+== Contributing to ptj
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Josh Grunzweig. See LICENSE.txt for
+further details.
+
+
+== TODO
+
+* Batch imports?
+* specs / unit tests :/
+* benchmark unit tests with various actions
+
+

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'bundler'
+require 'rake'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+Dir["tasks/*.rake"].each { |taskfile| load taskfile }
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "ptj"
+  gem.homepage = "http://github.com/jgrunzweig/ptj"
+  gem.license = "MIT"
+  gem.summary = %Q{Password analysis and collection database.}
+  gem.description = %Q{An easy way to collect and analyze data about password 
+  databases.}
+  gem.email = "jgrunzweig@gmail.com"
+  gem.authors = ["Josh Grunzweig"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "ptj #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/etc/config.yml

@@ -0,0 +1,23 @@
+
+## The development environment uses sqlite as a database.
+##
+## This connection string will cause the sqlite database to be located in 
+## the root directory of the ptj project under 'data/ptj.db'
+
+db_conn: "sqlite://$DATADIR$/ptj.db"
+
+## ... Or you can specify a hash of seperated parameters.
+## The configuration below is loosely based on a production config.yml
+## which uses postgres as its backend db repository.
+
+#db_conn: 
+#  adapter:  'postgres'
+#  database: 'ptj'
+#  username: 'ptj'
+#  password: 'abc123'
+#  host:     '172.16.51.145'
+
+
+
+
+

data/lib/ptj.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+require 'ptj/environment'
+require 'ptj/ext'
+require 'ptj/model'
+require 'ptj/parser'

data/lib/ptj/default_setup.rb

@@ -0,0 +1,10 @@
+# This is a default setup file you can 
+# require as in "require 'ptj/default_setup'"
+# it will automatically use default settings
+# for the configuration and database if they
+# are not specified in the configuration file.
+require 'ptj'
+
+PTJ::Env.read_config
+PTJ::Model.setup! unless PTJ::Model.setup?
+

data/lib/ptj/environment.rb

@@ -0,0 +1,115 @@
+require 'pathname'
+require 'yaml'
+
+module PTJ
+  # This module is used in bootstrapping and configuring the 
+  # PTJ Environment.
+  #
+  # The "KEY_*" constants in this module specify configuration options
+  # that can be used as hash keys via load_config or in the yara formatted
+  # configuration file via read_config.
+  #
+  module Environment
+
+    LIBROOT = Pathname.new(__FILE__).dirname.dirname.expand_path
+    ROOTDIR = LIBROOT.dirname.expand_path
+    DATADIR = ROOTDIR.join('data')
+
+    PTJ_ENV = ((d=ENV['PTJ_ENV']) and not d.empty?)? d : nil
+
+    CFGDIR = if (d=ENV['PTJ_CFGDIR'])
+               Pathname.new(d) 
+             elsif PTJ_ENV 
+               ROOTDIR.join('etc', PTJ_ENV)
+             else
+               ROOTDIR.join('etc')
+             end
+
+    CFGFILE = (d=ENV['PTJ_CFGFILE'])? Pathname.new(d) : CFGDIR.join('config.yml')
+
+    VERSION = File.read(ROOTDIR.join('VERSION'))
+    VERS_MAJOR, VERS_MINOR, VERS_PATCH = VERSION.split('.',3).map{|n| n.to_i}
+
+    # The 'db_url' configuration option 
+    KEY_DB_CONN     = "db_conn"
+    
+    # The debug configuration option may be set to true or false. 
+    # If debugging is enabled, certain features in spookt will emit extra
+    # debugging information. The default value is false.
+    KEY_DEBUG      = "debug"
+
+    CONFIG = {
+      KEY_DEBUG  =>  false,
+      KEY_DB_CONN => "sqlite::memory:",
+    }
+
+
+    # The load config method will load new configuration settings from
+    # a hash object. Note, the default configuration settings are overridden
+    # by new values specified with this method. 
+    #
+    # Example:
+    #
+    #     # This example enables debugging...
+    #     Spookt::Environment.load_config "debug" => true
+    #
+    # Note certain configuration variables are available such as LIBROOT,
+    # DATADIR, ROOTDIR, CFGDIR, and can be accessed from config options by enclosing
+    # them with the special character '$'. Any constant defined in Spookt::Environment
+    # can be accessed this way, actually.
+    #
+    # Example:
+    #
+    #     # This example sets the samples directory as a subdirectory of
+    #     # the DATADIR (this is the default, but this does it explicitly)
+    #     Spookt::Environment.load_config "sample_dir" => "$DATADIR$/samples"
+    #
+    #
+    def self.load_config(hash)
+      hash.each do |k,v|
+        if v.is_a?(String)
+          v = v.gsub(/\$([A-Z][A-Z0-9_]*)\$/) do |v|
+            var = $1
+            if const_defined?(var)
+              const_get(var).to_s
+            else
+              raise("Invalid variable referenced in configuration: #{v}")
+            end
+          end
+        end
+
+        CONFIG[k.to_s] = v
+      end
+    end
+
+    class ConfigError < StandardError
+    end
+
+    # The load config method will load new configuration settings from
+    # a yaml-formatted configuration file. Note, the default configuration 
+    # settings are overridden by new values specified in the configuration
+    # file.
+    #
+    # The yaml config data is treated as a ruby hash and passed directly to 
+    # load_config. See load_config for more options.
+    # 
+    def self.read_config(file=CFGFILE)
+      begin
+        h = YAML.load_file(file) 
+      rescue
+        raise(ConfigError, "Error in file: #{file} -> #{$!}")
+      end
+      if h.is_a?(Hash)
+        load_config(h)
+      else
+        raise(ConfigError, "invalid ptj config format for file: #{file}")
+      end
+    end
+
+  end
+
+  Env = Environment
+    
+end
+
+