playwhe 0.0.1 → 0.1.0

data/README.md

@@ -2,8 +2,20 @@
 
 A ruby gem for retrieving and storing Play Whe results.
 
-The gem provides a ruby API for retrieving and storing Play Whe results from the
-National Lotteries Control Board (NLCB) website at http://www.nlcb.co.tt/.
+The gem provides a ruby API and script for retrieving and storing Play Whe
+results from the National Lotteries Control Board (NLCB) website at
+http://www.nlcb.co.tt/.
+
+## Quick Start
+
+    $ gem install playwhe
+    $ playwhe -b && playwhe -u
+
+    $ echo Fetch results for October, 2010
+    $ playwhe -f 2010-10
+
+    $ echo Fetch results for 10 October, 2010
+    $ playwhe -f 2010-10-10
 
 ## Installation
 
@@ -19,7 +31,76 @@ Or install it yourself as:
 
     $ gem install playwhe
 
+## Usage
+
+After installation you will have access to both the library and an executable.
+
+To use the library, simply require **playwhe** and you would be able to retrieve
+Play Whe results in your code. If you need a way to persist those results, then
+you can also require **playwhe/storage**.
+
+The executable is called **playwhe** and it allows you to
+
+1. Setup a directory with a database of Play Whe results.
+
+        $ playwhe --bootstrap # or playwhe -b
+
+2. Create and initialize a database for storing Play Whe results.
+
+        $ playwhe --create # or playwhe -c
+
+3. Update a database with the latest Play Whe results.
+
+        $ playwhe --update # or playwhe -u
+
+   Note that you can create and update one after the other with the following
+   command.
+
+        $ playwhe -cu
+
+4. Fetch individual results by month
+
+        $ echo Fetch results for April, 2012
+        $ playwhe --fetch 2012-04 # or playwhe -f 2012-04
+
+   or by day.
+
+        $ echo Fetch results for 2nd April, 2012
+        $ playwhe --fetch 2012-04-02 # or playwhe -f 2012-04-02
+
+   Note that the fetch is done using a local database of results. So, you must
+   have created and updated your own local database before running this command.
+
+## Dev Notes
+
+How to access the library?
+
+    $ irb -Ilib --simple-prompt
+    >> require 'playwhe'
+    >> require 'playwhe/storage'
+
+How to update **data/playwhe.db**?
+
+    >> PlayWhe::Storage.update './data'
+
+How to update **data/playwhe.db** using **bin/playwhe**?
+
+    $ ruby -Ilib ./bin/playwhe -l debug -u ./data
+
+How to access the data in **data/playwhe.db**?
+
+    >> PlayWhe::Storage.connect './data/playwhe.db'
+    >> PlayWhe::Storage::Result.first # for e.g. retrieve the first result
+
+How to access the data in **data/playwhe.db** using **bin/playwhe**?
+
+    $ ruby -Ilib ./bin/playwhe -f 1994-07-04 ./data
+
 ## Help
 
-You can get help, report bugs, make suggestions or ask questions by contacting
-Dwayne R. Crooks via email at me@dwaynecrooks.com.
+For help using the executable, try
+
+    $ playwhe --help # or playwhe -h
+
+You can also get help, report bugs, make suggestions or ask questions by
+contacting Dwayne R. Crooks via email at me@dwaynecrooks.com.

data/bin/playwhe

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+
+require 'playwhe'
+require 'playwhe/storage'
+require 'trollop'
+
+DATE_PATTERN = /\A(\d{4})-(\d{2})(?:-(\d{2}))?\z/
+
+opts = Trollop::options do
+  version "playwhe #{PlayWhe::VERSION} (c) 2012 Dwayne R. Crooks"
+  banner <<-EOS
+A ruby script for retrieving and storing Play Whe results.
+
+Usage:
+        playwhe [options] [dir]
+where [options] are:
+EOS
+
+  opt :bootstrap, "Setup a given directory with a database of Play Whe results. If no directory is given then $HOME/.playwhe is used"
+  opt :create, "Create and initialize a database for Play Whe results in the given directory. If no directory is given then $HOME/.playwhe is used"
+  opt :update, "Update the database in the given directory with the latest Play Whe results. If no directory is given then $HOME/.playwhe is used"
+  opt :log_level, "Determines the amount of logging to perform. It must be one of 'fatal', 'error', 'warn', 'info' or 'debug'", :default => 'info'
+  opt :fetch, "Get results for a given month (if format is 'yyyy-mm') or day (if format is 'yyyy-mm-dd'). If a directory is given then the results are retrieved from the database contained within, otherwise it attempts to retrieve the results from the database in $HOME/.playwhe", :type => String
+end
+
+Trollop::die :log_level, "must be one of 'fatal', 'error', 'warn', 'info' or 'debug'" unless %w(fatal error warn info debug).include? opts[:log_level]
+
+if opts[:fetch]
+  match = opts[:fetch].match DATE_PATTERN
+  Trollop::die :fetch, "must be in the format 'yyyy-mm' or 'yyyy-mm-dd'" unless match
+end
+
+begin
+  path = ARGV[0] || File.join(Dir.home, '.playwhe')
+
+  if opts[:bootstrap]
+    spec = Gem::Specification.find_by_name('playwhe')
+    data = File.join(spec.gem_dir, 'data/playwhe.db')
+
+    if File.file? path
+      puts "Sorry, file '#{path}' exists. We could not complete the operation."
+    else
+      Dir.mkdir(path) unless File.directory?(path)
+      FileUtils.cp(data, path, :verbose => true)
+
+      puts "You're all setup now. Have fun!"
+    end
+  else
+    PlayWhe::Storage.create(path, opts[:log_level]) if opts[:create]
+    PlayWhe::Storage.update(path, opts[:log_level]) if opts[:update]
+
+    if opts[:fetch]
+      PlayWhe::Storage.connect(File.join(path, 'playwhe.db'), opts[:log_level])
+
+      year = match[1].to_i
+      month = match[2].to_i
+
+      if match[3].nil?
+        # get results for a given month
+        begin
+          results = PlayWhe::Storage::Result.all_by_month(year, month).reverse
+        rescue
+          puts "Sorry, we encountered an error. Please check the date you entered."
+          exit 1
+        end
+      else
+        # get results for a given day
+        day = match[3].to_i
+
+        begin
+          results = PlayWhe::Storage::Result.all_by_day(year, month, day).reverse
+        rescue
+          puts "Sorry, we encountered an error. Please check the date you entered."
+          exit 1
+        end
+      end
+
+      output = results.map do |result|
+        "Draw  : #{result.draw}\nDate  : #{result.date}\nPeriod: #{result.period}\nMark  : #{result.mark} (#{PlayWhe::SPIRITS[result.mark]})"
+      end.join "\n\n"
+      puts output
+    end
+  end
+rescue Interrupt
+  puts "Patience is a virtue. Sorry to see you didn't have any :). Bye!"
+rescue
+  puts "Sorry, we encountered an error during processing."
+end

data/lib/playwhe/storage/models.rb

@@ -20,6 +20,24 @@ module PlayWhe
       validates_within :period, set: 1..3
       validates_within :mark,   set: PlayWhe::LOWEST_MARK..PlayWhe::HIGHEST_MARK
 
+      def self.all_by_day(year, month, day)
+        self.all(:date => Date.new(year, month, day))
+      end
+
+      def self.all_by_month(year, month)
+        a = Date.new year, month, 1 # start of the month
+        b = (a >> 1) - 1 # end of the month
+
+        self.all(:date => a..b)
+      end
+
+      def self.all_by_year(year)
+        a = Date.new year, 1, 1 # start of the year
+        b = (a >> 12) - 1 # end of the year
+
+        self.all(:date => a..b)
+      end
+
     private
 
       def check_draw

data/lib/playwhe/version.rb

@@ -1,3 +1,3 @@
 module PlayWhe
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/playwhe.gemspec

@@ -6,13 +6,15 @@ Gem::Specification.new do |gem|
   gem.email         = ["me@dwaynecrooks.com"]
   gem.description   = %q{A ruby gem for retrieving and storing Play Whe results.
 
-  The gem provides a ruby API for retrieving and storing Play Whe results from
-  the National Lotteries Control Board (NLCB) website at http://www.nlcb.co.tt/.}
+  The gem provides a ruby API and script for retrieving and storing Play Whe
+  results from the National Lotteries Control Board (NLCB) website at
+  http://www.nlcb.co.tt/.}
   gem.summary       = %q{A ruby gem for retrieving and storing Play Whe results.}
   gem.homepage      = "http://rubygems.org/gems/playwhe"
 
   gem.add_dependency('data_mapper', '~> 1.2.0')
   gem.add_dependency('dm-sqlite-adapter', '~> 1.2.0')
+  gem.add_dependency('trollop', '~> 1.16.2')
 
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: playwhe
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-28 00:00:00.000000000 Z
+date: 2012-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: data_mapper
@@ -43,12 +43,29 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: trollop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.16.2
 description: ! "A ruby gem for retrieving and storing Play Whe results.\n\n  The gem
-  provides a ruby API for retrieving and storing Play Whe results from\n  the National
-  Lotteries Control Board (NLCB) website at http://www.nlcb.co.tt/."
+  provides a ruby API and script for retrieving and storing Play Whe\n  results from
+  the National Lotteries Control Board (NLCB) website at\n  http://www.nlcb.co.tt/."
 email:
 - me@dwaynecrooks.com
-executables: []
+executables:
+- playwhe
 extensions: []
 extra_rdoc_files: []
 files:
@@ -57,6 +74,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
+- bin/playwhe
 - data/playwhe.db
 - lib/playwhe.rb
 - lib/playwhe/storage.rb