playwhe 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rvmrc
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Dwayne R. Crooks
+
+MIT License
+
+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.md

@@ -0,0 +1,25 @@
+# Play Whe
+
+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/.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'playwhe'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install playwhe
+
+## Help
+
+You can get help, report bugs, make suggestions or ask questions by contacting
+Dwayne R. Crooks via email at me@dwaynecrooks.com.

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/playwhe.rb

@@ -0,0 +1,148 @@
+require 'date'
+require 'net/http'
+
+require 'playwhe/version'
+
+module PlayWhe
+  # The day that Play Whe had its first draw; its start date
+  BIRTHDAY = Date.parse('4th July 1994')
+
+  # The day that Play Whe changed to having 3 draws per day
+  THREE_DRAWS_DAY = Date.parse('21st November 2011')
+
+  HOST = 'nlcb.co.tt'
+  QUERY_PATH = 'search/pwq/countdateCash.php'
+  QUERY_URL  = URI("http://#{HOST}/#{QUERY_PATH}")
+
+  # the lowest and highest Play Whe marks
+  LOWEST_MARK  = 1
+  HIGHEST_MARK = 36
+
+  # marks associated with their standard spirit
+  SPIRITS = {
+    1  => 'centipede',
+    2  => 'old lady',
+    3  => 'carriage',
+    4  => 'dead man',
+    5  => 'parson man',
+    6  => 'belly',
+    7  => 'hog',
+    8  => 'tiger',
+    9  => 'cattle',
+    10 => 'monkey',
+    11 => 'corbeau',
+    12 => 'king',
+    13 => 'crapaud',
+    14 => 'money',
+    15 => 'sick woman',
+    16 => 'jamette',
+    17 => 'pigeon',
+    18 => 'water boat',
+    19 => 'horse',
+    20 => 'dog',
+    21 => 'mouth',
+    22 => 'rat',
+    23 => 'house',
+    24 => 'queen',
+    25 => 'morocoy',
+    26 => 'fowl',
+    27 => 'little snake',
+    28 => 'red fish',
+    29 => 'opium man',
+    30 => 'house cat',
+    31 => 'parson wife',
+    32 => 'shrimps',
+    33 => 'spider',
+    34 => 'blind man',
+    35 => 'big snake',
+    36 => 'donkey'
+  }
+
+  def self.results_for_month(year, month)
+    if date_in_range?(year, month)
+      params = { 'year'  => (year%100).to_s.rjust(2, '0'),
+                 'month' => Date::ABBR_MONTHNAMES[month] }
+
+      begin
+        response = Net::HTTP.post_form(QUERY_URL, params)
+      rescue
+        raise ServiceUnavailable
+      end
+
+      case response
+      when Net::HTTPOK
+        return parse_body(year, params['year'], month, params['month'], response.body)
+      else
+        raise ServiceUnavailable
+      end
+    else
+      # obviously we won't have any results
+      return []
+    end
+  end
+
+  def self.results_for_year(year, callbacks = {})
+    all_results = []
+
+    12.times do |m|
+      month = m + 1
+
+      skip = callbacks[:before] ? callbacks[:before].call(month) : false
+
+      unless skip
+        begin
+          flag = :ok
+          results = results_for_month(year, month)
+        rescue ServiceUnavailable
+          flag = :error
+          results = []
+        ensure
+          begin
+            continue = callbacks[:after] ? callbacks[:after].call(month, flag, results) : true
+          rescue
+            raise
+          ensure
+            all_results += results if results
+          end
+        end
+
+        break unless continue
+      end
+    end
+
+    all_results
+  end
+
+  class ServiceUnavailable < Exception
+  end
+
+private
+
+  def self.date_in_range?(year, month)
+    mday = year == BIRTHDAY.year && month == BIRTHDAY.month ? BIRTHDAY.day : 1
+    date = Date.new(year, month, mday)
+
+    date >= BIRTHDAY && date <= Date.today
+  end
+
+  def self.parse_body(year, yy, month, abbr_month, body)
+    # Here's the current form of the data on the page as of 27/05/2012:
+    #
+    # <date>: Draw # <draw> : <period>'s draw  was <mark>
+    #
+    # where
+    #
+    # <date>  : dd-Mmm-yy
+    # <draw>  : a positive integer
+    # <period>: Morning | Midday | Evening
+    # <mark>  : 1..36
+    results = body.scan(/(\d{2})-#{abbr_month}-#{yy}: Draw # (\d+) : (Morning|Midday|Evening)'s draw  was (\d+)/)
+
+    results.collect! do |r|
+      { draw: r[1].to_i,
+        date: Date.new(year, month, r[0].to_i),
+        period: {'Morning' => 1, 'Midday' => 2, 'Evening' => 3}[r[2]],
+        mark: r[3].to_i }
+    end.sort_by! { |r| r[:draw] }
+  end
+end

data/lib/playwhe/storage.rb

@@ -0,0 +1,109 @@
+require 'data_mapper'
+require 'date'
+
+require 'playwhe/storage/models'
+
+module PlayWhe
+
+  module Storage
+
+    def self.connect(path_to_db, log_level = :debug)
+      DataMapper::Logger.new($stdout, log_level)
+      DataMapper.setup(:default, "sqlite://#{File.expand_path(path_to_db)}")
+    end
+
+    def self.create(path = nil, log_level = :debug)
+      setup(path, log_level)
+
+      DataMapper.auto_migrate!
+    end
+
+    def self.update(path = nil, log_level = :debug)
+      setup(path, log_level)
+
+      (PlayWhe::BIRTHDAY.year..Date.today.year).each do |year|
+        task = Task.first_or_create({ year: year },
+          { month: year == PlayWhe::BIRTHDAY.year ? PlayWhe::BIRTHDAY.month : 1,
+            status: 'pending' })
+
+        unless task.completed?
+          DataMapper.logger << "retrieving results for year #{year}..."
+
+          before = Proc.new do |month|
+            if month < task.month
+              DataMapper.logger << "  - skipping #{Date::MONTHNAMES[month]}"
+              true # skip
+            else
+              DataMapper.logger << "  + at #{Date::MONTHNAMES[month]}..."
+              false # do not skip
+            end
+          end
+
+          after = Proc.new do |month, flag, results|
+            case flag
+            when :ok
+              Result.transaction do |t|
+                begin
+                  results.each do |r|
+                    result = Result.first_or_new(draw: r[:draw], date: r[:date], period: r[:period], mark: r[:mark])
+
+                    unless result.save
+                      DataMapper.logger << "    - invalid data: #{result.draw} #{result.date} #{result.period} #{result.mark}"
+                      Error.create(message: r.to_s)
+                    end
+                  end
+
+                  today = Date.today
+                  if Date.new(year, month) < Date.new(today.year, today.month)
+                    if month == 12
+                      task.status = 'completed'
+                    else
+                      task.month += 1
+                    end
+
+                    if task.save
+                      DataMapper.logger << "  + completed #{Date::MONTHNAMES[month]}!"
+                      DataMapper.logger << "completed year #{year}!" if task.completed?
+
+                      true # continue
+                    else
+                      DataMapper.logger << '  - task not completed!'
+
+                      false # do not continue
+                    end
+                  else
+                    DataMapper.logger << 'All tasks completed!'
+
+                    false # do not continue
+                  end
+                rescue
+                  t.rollback
+
+                  DataMapper.logger << 'Encountered an error during processing'
+
+                  false # do not continue
+                end
+              end
+            when :error
+              DataMapper.logger << 'Encountered an error during processing'
+
+              false # do not continue
+            end
+          end
+
+          PlayWhe.results_for_year(year, before: before, after: after)
+        end
+      end
+    end
+
+  private
+
+    def self.setup(path, log_level)
+      path ||= File.join(Dir.home, '.playwhe')
+      path = File.expand_path(path)
+      Dir.mkdir(path) unless File.directory?(path)
+
+      self.connect("#{path}/playwhe.db", log_level)
+    end
+  end
+end

data/lib/playwhe/storage/models.rb

@@ -0,0 +1,74 @@
+require 'data_mapper'
+
+module PlayWhe
+
+  module Storage
+
+    DataMapper::Property.required(true)
+
+    class Result
+      include DataMapper::Resource
+
+      storage_names[:default] = 'results'
+
+      property :draw,   Integer, key: true
+      property :date,   Date
+      property :period, Integer
+      property :mark,   Integer
+
+      validates_with_method :draw, method: :check_draw
+      validates_within :period, set: 1..3
+      validates_within :mark,   set: PlayWhe::LOWEST_MARK..PlayWhe::HIGHEST_MARK
+
+    private
+
+      def check_draw
+        self.draw >= 1 ? true : [false, 'The draw must be a positive integer']
+      end
+    end
+
+    class Task
+      include DataMapper::Resource
+
+      storage_names[:default] = 'tasks'
+
+      property :id,         Serial
+      property :year,       Integer,  unique: true
+      property :month,      Integer
+      property :status,     String
+      property :created_at, DateTime, required: false
+      property :updated_at, DateTime, required: false
+
+      validates_with_method :year, method: :check_year
+      validates_within :month, set: 1..12
+      validates_within :status, set: ['pending', 'completed']
+
+      def completed?
+        self.status == 'completed'
+      end
+
+    private
+
+      def check_year
+        if self.year >= PlayWhe::BIRTHDAY.year && self.year <= Date.today.year
+          true
+        else
+          [false, 'The year is out of range']
+        end
+      end
+    end
+
+    class Error
+      include DataMapper::Resource
+
+      storage_names[:default] = 'errors'
+
+      property :id,         Serial
+      property :message,    Text
+      property :created_at, DateTime, required: false
+      property :updated_at, DateTime, required: false
+    end
+
+    DataMapper.finalize
+  end
+end

data/lib/playwhe/version.rb

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

data/playwhe.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/playwhe/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Dwayne R. Crooks"]
+  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/.}
+  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.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "playwhe"
+  gem.require_paths = ["lib"]
+  gem.version       = PlayWhe::VERSION
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: playwhe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Dwayne R. Crooks
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: data_mapper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: dm-sqlite-adapter
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+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/."
+email:
+- me@dwaynecrooks.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- data/playwhe.db
+- lib/playwhe.rb
+- lib/playwhe/storage.rb
+- lib/playwhe/storage/models.rb
+- lib/playwhe/version.rb
+- playwhe.gemspec
+homepage: http://rubygems.org/gems/playwhe
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A ruby gem for retrieving and storing Play Whe results.
+test_files: []