scoreoid 1.0.0 → 1.1.0

data/CHANGES.md

@@ -1,6 +1,11 @@
 Scoreoid Ruby Change Log
 ========================
 
+2012-11-25 *v1.1.0*
+-------------------
+
+- Allow passing date parameters (`:start_date` or `:end_date`) in natural language, such as "1 year ago". You can still pass a Date or Time object instead.
+
 2012-11-25 *v1.0.0*
 -------------------
 

data/README.md

@@ -1,8 +1,10 @@
 Scoreoid Ruby
 =============
 
-Scoreoid Ruby is a wrapper for the Scoreoid API. It is in the early development stages,
-with plans to support all Scoreoid API methods.
+Summary
+-------
+
+Scoreoid Ruby is a wrapper for the [Scoreoid](https://www.scoreoid.com/) API.
 
 Installation
 ------------
@@ -22,6 +24,8 @@ Or install it yourself as:
 Usage
 -----
 
+Full documentation is [available online](http://rubydoc.info/gems/scoreoid/frames).
+
 To get started, configure Scoreoid Ruby with your API key and game ID:
 
     require 'scoreoid'

data/Rakefile

@@ -6,3 +6,8 @@ RSpec::Core::RakeTask.new(:spec)
 YARD::Rake::YardocTask.new(:yard)
 
 task default: :spec
+
+desc 'Start an IRB session in the context of the current bundle'
+task :irb do
+	sh 'bundle console'
+end

data/lib/scoreoid/api.rb

@@ -1,5 +1,4 @@
-require 'date'
-
+require 'chronic'
 require 'multi_json'
 require 'rest_client'
 
@@ -12,6 +11,10 @@ module Scoreoid
 		class << self
 			# Query a given Scoreoid API method and return the repsonse as a string.
 			#
+			# Supplied parameters will be prepared with {.prepare_params} before sending.
+			# This is so that you can, for example,  supply a Date object for :start_date
+			# even though the Scoreoid API expects it to be a string formatted as "YYYY-MM-DD".
+			#
 			# @param [String] api_method The Scoreoid API method to query
 			# @param [Hash] params Parameters to include in the API request
 			#
@@ -36,7 +39,6 @@ module Scoreoid
 			# @return [Hash] The Scoreoid API response parsed into a Hash.
 			#
 			# @see .query
-			# @see .prepare_params
 			def query_and_parse(api_method, params={})
 				params = params.merge(response: 'json')
 
@@ -50,16 +52,25 @@ module Scoreoid
 
 			# Attempt to coerce parameters into formats that the Scoreoid API expects.
 			#
+			# Date parameters will be parsed with Chronic, so you can supply dates in
+			# natural language such as "may 5th 2012" or "1 year ago".
+			#
 			# @param [Hash] params A hash of any parameters you wish to format.
 			#
-			# @option params [Date, Time, String] :start_date
-			# @option params [Date, Time, String] :end_date
+			# @option params [#to_s, #strftime] :start_date
+			# @option params [#to_s, #strftime] :end_date
 			#
 			# @return [Hash] The formatted parameters, ready to use in an API query.
 			def prepare_params(params)
-				params.each do |key, value|
-					if [:start_date, :end_date].include?(key) and value.respond_to?(:strftime)
-						params[key] = value.strftime '%Y-%m-%d'
+				params.each do |key, _|
+					if [:start_date, :end_date].include?(key)
+						if params[key].respond_to? :to_s
+							params[key] = Chronic.parse(params[key].to_s, context: :past)
+						end
+
+						if params[key].respond_to? :strftime
+							params[key] = params[key].strftime '%Y-%m-%d'
+						end
 					end
 				end
 				params

data/lib/scoreoid/version.rb

@@ -1,4 +1,4 @@
 module Scoreoid
 	# The currently loaded Scoreoid Ruby version.
-	VERSION = '1.0.0'
+	VERSION = '1.1.0'
 end

data/scoreoid.gemspec

@@ -12,6 +12,7 @@ Gem::Specification.new do |gem|
 	gem.license = 'MIT'
 
 	gem.required_ruby_version = '1.9.2'
+	gem.add_runtime_dependency 'chronic', '~> 0.8.0'
 	gem.add_runtime_dependency 'multi_json', '~> 1.3'
 	gem.add_runtime_dependency 'rest-client', '~> 1.6'
 

data/spec/api_spec.rb

@@ -34,8 +34,8 @@ describe Scoreoid::API do
 
 		it 'should format the parameters before sending' do
 			example_response = %q({"players": 7})
-			given_params = {start_date: Date.new(2010, 1, 1), end_date: Date.new(2012, 2, 3).to_time}
-			formatted_params = {start_date: '2010-01-01', end_date: '2012-02-03'}
+			given_params = {start_date: Date.new(2010, 1, 1), end_date: 'december 3rd 2011'}
+			formatted_params = {start_date: '2010-01-01', end_date: '2011-12-03'}
 
 			RestClient.stub(:post).and_return(example_response)
 			RestClient.should_receive(:post).with('https://www.scoreoid.com/api/playerCount', formatted_params)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scoreoid
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-25 00:00:00.000000000 Z
+date: 2012-11-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement