playwhe 0.1.0 → 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9d783ee5066f3954ae5f3afbfedbaac7e963f14b
+  data.tar.gz: ef9392125d15a142ca70a5a3a29a6d2b678ea96a
+SHA512:
+  metadata.gz: 26252985bd2b160a75c1127a1cb1d48d1bbc07832b973402bc1d115a08008ebd8e641cc371b287a4a50cf587f06c5df6917e110a0c53aae5d8be85604d8ac14d
+  data.tar.gz: ac4941653662988a5570b7fdc7c15bb4ea80671ae8c4fd0e78184d541d7552263c1776e6b31162901f6b7b4cc1e55889ddb7e71f63eeede34b1ad7b71f5f6076

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -1,22 +1,21 @@
-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:
+Copyright (c) 2016 Dwayne Crooks
+
+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 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.
+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

@@ -1,106 +1,115 @@
-# Play Whe
+## About
 
-A ruby gem for retrieving and storing Play Whe results.
-
-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
+playwhe is a Ruby library for retrieving Play Whe results from the [National Lotteries
+Control Board](http://www.nlcb.co.tt/) (NLCB) website.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'playwhe'
+```ruby
+gem "playwhe"
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 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.
+```bash
+$ gem install playwhe
+```
 
-        $ playwhe -cu
+Inside of your Ruby program do:
 
-4. Fetch individual results by month
+```ruby
+require "playwhe"
+```
 
-        $ echo Fetch results for April, 2012
-        $ playwhe --fetch 2012-04 # or playwhe -f 2012-04
+... to pull it in as a dependency.
 
-   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
-
-For help using the executable, try
-
-    $ playwhe --help # or playwhe -h
+## Usage
 
-You can also get help, report bugs, make suggestions or ask questions by
-contacting Dwayne R. Crooks via email at me@dwaynecrooks.com.
+This gem comes with a CLI called `playwhe`. Below are some examples of its usage.
+
+List the 4 most recent results in descending order:
+
+```bash
+$ playwhe
+# or
+$ playwhe --most-recent 4
+# or
+$ playwhe --most-recent --order desc
+15253,2016-07-02,29,PM
+15252,2016-07-02,30,AN
+15251,2016-07-02,31,AM
+15250,2016-07-02,29,EM
+```
+
+List the 4 most recent results in ascending order:
+
+```bash
+$ playwhe --order asc
+15250,2016-07-02,29,EM
+15251,2016-07-02,31,AM
+15252,2016-07-02,30,AN
+15253,2016-07-02,29,PM
+```
+
+List the 8 least recent results in ascending order:
+
+```bash
+$ playwhe --least-recent 8
+1,1994-07-04,15,AM
+2,1994-07-04,11,PM
+3,1994-07-05,36,AM
+4,1994-07-05,31,PM
+5,1994-07-06,12,AM
+6,1994-07-06,36,PM
+7,1994-07-07,6,AM
+8,1994-07-07,23,PM
+```
+
+List all the results for the year 2015 in ascending order:
+
+```bash
+$ playwhe 2015
+13562,2015-01-01,29,EM
+13563,2015-01-01,29,AM
+13564,2015-01-01,1,PM
+...
+14630,2015-12-31,15,EM
+14631,2015-12-31,13,AM
+14632,2015-12-31,28,AN
+14633,2015-12-31,27,PM
+```
+
+List all the results for April 2016 in descending order:
+
+```bash
+$ playwhe 2016 4 --order desc
+15041,2016-04-30,3,PM
+15040,2016-04-30,6,AN
+15039,2016-04-30,31,AM
+15038,2016-04-30,27,EM
+...
+14941,2016-04-01,3,PM
+14940,2016-04-01,16,AN
+14939,2016-04-01,14,AM
+14938,2016-04-01,31,EM
+```
+
+List all the results for October 10th, 2008 in ascending order:
+
+```bash
+$ playwhe 2008 10 10
+8775,2008-10-10,31,AM
+8776,2008-10-10,12,PM
+```
+
+## Copyright
+
+Copyright (c) 2016 Dwayne Crooks. See [LICENSE](/LICENSE) for further details.

data/Rakefile

@@ -1,2 +1,9 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.warning = false
+end
+
+task default: :test

data/bin/playwhe

@@ -1,88 +1,113 @@
 #!/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
+require "optparse"
+
+require_relative "../lib/playwhe"
+
+options = {}
+
+option_parser = OptionParser.new do |opts|
+  executable_name = File.basename($PROGRAM_NAME)
+  opts.banner = <<-BANNER
+Display Play Whe results
+
+Usage: #{executable_name} [args] [options]
+
+Arguments:
+\t<year>
+\t<year> <month>
+\t<year> <month> <day>
+
+Options:
+  BANNER
+
+  opts.on("--most-recent N", Integer, "List the N (>= 1) most recent results") do |n|
+    if n >= 1
+      options[:most_recent] = n
+    else
+      raise ArgumentError, "invalid argument: --most-recent #{n}"
+    end
+  end
+
+  opts.on("--least-recent N", Integer, "List the N (>= 1) least recent results") do |n|
+    if n >= 1
+      options[:least_recent] = n
+    else
+      raise ArgumentError, "invalid argument: --least-recent #{n}"
+    end
+  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]
+  opts.on("--order asc|desc", %i(asc desc), "List in ascending or descending order") do |order|
+    options[:order] = order
+  end
 
-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
+  opts.on("-v", "--version", "Show version information, then exit") do
+    puts PlayWhe::VERSION
+    exit
+  end
+
+  opts.on("-h", "--help", "Show this help, then exit") do
+    puts opts
+    exit
+  end
 end
 
 begin
-  path = ARGV[0] || File.join(Dir.home, '.playwhe')
+  option_parser.parse!
+rescue => e
+  STDERR.puts "Please check your options/arguments"
+  STDERR.puts "Error: #{e.message}"
+  exit 1
+end
 
-  if opts[:bootstrap]
-    spec = Gem::Specification.find_by_name('playwhe')
-    data = File.join(spec.gem_dir, 'data/playwhe.db')
+def as_csv(results)
+  results.map(&:to_s).join("\n")
+end
 
-    if File.file? path
-      puts "Sorry, file '#{path}' exists. We could not complete the operation."
+def get_results(args, options)
+  if options.key?(:most_recent)
+    PlayWhe.get.most_recent(limit: options[:most_recent], order: options.fetch(:order, :desc))
+  elsif options.key?(:least_recent)
+    PlayWhe.get.least_recent(limit: options[:least_recent], order: options.fetch(:order, :asc))
+  elsif args.any?
+    nargs = args.length
+    order = options.fetch(:order, :asc)
+
+    if nargs == 1
+      year = args[0].to_i
+      PlayWhe.get.results_for_year(Date.new(year), order: order)
+    elsif nargs == 2
+      year = args[0].to_i
+      month = args[1].to_i
+      PlayWhe.get.results_for_month(Date.new(year, month), order: order)
+    elsif nargs == 3
+      year = args[0].to_i
+      month = args[1].to_i
+      day = args[2].to_i
+      PlayWhe.get.results_for_day(Date.new(year, month, day), order: order)
     else
-      Dir.mkdir(path) unless File.directory?(path)
-      FileUtils.cp(data, path, :verbose => true)
-
-      puts "You're all setup now. Have fun!"
+      raise ArgumentError, "Too many arguments"
     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
+    PlayWhe.get.most_recent(limit: 4, order: options.fetch(:order, :desc))
   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
+
+def main(args, options)
+  good_results, bad_results = get_results(args, options)
+  puts as_csv(good_results) if good_results.any?
+rescue PlayWhe::Error => e
+  STDERR.puts "Sorry, we were unable to retrieve the results"
+  STDERR.puts "Error: #{e.message}"
+  exit 1
+rescue ArgumentError => e
+  STDERR.puts "Please check your options/arguments"
+  STDERR.puts "Error: #{e.message}"
+  exit 1
+rescue => e
+  STDERR.puts "Sorry, we encountered an unknown error"
+  STDERR.puts "Error: #{e.message}"
+  exit 1
+end
+
+main(ARGV, options)